base from tradegecko/woocommerce_api

Author: averydev

Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+gem "activesupport"
+gem "activemodel"
+gem "httparty"
+gem "virtus"
+
+group :development do
+  gem "bundler"
+  gem "jeweler"
+  gem "rdoc"
+  gem "rspec"
+  gem 'webmock'
+  gem "vcr"
+  gem "pry"
+end

Gemfile.lock

@@ -0,0 +1,125 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.1.5)
+      activesupport (= 5.1.5)
+    activesupport (5.1.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.4.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    builder (3.2.3)
+    coderay (1.1.2)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    concurrent-ruby (1.0.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    equalizer (0.0.11)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.3.0)
+    github_api (0.16.0)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      mime-types (>= 1.16, < 3.0)
+      oauth2 (~> 1.0)
+    hashdiff (0.3.7)
+    hashie (3.5.7)
+    highline (1.7.10)
+    httparty (0.16.0)
+      multi_xml (>= 0.5.2)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    jeweler (2.3.9)
+      builder
+      bundler
+      git (>= 1.2.5)
+      github_api (~> 0.16.0)
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      psych
+      rake
+      rdoc
+      semver2
+    jwt (1.5.6)
+    method_source (0.9.0)
+    mime-types (2.99.3)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    multi_json (1.13.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    nokogiri (1.10.1)
+      mini_portile2 (~> 2.4.0)
+    oauth2 (1.4.0)
+      faraday (>= 0.8, < 0.13)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    psych (3.0.2)
+    rack (2.0.6)
+    rake (12.3.0)
+    rdoc (6.0.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    safe_yaml (1.0.4)
+    semver2 (3.4.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    vcr (4.0.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    webmock (3.3.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel
+  activesupport
+  bundler
+  httparty
+  jeweler
+  pry
+  rdoc
+  rspec
+  vcr
+  virtus
+  webmock
+
+BUNDLED WITH
+   1.17.3

LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Philip Mark Deazeta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

README.md

@@ -0,0 +1,78 @@
+# Ruby Client for Woocommerce API
+
+[![Build Status](https://semaphoreci.com/api/v1/tradegecko/woocommerce_api/branches/fix-variations/badge.svg)](https://semaphoreci.com/tradegecko/woocommerce_api)
+## Installation
+```ruby
+gem "woocommerce_api", github: "tradegecko/woocommerce_api"
+```
+```ruby
+require "woocommerce_api"
+```
+
+## Initialize authorize access
+
+```ruby
+# Through https
+WoocommerceAPI::Client.new(
+  consumer_key: "ck_1234", 
+  consumer_secret: "cs_1234", 
+  store_url: "https://example.com")
+
+# Through https but sending consumer_key and consumer_secret as query string
+WoocommerceAPI::Client.new(
+  consumer_key: "ck_1234", 
+  consumer_secret: "cs_1234", 
+  store_url: "https://example.com", 
+  mode: :query_https)
+
+# Through http (Oauth) 
+WoocommerceAPI::Client.new(
+  consumer_key: "ck_1234", 
+  consumer_secret: "cs_1234", 
+  store_url: "https://example.com", 
+  mode: :oauth_http)
+```
+
+## Calling API
+### Collection endpoints
+returns a collection of the resource, size of collection limited by a configuration in Woocommerce setting (10 by default)
+```ruby
+WoocommerceAPI::Product.all
+=> [collection of products]
+```
+collection with parameters, check more http://woothemes.github.io/woocommerce-rest-api-docs/#parameters 
+```ruby
+WoocommerceAPI::Product.all(filter: { limit: 50 })
+WoocommerceAPI::Order.all(filter: { status: "complete", created_at_min: "2015-11-01" })
+```
+### Count 
+```ruby
+WoocommerceAPI::Product.count
+WoocommerceAPI::Order.count(filter: { status: "commplete" })
+```
+### Finding a resource
+```ruby 
+WoocommerceAPI::Product.find(1) 
+WoocommerceAPI::Order.find(1)
+```
+### Update a resource
+```ruby
+product = WoocommerceAPI::Product.find(1) 
+product.update_attributes(regular_price: 100, managing_stock: true)
+# or
+product.regular_price = 100
+product.managing_stock = true
+product.save
+```
+### Destroy a resource 
+```ruby
+product.destroy # Soft delete a product (move to trash)
+product.destroy(force: true) # Permanently delete a product
+```
+
+## Debugging 
+We are using HTTParty, then...
+```ruby
+WoocommerceAPI::OauthClient.debug_output $stdout
+WoocommerceAPI::Client.debug_output $stdout
+```

Rakefile

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "woocommerce_api"
+  gem.homepage = "http://github.com/tradegecko/woocommerce_api"
+  gem.license = "MIT"
+  gem.summary = %Q{Enables Ruby applications to communicate with the WooCommerce API}
+  gem.description = %Q{Enables Ruby applications to communicate with the WooCommerce API.}
+  gem.email = "[email protected]"
+  gem.authors = ["TradeGecko"]
+  # dependencies defined in Gemfile
+  gem.files = Dir.glob('lib/**/*.rb')
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "woocommerce_api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session with WoocommerceAPI"
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'woocommerce-api'
+  ARGV.clear
+  IRB.start
+end

VERSION

@@ -0,0 +1 @@
+1.1.0