bigcommerce_api 0.6.3 → 0.7.0

data/lib/bigcommerce_api/order_coupon.rb

@@ -0,0 +1,13 @@
+module BigcommerceAPI
+  class OrderCoupon < Resource
+    attr_accessor :id,
+                  :coupon_id,
+                  :order_id,
+                  :code,
+                  :amount,
+                  :type,
+                  :discount
+
+    belongs_to :order, :coupon
+  end
+end

data/lib/bigcommerce_api/order_product.rb

@@ -1,14 +1,62 @@
 module BigcommerceAPI
-
   class OrderProduct < Resource
-    attr_accessor :configurable_fields, :bin_picking_number, :cost_price_ex_tax, :base_total, :name, :fixed_shipping_cost, :price_tax, :price_ex_tax, :refund_amount, :quantity, :price_inc_tax, :product_id, :return_id, :is_refunded, :base_price, :order_id, :option_set_id, :weight, :total_ex_tax, :product_options, :event_name, :wrapping_cost_inc_tax, :wrapping_cost_ex_tax, :order_address_id, :id, :wrapping_message, :base_wrapping_cost, :cost_price_inc_tax, :total_inc_tax, :type, :applied_discounts, :wrapping_name, :cost_price_tax, :base_cost_price, :sku, :parent_order_product_id, :wrapping_cost_tax, :ebay_item_id, :quantity_shipped, :total_tax, :ebay_transaction_id, :event_date, :is_bundled_product
-    
-    belongs_to :option_set, {:parent_order_product => :order_product}, :ebay_item, :ebay_transaction, :return, :product, :order
-    # reserved 
+    attr_accessor :id,
+                  :applied_discounts,
+                  :base_cost_price,
+                  :base_price,
+                  :base_total,
+                  :base_wrapping_cost,
+                  :bin_picking_number,
+                  :configurable_fields,
+                  :cost_price_ex_tax,
+                  :cost_price_inc_tax,
+                  :cost_price_tax,
+                  :ebay_item_id,
+                  :ebay_transaction_id,
+                  :event_date,
+                  :event_name,
+                  :fixed_shipping_cost,
+                  :is_bundled_product,
+                  :is_refunded,
+                  :name,
+                  :option_set_id,
+                  :order_address_id,
+                  :order_id,
+                  :parent_order_product_id,
+                  :price_ex_tax,
+                  :price_inc_tax,
+                  :price_tax,
+                  :product_id,
+                  :product_options,
+                  :quantity,
+                  :quantity_shipped,
+                  :refund_amount,
+                  :return_id,
+                  :sku,
+                  :total_ex_tax,
+                  :total_inc_tax,
+                  :total_tax,
+                  :type,
+                  :weight,
+                  :wrapping_cost_ex_tax,
+                  :wrapping_cost_inc_tax,
+                  :wrapping_cost_tax,
+                  :wrapping_message,
+                  :wrapping_name
+
+    belongs_to :option_set,
+               { parent_order_product: :order_product },
+               :ebay_item,
+               :ebay_transaction,
+               :return,
+               :product,
+               :order
+
+    # reserved
     attr_accessor :orderproduct_type
-  
-    def shippingaddress
-      a = BigcommerceAPI::Base.get "/orders/#{self.order_id}/shippingaddresses/#{self.order_address_id}"
+
+    def shipping_address
+      a = BigcommerceAPI::Base.get "/orders/#{self.order_id}/shipping_addresses/#{self.order_address_id}"
       (a.success? and !a.nil?) ? BigcommerceAPI::Shippingaddress.new(a) : nil
     end
 
@@ -38,7 +86,7 @@ module BigcommerceAPI
 
     class << self
 	  	def all(order_id, params={})
-	      resources = BigcommerceAPI::Base.get("/orders/#{order_id}/products", :query => date_adjust(params))
+	      resources = BigcommerceAPI::Base.get("/orders/#{order_id}/products", query: date_adjust(params))
 	      (resources.success? and !resources.nil?) ? resources.collect{|r| self.new(r)} : []
 	    end
 
@@ -47,7 +95,5 @@ module BigcommerceAPI
 	      (r.success? and !r.nil?) ? self.new(r) : nil
 	    end
 	  end
-  
   end
-
-end
+end

data/lib/bigcommerce_api/order_status.rb

@@ -1,8 +1,7 @@
 module BigcommerceAPI
-
   class OrderStatus < Resource
-    attr_accessor :id, :order, :name
-  
+    attr_accessor :id,
+                  :order,
+                  :name
   end
-
-end
+end

data/lib/bigcommerce_api/product.rb

@@ -1,24 +1,102 @@
 module BigcommerceAPI
-
   class Product < Resource
     extend BigcommerceAPI::Countable
 
     # incoming attributes
-    attr_accessor :brand_id, :myob_expense_account, :inventory_tracking, :preorder_release_date, :tax_class_id, :sku, :date_modified, :fixed_cost_shipping_price, :categories, :meta_description, :sort_order, :related_products, :is_visible, :description, :layout_file, :meta_keywords, :rating_total, :price, :event_date_field_name, :height, :order_quantity_minimum, :myob_asset_account, :order_quantity_maximum, :peachtree_gl_account, :retail_price, :availability_description, :weight, :is_preorder_only, :date_created, :open_graph_title, :rating_count, :open_graph_type, :option_set_id, :is_featured, :date_last_imported, :option_set_display, :availability, :is_condition_shown, :name, :inventory_warning_level, :event_date_end, :cost_price, :inventory_level, :event_date_type, :upc, :open_graph_description, :depth, :custom_url, :myob_income_account, :condition, :is_price_hidden, :custom_fields, :configurable_fields, :discount_rules, :warranty, :total_sold, :view_count, :event_date_start, :price_hidden_label, :videos, :sale_price, :bin_picking_number, :preorder_message, :is_open_graph_thumbnail, :search_keywords, :is_free_shipping, :width, :type, :id, :page_title, :downloads 
+    attr_accessor :id,
+                  :availability,
+                  :availability_description,
+                  :bin_picking_number,
+                  :brand_id,
+                  :categories,
+                  :condition,
+                  :configurable_fields,
+                  :cost_price,
+                  :custom_fields,
+                  :custom_url,
+                  :date_created,
+                  :date_last_imported,
+                  :date_modified,
+                  :depth,
+                  :description,
+                  :discount_rules,
+                  :downloads,
+                  :event_date_end,
+                  :event_date_field_name,
+                  :event_date_start,
+                  :event_date_type,
+                  :fixed_cost_shipping_price,
+                  :height,
+                  :inventory_level,
+                  :inventory_tracking,
+                  :inventory_warning_level,
+                  :is_condition_shown,
+                  :is_featured,
+                  :is_free_shipping,
+                  :is_open_graph_thumbnail,
+                  :is_preorder_only,
+                  :is_price_hidden,
+                  :is_visible,
+                  :layout_file,
+                  :meta_description,
+                  :meta_keywords,
+                  :myob_asset_account,
+                  :myob_expense_account,
+                  :myob_income_account,
+                  :name,
+                  :open_graph_description,
+                  :open_graph_title,
+                  :open_graph_type,
+                  :option_set_display,
+                  :option_set_id,
+                  :order_quantity_maximum,
+                  :order_quantity_minimum,
+                  :page_title,
+                  :peachtree_gl_account,
+                  :preorder_message,
+                  :preorder_release_date,
+                  :price,
+                  :price_hidden_label,
+                  :rating_count,
+                  :rating_total,
+                  :related_products,
+                  :retail_price,
+                  :sale_price,
+                  :search_keywords,
+                  :sku,
+                  :sort_order,
+                  :tax_class_id,
+                  :total_sold,
+                  :type,
+                  :upc,
+                  :videos,
+                  :view_count,
+                  :warranty,
+                  :weight,
+                  :width
+
     # has_many
-    attr_accessor :options_hash, :skus_hash, :rules_hash, :images_hash
+    attr_accessor :options_hash,
+                  :skus_hash,
+                  :rules_hash,
+                  :images_hash
 
     # has_one
-    attr_accessor :option_set_resource, :brand_resource
+    attr_accessor :option_set_resource,
+                  :brand_resource
 
-    # reserved 
+    # reserved
     attr_accessor :product_type
 
 
-    has_many :skus, :rules, :images, {:options => :product_options}
-    has_one :brand, :option_set
+    has_many :skus,
+             :rules,
+             :images,
+             { options: :product_options }
+
+    has_one :brand,
+            :option_set
+
     belongs_to :tax_class
-    
   end
-
-end
+end

data/lib/bigcommerce_api/product_option.rb

@@ -1,10 +1,11 @@
 module BigcommerceAPI
-
   class ProductOption < Resource
-    attr_accessor :id, :display_name, :option_id, :sort_order, :is_required
+    attr_accessor :id,
+                  :display_name,
+                  :is_required,
+                  :option_id,
+                  :sort_order
 
     belongs_to :option
-  
   end
-
-end
+end

data/lib/bigcommerce_api/resource.rb

@@ -1,20 +1,10 @@
-module BigcommerceAPI  
+module BigcommerceAPI
 
   class Resource < Base
     attr_accessor :errors
 
-  	def initialize(data)
-      data.each do |k, v|
-        if v and v.is_a? String
-          val = v.gsub(/\n/, '').gsub(/\t/, '').strip
-        else
-          val = v
-        end
-        k = "#{k}_hash" if !self.class.has_many_options.nil? and self.class.has_many_options.include? k
-        k = "#{k}_resource" if !self.class.has_one_options.nil? and self.class.has_one_options.include? k
-        k = "#{self.resource}_#{k}" if k == 'type'
-        send(:"#{k}=", val) if self.respond_to? "#{k}="
-      end
+    def initialize(data)
+      self.assign_attributes(data)
       self.attributes_were = data
     end
 
@@ -24,7 +14,7 @@ module BigcommerceAPI
     end
 
     def save
-       url = self.resource_url
+      url = self.resource_url
       if self.id.nil?
         # delete the parent id if there is one
         self.send(self.parent + '_id=', nil) if !self.parent.nil?
@@ -33,30 +23,52 @@ module BigcommerceAPI
       else
         # only send updated attributes
         attrs = self.attributes
-        body = Hash.new 
+        body = Hash.new
         self.changed.each{|c| body[c] = attrs[c]}
+        body.delete('date_modified')
         response = BigcommerceAPI::Resource.http_request(:put, "/#{url}/#{self.id}", :body => body.to_json)
       end
-      if response.success?
-        return self.id.nil? ? self.class.new(response.parsed_response) : true
-      else
-        self.errors = response.parsed_response
-        return false
+
+      self.class.new(response.parsed_response)
+    end
+
+    def update_attributes(attributes)
+      assign_attributes(attributes) && save
+    end
+
+    def assign_attributes(attributes)
+      attributes.each do |k, v|
+        if v and v.is_a? String
+          val = v.gsub(/\n/, '').gsub(/\t/, '').strip
+        else
+          val = v
+        end
+        k = "#{k}_hash" if !self.class.has_many_options.nil? and self.class.has_many_options.include? k
+        k = "#{k}_resource" if !self.class.has_one_options.nil? and self.class.has_one_options.include? k
+        k = "#{self.resource}_#{k}" if k == 'type'
+        send(:"#{k}=", val) if self.respond_to? "#{k}="
       end
     end
 
-    def create(params={})
+    def create
       # delete the parent id if there is one
       url = self.resource_url
       self.send(self.parent + '_id=', nil) if !self.parent.nil?
 
-      response = BigcommerceAPI::Resource.http_request(:post, "/#{url}", :body => date_adjust(params).to_json)
-      if response.success?
-        return self.class.new(response.parsed_response)
-      else
-        self.errors = response.parsed_response
-        return false
-      end
+      attrs = self.attributes
+      body = Hash.new
+      self.changed.each{|c| body[c] = attrs[c]}
+
+      response = BigcommerceAPI::Resource.http_request(:post, "/#{url}", :body => body.to_json)
+
+      return self.class.new(response.parsed_response)
+    end
+
+    def delete
+      url = self.resource_url
+      BigcommerceAPI::Resource.http_request(:delete, "/#{url}/#{self.id}")
+
+      return true
     end
 
     def find_for_reload
@@ -92,7 +104,7 @@ module BigcommerceAPI
       return changed
     end
 
-  	class << self
+    class << self
       attr_accessor :has_many_options, :has_one_options, :belongs_to_options
 
       def has_many(*names)
@@ -134,7 +146,7 @@ module BigcommerceAPI
           end
         end
       end
-      
+
       def belongs_to(*names)
         self.belongs_to_options = names.collect{|x| x.is_a?(Hash) ? x.keys.first.to_s : x.to_s}
         names.each do |m|
@@ -156,41 +168,73 @@ module BigcommerceAPI
         end
       end
 
-	  	def resource
-	  		out = self.name.split('::').last.downcase
-	  		last = out.split(//).last(1).to_s
+      def resource
+        out = self.name.split('::').last.downcase
+        last = out.split(//).last.to_s
         if last == 'y'
           out = out.chomp('y') + 'ies'
-	  		elsif last == 's'
-	  			out += 'es'
-	  		else
-	  			out += 's'
-	  		end
-	  		return out
-	  	end
-
-	  	def all(params={})
-	      resources = BigcommerceAPI::Resource.http_request(:get, "/#{resource}", :query => date_adjust(params))
-	      (resources.success? and !resources.nil?) ? resources.collect{|r| self.new(r)} : []
-	    end
-
-	    def find(id)
+        elsif last == 's'
+          out += 'es'
+        else
+          out += 's'
+        end
+        return out
+      end
+
+      def all(params={})
+        resources = BigcommerceAPI::Resource.http_request(:get, "/#{resource}", :query => date_adjust(params))
+        (resources.success? and !resources.nil?) ? resources.collect{|r| self.new(r)} : []
+      end
+
+      def find(id)
+        return if id.blank?
         r = BigcommerceAPI::Resource.http_request(:get, "/#{resource}/#{id}")
-	      (r.success? and !r.nil?) ? self.new(r) : nil
-	    end
+        (r.success? and !r.nil?) ? self.new(r) : nil
+      end
 
       def http_request(verb, url, options={})
         begin
-          BigcommerceAPI::Base.send(verb, url, options)
+          response = BigcommerceAPI::Base.send(verb, url, options)
+          if response.code >= 400
+            message = case response.code
+                      when 429
+                        "Too many requests, please retry in #{response.headers["x-retry-after"]} second."
+                      when 500
+                        "Internal Error"
+                      else
+                        parse_errors(response)
+                      end
+            raise BigcommerceAPI::Error.new(response.code, message)
+          end
+          response
         rescue SocketError => e
           BigcommerceAPI::Result.new(:success => false, :errors => "Invalid URL")
         end
       end
-	  end # end class methods
+
+      private
+
+      # recursive function to convert hash into string, e.g. {a: {b: "c"}, d: "e"} becomes "c e"
+      def hash_to_s(hash)
+        if hash.is_a?(Array)
+          hash.map do |value|
+            hash_to_s(value)
+          end.to_sentence
+        elsif hash.is_a?(Hash)
+          hash_to_s(hash.values)
+        else
+          hash.to_s.gsub(/[,.]$/, '')
+        end
+      end
+
+      def parse_errors(response)
+        hash_to_s(response.parsed_response)
+      end
+    end # end class methods
 
     private
-      attr_accessor :attributes_were
+    attr_accessor :attributes_were
 
   end
 
-end
+end