etsy 0.2.0 → 0.2.1

data/test/unit/etsy/model_test.rb

@@ -0,0 +1,64 @@
+require File.expand_path('../../../test_helper', __FILE__)
+
+module Etsy
+  class TestModel
+    include Etsy::Model
+  end
+
+  class ModelTest < Test::Unit::TestCase
+
+    def mock_empty_request(options = {})
+      body = options.delete(:body) { '{}' }
+      Request.expects(:new).with('', options).returns(stub(:get => stub(:body => body, :code => 200)))
+    end
+
+    context 'An instance of a Model' do
+
+      should 'perform no requests if :limit is 0' do
+        Request.expects(:new).never
+        TestModel.get_all('', :limit => 0)
+      end
+
+      should 'perform only one request if :limit is less than 100' do
+        mock_empty_request(:limit => 10, :offset => 0).once
+        TestModel.get_all('', :limit => 10)
+      end
+
+      should 'perform only one request if :limit is equal to 100' do
+        mock_empty_request(:limit => 100, :offset => 0).once
+        TestModel.get_all('', :limit => 100)
+      end
+
+      should 'perform multiple requests if :limit is greater than 100' do
+        mock_empty_request(:limit => 100, :offset => 0).once
+        mock_empty_request(:limit => 50, :offset => 100).once
+
+        TestModel.get_all('', :limit => 150)
+      end
+
+      should 'perform only one request if :limit is :all and count is less than 100' do
+        mock_empty_request(:limit => 100, :offset => 0, :body => '{"count": 10}').once
+        TestModel.get_all('', :limit => :all)
+      end
+
+      should 'perform only one request if :limit is :all and count is equal to 100' do
+        mock_empty_request(:limit => 100, :offset => 0, :body => '{"count": 100}').once
+        TestModel.get_all('', :limit => :all)
+      end
+
+      should 'perform only one request if :limit is :all and :offset is greater than count' do
+        mock_empty_request(:limit => 100, :offset => 40, :body => '{"count": 25}').once
+        TestModel.get_all('', :limit => :all, :offset => 40)
+      end
+
+      should 'perform multiple requests if :limit is :all and count is greater than 100' do
+        body = '{"count": 210}'
+        mock_empty_request(:limit => 100, :offset => 0, :body => body).once
+        mock_empty_request(:limit => 100, :offset => 100, :body => body).once
+        mock_empty_request(:limit => 10, :offset => 200, :body => body).once
+
+        TestModel.get_all('', :limit => :all)
+      end
+    end
+  end
+end

data/test/unit/etsy/payment_template_test.rb

@@ -0,0 +1,68 @@
+require File.expand_path('../../../test_helper', __FILE__)
+
+module Etsy
+  class PaymentTemplateTest < Test::Unit::TestCase
+    context "An instance of the PaymentTemplate class" do
+      setup do
+        data = read_fixture('payment_template/getPaymentTemplate.json')
+        @payment_template = PaymentTemplate.new(data.first)
+      end
+
+      should "have an id" do
+        @payment_template.id.should == 51
+      end
+
+      should "have attribute: allow_check" do
+        @payment_template.allow_check.should == false
+      end
+
+      should "have attribute: allow_mo" do
+        @payment_template.allow_mo.should == false
+      end
+
+      should "have attribute: allow_other" do
+        @payment_template.allow_other.should == true
+      end
+
+      should "have attribute: allow_paypal" do
+        @payment_template.allow_paypal.should == true
+      end
+
+      should "have attribute: allow_cc" do
+        @payment_template.allow_cc.should == false
+      end
+
+      should "have attribute: paypal_email" do
+        @payment_template.paypal_email.should == "user@example.com"
+      end
+
+      should "have attribute: name" do
+        @payment_template.name.should == "Example Template"
+      end
+
+      should "have attribute: first_line" do
+        @payment_template.first_line.should == nil
+      end
+
+      should "have attribute: second_line" do
+        @payment_template.second_line.should == nil
+      end
+
+      should "have attribute: city" do
+        @payment_template.city.should == "Chicago"
+      end
+
+      should "have attribute: state" do
+        @payment_template.state.should == "IL"
+      end
+
+      should "have attribute: zip" do
+        @payment_template.zip.should == "60605"
+      end
+
+      should "have attribute: country_id" do
+        @payment_template.country_id.should == 4
+      end
+    end
+  end
+end

data/test/unit/etsy/profile_test.rb

@@ -0,0 +1,111 @@
+require File.expand_path('../../../test_helper', __FILE__)
+
+module Etsy
+  class ProfileTest < Test::Unit::TestCase
+
+    # The Etsy profile can only be accessed as an association through other resources.
+    # There are no finders.
+    context "An instance of the Profile class" do
+
+      context "with response data" do
+        setup do
+          data = read_fixture('profile/new.json')
+          @profile = Profile.new(data)
+        end
+
+        should "have a value for :id" do
+          @profile.id.should == 123
+        end
+
+        should "have a value for :user_id" do
+          @profile.user_id.should == 5327518
+        end
+
+        should "have a value for :username" do
+          @profile.username.should == "littletjane"
+        end
+
+        should "have a value for :bio" do
+          @profile.bio.should == "I make stuff"
+        end
+
+        should "have a value for :gender" do
+          @profile.gender.should == "female"
+        end
+
+        should "have a value for :birth_day" do
+          @profile.birth_day.should == "01"
+        end
+
+        should "have a value for :birth_month" do
+          @profile.birth_month.should == "01"
+        end
+
+        should "have a value for :birth_year" do
+          @profile.birth_year.should == "1970"
+        end
+
+        should "have a value for :joined_at" do
+          @profile.joined_at.should == Time.at(1225392413)
+        end
+
+        should "have a value for :materials" do
+          @profile.materials.should == []
+        end
+
+        should "have a value for :country_id" do
+          @profile.country_id.should == 209
+        end
+
+        should "have a value for :city" do
+          @profile.city.should == "BigCity"
+        end
+
+        should "have a value for :avatar_id" do
+          @profile.avatar_id.should == 345
+        end
+
+        should "have a value for :location" do
+          @profile.location.should == "HQ"
+        end
+
+        should "have a value for :region" do
+          @profile.region.should == "The Desert"
+        end
+
+        should "have a value for :lat" do
+          @profile.lat.should == 39.5304
+        end
+
+        should "have a value for :lon" do
+          @profile.lon.should == -119.8144
+        end
+
+        should "have a value for :transaction_buy_count" do
+          @profile.transaction_buy_count.should == 19
+        end
+
+        should "have a value for :transaction_sold_count" do
+          @profile.transaction_sold_count.should == 16
+        end
+
+        should "have a value for :seller?" do
+          @profile.seller?.should == true
+        end
+
+        should "have a value for :image" do
+          @profile.image.should == 'some_image.jpg'
+        end
+
+        should "have a value for :first_name" do
+          @profile.first_name.should == 'Tinker'
+        end
+
+        should "have a value for :last_name" do
+          @profile.last_name.should == 'Bell'
+        end
+      end
+
+    end
+  end
+end

data/test/unit/etsy/request_test.rb

@@ -5,10 +5,6 @@ module Etsy
 
     context "The Request class" do
 
-      should "know the host" do
-        Request.host.should == 'openapi.etsy.com'
-      end
-
       should "be able to retrieve a response" do
         http_response = stub()
         response      = stub()
@@ -20,74 +16,100 @@ module Etsy
 
         Request.get('/user', :one => 'two').should == response
       end
+
+      should "require OAuth credentials if :require_secure is set" do
+        lambda do
+          Request.new('/path', :require_secure => true)
+        end.should raise_error(/Secure connection required/)
+      end
     end
 
     context "An instance of the Request class" do
 
-      should "know the base path for the sandbox read-only environment" do
-        Etsy.stubs(:environment).returns(:sandbox)
-        Etsy.stubs(:access_mode).returns(:read_only)
-
-        Request.new('').base_path.should == '/v2/sandbox/public'
+      should "know the base path" do
+        Request.new('').base_path.should == '/v2'
       end
 
-      should "know the base path for the sandbox read/write environment when the access information is present" do
-        Etsy.stubs(:environment).returns(:sandbox)
-        Etsy.stubs(:access_mode).returns(:read_write)
+      should "append the api_key to the parameters in basic mode" do
+        Etsy.expects(:api_key).with().returns('key')
+        Request.stubs(:secure?).returns(false)
 
-        r = Request.new('', :access_token => 'toke', :access_secret => 'secret')
-        r.base_path.should == '/v2/sandbox/private'
+        r = Request.new('/user', :limit => '1')
+        r.parameters.should == {:limit => '1', :api_key => 'key'}
       end
 
-      should "know the base path for the sandbox read/write environment when the access information is not present" do
-        Etsy.stubs(:environment).returns(:sandbox)
-        Etsy.stubs(:access_mode).returns(:read_write)
+      should "not append the api_key to the parameters in secure mode" do
+        Etsy.stubs(:access_mode).returns(:authenticated)
 
-        Request.new('').base_path.should == '/v2/sandbox/public'
+        r = Request.new('/user', :limit => '1', :access_token => 'token', :access_secret => 'secret')
+        r.parameters.should == {:limit => '1'}
       end
 
-      should "know the base path for the production read-only environment" do
-        Etsy.stubs(:environment).returns(:production)
-        Etsy.stubs(:access_mode).returns(:read_only)
 
-        Request.new('').base_path.should == '/v2/public'
+      should "be able to generate query parameters" do
+        r = Request.new('/user')
+        r.expects(:parameters).with().returns(:api_key => 'foo')
+        r.query.should == 'api_key=foo'
       end
 
-      should "know the base path for the production read-write environment when access information is present" do
-        Etsy.stubs(:environment).returns(:production)
-        Etsy.stubs(:access_mode).returns(:read_write)
+      should "be able to join multiple query parameters" do
+        params = {:limit => '1', :other => 'yes'}
 
-        r = Request.new('', :access_token => 'toke', :access_secret => 'secret')
-        r.base_path.should == '/v2/private'
-      end
+        r = Request.new('/user', params)
+        r.stubs(:parameters).with().returns(params)
 
-      should "know the base path for the production read-write environment when access information is not present" do
-        Etsy.stubs(:environment).returns(:production)
-        Etsy.stubs(:access_mode).returns(:read_write)
+        r.query.split('&').sort.should == %w(limit=1 other=yes)
+      end
 
-        Request.new('').base_path.should == '/v2/public'
+      should "be able to request a single association" do
+        r = Request.new('/foo', {:includes => 'Thunder'})
+        r.stubs(:parameters).with().returns({:a => :b})
+        CGI.parse(r.query).should == { "a" => ["b"], "includes" => ["Thunder"] }
       end
 
-      should "append the api_key and detail_level to the parameters" do
-        Etsy.expects(:api_key).with().returns('key')
+      should "be able make simplified association requests" do
+        r = Request.new('/foo', {:includes => ['Thunder', 'Lightning']})
+        r.stubs(:parameters).with().returns({:a => :b})
+        CGI.parse(r.query).should == { "a" => ["b"], "includes" => ["Thunder,Lightning"] }
+      end
 
-        r = Request.new('/user', :limit => '1')
-        r.parameters.should == {:limit => '1', :api_key => 'key', :detail_level => 'high'}
+      should "be able to generate detailed association queries" do
+        r = Request.new('/foo')
+        r.association(:resource => 'Lightning').should == 'Lightning'
       end
 
-      should "be able to generate query parameters" do
-        r = Request.new('/user')
-        r.expects(:parameters).with().returns(:api_key => 'foo')
-        r.query.should == 'api_key=foo'
+      should "be able to specify fields in association query" do
+        r = Request.new('/foo')
+        params = {:resource => 'Lightning', :fields => ['one', 'two']}
+        r.association(params).should == 'Lightning(one,two)'
       end
 
-      should "be able to join multiple query parameters" do
-        params = {:limit => '1', :other => 'yes'}
+      should "be able to specify limit in association query" do
+        r = Request.new('/foo')
+        params = {:resource => 'Lightning', :limit => 3}
+        r.association(params).should == 'Lightning:3:0'
+      end
 
-        r = Request.new('/user', params)
-        r.stubs(:parameters).with().returns(params)
+      should "be able to specify offset in association query" do
+        r = Request.new('/foo')
+        params = {:resource => 'Lightning', :offset => 7}
+        r.association(params).should == 'Lightning:25:7'
+      end
 
-        r.query.split('&').sort.should == %w(limit=1 other=yes)
+      should "be able to join multiple resources in association query" do
+        params = {
+          :a => 'b',
+          :includes => [
+            {:resource => 'Lightning'},
+            {:resource => 'Thunder'}
+          ]
+        }
+        r = Request.new('/foo', params)
+        r.stubs(:base_path).with().returns('/base')
+        r.stubs(:parameters).with().returns(:a => 'b')
+        uri = URI.parse(r.endpoint_url)
+        uri.path.should == '/base/foo'
+        CGI.parse(uri.query).should == { "a" => ["b"], "includes" => ["Lightning,Thunder"] }
       end
 
       should "be able to determine the endpoint URI when in read-only mode" do
@@ -98,8 +120,8 @@ module Etsy
         r.endpoint_url.should == '/base/user?a=b'
       end
 
-      should "be able to determine the endpoint URI when in read-write mode" do
-        Etsy.stubs(:access_mode).returns(:read_write)
+      should "be able to determine the endpoint URI when in authenticated mode" do
+        Etsy.stubs(:access_mode).returns(:authenticated)
 
         r = Request.new('/user', :access_token => 'toke', :access_secret => 'secret')
         r.stubs(:base_path).with().returns('/base')
@@ -110,7 +132,7 @@ module Etsy
 
       should "know the client for read-only mode" do
         Etsy.stubs(:access_mode).returns(:read_only)
-        Request.stubs(:host).returns('example.com')
+        Etsy.stubs(:host).returns('example.com')
 
         BasicClient.stubs(:new).with('example.com').returns('client')
 
@@ -119,9 +141,9 @@ module Etsy
         r.client.should == 'client'
       end
 
-      should "know the client for read-write mode when there is no access token information" do
-        Etsy.stubs(:access_mode).returns(:read_write)
-        Request.stubs(:host).returns('example.com')
+      should "know the client for authenticated mode when there is no access token information" do
+        Etsy.stubs(:access_mode).returns(:authenticated)
+        Etsy.stubs(:host).returns('example.com')
 
         BasicClient.stubs(:new).with('example.com').returns('client')
 
@@ -130,8 +152,8 @@ module Etsy
         r.client.should == 'client'
       end
 
-      should "know the client for read-write mode when there is access token information" do
-        Etsy.stubs(:access_mode).returns(:read_write)
+      should "know the client for authenticated mode when there is access token information" do
+        Etsy.stubs(:access_mode).returns(:authenticated)
         SecureClient.stubs(:new).with(:access_token => 'toke', :access_secret => 'secret').returns('client')
 
         r = Request.new('', :access_token => 'toke', :access_secret => 'secret')
@@ -149,6 +171,20 @@ module Etsy
         r.get.should == 'response'
       end
 
+      should "not modify the options hash passed to it" do
+        options = { :includes => 'Lightning',
+                    :access_token => 'token',
+                    :access_secret => 'secret',
+                    :fields => [:id],
+                    :limit => 100,
+                    :offset => 100 }
+        options_copy = options.dup
+
+        Request.new('', options)
+
+        options.should == options_copy
+      end
+
     end