bigcommerce_api 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01abb5cc7c76c570309b4e94698f1c24e4a5c59f
-  data.tar.gz: a6a7cd9349a3092e189a9642c5d71a7692409bb1
+  metadata.gz: 9d3066447f844c7d5ef596f8858d00c24dd909e5
+  data.tar.gz: 72b7f45bbc559b5c397de28cf81eb875347e7fd6
 SHA512:
-  metadata.gz: 94507ff8220f1d9785d0dbd72c38b84c6cd175c01672b883cd0cade6d3604aeddca24da80affd2a825e73c6a7e0ce19c1d604f65465c6d67e59ca7394669b706
-  data.tar.gz: 2ababf2435e4cebd995a33209b0f0dc54436afb85407d0eac6fb005810c554bb1f4fb06849283a7691579a1c61e9e99f770a388e782404da2ad76cf26d5de3b3
+  metadata.gz: 2c78bb60cc4a41cf4283c87effc4ea0a6800a89319926517581bd7ca7e2abb243c653c02ebc275b7d13031fd9fe85e0f98d07028a8523f7d60eb5e5c3758f347
+  data.tar.gz: ec654c8e1088386c19a16ccdaaa4112174339319ee1981672e0b155c22b5762c9dc194b05b71d238dba60f8e5c6940d77b1ef3420f231631844e0ad4b2286aad

data/lib/bigcommerce_api.rb

@@ -7,10 +7,14 @@ require 'bigcommerce_api/inflections'
 require 'bigcommerce_api/modules/countable'
 require 'bigcommerce_api/base'
 require 'bigcommerce_api/resource'
+require 'bigcommerce_api/error'
 
 # Resources
-require 'bigcommerce_api/category'
+require 'bigcommerce_api/address'
 require 'bigcommerce_api/brand'
+require 'bigcommerce_api/category'
+require 'bigcommerce_api/customer'
+require 'bigcommerce_api/hook'
 require 'bigcommerce_api/image'
 require 'bigcommerce_api/option'
 require 'bigcommerce_api/option_set'
@@ -24,6 +28,6 @@ require 'bigcommerce_api/product_option'
 require 'bigcommerce_api/result'
 require 'bigcommerce_api/rule'
 require 'bigcommerce_api/shipment'
-require 'bigcommerce_api/shippingaddress'
+require 'bigcommerce_api/shipping_address'
 require 'bigcommerce_api/sku'
 require 'bigcommerce_api/store'

data/lib/bigcommerce_api/address.rb

@@ -0,0 +1,45 @@
+module BigcommerceAPI
+  class Address < Resource
+    attr_accessor  :id,
+                   :customer_id,
+                   :first_name,
+                   :last_name,
+                   :company,
+                   :street_1,
+                   :street_2,
+                   :city,
+                   :state,
+                   :zip,
+                   :country,
+                   :country_iso2,
+                   :phone,
+                   :address_type
+
+    belongs_to :customer
+
+    def resource_url
+      "customers/#{self.customer_id}/addresses"
+    end
+
+    def parent
+      'customer'
+    end
+
+    # we override this on resources that need paired IDs for find
+    def find_for_reload
+      self.class.find(self.customer_id, self.id)
+    end
+
+    class << self
+      def all(customer_id, params={})
+        resources = BigcommerceAPI::Base.get("/customers/#{customer_id}/addresses", query: date_adjust(params))
+        (resources.success? and !resources.nil?) ? resources.collect{|r| self.new(r)} : []
+      end
+
+      def find(customer_id, id)
+        r = BigcommerceAPI::Base.get("/customers/#{customer_id}/addresses/#{id}")
+        (r.success? and !r.nil?) ? self.new(r) : nil
+      end
+    end
+  end
+end

data/lib/bigcommerce_api/base.rb

@@ -4,27 +4,37 @@ module BigcommerceAPI
     extend BigcommerceAPI
 
     include HTTParty
-    format :json
-    headers 'Accept' => "application/json"
-    headers 'Content-Type' => "application/json"
+
+    def self.default_options
+      Thread.current["BigcommerceAPI"] ||= {
+        parser: HTTParty::Parser,
+        format: :json,
+        headers: { "Accept" => "application/json", "Content-Type" => "application/json" }
+      }
+    end
 
     def initialize(params={})
       # for the time being, accept old school API params
+      session_options = self.class.default_options
       if params[:username] and params[:api_key]
-        self.class.basic_auth params[:username], params[:api_key]
-      # default to Oauth
+          session_options[:username] = params[:username]
+          session_options[:password] = params[:api_key]
+        # default to Oauth
       else
-        self.class.headers 'X-Auth-Client' => params[:client_id]
-        self.class.headers 'X-Auth-Token' => params[:access_token]
+        session_options[:headers]['X-Auth-Client'] = params[:client_id]
+        session_options[:headers]['X-Auth-Token']  = params[:access_token]
       end
 
       # if we're using Oauth, we're probably grabbing :store_hash
       # accept :store_url for legacy purposes
-      if params[:store_url]
-        self.class.base_uri(params[:store_url] + '/api/v2/')
-      else
-        self.class.base_uri("https://api.bigcommerce.com/stores/#{params[:store_hash]}/v2/")
-      end
+      session_options[:base_uri] = if params[:store_url]
+                                     "#{params[:store_url]}/api/v2"
+                                   else
+                                     "https://api.bigcommerce.com/stores/#{params[:store_hash]}/v2"
+                                   end
+      session_options[:base_uri] = HTTParty.normalize_base_uri(session_options[:base_uri])
+
+      Thread.current["BigcommerceAPI"] = session_options
     end
 
     def time
@@ -74,7 +84,7 @@ module BigcommerceAPI
 
     class << self
       def clean!(hash)
-        hash.each do |k, v| 
+        hash.each do |k, v|
           if v.is_a? Hash
             clean!(v)
           else
@@ -88,7 +98,7 @@ module BigcommerceAPI
       def to_rfc2822(datetime)
         datetime.strftime("%a, %d %b %Y %H:%M:%S %z")
       end
-      
+
       def date_adjust(params)
         [:date_created, :date_modified, :date_last_imported, :date_shipped, :min_date_created, :max_date_created, :min_date_modified, :max_date_modified, :min_date_last_imported, :max_date_last_imported].each do |date|
           [date, date.to_s].each do |d|
@@ -104,7 +114,7 @@ module BigcommerceAPI
         return params
       end
     end
-        
+
   end
 
-end
+end

data/lib/bigcommerce_api/brand.rb

@@ -1,10 +1,12 @@
 module BigcommerceAPI
-
   class Brand < Resource
-    attr_accessor :id, :name, :page_title, :meta_keywords, :meta_description, 
-                  :image_file, :search_keywords
-
+    attr_accessor :id,
+                  :image_file,
+                  :meta_description,
+                  :meta_keywords,
+                  :name,
+                  :page_title,
+                  :search_keywords
   end
-
 end
 

data/lib/bigcommerce_api/category.rb

@@ -1,12 +1,19 @@
 module BigcommerceAPI
-
   class Category < Resource
-    attr_accessor :id, :parent_id, :name, :description, :sort_order, 
-                  :page_title, :meta_keywords, :meta_description, 
-                  :layout_file, :parent_category_list, :image_file, 
-                  :is_visible, :search_keywords, :url
-
+    attr_accessor :id,
+                  :description,
+                  :image_file,
+                  :is_visible,
+                  :layout_file,
+                  :meta_description,
+                  :meta_keywords,
+                  :name,
+                  :page_title,
+                  :parent_category_list,
+                  :parent_id,
+                  :search_keywords,
+                  :sort_order,
+                  :url
   end
-
 end
 

data/lib/bigcommerce_api/coupon.rb

@@ -0,0 +1,6 @@
+module BigcommerceAPI
+  class Coupon < Resource
+    attr_accessor :id
+
+  end
+end

data/lib/bigcommerce_api/customer.rb

@@ -0,0 +1,26 @@
+module BigcommerceAPI
+  class Customer < Resource
+    extend BigcommerceAPI::Countable
+    attr_accessor :id,
+                  :company,
+                  :first_name,
+                  :last_name,
+                  :email,
+                  :phone,
+                  :date_created,
+                  :date_modified,
+                  :store_credit,
+                  :registration_ip_address,
+                  :customer_group_id,
+                  :notes
+
+    attr_accessor :addresses_hash
+
+    belongs_to :order
+    has_many :addresses
+
+    def self.find(id)
+      super unless id.to_i == 0
+    end
+  end
+end

data/lib/bigcommerce_api/error.rb

@@ -0,0 +1,9 @@
+module BigcommerceAPI
+  class Error < StandardError
+    attr_reader :code
+    def initialize(code, message)
+      @code = code
+      super(message)
+    end
+  end
+end

data/lib/bigcommerce_api/hook.rb

@@ -0,0 +1,11 @@
+module BigcommerceAPI
+  class Hook < Resource
+    attr_accessor :id,
+                  :store_hash,
+                  :client_id,
+                  :scope,
+                  :headers,
+                  :destination,
+                  :is_active
+  end
+end

data/lib/bigcommerce_api/image.rb

@@ -1,10 +1,41 @@
 module BigcommerceAPI
-
   class Image < Resource
-    attr_accessor :id, :image_file, :product_id, :sort_order, :is_thumbnail, :description, :date_created, :zoom_url, :thumbnail_url, :standard_url, :tiny_url
+    attr_accessor :id,
+                  :date_created,
+                  :description,
+                  :image_file,
+                  :is_thumbnail,
+                  :product_id,
+                  :sort_order,
+                  :standard_url,
+                  :thumbnail_url,
+                  :tiny_url,
+                  :zoom_url
 
     belongs_to :product
-  
-  end
 
-end
+    def resource_url
+      "products/#{self.product_id}/images"
+    end
+
+    def parent
+      'product'
+    end
+
+    def find_for_reload
+      self.class.find(self.product_id, self.id)
+    end
+
+    class << self
+      def all(product_id, params={})
+        resources = BigcommerceAPI::Base.get("/products/#{product_id}/images", query: date_adjust(params))
+        (resources.success? and !resources.nil?) ? resources.collect{|r| self.new(r)} : []
+      end
+
+      def find(product_id, id)
+        r = BigcommerceAPI::Base.get("/products/#{product_id}/images/#{id}")
+        (r.success? and !r.nil?) ? self.new(r) : nil
+      end
+    end
+  end
+end

data/lib/bigcommerce_api/option.rb

@@ -1,10 +1,11 @@
 module BigcommerceAPI
-
   class Option < Resource
-    attr_accessor :id, :name, :display_name, :option_type, :values_hash
-  
-    has_many :values => :option_values
-  
-  end
+    attr_accessor :id,
+                  :display_name,
+                  :name,
+                  :type,
+                  :values_hash
 
-end
+    has_many values: :option_values
+  end
+end

data/lib/bigcommerce_api/option_set.rb

@@ -1,10 +1,9 @@
 module BigcommerceAPI
-
   class OptionSet < Resource
-    attr_accessor :id, :name, :options_hash
+    attr_accessor :id,
+                  :options_hash,
+                  :name
 
-    has_many :options => :option_set_options
-  
+    has_many options: :option_set_options
   end
-
-end
+end

data/lib/bigcommerce_api/option_set_option.rb

@@ -1,11 +1,38 @@
 module BigcommerceAPI
-
   class OptionSetOption < Resource
-    attr_accessor :id, :option_id, :display_name, :option_set_id, :sort_order, :is_required, :option_resource
+    attr_accessor :id,
+                  :display_name,
+                  :is_required,
+                  :option_id,
+                  :option_resource,
+                  :option_set_id,
+                  :sort_order
 
     has_one :option
     belongs_to :option_set
-  
-  end
 
-end
+    def resource_url
+      "option_sets/#{self.option_set_id}/options"
+    end
+
+    def parent
+      'option_set'
+    end
+
+    def find_for_reload
+      self.class.find(self.option_set_id, self.id)
+    end
+
+    class << self
+      def all(option_set_id, params={})
+        resources = BigcommerceAPI::Base.get("/option_sets/#{option_set_id}/options", query: date_adjust(params))
+        (resources.success? and !resources.nil?) ? resources.collect{|r| self.new(r)} : []
+      end
+
+      def find(option_set_id, id)
+        r = BigcommerceAPI::Base.get("/option_sets/#{option_set_id}/options/#{id}")
+        (r.success? and !r.nil?) ? self.new(r) : nil
+      end
+    end
+  end
+end

data/lib/bigcommerce_api/option_value.rb

@@ -1,10 +1,35 @@
 module BigcommerceAPI
-
   class OptionValue < Resource
-    attr_accessor :id, :option_id, :sort_order, :value, :label
-  
+    attr_accessor :id,
+                  :label,
+                  :option_id,
+                  :sort_order,
+                  :value
+
     belongs_to :option
-  
-  end
 
-end
+    def resource_url
+      "options/#{self.option_id}/values"
+    end
+
+    def parent
+      'option'
+    end
+
+    def find_for_reload
+      self.class.find(self.option_id, self.id)
+    end
+
+    class << self
+      def all(option_id, params={})
+        resources = BigcommerceAPI::Base.get("/options/#{option_id}/values", query: date_adjust(params))
+        (resources.success? and !resources.nil?) ? resources.collect{|r| self.new(r)} : []
+      end
+
+      def find(option_id, id)
+        r = BigcommerceAPI::Base.get("/options/#{option_id}/values/#{id}")
+        (r.success? and !r.nil?) ? self.new(r) : nil
+      end
+    end
+  end
+end

data/lib/bigcommerce_api/order.rb

@@ -1,19 +1,81 @@
 module BigcommerceAPI
-
   class Order < Resource
     extend BigcommerceAPI::Countable
-    
-    attr_accessor :refunded_amount, :payment_status, :handling_cost_inc_tax, :shipping_cost_ex_tax, :handling_cost_tax, :currency_id, :items_shipped, :handling_cost_ex_tax, :discount_amount, :staff_notes, :default_currency_id, :store_credit_amount, :payment_method, :total_ex_tax, :subtotal_inc_tax, :subtotal_ex_tax, :date_modified, :currency_exchange_rate, :wrapping_cost_inc_tax, :wrapping_cost_ex_tax, :handling_cost_tax_class_id, :base_handling_cost, :id, :is_deleted, :coupon_discount, :customer_message, :geoip_country, :gift_certificate_amount, :total_inc_tax, :base_wrapping_cost, :date_shipped, :billing_address, :geoip_country_iso2, :payment_provider_id, :wrapping_cost_tax_class_id, :base_shipping_cost, :subtotal_tax, :wrapping_cost_tax, :status_id, :customer_id, :default_currency_code, :currency_code, :order_is_digital, :items_total, :total_tax, :shipping_cost_inc_tax, :status, :shipping_address_count, :ip_address, :shipping_cost_tax_class_id, :shipping_cost_tax, :date_created, :products_hash, :shipping_addresses_hash, :coupons_hash
-    # :coupons, :shipping_addresses, 
 
-    has_many :coupons, {:products => :order_products}, {:shipping_addresses => :shippingaddresses}
-    belongs_to :customer, :currency, :default_currency, :shipping_cost_tax_class, :wrapping_cost_tax_class, :payment_provider, :handling_cost_tax_class
-    
-    def shipments
-      s = BigcommerceAPI::Base.get '/orders/' + self.id.to_s + '/shipments'
-      (s.success? and !s.nil?) ? s.collect{|o| BigcommerceAPI::Shipment.new(o)} : []
-    end
+    attr_accessor :id,
+                  :base_handling_cost,
+                  :base_shipping_cost,
+                  :base_wrapping_cost,
+                  :billing_address,
+                  :coupon_discount,
+                  :coupons_hash,
+                  :currency_code,
+                  :currency_exchange_rate,
+                  :currency_id,
+                  :customer_id,
+                  :customer_message,
+                  :date_created,
+                  :date_modified,
+                  :date_shipped,
+                  :default_currency_code,
+                  :default_currency_id,
+                  :discount_amount,
+                  :geoip_country,
+                  :geoip_country_iso2,
+                  :gift_certificate_amount,
+                  :handling_cost_ex_tax,
+                  :handling_cost_inc_tax,
+                  :handling_cost_tax,
+                  :handling_cost_tax_class_id,
+                  :ip_address,
+                  :is_deleted,
+                  :items_shipped,
+                  :items_total,
+                  :order_is_digital,
+                  :payment_method,
+                  :payment_provider_id,
+                  :payment_status,
+                  :products_hash,
+                  :refunded_amount,
+                  :shipping_address_count,
+                  :shipping_addresses_hash,
+                  :shipping_cost_ex_tax,
+                  :shipping_cost_inc_tax,
+                  :shipping_cost_tax,
+                  :shipping_cost_tax_class_id,
+                  :staff_notes,
+                  :status,
+                  :status_id,
+                  :store_credit_amount,
+                  :subtotal_ex_tax,
+                  :subtotal_inc_tax,
+                  :subtotal_tax,
+                  :total_ex_tax,
+                  :total_inc_tax,
+                  :total_tax,
+                  :wrapping_cost_ex_tax,
+                  :wrapping_cost_inc_tax,
+                  :wrapping_cost_tax,
+                  :wrapping_cost_tax_class_id
 
-  end
+    has_many :coupons,
+             { products: :order_products },
+             :shipping_addresses,
+             :shipments
+    alias_method :order_line_items, :products
+    alias_method :shippingaddresses, :shipping_addresses
 
-end
+    belongs_to :customer,
+               :currency,
+               :default_currency,
+               :shipping_cost_tax_class,
+               :wrapping_cost_tax_class,
+               :payment_provider,
+               :handling_cost_tax_class
+
+    alias_method :old_customer, :customer
+    def customer
+      old_customer unless customer_id == 0
+    end
+  end
+end