shoppr 0.1.0

data/History

@@ -0,0 +1 @@
+0.1.0 - initial release

data/License

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Squeejee
+
+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.rdoc

@@ -0,0 +1,17 @@
+= shoppr
+
+The Ruby Shopping.com API gem. 
+
+== examples
+  
+See the examples directory.
+
+http://github.com/squeejee/shoppr/tree/master/examples
+
+== docs
+
+http://rdoc.info/projects/squeejee/shoppr
+
+== Copyright
+
+Copyright (c) 2009 Squeejee. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,91 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name              = "shoppr"
+    gem.summary           = %Q{Ruby wrapper for the Shopping.com API}
+    gem.email             = "wynn@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_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')
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "shoppr #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+    
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+    
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/shoppr/rdoc"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+      
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 0

data/lib/shoppr.rb

@@ -0,0 +1,92 @@
+require 'forwardable'
+require 'rubygems'
+require 'active_support'
+
+gem 'roxml'
+require 'roxml'
+
+gem 'mash', '0.0.3'
+require 'mash'
+
+gem 'httparty', '0.4.3'
+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
+    @api_key ||= 'authorized-key'
+  end
+  
+  def self.api_key=(value)
+    @api_key = value
+  end
+  
+  def self.tracking_id
+    @tracking_id ||= '7000610'
+  end
+  
+  def self.tracking_id=(value)
+    @tracking_id = value
+  end
+  
+end
+
+directory = File.expand_path(File.dirname(__FILE__))
+
+
+require File.join(directory, 'shoppr', 'api_exception')
+require File.join(directory, 'shoppr', 'attribute_value')
+require File.join(directory, 'shoppr', 'attribute')
+require File.join(directory, 'shoppr', 'attribute_selection')
+require File.join(directory, 'shoppr', 'image')
+require File.join(directory, 'shoppr', 'feature_rating')
+require File.join(directory, 'shoppr', 'consumer_review')
+require File.join(directory, 'shoppr', 'store')
+require File.join(directory, 'shoppr', 'offer')
+require File.join(directory, 'shoppr', 'category_selection')
+require File.join(directory, 'shoppr', 'client')
+require File.join(directory, 'shoppr', 'client_tracking')
+require File.join(directory, 'shoppr', 'keyword_search')
+require File.join(directory, 'shoppr', 'dynamic_navigation_history')
+require File.join(directory, 'shoppr', 'feature')
+require File.join(directory, 'shoppr', 'feature_group')
+require File.join(directory, 'shoppr', 'offer_selection')
+require File.join(directory, 'shoppr', 'product_selection')
+require File.join(directory, 'shoppr', 'search_history')
+require File.join(directory, 'shoppr', 'server_detail')
+require File.join(directory, 'shoppr', 'product')
+require File.join(directory, 'shoppr', 'category')
+require File.join(directory, 'shoppr', 'generic_response')
+require File.join(directory, 'shoppr', 'general_search_response')

data/lib/shoppr/api_exception.rb

@@ -0,0 +1,8 @@
+module Shoppr
+  class APIException
+    include ROXML
+    xml_reader :type, :from => :attr
+    xml_reader :code, :as => Integer
+    xml_reader :message
+  end
+end

data/lib/shoppr/attribute.rb

@@ -0,0 +1,10 @@
+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'
+  end
+end

data/lib/shoppr/attribute_selection.rb

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,10 @@
+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
+  end
+end

data/lib/shoppr/category.rb

@@ -0,0 +1,14 @@
+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'
+  end
+end

data/lib/shoppr/category_selection.rb

@@ -0,0 +1,10 @@
+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'
+  end
+end

data/lib/shoppr/client.rb

@@ -0,0 +1,47 @@
+module Shoppr
+  class Client
+    include HTTParty
+    format :xml
+    
+    attr_reader :api_key, :tracking_id, :sandboxed, :api_version
+    
+    # Get your api_key found here http://developer.shopping.com/docs/Getting_Started
+    def initialize(sandboxed=false)
+      @api_key ||= Shoppr.api_key
+      @tracking_id ||= Shoppr.tracking_id
+      
+      @sandboxed = sandboxed
+      
+      base_uri = (self.sandboxed? ? 'sandbox.api.shopping.com/publisher/3.0/rest' : 'publisher.usb.api.shopping.com/publisher/3.0/rest')
+      self.class.base_uri base_uri
+    end
+    
+    def sandboxed?
+      !!@sandboxed
+    end
+    
+    def api_version
+      self.class.parser Proc.new {|response| GenericResponse.from_xml(response)}
+      @api_version ||= self.class.get('/').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)))
+    end
+    
+    
+    private
+      def default_options
+        {:apiKey => self.api_key, :trackingId => self.tracking_id}
+      end
+      
+      def prep_query_options(options)
+        opts = {}
+        options.each do |key, value|
+          opts[key.to_s.camelize(:lower)] = value
+        end
+        opts
+      end
+  end
+end

data/lib/shoppr/client_tracking.rb

@@ -0,0 +1,13 @@
+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
+  end
+end

data/lib/shoppr/consumer_review.rb

@@ -0,0 +1,16 @@
+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'
+  end
+end

data/lib/shoppr/dynamic_navigation_history.rb

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,9 @@
+module Shoppr
+  class Feature
+    include ROXML
+    xml_convention {|val| val.camelize(:lower) }
+    xml_reader :name
+    xml_reader :description
+    xml_reader :values, :as => []
+  end
+end

data/lib/shoppr/feature_group.rb

@@ -0,0 +1,9 @@
+module Shoppr
+  class FeatureGroup
+    include ROXML
+    xml_convention {|val| val.camelize(:lower) }
+    xml_reader :name
+    xml_reader :description
+    xml_reader :features, :as => [Feature]
+  end
+end

data/lib/shoppr/feature_rating.rb

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

data/lib/shoppr/general_search_response.rb

@@ -0,0 +1,12 @@
+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'
+  end
+end

data/lib/shoppr/generic_response.rb

@@ -0,0 +1,8 @@
+module Shoppr
+  class GenericResponse
+    include ROXML
+    xml_convention {|val| val.camelize(:lower) }
+    xml_reader :server_detail, :as => ServerDetail
+    xml_reader :exceptions, :as => [APIException], :in => 'exceptions'
+  end
+end