etsy 0.2.0 → 0.2.1

data/test/unit/etsy/response_test.rb

@@ -19,15 +19,33 @@ module Etsy
         2.times { r.to_hash }
       end
 
-      should "have a record count" do
-        r = Response.new('')
-        r.expects(:to_hash).with().returns('count' => 1)
+      should "have a record count when the response is not paginated" do
+        raw_response = mock
+        raw_response.stubs(:body => '{ "count": 1 }')
+        r = Response.new(raw_response)
 
         r.count.should == 1
       end
 
+      should "have a record count when the response is paginated" do
+        raw_response = mock
+        raw_response.stubs(:body => '{ "count": 100, "results": [{},{}], "pagination": {} }')
+        r = Response.new(raw_response)
+
+        r.count.should == 2
+      end
+
+      should "return a count of 0 when the response is paginated and the results are empty" do
+        raw_response = mock
+        raw_response.stubs(:body => '{ "count": 100, "results": null, "pagination": {} }')
+        r = Response.new(raw_response)
+
+        r.count.should == 0
+      end
+
       should "return an array if there are multiple results entries" do
         r = Response.new('')
+        r.expects(:code).with().returns('200')
         r.expects(:count).with().returns(2)
         r.expects(:to_hash).with().returns('results' => %w(one two))
 
@@ -36,14 +54,110 @@ module Etsy
 
       should "return a single value for results if there is only 1 result" do
         r = Response.new('')
+        r.expects(:code).with().returns('200')
         r.expects(:count).with().returns(1)
         r.expects(:to_hash).with().returns('results' => ['foo'])
 
         r.result.should == 'foo'
       end
 
+      should "provide the complete raw body" do
+        raw_response = mock
+        raw_response.stubs(:body => "I am not JSON")
+        r = Response.new(raw_response)
+
+        r.body.should == 'I am not JSON'
+      end
+
+      should "raise an invalid JSON exception if the response is not json" do
+        raw_response = mock
+        raw_response.stubs(:body => "I am not JSON")
+        r = Response.new(raw_response)
+
+        lambda { r.to_hash }.should raise_error(Etsy::EtsyJSONInvalid)
+      end
+
+      should "raise OAuthTokenRevoked" do
+        raw_response = mock
+        raw_response.stubs(:body => "oauth_problem=token_revoked")
+        r = Response.new(raw_response)
+
+        lambda { r.to_hash }.should raise_error(Etsy::OAuthTokenRevoked)
+      end
+
+      should "raise MissingShopID" do
+        raw_response = mock
+        raw_response.stubs(:body => "something Shop with PK shop_id something")
+        r = Response.new(raw_response)
+
+        lambda { r.to_hash }.should raise_error(Etsy::MissingShopID)
+      end
+
+      should "raise InvalidUserID" do
+        raw_response = mock
+        raw_response.stubs(:body => "'someguy' is not a valid user_id")
+        r = Response.new(raw_response)
+
+        lambda { r.to_hash }.should raise_error(Etsy::InvalidUserID)
+      end
+
+      should "raise TemporaryIssue" do
+        raw_response = mock
+        raw_response.stubs(:body => "something Temporary Etsy issue something")
+        r = Response.new(raw_response)
+
+        lambda { r.to_hash }.should raise_error(Etsy::TemporaryIssue)
+
+        raw_response = mock
+        raw_response.stubs(:body => "something Resource temporarily unavailable something")
+        r = Response.new(raw_response)
+
+        lambda { r.to_hash }.should raise_error(Etsy::TemporaryIssue)
+
+        raw_response = mock
+        raw_response.stubs(:body => "something You have exceeded your API limit something")
+        r = Response.new(raw_response)
+
+        lambda { r.to_hash }.should raise_error(Etsy::TemporaryIssue)
+      end
+
+      should "provide the code" do
+        raw_response = mock
+        raw_response.expects(:code => "400")
+        r = Response.new(raw_response)
+
+        r.code.should == '400'
+      end
+
+      should "consider a code of 2xx successful" do
+        raw_response = mock
+
+        raw_response.expects(:code => "200")
+        r = Response.new(raw_response)
+        r.should be_success
+
+        raw_response.expects(:code => "201")
+        r = Response.new(raw_response)
+        r.should be_success
+      end
+
+      should "consider a code of 4xx unsuccessful" do
+        raw_response = mock
+
+        raw_response.expects(:code => "404")
+        r = Response.new(raw_response)
+        r.should_not be_success
+      end
+
+      should "consider a code of 5xx unsuccessful" do
+        raw_response = mock
+
+        raw_response.expects(:code => "500")
+        r = Response.new(raw_response)
+        r.should_not be_success
+      end
     end
 
 
   end
-end
+end

data/test/unit/etsy/section_test.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../../../test_helper', __FILE__)
+
+module Etsy
+  class SectionTest < Test::Unit::TestCase
+    context "An instance of the Section class" do
+      setup do
+        data = read_fixture('section/getShopSection.json')
+        @section = Section.new(data.first)
+      end
+
+      should "have an id" do
+        @section.id.should == 11045327
+      end
+
+      should "have an title" do
+        @section.title.should == "Blue Items"
+      end
+
+      should "have an user_id" do
+        @section.user_id.should == 9569349
+      end
+
+      should "have an active_listing_count" do
+        @section.active_listing_count.should == 7
+      end
+    end
+  end
+end

data/test/unit/etsy/secure_client_test.rb

@@ -5,15 +5,17 @@ module Etsy
 
     context "An instance of the SecureClient class" do
 
-      should "be able to generate an OAuth consumer" do
+      should "be able to generate an OAuth consumer for the sandbox" do
+        Etsy.stubs(:environment).returns :sandbox
+        Etsy.stubs(:host).returns 'sandbox'
         Etsy.stubs(:api_key).returns('key')
         Etsy.stubs(:api_secret).returns('secret')
+        Etsy.stubs(:permission_scopes).returns(['scope_one', 'scope_two'])
 
         OAuth::Consumer.stubs(:new).with('key', 'secret', {
-          :site               => 'http://openapi.etsy.com',
-          :request_token_path => '/v2/sandbox/oauth/request_token',
-          :access_token_path  => '/v2/sandbox/oauth/access_token',
-          :authorize_url      => 'https://www.etsy.com/oauth/signin'
+          :site               => 'http://sandbox',
+          :request_token_path => '/v2/oauth/request_token?scope=scope_one+scope_two',
+          :access_token_path  => '/v2/oauth/access_token',
         }).returns('consumer')
 
         client = SecureClient.new
@@ -21,6 +23,26 @@ module Etsy
         client.consumer.should == 'consumer'
       end
 
+      should "be able to generate an OAuth consumer in production" do
+        Etsy.stubs(:environment).returns :production
+        Etsy.stubs(:host).returns 'production'
+        Etsy.stubs(:api_key).returns('key')
+        Etsy.stubs(:api_secret).returns('secret')
+        Etsy.stubs(:permission_scopes).returns(['scope_one', 'scope_two'])
+
+        OAuth::Consumer.stubs(:new).with('key', 'secret', {
+          :site               => 'http://production',
+          :request_token_path => '/v2/oauth/request_token?scope=scope_one+scope_two',
+          :access_token_path  => '/v2/oauth/access_token',
+        }).returns('consumer')
+
+        client = SecureClient.new
+
+        client.consumer.should == 'consumer'
+      end
+
+
+
       should "be able to generate a request token" do
         Etsy.stubs(:callback_url).with().returns('callback_url')
         consumer = stub() {|c| c.stubs(:get_request_token).with(:oauth_callback => 'callback_url').returns('toke') }

data/test/unit/etsy/shipping_template_test.rb

@@ -0,0 +1,24 @@
+require File.expand_path('../../../test_helper', __FILE__)
+
+module Etsy
+  class ShippingTemplateTest < Test::Unit::TestCase
+    context "An instance of the ShippingTemplate class" do
+      setup do
+        data = read_fixture('shipping_template/getShippingTemplate.json')
+        @shipping_template = ShippingTemplate.new(data.first)
+      end
+
+      should "have an id" do
+        @shipping_template.id.should == 212
+      end
+
+      should "have an title" do
+        @shipping_template.title.should == "Small Items"
+      end
+
+      should "have an user_id" do
+        @shipping_template.user_id.should == 14888443
+      end
+    end
+  end
+end

data/test/unit/etsy/shop_test.rb

@@ -26,7 +26,7 @@ module Etsy
       end
 
       should "allow a configurable limit when finding all shops" do
-        shops = mock_request('/shops', {:limit => 100}, 'Shop', 'findAllShop.json')
+        shops = mock_request('/shops', {:limit => 100, :offset => 0}, 'Shop', 'findAllShop.json')
         Shop.all(:limit => 100).should == shops
       end
 
@@ -49,7 +49,15 @@ module Etsy
         end
 
         should "have a value for :image_url" do
-          @shop.image_url.should == "http://ny-image2.etsy.com/iusb_760x100.7358402.jpg"
+          @shop.image_url.should == "http://ny-image3.etsy.com/iusb_760x100.8484779.jpg"
+        end
+
+        should "have a value for :url" do
+          @shop.url.should == "http://www.etsy.com/shop/littletjane"
+        end
+
+        should "have a value for :favorers_count" do
+          @shop.favorers_count.should == 684
         end
 
         should "have a value for :active_listings_count" do
@@ -86,12 +94,11 @@ module Etsy
         shop = Shop.new
         shop.stubs(:id).with().returns(1)
 
-        Listing.stubs(:find_all_by_shop_id).with(1).returns('listings')
+        Listing.stubs(:find_all_by_shop_id).with(1, {}).returns('listings')
 
         shop.listings.should == 'listings'
       end
-
     end
 
   end
-end
+end

data/test/unit/etsy/transaction_test.rb

@@ -0,0 +1,52 @@
+require File.expand_path('../../../test_helper', __FILE__)
+
+module Etsy
+  class TransactionTest < Test::Unit::TestCase
+
+    context "The Transaction class" do
+
+      should "be able to find transactions for a shop" do
+        transactions = mock_request('/shops/1/transactions', {'key' => 'value'}, 'Transaction', 'findAllShopTransactions.json')
+        Transaction.find_all_by_shop_id(1, {'key' => 'value'}).should == transactions
+      end
+
+    end
+
+    context "An instance of the Transaction class" do
+
+      context "with response data" do
+        setup do
+          data = read_fixture('transaction/findAllShopTransactions.json')
+          @transaction = Transaction.new(data.first)
+        end
+
+        should "have a value for :id" do
+          @transaction.id.should == 27230877
+        end
+
+        should "have a value for :quantity" do
+          @transaction.quantity.should == 1
+        end
+
+        should "have a value for :buyer_id" do
+          @transaction.buyer_id.should == 9641557
+        end
+
+        should "have a value for :listing_id" do
+          @transaction.listing_id.should == 41680579
+        end
+      end
+
+      should "know the buyer" do
+        User.stubs(:find).with(1).returns('user')
+
+        transaction = Transaction.new
+        transaction.stubs(:buyer_id).with().returns(1)
+
+        transaction.buyer.should == 'user'
+      end
+
+    end
+
+  end
+end

data/test/unit/etsy/user_test.rb

@@ -15,15 +15,42 @@ module Etsy
         User.find('littletjane', 'reagent').should == users
       end
 
-      should "be able to find the current logged in user" do
-        oauth_keys = {:access_token => 'token', :access_secret => 'secret'}
-        users = mock_request('/users/__SELF__', oauth_keys, 'User', 'getUser.single.json')
-        User.myself('token', 'secret').should == users.first
+      should "be able to pass options when finding a user" do
+        options = {:limit => 90, :offset => 90}
+        users = mock_request('/users/littletjane', options, 'User', 'getUser.single.json')
+        User.find('littletjane', options).should == users.first
+      end
+
+      should "be able to find the authenticated user" do
+        options = {:access_token => 'token', :access_secret => 'secret'}
+        users = mock_request('/users/__SELF__', options, 'User', 'getUser.single.json')
+        User.myself('token', 'secret', options).should == users.first
       end
     end
 
     context "An instance of the User class" do
 
+      context "requested with oauth access token" do
+        setup do
+          options = {:access_token => 'token', :access_secret => 'secret'}
+
+          data = read_fixture('user/getUser.single.json')
+          response = 'response'
+          response.stubs(:result).with().returns [data]
+          Request.stubs(:get).with('/users/__SELF__', options).returns response
+
+          @user = User.find('__SELF__', options)
+        end
+
+        should "persist the token" do
+          @user.token.should == 'token'
+        end
+
+        should "persist the secret" do
+          @user.secret.should == 'secret'
+        end
+      end
+
       context "with public response data" do
         setup do
           data = read_fixture('user/getUser.single.json')
@@ -50,7 +77,7 @@ module Etsy
       context "with private response data" do
         setup do
           data = read_fixture('user/getUser.single.private.json')
-          @user = User.new(data.first)
+          @user = User.new(data.first, 'token', 'secret')
         end
 
         should "have an email address" do
@@ -58,6 +85,118 @@ module Etsy
         end
       end
 
+      context "requested with associated shops" do
+        setup do
+          data = read_fixture('user/getUser.single.withShops.json')
+          @user = User.new(data.first)
+        end
+
+        should "have shops" do
+          @user.shops.each do |shop|
+            shop.class.should == Shop
+          end
+        end
+
+        # This assumes for now that a user can have only one shop belonging to them
+        should "return the first shop belonging to the user" do
+          @user.shop.should == @user.shops.first
+        end
+      end
+      
+      context "requested without associated shops" do
+        setup do
+          @data_without_shops = read_fixture('user/getUser.single.json')
+          @data_with_shops = read_fixture('user/getUser.single.withShops.json')
+          @options = {:fields => 'user_id', :includes => 'Shops'}
+
+          @user_without_shops = User.new(@data_without_shops.first)
+          @user_with_shops = User.new(@data_with_shops.first)
+        end
+
+        should "make a call to the API to retrieve it if requested" do
+          User.expects(:find).with('littletjane', @options).returns @user_with_shops
+          @user_without_shops.shops
+        end
+
+        should "not call the api twice" do
+          User.expects(:find).once.with('littletjane', @options).returns @user_with_shops
+          @user_without_shops.shops
+          @user_without_shops.shops
+        end
+
+        should "return a list of populated shop instances" do
+          User.stubs(:find).with('littletjane', @options).returns @user_with_shops
+          @user_without_shops.shops.first.name.should == 'LittleJane'
+        end
+
+        should "make the call with authentication if oauth is used" do
+          user = User.new(@data_without_shops.first, 'token', 'secret')
+          oauth = {:access_token => 'token', :access_secret => 'secret'}
+          User.expects(:find).with('littletjane', @options.merge(oauth)).returns @user_with_shops
+          user.shops
+        end
+      end
+
+      context "requested with an associated profile" do
+        setup do
+          data = read_fixture('user/getUser.single.withProfile.json')
+          @user = User.new(data.first)
+        end
+
+        should "have a profile" do
+          @user.profile.class.should == Profile
+        end
+      end
+
+      context "requested without an associated profile" do
+        setup do
+          @data_without_profile = read_fixture('user/getUser.single.json')
+          @data_with_profile = read_fixture('user/getUser.single.withProfile.json')
+          @options = {:fields => 'user_id', :includes => 'Profile'}
+
+          @user_without_profile = User.new(@data_without_profile.first)
+          @user_with_profile = User.new(@data_with_profile.first)
+        end
+
+        should "make a call to the API to retrieve it if requested" do
+          User.expects(:find).with('littletjane', @options).returns @user_with_profile
+          @user_without_profile.profile
+        end
+
+        should "not call the api twice" do
+          User.expects(:find).once.with('littletjane', @options).returns @user_with_profile
+          @user_without_profile.profile
+          @user_without_profile.profile
+        end
+
+        should "return a populated profile instance" do
+          User.stubs(:find).with('littletjane', @options).returns @user_with_profile
+          @user_without_profile.profile.bio.should == 'I make stuff'
+        end
+
+        should "make the call with authentication if oauth is used" do
+          user = User.new(@data_without_profile.first, 'token', 'secret')
+          oauth = {:access_token => 'token', :access_secret => 'secret'}
+          User.expects(:find).with('littletjane', @options.merge(oauth)).returns @user_with_profile
+          user.profile
+        end
+      end
+
+      context "instantiated with oauth token" do
+        setup do
+          @user = User.new(nil, 'token', 'secret')
+        end
+
+        should "have the token" do
+          @user.token.should == 'token'
+        end
+
+        should "have the secret" do
+          @user.secret.should == 'secret'
+        end
+
+      end
+
       should "know when the user was created" do
         user = User.new
         user.stubs(:created).returns(1)
@@ -66,13 +205,13 @@ module Etsy
       end
     end
 
-    should "know the shop for a user" do
+    should "know the addresses for a user" do
       user = User.new
       user.stubs(:username).with().returns('username')
 
-      Shop.stubs(:find).with('username').returns('shop')
+      Address.stubs(:find).with('username', {}).returns('addresses')
 
-      user.shop.should == 'shop'
+      user.addresses.should == 'addresses'
     end
 
   end