etsy 0.2.0 → 0.2.1

data/.gitignore

@@ -0,0 +1,8 @@
+pkg/
+doc/
+coverage/
+.bundle
+Gemfile.lock
+.rvmrc
+*.sw*
+*.orig

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+gemspec
+
+group :test do
+  gem 'jnunemaker-matchy', '0.4.0', :require => 'matchy'
+  gem 'shoulda', '2.11.1'
+  gem 'mocha', '0.9.8'
+end
+

data/README.md

@@ -0,0 +1,300 @@
+# Etsy
+
+[![Build Status](https://secure.travis-ci.org/kytrinyx/etsy.png)](http://travis-ci.org/kytrinyx/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
+
+### Dependencies
+
+The gem has been verified to work with version 1.5.0 of json.
+It will likely work with higher versions, but this is unproven.
+
+## Usage
+
+### Public Mode
+
+The Etsy API has two modes: public, and authenticated. Public 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'
+
+First, generate a request token:
+
+    request = Etsy.request_token
+
+From there, you will need to paste a verification URL into a browser:
+
+    Etsy.verification_url
+
+Once you have allowed access, you can generate an access token by supplying
+the verifier displayed on the Etsy site:
+
+    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.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
+      request_token = Etsy.request_token
+      session[:request_token]  = request_token.token
+      session[:request_secret] = 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
+
+### Environment
+
+The Etsy API has both a sandbox environment and a production environment.
+
+If nothing is set, the default is :sandbox.
+
+You can set this using:
+
+    Etsy.environment = :production
+
+## DSL
+
+Use the Etsy::Request class to make flexible calls to the API.
+
+To do so, find out which endpoint you wish to connect to and the parameters you wish to pass in.
+
+    >> access = {:access_token => 'token', :access_secret => 'secret'}
+    >> Etsy::Request.get('/taxonomy/tags', access.merge(:limit => 5))
+
+or to fetch an associated resource
+
+    >> access = {:access_token => 'token', :access_secret => 'secret'}
+    >> Etsy::Request.get('/users/__SELF__', access.merge(:includes => 'Profile'))
+
+or to limit the fields returned
+
+    >> shop_id = 'littletjane'
+    >> access = {:access_token => 'token', :access_secret => 'secret'}
+    >> Etsy::Request.get('/shops/#{shop_id}', access.merge(:fields => 'is_vacation,is_refusing_alchemy'))
+
+## Convenience Methods
+
+There are some wrappers for resources that typically are needed in a small application.
+
+### 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.
+
+### Associations
+
+Associations on resources can be specified with the 'includes' key.
+
+A single resource can be specified with the name of the resource as a string:
+
+    >> Listing.find(1, {:includes => 'Images'})
+
+Multiple resources can be specified with the name of the resources as a comma-delimited string:
+
+    >> User.find(1, {:includes => ['FeedbackAsBuyer', 'FeedbackAsSeller']})
+
+If you want a more fine-grained response, you can specify the associations as an array of hashes, each of which must contain the name of the resource, and can also include the fields you wish returned, as well as the limit and offset.
+
+    >> association = {:resource => 'Images', :fields => ['red','green','blue'], :limit => 1, :offset => 0}
+    >> Listing.find(1, {:includes => [association]})
+
+## 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.
+
+### Basics steps for contributing using (https://github.com/defunkt/hub)
+
+    # Setup the project
+    git clone kytrinyx/etsy
+    git fork
+    bundle
+    rake
+    
+    # Normal flow
+    git checkout -b your-feature-or-bug
+    # Write your tests
+    # Make the tests pass
+    git add <CHANGES>
+    git commit -m "Some useful message"
+    git push -u YOUR-GITHUB-USERNAME your-feature-or-bug
+    git pull-request
+
+## Contributors
+
+These people have helped make the Etsy gem what it is today:
+
+* [Patrick Reagan](https://github.com/reagent)
+* [Katrina Owen](http://github.com/kytrinyx)
+* [Mak Nazečić-Andrlon](https://github.com/Muon)
+* [Patrick Schless](https://github.com/plainlystated)
+* [Matt Fields](https://github.com/mfields106)
+* [Jake Boxer](https://github.com/jakeboxer)
+* [Trae Robrock](https://github.com/trobrock)
+* [Jimmy Tang](https://github.com/jimmytang)
+* [Julio Santos](https://github.com/julio)
+
+### Github Flow
+
+For those of you with commit access, please check out Scott Chacon's blog post about [github flow](http://scottchacon.com/2011/08/31/github-flow.html)
+
+> * Anything in the master branch is deployable
+> * To work on something new, create a descriptively named branch off of master (ie: new-oauth2-scopes)
+> * Commit to that branch locally and regularly push your work to the same named branch on the server
+> * When you need feedback or help, or you think the branch is ready for merging, open a pull request
+> * After someone else has reviewed and signed off on the feature, you can merge it into master
+> * Once it is merged and pushed to ‘master’, you can and should deploy immediately
+
+## License
+
+Copyright (c) 2009 - 2012 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.

data/Rakefile

@@ -1,40 +1,12 @@
+#!/usr/bin/env rake
 require 'rubygems'
-require 'rake/gempackagetask'
 require 'rake/testtask'
-
-require 'lib/etsy/version'
+require "bundler/gem_tasks"
 
 task :default => :test
 
-spec = Gem::Specification.new do |s|
-  s.name             = 'etsy'
-  s.version          = Etsy::Version.to_s
-  s.has_rdoc         = true
-  s.extra_rdoc_files = %w(README.rdoc)
-  s.rdoc_options     = %w(--main README.rdoc)
-  s.summary          = "Provides a friendly ruby-like interface to the Etsy API"
-  s.author           = 'Patrick Reagan'
-  s.email            = 'reaganpr@gmail.com'
-  s.homepage         = 'http://sneaq.net'
-  s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib,test}/**/*")
-
-  s.add_dependency('json', '~> 1.4.0')
-  s.add_dependency('oauth', '~> 0.4.0')
-end
-
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.gem_spec = spec
-end
-
 Rake::TestTask.new do |t|
   t.libs << 'test'
   t.test_files = FileList["test/**/*_test.rb"]
   t.verbose = true
 end
-
-desc 'Generate the gemspec for this Gem'
-task :gemspec do
-  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
-  File.open(file, 'w') {|f| f << spec.to_ruby }
-  puts "Created gemspec: #{file}"
-end

data/etsy.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.required_rubygems_version = Gem::Requirement.new(">= 0") if gem.respond_to? :required_rubygems_version=
+  gem.rubygems_version = "1.8.10"
+
+  gem.authors       = ["Katrina Owen"]
+  gem.authors       = ["Patrick Reagan", "Katrina Owen"]
+  gem.email         = ["reaganpr@gmail.com", "katrina.owen@gmail.com"]
+  gem.description   = %q{A friendly Ruby interface to the Etsy API}
+  gem.summary       = %q{Provides a friendly ruby-like wrapper for the Etsy API}
+  gem.homepage      = "http://github.com/kytrinyx/etsy"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name = "etsy"
+  gem.require_paths = ["lib"]
+  gem.version = "0.2.1"
+
+  if gem.respond_to? :specification_version then
+    gem.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      gem.add_runtime_dependency("json", [">= 1.5.0"])
+      gem.add_runtime_dependency("oauth", ["~> 0.4.0"])
+    else
+      gem.add_dependency("json", [">= 1.5.0"])
+      gem.add_dependency("oauth", ["~> 0.4.0"])
+    end
+  else
+    gem.add_dependency("json", [">= 1.5.0"])
+    gem.add_dependency("oauth", ["~> 0.4.0"])
+  end
+
+end

data/lib/etsy.rb

@@ -3,6 +3,7 @@ $:.unshift File.dirname(__FILE__)
 require 'net/http'
 require 'json'
 require 'oauth'
+require 'uri'
 
 require 'etsy/request'
 require 'etsy/response'
@@ -13,9 +14,17 @@ require 'etsy/verification_request'
 
 require 'etsy/model'
 require 'etsy/user'
+require 'etsy/profile'
 require 'etsy/shop'
 require 'etsy/listing'
 require 'etsy/image'
+require 'etsy/transaction'
+require 'etsy/address'
+require 'etsy/category'
+require 'etsy/payment_template'
+require 'etsy/country'
+require 'etsy/shipping_template'
+require 'etsy/section'
 
 # = Etsy: A friendly Ruby interface to the Etsy API
 #
@@ -55,8 +64,12 @@ module Etsy
   class << self
     attr_accessor :api_key, :api_secret
     attr_writer :callback_url
+    attr_writer :permission_scopes
   end
 
+  SANDBOX_HOST = 'sandbox.openapi.etsy.com'
+  PRODUCTION_HOST = 'openapi.etsy.com'
+
   # Set the environment, accepts either :sandbox or :production. Defaults to :sandbox
   # and will raise an exception when set to an unrecognized environment.
   #
@@ -65,6 +78,7 @@ module Etsy
       raise(ArgumentError, "environment must be set to either :sandbox or :production")
     end
     @environment = environment
+    @host = (environment == :sandbox) ? SANDBOX_HOST : PRODUCTION_HOST
   end
 
   # The currently configured environment.
@@ -73,20 +87,8 @@ module Etsy
     @environment || :sandbox
   end
 
-  # Set the access mode, can either be :read_only or :read_write.  Defaults to :read_only
-  # and will raise an exception when set to an invalid value.
-  #
-  def self.access_mode=(mode)
-    unless [:read_only, :read_write].include?(mode)
-      raise(ArgumentError, "access mode must be set to either :read_only or :read_write")
-    end
-    @access_mode = mode
-  end
-
-  # The currently configured access mode
-  #
-  def self.access_mode
-    @access_mode || :read_only
+  def self.host # :nodoc:
+    @host || SANDBOX_HOST
   end
 
   # The configured callback URL or 'oob' if no callback URL is configured. This controls
@@ -96,6 +98,12 @@ module Etsy
     @callback_url || 'oob'
   end
 
+  # OAuth permission scopes. Defines which private fields we can have access to.
+  #
+  def self.permission_scopes
+    @permission_scopes || []
+  end
+
   # Find a user by username.  See Etsy::User for more information.
   #
   def self.user(username)
@@ -105,13 +113,14 @@ module Etsy
   # Convenience method for accessing the authenticated user's own user information. Requires
   # authentication.
   #
-  def self.myself(token, secret)
-    User.myself(token, secret)
+  def self.myself(token, secret, options = {})
+    User.myself(token, secret, options)
   end
 
   # Generate a request token for authorization.
   #
   def self.request_token
+    clear_for_new_authorization
     verification_request.request_token
   end
 
@@ -119,7 +128,7 @@ module Etsy
   # either be passed manually or from the params in the callback URL.
   #
   def self.access_token(request_token, request_secret, verifier)
-    @access_token ||= begin
+    @access_token = begin
       client = Etsy::SecureClient.new({
         :request_token  => request_token,
         :request_secret => request_secret,
@@ -135,9 +144,29 @@ module Etsy
     verification_request.url
   end
 
+  def self.single_user(access_token, access_secret)
+    @credentials = {
+      :access_token => access_token,
+      :access_secret => access_secret
+    }
+    nil
+  end
+
+  def self.credentials
+    @credentials || {}
+  end
+
   private
 
   def self.verification_request
     @verification_request ||= VerificationRequest.new
   end
+
+  def self.clear_for_new_authorization
+    @verification_request = nil
+  end
+
+  def self.deprecate(message)
+    puts "DEPRECATED: #{message}."
+  end
 end