woocommerce_api 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d5fe62b56cded73f61f26308f6bba3ba15898b8
-  data.tar.gz: d29f7f4ce9027449ac4b2a54110f973e00d2600e
+  metadata.gz: 9c5c6ddc266dfa306c0c2eb7cf2e26e691a0e863
+  data.tar.gz: 00b4d32c73163f6b2995c8900e24e71b2bc45b12
 SHA512:
-  metadata.gz: dc90d44760b4b1c2c2eb801f315c814dbd30b460960cbba17230dac8c0d64375dfafe1f945193af8e230a35df409125cfc027ee4f0557c75c93fafa3e4c2136e
-  data.tar.gz: bde96c899c1d8f5f172c3e8dc4cfcb499fd91084782243491502b4e2815dcac3241820e1c2f216b7e4d40ca064cabb0890033b86179fa6d8bed0c23a0f670245
+  metadata.gz: a68107081a25c7e8ff8bc00682034d2d381f1fe8751224c795c25d2e4db657f0ebf14da6755b2e9f2bcdc8dc0016ef4df447d53b63fc67f57da275689a0bee77
+  data.tar.gz: 7c06cfa2fe2c8af611fa75327ded5c307a60305590a3e5bcd098293afcd943ac85a907ed755a199b696c4cd10797c89b27d74ab88131913de3f5d170018613f8

data/README.md

@@ -20,6 +20,8 @@ Check out the WooCommerce API endpoints and data that can be manipulated in <htt
 
 ## Setup
 
+Setup for the old WooCommerce API v3:
+
 ```ruby
 require "woocommerce_api"
 
@@ -30,6 +32,22 @@ woocommerce = WooCommerce::API.new(
 )
 ```
 
+Setup for the new WP REST API integration:
+
+```ruby
+require "woocommerce_api"
+
+woocommerce = WooCommerce::API.new(
+  "http://example.com",
+  "ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+  "cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+  {
+    wp_api: true,
+    version: "wc/v1"
+  }
+)
+```
+
 ### Options
 
 |       Option      |   Type   | Required |               Description                |
@@ -42,7 +60,8 @@ woocommerce = WooCommerce::API.new(
 #### Args options
 
 |       Option       |   Type   | Required |                                                 Description                                                  |
-| ------------------ | -------- | -------- | ------------------------------------------------------------------------------------------------------------ |
+|--------------------|----------|----------|--------------------------------------------------------------------------------------------------------------|
+| `wp_api`           | `Bool`   | no       | Allow requests to the WP REST API                                                                            |
 | `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` |
@@ -71,9 +90,13 @@ woocommerce = WooCommerce::API.new(
 
 - `.delete(endpoint, query)`
 
+### OPTIONS
+
+- `.options(endpoint)`
+
 #### Response
 
-All methods will return [HTTPary::Response](https://github.com/jnunemaker/httparty) object.
+All methods will return [HTTParty::Response](https://github.com/jnunemaker/httparty) object.
 
 ```ruby
 response = api.get "customers"
@@ -93,6 +116,7 @@ puts response.headers["x-wc-totalpages"] # Total of pages
 
 ## Release History
 
+- 2016-05-09 - 1.2.0 - Added support for WP REST API and added method to do HTTP OPTIONS requests..
 - 2015-12-07 - 1.1.2 - Stop send `body` in GET and DELETE requests.
 - 2015-12-07 - 1.1.1 - Fixed the encode when have spaces in the URL parameters.
 - 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

data/lib/woocommerce_api.rb

@@ -15,12 +15,14 @@ module WooCommerce
 
       # Optional args
       defaults = {
+        wp_api: false,
         version: "v3",
         verify_ssl: true,
         signature_method: "HMAC-SHA256"
       }
       args = defaults.merge(args)
 
+      @wp_api = args[:wp_api]
       @version = args[:version]
       @verify_ssl = args[:verify_ssl] == true
       @signature_method = args[:signature_method]
@@ -69,6 +71,15 @@ module WooCommerce
       do_request :delete, add_query_params(endpoint, query)
     end
 
+    # Public: OPTIONS requests.
+    #
+    # endpoint - A String naming the request endpoint.
+    #
+    # Returns the request Hash.
+    def options endpoint
+      do_request :options, add_query_params(endpoint, nil)
+    end
+
     protected
 
     # Internal: Appends data as query params onto an endpoint
@@ -80,9 +91,9 @@ module WooCommerce
     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('&'))
+      endpoint += "?" unless endpoint.include? "?"
+      endpoint += "&" unless endpoint.end_with? "?"
+      endpoint + URI.encode(flatten_hash(data).join("&"))
     end
 
     # Internal: Get URL for requests
@@ -92,9 +103,10 @@ module WooCommerce
     #
     # Returns the endpoint String.
     def get_url endpoint, method
+      api = @wp_api ? 'wp-json' : 'wc-api'
       url = @url
       url = "#{url}/" unless url.end_with? "/"
-      url = "#{url}wc-api/#{@version}/#{endpoint}"
+      url = "#{url}#{api}/#{@version}/#{endpoint}"
 
       @is_ssl ? url : oauth_url(url, method)
     end

data/lib/woocommerce_api/version.rb

@@ -1,3 +1,3 @@
 module WooCommerce
-  VERSION = '1.1.2'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: woocommerce_api
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Claudio Sanches
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-07 00:00:00.000000000 Z
+date: 2016-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -64,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper for the WooCommerce API