Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A friendly Ruby interface to the Etsy API
Ruby
Branch: master
Pull request Compare This branch is 2 commits ahead, 181 commits behind kytrinyx:master.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test
.gitignore
Gemfile
README.rdoc
Rakefile
etsy.gemspec

README.rdoc

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

Public Mode

The Etsy API has two modes: public, and authenticated. Public mode only requires an API key (available from 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'

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.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

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]})

Custom Requests to the Etsy API

It is possible to use the Etsy::Request class to make custom calls to the API. To do so, find out which endpoint you wish to connect to and the parameters you wish to pass in.

e.g. to fetch a resource that hasn't yet been implemented directly in the gem:

>> 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'))

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:

License

Copyright © 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.

Something went wrong with that request. Please try again.