ebayr 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.sw?

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ebayr.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 JJ Buckley
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# Ebayr
+
+Ebayr is a small gem which makes it a little easier to use the eBay Trading API
+with Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ebayr'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ebayr
+
+## Usage
+
+To use the eBay Trading API, you'll need a developer keyset. Sign up at
+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).
+
+```ruby
+require 'ebayr'
+
+Ebay.dev_id = "my-dev-id"
+
+# This is only needed if you want to retrieve user tokens
+Ebay.authorization_callback_url = "https://my-site/callback-url"
+
+Ebay.auth_token = "myverylongebayauthtoken"
+
+Ebay.app_id = "my-ebay-app-id"
+
+Ebay.cert_id = "my-ebay-cert-id"
+
+Ebay.ru_name = "my-ebay-ru-name"
+
+# Set this to true for testing in the eBay Sandbox (but remember to use the
+# appropriate keys!). It's true by default.
+Ebay.sandbox = false
+```
+
+Now you're ready to make calls
+
+```ruby
+Ebayr.call(:GeteBayOfficialTime)
+```
+
+To use an authorized user's key, pass in an `auth_token` parameter
+```ruby
+Ebayr.call(:GetOrders, :auth_token => "another-ebay-auth-token")
+```
+
+### Configuration
+
+Ebayr will look for the following Ruby files, and load them *once* in order (if
+they exist) when the module is evaluated:
+
+1. /etc/ebayrc.conf
+2. /usr/local/etc/ebayrc.conf
+3. ~/.ebayrc.conf
+4. ./.ebayrc.conf
+
+You can put configuration code in there (such as the variable setting shown
+above). The files should be plain old Ruby.
+
+In a Ruby on Rails project, just create a file called
+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.
+
+## 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

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/test*.rb"]
+end
+
+task :default => :test

data/ebayr.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ebayr/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["JJ Buckley"]
+  gem.email         = ["jj@bjjb.org"]
+  gem.description   = %q{A tidy library for using the eBay Trading API with Ruby}
+  gem.summary       = %q{eBayR is a gem that makes it (relatively) easy to use the eBay Trading API from Ruby. Includes a self-contained XML parser, a flexible callback system, and easy integration into Rails.}
+  gem.homepage      = "http://jjbuckley.github.com/ebayr"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "ebayr"
+  gem.require_paths = ["lib"]
+  gem.version       = Ebayr::VERSION
+  gem.add_dependency 'activesupport'
+  gem.add_development_dependency 'rake'
+end

data/lib/ebayr/version.rb

@@ -0,0 +1,3 @@
+module Ebayr
+  VERSION = "0.0.1"
+end

data/lib/ebayr.rb

@@ -0,0 +1,167 @@
+# -*- encoding : utf-8 -*-
+require "ebayr/version"
+require 'net/https'
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/hash/conversions'
+require 'active_support/buffered_logger'
+
+module Ebayr
+  mattr_accessor :dev_id,
+                 :app_id,
+                 :cert_id,
+                 :ru_name,
+                 :auth_token,
+                 :sandbox,
+                 :authorization_callback_url,
+                 :callbacks,
+                 :site_id,
+                 :compatability_level,
+                 :logger
+
+  @@logger ||= if defined?(Rails) 
+    Rails.logger
+  else
+    ActiveSupport::BufferedLogger.new(STDOUT) 
+  end
+
+  %W(/etc/ebayrc.conf /usr/local/etc/ebayrc.conf ~/.ebayrc.conf ./.ebayrc.conf).each do |path|
+    load path if File.exists?(path = File.expand_path(path))
+  end
+
+
+  @@site_id             ||= 0   # US
+  @@compatability_level ||= 745
+
+  def self.sandbox?
+    !!sandbox
+  end
+
+  # Gets the URI used for calls
+  def self.uri
+    URI::parse("https://api#{sandbox ? ".sandbox" : ""}.ebay.com/ws/api.dll")
+  end
+
+  def self.xml(structure)
+    case structure
+      when Hash then structure.map { |k, v| "<#{k.to_s}>#{xml(v)}</#{k.to_s}>" }.join
+      when Array then structure.map { |v| xml(v) }
+      else structure.to_s
+    end
+  end
+
+  # Make an eBay call (symbol or string). You can pass in these arguments:
+  #
+  # auth_token:: to use a user's token instead of the general token
+  # site_id:: to use a specific eBay site (default is 0, which is US ebay.com)
+  # compatability_level:: declare another eBay Trading API compatability_level
+  #
+  # All other arguments are passed into the API call, and may be nested.
+  #
+  # Remember, case matters.
+  #
+  #     call(:GeteBayOfficialTime)
+  #
+  # The response is a Hash of the response, deserialized from the XML by
+  # ActiveSupport's XML deserializer.
+  def self.call(call, arguments = {})
+    call = call.to_s
+
+    auth_token = arguments.delete(:auth_token) || self.auth_token.to_s
+    site_id = arguments.delete(:site_id) || self.site_id.to_s
+    compatability_level = arguments.delete(:compatability_level) || self.compatability_level.to_s
+
+    headers = {
+      'X-EBAY-API-COMPATIBILITY-LEVEL' => compatability_level.to_s,
+      'X-EBAY-API-DEV-NAME' => dev_id.to_s,
+      'X-EBAY-API-APP-NAME' => app_id.to_s,
+      'X-EBAY-API-CERT-NAME' => cert_id.to_s,
+      'X-EBAY-API-CALL-NAME' => call.to_s,
+      'X-EBAY-API-SITEID' => site_id.to_s,
+      'Content-Type' => 'text/xml'
+    }
+
+    xml = xml(arguments)
+
+    xml = <<-XML
+      <?xml version="1.0" encoding="utf-8"?>
+      <#{call}Request xmlns="urn:ebay:apis:eBLBaseComponents">
+        <RequesterCredentials>
+          <eBayAuthToken>#{auth_token}</eBayAuthToken>
+        </RequesterCredentials>
+        #{xml}
+      </#{call}Request>
+    XML
+
+    request = Net::HTTP::Post.new(uri.path, headers)
+
+    request.body = xml.to_s
+
+    http = Net::HTTP.new(uri.host, uri.port)
+
+    if uri.port == 443
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    end
+
+    response = http.start { |http| http.request(request) }
+
+    if callbacks
+      callbacks.each do |callback|
+        if callback.is_a?(Symbol)
+          send(callback, request, response)
+        elsif callback.respond_to?(:call)
+          callback.call(request, response)
+        else
+          throw Error.new("Invalid callback: #{callback.to_s}")
+        end
+      end
+    end
+
+    case response
+    when Net::HTTPSuccess 
+      result = Hash.from_xml(response.body)["#{call}Response"]
+      unless result
+        raise Exception.new("No #{call}Response in response", request, response)
+      end
+      case result['Ack']
+      when 'Success'
+        return result
+      when 'Warning'
+        @@logger.warn(result['Errors'].inspect)
+        return result
+      else
+        raise Error.new(result['Errors'], request, response)
+      end
+      return result
+    else
+      raise Exception.new("Unexpected response from server", request, response)
+    end
+  end
+
+  # Shorthand for call(call, arguments.merge(:auth_token => this.ebay_token))
+  # Allows objects which mix in this module to use their own token.
+  def ebay_call(call, arguments = {})
+    raise "#{self} has no eBay token" unless ebay_token
+    Ebay.call(call, arguments.merge(:auth_token => ebay_token))
+  end
+
+  class Exception < ::Exception
+    attr_reader :request, :response
+    def initialize(message, request, response)
+      super message
+      @request, @response = request, response
+    end
+  end
+
+  class Error < Exception
+    attr_reader :request, :response, :errors
+    def initialize(errors, request, response)
+      @errors, @request, @response = errors, request, response
+      super
+    end
+    
+    def to_s
+      [@errors].flatten.map { |e| "<#{e['LongMessage']}>" }.join(", ")
+    end
+  end
+end

data/test/test_ebayr.rb

@@ -0,0 +1,10 @@
+require 'test/unit'
+require 'ebayr'
+
+class TestEbayr < Test::Unit::TestCase
+  # If this passes without an exception, then we're ok.
+  def test_sanity
+    result = Ebayr.call(:GeteBayOfficialTime)
+    puts "The eBay time is: #{result['Timestamp']}"
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: ebayr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- JJ Buckley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-22 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &81216930 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *81216930
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &81216720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *81216720
+description: A tidy library for using the eBay Trading API with Ruby
+email:
+- jj@bjjb.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ebayr.gemspec
+- lib/ebayr.rb
+- lib/ebayr/version.rb
+- test/test_ebayr.rb
+homepage: http://jjbuckley.github.com/ebayr
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 248100125
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 248100125
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: eBayR is a gem that makes it (relatively) easy to use the eBay Trading API
+  from Ruby. Includes a self-contained XML parser, a flexible callback system, and
+  easy integration into Rails.
+test_files:
+- test/test_ebayr.rb