agent_cooper 0.0.2 → 0.0.4

data/README.md

@@ -11,11 +11,13 @@ Currently the following eBay APIs are supported:
 Usage
 -----
 Set up.
-    
-    AgentCooper::Request::APP_ID = YOUR_APP_ID
+
+    AgentCooper::Config.set do |config|
+      config.app_id = "SOME_OBSCURE_APP_ID"
+    end
 
 Initialize a request
-    
+
     request = AgentCooper::Finder.new
     request = AgentCooper::Shopper.new
     request = AgentCooper::Merchandiser.new
@@ -23,15 +25,22 @@ Initialize a request
 Build request params.
 
     request << {
-      'OPERATION-NAME' => 'findItemsByKeywords',
-      'keywords'       => 'harry potter'
+      'OPERATION-NAME' => 'getSearchKeywordsRecommendation',
+      'KEYWORDS'       => 'arry potter'
     }
 
 Get a response.
 
     response = request.get
 
-Response API allows one to utilize the pure goodness of Nokogiri:
+Return a hash:
+
+    response.to_hash
+
+    returns: {'getSearchKeywordsRecommendationResponse' => {'xmnls' => 'http://www.ebay.com/marketplace/search/v1/services', 'ack' => 'Success', 'version' => '1.9.0', 'keywords' => 'harry potter'}}
+
+
+Or parse a response with Nokogiri:
 
     response.xml.css("Item > Title").each do |title|
       some business value
@@ -39,10 +48,6 @@ Response API allows one to utilize the pure goodness of Nokogiri:
 
     response.xml.xpath("//Item")
 
-Specify a particular eBay locale (defaults to US):
-
-   AgentCooper::Shopper.new(:locale => :fr)
-
 ----
 
 Based on papercavalier's [sucker](http://github.com/papercavalier/sucker).

data/features/support/env.rb

@@ -14,12 +14,14 @@ module AgentCooperMethods
   end
 
   def cassette_name
-    Digest::MD5.hexdigest(@request.parameters.to_json)
+    Digest::MD5.hexdigest(@request.options.to_json)
   end
 end
 
 World(AgentCooperMethods)
 
 Before do
-  Request::APP_ID = ebay_app_id
+  AgentCooper::Config.set do |config|
+    config.app_id = 'SOME_OBSCURE_APP_ID'
+  end
 end

data/lib/agent_cooper/config.rb

@@ -0,0 +1,17 @@
+module AgentCooper
+  class Config
+    class << self
+      def set(&block)
+        yield self
+      end
+
+      def app_id=(app_id)
+        @@app_id = app_id
+      end
+
+      def app_id
+        @@app_id ||= nil
+      end
+    end
+  end
+end

data/lib/agent_cooper/finder.rb

@@ -1,22 +1,18 @@
 module AgentCooper
   class Finder < Request
 
-    HOST = 'http://svcs.ebay.com/services/search/FindingService/v1'
     VERSION = '1.9.0'
 
-    protected
+    base_uri 'svcs.ebay.com'
+    default_params 'SECURITY-APPNAME' => Config.app_id,
+      'SECURITY-VERSION' => VERSION,
+      'RESPONSE-DATA-FORMAT' => ENCODING,
+      'REST-PAYLOAD' => ''
 
-    def options
-      {
-        'SECURITY-APPNAME' => APP_ID,
-        'SECURITY-VERSION' => VERSION,
-        'RESPONSE-DATA-FORMAT' => ENCODING,
-        'REST-PAYLOAD' => ''
-      }.merge(parameters)
-    end
+    protected
 
-    def uri
-      "#{HOST}?#{options.to_params}"
+    def path
+      '/services/search/FindingService/v1'
     end
   end
 end

data/lib/agent_cooper/merchandiser.rb

@@ -1,24 +1,20 @@
 module AgentCooper
   class Merchandiser < Request
 
-    HOST = 'http://svcs.ebay.com/MerchandisingService'
     SERVICE_NAME = 'MerchandisingService'
     VERSION = '1.4.0'
-    
-    protected
 
-    def options
-      {
-        'SERVICE-NAME' => SERVICE_NAME,
-        'SERVICE-VERSION' => VERSION,
-        'RESPONSE-DATA-FORMAT' => ENCODING,
-        'CONSUMER-ID' => APP_ID,
-        'REST-PAYLOAD' => ''
-      }.merge(parameters)
-    end
+    base_uri 'svcs.ebay.com'
+    default_params 'CONSUMER-ID' => Config.app_id,
+      'SERVICE-NAME' => SERVICE_NAME,
+      'SERVICE-VERSION' => VERSION,
+      'RESPONSE-DATA-FORMAT' => ENCODING,
+      'REST-PAYLOAD' => ''
+
+    protected
 
-    def uri
-      "#{HOST}?#{options.to_params}"
+    def path
+      '/MerchandisingService'
     end
   end
 end

data/lib/agent_cooper/request.rb

@@ -1,47 +1,30 @@
 require 'httparty'
 
-class Request
-  ENCODING = 'XML'
-  LOCALE_CODES = {
-    :us => 0,
-    :fr => 71,
-    :es => 186,
-    :gb => 3,
-    :de => 77,
-    :nl => 146,
-    :it => 101,
-    :au => 15,
-    :ca => 2
-  }
-
-  attr_accessor :locale
-
-  def initialize(args={})
-    args.each { |k, v| send("#{k}=", v) }
-  end
+module AgentCooper
+  class Request
 
-  def parameters
-    @parameters ||= {}
-  end
+    ENCODING = 'XML'
 
-  def reset!
-    @parameters = {}
-  end
+    include HTTParty
+    format :xml
 
-  def <<(hash)
-    parameters.merge!(hash)
-  end
+    attr_accessor :locale
 
-  def locale
-    @locale ||= :us
-  end
+    def options
+      @options ||= {}
+    end
 
-  def locale_code
-    LOCALE_CODES[locale]
-  end
+    def <<(hash)
+      options.merge!(hash)
+    end
+
+    def reset!
+      @options = {}
+    end
 
-  def get
-    response = HTTParty.get(uri)
-    Response.new(response)
+    def get
+      r = self.class.get(path, :query => options)
+      Response.new(r)
+    end
   end
 end

data/lib/agent_cooper/response.rb

@@ -1,30 +1,36 @@
 require 'nokogiri'
 
-class Response
+module AgentCooper
+  class Response
 
-  def initialize(response)
-    @response = response
-  end
+    def initialize(response)
+      @response = response
+    end
 
-  def body
-    response.body
-  end
+    def body
+      response.body
+    end
 
-  def code
-    response.code
-  end
+    def to_hash
+      response.parsed_response
+    end
 
-  def valid?
-    code == 200
-  end
+    def code
+      response.code
+    end
 
-  def xml
-    @xml ||= Nokogiri::XML(body)
-  end
+    def valid?
+      code == 200
+    end
+
+    def xml
+      @xml ||= Nokogiri::XML(body)
+    end
 
-  protected
+    protected
 
-  def response
-    @response
+    def response
+      @response
+    end
   end
 end

data/lib/agent_cooper/shopper.rb

@@ -1,22 +1,18 @@
 module AgentCooper
   class Shopper < Request
 
-    HOST = 'http://open.api.ebay.com/shopping'
     VERSION = '717'
-    
-    protected
 
-    def options
-      {
-        'APPID' => APP_ID,
-        'RESPONSEENCODING' => ENCODING,
-        'VERSION' => VERSION,
-        'SITEID' => locale_code
-      }.merge(parameters)
-    end
+    base_uri 'open.api.ebay.com'
+    default_params 'APPID' => Config.app_id,
+      'RESPONSEENCODING' => ENCODING,
+      'VERSION' => VERSION,
+      'SITEID' => 0
+
+    protected
 
-    def uri
-      "#{HOST}?#{options.to_params}"
+    def path
+      '/shopping'
     end
   end
 end

data/lib/agent_cooper/version.rb

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

data/lib/agent_cooper.rb

@@ -1,8 +1,9 @@
+require 'agent_cooper/config'
 require 'agent_cooper/request'
 require 'agent_cooper/response'
 require 'agent_cooper/finder'
 require 'agent_cooper/shopper'
 require 'agent_cooper/merchandiser'
 
-module AgentCooper  
+module AgentCooper
 end

data/spec/agent_cooper/config_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+module AgentCooper
+  describe Config do
+    subject { Config }
+
+    describe ".app_id=" do
+      it "sets a value for @@app_id" do
+        subject.app_id = "12345"
+        subject.class_variables.should include("@@app_id")
+      end
+    end
+
+    describe ".app_id" do
+      it "returns @@app_id value" do
+        subject.app_id = "6789"
+        subject.app_id.should == "6789"
+      end
+    end
+  end
+end

data/spec/agent_cooper/request_spec.rb

@@ -8,22 +8,16 @@ module AgentCooper
       @request = subject.new
     end
     
-    describe "#parameters" do
+    describe "#options" do
       it "returns a hash" do
-        @request.parameters.should be_a(Hash)
+        @request.options.should be_a(Hash)
       end
     end
 
     describe "#<<" do
-      it "merges a hash into the existing parameters" do
+      it "merges a hash into the existing options" do
         @request << {:foo => "bar"}
-        @request.parameters[:foo].should == "bar"
-      end
-    end
-
-    describe "#locale" do
-      it "defaults to :us" do
-        @request.locale.should == :us
+        @request.options[:foo].should == "bar"
       end
     end
 
@@ -31,7 +25,7 @@ module AgentCooper
       it "resets the parameters to a blank hash" do
         @request << {:foo => 'bar'}
         @request.reset!
-        @request.parameters.should_not have_key(:foo)
+        @request.options.should_not have_key(:foo)
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: agent_cooper
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Ryan Closner
@@ -204,12 +204,14 @@ files:
 - features/support/env.rb
 - features/support/vcr.rb
 - lib/agent_cooper.rb
+- lib/agent_cooper/config.rb
 - lib/agent_cooper/finder.rb
 - lib/agent_cooper/merchandiser.rb
 - lib/agent_cooper/request.rb
 - lib/agent_cooper/response.rb
 - lib/agent_cooper/shopper.rb
 - lib/agent_cooper/version.rb
+- spec/agent_cooper/config_spec.rb
 - spec/agent_cooper/finder_spec.rb
 - spec/agent_cooper/merchandiser_spec.rb
 - spec/agent_cooper/request_spec.rb
@@ -261,6 +263,7 @@ test_files:
 - features/step_definitions/shopper_steps.rb
 - features/support/env.rb
 - features/support/vcr.rb
+- spec/agent_cooper/config_spec.rb
 - spec/agent_cooper/finder_spec.rb
 - spec/agent_cooper/merchandiser_spec.rb
 - spec/agent_cooper/request_spec.rb