omniauth-etsy 0.0.2.alpha → 0.1.0

data/README.md

@@ -1,30 +1,81 @@
 # OmniAuth Etsy
 
-A very alpha and unofficial [OmniAuth](https://github.com/intridea/omniauth) strategy for Etsy. To use it, you'll need OmniAuth and a registered application on [Etsy](https://www.etsy.com/developers/register) to get a token and secret.
+An unofficial [OmniAuth](https://github.com/intridea/omniauth) strategy for Etsy. To use it, you'll need OmniAuth and a registered application on [Etsy](https://www.etsy.com/developers/register).
 
-## Useage with Rails
+## Usage
 
-Create an initializer file, and tell OmniAuth you'd like to register etsy as a provider:
+`OmniAuth::Etsy` is Rack middleware. Below are examples written specifically for Rails 3.1+, however it can be used in other frameworks based off of Rack (Sinatra, etc). See the [OmniAuth docs](https://github.com/intridea/omniauth) for detailed usage examples.
+
+Create an initializer file, and tell OmniAuth you'd like to register Etsy as a provider:
+
+    Rails.application.config.middleware.use OmniAuth::Builder do
+      provider :etsy, ENV['ETSY_TOKEN'], ENV['ETSY_SECRET']
+    end
+
+Etsy allows for sandbox API requests; to utilize it add sandbox to your config:
 
     Rails.application.config.middleware.use OmniAuth::Builder do
-      provider :etsy, 'token', 'secret'
+      provider :etsy, ENV['ETSY_TOKEN'], ENV['ETSY_SECRET'], :sandbox => true
     end
 
-Optionally, you may also pass in comma separated [Permission Scopes](http://www.etsy.com/developers/documentation/getting_started/oauth#section_permission_scopes):
+Note: Etsy's sandbox API may return rather _unusual_ results. I advise when making read-only requests to simply forgo the sandbox.
+
+Optionally, you may also pass in comma-separated [Permission Scopes](http://www.etsy.com/developers/documentation/getting_started/oauth#section_permission_scopes):
 
 
     Rails.application.config.middleware.use OmniAuth::Builder do
-      provider :etsy, 'token', 'secret', :scope => 'email_r'
+      provider :etsy, ENV['ETSY_TOKEN'], ENV['ETSY_SECRET'], :scope => 'email_r,profile_r,listings_r'
     end
 
 Note: If for some reason you receive a 400 error, it's probably your scopes.
 
+## Auth hash
+
+On callback this is what you can expect in your `request.env['omniauth.auth']` info hash:
+
+```ruby
+provider: etsy
+uid: 12341241
+info:
+  nickname: 'nickname'
+  email: 'you@email.com'
+  user_id: 12341241
+  first_name: 'Bill'
+  last_name: 'Clinton'
+  name: 'Bill Clinton'
+  image: 'http://www.etsy.com/images/avatars/default_avatar_75px.png'
+  profile:
+    user_profile_id: 12341241
+    user_id: 12341241
+    login_name: 'nickname'
+    bio: ''
+    gender: private
+    birth_month: '0'
+    birth_day: '0'
+    birth_year: '0'
+    join_tsz: 1337366290
+    materials: ''
+    country_id: ''
+    region: ''
+    city: ''
+    location: ''
+    avatar_id: ''
+    lat: ''
+    lon: ''
+    transaction_buy_count: 0
+    transaction_sold_count: 0
+    is_seller: false
+    image_url_75x75: 'http://www.etsy.com/images/avatars/default_avatar_75px.png'
+    first_name: 'Bill'
+    last_name: 'Clinton'
+```
+
 ## Installation
 
 Add OmniAuth and OmniAuth::Etsy to your application's Gemfile:
 
     gem 'omniauth', '~>1.0'
-    gem 'omniauth-etsy', '0.0.2.alpha'
+    gem 'omniauth-etsy', '~>0.1.0'
 
 And then execute:
 
@@ -32,9 +83,11 @@ And then execute:
 
 Or install it yourself as:
 
-  $ gem install omniauth
+    $ gem install omniauth
     $ gem install omniauth-etsy
 
+`OmniAuth::Etsy` has been used on both Ruby 1.9.2 and REE 1.8.7.
+
 ## Contributing
 
 1. Fork it

data/lib/omniauth-etsy/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module Etsy
-    VERSION = "0.0.2.alpha"
+    VERSION = "0.1.0"
   end
 end

data/lib/omniauth/strategies/etsy.rb

@@ -3,8 +3,9 @@ require 'omniauth-oauth'
 module OmniAuth
   module Strategies
     class Etsy < OmniAuth::Strategies::OAuth
+
       option :client_options, {
-        :site               => "http://sandbox.openapi.etsy.com/v2",
+        :site               => "http://openapi.etsy.com/v2",
         :request_token_path => "/oauth/request_token",
         :access_token_path  => "/oauth/access_token",
         :authorize_url      => "https://www.etsy.com/oauth/signin"
@@ -17,31 +18,38 @@ module OmniAuth
           'nickname' => raw_info['login_name'],
           'email' => raw_info['primary_email'],
           'user_id' => raw_info['user_id'],
-        }.merge!(profile_info)
+          'name' => "#{profile_info['first_name']} #{profile_info['last_name']}",
+          'first_name' => profile_info['first_name'],
+          'last_name' => profile_info['last_name'],
+          'image' => profile_info['image_url_75x75'],
+          'profile' => profile_info
+        }
       end
 
       def request_phase
         if options.scope
-          options.request_params.merge!(:scope => Rack::Utils.build_query([options.scope]))
+          options.request_params.merge!(:scope => options.scope.gsub(',', ' '))
         end
+        prep_sandbox
         super
       end
 
-      def profile_info
-        profile = user_hash['Profile']
-        if profile
-          {
-            'first_name' => profile['first_name'],
-            'last_name' => profile['last_name'],
-            'image' => profile['image_url_75x75'],
-            'full_name' => "#{profile['first_name']} #{profile['last_name']}",
-            'name' => "#{profile['first_name']} #{profile['last_name']}"
-          }
-        else
-          {}
+      def callback_phase
+        prep_sandbox
+        super
+      end
+
+      def prep_sandbox
+        if options.sandbox
+          options.client_options.merge!(:site => "http://sandbox.openapi.etsy.com/v2")
         end
       end
 
+      def profile_info
+        @profile_info ||= user_hash['Profile']
+        @profile_info.each { |k,v| @profile_info[k] = '' if v == nil }
+      end
+
       def raw_info
         @data ||= user_hash
       end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: omniauth-etsy
 version: !ruby/object:Gem::Version 
-  hash: -850052270
-  prerelease: 6
+  hash: 27
+  prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 2
-  - alpha
-  version: 0.0.2.alpha
+  version: 0.1.0
 platform: ruby
 authors: 
 - Jeff Mehlhoff
@@ -16,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-27 00:00:00 -07:00
+date: 2012-05-28 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -103,14 +102,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      hash: 25
+      hash: 3
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: