shoppr 0.1.1 → 0.2.3

data/README.markdown

@@ -0,0 +1,40 @@
+# shoppr
+
+The Ruby Shopping.com API gem. 
+
+## Installation
+
+    sudo gem install shoppr
+    
+## Usage
+
+To use the Shopping.com API, you'll need an [API key]( http://developer.shopping.com/docs/Getting_Started)
+    
+    # Set up your API key
+    Shoppr.api_key = 'OU812'
+    
+then just create a client
+    
+    client = Shoppr::Client.new
+    
+or if you want to use the sandbox test environment you can do so without an API key:
+
+    client = Shoppr::Client.new(true)
+    
+### Searching for products by keyword
+
+    client.search(:keyword => 'nikon')
+
+### Searching for products by keyword showing product reviews
+
+    client.search(:keyword => 'nikon', :show_product_reviews => true)
+    
+More scenario examples can be found on the [shopping.com API site](http://developer.shopping.com/docs/API_Use_Cases)
+
+## docs
+
+http://rdoc.info/projects/squeejee/shoppr
+
+## Copyright
+
+Copyright (c) 2009 Squeejee. See LICENSE for details.

data/Rakefile

@@ -6,20 +6,20 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name              = "shoppr"
     gem.summary           = %Q{Ruby wrapper for the Shopping.com API}
-    gem.email             = "wynn@squeejee.com"
+    gem.email             = "jim@squeejee.com"
     gem.homepage          = "http://github.com/squeejee/shoppr"
     gem.authors           = ["Wynn Netherland", "Jim Mulholland"]
     gem.rubyforge_project = "shoppr"
     gem.files             = FileList["[A-Z]*", "{examples,lib,test}/**/*"]
     
-    gem.add_dependency('mash', '0.0.3')
-    gem.add_dependency('httparty', '~> 0.4.3')
+    gem.add_dependency('hashie', '0.2.0')
+    gem.add_dependency('httparty', '>= 0.5.0')
     
     gem.add_development_dependency('thoughtbot-shoulda')
     gem.add_development_dependency('jeremymcanally-matchy')
     gem.add_development_dependency('mocha')
     gem.add_development_dependency('fakeweb')
-    gem.add_development_dependency('mash')
+    gem.add_development_dependency('hashie')
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
@@ -74,3 +74,8 @@ begin
 rescue LoadError
   puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
 end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r shoppr.rb"
+end

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:major: 0
-:minor: 1
 :build: 
-:patch: 1
+:major: 0
+:minor: 2
+:patch: 3

data/lib/shoppr.rb

@@ -1,48 +1,9 @@
 require 'forwardable'
 require 'rubygems'
 require 'active_support'
-
-gem 'roxml'
-require 'roxml'
-
-gem 'mash', '0.0.3'
-require 'mash'
-
-gem 'httparty', '~> 0.4.3'
+require 'hashie'
 require 'httparty'
 
-module HTTParty
-  module ClassMethods
-    def parser(customer_parser)
-      default_options[:parser] = customer_parser
-    end
-  end
-  
-  class Request
-    def parse_response(body)
-      return nil if body.nil? or body.empty?
-      if options[:parser].blank?
-        case format
-          when :xml
-            Crack::XML.parse(body)
-          when :json
-            Crack::JSON.parse(body)
-          when :yaml
-            YAML::load(body)
-          else
-            body
-          end
-      else
-        if options[:parser].is_a?(Proc)
-          options[:parser].call(body)
-        else
-          body
-        end
-      end
-    end
-  end
-end
-
 module Shoppr
   
   def self.api_key
@@ -61,6 +22,18 @@ module Shoppr
     @tracking_id = value
   end
   
+  def self.map_mash_attrs(obj, mash)
+    attrs = mash.map {|k,v| k.underscore}
+
+    obj.class_eval do
+      attr_accessor *attrs
+    end
+     
+    mash.each do |k,v|
+      obj.send("#{k.underscore}=", v)
+    end
+  end
+  
 end
 
 directory = File.expand_path(File.dirname(__FILE__))

data/lib/shoppr/api_exception.rb

@@ -1,8 +1,9 @@
 module Shoppr
-  class APIException
-    include ROXML
-    xml_reader :type, :from => :attr
-    xml_reader :code, :as => Integer
-    xml_reader :message
+  class APIException  
+          
+    def initialize(cat_mash)        
+      Shoppr.map_mash_attrs(self, cat_mash)
+    end
+    
   end
 end

data/lib/shoppr/attribute.rb

@@ -1,10 +1,16 @@
 module Shoppr
-  class Attribute
-    include ROXML
-    xml_convention {|val| val.camelize(:lower) }
-    xml_reader :id, :from => '@id'
-    xml_reader :name
-    xml_reader :attribute_url, :from => 'attributeURL'
-    xml_reader :attribute_values, :as => [AttributeValue], :from => 'attributeValues'
+  class Attribute   
+      
+    def initialize(cat_mash)    
+      Shoppr.map_mash_attrs(self, cat_mash)
+      
+      if self.attribute_values.attributeValue.is_a?(Array)      
+        @attribute_values = self.attribute_values.attributeValue.map {|f| AttributeValue.new(f)}
+      elsif self.attribute_values.attributeValue
+        @attribute_values = [AttributeValue.new(self.attribute_values.attributeValue)]
+      else
+        @attribute_values = []
+      end
+    end
   end
 end

data/lib/shoppr/attribute_selection.rb

@@ -1,10 +1,4 @@
 module Shoppr
   class AttributeSelection
-    include ROXML
-    xml_convention {|val| val.camelize(:lower) }
-    xml_reader :id, :from => '@id'
-    xml_reader :name
-    xml_reader :attribute_value_url, :from => 'attributeValueURL'
-    xml_reader :dropped?, :from => :attr
   end
 end

data/lib/shoppr/attribute_value.rb

@@ -1,10 +1,9 @@
 module Shoppr
   class AttributeValue
-    include ROXML
-    xml_convention {|val| val.camelize(:lower) }
-    xml_reader :id, :from => '@id'
-    xml_reader :name
-    xml_reader :attribute_value_url, :from => 'attributeValueURL'
-    xml_reader :matching_items_count, :as => Integer
+    
+    def initialize(cat_mash)    
+      Shoppr.map_mash_attrs(self, cat_mash)
+    end
+    
   end
 end

data/lib/shoppr/category.rb

@@ -1,14 +1,32 @@
 module Shoppr
   class Category
-    include ROXML
-    xml_convention {|val| val.camelize(:lower) }
-    xml_reader :id, :from => '@id', :as => Integer
-    xml_reader :name
-    xml_reader :category_url, :from => 'categoryURL'
-    xml_reader :content_type
-    xml_reader :products, :as => [Product], :from => 'items/product'
-    xml_reader :offers, :as => [Offer], :from => 'items/offer'
-    xml_reader :attributes, :as => [Attribute], :in => 'attributes'
-    xml_reader :categories, :as => [Category], :in => 'categories'
+    
+    attr_accessor :attributes, :products
+    
+    def initialize(cat_mash)        
+      Shoppr.map_mash_attrs(self, cat_mash)
+      
+      if self.attributes
+        if self.attributes.attribute
+          @attributes = self.attributes.attribute.map {|attribute| Attribute.new(attribute) } 
+        else
+          @attributes = []
+        end
+      else
+        @attributes = []
+      end
+    
+      if self.items
+        if self.items.product.is_a?(Array)
+          @products = self.items.product.map {|product| Product.new(product) } 
+        else
+          @products = self.items.product ? [Product.new(self.items.product)] : []
+        end
+      else
+        @products = []
+      end
+      
+    end
+    
   end
 end

data/lib/shoppr/category_selection.rb

@@ -1,10 +1,8 @@
 module Shoppr
-  class CategorySelection
-    include ROXML
-    xml_convention {|val| val.camelize(:lower) }
-    xml_reader :id, :from => '@id', :as => Integer
-    xml_reader :name
-    xml_reader :category_url, :from => 'categoryURL'
-    xml_reader :dropped?, :from => '@dropped'
+  class CategorySelection    
+    
+    def initialize(cat_mash)        
+      Shoppr.map_mash_attrs(self, cat_mash)
+    end
   end
 end

data/lib/shoppr/client.rb

@@ -20,20 +20,26 @@ module Shoppr
       !!@sandboxed
     end
     
+    def generic_response
+      @generic_response ||= GenericResponse.new()
+    end
+    
     def api_version
-      self.class.parser Proc.new {|response| GenericResponse.from_xml(response)}
-      @api_version ||= self.class.get('/').server_detail.api_version
+      # self.class.parser Proc.new {|response| GenericResponse.from_xml(response)}
+      # @api_version ||= self.class.get('/').server_detail.api_version
+      @api_version ||= generic_response.server_detail.api_version
+      
     end
     
     def search(options={})
-      self.class.parser Proc.new {|response| GeneralSearchResponse.from_xml(response)}
-      self.class.get('/GeneralSearch', :query => default_options.merge(prep_query_options(options)))
+      # self.class.parser Proc.new {|response| GeneralSearchResponse.parse_search_results(response)}
+      response = GeneralSearchResponse.new(default_options.merge(prep_query_options(options))) 
     end
     
     
     private
       def default_options
-        {:apiKey => self.api_key, :trackingId => self.tracking_id}
+        {:apiKey => self.api_key, :trackingId => self.tracking_id, :groupItemsByCategory => true}
       end
       
       def prep_query_options(options)

data/lib/shoppr/client_tracking.rb

@@ -1,13 +1,8 @@
 module Shoppr
   class ClientTracking
-    include ROXML
-    xml_convention {|val| val.camelize(:lower) }
-    xml_reader :height, :as => Integer, :from => '@height'
-    xml_reader :width, :as => Integer, :from => '@width'
-    xml_reader :type, :from => '@type'
-    xml_reader :source_url, :from => 'sourceURL'
-    xml_reader :href_url, :from => 'hrefURL'
-    xml_reader :title_text
-    xml_reader :alt_text
+    
+    def initialize(cat_mash)    
+      Shoppr.map_mash_attrs(self, cat_mash)
+    end
   end
 end

data/lib/shoppr/consumer_review.rb

@@ -1,16 +1,13 @@
 module Shoppr
   class ConsumerReview
-    include ROXML
-    xml_convention {|val| val.camelize(:lower) }
-    xml_reader :author_id, :from => 'authorID'
-    xml_reader :post_date, :as => Time
-    xml_reader :rating, :as => Float, :from => 'rating/overallRating'
-    xml_reader :feature_ratings, :as => [FeatureRating], :from => 'rating/featureRating'
-    xml_reader :summary
-    xml_reader :bottom_line
-    xml_reader :pros
-    xml_reader :cons
-    xml_reader :content, :from => 'reviewContent'
-    xml_reader :url, :from => 'fullReviewURL'
+    
+    attr_accessor :featured_ratings
+    
+    def initialize(cat_mash)   
+      Shoppr.map_mash_attrs(self, cat_mash)
+            
+      @rating = self.rating.overallRating
+    end
+    
   end
 end

data/lib/shoppr/dynamic_navigation_history.rb

@@ -1,8 +1,4 @@
 module Shoppr
   class DynamicNavigationHistory
-    include ROXML
-    xml_convention {|val| val.camelize(:lower) }
-    xml_reader :keyword_search, :as => KeywordSearch
-    xml_reader :attribute_selection, :as => AttributeSelection
   end
 end

data/lib/shoppr/feature.rb

@@ -1,9 +1,17 @@
 module Shoppr
   class Feature
-    include ROXML
-    xml_convention {|val| val.camelize(:lower) }
-    xml_reader :name
-    xml_reader :description
-    xml_reader :values, :as => []
+    
+    attr_accessor :values
+    def initialize(cat_mash)   
+      Shoppr.map_mash_attrs(self, cat_mash)
+      
+      if self.value.is_a?(Array)
+        @values = self.value.map {|value| value } 
+      else
+        @values = [self.value]
+      end
+      
+    end
+    
   end
 end

data/lib/shoppr/feature_group.rb

@@ -1,9 +1,15 @@
 module Shoppr
   class FeatureGroup
-    include ROXML
-    xml_convention {|val| val.camelize(:lower) }
-    xml_reader :name
-    xml_reader :description
-    xml_reader :features, :as => [Feature]
+    
+    attr_accessor :features
+    def initialize(cat_mash)   
+      Shoppr.map_mash_attrs(self, cat_mash)
+
+      if self.feature.is_a?(Array)      
+        @features = self.feature.map {|f| Feature.new(f)}
+      else
+        @features = [Feature.new(self.feature)]
+      end
+    end
   end
 end

data/lib/shoppr/feature_rating.rb

@@ -1,8 +1,9 @@
 module Shoppr
-  class FeatureRating
-    include ROXML
-    xml_convention {|val| val.camelize(:lower) }
-    xml_reader :name
-    xml_reader :value, :as => Float
+  class FeatureRating         
+      
+    def initialize(cat_mash)        
+      Shoppr.map_mash_attrs(self, cat_mash)
+    end
+      
   end
 end

data/lib/shoppr/general_search_response.rb

@@ -1,12 +1,29 @@
 module Shoppr
   class GeneralSearchResponse
-    include ROXML
-    xml_convention {|val| val.camelize(:lower) }
-    xml_reader :related_terms, :as => [], :in => 'related_terms', :from => 'term'
-    xml_reader :server_detail, :as => ServerDetail
-    xml_reader :exceptions, :as => [APIException], :in => 'exceptions'
-    xml_reader :client_tracking, :as => ClientTracking
-    xml_reader :search_history, :as => SearchHistory
-    xml_reader :categories, :as => [Category], :in => 'categories'
+    
+    def initialize(options={})
+      response = Shoppr::Client.get('/GeneralSearch', :query => options)
+      h = Hashie::Mash.new(response["GeneralSearchResponse"])     
+      
+      Shoppr.map_mash_attrs(self, h)
+      
+      if self.categories.category.is_a?(Array)
+        @categories = self.categories.category.map {|category| Category.new(category) } 
+      else
+        @categories = [Category.new(self.categories.category)]
+      end
+      
+      if self.exceptions.exception.is_a?(Array)
+        @exceptions = self.exceptions.exception.map {|exception| APIException.new(exception) } 
+      else
+        @exceptions = [APIException.new(self.exceptions.exception)]
+      end
+      
+      @server_detail = ServerDetail.new(self.server_detail)  
+      @client_tracking = ClientTracking.new(self.client_tracking)
+      @related_terms = self.related_terms ? self.related_terms.term : []
+      @search_history = SearchHistory.new(self.search_history)
+    end
+            
   end
 end