rebay 1.0.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2010 Chuck Collins
+
+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,62 @@
+rebay
+========
+Rebay is a very simple wrapper for the ebay finding and shopping APIs.  Please see the ebay documentation for the proper input arguments and expected output. 
+
+[Ebay Shopping Api Documentation](http://developer.ebay.com/products/shopping/)
+
+[Ebay Finding Api Documentation](http://developer.ebay.com/products/finding/)
+
+Configuration
+-------------
+Create and require a config.rb, or if using rails create an initializer (rebay.rb perhaps), and place the following code into it:
+
+	Rebay::Api.configure do |rebay|
+		rebay.app_id = 'YOUR APPLICATION ID HERE'
+	end
+		
+		
+Use
+---
+If you have questions about optional/required parameters, please check the ebay api docs.  The source of this api wrapper also includes links to specific api call documentation.  Basically, pass whatever options into the rebay api call and they will be passed through into the actual api call.  When getting your return response, the json from ebay is transformed just a bit.  You can still expect the same keys to come through in the hash, they just aren't annoyingly wrapped in an array... everywhere.
+
+
+Example
+-------
+To get search keyword recommendations for *acordian*:
+
+	finder = Rebay::Finding.new
+	response = finder.get_search_keywords_recommendation({:keywords => 'acordian'})
+	
+Ebay will return an array filled result something like this:
+		
+	{"getSearchKeywordsRecommendationResponse": [{"ack": ["Success"],"version": ["1.5.0"],"timestamp": ["2010-08-13T21:11:02.539Z"],"keywords": ["accordion"]}]}
+	
+For my own sanity, I transform this response into a more standard ruby hash and in the case of the finding api responses, I removed the XXXResponse key and use the resulting hash as the response (to be inline with the shopping api responses).
+
+	{"ack" => "Success", "version" => "1.5.0", "timestamp" => "2010-08-13T21:11:02.539Z", "keywords" => "accordion"}
+
+You can check for success or failure of the request:
+	response.success?
+	response.failure?
+	
+MIT License
+-----------
+Copyright (c) 2010 Chuck Collins
+
+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/Rakefile

@@ -0,0 +1,18 @@
+require "rake"
+
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rebay"
+    gem.summary = "Client for the RESTful JSON ebay finding and shopping api"
+    gem.email = "chuck.collins@gmail.com"
+    gem.homepage = "http://github.com/ccollins/rebay"
+    gem.authors = ["Chuck Collins"]
+    gem.files = Dir["*", "{lib}/**/*"]
+    gem.add_dependency("json")
+  end
+  
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.2

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "lib", "rebay")

data/lib/rebay.rb

@@ -0,0 +1,8 @@
+require 'rebay/api'
+require 'rebay/finding'
+require 'rebay/shopping'
+require 'rebay/response'
+
+module Rebay
+  require 'rebay/railtie' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+end

data/lib/rebay/api.rb

@@ -0,0 +1,36 @@
+require 'net/http'
+require 'json'
+require 'uri'
+
+module Rebay
+  class Api
+    EBAY_US = 0
+  
+    def self.app_id= app_id
+      @@app_id = app_id
+    end
+    
+    def self.app_id
+      @@app_id
+    end
+      
+    def self.configure
+      yield self if block_given?
+    end
+    
+    protected
+    def get_json_response(url)
+      Rebay::Response.new(JSON.parse(Net::HTTP.get_response(URI.parse(url)).body))
+    end
+    
+    def build_rest_payload(params)
+      payload = ''
+      unless params.nil?
+        params.keys.each do |key|
+          payload += URI.escape "&#{key}=#{params[key]}"
+        end
+      end
+      return payload
+    end
+  end
+end

data/lib/rebay/finding.rb

@@ -0,0 +1,75 @@
+module Rebay
+  class Finding < Rebay::Api
+    BASE_URL = 'http://svcs.ebay.com/services/search/FindingService/v1'
+    VERSION = '1.0.0'
+    
+    #http://developer.ebay.com/DevZone/finding/CallRef/findItemsAdvanced.html
+    def find_items_advanced(params)
+      raise ArgumentError unless params[:keywords] or params[:categoryId]
+      response = get_json_response(build_request_url('findItemsAdvanced', params))
+      response.trim(:findItemsAdvancedResponse)
+      return response
+    end
+  
+    #http://developer.ebay.com/DevZone/finding/CallRef/findItemsByCategory.html
+    def find_items_by_category(params)
+      raise ArgumentError unless params[:categoryId]
+      response = get_json_response(build_request_url('findItemsByCategory', params))
+      response.trim(:findItemsByCategoryResponse)
+      return response
+    end
+  
+    #http://developer.ebay.com/DevZone/finding/CallRef/findItemsByKeywords.html
+    def find_items_by_keywords(params)
+      raise ArgumentError unless params[:keywords]
+      response = get_json_response(build_request_url('findItemsByKeywords', params))
+      response.trim(:findItemsByKeywordsResponse)
+      return response
+    end
+  
+    #http://developer.ebay.com/DevZone/finding/CallRef/findItemsByProduct.html
+    def find_items_by_product(params)
+      raise ArgumentError unless params[:productId]
+      params['productId.@type'] = 'ReferenceID'
+      response = get_json_response(build_request_url('findItemsByProduct', params))
+      response.trim(:findItemsByProductResponse)
+      return response
+    end
+  
+    #http://developer.ebay.com/DevZone/finding/CallRef/findItemsIneBayStores.html
+    def find_items_in_ebay_stores(params)
+      raise ArgumentError unless params[:keywords] or params[:storeName]
+      response = get_json_response(build_request_url('findItemsIneBayStores', params))
+      response.trim(:findItemsIneBayStoresResponse)
+      return response
+    end
+  
+    #http://developer.ebay.com/DevZone/finding/CallRef/getHistograms.html
+    def get_histograms(params)
+      raise ArgumentError unless params[:categoryId]
+      response = get_json_response(build_request_url('getHistograms', params))
+      response.trim(:getHistorgramsResponse)
+      return response
+    end
+  
+    #http://developer.ebay.com/DevZone/finding/CallRef/getSearchKeywordsRecommendation.html
+    def get_search_keywords_recommendation(params)
+      raise ArgumentError unless params[:keywords]
+      response = get_json_response(build_request_url('getSearchKeywordsRecommendation', params))
+      response.trim(:getSearchKeywordsRecommendationResponse)
+      return response
+    end
+  
+    #http://developer.ebay.com/DevZone/finding/CallRef/getVersion.html
+    def get_version
+      response = get_json_response(build_request_url('getVersion'))
+    end
+    
+    private    
+    def build_request_url(service, params=nil)
+      url = "#{BASE_URL}?OPERATION-NAME=#{service}&SERVICE-VERSION=#{VERSION}&SECURITY-APPNAME=#{Rebay::Api.app_id}&RESPONSE-DATA-FORMAT=JSON&REST-PAYLOAD"
+      url += build_rest_payload(params)
+      return url
+    end
+  end
+end

data/lib/rebay/railtie.rb

@@ -0,0 +1,8 @@
+require 'rebay'
+require 'rails'
+
+module Rebay
+  class Railtie < Rails::Railtie
+    railtie_name :rebay
+  end
+end

data/lib/rebay/response.rb

@@ -0,0 +1,38 @@
+module Rebay
+  class Response
+    attr_accessor :response
+    
+    def initialize(json_response)
+      @response = transform_json_response(json_response)
+    end
+    
+    def success?
+      return @response["Ack"] == 'Success'
+    end
+    
+    def failure?
+      return @response["Ack"] == 'Failure'
+    end
+    
+    def trim(key)
+      if @response.has_key?(key)
+        @response = @response[key]
+      end
+    end
+    
+    protected
+    def transform_json_response(response)    
+      if response.class == Hash
+        r = Hash.new
+        response.keys.each do |k|
+          r[k] = transform_json_response(response[k])
+        end
+        return r
+      elsif response.class == Array and response.size == 1  
+        return transform_json_response(response[0])
+      else
+        return response
+      end
+    end
+  end
+end

data/lib/rebay/shopping.rb

@@ -0,0 +1,83 @@
+module Rebay
+  class Shopping < Rebay::Api
+    BASE_URL = 'http://open.api.ebay.com/shopping'
+    VERSION = '677'
+    
+    #http://developer.ebay.com/DevZone/shopping/docs/CallRef/FindProducts.html
+    def find_products(params)
+      raise ArgumentError unless params[:categoryId] or params[:productId] or params[:queryKeywords]
+      get_json_response(build_request_url('FindProducts', params))
+    end
+    
+    #http://developer.ebay.com/DevZone/shopping/docs/CallRef/FindHalfProducts.html
+    def find_half_products(params)
+      raise ArgumentError unless params[:productId] or params[:queryKeywords]
+      get_json_response(build_request_url('FindHalfProducts', params))
+    end
+    
+    #http://developer.ebay.com/DevZone/shopping/docs/CallRef/GetSingleItem.html
+    def get_single_item(params)
+      raise ArgumentError unless params[:itemId]
+      get_json_response(build_request_url('GetSingleItem', params))
+    end
+    
+    #http://developer.ebay.com/DevZone/shopping/docs/CallRef/GetItemStatus.html
+    def get_item_status(params)
+      raise ArgumentError unless params[:itemId]
+      get_json_response(build_request_url('GetItemStatus', params))
+    end
+    
+    #http://developer.ebay.com/DevZone/shopping/docs/CallRef/GetShippingCosts.html
+    def get_shipping_costs(params)
+      raise ArgumentError unless params[:itemId]
+      get_json_response(build_request_url('GetShippingCosts', params))
+    end
+    
+    #http://developer.ebay.com/DevZone/shopping/docs/CallRef/GetMultipleItems.html
+    def get_multiple_items(params)
+      raise ArgumentError unless params[:itemId]
+      get_json_response(build_request_url('GetMultipleItems', params))
+    end
+    
+    #http://developer.ebay.com/DevZone/shopping/docs/CallRef/GetUserProfile.html
+    def get_user_profile(params)
+      raise ArgumentError unless params[:userId]
+      get_json_response(build_request_url('GetUserProfile', params))
+    end
+    
+    #http://developer.ebay.com/DevZone/shopping/docs/CallRef/FindPopularSearches.html
+    def find_popular_searches(params)
+      raise ArgumentError unless params[:categoryId]
+      get_json_response(build_request_url('FindPopularSearches', params))
+    end
+    
+    #http://developer.ebay.com/DevZone/shopping/docs/CallRef/FindPopularItems.html
+    def find_popular_items(params={})
+      raise ArgumentError unless params[:categoryId] or params[:queryKeywords]
+      get_json_response(build_request_url('FindPopularItems', params))
+    end
+      
+    #http://developer.ebay.com/DevZone/shopping/docs/CallRef/FindReviewsandGuides.html
+    def find_reviews_and_guides(params={})
+      get_json_response(build_request_url('FindReviewsAndGuides', params))
+    end
+   
+    #http://developer.ebay.com/DevZone/shopping/docs/CallRef/GetCategoryInfo.html
+    def get_category_info(params)
+      raise ArgumentError unless params[:categoryId]
+      get_json_response(build_request_url('GetCategoryInfo', params))
+    end
+    
+    def get_category_info_with_children(params)
+      params[:IncludeSelector] = 'ChildCategories'
+      get_category_info(params)
+    end 
+    
+    private
+    def build_request_url(service, params=nil)
+      url = "#{BASE_URL}?callname=#{service}&appid=#{Rebay::Api.app_id}&version=#{VERSION}&responseencoding=JSON&siteid=#{Rebay::Api::EBAY_US}"
+      url += build_rest_payload(params)
+      return url
+    end
+  end
+end

data/rebay.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rebay}
+  s.version = "1.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chuck Collins"]
+  s.date = %q{2010-09-15}
+  s.email = %q{chuck.collins@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "lib/rebay.rb",
+     "lib/rebay/api.rb",
+     "lib/rebay/finding.rb",
+     "lib/rebay/railtie.rb",
+     "lib/rebay/response.rb",
+     "lib/rebay/shopping.rb",
+     "rebay.gemspec"
+  ]
+  s.homepage = %q{http://github.com/ccollins/rebay}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Client for the RESTful JSON ebay finding and shopping api}
+  s.test_files = [
+    "spec/api_spec.rb",
+     "spec/finding_spec.rb",
+     "spec/response_spec.rb",
+     "spec/shopping_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+    else
+      s.add_dependency(%q<json>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 0"])
+  end
+end
+

data/spec/api_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+module Rebay
+  describe Api do
+    it "should respond to configure" do
+      Rebay::Api.should respond_to(:configure)
+    end
+    
+    it "should allow setting of app_id" do
+      Rebay::Api.should respond_to(:app_id=)
+    end
+    
+    it "should allow getting of app_id" do
+      Rebay::Api.should respond_to(:app_id)
+    end
+    
+    it "should return app id after configureation" do
+      app_id = Rebay::Api.app_id
+      Rebay::Api.configure do |rebay|
+        rebay.app_id = 'test'
+      end
+      Rebay::Api.app_id.should == 'test'
+      Rebay::Api.configure do |rebay|
+        rebay.app_id = app_id
+      end
+    end
+    
+    context "when calling build_rest_payload" do
+      before(:each) do
+        @api = Rebay::Api.new
+      end
+      
+      it "should build rest payload from hash" do
+        payload = @api.send(:build_rest_payload, {:test=>'blah', :test2=>'blah', :test3=>'blah'})
+        payload.should include("&test=blah")
+        payload.should include("&test2=blah")
+        payload.should include("&test3=blah")
+      end
+    
+      it "should escape html chars" do
+         payload = @api.send(:build_rest_payload, {:test=>'blah', :test2=>'blah', :test3=>'blah blah'})
+         payload.should include("&test=blah")
+         payload.should include("&test2=blah")
+         payload.should include("&test3=blah%20blah")
+      end
+    end
+  end
+end

data/spec/finding_spec.rb

@@ -0,0 +1,164 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+module Rebay
+  describe Finding do
+    before(:each) do
+        @finder = Finding.new
+        @finder.stub!(:get_json_response).and_return(Rebay::Response.new({"Ack" => 'Success'}))
+    end
+      
+    it "should specify base url" do
+      Finding::BASE_URL.should_not be_nil
+    end
+    
+    it "should specify version" do
+      Finding::VERSION.should_not be_nil
+    end
+    
+    context "after creation" do
+      it "should provide find_items_advanced" do
+        @finder.should respond_to(:find_items_advanced)
+      end
+      
+      it "should provide find_items_by_category" do
+        @finder.should respond_to(:find_items_by_category)
+      end
+      
+      it "should provide find_items_by_product" do
+        @finder.should respond_to(:find_items_by_product)
+      end
+      
+      it "should provide find_items_in_ebay_stores" do
+        @finder.should respond_to(:find_items_in_ebay_stores)
+      end
+      
+      it "should provide get_histograms" do
+        @finder.should respond_to(:get_histograms)
+      end
+      
+      it "should provide get_search_keywords_recommendation" do
+        @finder.should respond_to(:get_search_keywords_recommendation)
+      end
+      
+      it "should provide get_version" do
+        @finder.should respond_to(:get_version)
+      end
+    end
+    
+    context "when calling find_items_advanced" do     
+      it "should fail without args" do
+        lambda { @finder.find_items_advanced }.should raise_error(ArgumentError)
+      end
+      
+      it "should return a hash response with categoryId as parameter" do
+        @finder.find_items_advanced({:categoryId => 1}).class.should eq(Rebay::Response)
+      end
+      
+      it "should return a hash response with keywords as parameter" do
+        @finder.find_items_advanced({:keywords => 'feist'}).class.should eq(Rebay::Response)
+      end
+      
+      it "should succeed" do
+        @finder.find_items_advanced({:keywords => 'feist'}).success?.should be_true
+      end
+    end
+    
+    context "when calling find_items_by_category" do     
+      it "should fail without args" do
+        lambda { @finder.get_search_keywords_recommendation }.should raise_error(ArgumentError)
+      end
+      
+      it "should return a hash response" do
+        @finder.find_items_by_category({:categoryId => 1}).class.should eq(Rebay::Response)
+      end
+      
+      it "should succeed" do
+        @finder.find_items_by_category({:categoryId => 1}).success?.should be_true
+      end
+    end
+    
+    context "when calling find_items_by_product" do    
+      it "should fail without args" do
+        lambda { @finder.find_items_by_product }.should raise_error(ArgumentError)
+      end
+      
+      it "should return a hash response" do
+        @finder.find_items_by_product({:productId => 53039031}).class.should eq(Rebay::Response)
+      end
+      
+      it "should succeed" do
+        @finder.find_items_by_product({:productId => 53039031}).success?.should be_true
+      end
+    end
+  
+    context "when calling find_items_by_keywords" do     
+      it "should fail without args" do
+        lambda { @finder.find_items_by_keywords }.should raise_error(ArgumentError)
+      end
+      
+      it "should return a hash response" do
+        @finder.find_items_by_keywords({:keywords => 'feist'}).class.should eq(Rebay::Response)
+      end
+      
+      it "should succeed" do
+        @finder.find_items_by_keywords({:keywords => 'feist'}).success?.should be_true
+      end
+    end
+    
+    context "when calling find_items_in_ebay_stores" do
+      it "should fail without args" do
+        lambda { @finder.find_items_in_ebay_stores }.should raise_error(ArgumentError)
+      end
+      
+      it "should return a hash response with storeName as parameter" do
+        @finder.find_items_in_ebay_stores({:storeName => 'Laura_Chen\'s_Small_Store'}).class.should eq(Rebay::Response)
+      end
+      
+      it "should return a hash response with keywords as parameter" do
+        @finder.find_items_in_ebay_stores({:keywords => 'feist'}).class.should eq(Rebay::Response)
+      end
+      
+      it "should succeed" do
+        @finder.find_items_in_ebay_stores({:keywords => 'feist'}).success?.should be_true
+      end
+    end
+    
+    context "when calling get_histograms" do
+      it "should fail without args" do
+        lambda { @finder.get_histograms }.should raise_error(ArgumentError)
+      end
+      
+      it "should return a hash response" do
+        @finder.get_histograms({:categoryId => 1}).class.should eq(Rebay::Response)
+      end
+      
+      it "should succeed" do
+        @finder.get_histograms({:categoryId => 1}).success?.should be_true
+      end
+    end
+    
+    context "when calling get_search_keywords_recommendation" do
+      it "should fail without args" do
+        lambda { @finder.get_search_keywords_recommendation }.should raise_error(ArgumentError)
+      end
+      
+      it "should return a hash response" do
+        @finder.get_search_keywords_recommendation({:keywords => 'feist'}).class.should eq(Rebay::Response)
+      end
+      
+      it "should succeed" do
+        @finder.get_search_keywords_recommendation({:keywords => 'feist'}).success?.should be_true
+      end
+    end
+    
+    context "when calling get_version" do
+      it "should return a hash response" do
+        @finder.get_version.class.should eq(Rebay::Response)
+      end
+      
+      it "should succeed" do
+        @finder.get_version.success?.should be_true
+      end
+    end
+  end
+end

data/spec/response_spec.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+module Rebay
+  describe Response do
+    context "on creation" do
+      it "should transform the happy json" do
+        json_happy = JSON.parse(File.read(File.dirname(__FILE__) + "/json_responses/finding/get_search_keywords_recommendation_happy.json"))
+        response = Response.new(json_happy)
+        response.response.should eq({"getSearchKeywordsRecommendationResponse" => {"ack" => "Success", "version" => "1.5.0", 
+                                                                                  "timestamp" => "2010-08-13T21:11:02.539Z", "keywords" => "accordion"}})
+      end
+      
+      it "should transform the sad json" do
+        json_sad = JSON.parse(File.read(File.dirname(__FILE__) + "/json_responses/finding/get_search_keywords_recommendation_sad.json"))
+        response = Response.new(json_sad)
+        response.response.should eq({"getSearchKeywordsRecommendationResponse" =>
+                        {"ack" => "Warning",
+                         "errorMessage" => {"error" => {"errorId" => "59", "domain" => "Marketplace", "severity" => "Warning",
+                                                      "category" => "Request", "message" => "No recommendation was identified for the submitted keywords.",
+                                                      "subdomain" => "Search"}},
+                         "version" => "1.5.0",
+                         "timestamp" => "2010-08-13T21:08:30.081Z",
+                         "keywords" => ""}})
+      end
+    end
+    
+    it "should return success" do
+      response = Response.new({"Ack" => "Success"})
+      response.success?.should be_true
+      response.failure?.should be_false
+    end
+  
+    it "should return failure" do
+      response = Response.new({"Ack" => "Failure"})
+      response.failure?.should be_true
+      response.success?.should be_false
+    end
+  
+    it "should trim response" do
+      response = Response.new({"Ack" => "Failure", "test" => "test"})
+      response.trim("test")
+      response.response.should eq("test")
+    end
+  
+    it "should not trim response" do
+      response = Response.new({"Ack" => "Failure", "test" => "test"})
+      response.trim(:nothing)
+      response.response.should eq({"Ack" => "Failure", "test" => "test"})
+    end
+  end
+end

data/spec/shopping_spec.rb

@@ -0,0 +1,214 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+module Rebay
+  describe Shopping do
+    before(:each) do
+      @shopper = Shopping.new
+      @shopper.stub!(:get_json_response).and_return(Rebay::Response.new({"Ack" => "Success"}))
+    end
+      
+    it "should specify base url" do
+      Shopping::BASE_URL.should_not be_nil
+    end
+    
+    it "should specify version" do
+      Shopping::VERSION.should_not be_nil
+    end
+    
+    context "after creation" do
+      it "should provide get_category_info" do
+        @shopper.should respond_to(:get_category_info)
+      end
+      
+      it "should provide get_category_info_with_children" do
+        @shopper.should respond_to(:get_category_info_with_children)
+      end
+      
+      it "should provide find_products" do
+        @shopper.should respond_to(:find_products)
+      end
+      
+      it "should provide find_half_products" do
+        @shopper.should respond_to(:find_half_products)
+      end
+      
+      it "should provide get_single_item" do
+        @shopper.should respond_to(:get_single_item)
+      end
+      
+      it "should provide get_item_status" do
+        @shopper.should respond_to(:get_item_status)
+      end
+      
+      it "should provide get_shipping_costs" do
+        @shopper.should respond_to(:get_shipping_costs)
+      end
+      
+      it "should provide get_multiple_items" do
+        @shopper.should respond_to(:get_multiple_items)
+      end
+      
+      it "should provide get_user_profile" do
+        @shopper.should respond_to(:get_user_profile)
+      end
+      
+      it "should provide find_popular_searches" do
+        @shopper.should respond_to(:find_popular_searches)
+      end
+      
+      it "should provide find_popular_items" do
+        @shopper.should respond_to(:find_popular_items)
+      end
+      
+      it "should provide find_reviews_and_guides" do
+        @shopper.should respond_to(:find_reviews_and_guides)
+      end
+    end
+  
+    context "when calling get_category_info" do
+      it "should fail without args" do
+        lambda { @shopper.get_category_info }.should raise_error(ArgumentError)
+      end
+      
+      it "should return a hash response" do
+        @shopper.get_category_info({:categoryId => 29223}).class.should eq(Rebay::Response)
+      end
+      
+      it "should succeed" do
+        @shopper.get_category_info({:categoryId => 29223}).success?.should be_true
+      end
+    end
+    
+    context "when calling find_products" do      
+      it "should fail without args" do
+        lambda { @shopper.find_products }.should raise_error(ArgumentError)
+      end
+      
+      it "should return a hash response" do
+        @shopper.find_products({:queryKeywords => 'harry potter'}).class.should eq(Rebay::Response)
+      end
+      
+      it "should succeed" do
+        @shopper.find_products({:queryKeywords => 'harry potter'}).success?.should be_true
+      end
+    end
+    
+    context "when calling find_half_products" do     
+      it "should fail without args" do
+        lambda { @shopper.find_half_products }.should raise_error(ArgumentError)
+      end
+      
+      it "should return a hash response" do
+        @shopper.find_half_products({:queryKeywords => 'harry potter'}).class.should eq(Rebay::Response)
+      end
+      
+      it "should succeed" do
+        @shopper.find_half_products({:queryKeywords => 'harry potter'}).success?.should be_true
+      end
+    end
+    
+    context "when calling get_single_item" do     
+      it "should fail without args" do
+        lambda { @shopper.get_single_item }.should raise_error(ArgumentError)
+      end
+      
+      it "should return a hash response" do
+        @shopper.get_single_item({:itemId => 230139965209}).class.should eq(Rebay::Response)
+      end
+      
+      it "should succeed" do
+        @shopper.get_single_item({:itemId => 230139965209}).success?.should be_true
+      end
+    end
+    
+    context "when calling get_item_status" do    
+      it "should fail without args" do
+        lambda { @shopper.get_item_status }.should raise_error(ArgumentError)
+      end
+      
+      it "should return a hash response" do
+        @shopper.get_item_status({:itemId => 230139965209}).class.should eq(Rebay::Response)
+      end
+      
+      it "should succeed" do
+        @shopper.get_item_status({:itemId => 230139965209}).success?.should be_true
+      end
+    end
+    
+    context "when calling get_shipping_costs" do    
+      it "should fail without args" do
+        lambda { @shopper.get_shipping_costs }.should raise_error(ArgumentError)
+      end
+      
+      it "should return a hash response" do
+        @shopper.get_shipping_costs({:itemId => 230139965209}).class.should eq(Rebay::Response)
+      end
+      
+      it "should succeed" do
+        @shopper.get_shipping_costs({:itemId => 230139965209}).success?.should be_true
+      end
+    end
+    
+    context "when calling get_multiple_items" do    
+      it "should fail without args" do
+        lambda { @shopper.get_multiple_items }.should raise_error(ArgumentError)
+      end
+      
+      it "should return a hash response" do
+        @shopper.get_multiple_items({:itemId => 230139965209}).class.should eq(Rebay::Response)
+      end
+      
+      it "should succeed" do
+        @shopper.get_multiple_items({:itemId => 230139965209}).success?.should be_true
+      end
+    end
+    
+    context "when calling get_user_profile" do     
+      it "should fail without args" do
+        lambda { @shopper.get_user_profile }.should raise_error(ArgumentError)
+      end
+      
+      it "should return a hash response" do
+        @shopper.get_user_profile({:userId => 1}).class.should eq(Rebay::Response)
+      end
+      
+      it "should succeed" do
+        @shopper.get_user_profile({:userId => 1}).success?.should be_true
+      end
+    end
+    
+    context "when calling find_popular_searches" do     
+      it "should fail without args" do
+        lambda { @shopper.find_popular_searches }.should raise_error(ArgumentError)
+      end
+      
+      it "should return a hash response" do
+        @shopper.find_popular_searches({:categoryId => 1}).class.should eq(Rebay::Response)
+      end
+      
+      it "should succeed" do
+        @shopper.find_popular_searches({:categoryId => 1}).success?.should be_true
+      end
+    end
+    
+    context "when calling find_popular_items" do    
+      it "should return a hash response" do
+        @shopper.find_popular_items({:categoryId => 1}).class.should eq(Rebay::Response)
+      end
+      
+      it "should succeed" do
+        @shopper.find_popular_items({:categoryId => 1}).success?.should be_true
+      end
+    end
+    
+    context "when calling find_reviews_and_guides" do      
+      it "should return a hash response" do
+        @shopper.find_reviews_and_guides.class.should eq(Rebay::Response)
+      end
+      
+      it "should succeed" do
+        @shopper.find_reviews_and_guides.success?.should be_true
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+RSpec.configure do |config|
+  config.mock_with :rspec
+end
+
+require File.join(File.dirname(__FILE__), "..", "lib", "rebay")
+
+Rebay::Api.configure do |rebay|
+  rebay.app_id = 'test'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: rebay
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 2
+  version: 1.0.2
+platform: ruby
+authors: 
+- Chuck Collins
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-15 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: chuck.collins@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- init.rb
+- lib/rebay.rb
+- lib/rebay/api.rb
+- lib/rebay/finding.rb
+- lib/rebay/railtie.rb
+- lib/rebay/response.rb
+- lib/rebay/shopping.rb
+- rebay.gemspec
+- spec/api_spec.rb
+- spec/finding_spec.rb
+- spec/response_spec.rb
+- spec/shopping_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/ccollins/rebay
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Client for the RESTful JSON ebay finding and shopping api
+test_files: 
+- spec/api_spec.rb
+- spec/finding_spec.rb
+- spec/response_spec.rb
+- spec/shopping_spec.rb
+- spec/spec_helper.rb