bigcommerce-oauth-api 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75787d5311705ef1dc2959615900806588650813
-  data.tar.gz: 0220bf99f82590445b75d1c7486663c24186bbab
+  metadata.gz: a484aad29a21d82ebb61dc10ad1051c174af5e64
+  data.tar.gz: 84be7bae67c690f8f40e735af3862c1a9dfab2e1
 SHA512:
-  metadata.gz: b93b0f562c53505273ae9d3057385ffee21090d920032c38f6fed8ac46e476c6d12ece7cd0b73153dd597eba72a40e050ab3cc8dd36c0290d68a390401cfd2a9
-  data.tar.gz: 0c84e1610a355f2e09e2318e1c8d069016725a2ae99ece2c65ba20864d2407c9de4b23d1e335e8f89e4875a5b26f0d5e248da940bea795bef13fd1cec535d4b1
+  metadata.gz: 3508631521b911e5b7956bdd5cbe1387551b036348b09f6209ad5de061b86e0cbed6a24e422ddb0ddeee56186cb8e1de5a29ad0a445086c022837ca0a13b5010
+  data.tar.gz: 6ca92909b5b6cd1edc34bd9f98e11e5073490c4739f0d7412971e960f13a9988de4031e8ef234d084a61190ea8e5a439a74aa670640dbc51d45c1badd6600dde

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+### 1.4.0 (2016-10-09)
+
+Features:
+
+    - added banner apis
+    - added gift certificate apis
+    - enable BigcommerceOAuthAPI::Resource to set attributes through methods (ex. resource.attribute_name = 'abc')
+    - add .to_h method on BigcommerceOAuthAPI::Error. This method will parse the json error message and return it as a hash.
+
+Bugfixes:
+
+    - enable BigcommerceOAuthAPI::Resource to convert array attributes to arrays of BigcommerceOAuthAPI::Resource.
+
+Deprecation warnings added:
+
+    - config.if_modified_since will be removed in v2.0.0
+    - config.format will be removed in v2.0.0
+
 ### 1.3.2 (2016-01-14)
 
 Bugfixes:

data/README.md

@@ -23,14 +23,14 @@ Configuration
 The gem can be configured either by module or class configuration. Starting from v1.2.0 `bigcommerce-oauth-api` supports both OAuth and legacy authentication.
 ```
 # module oauth configuration
-BigcommerceOAuthAPI.configuration do |config|
+BigcommerceOAuthAPI.configure do |config|
     config.store_hash = 'YOU STORE ID'
     config.client_id = 'YOUR CLIENT ID'
     config.access_token = 'YOUR OAUTH ACCESS TOKEN'
 end
 
 # module legacy (basic auth) configuration
-BigcommerceOAuthAPI.configuration do |config|
+BigcommerceOAuthAPI.configure do |config|
     config.endpoint = 'YOU STORE URL (https://store-XYZ.mybigcommerce.com)'
     config.user_name = 'API USER NAME'
     config.api_key = 'API KEY'
@@ -132,7 +132,9 @@ customer address | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/custo
 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

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-01-14'
+  s.date        = '2016-10-09'
   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/api.rb

@@ -8,6 +8,8 @@ module BigcommerceOAuthAPI
 
     def initialize(options = {})
       merged_options = BigcommerceOAuthAPI.options.merge(options)
+      warn "[DEPRECATION] bigcommerce-oauth-api: 'config.format' will be removed in v2.0.0" unless merged_options[:format] == :json
+      warn "[DEPRECATION] bigcommerce-oauth-api: 'config.if_modified_since' will be removed in v2.0.0" unless merged_options[:if_modified_since].nil?
 
       Configuration::VALID_OPTIONS_KEYS.each do |key|
         send("#{key}=", merged_options[key])

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

@@ -30,7 +30,9 @@ module BigcommerceOAuthAPI
                      :customer_group => { api_module: :customer_group, scope: :self, methods: [:all, :select, :create, :update, :delete]},
                      :geography_country => { api_module: :country, scope: :self, methods: [:all, :select, :count]},
                      :geography_state => { api_module: :state, scope: :country, methods: [:all, :select, :count]},
+                     :marketing_banner => { api_module: :banner, scope: :self, methods: [:all, :select, :create, :update, :delete]},
                      :marketing_coupons => { api_module: :coupon, scope: :self, methods: [:all, :select, :create, :update, :delete, :count]},
+                     :marketing_gift_certificate => { api_module: :gift_certificate, scope: :self, methods: [:all, :select, :create, :update, :delete]},
                      :option => { api_module: :option, scope: :self, methods: [:all, :select, :create, :update, :delete, :count]},
                      :option_set => { api_module: :option_set, scope: :self, methods: [:all, :select, :create, :update, :delete, :count]},
                      :option_set_option => { api_module: :option, scope: :option_set, methods: [:all, :select, :create, :update, :delete]},
@@ -74,7 +76,7 @@ module BigcommerceOAuthAPI
     # @!method update_blog_post(id, options = {})
     # @param [Integer] id the identifier for the post
     # @param [Hash] options the attributes for the post
-    # update the attributes of the post with the given id
+    # updates the attributes of the post with the given id
 
     # @!method delete_blog_post(id)
     # @param [Integer] id the identifier for the post
@@ -99,7 +101,7 @@ module BigcommerceOAuthAPI
     # @!method update_brand(id, options = {})
     # @param [Integer] id the identifier for the brand
     # @param [Hash] options the attributes for the brand
-    # update the attributes of the brand with the given id
+    # updates the attributes of the brand with the given id
 
     # @!method delete_brand(id)
     # @param [Integer] id the identifier for the brand
@@ -124,7 +126,7 @@ module BigcommerceOAuthAPI
     # @!method update_category(id, options = {})
     # @param [Integer] id the identifier for the category
     # @param [Hash] options the attributes for the category
-    # update the attributes of the category with the given id
+    # updates the attributes of the category with the given id
 
     # @!method delete_category(id)
     # @param [Integer] id the identifier for the category
@@ -145,7 +147,7 @@ module BigcommerceOAuthAPI
     # @!method update_customer(id, options = {})
     # @param [Integer] id the identifier for the customer
     # @param [Hash] options the attributes for the customer
-    # update the attributes of the customer with the given id
+    # updates the attributes of the customer with the given id
 
     # @!method delete_customer(id)
     # @param [Integer] id the identifier for the customer
@@ -161,8 +163,8 @@ module BigcommerceOAuthAPI
     # gets a list of addresses for the given customer
 
     # @!method customer_address(customer_id, id, options = {})
-    # @param [Integer] id the identifier for the address
     # @param [Integer] customer_id the identifier for the customer
+    # @param [Integer] id the identifier for the address
     # gets the address with the given id for the given customer
 
     # @!method create_customer_address(customer_id, options = {})
@@ -171,14 +173,14 @@ module BigcommerceOAuthAPI
     # creates a address with the given attributes for the given customer
 
     # @!method update_customer_address(customer_id, id, options = {})
-    # @param [Integer] id the identifier for the address
     # @param [Integer] customer_id the identifier for the customer
+    # @param [Integer] id the identifier for the address
     # @param [Hash] options the attributes for the address
-    # update the attributes of the address with the given id for the given customer
+    # updates the attributes of the address with the given id for the given customer
 
     # @!method delete_customer_address(customer_id, id)
-    # @param [Integer] id the identifier for the address
     # @param [Integer] customer_id the identifier for the customer
+    # @param [Integer] id the identifier for the address
     # deletes the address with the given id for the given customer
 
     # @!method customer_groups(options = {})
@@ -196,7 +198,7 @@ module BigcommerceOAuthAPI
     # @!method update_customer_group(id, options = {})
     # @param [Integer] id the identifier for the customer_group
     # @param [Hash] options the attributes for the customer_group
-    # update the attributes of the customer_group with the given id
+    # updates the attributes of the customer_group with the given id
 
     # @!method delete_customer_group(id)
     # @param [Integer] id the identifier for the customer_group
@@ -220,8 +222,8 @@ module BigcommerceOAuthAPI
     # gets a list of states for the given country
 
     # @!method country_state(country_id, id, options = {})
-    # @param [Integer] id the identifier for the state
     # @param [Integer] country_id the identifier for the country
+    # @param [Integer] id the identifier for the state
     # gets the state with the given id for the given country
 
     # @!method country_states_count(country_id, options = {})
@@ -229,6 +231,27 @@ module BigcommerceOAuthAPI
     # @param [Hash] options the filters for the states
     # returns the number of states for the given country
 
+    # @!method banners(options = {})
+    # @param [Hash] options the filters for the banners
+    # gets a list of banners
+
+    # @!method banner(id, options = {})
+    # @param [Integer] id the identifier for the banner
+    # gets the banner with the given id
+
+    # @!method create_banner(options = {})
+    # @param [Hash] options the attributes for the banner
+    # creates a banner with the given attributes
+
+    # @!method update_banner(id, options = {})
+    # @param [Integer] id the identifier for the banner
+    # @param [Hash] options the attributes for the banner
+    # updates the attributes of the banner with the given id
+
+    # @!method delete_banner(id)
+    # @param [Integer] id the identifier for the banner
+    # deletes the banner with the given id
+
     # @!method coupons(options = {})
     # @param [Hash] options the filters for the coupons
     # gets a list of coupons
@@ -244,7 +267,7 @@ module BigcommerceOAuthAPI
     # @!method update_coupon(id, options = {})
     # @param [Integer] id the identifier for the coupon
     # @param [Hash] options the attributes for the coupon
-    # update the attributes of the coupon with the given id
+    # updates the attributes of the coupon with the given id
 
     # @!method delete_coupon(id)
     # @param [Integer] id the identifier for the coupon
@@ -254,6 +277,27 @@ module BigcommerceOAuthAPI
     # @param [Hash] options the filters for the coupons
     # returns the number of coupons
 
+    # @!method gift_certificates(options = {})
+    # @param [Hash] options the filters for the gift_certificates
+    # gets a list of gift_certificates
+
+    # @!method gift_certificate(id, options = {})
+    # @param [Integer] id the identifier for the gift_certificate
+    # gets the gift_certificate with the given id
+
+    # @!method create_gift_certificate(options = {})
+    # @param [Hash] options the attributes for the gift_certificate
+    # creates a gift_certificate with the given attributes
+
+    # @!method update_gift_certificate(id, options = {})
+    # @param [Integer] id the identifier for the gift_certificate
+    # @param [Hash] options the attributes for the gift_certificate
+    # updates the attributes of the gift_certificate with the given id
+
+    # @!method delete_gift_certificate(id)
+    # @param [Integer] id the identifier for the gift_certificate
+    # deletes the gift_certificate with the given id
+
     # @!method options(options = {})
     # @param [Hash] options the filters for the options
     # gets a list of options
@@ -269,7 +313,7 @@ module BigcommerceOAuthAPI
     # @!method update_option(id, options = {})
     # @param [Integer] id the identifier for the option
     # @param [Hash] options the attributes for the option
-    # update the attributes of the option with the given id
+    # updates the attributes of the option with the given id
 
     # @!method delete_option(id)
     # @param [Integer] id the identifier for the option
@@ -294,7 +338,7 @@ module BigcommerceOAuthAPI
     # @!method update_option_set(id, options = {})
     # @param [Integer] id the identifier for the option_set
     # @param [Hash] options the attributes for the option_set
-    # update the attributes of the option_set with the given id
+    # updates the attributes of the option_set with the given id
 
     # @!method delete_option_set(id)
     # @param [Integer] id the identifier for the option_set
@@ -310,8 +354,8 @@ module BigcommerceOAuthAPI
     # gets a list of options for the given option_set
 
     # @!method option_set_option(option_set_id, id, options = {})
-    # @param [Integer] id the identifier for the option
     # @param [Integer] option_set_id the identifier for the option_set
+    # @param [Integer] id the identifier for the option
     # gets the option with the given id for the given option_set
 
     # @!method create_option_set_option(option_set_id, options = {})
@@ -320,14 +364,14 @@ module BigcommerceOAuthAPI
     # creates a option with the given attributes for the given option_set
 
     # @!method update_option_set_option(option_set_id, id, options = {})
-    # @param [Integer] id the identifier for the option
     # @param [Integer] option_set_id the identifier for the option_set
+    # @param [Integer] id the identifier for the option
     # @param [Hash] options the attributes for the option
-    # update the attributes of the option with the given id for the given option_set
+    # updates the attributes of the option with the given id for the given option_set
 
     # @!method delete_option_set_option(option_set_id, id)
-    # @param [Integer] id the identifier for the option
     # @param [Integer] option_set_id the identifier for the option_set
+    # @param [Integer] id the identifier for the option
     # deletes the option with the given id for the given option_set
 
     # @!method option_values(option_id, options = {})
@@ -336,8 +380,8 @@ module BigcommerceOAuthAPI
     # gets a list of values for the given option
 
     # @!method option_value(option_id, id, options = {})
-    # @param [Integer] id the identifier for the value
     # @param [Integer] option_id the identifier for the option
+    # @param [Integer] id the identifier for the value
     # gets the value with the given id for the given option
 
     # @!method create_option_value(option_id, options = {})
@@ -346,14 +390,14 @@ module BigcommerceOAuthAPI
     # creates a value with the given attributes for the given option
 
     # @!method update_option_value(option_id, id, options = {})
-    # @param [Integer] id the identifier for the value
     # @param [Integer] option_id the identifier for the option
+    # @param [Integer] id the identifier for the value
     # @param [Hash] options the attributes for the value
-    # update the attributes of the value with the given id for the given option
+    # updates the attributes of the value with the given id for the given option
 
     # @!method delete_option_value(option_id, id)
-    # @param [Integer] id the identifier for the value
     # @param [Integer] option_id the identifier for the option
+    # @param [Integer] id the identifier for the value
     # deletes the value with the given id for the given option
 
     # @!method order_statuses(options = {})
@@ -379,7 +423,7 @@ module BigcommerceOAuthAPI
     # @!method update_order(id, options = {})
     # @param [Integer] id the identifier for the order
     # @param [Hash] options the attributes for the order
-    # update the attributes of the order with the given id
+    # updates the attributes of the order with the given id
 
     # @!method delete_order(id)
     # @param [Integer] id the identifier for the order
@@ -395,8 +439,8 @@ module BigcommerceOAuthAPI
     # gets a list of coupons for the given order
 
     # @!method order_coupon(order_id, id, options = {})
-    # @param [Integer] id the identifier for the coupon
     # @param [Integer] order_id the identifier for the order
+    # @param [Integer] id the identifier for the coupon
     # gets the coupon with the given id for the given order
 
     # @!method order_messages(order_id, options = {})
@@ -405,8 +449,8 @@ module BigcommerceOAuthAPI
     # gets a list of messages for the given order
 
     # @!method order_message(order_id, id, options = {})
-    # @param [Integer] id the identifier for the message
     # @param [Integer] order_id the identifier for the order
+    # @param [Integer] id the identifier for the message
     # gets the message with the given id for the given order
 
     # @!method order_products(order_id, options = {})
@@ -415,8 +459,8 @@ module BigcommerceOAuthAPI
     # gets a list of products for the given order
 
     # @!method order_product(order_id, id, options = {})
-    # @param [Integer] id the identifier for the product
     # @param [Integer] order_id the identifier for the order
+    # @param [Integer] id the identifier for the product
     # gets the product with the given id for the given order
 
     # @!method order_products_count(order_id, options = {})
@@ -430,8 +474,8 @@ module BigcommerceOAuthAPI
     # gets a list of shipments for the given order
 
     # @!method order_shipment(order_id, id, options = {})
-    # @param [Integer] id the identifier for the shipment
     # @param [Integer] order_id the identifier for the order
+    # @param [Integer] id the identifier for the shipment
     # gets the shipment with the given id for the given order
 
     # @!method create_order_shipment(order_id, options = {})
@@ -440,14 +484,14 @@ module BigcommerceOAuthAPI
     # creates a shipment with the given attributes for the given order
 
     # @!method update_order_shipment(order_id, id, options = {})
-    # @param [Integer] id the identifier for the shipment
     # @param [Integer] order_id the identifier for the order
+    # @param [Integer] id the identifier for the shipment
     # @param [Hash] options the attributes for the shipment
-    # update the attributes of the shipment with the given id for the given order
+    # updates the attributes of the shipment with the given id for the given order
 
     # @!method delete_order_shipment(order_id, id)
-    # @param [Integer] id the identifier for the shipment
     # @param [Integer] order_id the identifier for the order
+    # @param [Integer] id the identifier for the shipment
     # deletes the shipment with the given id for the given order
 
     # @!method order_shipping_addresses(order_id, options = {})
@@ -456,8 +500,8 @@ module BigcommerceOAuthAPI
     # gets a list of shipping_addresses for the given order
 
     # @!method order_shipping_address(order_id, id, options = {})
-    # @param [Integer] id the identifier for the shipping_address
     # @param [Integer] order_id the identifier for the order
+    # @param [Integer] id the identifier for the shipping_address
     # gets the shipping_address with the given id for the given order
 
     # @!method order_taxes(order_id, options = {})
@@ -466,8 +510,8 @@ module BigcommerceOAuthAPI
     # gets a list of taxes for the given order
 
     # @!method order_tax(order_id, id, options = {})
-    # @param [Integer] id the identifier for the tax
     # @param [Integer] order_id the identifier for the order
+    # @param [Integer] id the identifier for the tax
     # gets the tax with the given id for the given order
 
     # @!method payment_methods(options = {})
@@ -489,7 +533,7 @@ module BigcommerceOAuthAPI
     # @!method update_product(id, options = {})
     # @param [Integer] id the identifier for the product
     # @param [Hash] options the attributes for the product
-    # update the attributes of the product with the given id
+    # updates the attributes of the product with the given id
 
     # @!method delete_product(id)
     # @param [Integer] id the identifier for the product
@@ -505,8 +549,8 @@ module BigcommerceOAuthAPI
     # gets a list of custom_fields for the given product
 
     # @!method product_custom_field(product_id, id, options = {})
-    # @param [Integer] id the identifier for the custom_field
     # @param [Integer] product_id the identifier for the product
+    # @param [Integer] id the identifier for the custom_field
     # gets the custom_field with the given id for the given product
 
     # @!method create_product_custom_field(product_id, options = {})
@@ -515,14 +559,14 @@ module BigcommerceOAuthAPI
     # creates a custom_field with the given attributes for the given product
 
     # @!method update_product_custom_field(product_id, id, options = {})
-    # @param [Integer] id the identifier for the custom_field
     # @param [Integer] product_id the identifier for the product
+    # @param [Integer] id the identifier for the custom_field
     # @param [Hash] options the attributes for the custom_field
-    # update the attributes of the custom_field with the given id for the given product
+    # updates the attributes of the custom_field with the given id for the given product
 
     # @!method delete_product_custom_field(product_id, id)
-    # @param [Integer] id the identifier for the custom_field
     # @param [Integer] product_id the identifier for the product
+    # @param [Integer] id the identifier for the custom_field
     # deletes the custom_field with the given id for the given product
 
     # @!method product_discount_rules(product_id, options = {})
@@ -531,8 +575,8 @@ module BigcommerceOAuthAPI
     # gets a list of discount_rules for the given product
 
     # @!method product_discount_rule(product_id, id, options = {})
-    # @param [Integer] id the identifier for the discount_rule
     # @param [Integer] product_id the identifier for the product
+    # @param [Integer] id the identifier for the discount_rule
     # gets the discount_rule with the given id for the given product
 
     # @!method create_product_discount_rule(product_id, options = {})
@@ -541,14 +585,14 @@ module BigcommerceOAuthAPI
     # creates a discount_rule with the given attributes for the given product
 
     # @!method update_product_discount_rule(product_id, id, options = {})
-    # @param [Integer] id the identifier for the discount_rule
     # @param [Integer] product_id the identifier for the product
+    # @param [Integer] id the identifier for the discount_rule
     # @param [Hash] options the attributes for the discount_rule
-    # update the attributes of the discount_rule with the given id for the given product
+    # updates the attributes of the discount_rule with the given id for the given product
 
     # @!method delete_product_discount_rule(product_id, id)
-    # @param [Integer] id the identifier for the discount_rule
     # @param [Integer] product_id the identifier for the product
+    # @param [Integer] id the identifier for the discount_rule
     # deletes the discount_rule with the given id for the given product
 
     # @!method product_discount_rules_count(product_id, options = {})
@@ -562,13 +606,13 @@ module BigcommerceOAuthAPI
     # gets a list of configurable_fields for the given product
 
     # @!method product_configurable_field(product_id, id, options = {})
-    # @param [Integer] id the identifier for the configurable_field
     # @param [Integer] product_id the identifier for the product
+    # @param [Integer] id the identifier for the configurable_field
     # gets the configurable_field with the given id for the given product
 
     # @!method delete_product_configurable_field(product_id, id)
-    # @param [Integer] id the identifier for the configurable_field
     # @param [Integer] product_id the identifier for the product
+    # @param [Integer] id the identifier for the configurable_field
     # deletes the configurable_field with the given id for the given product
 
     # @!method product_configurable_fields_count(product_id, options = {})
@@ -582,8 +626,8 @@ module BigcommerceOAuthAPI
     # gets a list of images for the given product
 
     # @!method product_image(product_id, id, options = {})
-    # @param [Integer] id the identifier for the image
     # @param [Integer] product_id the identifier for the product
+    # @param [Integer] id the identifier for the image
     # gets the image with the given id for the given product
 
     # @!method create_product_image(product_id, options = {})
@@ -592,14 +636,14 @@ module BigcommerceOAuthAPI
     # creates a image with the given attributes for the given product
 
     # @!method update_product_image(product_id, id, options = {})
-    # @param [Integer] id the identifier for the image
     # @param [Integer] product_id the identifier for the product
+    # @param [Integer] id the identifier for the image
     # @param [Hash] options the attributes for the image
-    # update the attributes of the image with the given id for the given product
+    # updates the attributes of the image with the given id for the given product
 
     # @!method delete_product_image(product_id, id)
-    # @param [Integer] id the identifier for the image
     # @param [Integer] product_id the identifier for the product
+    # @param [Integer] id the identifier for the image
     # deletes the image with the given id for the given product
 
     # @!method product_images_count(product_id, options = {})
@@ -613,8 +657,8 @@ module BigcommerceOAuthAPI
     # gets a list of options for the given product
 
     # @!method product_option(product_id, id, options = {})
-    # @param [Integer] id the identifier for the option
     # @param [Integer] product_id the identifier for the product
+    # @param [Integer] id the identifier for the option
     # gets the option with the given id for the given product
 
     # @!method product_reviews(product_id, options = {})
@@ -628,8 +672,8 @@ module BigcommerceOAuthAPI
     # gets a list of rules for the given product
 
     # @!method product_rule(product_id, id, options = {})
-    # @param [Integer] id the identifier for the rule
     # @param [Integer] product_id the identifier for the product
+    # @param [Integer] id the identifier for the rule
     # gets the rule with the given id for the given product
 
     # @!method create_product_rule(product_id, options = {})
@@ -638,14 +682,14 @@ module BigcommerceOAuthAPI
     # creates a rule with the given attributes for the given product
 
     # @!method update_product_rule(product_id, id, options = {})
-    # @param [Integer] id the identifier for the rule
     # @param [Integer] product_id the identifier for the product
+    # @param [Integer] id the identifier for the rule
     # @param [Hash] options the attributes for the rule
-    # update the attributes of the rule with the given id for the given product
+    # updates the attributes of the rule with the given id for the given product
 
     # @!method delete_product_rule(product_id, id)
-    # @param [Integer] id the identifier for the rule
     # @param [Integer] product_id the identifier for the product
+    # @param [Integer] id the identifier for the rule
     # deletes the rule with the given id for the given product
 
     # @!method product_rules_count(product_id, options = {})
@@ -659,8 +703,8 @@ module BigcommerceOAuthAPI
     # gets a list of videos for the given product
 
     # @!method product_video(product_id, id, options = {})
-    # @param [Integer] id the identifier for the video
     # @param [Integer] product_id the identifier for the product
+    # @param [Integer] id the identifier for the video
     # gets the video with the given id for the given product
 
     # @!method create_product_video(product_id, options = {})
@@ -669,14 +713,14 @@ module BigcommerceOAuthAPI
     # creates a video with the given attributes for the given product
 
     # @!method update_product_video(product_id, id, options = {})
-    # @param [Integer] id the identifier for the video
     # @param [Integer] product_id the identifier for the product
+    # @param [Integer] id the identifier for the video
     # @param [Hash] options the attributes for the video
-    # update the attributes of the video with the given id for the given product
+    # updates the attributes of the video with the given id for the given product
 
     # @!method delete_product_video(product_id, id)
-    # @param [Integer] id the identifier for the video
     # @param [Integer] product_id the identifier for the product
+    # @param [Integer] id the identifier for the video
     # deletes the video with the given id for the given product
 
     # @!method product_videos_count(product_id, options = {})
@@ -690,8 +734,8 @@ module BigcommerceOAuthAPI
     # gets a list of skus for the given product
 
     # @!method product_sku(product_id, id, options = {})
-    # @param [Integer] id the identifier for the sku
     # @param [Integer] product_id the identifier for the product
+    # @param [Integer] id the identifier for the sku
     # gets the sku with the given id for the given product
 
     # @!method create_product_sku(product_id, options = {})
@@ -700,14 +744,14 @@ module BigcommerceOAuthAPI
     # creates a sku with the given attributes for the given product
 
     # @!method update_product_sku(product_id, id, options = {})
-    # @param [Integer] id the identifier for the sku
     # @param [Integer] product_id the identifier for the product
+    # @param [Integer] id the identifier for the sku
     # @param [Hash] options the attributes for the sku
-    # update the attributes of the sku with the given id for the given product
+    # updates the attributes of the sku with the given id for the given product
 
     # @!method delete_product_sku(product_id, id)
-    # @param [Integer] id the identifier for the sku
     # @param [Integer] product_id the identifier for the product
+    # @param [Integer] id the identifier for the sku
     # deletes the sku with the given id for the given product
 
     # @!method product_skus_count(product_id, options = {})
@@ -730,7 +774,7 @@ module BigcommerceOAuthAPI
     # @!method update_redirect(id, options = {})
     # @param [Integer] id the identifier for the redirect
     # @param [Hash] options the attributes for the redirect
-    # update the attributes of the redirect with the given id
+    # updates the attributes of the redirect with the given id
 
     # @!method delete_redirect(id)
     # @param [Integer] id the identifier for the redirect
@@ -771,7 +815,7 @@ module BigcommerceOAuthAPI
     # @!method update_hook(id, options = {})
     # @param [Integer] id the identifier for the hook
     # @param [Hash] options the attributes for the hook
-    # update the attributes of the hook with the given id
+    # updates the attributes of the hook with the given id
 
     # @!method delete_hook(id)
     # @param [Integer] id the identifier for the hook

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

@@ -1,5 +1,12 @@
+require 'json'
+
 module BigcommerceOAuthAPI
   class Error < StandardError
+
+    def to_h
+      JSON.parse(message, symbolize_names: true) rescue {}
+    end
+
     def inspect
       "#<BigcommerceOAuthAPI::Error: BigcommerceOAuthAPI::Error message=\"#{message}\">"
     end

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

@@ -7,11 +7,13 @@ module BigcommerceOAuthAPI
     end
 
     def [](key)
-      @attributes[key.to_sym]
+      value = memoize(key.to_sym) # get memoized value if present
+      value || @attributes[key.to_sym]
     end
 
     def []=(key, value)
       @attributes[key.to_sym] = value
+      unmemoize(key.to_sym) # protect against memoized data
     end
 
     def ==(other)
@@ -31,27 +33,21 @@ module BigcommerceOAuthAPI
     end
 
     def method_missing(method_sym, *arguments)
-      if @attributes.include?(method_sym)
+      method_type = method_sym.to_s[-1] # last char
+      if @attributes.include?(method_sym) || method_type == '='
         attribute_name = method_sym.to_s.gsub(/(\?$)|(=$)/, '')
-        self.instance_eval build_attribute_getter(attribute_name)
+        case method_type
+          when '='
+            self.instance_eval build_attribute_setter(attribute_name)
+          else
+            self.instance_eval build_attribute_getter(attribute_name)
+        end
         send(method_sym, *arguments)
       else
         super(method_sym, *arguments)
       end
     end
 
-    def build_attribute_getter(attribute_name)
-      "def #{attribute_name}
-        if @attributes[:#{attribute_name}] && @attributes[:#{attribute_name}].is_a?(Hash)
-          memoize(:#{attribute_name}) do
-            self.class.new(@attributes[:#{attribute_name}])
-          end
-        else
-          @attributes[:#{attribute_name}]
-        end
-      end"
-    end
-
     def marshal_dump
       {}.merge(@attributes.to_h)
     end
@@ -71,5 +67,37 @@ module BigcommerceOAuthAPI
 
       var
     end
+
+    def unmemoize(name)
+      var = instance_variable_get("@#{name.to_s}") rescue nil
+      unless var.nil?
+        instance_variable_set("@#{name.to_s}", nil)
+      end
+    end
+
+    def build_attribute_getter(attribute_name)
+      "def #{attribute_name}
+        if @attributes[:#{attribute_name}] && @attributes[:#{attribute_name}].is_a?(Hash)
+          memoize(:#{attribute_name}) do
+            self.class.new(@attributes[:#{attribute_name}])
+          end
+        elsif @attributes[:#{attribute_name}] && @attributes[:#{attribute_name}].is_a?(Array)
+          memoize(:#{attribute_name}) do
+            @attributes[:#{attribute_name}].map do |entry|
+              self.class.new(entry)
+            end
+          end
+        else
+          @attributes[:#{attribute_name}]
+        end
+      end"
+    end
+
+    def build_attribute_setter(attribute_name)
+      "def #{attribute_name}=(value)
+        @attributes[:#{attribute_name}] = value
+        unmemoize(:#{attribute_name}) # protect against memoized data
+      end"
+    end
   end
 end

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

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

data/spec/bigcommerce_oauth_api/client/client_module_spec.rb

@@ -9,6 +9,8 @@ describe BigcommerceOAuthAPI::Client do
       { api_module: 'tag', methods: [:all], prefix_paths: 'blog', prefix_methods: 'blog'},
       { api_module: 'brand', methods: [:all, :select, :create, :update, :delete, :count]},
       { api_module: 'category', methods: [:all, :select, :create, :update, :delete]},
+      { api_module: 'banner', methods: [:all, :select, :create, :update, :delete]},
+      { api_module: 'gift_certificate', methods: [:all, :select, :create, :update, :delete]},
       { api_module: 'customer', methods: [:all, :select, :create, :update, :delete, :count]},
       { api_module: 'customer_group', methods: [:all, :select, :create, :update, :delete]},
       { api_module: 'country', scope: :self, methods: [:all, :select, :count]},

data/spec/bigcommerce_oauth_api/resource_spec.rb

@@ -22,6 +22,18 @@ module BigcommerceOAuthAPI
         expect(instance.c[:foo]).to eql('bar')
         expect(instance.c.foo).to eql('bar')
       end
+
+      it 'can set attributes' do
+        expect(instance.a).to eq('foo')
+        instance.a = 'method'
+        expect(instance.a).to eq('method')
+        instance['a'] = 'hash'
+        expect(instance.a).to eq('hash')
+        instance[:a] = 'symbol'
+        expect(instance.a).to eq('symbol')
+        instance.new_method = 'new stuff'
+        expect(instance.new_method).to eq('new stuff')
+      end
     end
 
     context 'when initialized with a deeply nested hash' do
@@ -39,6 +51,18 @@ module BigcommerceOAuthAPI
         expect(instance.a.b.c.d).to eql('e')
       end
 
+      it 'can set attributes' do
+        expect(instance.a.b.c.d).to eq('e')
+        instance.a.b.c.d = 'method'
+        expect(instance.a.b.c.d).to eq('method')
+        instance['a']['b']['c']['d'] = 'hash'
+        expect(instance.a.b.c.d).to eq('hash')
+        instance[:a][:b][:c][:d] = 'symbol'
+        expect(instance.a.b.c.d).to eq('symbol')
+        instance.a.b.c.new_method = 'new stuff'
+        expect(instance.a.b.c.new_method).to eq('new stuff')
+      end
+
       describe '#marshal_dump' do
         it 'can load a marshal dump correctly' do
           dump = Marshal.dump(instance)
@@ -50,5 +74,50 @@ module BigcommerceOAuthAPI
         end
       end
     end
+
+    context 'when initialized with a list attribute' do
+      let(:instance) do
+        described_class.new({a: [{b: 1}, {b: 2}] })
+      end
+
+      it 'converts the list elements to resources' do
+        expect(instance).to be
+        expect(instance.respond_to?(:a)).to be true
+        expect(instance.a).to be_a Array
+        expect(instance.a.size).to eq(2)
+        instance.a.each do |entry|
+          expect(entry).to be_a BigcommerceOAuthAPI::Resource
+          expect(entry.respond_to?(:b)).to be true
+        end
+      end
+
+      it 'can set attributes' do
+        expect(instance.a).to be_a Array
+        first_object = instance.a.first
+        expect(first_object.b).to eq(1)
+        first_object.b = 3
+        expect(instance.a.first.b).to eq(3)
+        instance[:a][0][:b] = 4
+        expect(instance.a.first.b).to eq(4)
+        instance['a'][0]['b'] = 5
+        expect(instance.a.first.b).to eq(5)
+      end
+
+      describe '#marshal_dump' do
+        it 'can load a marshal dump correctly' do
+          dump = Marshal.dump(instance)
+          expect(dump).to be_a String
+          loaded_object = Marshal.load(dump)
+          expect(loaded_object).to_not be_a String
+          expect(loaded_object).to be_a BigcommerceOAuthAPI::Resource
+          expect(loaded_object.a).to be_a Array
+          expect(loaded_object.a.size).to eq(2)
+          loaded_object.a.each do |entry|
+            expect(entry).to be_a BigcommerceOAuthAPI::Resource
+            expect(entry.respond_to?(:b)).to be true
+          end
+        end
+      end
+    end
   end
 end

metadata

@@ -1,145 +1,145 @@
 --- !ruby/object:Gem::Specification
 name: bigcommerce-oauth-api
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Christian Orthmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-14 00:00:00.000000000 Z
+date: 2016-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov-rcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: 5.0.0
 description: Connect Ruby applications to Bigcommerce APIs through OAuth or basic
@@ -149,7 +149,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .rspec
+- ".rspec"
 - CHANGELOG.md
 - Gemfile
 - README.md
@@ -187,20 +187,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby client library for Bigcommerce APIs with OAuth and basic authentication
   support
 test_files: []
-has_rdoc: