English
资源说明：A friendly Ruby interface to the Etsy API
# Etsy
[](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/iamfmjk/etsy.git
$ cd etsy
$ rake install
### 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
In order to try this out you'll need to create an app on [etsy.com/your/apps](https://www.etsy.com/your/apps).
This will give you an api key and secret.
Paste the following into IRB, replacing the api key and secret with the ones you got on Etsy:
```ruby
require 'etsy'
Etsy.protocol = "https"
Etsy.api_key = 'YOUR API KEY'
Etsy.api_secret = 'YOUR SECRET'
request = Etsy.request_token
Etsy.verification_url
```
Paste the verification URL into your browser, and authorize the application. That will give you a page
with a code on it. Paste the following into IRB, replacing the code:
```ruby
access = Etsy.access_token(request.token, request.secret, 'CODE')
Etsy.myself(access.token, access.secret)
```
If you've received a 401 unauthorized error, then you likely don't have a valid api key and secret, or
perhaps the verification url timed out.
### 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 '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 '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)
The key and secret have to be passed in for the authenticated calls.
auth = {:access_token=>access.token, :access_secret=>access.secret}
Etsy::Transaction.find_all_by_shop_id(shop_id, auth.merge(options))
### Web Application
The process for authenticating via a web application is similar, but requires the configuration of a callback URL:
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 previously had both a sandbox environment and a production environment. They have recently eliminated the sandbox environment, but the ability to set the environment has been preserved in case it is implemented in v3.
If nothing is set, the default is :production.
You can set this using:
Etsy.environment = :production
## Error handling
For legacy reasons, this gem does *not* raise errors when requests are unsuccessful.
However, you can force errors to be thrown by configuring the `silent_errors` flag.
>>> Etsy.silent_errors = false
## 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')
=> #"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
=> #"", "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
=> [#, ... ]
>> listing = shop.listings.first
=> #
>> 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
=> [#,
#]
>> 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
=> #
>> 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]})
## Public mode vs authenticated calls
This additional example should make clear the difference between issuing public versus authenticated requests:
### Public workflow
>> Etsy.api_key = 'key'
>> user = Etsy.user('user_id_or_name')
>> Etsy::Listing.find_all_by_shop_id(user.shop.id, :limit => 5)
### Authenticated workflow
>> Etsy.api_key = 'key'
>> Etsy.api_secret = 'secret'
>> user = Etsy.myself(token, secret)
>> access = { :access_token => user.token, :access_secret => user.secret }
>> Etsy::Listing.find_all_by_shop_id(user.shop.id, access.merge(:limit => 5))
## 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
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](https://github.com/kytrinyx)
* [Trae Robrock](https://github.com/trobrock)
* [Roger Smith](https://github.com/rogsmith)
* [Jimmy Tang](https://github.com/jimmytang)
* [Mak Nazečić-Andrlon](https://github.com/Muon)
* [Daniel Szmulewicz](https://github.com/danielsz)
* [Patrick Schless](https://github.com/plainlystated)
* [Martin Popelak](https://github.com/pupca)
* [Julio Santos](https://github.com/julio)
* [Matt Fields](https://github.com/mfields106)
* [Mike Taylor](https://github.com/sealabcore)
* [Mason Stewart](https://github.com/masondesu)
* [Sasha Gerrand](https://github.com/sgerrand)
* [Jake Boxer](https://github.com/jakeboxer)
* [Sunwoo Yang](https://github.com/sunwooz)
* [Isaac Rosenberg](https://github.com/irosenb)
* [Carson Gross](https://github.com/carsongross)
* [John Amicangelo](https://github.com/JohnAmican)
* [Max Gulyaev](https://github.com/maxilev)
* [fbehrens](https://github.com/fbehrens)
* [William Jeffries](https://github.com/williamcodes)
* [Jack Guoyuan Zhao](https://github.com/zhaoguoyuan)
### 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
The Etsy rubygem is released under the MIT license.
本源码包内暂不包含可直接显示的源代码文件，请下载源码包。
