bigcommerce 0.8.1 → 0.8.2

data/bigcommerce.gemspec

@@ -6,7 +6,8 @@ Gem::Specification.new do |s|
   s.add_dependency('json')
   s.add_dependency('rest-client')
   s.add_development_dependency("ci_reporter")
-  s.add_development_dependency("fakeweb")
+  s.add_development_dependency("vcr")
+  s.add_development_dependency("webmock", '1.9')  
   s.add_development_dependency("mocha")
   s.add_development_dependency("rake")
   s.add_development_dependency("rspec", '~> 2.11')

data/lib/big_commerce.rb

@@ -1,2 +1 @@
-# Support legacy naming
-require 'bigcommerce'
+raise "'big_commerce' (BigCommerce::Api) is no longer supported. Please require 'bigcommerce' (Bigcommerce::Api)"

data/lib/bigcommerce/api.rb

@@ -177,12 +177,11 @@ module Bigcommerce
       if date.is_a?(String)
         date = DateTime.parse(date)
       end
-      date = to_rfc2822(date)
-      @connection.get('/orders', options.merge!(:min_date_created => CGI::escape(date)))
+      @connection.get('/orders', options.merge!(:min_date_created => to_rfc2822(date)))
     end
 
     def get_orders_modified_since(date)
-      @connection.get('/orders', {}, {'If-Modified-Since' => CGI::escape(to_rfc2822(date))})
+      @connection.get('/orders', {}, {'If-Modified-Since' => to_rfc2822(date)})
     end
 
     def get_order(id)
@@ -281,6 +280,14 @@ module Bigcommerce
       @connection.get("/products/#{product_id}/customfields/#{custom_field_id}", {})
     end
 
+    def get_product_images(product_id, options={})
+      @connection.get("/products/#{product_id}/images", options)
+    end
+    
+    def create_product_images(product_id, options={})
+      @connection.post("/products/#{product_id}/images", options)
+    end
+
     def get_products_images(options={})
       @connection.get("/products/images", options)
     end

data/lib/bigcommerce/version.rb

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

data/spec/integration/orders_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe "/api/v2/orders" do
+  include_context "integration"
+
+  it "gets the orders collection", :vcr do
+    orders = api.get_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.should be_a_kind_of(Enumerable)
+    orders.size.should be > 0
+  end
+  
+end

data/spec/spec_helper.rb

@@ -1,8 +1,20 @@
 require 'bigcommerce'
 require 'date'
-require 'fakeweb'
+require 'vcr'
+require 'webmock/rspec'
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
 Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f }
 
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+  c.filter_sensitive_data('<API_USER>') { ENV['API_USER'] }
+  c.filter_sensitive_data('<API_PASS>') { ENV['API_PASS'] }
+end
+
+RSpec.configure do |c|
+  c.treat_symbols_as_metadata_keys_with_true_values = true
+end

data/spec/support/integration_context.rb

@@ -0,0 +1,13 @@
+shared_context "integration" do
+  let :api do
+    ENV['API_URL'] = ENV['API_URL'] || 'https://store-vnh06c71.mybigcommerce.com'
+    ENV['API_USER'] = ENV['API_USER'] || 'apiuser'
+    ENV['API_PASS'] = ENV['API_PASS'] || '123456'
+    
+    Bigcommerce::Api.new({
+      :store_url => ENV['API_URL'],
+      :username => ENV['API_USER'],
+      :api_key => ENV['API_PASS']
+    })
+  end
+end

data/spec/support/mock_api_context.rb

@@ -0,0 +1,10 @@
+shared_context "mock api" do
+  let :api do
+    connection = mock(Bigcommerce::Connection)
+    api = Bigcommerce::Api.new
+    api.instance_eval do
+      @connection = connection
+    end
+    api
+  end
+end

data/spec/unit/api_request_spec.rb

@@ -0,0 +1,34 @@
+describe "API request delegation" do
+  include_context "mock api"
+  
+  it "requests a resource" do
+    api.connection.should_receive(:get).once.with("/time")
+    api.get_time
+  end
+
+  it "requests a resource by id" do
+    api.connection.should_receive(:get).once.with("/products/333", {})
+    api.get_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)
+  end
+
+  it "requests a resource with pagination" do
+    api.connection.should_receive(:get).once.with("/orders", {:page => 2})
+    api.get_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)
+  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)
+  end
+  
+end

data/spec/unit/date_time_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Bigcommerce::Api do
+
+  let(:api) do
+    Bigcommerce::Api.new({
+      :store_url => "https://store-12345.mybigcommerce.com",
+      :username => "test", :api_key => "12345"
+    })
+  end
+
+  let(:rfc2822_datetime) { "Tue, 13 Mar 2012 12:45:26 +0000" }
+  let(:rfc2822_date)     { "Mon, 12 Mar 2012 00:00:00 +0000" }
+
+  describe "RFC 2822 DateTime format" do
+
+    it "converts raw date times to RFC 2822 format" do
+      api.to_rfc2822(DateTime.parse('2012-03-13 12:45:26 +0000')).should eql rfc2822_datetime
+    end
+    
+    it "converts textual date times to RFC 2822 format" do
+      api.to_rfc2822(DateTime.parse('12th March 2012')).should eql rfc2822_date
+    end
+
+    it "converts ISO 8601 dates to RFC 2822 format" do
+      api.to_rfc2822(DateTime.parse('2012-03-12')).should eql rfc2822_date
+    end
+
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bigcommerce
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-02 00:00:00.000000000 Z
+date: 2013-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -76,7 +76,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fakeweb
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -91,6 +91,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -154,12 +170,17 @@ files:
 - ./lib/bigcommerce/connection.rb
 - ./lib/bigcommerce/version.rb
 - ./lib/bigcommerce.rb
-- ./spec/models/api_spec.rb
-- ./spec/models/connection_spec.rb
+- ./spec/integration/orders_spec.rb
 - ./spec/spec_helper.rb
-- ./spec/support/fixture_helpers.rb
-- spec/models/api_spec.rb
-- spec/models/connection_spec.rb
+- ./spec/support/integration_context.rb
+- ./spec/support/mock_api_context.rb
+- ./spec/unit/api_request_spec.rb
+- ./spec/unit/connection_spec.rb
+- ./spec/unit/date_time_spec.rb
+- spec/integration/orders_spec.rb
+- spec/unit/api_request_spec.rb
+- spec/unit/connection_spec.rb
+- spec/unit/date_time_spec.rb
 homepage: http://github.com/bigcommerce/bigcommerce-api-ruby
 licenses: []
 post_install_message: 
@@ -180,11 +201,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Enables Ruby applications to communicate with the Bigcommerce API
 test_files:
-- spec/models/api_spec.rb
-- spec/models/connection_spec.rb
-has_rdoc: false
+- spec/integration/orders_spec.rb
+- spec/unit/api_request_spec.rb
+- spec/unit/connection_spec.rb
+- spec/unit/date_time_spec.rb

data/spec/models/api_spec.rb

@@ -1,93 +0,0 @@
-require 'spec_helper'
-
-describe Bigcommerce::Api do
-  before do
-    FakeWeb.allow_net_connect = false
-    FakeWeb.register_uri(:get, %r|https://test:12345@store-12345.mybigcommerce.com/api/v2/orders|, :body => load_json_fixture('order'), :status => 200, :content_type => "text/json")
-    FakeWeb.register_uri(:get, %r|https://test:12345@store-12345.mybigcommerce.com/api/v2/time|, :body => load_json_fixture('time'), :status => 200, :content_type => "text/json")
-  end
-  after do
-    FakeWeb.clean_registry
-  end
-
-  let(:api) do
-    Bigcommerce::Api.new({
-      :store_url => "https://store-12345.mybigcommerce.com",
-      :username => "test", :api_key => "12345"
-    })
-  end
-
-  let(:rfc2822_datetime) { "Tue, 13 Mar 2012 12:45:26 +0000" }
-  let(:rfc2822_date)     { "Mon, 12 Mar 2012 00:00:00 +0000" }
-
-  describe "Time" do
-    it "converts times to RFC 2822 format" do
-      api.to_rfc2822(DateTime.parse('2012-03-13 12:45:26 +0000')).should eql rfc2822_datetime
-    end
-    it "converts dates to RFC 2822 format" do
-      api.to_rfc2822(DateTime.parse('2012-03-12 00:00:00 +0000')).should eql rfc2822_date
-    end
-    it "retrieves the current time from the store" do
-      api.connection.should_receive(:get).once.with("/time")
-      api.get_time
-    end
-  end
-
-  describe "Orders" do
-    it "retrieves an order by ID" do
-      api.connection.should_receive(:get).once.with("/orders/100", {})
-      api.get_order(100)
-    end
-
-    it "retrieves orders" do
-      api.connection.should_receive(:get).once.with("/orders", {})
-      api.get_orders
-    end
-
-    it "retrieves orders with pagination" do
-      api.connection.should_receive(:get).once.with("/orders", {:page => 2})
-      api.get_orders(:page => 2)
-    end
-
-    it "retrieves orders with limit" do
-      api.connection.should_receive(:get).once.with("/orders", {:limit => 10})
-      api.get_orders(:limit => 10)
-    end
-
-    it "retrieves orders with pagination and limit" do
-      api.connection.should_receive(:get).once.with("/orders", {:limit => 10, :page => 2})
-      api.get_orders(:limit => 10, :page => 2)
-    end
-
-    it "converts from DateTime when retrieving orders by date" do
-      api.connection.should_receive(:get).once.with("/orders", {:min_date_created => CGI::escape(rfc2822_datetime)})
-      api.get_orders_by_date(DateTime.parse('2012-03-13 12:45:26 GMT'))
-    end
-
-    it "converts from DateTime when retrieving orders by date with pagination" do
-      api.connection.should_receive(:get).once.with("/orders", {:min_date_created => CGI::escape(rfc2822_datetime), :page => 2})
-      api.get_orders_by_date(DateTime.parse('2012-03-13 12:45:26 GMT'), :page => 2)
-    end
-
-    it "converts from Date when retrieving orders by date" do
-      api.connection.should_receive(:get).once.with("/orders", {:min_date_created => CGI::escape(rfc2822_date)})
-      api.get_orders_by_date(Date.parse("2012-03-12"))
-    end
-
-    it "converts from a datetime string when retrieving orders by date" do
-      api.connection.should_receive(:get).once.with("/orders", {:min_date_created=> CGI::escape(rfc2822_datetime)})
-      api.connection.should_receive(:get).once.with("/orders", {:min_date_created=> CGI::escape(rfc2822_date)})
-
-      api.get_orders_by_date('2012-03-13 12:45:26 GMT')
-      api.get_orders_by_date('2012-03-12')
-    end
-
-    describe '#get_orders_modified_since' do
-      it "retrieves orders modified since date-time" do
-        api.connection.should_receive(:get).with('/orders', {}, {'If-Modified-Since' => CGI::escape(rfc2822_datetime)})
-        api.get_orders_modified_since(DateTime.parse(rfc2822_datetime))
-      end
-    end
-    
-  end
-end

data/spec/support/fixture_helpers.rb

@@ -1,9 +0,0 @@
-module FixtureHelpers
-  def load_json_fixture(name)
-    File.read(File.expand_path("../fixtures/#{name}.json", File.dirname(__FILE__)))
-  end
-end
-
-RSpec.configure do |c|
-  c.include FixtureHelpers
-end