etsy 0.2.0 → 0.2.1

data/test/unit/etsy/verification_request_test.rb

@@ -13,14 +13,14 @@ module Etsy
 
       should "know the url" do
         client = stub()
-        client.stubs(:request_token).returns(stub(:authorize_url => 'http://www.etsy.com?foo=bar', :secret => 'secret'))
+        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&oauth_consumer_key=secret'
+        @request.url.should == 'http://www.etsy.com?foo=bar&baz=true'
       end
 
     end
 
   end
-end
+end

data/test/unit/etsy_test.rb

@@ -7,8 +7,10 @@ class EtsyTest < Test::Unit::TestCase
       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)
     end
 
     should "be able to set and retrieve the API key" do
@@ -41,17 +43,18 @@ class EtsyTest < Test::Unit::TestCase
       Etsy.api_secret.should == 'secret'
     end
 
-    should "be in read-mode by default" do
-      Etsy.access_mode.should == :read_only
+    should "know the host for the sandbox environment" do
+      Etsy.environment = :sandbox
+      Etsy.host.should == 'sandbox.openapi.etsy.com'
     end
 
-    should "be able to set the access mode to a read-write" do
-      Etsy.access_mode = :read_write
-      Etsy.access_mode.should == :read_write
+    should "know the host for the production environment" do
+      Etsy.environment = :production
+      Etsy.host.should == 'openapi.etsy.com'
     end
 
-    should "raise an exception when attempting to set an invalid access mode" do
-      lambda { Etsy.access_mode = :invalid }.should raise_error(ArgumentError)
+    should "default to sandbox host" do
+      Etsy.host.should == 'sandbox.openapi.etsy.com'
     end
 
     should "be able to set the callback url" do
@@ -62,6 +65,15 @@ class EtsyTest < Test::Unit::TestCase
     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

metadata

@@ -1,132 +1,188 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: etsy
-version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Patrick Reagan
+- Katrina Owen
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-11-11 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-07-04 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70157167530640 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 4
-        - 0
-        version: 1.4.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: oauth
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70157167530640
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: &70157167530160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 0
-        - 4
-        - 0
+      - !ruby/object:Gem::Version
         version: 0.4.0
   type: :runtime
-  version_requirements: *id002
-description: 
-email: reaganpr@gmail.com
+  prerelease: false
+  version_requirements: *70157167530160
+description: A friendly Ruby interface to the Etsy API
+email:
+- reaganpr@gmail.com
+- katrina.owen@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.rdoc
-files: 
-- README.rdoc
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
 - Rakefile
+- etsy.gemspec
+- lib/etsy.rb
+- lib/etsy/address.rb
 - lib/etsy/basic_client.rb
+- lib/etsy/category.rb
+- lib/etsy/country.rb
 - lib/etsy/image.rb
 - lib/etsy/listing.rb
 - lib/etsy/model.rb
+- lib/etsy/payment_template.rb
+- lib/etsy/profile.rb
 - lib/etsy/request.rb
 - lib/etsy/response.rb
+- lib/etsy/section.rb
 - lib/etsy/secure_client.rb
+- lib/etsy/shipping_template.rb
 - lib/etsy/shop.rb
+- lib/etsy/transaction.rb
 - lib/etsy/user.rb
 - lib/etsy/verification_request.rb
-- lib/etsy/version.rb
-- lib/etsy.rb
+- test/fixtures/address/getUserAddresses.json
+- test/fixtures/category/findAllSubCategoryChildren.json
+- test/fixtures/category/findAllTopCategory.json
+- test/fixtures/category/findAllTopCategory.single.json
+- test/fixtures/category/findAllTopCategoryChildren.json
+- test/fixtures/category/getCategory.multiple.json
+- test/fixtures/category/getCategory.single.json
+- test/fixtures/country/getCountry.json
 - test/fixtures/image/findAllListingImages.json
-- test/fixtures/listing/findAllShopListingsActive.json
+- test/fixtures/listing/findAllListingActive.category.json
+- test/fixtures/listing/findAllShopListings.json
+- test/fixtures/listing/getListing.multiple.json
+- test/fixtures/listing/getListing.single.json
+- test/fixtures/payment_template/getPaymentTemplate.json
+- test/fixtures/profile/new.json
+- test/fixtures/section/getShopSection.json
+- test/fixtures/shipping_template/getShippingTemplate.json
 - test/fixtures/shop/findAllShop.json
 - test/fixtures/shop/findAllShop.single.json
 - test/fixtures/shop/getShop.multiple.json
 - test/fixtures/shop/getShop.single.json
+- test/fixtures/transaction/findAllShopTransactions.json
 - test/fixtures/user/getUser.multiple.json
 - test/fixtures/user/getUser.single.json
 - test/fixtures/user/getUser.single.private.json
+- test/fixtures/user/getUser.single.withProfile.json
+- test/fixtures/user/getUser.single.withShops.json
 - test/test_helper.rb
+- test/unit/etsy/address_test.rb
 - test/unit/etsy/basic_client_test.rb
+- test/unit/etsy/category_test.rb
+- test/unit/etsy/country_test.rb
 - test/unit/etsy/image_test.rb
 - test/unit/etsy/listing_test.rb
+- test/unit/etsy/model_test.rb
+- test/unit/etsy/payment_template_test.rb
+- test/unit/etsy/profile_test.rb
 - test/unit/etsy/request_test.rb
 - test/unit/etsy/response_test.rb
+- test/unit/etsy/section_test.rb
 - test/unit/etsy/secure_client_test.rb
+- test/unit/etsy/shipping_template_test.rb
 - test/unit/etsy/shop_test.rb
+- test/unit/etsy/transaction_test.rb
 - test/unit/etsy/user_test.rb
 - test/unit/etsy/verification_request_test.rb
 - test/unit/etsy_test.rb
-has_rdoc: true
-homepage: http://sneaq.net
+homepage: http://github.com/kytrinyx/etsy
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --main
-- README.rdoc
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Provides a friendly ruby-like interface to the Etsy API
-test_files: []
-
+summary: Provides a friendly ruby-like wrapper for the Etsy API
+test_files:
+- test/fixtures/address/getUserAddresses.json
+- test/fixtures/category/findAllSubCategoryChildren.json
+- test/fixtures/category/findAllTopCategory.json
+- test/fixtures/category/findAllTopCategory.single.json
+- test/fixtures/category/findAllTopCategoryChildren.json
+- test/fixtures/category/getCategory.multiple.json
+- test/fixtures/category/getCategory.single.json
+- test/fixtures/country/getCountry.json
+- test/fixtures/image/findAllListingImages.json
+- test/fixtures/listing/findAllListingActive.category.json
+- test/fixtures/listing/findAllShopListings.json
+- test/fixtures/listing/getListing.multiple.json
+- test/fixtures/listing/getListing.single.json
+- test/fixtures/payment_template/getPaymentTemplate.json
+- test/fixtures/profile/new.json
+- test/fixtures/section/getShopSection.json
+- test/fixtures/shipping_template/getShippingTemplate.json
+- test/fixtures/shop/findAllShop.json
+- test/fixtures/shop/findAllShop.single.json
+- test/fixtures/shop/getShop.multiple.json
+- test/fixtures/shop/getShop.single.json
+- test/fixtures/transaction/findAllShopTransactions.json
+- test/fixtures/user/getUser.multiple.json
+- test/fixtures/user/getUser.single.json
+- test/fixtures/user/getUser.single.private.json
+- test/fixtures/user/getUser.single.withProfile.json
+- test/fixtures/user/getUser.single.withShops.json
+- test/test_helper.rb
+- test/unit/etsy/address_test.rb
+- test/unit/etsy/basic_client_test.rb
+- test/unit/etsy/category_test.rb
+- test/unit/etsy/country_test.rb
+- test/unit/etsy/image_test.rb
+- test/unit/etsy/listing_test.rb
+- test/unit/etsy/model_test.rb
+- test/unit/etsy/payment_template_test.rb
+- test/unit/etsy/profile_test.rb
+- test/unit/etsy/request_test.rb
+- test/unit/etsy/response_test.rb
+- test/unit/etsy/section_test.rb
+- test/unit/etsy/secure_client_test.rb
+- test/unit/etsy/shipping_template_test.rb
+- test/unit/etsy/shop_test.rb
+- test/unit/etsy/transaction_test.rb
+- test/unit/etsy/user_test.rb
+- test/unit/etsy/verification_request_test.rb
+- test/unit/etsy_test.rb

data/README.rdoc

@@ -1,208 +0,0 @@
-= Etsy
-
-== Description
-
-The Etsy gem provides a friendly Ruby interface to the Etsy API
-
-== Installation
-
-Installing the latest stable version is simple:
-
-    $ gem install etsy
-
-If you want to be on the bleeding edge, install from GitHub:
-
-    $ git clone git://github.com/reagent/etsy.git
-    $ cd etsy
-    $ rake gem && gem install pkg/etsy-<version>.gem
-
-== Usage
-
-=== Read-Only Mode
-
-The Etsy API has two modes: read-only, and read-write. Read-only mode only requires an
-API key (available from http://developer.etsy.com):
-
-    require 'rubygems'
-    require 'etsy'
-
-    Etsy.api_key = 'foobar'
-
-From there, you can make any non-authenticated calls to the API that you need.
-
-== Authenticated Calls
-
-The Etsy API has support for both retrieval of extended information and write
-support for authenticated users.  Authentication can either be performed from
-the console or from within a Ruby web application.
-
-=== Console
-
-For simple authentication from the console, configure the necessary parameters:
-
-  require 'rubygems'
-  require 'etsy'
-
-  Etsy.api_key = 'key'
-  Etsy.api_secret = 'secret'
-  Etsy.access_mode = :read_write
-
-From there, you will need to paste the verification URL into a browser:
-
-  Etsy.verification_url
-
-Once you have allowed access, you can now generate an access token by supplying
-the verifier displayed on the Etsy site:
-
-  request = Etsy.request_token
-  access  = Etsy.access_token(request.token, request.secret, 'abc123')
-
-Authenticated calls can now be made by passing an access token and secret:
-
-Etsy.myself(access.token, access.secret)
-
-=== Web Application
-
-The process for authenticating via a web application is similar, but requires the
-configuration of a callback URL:
-
-  require 'rubygems'
-  require 'etsy'
-
-  Etsy.api_key = 'key'
-  Etsy.api_secret = 'secret'
-  Etsy.access_mode = :read_write
-  Etsy.callback_url = 'http://localhost:4567/authorize'
-
-In this mode, you'll need to store the request token and secret before redirecting
-to the verification URL.  A simple example using Sinatra:
-
-  enable :sessions
-
-  get '/' do
-    session[:request_token]  = Etsy.request_token.token
-    session[:request_secret] = Etsy.request_token.secret
-    redirect Etsy.verification_url
-  end
-
-  get '/authorize' do
-    access_token = Etsy.access_token(
-      session[:request_token],
-      session[:request_secret],
-      params[:oauth_verifier]
-    )
-
-    # access_token.token and access_token.secret can now be saved for future API calls
-  end
-
-=== Users
-
-If you're starting with a user, the easiest way is to use the Etsy.user method:
-
-    >> user = Etsy.user('littletjane')
-    => #<Etsy::User:0x107f82c @result=[{"city"=>"Washington, DC", ... >
-    >> user.username
-    => "littletjane"
-    >> user.id
-    => 5327518
-
-For more information about what is available for a user, check out the documentation
-for Etsy::User.
-
-== Shops
-
-Each user may optionally have a shop.  If a user is a seller, he / she also has an
-associated shop object:
-
-  >> shop = user.shop
-  => #<Etsy::Shop:0x102578c @result={"is_vacation"=>"", "announcement"=> ... >
-  >> shop.name
-  => "littletjane"
-  >> shop.title
-  => "a cute and crafty mix of handmade goods."
-
-More information about shops can be found in the documentation for Etsy::Shop.
-
-== Listings
-
-Shops contain multiple listings:
-
-  >> shop.listings
-  => [#<Etsy::Listing:0x119acac @result={} ...>, ... ]
-  >> listing = shop.listings.first
-  => #<Etsy::Listing:0x19a981c @result={} ... >
-  >> listing.title
-  => "hanging with the bad boys matchbox"
-  >> listing.description
-  => "standard size matchbox, approx. 1.5 x 2 inches ..."
-  >> listing.url
-  => "http://www.etsy.com/view_listing.php?listing_id=24165902"
-  >> listing.view_count
-  => 19
-  >> listing.created_at
-  => Sat Apr 25 11:31:34 -0400 2009
-
-See the documentation for Etsy::Listing for more information.
-
-== Images
-
-Each listing has one or more images available:
-
-  >> listing.images
-  => [#<Etsy::Image:0x18f85e4 @result={} ... >,
-      #<Etsy::Image:0x18f85d0 @result={} ... >]
-  >> listing.images.first.square
-  => "http://ny-image0.etsy.com/il_75x75.189111072.jpg"
-  >> listing.images.first.full
-  => "http://ny-image0.etsy.com/il_fullxfull.189111072.jpg"
-
-Listings also have a primary image:
-
-  >> listing.image
-  => #<Etsy::Image:0x18c3060 @result={} ... >
-  >> listing.image.full
-  => "http://ny-image0.etsy.com/il_fullxfull.189111072.jpg"
-
-More information is available in the documentation for Etsy::Image.
-
-== Contributing
-
-I have a "commit bit" policy for contributions to this repository. Once I accept
-your patch, I will give you full commit access.  To submit patches:
-
-1. Fork this repository
-2. Implement the desired feature with tests (and documentation if necessary)
-3. Send me a pull request
-
-I ask that you not submit patches that include changes to the version or gemspec.
-
-== Contributors
-
-These people have helped make the Etsy gem what it is today:
-
-* {Katrina Owen}[http://github.com/kowen]
-
-== License
-
-Copyright (c) 2009 - 2010 Patrick Reagan (reaganpr@gmail.com)
-
-Permission is hereby granted, free of charge, to any person
-obtaining a copy of this software and associated documentation
-files (the "Software"), to deal in the Software without
-restriction, including without limitation the rights to use,
-copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the
-Software is furnished to do so, subject to the following
-conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.