cardmagic-etsy 0.3.2

data/test/unit/etsy/transaction_test.rb

@@ -0,0 +1,61 @@
+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
+
+      should "be able to find transactions for a buyer" do
+        transactions = mock_request('/users/1/transactions', {'key' => 'value'}, 'Transaction', 'findAllShopTransactions.json')
+        Transaction.find_all_by_buyer_id(1, {'key' => 'value'}).should == transactions
+      end
+
+      should "be able to find transactions for a receipt" do
+        transactions = mock_request('/receipts/1/transactions', {'key' => 'value'}, 'Transaction', 'findAllShopTransactions.json')
+        Transaction.find_all_by_receipt_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

@@ -0,0 +1,250 @@
+require File.expand_path('../../../test_helper', __FILE__)
+
+module Etsy
+  class UserTest < Test::Unit::TestCase
+
+    context "The User class" do
+
+      should "be able to find a single user" do
+        users = mock_request('/users/littletjane', {}, 'User', 'getUser.single.json')
+        User.find('littletjane').should == users.first
+      end
+
+      should "be able to find multiple users" do
+        users = mock_request('/users/littletjane,reagent', {}, 'User', 'getUser.multiple.json')
+        User.find('littletjane', 'reagent').should == users
+      end
+
+      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')
+          @user = User.new(data.first)
+        end
+
+        should "have an ID" do
+          @user.id.should == 5327518
+        end
+
+        should "have a :username" do
+          @user.username.should == 'littletjane'
+        end
+
+        should "have a value for :created" do
+          @user.created.should == 1191381578
+        end
+
+        should "not have an email address" do
+          @user.email.should be_nil
+        end
+      end
+
+      context "with private response data" do
+        setup do
+          data = read_fixture('user/getUser.single.private.json')
+          @user = User.new(data.first, 'token', 'secret')
+        end
+
+        should "have an email address" do
+          @user.email.should == 'reaganpr@gmail.com'
+        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)
+
+        user.created_at.should == Time.at(1)
+      end
+
+      context "with favorite listings data" do
+        setup do
+          data = read_fixture('user/getUser.single.withProfile.json')
+          @user = User.new(data.first)
+          listing_1 = stub(:listing_id => 1, :user_id => @user.id)
+          listing_2 = stub(:listing_id => 2, :user_id => @user.id)
+          @favorite_listings = [listing_1, listing_2]
+        end
+
+        should "have all listings" do
+          FavoriteListing.stubs(:find_all_user_favorite_listings).with(@user.id, {:access_token => nil, :access_secret => nil}).returns(@favorite_listings)
+          Listing.stubs(:find).with([1, 2], {:access_token => nil, :access_secret => nil}).returns(['listings'])
+          @user.favorites.should == ['listings']
+        end
+      end
+
+      context "with bought listings data" do
+        setup do
+          data = read_fixture('user/getUser.single.withProfile.json')
+          @user = User.new(data.first)
+          listing_1 = stub(:listing_id => 1, :user_id => @user.id)
+          listing_2 = stub(:listing_id => 2, :user_id => @user.id)
+          @bought_listings = [listing_1, listing_2]
+        end
+
+        should "have all listings" do
+          Transaction.stubs(:find_all_by_buyer_id).with(@user.id, {:access_token => nil, :access_secret => nil}).returns(@bought_listings)
+          Listing.stubs(:find).with([1, 2], {:access_token => nil, :access_secret => nil}).returns(['listings'])
+          @user.bought_listings.should == ['listings']
+        end
+      end
+    end
+
+    should "know the addresses for a user" do
+      user = User.new
+      user.stubs(:username).with().returns('username')
+
+      Address.stubs(:find).with('username', {}).returns('addresses')
+
+      user.addresses.should == 'addresses'
+    end
+
+  end
+end

data/test/unit/etsy/verification_request_test.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../../../test_helper', __FILE__)
+
+module Etsy
+  class VerificationRequestTest < Test::Unit::TestCase
+
+    context "An instance of the VerificationRequest class" do
+      setup { @request = VerificationRequest.new }
+
+      should "have a client" do
+        SecureClient.stubs(:new).returns('client')
+        @request.client.should == 'client'
+      end
+
+      should "know the url" do
+        client = stub()
+        client.stubs(:request_token).returns(stub(:params => {:login_url => 'http://www.etsy.com?foo=bar&baz=true'}, :secret => 'secret'))
+
+        @request.stubs(:client).returns(client)
+
+        @request.url.should == 'http://www.etsy.com?foo=bar&baz=true'
+      end
+
+    end
+
+  end
+end

data/test/unit/etsy_test.rb

@@ -0,0 +1,173 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+class EtsyTest < Test::Unit::TestCase
+
+  context "The Etsy module" do
+    setup do
+      Etsy.instance_variable_set(:@protocol, nil)
+      Etsy.instance_variable_set(:@environment, nil)
+      Etsy.instance_variable_set(:@access_mode, nil)
+      Etsy.instance_variable_set(:@callback_url, nil)
+      Etsy.instance_variable_set(:@host, nil)
+      Etsy.instance_variable_set(:@api_key, nil)
+      Etsy.instance_variable_set(:@api_secret, nil)
+      Etsy.instance_variable_set(:@permission_scopes, nil)
+      Etsy.instance_variable_set(:@silent_errors, nil)
+    end
+
+    should "be able to set and retrieve the API key" do
+      Etsy.api_key = 'key'
+      Etsy.api_key.should == 'key'
+    end
+
+    should "be able to set and retrieve the API key across threads (global)" do
+      Etsy.api_key = 'key'
+      Thread.new do
+        Etsy.api_key.should == 'key'
+      end.join
+    end
+
+    should "be able to set and retrieve the API key inside a thread (thread local)" do
+      Etsy.api_key = 'key'
+      Thread.new do
+        Etsy.api_key = 'thread_local_key'
+        Etsy.api_key.should == 'thread_local_key'
+      end.join
+    end
+
+    should "be able to set and retrieve the API secret" do
+      Etsy.api_secret = 'secret'
+      Etsy.api_secret.should == 'secret'
+    end
+
+    should "be able to set and retrieve the API secret across threads (global)" do
+      Etsy.api_secret = 'secret'
+      Thread.new do
+        Etsy.api_secret.should == 'secret'
+      end.join
+    end
+
+    should "be able to set and retrieve the API secret inside a thread (thread local)" do
+      Etsy.api_secret = 'secret'
+      Thread.new do
+        Etsy.api_secret = 'thread_local_secret'
+        Etsy.api_secret.should == 'thread_local_secret'
+      end.join
+    end
+
+    should "be able to find a user by username" do
+      user = stub()
+
+      Etsy::User.expects(:find).with('littletjane').returns(user)
+      Etsy.user('littletjane').should == user
+    end
+
+    should "use the https protocol by default" do
+      Etsy.protocol.should == "https"
+    end
+
+    should "be able to set the protocol to a valid value" do
+      Etsy.protocol = 'http'
+      Etsy.protocol.should == 'http'
+    end
+
+    should "raise an exception when attempting to set an invalid protocol" do
+      lambda { Etsy.protocol = :invalid }.should raise_error(ArgumentError)
+    end
+
+    should "use silent errors by default" do
+      Etsy.silent_errors.should == true
+    end
+
+    should "be able to set silent errors to a valid value" do
+      Etsy.silent_errors = false
+      Etsy.silent_errors.should == false
+    end
+
+    should "raise an exception when attempting to set an invalid silent errors value" do
+      lambda { Etsy.silent_errors = :invalid }.should raise_error(ArgumentError)
+    end
+
+    should "use the production environment by default" do
+      Etsy.environment.should == :production
+    end
+
+    should "be able to set the environment to a valid value" do
+      Etsy.environment = :sandbox
+      Etsy.environment.should == :sandbox
+    end
+
+    should "raise an exception when attempting to set an invalid environment" do
+      lambda { Etsy.environment = :invalid }.should raise_error(ArgumentError)
+    end
+
+    should "know the host for the sandbox environment" do
+      Etsy.environment = :sandbox
+      Etsy.host.should == 'sandbox.openapi.etsy.com'
+    end
+
+    should "know the host for the production environment" do
+      Etsy.environment = :production
+      Etsy.host.should == 'openapi.etsy.com'
+    end
+
+    should "default to production host" do
+      Etsy.host.should == 'openapi.etsy.com'
+    end
+
+    should "be able to set the callback url" do
+      Etsy.callback_url = 'http://localhost'
+      Etsy.callback_url.should == 'http://localhost'
+    end
+
+    should "default callback to out-of-band" do
+      Etsy.callback_url.should == 'oob'
+    end
+
+    should "default permission scopes to an empty array" do
+      Etsy.permission_scopes.should == []
+    end
+
+    should "be able to set the scopes" do
+      Etsy.permission_scopes = %w(a_scope another_scope)
+      Etsy.permission_scopes.should == ['a_scope', 'another_scope']
+    end
+  end
+
+  context "The Etsy module when set up properly" do
+    setup do
+      Etsy.instance_variable_set(:@protocol, 'https')
+      Etsy.instance_variable_set(:@environment, :sandbox)
+      Etsy.instance_variable_set(:@access_mode, :read_write)
+      Etsy.instance_variable_set(:@api_key, 'key')
+      Etsy.instance_variable_set(:@api_secret, 'secret')
+      Etsy.instance_variable_set(:@verification_request, nil)
+    end
+
+    should "provide a request token" do
+      request = stub(:request_token => 'token')
+      Etsy::VerificationRequest.stubs(:new).returns(request)
+
+      Etsy.request_token.should == 'token'
+    end
+
+    should "be able to generate an access token" do
+      Etsy::SecureClient.stubs(:new).with({
+        :request_token  => 'toke',
+        :request_secret => 'secret',
+        :verifier       => 'verifier'
+      }).returns(stub(:client => 'token'))
+
+      Etsy.access_token('toke', 'secret', 'verifier').should == 'token'
+    end
+
+    should "provide a verification URL" do
+      request = stub(:url => 'url')
+      Etsy::VerificationRequest.stubs(:new).returns(request)
+
+      Etsy.verification_url.should == 'url'
+    end
+
+  end
+
+end