bigcommerce_api 0.4.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a2d1f41c5fd3384735697fa107295fdfcc973b9
+  data.tar.gz: d2b8cb2d60cb397d7e02a8b2e534fc9ef58cce07
+SHA512:
+  metadata.gz: 5f809dcf20e171ca37b01f6336f3b7eb5d9618bdc41a338e8a9eaab64f32acde69bf992f529d7addb23d6c8aad6d43d61df0848f28dd36eb912b9b278d7e7f02
+  data.tar.gz: 6f64c6f13d33851e15108ca7733547e6e539e05e2031a3caf6a52e8b9e3666abefd52872f844c7b4e05ffca487e16a53fc46b877f3b1503b0c8b5ec39fb473d3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Mark Dickson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,112 @@
+Bigcommerce API (V2) Client
+================================
+Full featured Ruby Gem to connect to the Big Commerce API. Similar to the the official gem by Bigcommerce, but with more Ruby-like syntax, allowing you to interact with Ruby objects (with familiar `find` and `save` methods) instead of hashes. 
+
+Additionally, it is compatible with the new OAuth authentication.
+
+Developed and maintained by [Whiplash Merchandising](http://www.whiplashmerch.com).
+
+### Requirements
+
+- Ruby 1.8.7+
+- Rubygems
+- JSON
+- ActiveSupport 2.3.5+
+- Httparty
+
+A valid username, API key, and store URL OR app client id, OAuth token, and store hash/id are required to authenticate requests.
+
+### Installation
+
+```
+git clone git://github.com/ideaoforder/bigcommerce_api.git
+cd bigcommerce_api
+rake install
+```
+
+Or if you're using Bundler:
+
+```
+gem 'bigcommerce_api', '>=0.4.3', :git => 'git://github.com/ideaoforder/bigcommerce_api'
+```
+
+### Configuration
+
+To use the API client in your Ruby code:
+```
+require 'rubygems'
+require 'bigcommerce_api'
+```
+
+You can currently connect using the existing api key auth:
+```
+api = BigcommerceAPI::Base.new(
+	:api_key => 'XXXXXXXXXXXXX', 
+	:username => 'XXXXXXXX', 
+	:store_url => 'https://YOUR_STORE.mybigcommerce.com'
+)
+```
+
+Or using the new OAuth credentials (currently in Alpha at Bigcommerce):
+```
+api = BigcommerceAPI::Base.new(
+    :client_id => APP_CLIENT_ID,
+    :store_hash => STORE_HASH/ID,
+    :access_token => OAUTH_ACCESS_TOKEN
+)
+```
+
+You can test your connection by getting the time
+
+```
+ BigcommerceAPI::Base.get_time
+```
+
+A valid time means your connection and credentials are good.
+
+### Usage
+
+The API currently gives you read/write access to MOST of your Big Commerce API V2 resources (https://developer.bigcommerce.com/docs/api/v2)
+
+```
+$ irb
+
+BigcommerceAPI::Base.new(:api_key => 'XXXXXXXXXXXXX', :username => 'XXXXXXXX', :store_url => 'https://YOUR_STORE.mybigcommerce.com')
+
+products = BigcommerceAPI::Product.all
+
+order = BigcommerceAPI::Order.find(NNN)
+order.status_id = 3
+if order.save
+  puts "success!"
+else
+  puts order.errors.join('; ')
+end
+
+orders = BigcommerceAPI::Order.all(:status_id => 11, :min_date_created => '2008-01-01'})
+
+shipment = BigcommerceAPI::Shipment.create(
+	:order_id => bc_order.id, 
+	:order_address_id => SHIPMENT_ADDRESS_ID, 
+	:tracking_number => 'XXXXXX', 
+	:order_date => bc_order.date_created, 
+	:items => [{:order_product_id => bc_order_product.id, :quantity => NNN}]
+)
+
+```
+
+### Contributing to bigcommerce_api
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+### Copyright
+
+Copyright (c) 2014 Mark Dickson / Whiplash Merchandising. See LICENSE.txt for
+further details.
+

data/lib/bigcommerce_api/base.rb

@@ -0,0 +1,95 @@
+module BigcommerceAPI
+
+  class Base
+    extend BigcommerceAPI
+
+    include HTTParty
+    format :json
+    headers 'Accept' => "application/json"
+    headers 'Content-Type' => "application/json"
+
+    def initialize(params={})
+      # for the time being, accept old school API params
+      if params[:username] and params[:api_key]
+        self.class.basic_auth params[:username], 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]
+      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
+    end
+
+    def time
+      response = self.class.get('/time')
+      response.parsed_response['time']
+    end
+    alias_method :get_time, :time
+
+    def store
+      response = self.class.get('/store')
+      if response
+        return Store.new(response.parsed_response)
+      else
+        return nil
+      end
+    end
+    alias_method :info, :store
+    alias_method :information, :store
+    alias_method :settings, :store
+
+    # this grabs all of the FIRST LEVEL attributes
+    # it ignores hashed and constructed nested attributes,
+    # since Big Commerce won't let us set those anyway
+    def attributes(strip_empty=false)
+      hash = {}
+      self.instance_variables.each {|var| hash[var.to_s.delete("@")] = self.instance_variable_get(var) if (var.to_s['_hash'].nil? and var.to_s['_resource'].nil? and var.to_s[self.resource + '_type'].nil?) }
+      hash = BigcommerceAPI::Resource.date_adjust(hash)
+      BigcommerceAPI::Resource.clean!(hash) if strip_empty
+      hash.delete('id') if strip_empty
+      return hash
+    end
+
+    class << self
+      def clean!(hash)
+        hash.each do |k, v| 
+          if v.is_a? Hash
+            clean!(v)
+          else
+            hash.delete(k) if v.nil? or v == ''
+          end
+        end
+      end
+
+      # Returns the date formatted as
+      # RFC 2822 string
+      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|
+            if params[d] and !params[d].nil? and params[d] != ''
+              if params[d].is_a?(String)
+                params[d] = DateTime.parse(params[d])
+              end
+              # params[d] = CGI::escape(to_rfc2822(params[d]))
+              params[d] = to_rfc2822(params[d])
+            end
+          end
+        end
+        return params
+      end
+    end
+        
+  end
+
+end

data/lib/bigcommerce_api/image.rb

@@ -0,0 +1,10 @@
+module BigcommerceAPI
+
+  class Image < Resource
+    attr_accessor :id, :image_file, :product_id, :sort_order, :is_thumbnail, :description, :date_created
+
+    belongs_to :product
+  
+  end
+
+end

data/lib/bigcommerce_api/option.rb

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

data/lib/bigcommerce_api/option_set.rb

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

data/lib/bigcommerce_api/option_set_option.rb

@@ -0,0 +1,11 @@
+module BigcommerceAPI
+
+  class OptionSetOption < Resource
+    attr_accessor :id, :option_id, :display_name, :option_set_id, :sort_order, :is_required, :option_resource
+
+    has_one :option
+    belongs_to :option_set
+  
+  end
+
+end

data/lib/bigcommerce_api/option_value.rb

@@ -0,0 +1,10 @@
+module BigcommerceAPI
+
+  class OptionValue < Resource
+    attr_accessor :id, :option_id, :sort_order, :value, :label
+  
+    belongs_to :option
+  
+  end
+
+end

data/lib/bigcommerce_api/order.rb

@@ -0,0 +1,17 @@
+module BigcommerceAPI
+
+  class Order < Resource
+    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
+
+  end
+
+end

data/lib/bigcommerce_api/order_product.rb

@@ -0,0 +1,49 @@
+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 :orderproduct_type
+  
+    def shippingaddress
+      a = BigcommerceAPI::Base.get "/orders/#{self.order_id}/shippingaddresses/#{self.order_address_id}"
+      (a.success? and !a.nil?) ? BigcommerceAPI::Shippingaddress.new(a) : nil
+    end
+
+    # TODO: these can probably go in a ReadOnly class
+    def save
+    	self.errors = ["Shipping Addresses are readonly"]
+    	return false
+    end
+
+    def create(params={})
+    	self.errors = ["Shipping Addresses are readonly"]
+    	return false
+    end
+
+    # this overrides the default method, since this has to come in with an order id
+    def resource_url
+      "orders/#{self.order_id}/products"
+    end
+
+    def parent
+      'order'
+    end
+
+    class << self
+	  	def all(order_id, 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
+
+	    def find(order_id, id)
+	      r = BigcommerceAPI::Base.get("/orders/#{order_id}/products/#{id}")
+	      (r.success? and !r.nil?) ? self.new(r) : nil
+	    end
+	  end
+  
+  end
+
+end

data/lib/bigcommerce_api/order_status.rb

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

data/lib/bigcommerce_api/product.rb

@@ -0,0 +1,22 @@
+module BigcommerceAPI
+
+  class Product < Resource
+    # 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, :tax_class, :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 
+    # has_many
+    attr_accessor :options_hash, :skus_hash, :rules_hash, :images_hash
+
+    # has_one
+    attr_accessor :option_set_resource, :brand_resource
+
+    # reserved 
+    attr_accessor :product_type
+
+
+    has_many :skus, :rules, :images, {:options => :product_options}
+    has_one :brand, :option_set
+    belongs_to :tax_class
+    
+  end
+
+end

data/lib/bigcommerce_api/product_option.rb

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

data/lib/bigcommerce_api/resource.rb

@@ -0,0 +1,152 @@
+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
+    end
+
+    def save
+      # delete the parent id if there is one
+      url = self.resource_url
+      self.send(self.parent + '_id=', nil) if !self.parent.nil?
+
+      if self.id.nil?
+        response = BigcommerceAPI::Base.post("/#{url}", :body => self.attributes(true).to_json)
+      else
+        response = BigcommerceAPI::Base.put("/#{url}/#{self.id}", :body => self.attributes(true).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
+      end
+    end
+
+    def create(params={})
+      # delete the parent id if there is one
+      url = self.resource_url
+      self.send(self.parent + '_id=', nil) if !self.parent.nil?
+
+      response = BigcommerceAPI::Base.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
+    end
+
+    def resource
+      self.class.name.downcase.to_s.split('::').last
+    end
+
+    def resource_url
+      self.class.resource
+    end
+
+    def parent
+      nil
+    end
+
+  	class << self
+      attr_accessor :has_many_options, :has_one_options, :belongs_to_options
+
+      def has_many(*names)
+        self.has_many_options = names.collect{|x| x.is_a?(Hash) ? x.keys.first.to_s : x.to_s}
+        names.each do |m|
+          if m.is_a? Hash
+            meth = m.keys.first.to_s
+            res = m.values.first.to_s
+          else
+            meth = m.to_s
+            res = m.to_s
+          end
+          define_method meth do
+            out = BigcommerceAPI::Base.get("#{self.send(meth + '_hash')['resource']}")
+            obj = res.singularize.camelize
+            if out and !defined?('BigcommerceAPI::' + obj).nil?
+              (out.success? and !out.nil?) ? out.collect{|o| ('BigcommerceAPI::' + obj).constantize.new(o)} : []
+            end
+          end
+        end
+      end
+
+      def has_one(*names)
+        self.has_one_options = names.collect{|x| x.is_a?(Hash) ? x.keys.first.to_s : x.to_s}
+        names.each do |m|
+          if m.is_a? Hash
+            meth = m.keys.first.to_s
+            resource = m.values.first.to_s
+          else
+            meth = m.to_s
+            resource = m.to_s
+          end
+          define_method meth do
+            out = BigcommerceAPI::Base.get("#{self.send(meth + '_resource')['resource']}")
+            obj = resource.singularize.camelize
+            if out and !defined?('BigcommerceAPI::' + obj).nil?
+              (out.success? and !out.nil?) ? ('BigcommerceAPI::' + obj).constantize.new(out) : nil
+            end
+          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|
+          if m.is_a? Hash
+            meth = m.keys.first.to_s
+            resource = m.values.first.to_s
+          else
+            meth = m.to_s
+            resource = m.to_s
+          end
+          define_method meth do
+            obj = resource.singularize.camelize
+            url = '/' + meth.pluralize + '/' + self.send(meth + "_id").to_s
+            out = BigcommerceAPI::Base.get("#{url}")
+            if out and !defined?('BigcommerceAPI::' + obj).nil?
+              (out.success? and !out.nil?) ? ('BigcommerceAPI::' + obj).constantize.new(out) : nil
+            end
+          end
+        end
+      end
+
+	  	def resource
+	  		out = self.name.split('::').last.downcase
+	  		last = out.split(//).last(1).to_s
+	  		if last == 's'
+	  			out += 'es'
+	  		else
+	  			out += 's'
+	  		end
+	  		return out
+	  	end
+
+	  	def all(params={})
+	      resources = BigcommerceAPI::Base.get("/#{resource}", :query => date_adjust(params))
+	      (resources.success? and !resources.nil?) ? resources.collect{|r| self.new(r)} : []
+	    end
+
+	    def find(id)
+	      r = BigcommerceAPI::Base.get("/#{resource}/#{id}")
+	      (r.success? and !r.nil?) ? self.new(r) : nil
+	    end
+	  end
+
+  end
+
+end

data/lib/bigcommerce_api/shipment.rb

@@ -0,0 +1,31 @@
+module BigcommerceAPI
+
+  class Shipment < Resource
+    attr_accessor :items, :comments, :order_id, :shipping_address, :order_address_id, :id, :tracking_number, :billing_address, :customer_id, :shipping_method, :date_created
+
+    belongs_to :customer, {:order_address => :shipping_address}, :order
+
+    # these are all overrides, since Shipments work a little differently
+    def resource_url
+      "orders/#{self.order_id}/shipments"
+    end
+
+    def parent
+      'order'
+    end
+
+    class << self
+	  	def all(order_id, params={})
+	      resources = BigcommerceAPI::Base.get("/orders/#{order_id}/shipments", :query => date_adjust(params))
+	      (resources.success? and !resources.nil?) ? resources.collect{|r| self.new(r)} : []
+	    end
+
+	    def find(order_id, id)
+	      r = BigcommerceAPI::Base.get("/orders/#{order_id}/shipments/#{id}")
+	      (r.success? and !r.nil?) ? self.new(r) : nil
+	    end
+	  end
+  
+  end
+
+end

data/lib/bigcommerce_api/shippingaddress.rb

@@ -0,0 +1,43 @@
+module BigcommerceAPI
+
+  class Shippingaddress < Resource
+    attr_accessor :shipping_zone_id, :handling_cost_inc_tax, :city, :company, :handling_cost_tax, :cost_tax_class_id, :zip, :street_1, :items_shipped, :country_iso2, :country, :street_2, :handling_cost_ex_tax, :cost_tax, :order_id, :shipping_zone_name, :handling_cost_tax_class_id, :base_handling_cost, :id, :phone, :last_name, :cost_inc_tax, :base_cost, :shipping_method, :items_total, :cost_ex_tax, :email, :state, :first_name
+
+    belongs_to :shipping_zone, :order
+
+    # this overrides the default method, since this has to come in with an order id
+    def resource_url
+      "orders/#{self.order_id}/shippingaddresses"
+    end
+
+    def parent
+      'order'
+    end
+
+    # TODO: these can probably go in a ReadOnly class
+    def save
+    	self.errors = ["Shipping Addresses are readonly"]
+    	return false
+    end
+
+    def create(params={})
+    	self.errors = ["Shipping Addresses are readonly"]
+    	return false
+    end
+
+    class << self
+      	def all(order_id, params={})
+          resources = BigcommerceAPI::Base.get("/orders/#{order_id}/shippingaddresses", :query => date_adjust(params))
+          (resources.success? and !resources.nil?) ? resources.collect{|r| self.new(r)} : []
+        end
+
+        def find(order_id, id)
+          r = BigcommerceAPI::Base.get("/orders/#{order_id}/shippingaddresses/#{id}")
+          (r.success? and !r.nil?) ? self.new(r) : nil
+        end
+
+    end
+  
+  end
+
+end

data/lib/bigcommerce_api/sku.rb

@@ -0,0 +1,58 @@
+module BigcommerceAPI
+
+  class Sku < Resource
+    attr_accessor :id, :sku, :product_id, :cost_price, :upc, :inventory_level, :inventory_warning_level, :bin_picking_number, :options
+
+    belongs_to :product
+
+    def resource_url
+      "products/#{self.product_id}/skus"
+    end
+
+    def parent
+      'product'
+    end
+    
+    def product_option_id
+      self.options.first['product_option_id']
+    end
+    
+    def option_value_id
+      self.options.first['option_value_id']
+    end
+    
+    def product_option
+      po = BigcommerceAPI::Base.get '/products/' + self.product_id.to_s + '/options/' + self.product_option_id.to_s
+      (po.success? and !po.nil?) ? ProductOption.new(po) : nil
+    end
+    
+    def option_value
+      option_id = self.product_option.option_id
+      ov = BigcommerceAPI::Base.get '/options/' + option_id.to_s + '/values/' + self.option_value_id.to_s
+      (ov.success? and !ov.nil?) ? OptionValue.new(ov) : nil
+    end
+    
+    def description
+      out = Array.new
+      po = self.product_option
+      ov = self.option_value
+      out << po.display_name if po
+      out << ov.label if ov
+      return out.join(' ')
+    end
+
+    class << self
+      def all(product_id, params={})
+        resources = BigcommerceAPI::Base.get("/products/#{product_id}/skus", :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}/skus/#{id}")
+        (r.success? and !r.nil?) ? self.new(r) : nil
+      end
+    end
+  
+  end
+
+end

data/lib/bigcommerce_api/store.rb

@@ -0,0 +1,21 @@
+module BigcommerceAPI  
+  
+  class Store < Base
+    attr_accessor :errors, :id, :domain, :name, :address, :phone, :admin_email, :order_email, :language, :currency, :currency_symbol, :currency_symbol_location, :decimal_separator, :thousands_separator, :decimal_places, :weight_units, :dimension_units, :plan_name
+
+    # Sample response
+    # {"id"=>"XXXX", "domain"=>"XXXX.mybigcommerce.com", "name"=>"XXXX", "address"=>"", "phone"=>"", "admin_email"=>"XXX", "order_email"=>"XXX", "language"=>"en", "currency"=>"USD", "currency_symbol"=>"$", "decimal_separator"=>".", "thousands_separator"=>",", "decimal_places"=>2, "currency_symbol_location"=>"left", "weight_units"=>"LBS", "dimension_units"=>"Inches", "plan_name"=>"Partner Sandbox"}
+  	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
+        send(:"#{k}=", val) if self.respond_to? "#{k}="
+      end
+    end
+
+  end
+
+end

data/lib/bigcommerce_api.rb

@@ -0,0 +1,20 @@
+require "rubygems"
+require 'httparty'
+require 'active_support/inflector'
+
+require 'bigcommerce_api/base'
+require 'bigcommerce_api/resource'
+require 'bigcommerce_api/image'
+require 'bigcommerce_api/option'
+require 'bigcommerce_api/option_set'
+require 'bigcommerce_api/option_set_option'
+require 'bigcommerce_api/option_value'
+require 'bigcommerce_api/order'
+require 'bigcommerce_api/order_product'
+require 'bigcommerce_api/order_status'
+require 'bigcommerce_api/product'
+require 'bigcommerce_api/product_option'
+require 'bigcommerce_api/shipment'
+require 'bigcommerce_api/shippingaddress'
+require 'bigcommerce_api/sku'
+require 'bigcommerce_api/store'

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: bigcommerce_api
+version: !ruby/object:Gem::Version
+  version: 0.4.3
+platform: ruby
+authors:
+- Mark Dickson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: rdoc
+  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: bundler
+  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: jeweler
+  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'
+description: Enables Ruby applications to communicate with the BigCommerce API V2.
+email: mark@sitesteaders.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- lib/bigcommerce_api.rb
+- lib/bigcommerce_api/base.rb
+- lib/bigcommerce_api/image.rb
+- lib/bigcommerce_api/option.rb
+- lib/bigcommerce_api/option_set.rb
+- lib/bigcommerce_api/option_set_option.rb
+- lib/bigcommerce_api/option_value.rb
+- lib/bigcommerce_api/order.rb
+- lib/bigcommerce_api/order_product.rb
+- lib/bigcommerce_api/order_status.rb
+- lib/bigcommerce_api/product.rb
+- lib/bigcommerce_api/product_option.rb
+- lib/bigcommerce_api/resource.rb
+- lib/bigcommerce_api/shipment.rb
+- lib/bigcommerce_api/shippingaddress.rb
+- lib/bigcommerce_api/sku.rb
+- lib/bigcommerce_api/store.rb
+- LICENSE.txt
+- README.md
+homepage: http://github.com/ideaoforder/bigcommerce_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Enables Ruby applications to communicate with the BigCommerce API
+test_files: []