ebayr 0.0.2 → 0.0.4

data/README.md

@@ -24,7 +24,7 @@ http://developer.ebay.com if you haven't already done so.
 
 Next, you'll need to require Ebayr, and tell it to use your keys. You will also
 need to generate an RUName, and get the key for that. (This is all standard
-stuff - look at the eBay developer docs for details).
+stuff - look at the [eBay developer docs][1] for details).
 
 ```ruby
 require 'ebayr'
@@ -76,11 +76,37 @@ config/initializers/ebayr.rb (or something), and put the configuration there. Of
 course, you should probably not check in these files, if you're using a public
 repository.
 
+## Testing
+
+When running test, you generally won't want to use up your API call-limit too
+quickly, so it makes sense to stub out calls to the eBay API.
+
+Ebayr has a small test helper library to help with this. It uses [Fakeweb][2]
+for this, and just requires that you wrap your test code in a block, like this:
+
+```ruby
+require 'ebayr/test_helper'
+class MyTest < Test::Unit::TestCase
+  include Ebayr::TestHelper
+
+  # A very contrived example...
+  def test_fetching_user_id
+    stub_ebay_call!(:GetUser, :UserID => "joebloggs") do
+      assert_equal("joebloggs", Ebayr.call(:GetUser)['UserID'])
+    end
+  end
+end
+```
+
+You need to remember to include Fakeweb in your Gemfile, or Ebayr will complain.
+
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-
 5. Create new Pull Request
+
+[1]: http://developer.ebay.com
+[2]: http://fakeweb.rubyforge.org

data/lib/ebayr.rb

@@ -36,20 +36,33 @@ module Ebayr
     !!sandbox
   end
 
-  def self.uri_prefix
-    "https://api#{sandbox ? ".sandbox" : ""}.ebay.com/ws"
+  # Gets either ebay.com/ws or sandbox.ebay.com/ws, as appropriate, with
+  # "service" prepended. E.g.
+  #
+  #     Ebayr.uri_prefix("blah")  # => https://blah.ebay.com/ws
+  #     Ebayr.uri_prefix          # => https://api.ebay.com/ws
+  def self.uri_prefix(service = "api")
+    "https://#{service}#{sandbox ? ".sandbox" : ""}.ebay.com/ws"
   end
 
-  # Gets the URI used for calls
-  def self.uri
-    URI::parse("#{uri_prefix}/api.dll")
+  # Gets the URI used for API calls (as a URI object)
+  def self.uri(*args)
+    URI::parse("#{uri_prefix(*args)}/api.dll")
   end
 
+  # Gets the URI for eBay authorization/login. The session_id should be obtained
+  # via an API call to GetSessionID (be sure to use the right ru_name), and the
+  # ru_params can contain anything (they will be passed back to your app in the
+  # redirect from eBay upon successful login and authorization).
   def self.authorization_uri(session_id, ru_params = {})
     ruparams = CGI::escape(ru_params.map { |k, v| "#{k}=#{v}" }.join("&"))
-    URI::parse("#{uri_prefix}/eBayISAPI.dll?SignIn&RuName=%s&SessId=#{session_id}&ruparams=#{ruparams}")
+    URI::parse("#{uri_prefix("signin")}/eBayISAPI.dll?SignIn&RuName=#{ru_name}&SessId=#{session_id}&ruparams=#{ruparams}")
   end
 
+  # A very, very simple XML serializer.
+  #
+  #     Ebayr.xml("Hello!")       # => "Hello!"
+  #     Ebayr.xml({:foo=>"Bar"})  # => <foo>Bar</foo>
   def self.xml(structure)
     case structure
       when Hash then structure.map { |k, v| "<#{k.to_s}>#{xml(v)}</#{k.to_s}>" }.join

data/lib/ebayr/version.rb

@@ -1,3 +1,3 @@
 module Ebayr
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/test/test_ebayr.rb

@@ -21,7 +21,9 @@ class TestEbayr < Test::Unit::TestCase
     assert Ebayr.sandbox?
   end
 
-  def test_ebayr_uri
+  def test_ebayr_uris
+    assert_equal "https://api.sandbox.ebay.com/ws", Ebayr.uri_prefix
+    assert_equal "https://blah.sandbox.ebay.com/ws", Ebayr.uri_prefix("blah")
     assert_equal "https://api.sandbox.ebay.com/ws/api.dll", Ebayr.uri.to_s
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ebayr
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-29 00:00:00.000000000Z
+date: 2012-04-18 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &81104660 !ruby/object:Gem::Requirement
+  requirement: &81893100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *81104660
+  version_requirements: *81893100
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &81104440 !ruby/object:Gem::Requirement
+  requirement: &81892860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *81104440
+  version_requirements: *81892860
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &81104210 !ruby/object:Gem::Requirement
+  requirement: &81892620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *81104210
+  version_requirements: *81892620
 description: A tidy library for using the eBay Trading API with Ruby
 email:
 - jj@bjjb.org
@@ -75,7 +75,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 758613683
+      hash: -317667633
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -84,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 758613683
+      hash: -317667633
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10