rubyyot-razsell 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,7 @@
+tmp*
+log*
+*[~#]
+optparse_example.rb
+pkg/*
+coverage*
+nbproject*

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jamal Hansen
+
+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,10 @@
+= razsell
+
+A feed parser for Zazzle.com written in Ruby.  Raszell allows you to query zazzle for information on products.
+
+== Copyright
+
+Copyright (c) 2009 Jamal Hansen.
+Jamal Hansen and razsell are not affiliated with Zazzle.com.
+Zazzle.com is Copyright (c) Zazzle.com.
+See LICENSE for details for razsell.

data/Rakefile

@@ -0,0 +1,68 @@
+require 'rubygems'
+require 'rake'
+
+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.email = "jamal.hansen@gmail.com"
+    gem.homepage = "http://github.com/rubyyot/razsell"
+    gem.authors = ["Jamal Hansen"]
+    gem.add_dependency('hpricot')
+    gem.add_development_dependency('cucumber', '>= 0.3.11')
+    gem.add_development_dependency('mocha')
+    gem.add_development_dependency('technicalpickles-shoulda')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+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
+
+begin
+  require 'cucumber/rake/task'
+  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"
+  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 = "razsell #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/features/razsell.feature

@@ -0,0 +1,18 @@
+Feature: Query Image Link
+  In order to get a link to an image of a product
+  A user of razsell
+  Will query a product image link
+
+  Scenario: Querying the keyword Rockstar for the artist Kung Fu Tees returns an image url
+    Given a desire to query the artist "KungFuTees" on Zazzle
+    When I query "rockstar"
+    Then there should be "3" items
+    And the items should have the keyword "Rockstar"
+    And the items should have a link to an image
+
+  Scenario: Querying the keyword Rockstar for the artist Kung Fu Tees returns a thumbnail url
+    Given a desire to query the artist "KungFuTees" on Zazzle
+    When I query "rockstar"
+    Then there should be "3" items
+    And the items should have the keyword "Rockstar"
+    And the items should have a link to a thumbnail

data/features/step_definitions/razsell_steps.rb

@@ -0,0 +1,40 @@
+
+Given /^a desire to query the artist "([^\"]*)" on Zazzle$/ do |artist|
+  @artist = artist
+  @sut = RazsellMixedIn.new
+  @query = Razsell::Query.new.for_artist(artist)
+end
+
+When /^the "([^\"]*)" is "([^\"]*)"$/ do |name, value|
+  @query.add_criteria(name, value)
+end
+
+When /^I query "([^\"]*)"$/ do |fixture|
+  http_service = Razsell::HttpService.new
+  http_service.expects(:get).once.returns(feed(fixture))
+
+  @result = @sut.request(@query, :http_service => http_service)
+end
+
+Then /^there should be "([^\"]*)" items/ do |item_count|
+  assert_equal item_count.to_i, @result.item_count
+end
+
+Then /^the items should have the keyword "([^\"]*)"$/ do |keyword|
+  @result.items.each do |item|
+    assert item.title.include? keyword
+  end
+end
+
+Then /^the items should have a link to an image$/ do
+  @result.items.each do |item|
+    assert(/http:\/\/rlv.zcache.com\/.*\.jpg/ =~ item.content_url)
+  end
+end
+
+Then /^the items should have a link to a thumbnail$/ do
+  @result.items.each do |item|
+    assert(/http:\/\/rlv.zcache.com\/.*\.jpg/ =~ item.thumbnail_url)
+  end
+end
+

data/features/support/env.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../test')
+require 'razsell'
+require 'mocha'
+require 'fixtures'
+include Fixtures
+
+require 'test/unit/assertions'
+
+World(Test::Unit::Assertions)
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'razsell_mixed_in'

data/features/support/razsell_mixed_in.rb

@@ -0,0 +1,5 @@
+require 'razsell'
+
+class RazsellMixedIn
+  include Razsell
+end

data/lib/constants/image_sizes.rb

@@ -0,0 +1,10 @@
+
+module Razsell
+  module ImageSizes
+    TINY = 'tiny'
+    SMALL = 'small'
+    MEDIUM = 'medium'
+    LARGE = 'large'
+    HUGE = 'huge'
+  end
+end

data/lib/constants/product_types.rb

@@ -0,0 +1,30 @@
+
+module Razsell
+  module ProductTypes
+    BUMPER_STICKER ="128"
+    CARD = "137"
+    MOUSE_PAD = "144"
+    BUTTON = "145"
+    KEYCHAIN = "146"
+    MAGNET = "147"
+    HAT = "148"
+    BAG = "149"
+    TIE = "151"
+    PHOTO_SCULPTURE = "153"
+    APRON ="154"
+    PHOTO_PRINT = "156"
+    CALENDAR = "158"
+    SHOES = "167"
+    MUG = "168"
+    POSTAGE_STAMP = "172"
+    SKATEBOARD = "186"
+    STICKER = "217"
+    POSTER = "228"
+    EMBROIDERED_SHIRT = "231"
+    EMBROIDERED_BAG = "232"
+    EMBROIDERED_HAT = "233"
+    T_SHIRT = "235"
+    POSTCARD = "239"
+    PROFILE_CARD = "240"
+  end
+end

data/lib/constants/sort_methods.rb

@@ -0,0 +1,7 @@
+
+module Razsell
+  module SortMethods
+    POPULARITY = 'popularity'
+    DATE_CREATED = 'date_created'
+  end
+end

data/lib/constants/sort_periods.rb

@@ -0,0 +1,9 @@
+
+module Razsell
+  module SortPeriods
+    ALL_TIME = '0'
+    TODAY = '1'
+    THIS_WEEK = '7'
+    THIS_MONTH = '30'
+  end
+end

data/lib/constants.rb

@@ -0,0 +1,5 @@
+require 'constants/sort_methods'
+require 'constants/image_sizes'
+require 'constants/product_types'
+require 'constants/sort_periods'
+

data/lib/engine.rb

@@ -0,0 +1,25 @@
+require 'http_service'
+
+module Razsell
+  class Engine
+    def initialize opts={}
+      @http_service = get_http_service opts
+    end
+
+    def request query
+      feed = @http_service.get query
+      results = Razsell::Results.new feed
+
+      while results.has_more_pages? && query.advance_page
+        feed = @http_service.get query
+        results.add(feed)
+      end
+
+      results
+    end
+
+    def get_http_service opts
+      opts[:http_service] ? opts[:http_service] : Razsell::HttpService.new
+    end
+  end
+end

data/lib/http_service.rb

@@ -0,0 +1,8 @@
+
+module Razsell
+  class HttpService
+    def get query
+      
+    end
+  end
+end

data/lib/item.rb

@@ -0,0 +1,19 @@
+
+module Razsell
+  class Item
+    def initialize values={}
+      @values = values
+      self.class.class_eval do
+        add_attributes values
+      end
+    end
+
+    def self.add_attributes values
+      values.each_key do |key|
+        define_method "#{key.to_s}" do
+          @values[key]
+        end\
+      end
+    end
+  end
+end

data/lib/query.rb

@@ -0,0 +1,107 @@
+require 'constants'
+require 'cgi'
+
+module Razsell
+  class Query
+    include Razsell::SortMethods
+    include Razsell::ImageSizes
+
+    attr_accessor :page_limit
+    attr_reader :artist
+
+    def initialize *args
+      set_default_page_limit
+\
+      default_criteria
+
+      @keys = { :keywords => 'qs', :product_line => 'cg', :product_type => 'pt',
+        :sort_type => 'st', :sort_period => 'sp', :page => 'pg', :items_per_page => 'ps',
+        :feed_type => 'ft', :image_size => 'isz', :image_background_color => 'bg',
+        :opensearch => 'opensearch', :source => 'src'}
+    end
+
+    def for_artist artist
+      @artist = artist
+      self
+    end
+
+    #def add_criteria name, value
+    #  this.send name, value
+    #end
+
+    def base_url
+      return "http://feed.zazzle.com/#{@artist}/rss" if @artist
+      "http://feed.zazzle.com/rss"
+    end
+
+    def to_querystring
+      @querystring.to_a.map { |a| build_pair(a) }.sort {|x,y| x <=> y }.delete_if { |pair| pair == "" }.join("&")
+    end
+
+    def to_url
+      "#{base_url}?#{to_querystring}"
+    end
+
+    def advance_page
+      return false if @querystring[:page] >= page_limit
+
+      @querystring[:page] =  @querystring[: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]
+      end
+
+      def format_value value
+        CGI.escape(value.to_s)
+      end
+
+      
+      def set_default_page_limit
+        @page_limit = 5
+      end
+
+      def default_criteria
+        @querystring = {:page => 1, :sort_type => POPULARITY,
+          :items_per_page => 50, :image_background_color => "FFFFFF",
+          :image_size => LARGE, :source => 'razsell', :opensearch => 1, :feed_type => "rss"}
+      end
+
+      def self.attr_querystring_read(*args)
+        @querystring = {}
+
+        args.each do |attribute|
+          define_method "#{attribute}" do
+            @querystring[attribute]
+          end
+        end
+      end
+
+      def self.attr_querystring_write(*args)
+        @querystring = {}
+
+        args.each do |attribute|
+          define_method "#{attribute}=" do |value|
+            @querystring[attribute] = value
+          end\
+        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,
+        :opensearch, :source
+      attr_querystring_write :keywords, :product_line, :product_type,
+        :sort_type, :sort_period, :image_size, :image_background_color
+
+  end
+end

data/lib/razsell.rb

@@ -0,0 +1,11 @@
+require 'query'
+require 'results'
+require 'item'
+require 'engine'
+
+module Razsell
+  def request query, opts={}
+    engine = Razsell::Engine.new opts
+    engine.request(query)
+  end
+end

data/lib/results.rb

@@ -0,0 +1,70 @@
+require 'hpricot'
+
+module Razsell
+  class Results
+    attr_accessor :items, :result_count, :items_per_page
+
+    def initialize feed
+      @start_index = 0
+      @items_per_page = 0
+      @result_count = 0
+      @items = []
+      
+      populate_items feed
+    end
+
+    def add feed
+      populate_items feed
+    end
+
+    def item_count
+      @items.length
+    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] = DateTime.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
+    end
+
+    def split_keywords words
+      return [] if (!words || words == "")
+
+      words.split(",").map { |s| s.strip }
+    end
+
+    def strip_cdata str
+      str[9..-4]
+    end
+
+    def has_more_pages?
+      return false unless (@start_index && @items_per_page && @result_count)
+      (@start_index + @items_per_page) < @result_count
+    end
+
+    private
+      def populate_items feed
+        doc = Hpricot::XML(feed)
+        rc = doc.at("opensearch:totalResults")
+        ipp = doc.at("opensearch:itemsPerPage")
+        si = doc.at("opensearch:startIndex")
+
+        @result_count = rc.inner_html.to_i if rc
+        @items_per_page = ipp.inner_html.to_i if ipp
+        @start_index = si.inner_html.to_i if si
+
+        doc.search("item").each do |item|
+          @items << Razsell::Item.new(build_hash_from(item))
+        end
+      end
+  end
+end

data/test/engine_test.rb

@@ -0,0 +1,55 @@
+require 'test_helper'
+require 'engine'
+require 'http_service'
+
+module Razsell
+  class EngineTest < Test::Unit::TestCase
+    context "basic operations" do
+      should "initialize without parameters" do
+        engine = Razsell::Engine.new 
+      end
+
+      should "accept http_service" do
+        http_service = Razsell::HttpService.new
+        http_service.expects(:get).once.returns("")
+
+        engine = Razsell::Engine.new :http_service => http_service
+        query = Razsell::Query.new
+
+        engine.request query
+      end
+
+      context "getting results" do
+        setup do
+          http_service = Razsell::HttpService.new
+          http_service.expects(:get).once.returns(feed("rockstar"))
+
+          engine = Razsell::Engine.new :http_service => http_service
+          query = Razsell::Query.new
+
+          @result = engine.request query
+        end
+
+        should "have total item count" do
+          assert_equal 3, @result.item_count
+        end
+      end
+
+      context "Getting multiple pages of results" do
+        setup do
+          http_service = Razsell::HttpService.new
+          http_service.expects(:get).twice.returns(feed("page_1"), feed("page_2"))
+
+          engine = Razsell::Engine.new :http_service => http_service
+          query = Razsell::Query.new
+
+          @result = engine.request query
+        end
+
+        should "have total item count" do
+          assert_equal 5, @result.item_count
+        end
+      end
+    end
+  end
+end