woocommerce_api 1.0.3 → 1.1.0

data/README.md

@@ -41,22 +41,23 @@ woocommerce = WooCommerce::API.new(
 
 #### 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 |
+|       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          |
+| `signature_method` | `String` | no       | Signature method used for oAuth requests, works with `HMAC-SHA1` and `HMAC-SHA256`, default is `HMAC-SHA256` |
 
 ## 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`           |
+|   Params   |   Type   |                         Description                          |
+| ---------- | -------- | ------------------------------------------------------------ |
+| `endpoint` | `String` | WooCommerce API endpoint, example: `customers` or `order/12` |
+| `data`     | `Hash`   | Only for POST and PUT, data that will be converted to JSON   |
+| `query`    | `Hash`   | Only for GET and DELETE, request query string                |
 
 ### GET
 
-- `.get(endpoint)`
+- `.get(endpoint, query)`
 
 ### POST
 
@@ -68,7 +69,7 @@ woocommerce = WooCommerce::API.new(
 
 ### DELETE
 
-- `.delete(endpoint)`
+- `.delete(endpoint, query)`
 
 #### Response
 
@@ -92,6 +93,7 @@ puts response.headers["x-wc-totalpages"] # Total of pages
 
 ## Release History
 
+- 2015-08-27 - 1.1.0 - Added `query` argument for GET and DELETE methods, reduced chance of nonce collisions and added support for urls including ports
 - 2015-08-27 - 1.0.3 - Encode all % characters in query string for OAuth 1.0a.
 - 2015-08-12 - 1.0.2 - Fixed the release date.
 - 2015-08-12 - 1.0.1 - Escaped oauth_signature in url query string.

data/lib/woocommerce_api.rb

@@ -14,11 +14,16 @@ module WooCommerce
       @consumer_secret = consumer_secret
 
       # Optional args
-      defaults = {version: "v3", verify_ssl: true}
+      defaults = {
+        version: "v3",
+        verify_ssl: true,
+        signature_method: "HMAC-SHA256"
+      }
       args = defaults.merge(args)
 
       @version = args[:version]
       @verify_ssl = args[:verify_ssl] == true
+      @signature_method = args[:signature_method]
 
       # Internal args
       @is_ssl = @url.start_with? "https"
@@ -27,10 +32,11 @@ module WooCommerce
     # Public: GET requests.
     #
     # endpoint - A String naming the request endpoint.
+    # query    - A Hash with query params.
     #
     # Returns the request Hash.
-    def get endpoint
-      do_request :get, endpoint
+    def get endpoint, query = nil
+      do_request :get, add_query_params(endpoint, query)
     end
 
     # Public: POST requests.
@@ -56,38 +62,52 @@ module WooCommerce
     # Public: DELETE requests.
     #
     # endpoint - A String naming the request endpoint.
+    # query    - A Hash with query params.
     #
     # Returns the request Hash.
-    def delete endpoint
-      do_request :delete, endpoint
+    def delete endpoint, query = nil
+      do_request :delete, add_query_params(endpoint, query)
     end
 
     protected
 
+    # Internal: Appends data as query params onto an endpoint
+    #
+    # endpoint - A String naming the request endpoint.
+    # data     - A hash of data to flatten and append
+    #
+    # Returns an endpoint string with the data appended
+    def add_query_params endpoint, data
+      return endpoint if data.nil? || data.empty?
+
+      endpoint += '?' unless endpoint.include? '?'
+      endpoint += '&' unless endpoint.end_with? '?'
+      endpoint + URI.encode(flatten_hash(data).join('&'))
+    end
+
     # Internal: Get URL for requests
     #
     # endpoint - A String naming the request endpoint.
+    # method   - The method used in the url (for oauth querys)
     #
     # Returns the endpoint String.
-    def get_url endpoint
+    def get_url endpoint, method
       url = @url
-      if !url.end_with? "/"
-        url = "#{url}/"
-      end
+      url = "#{url}/" unless url.end_with? "/"
+      url = "#{url}wc-api/#{@version}/#{endpoint}"
 
-      "#{url}wc-api/#{@version}/#{endpoint}"
+      @is_ssl ? url : oauth_url(url, method)
     end
 
     # Internal: Requests default options.
     #
-    # method   - A String maning the request method
+    # method   - A String naming 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
-
+    def do_request method, endpoint, data = {}
+      url = get_url(endpoint, method)
       options = {
         format: :json,
         verify: @verify_ssl,
@@ -97,27 +117,52 @@ module WooCommerce
           "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
+        options.merge!(basic_auth: {
+          username: @consumer_key,
+          password: @consumer_secret
         })
       end
+      options.merge!(body: data.to_json) if data
+      HTTParty.send(method, url, options)
+    end
 
-      HTTParty.send method, url, options
+    # Internal: Generates an oauth url given current settings
+    #
+    # url    - A String naming the current request url
+    # method - The HTTP verb of the request
+    #
+    # Returns a url to be used for the query.
+    def oauth_url url, method
+      oauth = WooCommerce::OAuth.new(
+        url,
+        method,
+        @version,
+        @consumer_key,
+        @consumer_secret,
+        @signature_method
+      )
+      oauth.get_oauth_url
     end
 
+    # Internal: Flattens a hash into an array of query relations
+    #
+    # hash - A hash to flatten
+    #
+    # Returns an array full of key value paired strings
+    def flatten_hash hash
+      hash.flat_map do |key, value|
+        case value
+        when Hash
+          value.map do |inner_key, inner_value|
+            "#{key}[#{inner_key}]=#{inner_value}"
+          end
+        when Array
+          value.map { |inner_value| "#{key}[]=#{inner_value}" }
+        else
+          "#{key}=#{value}"
+        end
+      end
+    end
   end
 end

data/lib/woocommerce_api/oauth.rb

@@ -6,13 +6,15 @@ require "openssl"
 
 module WooCommerce
   class OAuth
+    class InvalidSignatureMethodError < StandardError; end
 
-    def initialize url, method, version, consumer_key, consumer_secret
+    def initialize url, method, version, consumer_key, consumer_secret, signature_method = "HMAC-SHA256"
       @url = url
       @method = method.upcase
       @version = version
       @consumer_key = consumer_key
       @consumer_secret = consumer_secret
+      @signature_method = signature_method
     end
 
     # Public: Get OAuth url
@@ -27,13 +29,16 @@ module WooCommerce
         CGI::parse(parsed_url.query).each do |key, value|
           params[key] = value[0]
         end
+        params = Hash[params.sort]
 
-        url = "#{parsed_url.scheme}://#{parsed_url.host}#{parsed_url.path}"
+        url = parsed_url.to_s.gsub(/\?.*/, "")
       end
 
+      nonce_lifetime = 15 * 60 # Woocommerce keeps nonces for 15 minutes
+
       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_nonce"] = Digest::SHA1.hexdigest((Time.new.to_f % nonce_lifetime + (Process.pid * nonce_lifetime)).to_s)
+      params["oauth_signature_method"] = @signature_method
       params["oauth_timestamp"] = Time.new.to_i
       params["oauth_signature"] = CGI::escape(generate_oauth_signature(params, url))
 
@@ -68,7 +73,19 @@ module WooCommerce
         consumer_secret = @consumer_secret
       end
 
-      return Base64.strict_encode64(OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), consumer_secret, string_to_sign))
+      return Base64.strict_encode64(OpenSSL::HMAC.digest(digest, consumer_secret, string_to_sign))
+    end
+
+    # Internal: Digest object based on signature method
+    #
+    # Returns a digest object.
+    def digest
+      case @signature_method
+      when "HMAC-SHA256" then OpenSSL::Digest.new("sha256")
+      when "HMAC-SHA1" then OpenSSL::Digest.new("sha1")
+      else
+        fail InvalidSignatureMethodError
+      end
     end
 
     # Internal: Encode param
@@ -76,8 +93,8 @@ module WooCommerce
     # text - A String to be encoded
     #
     # Returns the encoded String.
-    def encode_param(text)
-      CGI::escape(text).gsub('%', '%25')
+    def encode_param text
+      CGI::escape(text).gsub("%", "%25")
     end
   end
 end

data/lib/woocommerce_api/version.rb

@@ -1,3 +1,3 @@
 module WooCommerce
-  VERSION = '1.0.3'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: woocommerce_api
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-27 00:00:00.000000000 Z
+date: 2015-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty