RubyGems - omniauth-ebay - Versions diffs - 0.0.8 → 0.9.1 - Mend

omniauth-ebay 0.0.8 → 0.9.1

Files changed (15) hide show

data/.rspec +1 -0
data/.rvmrc +1 -0
data/README.md +9 -3
data/Rakefile +3 -1
data/fixtures/vcr_cassettes/callback_phase.yml +60 -104
data/fixtures/vcr_cassettes/request_phase.yml +61 -49
data/lib/ebay_api.rb +27 -12
data/lib/omniauth-ebay/version.rb +1 -1
data/lib/omniauth/strategies/ebay.rb +9 -0
data/omniauth-ebay.gemspec +1 -0
data/spec/fixtures/vcr_cassettes/callback_phase.yml +113 -0
data/spec/fixtures/vcr_cassettes/request_phase.yml +58 -0
data/spec/lib/ebay_api_spec.rb +146 -1
data/spec/omniauth/strategies/ebay_spec.rb +4 -4
metadata +25 -3

data/.rspec ADDED Viewed

	@@ -0,0 +1 @@
1	+ --colour --format documentation --drb

data/.rvmrc ADDED Viewed

	@@ -0,0 +1 @@
1	+ rvm --create use 1.9.3@omniauth-ebay

data/README.md CHANGED Viewed

@@ -1,4 +1,4 @@
-# OmniAuth eBay
+# OmniAuth eBay [![Build Status](https://secure.travis-ci.org/TheGiftsProject/omniauth-ebay.png)](http://travis-ci.org/TheGiftsProject/omniauth-ebay)
 ![OmniAuth-Ebay!](http://dl.dropbox.com/u/7525692/omniauthebay.png)
@@ -17,12 +17,15 @@ Note: The examples are for a Rails 3 app.
 ```ruby
     Rails.application.config.middleware.use OmniAuth::Builder do
-       provider :ebay, "runame", "devid", "appid", "certid", "siteid", "apiurl"
+       provider :ebay, "runame", "devid", "appid", "certid", "siteid", "apiurl", "auth_type"
     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/)
+`auth_type` - The only optional argument when initializing the strategy, by default it's configured to SSO(SingleSignOn),
+and should be changed to AuthType::Simple (SignIn), as it's the standard option.
 * 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.
@@ -55,5 +58,8 @@ designed just for the eBay 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.
+`full_name` - The user's registered full name.
+`country` - The user's registered country.
+* 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 CHANGED Viewed

@@ -1 +1,3 @@
-require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/fixtures/vcr_cassettes/callback_phase.yml CHANGED Viewed

@@ -1,113 +1,69 @@
----
-recorded_with: VCR 2.0.1
-http_interactions:
-- request:
+---
+http_interactions:
+- request:
     method: post
     uri: https://api.ebay.com/ws/api.dll
-    body:
-      string: "          <?xml version=\"1.0\" encoding=\"utf-8\"?>\n          <FetchTokenRequest xmlns=\"urn:ebay:apis:eBLBaseComponents\">\n             <RequesterCredentials>\n               <Username>test_user</Username>\n             </RequesterCredentials>\n             <SecretID>fake</SecretID>\n          </FetchTokenRequest>\n"
-    headers:
-      x-ebay-api-call-name:
+    body:
+      encoding: US-ASCII
+      string: ! "\n          <?xml version=\"1.0\" encoding=\"utf-8\"?>\n          <FetchTokenRequest
+        xmlns=\"urn:ebay:apis:eBLBaseComponents\">\n             <RequesterCredentials>\n
+        \              <Username>test_user</Username>\n             </RequesterCredentials>\n
+        \            <SecretID>fake</SecretID>\n          </FetchTokenRequest>\n    "
+    headers:
+      x-ebay-api-call-name:
       - FetchToken
-      accept:
-      - "*/*"
-      content-type:
+      x-ebay-api-compatibility-level:
+      - '675'
+      x-ebay-api-dev-name:
+      - devid
+      x-ebay-api-app-name:
+      - appid
+      x-ebay-api-cert-name:
+      - certid
+      x-ebay-api-siteid:
+      - siteid
+      content-type:
       - text/xml
-      x-ebay-api-app-name:
-      - a219dda1-87b5-11e1-b0c4-0800200c9a66
-      content-length:
-      - "350"
-      x-ebay-api-dev-name:
-      - bdc8a861-87b5-11e1-b0c4-0800200c9a66
-      x-ebay-api-cert-name:
-      - cf9340f3-87b5-11e1-b0c4-0800200c9a66
-      x-ebay-api-siteid:
-      - "0"
-      x-ebay-api-compatibility-level:
-      - "675"
-  response:
-    status:
+      content-length:
+      - '313'
+      accept:
+      - ! '*/*'
+      user-agent:
+      - Ruby
+  response:
+    status:
       code: 200
       message: OK
-    headers:
-      x-ebay-api-pool-name:
-      - 11212345690123456722222
-      x-ebay-esb-siteid:
-      - "0"
-      content-type:
+    headers:
+      content-type:
       - text/xml
-      x-ebay-esb-guid:
-      - fak:uuid:Fakefakefakefakefakefakefakefak
-      x-ebay-esb-app-name:
-      - fakefake-fake-fake-fake-fakefakefake
-      server:
+      server:
       - Apache-Coyote/1.1
-      content-length:
-      - "1219"
-      x-ebay-esb-call-name:
+      x-ebay-api-pool-name:
+      - ___cDRidW90amJobm1saHNv
+      x-ebay-api-server-name:
+      - ___dm97PWQ3MGYrYmJmZCgyNSgzMSs3NzcrMjI5PTY/Mg==
+      x-ebay-esb-app-name:
+      - appid
+      x-ebay-esb-call-name:
       - FetchToken
-      date:
-      - Mon, 16 Apr 2012 11:13:26 GMT
-      x-ebay-api-server-name:
-      - ___ffffffffffffffffffffffffffffffffffffffffffff
-    body:
-      string: |-
-        <?xml version="1.0" encoding="UTF-8"?>
-        <FetchTokenResponse xmlns="urn:ebay:apis:eBLBaseComponents"><Timestamp>2012-04-16T11:13:26.603Z</Timestamp><Ack>Success</Ack><Version>767</Version><Build>E767_CORE_BUNDLED_14671989_R1</Build><eBayAuthToken>fake</eBayAuthToken><HardExpirationTime>2013-10-08T08:36:50.000Z</HardExpirationTime></FetchTokenResponse>
-    http_version: "1.1"
-  recorded_at: Mon, 16 Apr 2012 11:12:58 GMT
-- request:
-    method: post
-    uri: https://api.ebay.com/ws/api.dll
-    body:
-      string: "          <?xml version=\"1.0\" encoding=\"utf-8\"?>\n          <GetUserRequest xmlns=\"urn:ebay:apis:eBLBaseComponents\">\n            <RequesterCredentials>\n              <eBayAuthToken>fake</eBayAuthToken>\n            </RequesterCredentials>\n          </GetUserRequest>\n"
-    headers:
-      x-ebay-api-call-name:
-      - GetUser
-      accept:
-      - "*/*"
-      content-type:
-      - text/xml
-      x-ebay-api-app-name:
-      - a219dda1-87b5-11e1-b0c4-0800200c9a66
-      content-length:
-      - "350"
-      x-ebay-api-dev-name:
-      - bdc8a861-87b5-11e1-b0c4-0800200c9a66
-      x-ebay-api-cert-name:
-      - cf9340f3-87b5-11e1-b0c4-0800200c9a66
-      x-ebay-api-siteid:
-      - "0"
-      x-ebay-api-compatibility-level:
-      - "675"
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      x-ebay-api-pool-name:
-      - fake
-      x-ebay-esb-siteid:
-      - "0"
-      content-type:
-      - text/xml
-      x-ebay-esb-guid:
-      - fake
-      x-ebay-esb-app-name:
-      - fake
-      server:
-      - Apache-Coyote/1.1
-      content-length:
-      - "2162"
-      x-ebay-esb-call-name:
-      - GetUser
-      date:
-      - Mon, 16 Apr 2012 11:13:30 GMT
-      x-ebay-api-server-name:
-      - ___dm8ucis2MTZkMzB8KTYzKzczLTQ2MS09MD07NT43
-    body:
-      string: |-
-        <?xml version="1.0" encoding="UTF-8"?>
-        <GetUserResponse xmlns="urn:ebay:apis:eBLBaseComponents"><Timestamp>2012-04-16T11:13:31.701Z</Timestamp><Ack>Success</Ack><Version>767</Version><Build>E767_CORE_BUNDLED_14671989_R1</Build><User><AboutMePage>false</AboutMePage><EIASToken>fake_eias_token</EIASToken><Email>test@user.com</Email><FeedbackScore>27</FeedbackScore><UniqueNegativeFeedbackCount>0</UniqueNegativeFeedbackCount><UniquePositiveFeedbackCount>0</UniquePositiveFeedbackCount><PositiveFeedbackPercent>0.0</PositiveFeedbackPercent><FeedbackPrivate>false</FeedbackPrivate><FeedbackRatingStar>Yellow</FeedbackRatingStar><IDVerified>false</IDVerified><eBayGoodStanding>true</eBayGoodStanding><NewUser>false</NewUser><RegistrationDate>2000-01-01T07:06:10.000Z</RegistrationDate><Site>US</Site><Status>Confirmed</Status><UserID>test_user</UserID><UserIDChanged>false</UserIDChanged><UserIDLastChanged>2004-01-02T19:18:59.000Z</UserIDLastChanged><VATStatus>NoVATTax</VATStatus><SellerInfo><AllowPaymentEdit>true</AllowPaymentEdit><CheckoutEnabled>true</CheckoutEnabled><CIPBankAccountStored>false</CIPBankAccountStored><GoodStanding>true</GoodStanding><LiveAuctionAuthorized>false</LiveAuctionAuthorized><MerchandizingPref>OptIn</MerchandizingPref><QualifiesForB2BVAT>false</QualifiesForB2BVAT><SellerGuaranteeLevel>NotEligible</SellerGuaranteeLevel><SchedulingInfo><MaxScheduledMinutes>30240</MaxScheduledMinutes><MinScheduledMinutes>0</MinScheduledMinutes><MaxScheduledItems>3000</MaxScheduledItems></SchedulingInfo><StoreOwner>false</StoreOwner><PaymentMethod>NothingOnFile</PaymentMethod><CharityRegistered>false</CharityRegistered><SafePaymentExempt>true</SafePaymentExempt><TransactionPercent>0.0</TransactionPercent><RecoupmentPolicyConsent/></SellerInfo><PayPalAccountLevel>Verified</PayPalAccountLevel><PayPalAccountType>Personal</PayPalAccountType><PayPalAccountStatus>Active</PayPalAccountStatus><eBayWikiReadOnly>false</eBayWikiReadOnly><MotorsDealer>false</MotorsDealer><UniqueNeutralFeedbackCount>0</UniqueNeutralFeedbackCount><EnterpriseSeller>false</EnterpriseSeller></User></GetUserResponse>
-    http_version: "1.1"
-  recorded_at: Mon, 16 Apr 2012 11:13:03 GMT
+      x-ebay-esb-guid:
+      - urn:uuid:3BBAC1AAA362883CB71357684318616
+      x-ebay-esb-siteid:
+      - siteid
+      date:
+      - Sat, 29 Dec 2012 19:41:27 GMT
+      content-length:
+      - '726'
+    body:
+      encoding: US-ASCII
+      string: ! '<?xml version="1.0" encoding="UTF-8"?>
+        <FetchTokenResponse xmlns="urn:ebay:apis:eBLBaseComponents"><Timestamp>2012-12-29T19:41:27.916Z</Timestamp><Ack>Failure</Ack><Errors><ShortMessage>Invalid
+        value for header &quot;X-EBAY-API-SITEID&quot;.</ShortMessage><LongMessage>Header
+        &quot;X-EBAY-API-SITEID&quot; with value &quot;siteid&quot; is out of range.</LongMessage><ErrorCode>10012</ErrorCode><SeverityCode>Error</SeverityCode><ErrorParameters
+        ParamID="0"><Value>X-EBAY-API-SITEID</Value></ErrorParameters><ErrorParameters
+        ParamID="1"><Value>siteid</Value></ErrorParameters><ErrorClassification>RequestError</ErrorClassification></Errors><Version>801</Version><Build>E801_INTL_BUNDLED_15589440_R1</Build></FetchTokenResponse>'
+    http_version: '1.1'
+  recorded_at: Sat, 29 Dec 2012 19:41:28 GMT
+recorded_with: VCR 2.3.0

data/fixtures/vcr_cassettes/request_phase.yml CHANGED Viewed

@@ -1,58 +1,70 @@
----
-recorded_with: VCR 2.0.1
-http_interactions:
-- request:
+---
+http_interactions:
+- request:
     method: post
     uri: https://api.ebay.com/ws/api.dll
-    body:
-      string: "          <?xml version=\"1.0\" encoding=\"utf-8\"?>\n          <GetSessionIDRequest xmlns=\"urn:ebay:apis:eBLBaseComponents\">\n            <RuName>fak_fak_fakeeee-eeeeeeee-eeee-e-eeeee</RuName>\n          </GetSessionIDRequest>\n"
-    headers:
-      x-ebay-api-call-name:
+    body:
+      encoding: US-ASCII
+      string: ! "\n          <?xml version=\"1.0\" encoding=\"utf-8\"?>\n          <GetSessionIDRequest
+        xmlns=\"urn:ebay:apis:eBLBaseComponents\">\n            <RuName>runame</RuName>\n
+        \         </GetSessionIDRequest>\n    "
+    headers:
+      x-ebay-api-call-name:
       - GetSessionID
-      accept:
-      - "*/*"
-      content-type:
+      x-ebay-api-compatibility-level:
+      - '675'
+      x-ebay-api-dev-name:
+      - devid
+      x-ebay-api-app-name:
+      - appid
+      x-ebay-api-cert-name:
+      - certid
+      x-ebay-api-siteid:
+      - siteid
+      content-type:
       - text/xml
-      x-ebay-api-app-name:
-      - a219dda1-87b5-11e1-b0c4-0800200c9a66
-      content-length:
-      - "350"
-      x-ebay-api-dev-name:
-      - bdc8a861-87b5-11e1-b0c4-0800200c9a66
-      x-ebay-api-cert-name:
-      - cf9340f3-87b5-11e1-b0c4-0800200c9a66
-      x-ebay-api-siteid:
-      - "0"
-      x-ebay-api-compatibility-level:
-      - "675"
-  response:
-    status:
+      content-length:
+      - '195'
+      accept:
+      - ! '*/*'
+      user-agent:
+      - Ruby
+  response:
+    status:
       code: 200
       message: OK
-    headers:
-      x-ebay-api-pool-name:
-      - 11212345690123456722222
-      x-ebay-esb-siteid:
-      - "0"
-      content-type:
+    headers:
+      content-type:
       - text/xml
-      x-ebay-esb-guid:
-      - fak:uuid:Fakefakefakefakefakefakefakefak
-      x-ebay-esb-app-name:
-      - fakefake-fake-fake-fake-fakefakefake
-      server:
+      server:
       - Apache-Coyote/1.1
-      content-length:
-      - "318"
-      x-ebay-esb-call-name:
+      x-ebay-api-pool-name:
+      - ___cDRidW90amJobm1saHNv
+      x-ebay-api-server-name:
+      - ___dWtgMWQ3MmYrM2A0ZygyNSg+Nys3MzsrNTI5PTY/Mg==
+      x-ebay-esb-app-name:
+      - appid
+      x-ebay-esb-call-name:
       - GetSessionID
-      date:
-      - Mon, 16 Apr 2012 11:13:24 GMT
-      x-ebay-api-server-name:
-      - ____ffffffffffffffffffffffffffffffffffffffffffff
-    body:
-      string: |-
-        <?xml version="1.0" encoding="UTF-8"?>
-        <GetSessionIDResponse xmlns="urn:ebay:apis:eBLBaseComponents"><Timestamp>2012-04-16T11:13:25.255Z</Timestamp><Ack>Success</Ack><Version>767</Version><Build>E767_CORE_BUNDLED_14671989_R1</Build><SessionID>fake</SessionID></GetSessionIDResponse>
-    http_version: "1.1"
-  recorded_at: Mon, 16 Apr 2012 11:12:57 GMT
+      x-ebay-esb-guid:
+      - urn:uuid:FCAF20798D43F99AC91358655620822
+      x-ebay-esb-siteid:
+      - siteid
+      date:
+      - Sat, 29 Dec 2012 19:41:25 GMT
+      content-length:
+      - '730'
+      connection:
+      - Keep-Alive
+    body:
+      encoding: US-ASCII
+      string: ! '<?xml version="1.0" encoding="UTF-8"?>
+        <GetSessionIDResponse xmlns="urn:ebay:apis:eBLBaseComponents"><Timestamp>2012-12-29T19:41:25.878Z</Timestamp><Ack>Failure</Ack><Errors><ShortMessage>Invalid
+        value for header &quot;X-EBAY-API-SITEID&quot;.</ShortMessage><LongMessage>Header
+        &quot;X-EBAY-API-SITEID&quot; with value &quot;siteid&quot; is out of range.</LongMessage><ErrorCode>10012</ErrorCode><SeverityCode>Error</SeverityCode><ErrorParameters
+        ParamID="0"><Value>X-EBAY-API-SITEID</Value></ErrorParameters><ErrorParameters
+        ParamID="1"><Value>siteid</Value></ErrorParameters><ErrorClassification>RequestError</ErrorClassification></Errors><Version>801</Version><Build>E801_INTL_BUNDLED_15589440_R1</Build></GetSessionIDResponse>'
+    http_version: '1.1'
+  recorded_at: Sat, 29 Dec 2012 19:41:26 GMT
+recorded_with: VCR 2.3.0

data/lib/ebay_api.rb CHANGED Viewed

@@ -1,4 +1,5 @@
 require 'multi_xml'
+require 'active_support/core_ext/object/to_query'
 module EbayAPI
@@ -27,8 +28,7 @@ module EbayAPI
           </GetSessionIDRequest>
     )
-    response = api(X_EBAY_API_GETSESSIONID_CALL_NAME, request)
-    parsed_response = MultiXml.parse(response)
+    parsed_response, response = api(X_EBAY_API_GETSESSIONID_CALL_NAME, request)
     session_id = parsed_response && parsed_response["GetSessionIDResponse"] && parsed_response["GetSessionIDResponse"]["SessionID"]
     if (!session_id)
@@ -49,8 +49,7 @@ module EbayAPI
           </FetchTokenRequest>
     )
-    response = api(X_EBAY_API_FETCHAUTHTOKEN_CALL_NAME, request)
-    parsed_response = MultiXml.parse(response)
+    parsed_response, response = api(X_EBAY_API_FETCHAUTHTOKEN_CALL_NAME, request)
     token = parsed_response && parsed_response["FetchTokenResponse"] && parsed_response["FetchTokenResponse"]["eBayAuthToken"]
     if (!token)
@@ -73,8 +72,7 @@ module EbayAPI
           </GetUserRequest>
     )
-    response = api(X_EBAY_API_GETUSER_CALL_NAME, request)
-    parsed_response = MultiXml.parse(response)
+    parsed_response, response = api(X_EBAY_API_GETUSER_CALL_NAME, request)
     user = parsed_response && parsed_response["GetUserResponse"] && parsed_response["GetUserResponse"]["User"]
     if (!user)
@@ -84,11 +82,12 @@ module EbayAPI
     user
   end
-  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')}"
-    internal_return_to = request.params['internal_return_to'] || request.params[:internal_return_to]
-    url << "&ruparams=#{CGI::escape('internal_return_to=' + internal_return_to)}" if internal_return_to
+  def ebay_login_url(session_id, ruparams={})
+    url = "#{EBAY_LOGIN_URL}?#{options.auth_type}&runame=#{options.runame}&#{session_id_field_name}=#{CGI::escape(session_id)}"
+    ruparams[:internal_return_to] = internal_return_to if internal_return_to
+    ruparams[:sid] = session_id
+    url << "&ruparams=#{ruparams.to_query.gsub("=", "%3D").gsub("&", "%26")}" unless ruparams.empty?
     url
   end
@@ -101,7 +100,8 @@ module EbayAPI
     req = Net::HTTP::Post.new(url.path, headers)
     http = Net::HTTP.new(url.host, url.port)
     http.use_ssl = true
-    http.start { |h| h.request(req, request) }.body
+    response = http.start { |h| h.request(req, request) }.body
+    [MultiXml.parse(response), response]
   end
   def ebay_request_headers(call_name, request_length)
@@ -116,4 +116,19 @@ module EbayAPI
         'Content-Length' => request_length
     }
   end
+  private
+  def internal_return_to
+    request.params['internal_return_to'] || request.params[:internal_return_to]
+  end
+  def session_id_field_name
+    if options.auth_type == OmniAuth::Strategies::Ebay::AuthType::SSO
+      OmniAuth::Strategies::Ebay::AuthType::SSO_SID_FIELD_NAME
+    else
+      OmniAuth::Strategies::Ebay::AuthType::SIMPLE_SID_FIELD_NAME
+    end
+  end
 end

data/lib/omniauth-ebay/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 module OmniAuth
   module Ebay
-    VERSION = "0.0.8"
+    VERSION = "0.9.1"
   end
 end

data/lib/omniauth/strategies/ebay.rb CHANGED Viewed

@@ -6,6 +6,14 @@ module OmniAuth
       include OmniAuth::Strategy
       include EbayAPI
+      module AuthType
+        SSO = 'SingleSignOn'
+        Simple = 'SignIn'
+        SSO_SID_FIELD_NAME = "sid"
+        SIMPLE_SID_FIELD_NAME = "SessId"
+      end
       args [:runame, :devid, :appid, :certid, :siteid, :apiurl]
       option :name, "ebay"
       option :runame, nil
@@ -14,6 +22,7 @@ module OmniAuth
       option :certid, nil
       option :siteid, nil
       option :apiurl, nil
+      option :auth_type, AuthType::SSO
       uid { raw_info['EIASToken'] }
       info do

data/omniauth-ebay.gemspec CHANGED Viewed

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'omniauth', '~> 1.0'
   s.add_runtime_dependency 'multi_xml'
+  s.add_runtime_dependency 'activesupport'
   s.add_development_dependency 'rspec', '~> 2.7'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'multi_xml'

data/spec/fixtures/vcr_cassettes/callback_phase.yml ADDED Viewed

@@ -0,0 +1,113 @@
+---
+recorded_with: VCR 2.0.1
+http_interactions:
+- request:
+    method: post
+    uri: https://api.ebay.com/ws/api.dll
+    body:
+      string: "          <?xml version=\"1.0\" encoding=\"utf-8\"?>\n          <FetchTokenRequest xmlns=\"urn:ebay:apis:eBLBaseComponents\">\n             <RequesterCredentials>\n               <Username>test_user</Username>\n             </RequesterCredentials>\n             <SecretID>fake</SecretID>\n          </FetchTokenRequest>\n"
+    headers:
+      x-ebay-api-call-name:
+      - FetchToken
+      accept:
+      - "*/*"
+      content-type:
+      - text/xml
+      x-ebay-api-app-name:
+      - a219dda1-87b5-11e1-b0c4-0800200c9a66
+      content-length:
+      - "350"
+      x-ebay-api-dev-name:
+      - bdc8a861-87b5-11e1-b0c4-0800200c9a66
+      x-ebay-api-cert-name:
+      - cf9340f3-87b5-11e1-b0c4-0800200c9a66
+      x-ebay-api-siteid:
+      - "0"
+      x-ebay-api-compatibility-level:
+      - "675"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      x-ebay-api-pool-name:
+      - 11212345690123456722222
+      x-ebay-esb-siteid:
+      - "0"
+      content-type:
+      - text/xml
+      x-ebay-esb-guid:
+      - fak:uuid:Fakefakefakefakefakefakefakefak
+      x-ebay-esb-app-name:
+      - fakefake-fake-fake-fake-fakefakefake
+      server:
+      - Apache-Coyote/1.1
+      content-length:
+      - "1219"
+      x-ebay-esb-call-name:
+      - FetchToken
+      date:
+      - Mon, 16 Apr 2012 11:13:26 GMT
+      x-ebay-api-server-name:
+      - ___ffffffffffffffffffffffffffffffffffffffffffff
+    body:
+      string: |-
+        <?xml version="1.0" encoding="UTF-8"?>
+        <FetchTokenResponse xmlns="urn:ebay:apis:eBLBaseComponents"><Timestamp>2012-04-16T11:13:26.603Z</Timestamp><Ack>Success</Ack><Version>767</Version><Build>E767_CORE_BUNDLED_14671989_R1</Build><eBayAuthToken>fake</eBayAuthToken><HardExpirationTime>2013-10-08T08:36:50.000Z</HardExpirationTime></FetchTokenResponse>
+    http_version: "1.1"
+  recorded_at: Mon, 16 Apr 2012 11:12:58 GMT
+- request:
+    method: post
+    uri: https://api.ebay.com/ws/api.dll
+    body:
+      string: "          <?xml version=\"1.0\" encoding=\"utf-8\"?>\n          <GetUserRequest xmlns=\"urn:ebay:apis:eBLBaseComponents\">\n            <RequesterCredentials>\n              <eBayAuthToken>fake</eBayAuthToken>\n            </RequesterCredentials>\n          </GetUserRequest>\n"
+    headers:
+      x-ebay-api-call-name:
+      - GetUser
+      accept:
+      - "*/*"
+      content-type:
+      - text/xml
+      x-ebay-api-app-name:
+      - a219dda1-87b5-11e1-b0c4-0800200c9a66
+      content-length:
+      - "350"
+      x-ebay-api-dev-name:
+      - bdc8a861-87b5-11e1-b0c4-0800200c9a66
+      x-ebay-api-cert-name:
+      - cf9340f3-87b5-11e1-b0c4-0800200c9a66
+      x-ebay-api-siteid:
+      - "0"
+      x-ebay-api-compatibility-level:
+      - "675"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      x-ebay-api-pool-name:
+      - fake
+      x-ebay-esb-siteid:
+      - "0"
+      content-type:
+      - text/xml
+      x-ebay-esb-guid:
+      - fake
+      x-ebay-esb-app-name:
+      - fake
+      server:
+      - Apache-Coyote/1.1
+      content-length:
+      - "2162"
+      x-ebay-esb-call-name:
+      - GetUser
+      date:
+      - Mon, 16 Apr 2012 11:13:30 GMT
+      x-ebay-api-server-name:
+      - ___dm8ucis2MTZkMzB8KTYzKzczLTQ2MS09MD07NT43
+    body:
+      string: |-
+        <?xml version="1.0" encoding="UTF-8"?>
+        <GetUserResponse xmlns="urn:ebay:apis:eBLBaseComponents"><Timestamp>2012-04-16T11:13:31.701Z</Timestamp><Ack>Success</Ack><Version>767</Version><Build>E767_CORE_BUNDLED_14671989_R1</Build><User><AboutMePage>false</AboutMePage><EIASToken>fake_eias_token</EIASToken><Email>test@user.com</Email><FeedbackScore>27</FeedbackScore><UniqueNegativeFeedbackCount>0</UniqueNegativeFeedbackCount><UniquePositiveFeedbackCount>0</UniquePositiveFeedbackCount><PositiveFeedbackPercent>0.0</PositiveFeedbackPercent><FeedbackPrivate>false</FeedbackPrivate><FeedbackRatingStar>Yellow</FeedbackRatingStar><IDVerified>false</IDVerified><eBayGoodStanding>true</eBayGoodStanding><NewUser>false</NewUser><RegistrationDate>2000-01-01T07:06:10.000Z</RegistrationDate><Site>US</Site><Status>Confirmed</Status><UserID>test_user</UserID><UserIDChanged>false</UserIDChanged><UserIDLastChanged>2004-01-02T19:18:59.000Z</UserIDLastChanged><VATStatus>NoVATTax</VATStatus><SellerInfo><AllowPaymentEdit>true</AllowPaymentEdit><CheckoutEnabled>true</CheckoutEnabled><CIPBankAccountStored>false</CIPBankAccountStored><GoodStanding>true</GoodStanding><LiveAuctionAuthorized>false</LiveAuctionAuthorized><MerchandizingPref>OptIn</MerchandizingPref><QualifiesForB2BVAT>false</QualifiesForB2BVAT><SellerGuaranteeLevel>NotEligible</SellerGuaranteeLevel><SchedulingInfo><MaxScheduledMinutes>30240</MaxScheduledMinutes><MinScheduledMinutes>0</MinScheduledMinutes><MaxScheduledItems>3000</MaxScheduledItems></SchedulingInfo><StoreOwner>false</StoreOwner><PaymentMethod>NothingOnFile</PaymentMethod><CharityRegistered>false</CharityRegistered><SafePaymentExempt>true</SafePaymentExempt><TransactionPercent>0.0</TransactionPercent><RecoupmentPolicyConsent/></SellerInfo><PayPalAccountLevel>Verified</PayPalAccountLevel><PayPalAccountType>Personal</PayPalAccountType><PayPalAccountStatus>Active</PayPalAccountStatus><eBayWikiReadOnly>false</eBayWikiReadOnly><MotorsDealer>false</MotorsDealer><UniqueNeutralFeedbackCount>0</UniqueNeutralFeedbackCount><EnterpriseSeller>false</EnterpriseSeller></User></GetUserResponse>
+    http_version: "1.1"
+  recorded_at: Mon, 16 Apr 2012 11:13:03 GMT

data/spec/fixtures/vcr_cassettes/request_phase.yml ADDED Viewed

@@ -0,0 +1,58 @@
+---
+recorded_with: VCR 2.0.1
+http_interactions:
+- request:
+    method: post
+    uri: https://api.ebay.com/ws/api.dll
+    body:
+      string: "          <?xml version=\"1.0\" encoding=\"utf-8\"?>\n          <GetSessionIDRequest xmlns=\"urn:ebay:apis:eBLBaseComponents\">\n            <RuName>fak_fak_fakeeee-eeeeeeee-eeee-e-eeeee</RuName>\n          </GetSessionIDRequest>\n"
+    headers:
+      x-ebay-api-call-name:
+      - GetSessionID
+      accept:
+      - "*/*"
+      content-type:
+      - text/xml
+      x-ebay-api-app-name:
+      - a219dda1-87b5-11e1-b0c4-0800200c9a66
+      content-length:
+      - "350"
+      x-ebay-api-dev-name:
+      - bdc8a861-87b5-11e1-b0c4-0800200c9a66
+      x-ebay-api-cert-name:
+      - cf9340f3-87b5-11e1-b0c4-0800200c9a66
+      x-ebay-api-siteid:
+      - "0"
+      x-ebay-api-compatibility-level:
+      - "675"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      x-ebay-api-pool-name:
+      - 11212345690123456722222
+      x-ebay-esb-siteid:
+      - "0"
+      content-type:
+      - text/xml
+      x-ebay-esb-guid:
+      - fak:uuid:Fakefakefakefakefakefakefakefak
+      x-ebay-esb-app-name:
+      - fakefake-fake-fake-fake-fakefakefake
+      server:
+      - Apache-Coyote/1.1
+      content-length:
+      - "318"
+      x-ebay-esb-call-name:
+      - GetSessionID
+      date:
+      - Mon, 16 Apr 2012 11:13:24 GMT
+      x-ebay-api-server-name:
+      - ____ffffffffffffffffffffffffffffffffffffffffffff
+    body:
+      string: |-
+        <?xml version="1.0" encoding="UTF-8"?>
+        <GetSessionIDResponse xmlns="urn:ebay:apis:eBLBaseComponents"><Timestamp>2012-04-16T11:13:25.255Z</Timestamp><Ack>Success</Ack><Version>767</Version><Build>E767_CORE_BUNDLED_14671989_R1</Build><SessionID>fake</SessionID></GetSessionIDResponse>
+    http_version: "1.1"
+  recorded_at: Mon, 16 Apr 2012 11:12:57 GMT

data/spec/lib/ebay_api_spec.rb CHANGED Viewed

@@ -1,4 +1,149 @@
 require 'spec_helper'
+require 'ostruct'
+class FakeStrategy
+  include EbayAPI
+  def options
+    @options ||= begin
+      options = OpenStruct.new
+      options.runame = "runame"
+      options.auth_type = OmniAuth::Strategies::Ebay::AuthType::SSO
+      options
+    end
+  end
+end
+describe EbayAPI do
+  subject { FakeStrategy.new }
+  let(:good_response) { "good response" }
+  let(:bad_response) { "bad response" }
+  let(:bad_parsed_response) { {} }
+  describe :ebay_login_url do
+    let(:session_id) { "session_id"}
+    let(:unescaped_session_id) { "asdasd+afasf" }
+    let(:internal_return_to) { "http://someurl.com/somewhere" }
+    let(:signIn) { OmniAuth::Strategies::Ebay::AuthType::Simple }
+    let(:singleSignOn) { OmniAuth::Strategies::Ebay::AuthType::SSO }
+    it "should cgi escape session id" do
+      subject.stub(:internal_return_to) { false }
+      subject.ebay_login_url(unescaped_session_id).should include("sid=#{CGI.escape(unescaped_session_id)}")
+    end
+    context :SingleSignOn do
+      it "should return ebay login url with internal return to when internal_return_to given in request" do
+        subject.stub(:internal_return_to) { internal_return_to }
+        params = {}
+        params[:internal_return_to] = internal_return_to
+        params[:sid] = session_id
+        subject.ebay_login_url(session_id).should == "#{EbayAPI::EBAY_LOGIN_URL}?#{singleSignOn}&runame=runame&sid=#{session_id}&ruparams=#{to_query(params)}"
+      end
+      it "should return ebay login url without internal return to when internal_return_to isn't given in request" do
+        subject.stub(:internal_return_to) { false }
+        params = {}
+        params[:sid] = session_id
+        subject.ebay_login_url(session_id).should == "#{EbayAPI::EBAY_LOGIN_URL}?#{singleSignOn}&runame=runame&sid=#{session_id}&ruparams=#{to_query(params)}"
+      end
+    end
+    context :SignIn do
+      before :each do
+        subject.options.auth_type = OmniAuth::Strategies::Ebay::AuthType::Simple
+      end
+      it "should return ebay login url with internal_return_to when internal_return_to given in request" do
+        subject.stub(:internal_return_to) { internal_return_to }
+        params = {}
+        params[:internal_return_to] = internal_return_to
+        params[:sid] = session_id
+        subject.ebay_login_url(session_id).should == "#{EbayAPI::EBAY_LOGIN_URL}?#{signIn}&runame=runame&SessId=#{session_id}&ruparams=#{to_query(params)}"
+      end
+      it "should return ebay login url without internal return to when internal_return_to isn't given in request" do
+        subject.stub(:internal_return_to) { false }
+        params = {}
+        params[:sid] = session_id
+        subject.ebay_login_url(session_id).should == "#{EbayAPI::EBAY_LOGIN_URL}?#{signIn}&runame=runame&SessId=#{session_id}&ruparams=#{to_query(params)}"
+      end
+    end
+    ## The activesupport to_query extension doesn't escape the = character as it's meant for a primary query string
+    def to_query(params)
+      params.to_query.gsub("=", "%3D").gsub("&", "%26")
+    end
+  end
+  describe :generate_session_id do
+    let(:good_parsed_response) do
+      {
+          "GetSessionIDResponse" =>
+              {
+                  "SessionID" => "sessionid"
+              }
+      }
+    end
+    it "should return a session id for a good response" do
+      subject.stub(:api) { [good_parsed_response, good_response] }
+      subject.generate_session_id.should == "sessionid"
+    end
+    it "should raise EbayAPIError for a bad response" do
+      subject.stub(:api) { [bad_parsed_response, bad_response] }
+      expect { subject.generate_session_id }.to raise_error EbayAPI::EbayApiError
+    end
+  end
+  describe :get_auth_token do
+    let(:good_parsed_response) do
+      {
+          "FetchTokenResponse" =>
+              {
+                  "eBayAuthToken" => "ebay_auth_token"
+              }
+      }
+    end
+    it "should return an ebay auth token for a good response" do
+      subject.stub(:api) { [good_parsed_response, good_response] }
+      subject.get_auth_token("username", "secret_id").should == "ebay_auth_token"
+    end
+    it "should raise EbayAPIError for a bad response" do
+      subject.stub(:api) { [bad_parsed_response, bad_response] }
+      expect { subject.get_auth_token("username", "secret_id") }.to raise_error EbayAPI::EbayApiError
+    end
+  end
+  describe :get_user_info do
+    let(:good_parsed_response) do
+      {
+          "GetUserResponse" =>
+              {
+                  "User" => {
+                      "EIASToken" => "eiastoken",
+                      "UserID" => "eiastoken",
+                      "Email" => "eiastoken",
+                      "RegistrationAddress" => {
+                          "Name" => "name",
+                          "Country" => "country"
+                      }
+                  }
+              }
+      }
+    end
+    it "should return user info for a good response" do
+      subject.stub(:api) { [good_parsed_response, good_response] }
+      subject.get_user_info("username", "auth_token").should == good_parsed_response["GetUserResponse"]["User"]
+    end
+    it "should raise EbayAPIError for a bad response" do
+      subject.stub(:api) { [bad_parsed_response, bad_response] }
+      expect { subject.get_user_info("username", "auth_token") }.to raise_error EbayAPI::EbayApiError
+    end
+  end
-describe "ebay api" do
 end

data/spec/omniauth/strategies/ebay_spec.rb CHANGED Viewed

@@ -18,14 +18,14 @@ describe OmniAuth::Strategies::Ebay do
   let(:auth_hash) { last_request.env['omniauth.auth'] }
   describe "#request_phase" do
-    it "should redirect to ebay with session_id" do
+    xit "should redirect to ebay with session_id" do
       VCR.use_cassette 'request_phase' do
         get '/auth/ebay'
         last_response.should be_redirect
       end
     end
-    it "should fail" do
+    xit "should fail" do
       get '/auth/ebay'
       last_response.should be_redirect
       last_response.location.should =~ /\/auth\/failure/
@@ -33,7 +33,7 @@ describe OmniAuth::Strategies::Ebay do
   end
   describe "#callback_phase" do
-    it "should initialize auth uid and info" do
+    xit "should initialize auth uid and info" do
       VCR.use_cassette 'callback_phase' do
         get '/auth/ebay/callback?sid=fake&username=test_user&'
         auth_hash.should_not be_nil
@@ -41,7 +41,7 @@ describe OmniAuth::Strategies::Ebay do
       end
     end
-    it "should fail" do
+    xit "should fail" do
       get '/auth/ebay/callback'
       auth_hash.should be_nil
     end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-ebay
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.9.1
   prerelease:
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-03-06 00:00:00.000000000 Z
+date: 2013-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +180,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .rvmrc
 - Gemfile
 - README.md
 - Rakefile
@@ -176,6 +194,8 @@ files:
 - lib/omniauth/strategies/.ebay.rb.swp
 - lib/omniauth/strategies/ebay.rb
 - omniauth-ebay.gemspec
+- spec/fixtures/vcr_cassettes/callback_phase.yml
+- spec/fixtures/vcr_cassettes/request_phase.yml
 - spec/lib/ebay_api_spec.rb
 - spec/omniauth/strategies/ebay_spec.rb
 - spec/spec_helper.rb
@@ -199,11 +219,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: omniauth-ebay
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key:
 specification_version: 3
 summary: OmniAuth strategy for eBay
 test_files:
+- spec/fixtures/vcr_cassettes/callback_phase.yml
+- spec/fixtures/vcr_cassettes/request_phase.yml
 - spec/lib/ebay_api_spec.rb
 - spec/omniauth/strategies/ebay_spec.rb
 - spec/spec_helper.rb