bigcommerce 0.9.0 → 0.10.0

data/lib/bigcommerce/connection.rb

@@ -1,5 +1,6 @@
 module Bigcommerce
   class Connection
+    attr_reader :configuration, :remaining_rate_limit
 
     def initialize(configuration)
       @configuration = {}
@@ -8,8 +9,16 @@ module Bigcommerce
       end
     end
 
-    def configuration
-      @configuration
+    def store_hash=(store_hash)
+      @configuration[:store_hash] = store_hash
+    end
+
+    def client_id=(client_id)
+      @configuration[:client_id] = client_id
+    end
+
+    def access_token=(access_token)
+      @configuration[:access_token] = access_token
     end
 
     def store_url=(store_url)
@@ -61,44 +70,102 @@ module Bigcommerce
       request(:delete, path, options, headers)
     end
 
+    # Make a request to the bigcommerce API using either Legacy or OAuth
     def request(method, path, options,headers={})
+      if oauth?
+        request_oauth(method, path, options, headers)
+      else
+        request_legacy(method, path, options, headers)
+      end
+    end
+
+    private
+
+    def oauth?
+      @configuration[:store_hash] && @configuration[:client_id] && @configuration[:access_token]
+    end
+
+    def request_oauth(method, path, options, headers={})
+      uri = File.join((ENV['BC_API_ENDPOINT'] || 'https://api.bigcommerce.com'), '/stores', @configuration[:store_hash], '/v2', path)
+
+      rest_client = RestClient::Resource.new uri.to_s, {
+        headers: headers.merge({
+          'X-Auth-Client' => @configuration[:client_id],
+          'X-Auth-Token' => @configuration[:access_token],
+          :accept => :json,
+          :content_type => :json
+        })
+      }
+
+      response = case method
+        when :get then
+          rest_client.get :params => options
+        when :post then
+          rest_client.post(options.to_json)
+        when :put then
+          rest_client.put(options.to_json)
+        when :delete then
+          rest_client.delete
+        when :head then
+          rest_client.head
+        when :options then
+          rest_client.options
+        else
+          raise 'Unsupported method!'
+      end
+
+      if (200..201) === response.code
+        JSON.parse response
+      elsif response.code == 204
+        {}
+      end
+    end
+
+    def request_legacy(method, path, options, headers={})
       resource_options = {
-        :user => @configuration[:username],
-        :password => @configuration[:api_key],
-        :headers => headers
+          :user => @configuration[:username],
+          :password => @configuration[:api_key],
+          :headers => headers
       }
-      restclient = RestClient::Resource.new "#{@configuration[:store_url]}/api/v2#{path}.json", resource_options
+
+      rest_client = RestClient::Resource.new "#{@configuration[:store_url]}/api/v2#{path}.json", resource_options
+
       if @configuration[:ssl_client_key] && @configuration[:ssl_client_cert] && @configuration[:ssl_ca_file]
-        restclient = RestClient::Resource.new(
-          "#{@configuration[:store_url]}/api/v2#{path}.json",
-          :username => @configuration[:username], 
-          :password => @configuration[:api_key],
-          :ssl_client_cert  =>  @configuration[:ssl_client_cert],
-          :ssl_client_key   =>  @configuration[:ssl_client_key],
-          :ssl_ca_file      =>  @configuration[:ssl_ca_file],
-          :verify_ssl       =>  @configuration[:verify_ssl]
+        rest_client = RestClient::Resource.new(
+            "#{@configuration[:store_url]}/api/v2#{path}.json",
+            :username => @configuration[:username],
+            :password => @configuration[:api_key],
+            :ssl_client_cert => @configuration[:ssl_client_cert],
+            :ssl_client_key => @configuration[:ssl_client_key],
+            :ssl_ca_file => @configuration[:ssl_ca_file],
+            :verify_ssl => @configuration[:verify_ssl]
         )
       end
-      begin
-        response = case method
-                   when :get then
-                     restclient.get :params => options, :accept => :json, :content_type => :json
-                   when :post then
-                     restclient.post(options.to_json, :content_type => :json, :accept => :json)
-                   when :put then
-                     restclient.put(options.to_json, :content_type => :json, :accept => :json)
-                   when :delete then
-                     restclient.delete
-                   end
-        if((200..201) === response.code)
-          JSON.parse response
-        elsif response.code == 204
-          nil
-        end
-      rescue => e
-        raise "Failed to parse Bigcommerce response: #{e}"
+
+      response = case method
+        when :get then
+          rest_client.get :params => options, :accept => :json, :content_type => :json
+        when :post then
+          rest_client.post(options.to_json, :content_type => :json, :accept => :json)
+        when :put then
+          rest_client.put(options.to_json, :content_type => :json, :accept => :json)
+        when :delete then
+          rest_client.delete
+        when :head then
+          rest_client.head
+        when :options then
+          rest_client.options
+        else
+          raise 'Unsupported method!'
+      end
+
+      @remaining_rate_limit = response.headers[:x_bc_apilimit_remaining]
+      if (200..201) === response.code
+        JSON.parse response
+      elsif response.code == 204
+        {}
       end
     end
- 
+
   end
 end

data/lib/bigcommerce/product.rb

@@ -0,0 +1,13 @@
+module Bigcommerce
+  class Product < Resource
+
+    # Here we memoize brand, so we can re-use it across different products
+    # Note we store this across the class
+    def brand
+      key = @hash["brand"]["resource"]
+      @@some_method ||= {}
+      @@some_method[key] ||= @connection.get(@hash["brand"]["resource"])
+    end
+
+  end
+end

data/lib/bigcommerce/resource.rb

@@ -0,0 +1,50 @@
+module Bigcommerce
+  class Resource
+
+    def metaclass
+      class << self; self; end
+    end
+
+    def initialize hash, connection
+      @connection = connection
+      @hash = hash
+      @hash.each do |key, value|
+        if (value.class == Hash)
+          self.resourceify(key, value)
+        end
+      end
+      @full_hash = @hash
+    end
+
+    def [](key)
+      @hash[key]
+    end
+
+    def []=(key,value)
+      @hash[key] = value
+    end
+
+    def resourceify(name, data)
+      if (!self.respond_to?(name.to_sym))
+        self.metaclass.send(:define_method, name) do
+          @connection.get data["resource"]
+        end
+      end
+    end
+
+    def load(*sub_resources)
+      sub_resources.each do |sub_resource|
+        begin
+          @full_hash[sub_resource.to_s] = self.send(sub_resource)
+        rescue RuntimeError => e
+          puts e
+        end
+      end
+    end
+
+    def to_json
+      @full_hash.to_json
+    end
+
+  end
+end

data/lib/bigcommerce/version.rb

@@ -1,6 +1,6 @@
 module Bigcommerce
   major = 0
-  minor = 9
+  minor = 10
   patch = 0
   VERSION = [major, minor, patch].join('.') unless defined? Bigcommerce::VERSION
 end

data/spec/integration/orders_spec.rb

@@ -4,13 +4,13 @@ describe "/api/v2/orders" do
   include_context "integration"
 
   it "gets the orders collection", :vcr do
-    orders = api.get_orders
+    orders = api.orders
     orders.should be_a_kind_of(Enumerable)
     orders.size.should be > 0
   end
 
   it "filters orders by date", :vcr do
-    orders = api.get_orders_by_date('2013-03-01')
+    orders = api.orders_by_date('2013-03-01')
     orders.should be_a_kind_of(Enumerable)
     orders.size.should be > 0
   end

data/spec/spec_helper.rb

@@ -2,7 +2,7 @@ begin
   require 'coveralls'
   Coveralls.wear!
 rescue LoadError => e
-  raise e unless RUBY_VERSION < '1.9'
+  raise e
 end
 
 require 'bigcommerce'

data/spec/unit/api_request_spec.rb

@@ -3,32 +3,32 @@ describe "API request delegation" do
 
   it "requests a resource" do
     api.connection.should_receive(:get).once.with("/time")
-    api.get_time
+    api.time
   end
 
   it "requests a resource by id" do
     api.connection.should_receive(:get).once.with("/products/333", {})
-    api.get_product(333)
+    api.product(333)
   end
 
   it "requests a compound resource by ids" do
     api.connection.should_receive(:get).once.with("/orders/999/products/333", {})
-    api.get_orders_product(999, 333)
+    api.orders_product(999, 333)
   end
 
   it "requests a resource with pagination" do
     api.connection.should_receive(:get).once.with("/orders", {:page => 2})
-    api.get_orders(:page => 2)
+    api.orders(:page => 2)
   end
 
   it "requests a resource with limit" do
     api.connection.should_receive(:get).once.with("/categories", {:limit => 10})
-    api.get_categories(:limit => 10)
+    api.categories(:limit => 10)
   end
 
   it "request a resource with pagination and limit" do
     api.connection.should_receive(:get).once.with("/customers", {:limit => 10, :page => 2})
-    api.get_customers(:limit => 10, :page => 2)
+    api.customers(:limit => 10, :page => 2)
   end
 
 end

data/spec/unit/api_spec.rb

@@ -3,20 +3,47 @@ require 'spec_helper'
 describe Bigcommerce::Api do
   include_context "mock api"
 
-  describe "get_orders_by_date" do
+  describe "orders_by_date" do
     it "should accept a valid Date object" do
       date = DateTime.now
       parsed_date = described_class.new.to_rfc2822(date)
       api.connection.should_receive(:get).once.with("/orders",
                                                     {:min_date_created => parsed_date})
-      api.get_orders_by_date(date)
+      api.orders_by_date(date)
     end
 
     it "should parse a valid date string" do
       date = described_class.new.to_rfc2822(DateTime.parse('2012-1-1'))
       api.connection.should_receive(:get).once.with("/orders",
                                                     {:min_date_created => date})
-      api.get_orders_by_date('2012-1-1')
+      api.orders_by_date('2012-1-1')
     end
   end
+
+  describe "#create-orders-shipments" do
+    it "should accept an order id parameter" do
+      api.connection.should_receive(:post).once.with("/orders/123/shipments", {})
+      api.create_orders_shipments(123)
+    end
+
+    it "should accept an order id parameter and an options hash" do
+      options = Hash[*('A'..'Z').to_a.flatten]
+      api.connection.should_receive(:post).once.with("/orders/123/shipments", options)
+      api.create_orders_shipments(123, options)
+    end
+  end
+
+  describe "#get-options-value" do
+    it "should accept an option id parameter" do
+      api.connection.should_receive(:get).once.with("/options/123/values", {})
+      api.options_value(123)
+    end
+
+    it "should accept an option id parameter and an options hash" do
+      options = Hash[*('A'..'Z').to_a.flatten]
+      api.connection.should_receive(:get).once.with("/options/123/values", options)
+      api.options_value(123, options)
+    end
+  end
+
 end

data/spec/unit/connection_spec.rb

@@ -15,38 +15,9 @@ shared_examples_for "request method accepting optional params and headers" do
     connection.should_receive(:request).once.with(http_method, "/orders", {}, {'Some-Header' => 'abc'})
     connection.send(http_method, path, {}, {'Some-Header' => 'abc'})
   end
-  
+
   it "sends request with params and headers" do
     connection.should_receive(:request).once.with(http_method, "/orders", {:page => 6}, {'Some-Header' => 'abc'})
     connection.send(http_method, path, {:page => 6}, {'Some-Header' => 'abc'})
   end
 end
-
-describe Bigcommerce::Connection do
-  describe "#request" do
-    let(:configuration) { { :username => "test", :api_key => "12345", :store_url => "http://a.bigcommerce.com" } }
-    let(:connection) { Bigcommerce::Connection.new(configuration) }
-    let(:expected_url) { "#{configuration[:store_url]}/api/v2/orders.json" }
-    let(:expected_params) { { :user => "test", :password => "12345", :headers => {} } }
-    let(:mock_resource) { double("RestClient::Resource") }
-    let(:mock_response) { double }
-    let(:path) { "/orders" }
-
-    before do
-      mock_response.stub(:code).and_return(204)
-      mock_resource.stub(:get).and_return(mock_response)
-    end
-
-    it "should set up the expected url, user and password" do
-      RestClient::Resource.should_receive(:new).once.with(expected_url, expected_params).and_return(mock_resource)
-      connection.request(:get, path, {})
-    end
-
-    it "should pass through headers to RestClient::Resource" do
-      params_with_headers = expected_params.merge(:headers => {"Some-Header" => "abc"})
-      RestClient::Resource.should_receive(:new).once.with(expected_url, params_with_headers).and_return(mock_resource)
-
-      connection.request(:get, "/orders", {}, {"Some-Header" => "abc"})
-    end
-  end
-end

metadata

@@ -1,15 +1,9 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: bigcommerce
-version: !ruby/object:Gem::Version 
-  hash: 59
-  prerelease: 
-  segments: 
-  - 0
-  - 9
-  - 0
-  version: 0.9.0
+version: !ruby/object:Gem::Version
+  version: 0.10.0
 platform: ruby
-authors: 
+authors:
 - Mark Rickerby
 - Rob Howard
 - Saranyan Vigraham
@@ -17,151 +11,158 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-10-17 00:00:00 +11:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2015-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activesupport
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rest-client
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: ci_reporter
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: mocha
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ci_reporter_rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 2
-        - 11
-        version: "2.11"
+      - !ruby/object:Gem::Version
+        version: '2.11'
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: vcr
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: webmock
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 29
-        segments: 
-        - 1
-        - 9
-        version: "1.9"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.9'
   type: :development
-  version_requirements: *id009
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.9'
 description: Enables Ruby applications to communicate with the Bigcommerce API V2.
-email: 
+email:
 - mark.rickerby@bigcommerce.com
 - rob.howard@bigcommerce.com
 - saranyan.vigraham@bigcommerce.com
 - sasha.gerrand@bigcommerce.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - LICENSE
 - Rakefile
 - README.md
@@ -170,6 +171,8 @@ files:
 - ./lib/bigcommerce/api.rb
 - ./lib/bigcommerce/connection.rb
 - ./lib/bigcommerce/version.rb
+- ./lib/bigcommerce/resource.rb
+- ./lib/bigcommerce/product.rb
 - ./lib/bigcommerce.rb
 - ./spec/big_commerce_spec.rb
 - ./spec/integration/orders_spec.rb
@@ -188,41 +191,31 @@ files:
 - spec/unit/connection_spec.rb
 - spec/unit/date_time_spec.rb
 - spec/unit/version_spec.rb
-has_rdoc: true
 homepage: http://github.com/bigcommerce/bigcommerce-api-ruby
-licenses: []
-
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+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: 1.6.2
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Enables Ruby applications to communicate with the Bigcommerce API
-test_files: 
+test_files:
 - spec/big_commerce_spec.rb
 - spec/integration/orders_spec.rb
 - spec/unit/api_request_spec.rb