razsell 0.0.10 → 0.0.11

data/Rakefile

@@ -9,15 +9,16 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "razsell"
-    gem.summary = %Q{A gem for getting info about products on a website that has a similar name}
+    gem.summary = %Q{A gem for getting info about products on Zazzle.com}
     gem.description = %Q{Queries Zazzle RSS feed for data.}
     gem.email = "jamal.hansen@gmail.com"
-    gem.homepage = "http://github.com/rubyyot/razsell"
+    gem.homepage = "http://rubyyot.com/razsell"
     gem.authors = ["Jamal Hansen"]
     gem.add_dependency('hpricot', '>= 0.8.1')
     gem.add_development_dependency('cucumber', '>= 0.3.11')
     gem.add_development_dependency('mocha')
     gem.add_development_dependency('shoulda')
+    gem.add_development_dependency('reek')
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
 
@@ -47,7 +48,7 @@ end
 
 begin
   require 'cucumber/rake/task'
-  Cucumber::Rake::Task.new(:features) 
+  Cucumber::Rake::Task.new(:features)
 rescue LoadError
   task :features do
     abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
@@ -80,3 +81,11 @@ namespace :products do
     results.items.sort {|x,y| x.title <=> y.title }.each { |p| puts p.title }
   end
 end
+
+require 'reek/rake/task'
+
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = false
+end
+
+

data/VERSION

@@ -1 +1 @@
-0.0.10
+0.0.11

data/lib/razsell.rb

@@ -4,7 +4,7 @@ require 'razsell/item'
 require 'razsell/query'
 
 
-module Razsell
+module Razsell::Mixin
   def request query, opts={}
     engine = Razsell::Engine.new opts
     engine.request(query)
@@ -15,4 +15,8 @@ module Razsell
     query = Razsell::Query.new.for_artist(artist)
     engine.request(query)
   end
+end
+
+module Razsell
+  extend Razsell::Mixin
 end

data/lib/razsell/constants/product_types.rb

@@ -1,5 +1,6 @@
 
 module Razsell
+  # TODO check to ensure that this matches with the current product type listing
   module ProductTypes
     BUMPER_STICKER ="128"
     CARD = "137"

data/lib/razsell/engine.rb

@@ -1,9 +1,11 @@
 require 'razsell/http_service'
 
 module Razsell
+  # Use the engine class to make requests and receive results
   class Engine
     def initialize opts={}
-      @http_service = get_http_service opts
+      @opts = opts
+      @http_service = get_http_service
     end
 
     def request query
@@ -18,8 +20,8 @@ module Razsell
       results
     end
 
-    def get_http_service opts
-      opts[:http_service] ? opts[:http_service] : Razsell::HttpService.new
+    def get_http_service
+      @opts[:http_service] || Razsell::HttpService.new
     end
   end
 end

data/lib/razsell/http_service.rb

@@ -1,6 +1,7 @@
 require 'open-uri'
 
 module Razsell
+  # Class that wraps http calls
   class HttpService
     def get query
       if query.class == String

data/lib/razsell/item.rb

@@ -1,5 +1,6 @@
-
 module Razsell
+  
+  # Represents a single item returned in the rss feed
   class Item
     def initialize values={}
       @values = values

data/lib/razsell/query.rb

@@ -2,6 +2,28 @@ require 'razsell/constants'
 require 'cgi'
 
 module Razsell
+
+  # Allows you to specify the result set you would like returned
+  #
+  #  === Attributes that you can specify
+  #  * keywords
+  #  * product_line
+  #  * product_type  (see Razsell::ProductTypes)
+  #  * sort_type  (see Razsell::SortMethods)
+  #  * sort_period  (see Razsell::SortPeriods)
+  #  * image_size  (see Razsell::ImageSizes)
+  #  * image_background_color
+  #
+  # Additionally you can use 
+  #
+  #   query = Razsell::Query.new.for_artist('some_zazzle_artist')
+  #
+  # to specify the artist.  Or if you have a link to a zazzle item you can get the details with:
+  #
+  #   query = Razsell::Query.new.for_item_url('http://www.zazzle.com/some-item-354678976578865')
+  #
+  # Once you have built your query, use Razsell#request(query) to get the results.
+
   class Query
     include Razsell::SortMethods
     include Razsell::ImageSizes
@@ -34,9 +56,6 @@ module Razsell
     def strip_item_number_from url
       url.scan(/\d*$/)[0]
     end
-    #def add_criteria name, value
-    #  this.send name, value
-    #end
 
     def base_url
       return "http://feed.zazzle.com/#{@artist}/rss" if @artist
@@ -44,7 +63,7 @@ module Razsell
     end
 
     def to_querystring
-      @querystring.to_a.map { |a| build_pair(a) }.sort {|x,y| x <=> y }.delete_if { |pair| pair == "" }.join("&")
+      @querystring.to_a.map { |element| build_pair(element) }.sort {|first, second| first <=> second }.delete_if { |pair| pair == "" }.join("&")
     end
 
     def to_url
@@ -52,27 +71,25 @@ module Razsell
     end
 
     def advance_page
-      return false if @querystring[:page] >= page_limit
+      cur_page = @querystring[:page]
+      return false if cur_page >= page_limit
 
-      @querystring[:page] =  @querystring[:page] + 1
+      @querystring[:page] =  cur_page + 1
       true
     end
 
     private
       def build_pair pair
-        return "#{get_querystring_identifier(pair[0])}=#{format_value(pair[1])}" if pair[1]
-        ""
-      end
-
-      def get_querystring_identifier key
-        @keys[key] if @keys[key]
+        key, value = pair
+        return "" unless value
+        
+        "#{@keys[key]}=#{format_value(value)}"
       end
 
       def format_value value
         CGI.escape(value.to_s)
       end
 
-      
       def set_default_page_limit
         @page_limit = 5
       end
@@ -103,8 +120,6 @@ module Razsell
         end
       end
 
-
-
       attr_querystring_read :keywords, :product_line, :product_type,
         :sort_type, :sort_period, :page, :items_per_page,
         :feed_type, :image_size, :image_background_color,

data/lib/razsell/results.rb

@@ -1,6 +1,9 @@
 require 'hpricot'
 
 module Razsell
+
+  # This class returns the query results
+
   class Results
     attr_accessor :items, :result_count, :items_per_page
 
@@ -22,18 +25,16 @@ module Razsell
     end
 
     def build_hash_from item
-      item_hash = {}
-      item_hash[:title] = strip_cdata(item.at("title").inner_html)
-      item_hash[:guid] = item.at("guid").inner_html
-      item_hash[:pub_date] = Time.parse(item.at("pubDate").inner_html)
-      item_hash[:link] = item.at("link").inner_html
-      item_hash[:author] = item.at("author").inner_html
-      item_hash[:description] = strip_cdata(item.at("media:description").inner_html)
-      item_hash[:thumbnail_url] = item.at("media:thumbnail")['url']
-      item_hash[:content_url] = item.at("media:content")['url']
-      item_hash[:keywords] = split_keywords(item.at("media:keywords").inner_html)
-      item_hash[:rating] = item.at("media:rating").inner_html
-      item_hash
+      { title: strip_cdata(item.at("title").inner_html),
+        guid: item.at("guid").inner_html,
+        pub_date: Time.parse(item.at("pubDate").inner_html),
+        link: item.at("link").inner_html,
+        author: item.at("author").inner_html,
+        description: strip_cdata(item.at("media:description").inner_html),
+        thumbnail_url: item.at("media:thumbnail")['url'],
+        content_url: item.at("media:content")['url'],
+        keywords: split_keywords(item.at("media:keywords").inner_html),
+        rating: item.at("media:rating").inner_html }
     end
 
     def split_keywords words

data/razsell.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{razsell}
-  s.version = "0.0.10"
+  s.version = "0.0.11"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jamal Hansen"]
-  s.date = %q{2010-02-18}
+  s.date = %q{2010-03-14}
   s.description = %q{Queries Zazzle RSS feed for data.}
   s.email = %q{jamal.hansen@gmail.com}
   s.extra_rdoc_files = [
@@ -54,11 +54,11 @@ Gem::Specification.new do |s|
      "test/results_test.rb",
      "test/test_helper.rb"
   ]
-  s.homepage = %q{http://github.com/rubyyot/razsell}
+  s.homepage = %q{http://rubyyot.com/razsell}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{A gem for getting info about products on a website that has a similar name}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A gem for getting info about products on Zazzle.com}
   s.test_files = [
     "test/product_types_test.rb",
      "test/fixtures.rb",
@@ -78,17 +78,20 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<cucumber>, [">= 0.3.11"])
       s.add_development_dependency(%q<mocha>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<reek>, [">= 0"])
     else
       s.add_dependency(%q<hpricot>, [">= 0.8.1"])
       s.add_dependency(%q<cucumber>, [">= 0.3.11"])
       s.add_dependency(%q<mocha>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<reek>, [">= 0"])
     end
   else
     s.add_dependency(%q<hpricot>, [">= 0.8.1"])
     s.add_dependency(%q<cucumber>, [">= 0.3.11"])
     s.add_dependency(%q<mocha>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<reek>, [">= 0"])
   end
 end
 

data/test/razsell_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
-class RazsellTest < Test::Unit::TestCase
-  include Razsell
+class RazsellMixinTest < Test::Unit::TestCase
+  include Razsell::Mixin
 
   context "basic operations" do
     setup do
@@ -17,3 +17,19 @@ class RazsellTest < Test::Unit::TestCase
     end
   end
 end
+
+class RazsellNonMixinTest < Test::Unit::TestCase
+  context "basic operations" do
+    setup do
+      @query = Razsell::Query.new
+    end
+
+    should "return results" do
+      http_service = Razsell::HttpService.new
+      http_service.expects(:get).once.returns("")
+
+      result = Razsell.request @query, :http_service => http_service
+      assert_equal Razsell::Results, result.class
+    end
+  end
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: razsell
 version: !ruby/object:Gem::Version 
-  version: 0.0.10
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 11
+  version: 0.0.11
 platform: ruby
 authors: 
 - Jamal Hansen
@@ -9,49 +14,73 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-18 00:00:00 -06:00
+date: 2010-03-14 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hpricot
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 1
         version: 0.8.1
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: cucumber
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 11
         version: 0.3.11
-    version: 
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: mocha
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: shoulda
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: reek
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id005
 description: Queries Zazzle RSS feed for data.
 email: jamal.hansen@gmail.com
 executables: []
@@ -99,7 +128,7 @@ files:
 - test/results_test.rb
 - test/test_helper.rb
 has_rdoc: true
-homepage: http://github.com/rubyyot/razsell
+homepage: http://rubyyot.com/razsell
 licenses: []
 
 post_install_message: 
@@ -111,21 +140,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: A gem for getting info about products on a website that has a similar name
+summary: A gem for getting info about products on Zazzle.com
 test_files: 
 - test/product_types_test.rb
 - test/fixtures.rb