agent_cooper 0.0.6 → 0.0.7.pre

data/.gitignore

@@ -2,4 +2,3 @@
 .bundle
 Gemfile.lock
 pkg/*
-ebay.yml

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create 1.9.2@agent_cooper

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+  - 1.9.2

data/README.md

@@ -1,9 +1,11 @@
 Agent Cooper
 ======
 
-Agent Cooper is a minimalistic, Nokogiri-based Ruby wrapper to the [eBay Web Services API](http://developer.ebay.com/).
+[![travis](https://secure.travis-ci.org/rclosner/agent_cooper.png)](http://travis-ci.org/rclosner/agent_cooper)
 
-Currently the following eBay APIs are supported:
+Agent Cooper is a minimalist, Nokogiri-based Ruby wrapper to the [eBay Web Services API](http://developer.ebay.com/).
+
+It supports the following eBay APIs are supported:
   - [Finding API](http://developer.ebay.com/products/finding/)
   - [Shopping API](http://developer.ebay.com/products/shopping/)
   - [Merchandising API](http://developer.ebay.com/products/merchandising/)
@@ -14,7 +16,7 @@ Set up.
 
 ```ruby
     AgentCooper.configure do |config|
-      config.app_id = "SOME_OBSCURE_APP_ID"
+      config.app_id = "YOUR_EBAY_APP_ID"
     end
 ```
 
@@ -59,4 +61,4 @@ Or parse a response with Nokogiri:
 ```
 ----
 
-Based on papercavalier's [sucker](http://github.com/papercavalier/sucker).
+Based on hakanensari's [amazon_product](http://github.com/hakanensari/amazon_product).

data/Rakefile

@@ -13,3 +13,5 @@ end
 Cucumber::Rake::Task.new(:features) do |t|
   t.cucumber_opts = "features --format pretty"
 end
+
+task :default => [:spec]

data/agent_cooper.gemspec

@@ -7,28 +7,30 @@ Gem::Specification.new do |s|
   s.version     = AgentCooper::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Ryan Closner"]
-  s.email       = ["ryan.closner@gmail.com"]
+  s.email       = ["ryan@ryanclosner.com"]
   s.homepage    = "https://rubygems.org/gems/agent_cooper"
   s.summary     = %q{A Ruby wrapper to the eBay Web Services API}
   s.description = %q{A Ruby wrapper to the eBay Web Services API}
 
   s.rubyforge_project = "agent_cooper"
 
-  {
-    'httpclient'          => '~> 2.2',
-    'nokogiri'            => '~> 1.4'
-  }.each {|lib, version| s.add_runtime_dependency lib, version }
+  runtime_dependencies = {
+    "httpclient" => "~> 2.2.3",
+    "nokogiri"   => "~> 1.5.0",
+    "virtus"     => "~> 0.0.9"
+  }
 
+  runtime_dependencies.each {|lib, version| s.add_runtime_dependency(lib, version) }
 
-  {
-    'cucumber'            => '~> 1.0',
-    'em-http-request'     => '~> 1.0.0.beta.4',
-    'em-synchrony'        => '~> 0.3.0.beta.1',
-    'rake'                => '~> 0.9',
-    'rspec'               => '~> 2.6',
-    'vcr'                 => '~> 1.10',
-    'webmock'             => '~> 1.6'
-  }.each {|lib, version| s.add_development_dependency lib, version }
+  development_dependencies = {
+    "cucumber" => "~> 1.1.2",
+    "rake"     => "~> 0.9.2",
+    "rspec"    => "~> 2.7.0",
+    "vcr"      => "~> 1.11.3",
+    "webmock"  => "~> 1.7.7"
+  }
+
+  development_dependencies.each {|lib, version| s.add_development_dependency(lib, version) }
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/features/finder.feature

@@ -18,7 +18,7 @@ Feature: Ebay Finder
         | findItemsByKeywords | harry potter phoenix |
      When I tape the "finder" request as: "find_items_by_keywords"
      Then the response code should be "200"
-      And the response should have 100 "item" nodes
+      And the response should have 99 "item" nodes
 
   Scenario: findItemsByCategory
     Given the following parameters:

data/features/support/env.rb

@@ -5,12 +5,8 @@ require 'agent_cooper'
 
 
 module AgentCooperMethods
-  def ebay
-    @ebay ||= YAML::load_file(File.dirname(__FILE__) + "/../../spec/fixtures/ebay.yml")
-  end
-
   def ebay_app_id
-    ebay['app_id']
+    ENV['EBAY_APP_ID'] || "APP_ID"
   end
 
   def cassette_name

data/features/support/vcr.rb

@@ -1,11 +1,7 @@
 require 'vcr'
 
-def ebay
-  @ebay ||= YAML::load_file(File.dirname(__FILE__) + "/../../spec/fixtures/ebay.yml")
-end
-
 def ebay_app_id
-  ebay['app_id']
+  ENV['EBAY_APP_ID'] || "APP_ID"
 end
 
 
@@ -15,5 +11,5 @@ VCR.config do |c|
     :record             => :none,
     :match_requests_on  => [:host] }
   c.stub_with :webmock
-  c.filter_sensitive_data('YOUR-APP-ID') { ebay_app_id }
+  c.filter_sensitive_data('APP_ID') { ebay_app_id }
 end

data/lib/agent_cooper.rb

@@ -1,22 +1,20 @@
-# Utilities
+require 'nokogiri'
+require 'httpclient'
+require 'virtus'
+require 'cgi'
+
+module AgentCooper
+  def self.configure(&block)
+    Config.configure(&block)
+  end
+end
+
 require 'agent_cooper/config'
 require 'agent_cooper/response'
-require 'agent_cooper/request'
-
-require 'agent_cooper/nokogiri_decorator'
+require 'agent_cooper/builder'
 
-# Requests
+require 'agent_cooper/request'
 require 'agent_cooper/requests/finder'
 require 'agent_cooper/requests/shopper'
 require 'agent_cooper/requests/merchandiser'
-
-#Version
 require "agent_cooper/version"
-
-module AgentCooper
-  class << self
-    def configure(&block)
-      Config.configure(&block)
-    end
-  end
-end

data/lib/agent_cooper/builder.rb

@@ -0,0 +1,46 @@
+module AgentCooper
+  class Builder
+
+    # Based on https://gist.github.com/335286
+
+    # @api public
+    def self.from_xml(xml)
+      case xml
+      when Nokogiri::XML::Document
+        from_xml(xml.root)
+      when Nokogiri::XML::Element
+        hsh = {}
+
+        xml.attributes.each_pair do |key, attr|
+          hsh[key] = attr.value
+        end
+
+        xml.children.each do |child|
+          result = from_xml(child)
+
+          if child.name == 'text'
+            if hsh.empty?
+              return result
+            else
+              hsh['__content__'] = result
+            end
+          elsif hsh[child.name]
+            case hsh[child.name]
+            when Array
+              hsh[child.name] << result
+            else
+              hsh[child.name] = [hsh[child.name]] << result
+            end
+          else
+            hsh[child.name] = result
+          end
+        end
+
+        hsh
+      else
+        xml.content.to_s
+      end
+    end
+
+  end
+end

data/lib/agent_cooper/config.rb

@@ -3,8 +3,13 @@ module AgentCooper
     class << self
       attr_accessor :app_id
 
+      # @api public
       def configure(&block)
-        yield self
+        unless block_given?
+          raise ArgumentError, "No block given"
+        end
+
+        yield self if block_given?
       end
     end
   end

data/lib/agent_cooper/request.rb

@@ -1,53 +1,77 @@
-require 'forwardable'
-require 'httpclient'
-require 'cgi'
-
 module AgentCooper
   class Request
 
-    extend Forwardable
+    include Virtus
 
-    def_delegators :@config, :app_id
+    # config attributes
+    attribute :app_id, String,
+      :default  => Proc.new { AgentCooper::Config.app_id },
+      :writer   => :protected
 
-    ENCODING = 'XML'
+    # request attributes
+    attribute :request_adapter, Object,
+      :default  => Proc.new { HTTPClient.new },
+      :accessor => :protected
 
-    def initialize
-      @config = Config
-    end
+    attribute :query_parameters, Hash,
+      :default  => Proc.new { {} },
+      :accessor => :protected
 
-    def adapter
-      @adapter ||= HTTPClient.new
-    end
+    attribute :default_parameters, Hash,
+      :accessor => :protected
 
+    attribute :host, String,
+      :accessor => :protected
+
+    attribute :path, String,
+      :accessor => :protected
+
+    # @api public
     def get
-      response = adapter.get(url)
-      Response.new(response)
+      Response.new(:response => request_adapter.get(url))
     end
 
-    def url
-      URI::HTTP.build(
-        :host  => host,
-        :path  => path,
-        :query => query
-      )
-    end
+    # @api public
+    def <<(parameters)
+      unless parameters.is_a?(Hash)
+        raise ArgumentError, "+parameters+ must be an instance of Hash"
+      end
 
-    def query
-      query = default_parameters.merge(parameters)
+      query_parameters.merge!(parameters)
+    end
 
-      query.collect {|k,v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"} * '&'
+    # @api public
+    def reset!
+      self.query_parameters = {}
     end
 
+    # @api public
     def parameters
-      @parameters ||= {}
+      default_parameters.merge(query_parameters)
+    end
+
+    protected
+
+    # @api private
+    def query
+      parameters.collect { |k,v| "#{escape(k)}=#{escape(v)}" }.sort * '&'
     end
 
-    def <<(hash)
-      parameters.merge!(hash)
+    # @api private
+    def escape(value)
+      CGI.escape("#{value}")
     end
 
-    def reset!
-      @parameters = {}
+    # @api private
+    def url
+      options = {
+        :host  => host,
+        :path  => path,
+        :query => query
+      }
+
+      URI::HTTP.build(options)
     end
+
   end
 end

data/lib/agent_cooper/requests/finder.rb

@@ -1,23 +1,20 @@
 module AgentCooper
   class Finder < Request
 
-    VERSION = '1.9.0'
+    VERSION  = "1.11.0".freeze
+    HOST     = "svcs.ebay.com".freeze
+    PATH     = "/services/search/FindingService/v1".freeze
+    ENCODING = "XML".freeze
 
-    def host
-      'svcs.ebay.com'
-    end
-
-
-    def path
-      '/services/search/FindingService/v1'
-    end
+    def initialize
+      self.host = HOST
+      self.path = PATH
 
-    def default_parameters
-      {
-        'SECURITY-APPNAME' => app_id,
-        'SECURITY-VERSION' => VERSION,
-        'RESPONSE-DATA-FORMAT' => ENCODING,
-        'REST-PAYLOAD' => ''
+      self.default_parameters = {
+        "SECURITY-APPNAME"     => app_id,
+        "SECURITY-VERSION"     => VERSION,
+        "RESPONSE-DATA-FORMAT" => ENCODING,
+        "REST-PAYLOAD"         => ""
       }
     end
 

data/lib/agent_cooper/requests/merchandiser.rb

@@ -1,25 +1,24 @@
 module AgentCooper
   class Merchandiser < Request
 
-    SERVICE_NAME = 'MerchandisingService'
-    VERSION = '1.4.0'
+    VERSION      = "1.5.0".freeze
+    HOST         = "svcs.ebay.com".freeze
+    SERVICE_NAME = "MerchandisingService".freeze
+    PATH         = "/MerchandisingService".freeze
+    ENCODING     = "XML".freeze
 
-    def host
-      'svcs.ebay.com'
-    end
-
-    def path
-      '/MerchandisingService'
-    end
+    def initialize
+      self.host = HOST
+      self.path = PATH
 
-    def default_parameters
-      {
-        'CONSUMER-ID' => app_id,
-        'SERVICE-NAME' => SERVICE_NAME,
-        'SERVICE-VERSION' => VERSION,
-        'RESPONSE-DATA-FORMAT' => ENCODING,
-        'REST-PAYLOAD' => ''
+      self.default_parameters = {
+        "CONSUMER-ID"          => app_id,
+        "SERVICE-NAME"         => SERVICE_NAME,
+        "SERVICE-VERSION"      => VERSION,
+        "RESPONSE-DATA-FORMAT" => ENCODING,
+        "REST-PAYLOAD"         => ""
       }
     end
+
   end
 end

data/lib/agent_cooper/requests/shopper.rb

@@ -1,23 +1,23 @@
 module AgentCooper
   class Shopper < Request
 
-    VERSION = '717'
+    VERSION      = "745".freeze
+    HOST         = "open.api.ebay.com".freeze
+    PATH         = "/shopping".freeze
+    SITE_ID      = 0.freeze
+    ENCODING     = "XML".freeze
 
-    def host
-      'open.api.ebay.com'
-    end
+    def initialize
+      self.host = HOST
+      self.path = PATH
 
-    def path
-      '/shopping'
+      self.default_parameters = {
+        "APPID"            => app_id,
+        "RESPONSEENCODING" => ENCODING,
+        "VERSION"          => VERSION,
+        "SITEID"           => SITE_ID
+       }
     end
 
-    def default_parameters
-      {
-        'APPID' => app_id,
-        'RESPONSEENCODING' => ENCODING,
-        'VERSION' => VERSION,
-        'SITEID' => 0
-      }
-    end
   end
 end