woocommerce_api 0.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015, WooThemes (http://www.woothemes.com/)
+
+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.

data/README.md

@@ -0,0 +1,98 @@
+# WooCommerce API - Ruby Client
+
+A Ruby wrapper for the WooCommerce REST API. Easily interact with the WooCommerce REST API using this library.
+
+[![npm version](https://img.shields.io/gem/v/formatador.svg)](https://rubygems.org/gems/woocommerce_api)
+
+## Installation
+
+```
+gem install woocommerce_api
+```
+
+## Getting started
+
+Generate API credentials (Consumer Key & Consumer Secret) following this instructions <http://docs.woothemes.com/document/woocommerce-rest-api/>
+.
+
+Check out the WooCommerce API endpoints and data that can be manipulated in <http://woothemes.github.io/woocommerce-rest-api-docs/>.
+
+## Setup
+
+```ruby
+require "woocommerce_api"
+
+woocommerce = WooCommerce::API.new(
+  "http://example.com",
+  "ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+  "cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+)
+```
+
+### Options
+
+|       Option      |   Type   | Required |               Description                |
+| ----------------- | -------- | -------- | ---------------------------------------- |
+| `url`             | `String` | yes      | Your Store URL, example: http://woo.dev/ |
+| `consumer_key`    | `String` | yes      | Your API consumer key                    |
+| `consumer_secret` | `String` | yes      | Your API consumer secret                 |
+| `args`            | `Hash`   | no       | Extra arguments (see Args options table) |
+
+#### Args options
+
+|    Option    |   Type   | Required |                                             Description                                             |
+| ------------ | -------- | -------- | --------------------------------------------------------------------------------------------------- |
+| `version`    | `String` | no       | API version, default is `v3`                                                                        |
+| `verify_ssl` | `Bool`   | no       | Verify SSL when connect, use this option as `false` when need to test with self-signed certificates |
+
+## Methods
+
+|   Params   |    Type    |                         Description                          |
+| ---------- | ---------- | ------------------------------------------------------------ |
+| `endpoint` | `String`   | WooCommerce API endpoint, example: `customers` or `order/12` |
+| `data`     | `Object`   | JS object, will be converted to JSON                         |
+| `callback` | `Function` | Callback function. Returns `err`, `data` and `res`           |
+
+### GET
+
+- `.get(endpoint)`
+
+### POST
+
+- `.post(endpoint, data)`
+
+### PUT
+
+- `.put(endpoint, data)`
+
+### DELETE
+
+- `.delete(endpoint)`
+
+#### Response
+
+All methods will return [HTTPary::Response](https://github.com/jnunemaker/httparty) object.
+
+```ruby
+response = api.get "customers"
+
+puts response.parsed_response # A Hash of the parsed JSON response
+# Example: {"customers"=>[{"id"=>8, "created_at"=>"2015-05-06T17:43:51Z", "email"=>
+
+puts response.code # A Interger of the HTTP code response
+# Example: 200
+
+puts response.headers["x-wc-total"] # Total of items
+# Example: 2
+
+puts response.headers["x-wc-totalpages"] # Total of pages
+# Example: 1
+```
+
+## Release History
+
+- 2015-07-15 - 0.0.1 - Beta release.
+
+## TODO
+
+- Unit Tests

data/lib/woocommerce_api.rb

@@ -0,0 +1,123 @@
+require "httparty"
+require "json"
+
+require "woocommerce_api/oauth"
+require "woocommerce_api/version"
+
+module WooCommerce
+  class API
+
+    def initialize url, consumer_key, consumer_secret, args = {}
+      # Required args
+      @url = url
+      @consumer_key = consumer_key
+      @consumer_secret = consumer_secret
+
+      # Optional args
+      defaults = {version: "v3", verify_ssl: true}
+      args = defaults.merge(args)
+
+      @version = args[:version]
+      @verify_ssl = args[:verify_ssl] == true
+
+      # Internal args
+      @is_ssl = @url.start_with? "https"
+    end
+
+    # Public: GET requests.
+    #
+    # endpoint - A String naming the request endpoint.
+    #
+    # Returns the request Hash.
+    def get endpoint
+      do_request :get, endpoint
+    end
+
+    # Public: POST requests.
+    #
+    # endpoint - A String naming the request endpoint.
+    # data     - The Hash data for the request.
+    #
+    # Returns the request Hash.
+    def post endpoint, data
+      do_request :post, endpoint, data
+    end
+
+    # Public: PUT requests.
+    #
+    # endpoint - A String naming the request endpoint.
+    # data     - The Hash data for the request.
+    #
+    # Returns the request Hash.
+    def put endpoint, data
+      do_request :put, endpoint, data
+    end
+
+    # Public: DELETE requests.
+    #
+    # endpoint - A String naming the request endpoint.
+    #
+    # Returns the request Hash.
+    def delete endpoint
+      do_request :delete, endpoint
+    end
+
+    protected
+
+    # Internal: Get URL for requests
+    #
+    # endpoint - A String naming the request endpoint.
+    #
+    # Returns the endpoint String.
+    def get_url endpoint
+      url = @url
+      if !url.end_with? "/"
+        url = "#{url}/"
+      end
+
+      "#{url}wc-api/#{@version}/#{endpoint}"
+    end
+
+    # Internal: Requests default options.
+    #
+    # method   - A String maning the request method
+    # endpoint - A String naming the request endpoint.
+    # data     - The Hash data for the request.
+    #
+    # Returns the response in JSON String.
+    def do_request method, endpoint, data = nil
+      url = get_url endpoint
+
+      options = {
+        format: :json,
+        verify: @verify_ssl,
+        headers: {
+          "User-Agent" => "WooCommerce API Client-Ruby/#{WooCommerce::VERSION}",
+          "Content-Type" => "application/json;charset=utf-8",
+          "Accept" => "application/json"
+        }
+      }
+
+      if @is_ssl
+        options.merge!({
+          basic_auth: {
+            username: @consumer_key,
+            password: @consumer_secret
+          }
+        })
+      else
+        oauth = WooCommerce::OAuth.new url, method, @version, @consumer_key, @consumer_secret
+        url = oauth.get_oauth_url
+      end
+
+      if data
+        options.merge!({
+          body: data.to_json
+        })
+      end
+
+      HTTParty.send method, url, options
+    end
+
+  end
+end

data/lib/woocommerce_api/oauth.rb

@@ -0,0 +1,76 @@
+require "digest/sha1"
+require "cgi"
+require "uri"
+require "base64"
+require "openssl"
+
+module WooCommerce
+  class OAuth
+
+    def initialize url, method, version, consumer_key, consumer_secret
+      @url = url
+      @method = method.upcase
+      @version = version
+      @consumer_key = consumer_key
+      @consumer_secret = consumer_secret
+    end
+
+    # Public: Get OAuth url
+    #
+    # Returns the OAuth url.
+    def get_oauth_url
+      params = {}
+      url = @url
+
+      if url.include?("?")
+        parsed_url = URI::parse(url)
+        CGI::parse(parsed_url.query).each do |key, value|
+          params[key] = value[0]
+        end
+
+        url = "#{parsed_url.scheme}://#{parsed_url.host}#{parsed_url.path}"
+      end
+
+      params["oauth_consumer_key"] = @consumer_key
+      params["oauth_nonce"] = Digest::SHA1.hexdigest("#{Time.new.to_i + rand(99999)}")
+      params["oauth_signature_method"] = "HMAC-SHA256"
+      params["oauth_timestamp"] = Time.new.to_i
+      params["oauth_signature"] = generate_oauth_signature(params, url)
+
+      query_string = URI::encode(params.map{|key, value| "#{key}=#{value}"}.join("&"))
+
+      "#{url}?#{query_string}"
+    end
+
+    protected
+
+    # Internal: Generate the OAuth Signature
+    #
+    # params - A Hash with the OAuth params.
+    # url    - A String with a URL
+    #
+    # Returns the oauth signature String.
+    def generate_oauth_signature params, url
+      base_request_uri = CGI::escape(url.to_s)
+      query_params = []
+
+      params.sort.map do |key, value|
+        query_params.push(CGI::escape(key.to_s) + "%3D" + CGI::escape(value.to_s))
+      end
+
+      query_string = query_params
+        .join("%26")
+        .gsub("%5B", "%255B")
+        .gsub("%5D", "%255D")
+      string_to_sign = "#{@method}&#{base_request_uri}&#{query_string}"
+
+      if @version == "v3"
+        consumer_secret = "#{@consumer_secret}&"
+      else
+        consumer_secret = @consumer_secret
+      end
+
+      return Base64.strict_encode64(OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), consumer_secret, string_to_sign))
+    end
+  end
+end

data/lib/woocommerce_api/version.rb

@@ -0,0 +1,3 @@
+module WooCommerce
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: woocommerce_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Claudio Sanches
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem provide a wrapper to deal with the WooCommerce REST API
+email: claudio@woothemes.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- lib/woocommerce_api.rb
+- lib/woocommerce_api/version.rb
+- lib/woocommerce_api/oauth.rb
+- README.md
+- LICENSE
+homepage: https://github.com/woothemes/wc-api-ruby
+licenses:
+- MIT
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Ruby wrapper for the WooCommerce API
+test_files: []