omniauth-ebay 0.0.2

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.idea

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,53 @@
+OmniAuth eBay
+====================================
+
+In this gem you will find an OmniAuth eBay strategy that is compliant with the Open eBay Apps API.
+You can read all about it here: [Open eBay Apps Developers Zone](http://developer.ebay.com/DevZone/open-ebay-apps/Concepts/OpeneBayUGDev.html)
+
+Usage
+------------------------------------------
+
+Note: The examples are for a Rails app.
+
+* Add our gem to your `Gemfile`
+`gem 'omniauth-ebay'`
+
+* Add to your omniauth initializer (`config/initializers/omniauth.rb`) the ebay strategy like so:
+
+`Rails.application.config.middleware.use OmniAuth::Builder do
+
+   provider :ebay, "runame", "devid", "appid", "certid", "siteid", "apiurl"
+
+end`
+
+Insert your app credentials in the given order. You can find out these details by going into your developer's account at [eBay DevZone](https://developer.ebay.com/DevZone/account/)
+
+* To use the strategy, you will need to access it's omniauth provider path: `/auth/ebay`. The callback phase path is the default one: `/auth/ebay/callback`.
+You will need to define the callback path in your relevant app RUname, so don't forget to set the accept/reject paths in the devzone to the callback path.
+
+* Set a route to the callback path of your sessions controller, and handle the session creation there. You will be able to access
+the omniauth session data by accessing `request.env['omniauth.auth']`
+
+How it Works
+====================================
+
+Request Phase
+--------------------
+
+* API call to eBay, requesting a session id.
+* Redirecting to eBay login with the session id.
+
+Callback Phase
+-----------------------------------------
+
+* API call to eBay, requesting an ebay auth token, with the secret id and username retrieved from the request.
+* API call to eBay, requesting the user's info by using the ebay auth token from the last call.
+* The strategy's UID is the eBay EIAS Token. Also these fields will also be exposed by accessing `request.env['omniauth.auth'].info`:
+
+`ebay_id` - The user's eBay username.
+
+`ebay_token` - The current session's auth token, to be used for API calls.
+
+`email` - The user's email address.
+* Extra data - We're also passing an optional parameter, `return_to`, which allows you to specify a URL you want the redirect the user to when the authentication process is completed.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/ebay_api.rb

@@ -0,0 +1,72 @@
+module EbayAPI
+
+  EBAY_LOGIN_URL = "https://signin.ebay.com/ws/eBayISAPI.dll"
+  X_EBAY_API_REQUEST_CONTENT_TYPE = 'text/xml'
+  X_EBAY_API_COMPATIBILITY_LEVEL = '675'
+  X_EBAY_API_GETSESSIONID_CALL_NAME = 'GetSessionID'
+  X_EBAY_API_FETCHAUTHTOKEN_CALL_NAME = 'FetchToken'
+  X_EBAY_API_GETUSER_CALL_NAME = 'GetUser'
+
+  def generate_session_id
+    request = <<-END
+          <?xml version="1.0" encoding="utf-8"?>
+          <GetSessionIDRequest xmlns="urn:ebay:apis:eBLBaseComponents">
+            <RuName>#{options.runame}</RuName>
+          </GetSessionIDRequest>
+    END
+
+    response = api(X_EBAY_API_GETSESSIONID_CALL_NAME, request)
+    MultiXml.parse(response.content)["GetSessionIDResponse"]["SessionID"]
+  end
+
+  def get_auth_token(username, secret_id)
+    request = <<-END
+          <?xml version="1.0" encoding="utf-8"?>
+          <FetchTokenRequest xmlns="urn:ebay:apis:eBLBaseComponents">
+             <RequesterCredentials>
+               <Username>#{username}</Username>
+             </RequesterCredentials>
+             <SecretID>#{secret_id.gsub(' ', '+')}</SecretID>
+          </FetchTokenRequest>
+    END
+
+    response = api(X_EBAY_API_FETCHAUTHTOKEN_CALL_NAME, request)
+    MultiXml.parse(response.content)["FetchTokenResponse"]["eBayAuthToken"]
+  end
+
+  def get_user_info(auth_token)
+    request = <<-END
+          <?xml version="1.0" encoding="utf-8"?>
+          <GetUserRequest xmlns="urn:ebay:apis:eBLBaseComponents">
+            <RequesterCredentials>
+              <eBayAuthToken>#{auth_token}</eBayAuthToken>
+            </RequesterCredentials>
+          </GetUserRequest>
+    END
+
+    response = api(X_EBAY_API_GETUSER_CALL_NAME, request)
+    MultiXml.parse(response.content)["GetUserResponse"]['User']
+  end
+
+  protected
+
+  def api(call_name, request)
+    headers = ebay_request_headers(call_name, request.length.to_s)
+    http = HTTPClient.new
+    http.post(options.apiurl, request, headers)
+  end
+
+  def ebay_request_headers(call_name, request_length)
+    {
+        'X-EBAY-API-CALL-NAME'  => call_name,
+        'X-EBAY-API-COMPATIBILITY-LEVEL'  => X_EBAY_API_COMPATIBILITY_LEVEL,
+        'X-EBAY-API-DEV-NAME' => options.devid,
+        'X-EBAY-API-APP-NAME' => options.appid,
+        'X-EBAY-API-CERT-NAME' => options.certid,
+        'X-EBAY-API-SITEID' => options.siteid,
+        'Content-Type' => X_EBAY_API_REQUEST_CONTENT_TYPE,
+        'Content-Length' => request_length
+    }
+  end
+
+end

data/lib/omniauth-ebay.rb

@@ -0,0 +1,3 @@
+require 'omniauth-ebay/version'
+require 'ebay_api'
+require 'omniauth/strategies/ebay'

data/lib/omniauth-ebay/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Ebay
+    VERSION = "0.0.2"
+  end
+end

data/lib/omniauth/strategies/ebay.rb

@@ -0,0 +1,71 @@
+require 'omniauth'
+
+module OmniAuth
+  module Strategies
+    class Ebay
+      include OmniAuth::Strategy
+      include EbayAPI
+
+      args [:runame, :devid, :appid, :certid, :siteid, :apiurl]
+      option :name, "ebay"
+      option :runame, nil
+      option :devid, nil
+      option :appid, nil
+      option :certid, nil
+      option :siteid, nil
+      option :apiurl, nil
+
+      uid { raw_info['EIASToken'] }
+      info do
+        {
+            :ebay_id => raw_info['UserID'],
+            :ebay_token => @auth_token,
+            :email => raw_info['Email']
+        }
+      end
+
+      extra do
+        {
+            :return_to => request.params["return_to"]
+        }
+      end
+
+      #1: We'll get to the request_phase by accessing /auth/ebay
+      #2: Request from eBay a SessionID
+      #3: Redirect to eBay Login URL with the RUName and SessionID
+      def request_phase
+        session_id = generate_session_id
+        redirect ebay_login_url(session_id)
+      end
+
+      #4: We'll get to the callback phase by setting our accept/reject URL in the ebay application settings(/auth/ebay/callback)
+      #5: Request an eBay Auth Token with the returned username&secret_id parameters.
+      #6: Request the user info from eBay
+      def callback_phase
+        @auth_token = get_auth_token(request.params["username"], request.params["sid"])
+        @user_info = get_user_info(@auth_token)
+        super
+      rescue Exception => ex
+        fail!("Failed to retrieve user info from ebay", ex)
+      end
+
+      def raw_info
+        @user_info
+      end
+
+      protected
+
+      def ebay_login_url(session_id)
+        #TODO: Refactor ruparams to receive all of the request query string
+        url = "#{EBAY_LOGIN_URL}?SingleSignOn&runame=#{options.runame}&sid=#{URI.escape(session_id).gsub('+', '%2B')}"
+        if request.params[:return_to]
+          url << "&ruparams=#{CGI::escape('return_to=' + request.params['return_to'])}"
+        end
+        return url
+      end
+
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'ebay', 'Ebay'

data/omniauth-ebay.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "omniauth-ebay/version"
+
+Gem::Specification.new do |s|
+  s.name        = "omniauth-ebay"
+  s.version     = OmniAuth::Ebay::VERSION
+  s.authors     = ["Itay Adler"]
+  s.email       = ["itayadler@gmail.com"]
+  s.homepage    = "https://github.com/TheGiftsProject/omniauth-ebay"
+  s.summary     = %q{OmniAuth strategy for eBay}
+  s.description = %q{In this gem you will find an OmniAuth eBay strategy that is compliant with the Open eBay Apps API.
+You can read all about it here: [Open eBay Apps Developers Zone](http://developer.ebay.com/DevZone/open-ebay-apps/Concepts/OpeneBayUGDev.html)}
+
+  s.rubyforge_project = "omniauth-ebay"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'omniauth', '~> 1.0'
+  s.add_development_dependency 'rspec', '~> 2.7'
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: omniauth-ebay
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Itay Adler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-29 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: omniauth
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 2
+        - 7
+        version: "2.7"
+  type: :development
+  version_requirements: *id002
+description: |-
+  In this gem you will find an OmniAuth eBay strategy that is compliant with the Open eBay Apps API.
+  You can read all about it here: [Open eBay Apps Developers Zone](http://developer.ebay.com/DevZone/open-ebay-apps/Concepts/OpeneBayUGDev.html)
+email: 
+- itayadler@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/ebay_api.rb
+- lib/omniauth-ebay.rb
+- lib/omniauth-ebay/version.rb
+- lib/omniauth/strategies/ebay.rb
+- omniauth-ebay.gemspec
+homepage: https://github.com/TheGiftsProject/omniauth-ebay
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: omniauth-ebay
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: OmniAuth strategy for eBay
+test_files: []
+