bigcommerce-oauth-api 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a484aad29a21d82ebb61dc10ad1051c174af5e64
-  data.tar.gz: 84be7bae67c690f8f40e735af3862c1a9dfab2e1
+  metadata.gz: 7ba098105b05e84a8943eb2bdea8c55f535a6d79
+  data.tar.gz: 39b16841f846996dec05b66059de51c5ac0b2ac5
 SHA512:
-  metadata.gz: 3508631521b911e5b7956bdd5cbe1387551b036348b09f6209ad5de061b86e0cbed6a24e422ddb0ddeee56186cb8e1de5a29ad0a445086c022837ca0a13b5010
-  data.tar.gz: 6ca92909b5b6cd1edc34bd9f98e11e5073490c4739f0d7412971e960f13a9988de4031e8ef234d084a61190ea8e5a439a74aa670640dbc51d45c1badd6600dde
+  metadata.gz: 8a577194ff7933ebc652065cde142d1ea163a42beff6453fb5d3f2437fafffe350396944068ad6a353df024a342846da24084c3865e05c3bbdaa0b18e3dba732
+  data.tar.gz: deb9bc17ce5806bc6425d3c21c862d187942b369a09ade027f390d23e8cf10053aa34705f9cd4a2492492ba419d57964012beb9f3926960312454c7411dead08

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+### 1.4.1 (2017-06-25)
+
+Features:
+
+    - added shipping zone api
+
+Bugfixes:
+
+    - fixed shipping method api
+    - fixed links to official api documentation
+
 ### 1.4.0 (2016-10-09)
 
 Features:

data/README.md

@@ -122,84 +122,46 @@ The following APIs are currently supported:
 
 API | Gem Version | Official Documentation
 --- | --- | ---
-blog post | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/blog/posts
-blog tag | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/blog/tags
-brand api | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/brands
-bulk pricing (discount rules) | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/discount_rules
-category | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/categories
-customer api | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/customers
-customer address | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/customers/addresses
-customer group | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/customer_groups
-geography country | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/countries
-geography state | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/countries/states
-marketing banner | 1.4.0 | https://developer.bigcommerce.com/api/stores/v2/banners
-marketing coupon | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/coupons
-marketing gift certificate | 1.4.0 | https://developer.bigcommerce.com/api/stores/v2/gift_certificates
-option | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/options
-option set | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/option_sets
-option set option | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/option_sets/options
-option value | 1.2.0 | https://developer.bigcommerce.com/api/stores/v2/options/values
-order | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/orders
-order coupon | 1.2.0 | https://developer.bigcommerce.com/api/stores/v2/orders/coupons
-order message | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/orders/messages
-order product | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/orders/products
-order shipment | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/orders/shipments
-order shipping address | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/orders/shipping_addresses
+blog post | 1.0.2 | https://developer.bigcommerce.com/api/v2/#blog-posts
+blog tag | 1.0.2 | https://developer.bigcommerce.com/api/v2/#blog-tags
+brand api | 1.1.0 | https://developer.bigcommerce.com/api/v2/#brands
+bulk pricing (discount rules) | 1.1.0 | https://developer.bigcommerce.com/api/v2/#bulk-pricing
+category | 1.1.0 | https://developer.bigcommerce.com/api/v2/#categories
+customer api | 1.0.2 | https://developer.bigcommerce.com/api/v2/#customers-2
+customer address | 1.0.2 | https://developer.bigcommerce.com/api/v2/#customer-addresses
+customer group | 1.0.2 | https://developer.bigcommerce.com/api/v2/#customer-groups
+geography country | 1.0.2 | https://developer.bigcommerce.com/api/v2/#countries
+geography state | 1.0.2 | https://developer.bigcommerce.com/api/v2/#states
+marketing banner | 1.4.0 | https://developer.bigcommerce.com/api/v2/#banners
+marketing coupon | 1.0.2 | https://developer.bigcommerce.com/api/v2/#coupons
+marketing gift certificate | 1.4.0 | https://developer.bigcommerce.com/api/v2/#gift-certificates
+option | 1.1.0 | https://developer.bigcommerce.com/api/v2/#options
+option set | 1.1.0 | https://developer.bigcommerce.com/api/v2/#option-sets
+option set option | 1.1.0 | https://developer.bigcommerce.com/api/v2/#option-set-options
+option value | 1.2.0 | https://developer.bigcommerce.com/api/v2/#option-values
+order | 1.0.2 | https://developer.bigcommerce.com/api/v2/#orders-2
+order coupon | 1.2.0 | https://developer.bigcommerce.com/api/v2/#order-coupons
+order message | 1.0.2 | https://developer.bigcommerce.com/api/v2/#order-messages
+order product | 1.0.2 | https://developer.bigcommerce.com/api/v2/#order-products-2
+order shipment | 1.0.2 | https://developer.bigcommerce.com/api/v2/#shipments
+order shipping address | 1.0.2 | https://developer.bigcommerce.com/api/v2/#order-shipping-addresses
 order statuses | 1.2.0 | https://developer.bigcommerce.com/api/stores/v2/order_statuses
-order tax | 1.2.0 | https://developer.bigcommerce.com/api/stores/v2/orders/taxes
-payment method | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/payments/methods
-product | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/products
-product configurable field | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/configurable_fields
-product custom field | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/products/custom_fields
-product googleproductsearch | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/googleproductsearch
-product image | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/images
-product option | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/options
-product review | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/reviews
-product rules | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/rules
-product video | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/videos
-product SKU | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/skus
-redirect | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/redirects
-shipping method api | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/shipping/methods
-store information | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/store_information
-system (time) | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/time
-tax class | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/tax_classes
-web hook | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/webhooks
-
-Getting an OAuth Access Token
--------------
-The Bigcommerce API focused on making OAuth available for 3rd party development through Apps.
-Bigcommerce currently recommends using basic authentication when developing custom (private) integrations for your webshop.
-
-However, it is actually possible to aquire access tokens without publishing an App for Bigcommerce by following these steps:
-
-1.  Go to http://developer.bigcommerce.com
-
-2.  Login with the same user as the webshop you want to create a token for.
-
-3.  Go to "My Apps" and create dummy app (maybe call it "Authentication App")
-
-4.  Select the APIs you need and set the Auth Callback Url.
-    * This needs to be a HTTPS Url where you can read incomming GET request
-
-5.  Go to your webshop and click on "Apps"
-
-6.  Select the tab "My Drafts" (which should contain your "Authentication App")
-
-7.  Install the "Authentication App" in your webshop.
-    * This triggers a callback to your "Auth Callback Url" where you receive a code which can be exchanged for a token.
-
-8.  Send a POST request containing the following parameters (to https://login.bigcommerce.com/oauth2/token):
-    * client_id (can be found under "My Apps" at developer.bigcommerce.com
-    * client_secret (can be found under "My Apps" at developer.bigcommerce.com
-    * code (is received in the "Auth Callback")
-    * scope (is received in the "Auth Callback")
-    * grant_type (is always authorization_code)
-    * redirect_uri (your "Auth Callback Url")
-    * context (is "stores/{your store hash / id}")
-
-9.  Done! The response returns your OAuth Access Token.
-
-If you are experiencing problems with the POST call try using the folllowing curl command
-```
-curl --data "[YOUR POST PARAMETERS]" https://login.bigcommerce.com/oauth2/token
-```
+order tax | 1.2.0 | https://developer.bigcommerce.com/api/v2/#order-taxes
+payment method | 1.0.2 | https://developer.bigcommerce.com/api/v2/#payment-methods
+product | 1.0.2 | https://developer.bigcommerce.com/api/v2/#products
+product configurable field | 1.1.0 | https://developer.bigcommerce.com/api/v2/#configurable-fields
+product custom field | 1.0.2 | https://developer.bigcommerce.com/api/v2/#custom-fields
+product googleproductsearch | 1.1.0 | https://developer.bigcommerce.com/api/v2/#google-product-search-mapping-object-properties
+product image | 1.1.0 | https://developer.bigcommerce.com/api/v2/#product-images
+product option | 1.1.0 | https://developer.bigcommerce.com/api/v2/#product-options
+product review | 1.1.0 | https://developer.bigcommerce.com/api/v2/#product-reviews
+product rules | 1.1.0 | https://developer.bigcommerce.com/api/v2/#product-rules
+product video | 1.1.0 | https://developer.bigcommerce.com/api/v2/#videos
+product SKU | 1.1.0 | https://developer.bigcommerce.com/api/v2/#skus
+redirect | 1.0.2 | https://developer.bigcommerce.com/api/v2/#redirects
+shipping method api | 1.0.2 | https://developer.bigcommerce.com/api/v2/#shipping-methods-reference
+shipping zone api | 1.4.1 | https://developer.bigcommerce.com/api/v2/#shipping-zones-reference
+store information | 1.0.2 | hhttps://developer.bigcommerce.com/api/v2/#store-information-reference
+system (time) | 1.0.2 | https://developer.bigcommerce.com/api/v2/#system-reference
+tax class | 1.0.2 | https://developer.bigcommerce.com/api/v2/#tax-class-reference
+web hook | 1.0.2 | https://developer.bigcommerce.com/api/#webhook-object-properties

data/bigcommerce-oauth-api.gemspec

@@ -3,7 +3,7 @@ require File.expand_path('../lib/bigcommerce-oauth-api/version', __FILE__)
 Gem::Specification.new do |s|
   s.name        = 'bigcommerce-oauth-api'
   s.version     = BigcommerceOAuthAPI::VERSION.dup
-  s.date        = '2016-10-09'
+  s.date        = '2017-06-25'
   s.summary     = "Ruby client library for Bigcommerce APIs with OAuth and basic authentication support"
   s.description = "Connect Ruby applications to Bigcommerce APIs through OAuth or basic authentication"
   s.authors     = ["Christian Orthmann"]

data/lib/bigcommerce-oauth-api/client.rb

@@ -57,34 +57,35 @@ module BigcommerceOAuthAPI
                      :product_video => { api_module: :video, scope: :product, methods: [:all, :select, :create, :update, :delete, :count]},
                      :product_sku => { api_module: :sku, scope: :product, methods: [:all, :select, :create, :update, :delete, :count]},
                      :redirect => { api_module: :redirect, scope: :self, methods: [:all, :select, :create, :update, :delete, :count]},
-                     :shipping_method => { api_module: :method, scope: :self, methods: [:all, :select], prefix_paths: 'shipping', prefix_methods: 'shipping'},
+                     :shipping_method => { api_module: :method, scope: :zone, methods: [:all, :select, :create, :update, :delete], prefix_paths: 'shipping', prefix_methods: 'shipping'},
+                     :shipping_zones => { api_module: :zone, scope: :self, methods: [:all, :select, :create, :update, :delete], prefix_paths: 'shipping', prefix_methods: 'shipping'},
                      :tax_class => { api_module: :tax_class, scope: :self, methods: [:all, :select]},
                      :web_hook => { api_module: :hook, scope: :self, methods: [:all, :select, :create, :update, :delete], legacy: false }
 
     # @!method blog_posts(options = {})
     # @param [Hash] options the filters for the posts
-    # gets a list of posts
+    # gets a list of blog posts
 
     # @!method blog_post(id, options = {})
     # @param [Integer] id the identifier for the post
-    # gets the post with the given id
+    # gets the blog post with the given id
 
     # @!method create_blog_post(options = {})
     # @param [Hash] options the attributes for the post
-    # creates a post with the given attributes
+    # creates a blog post with the given attributes
 
     # @!method update_blog_post(id, options = {})
     # @param [Integer] id the identifier for the post
     # @param [Hash] options the attributes for the post
-    # updates the attributes of the post with the given id
+    # updates the attributes of the blog post with the given id
 
     # @!method delete_blog_post(id)
     # @param [Integer] id the identifier for the post
-    # deletes the post with the given id
+    # deletes the blog post with the given id
 
     # @!method blog_tags(options = {})
     # @param [Hash] options the filters for the tags
-    # gets a list of tags
+    # gets a list of blog tags
 
     # @!method brands(options = {})
     # @param [Hash] options the filters for the brands
@@ -516,7 +517,7 @@ module BigcommerceOAuthAPI
 
     # @!method payment_methods(options = {})
     # @param [Hash] options the filters for the methods
-    # gets a list of methods
+    # gets a list of payment methods
 
     # @!method products(options = {})
     # @param [Hash] options the filters for the products
@@ -784,13 +785,52 @@ module BigcommerceOAuthAPI
     # @param [Hash] options the filters for the redirects
     # returns the number of redirects
 
-    # @!method shipping_methods(options = {})
+    # @!method shipping_zone_methods(zone_id, options = {})
+    # @param [Integer] zone_id the identifier for the zone
     # @param [Hash] options the filters for the methods
-    # gets a list of methods
+    # gets a list of shipping methods for the given shipping zone
 
-    # @!method shipping_method(id, options = {})
+    # @!method shipping_zone_method(zone_id, id, options = {})
+    # @param [Integer] zone_id the identifier for the zone
     # @param [Integer] id the identifier for the method
-    # gets the method with the given id
+    # gets the shipping method with the given id for the given shipping zone
+
+    # @!method create_shipping_zone_method(zone_id, options = {})
+    # @param [Integer] zone_id the identifier for the zone
+    # @param [Hash] options the attributes for the method
+    # creates a shipping method with the given attributes for the given shipping zone
+
+    # @!method update_shipping_zone_method(zone_id, id, options = {})
+    # @param [Integer] zone_id the identifier for the zone
+    # @param [Integer] id the identifier for the method
+    # @param [Hash] options the attributes for the method
+    # updates the attributes of the shipping method with the given id for the given shipping zone
+
+    # @!method delete_shipping_zone_method(zone_id, id)
+    # @param [Integer] zone_id the identifier for the zone
+    # @param [Integer] id the identifier for the method
+    # deletes the shipping method with the given id for the given shipping zone
+
+    # @!method shipping_zones(options = {})
+    # @param [Hash] options the filters for the zones
+    # gets a list of shipping zones
+
+    # @!method shipping_zone(id, options = {})
+    # @param [Integer] id the identifier for the zone
+    # gets the shipping zone with the given id
+
+    # @!method create_shipping_zone(options = {})
+    # @param [Hash] options the attributes for the zone
+    # creates a shipping zone with the given attributes
+
+    # @!method update_shipping_zone(id, options = {})
+    # @param [Integer] id the identifier for the zone
+    # @param [Hash] options the attributes for the zone
+    # updates the attributes of the shipping zone with the given id
+
+    # @!method delete_shipping_zone(id)
+    # @param [Integer] id the identifier for the zone
+    # deletes the shipping zone with the given id
 
     # @!method tax_classes(options = {})
     # @param [Hash] options the filters for the tax_classes

data/lib/bigcommerce-oauth-api/version.rb

@@ -1,3 +1,3 @@
 module BigcommerceOAuthAPI
-  VERSION = '1.4.0'.freeze
+  VERSION = '1.4.1'.freeze
 end

data/spec/bigcommerce_oauth_api/client/client_module_spec.rb

@@ -22,7 +22,7 @@ describe BigcommerceOAuthAPI::Client do
       { api_module: 'product', methods: [:all, :select, :create, :update, :delete, :count]},
       { api_module: 'coupon', methods: [:all, :select, :create, :update, :delete, :count]},
       { api_module: 'redirect', methods: [:all, :select, :create, :update, :delete, :count]},
-      { api_module: 'method', methods: [:all, :select], prefix_paths: 'shipping', prefix_methods: 'shipping'},
+      { api_module: 'zone', methods: [:all, :select, :create, :update, :delete], prefix_paths: 'shipping', prefix_methods: 'shipping'},
       { api_module: 'tax_class', scope: :self, methods: [:all, :select]},
       { api_module: 'hook', methods: [:all, :select, :create, :update, :delete], legacy: false}
   ]. each do |api_description|

data/spec/bigcommerce_oauth_api/client/client_nested_module_spec.rb

@@ -17,6 +17,7 @@ describe BigcommerceOAuthAPI::Client do
       { api_module: 'value', api_parent_module: 'option', methods: [:all, :select, :create, :update, :delete]},
       { api_module: 'discount_rule', api_parent_module: 'product', methods: [:all, :select, :create, :update, :delete, :count]},
       { api_module: 'image', api_parent_module: 'product', methods: [:all, :select, :create, :update, :delete, :count]},
+      { api_module: 'method', api_parent_module: 'zone', methods: [:all, :select, :create, :update, :delete], prefix_paths: 'shipping', prefix_methods: 'shipping'},
       { api_module: 'option', api_parent_module: 'product', methods: [:all, :select]},
       { api_module: 'review', api_parent_module: 'product', methods: [:all]},
       { api_module: 'rule', api_parent_module: 'product', methods: [:all, :select, :create, :update, :delete, :count]},

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bigcommerce-oauth-api
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Christian Orthmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-09 00:00:00.000000000 Z
+date: 2017-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake