kosher 0.1.12 → 0.2.0

data/README.md

@@ -1,6 +1,33 @@
 Kosher
 ======
 
-Kosher wraps Amazon in a loving embrace.
+Kosher models an offer by a bookseller.
 
-![Walter Benjamin](https://github.com/papercavalier/kosher/raw/master/walter_benjamin.jpg)
+It knows if the offer is good or bad. It also knows if the offer is
+better than another offer. It is somewhat overengineered.
+
+![Booksellers](http://upload.wikimedia.org/wikipedia/commons/thumb/b/b9/Bucharest_booksellers_2.jpg/600px-Bucharest_booksellers_2.jpg)
+
+Usage
+-----
+
+    include Kosher
+
+    offer = Offer.new(1234,
+                       Seller.new('ABCDEF',
+                                  'John Doe Books',
+                                  4.8),
+                       Condition.new(1),
+                       Description.new('A fine copy'),
+                       48,
+                       1000,
+                       399,
+                       'USD',
+                       'http://bookseller.com/listings/1234'
+
+    offer.kosher?
+    => true
+
+    offer.description = "Withdrawn library book"
+    offer.kosher?
+    => false

data/Rakefile

@@ -9,4 +9,3 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
 end
 
 task :default => :spec
-

data/kosher.gemspec

@@ -14,16 +14,11 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = 'kosher'
 
+  s.add_dependency('money', '~> 3.6.1')
+  s.add_development_dependency('rspec', '~> 2.5.0')
+
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
-
-  s.add_dependency('json', '~> 1.5.1')
-  s.add_dependency('sucker', '~> 1.3.1')
-  s.add_development_dependency('fabrication', '~> 0.9.5')
-  s.add_development_dependency('rspec', '~> 2.5.0')
-  s.add_development_dependency('ruby-debug19', '~> 0.11.6')
-  s.add_development_dependency('vcr', '~> 1.7.0')
-  s.add_development_dependency('webmock', '~> 1.6.2')
 end

data/lib/kosher/condition.rb

@@ -1,25 +1,15 @@
 module Kosher
-  class Condition < Struct.new(:grade)
-
-    alias_method :to_i, :grade
-
-    CONDITIONS = {
-      'new'        => 1,
-      'mint'       => 2,
-      'verygood'   => 3,
-      'good'       => 4,
-      'acceptable' => 5 }
-
-    def initialize(string = '')
-      self.grade = CONDITIONS[string] || 6
+  class Condition
+    def initialize(grade)
+      @grade = grade
     end
 
     def kosher?
-      grade <= 4
+      @grade <= Config.min_condition
     end
 
     def new?
-      grade == 1
+      @grade == 1
     end
 
     def used?

data/lib/kosher/config.rb

@@ -0,0 +1,45 @@
+module Kosher
+  module Config
+    extend self
+
+    def base_currency
+      @base_currency ||= 'EUR'
+    end
+
+    def base_currency=(code)
+      @base_currency = code
+    end
+
+    def blacklist
+      @blacklist ||= []
+    end
+
+    def blacklist=(seller_ids)
+      @blacklist = seller_ids
+    end
+
+    def max_hours_shipped
+      @max_hours_shipped ||= 48
+    end
+
+    def max_hours_shipped=(hours)
+      @max_hours_shipped = hours
+    end
+
+    def min_rating
+      @min_rating ||= 4.8
+    end
+
+    def min_rating=(rating)
+      @min_rating = rating
+    end
+
+    def min_condition
+      @min_condition ||= 4
+    end
+
+    def min_condition=(grade)
+      @min_condition = grade
+    end
+  end
+end

data/lib/kosher/description.rb

@@ -1,31 +1,27 @@
 module Kosher
-  class Description < String
+  class Description
     DAMAGED     = "\\b(?:missing|torn|broken|split|discard|withdrawn|rent|stain|school|damaged|water)"
     EXLIB       = "(?:e?x|discarded|retired|former|has|have)[\\s._-]*lib"
     MARKED      = "(highlight|hilit|underlin)"
     MISSING_VOL = "(vols?|volume) only"
     REVIEW_COPY = "\\b(?:uncorrected|advanced?\\sreview|arc)\\b"
 
+    def initialize(string = '')
+      @description = string
+    end
+
     def kosher?
-      !(present? && bad?)
-   end
+      !(damaged? || ex_library? || marked? || missing_volume? || review_copy?)
+    end
 
     private
 
-    def bad?
-      damaged?        ||
-      ex_library?     ||
-      marked?         ||
-      missing_volume? ||
-      review_copy?
-    end
-
     def damaged?
       matches(DAMAGED)
     end
 
     def does_not_match(value)
-      !match(Regexp.new(value, true))
+      !matches(value)
     end
 
     def ex_library?
@@ -37,7 +33,7 @@ module Kosher
     end
 
     def matches(value)
-      !does_not_match(value)
+      @description.match(Regexp.new(value, true))
     end
 
     def missing_volume?
@@ -48,10 +44,6 @@ module Kosher
       "(?:no|not an?)\\s+#{value}"
     end
 
-    def present?
-      self != ''
-    end
-
     def review_copy?
       matches(REVIEW_COPY)
     end

data/lib/kosher/offer.rb

@@ -1,38 +1,45 @@
+require 'money'
+
 module Kosher
   class Offer < Struct.new(
+    :id,
     :seller,
     :condition,
     :description,
-    :ships_in,
-    :ships_free,
-    :cents,
-    :exchange_id,
-    :listing_id)
-
-    def self.build(doc)
-      offer             = new
-      offer.seller      = Seller.build(doc['Merchant'])
-
-      attributes        = doc['OfferAttributes']
-      offer.condition   = Condition.new(attributes['SubCondition'])
-      offer.description = Description.new(attributes['ConditionNote'].to_s)
-
-      listing           = doc['OfferListing']
-      offer.ships_in    = listing['AvailabilityAttributes']['MaximumHours'].to_i
-      offer.ships_free  = listing['IsEligibleForSuperSaverShipping'] == '1'
-      offer.cents       = listing['Price']['Amount'].to_i
-      offer.exchange_id = listing['ExchangeId']
-      offer.listing_id  = listing['OfferListingId']
-
-      offer
+    :hours_shipped,
+    :price_in_cents,
+    :shipping_in_cents,
+    :currency,
+    :url)
+
+    include Comparable
+
+    def <=>(another)
+      if self.kosher? != another.kosher?
+        self.kosher? ? 1 : -1
+      else
+        -(self.final_price.exchange_to(Config.base_currency) <=> another.final_price.exchange_to(Config.base_currency))
+      end
+    end
+
+    def available?
+      hours_shipped.to_i <= Config.max_hours_shipped
+    end
+
+    def final_price
+      price + shipping
     end
 
     def kosher?
-      condition.kosher? && seller.kosher? && description.kosher? && ships_now?
+      condition.kosher? && seller.kosher? && description.kosher? && available?
+    end
+
+    def price
+      Money.new(price_in_cents, currency)
     end
 
-    def ships_now?
-      ships_in.to_i <= 48
+    def shipping
+      Money.new(shipping_in_cents.to_i, currency)
     end
   end
 end

data/lib/kosher/seller.rb

@@ -1,29 +1,11 @@
 module Kosher
-  class Seller < Struct.new(:merchant_id, :name, :average_rating)
-    class << self
-      attr_accessor :blacklist
-
-      def build(doc)
-        merchant_id    = doc['MerchantId']
-        name           = doc['Name']
-        average_rating = doc['AverageFeedbackRating'].to_f
-
-        new(merchant_id, name, average_rating)
-      end
-    end
-
-    def blacklist
-      self.class.blacklist
-    end
-
+  class Seller < Struct.new(:id, :name, :rating)
     def blacklisted?
-      blacklist.include?(merchant_id) rescue false
+      Config.blacklist.include?(id)
     end
 
     def kosher?
-      return false if blacklisted?
-
-      average_rating == 0.0 || average_rating > 4.7
+      !blacklisted? && (rating.to_f == 0.0 || rating >= Config.min_rating)
     end
   end
 end

data/lib/kosher/version.rb

@@ -1,3 +1,3 @@
 module Kosher
-  VERSION = '0.1.12'
+  VERSION = '0.2.0'
 end

data/lib/kosher.rb

@@ -1,16 +1,5 @@
-require 'sucker'
-require 'kosher/struct'
-require 'kosher/algorithm'
 require 'kosher/condition'
+require 'kosher/config'
 require 'kosher/description'
-require 'kosher/errors'
-require 'kosher/item'
 require 'kosher/offer'
-require 'kosher/request'
 require 'kosher/seller'
-
-module Kosher
-  def self.new(args={})
-    Request.new(args)
-  end
-end

data/spec/kosher/condition_spec.rb

@@ -2,29 +2,17 @@ require 'spec_helper'
 
 module Kosher
   describe Condition do
-    describe "#to_i" do
-      def this(str)
-        Condition.new(str).to_i
+    describe "#kosher?" do
+      before do
+        Config.min_condition = 1
       end
 
-      it "casts as integer" do
-        this('new').should eql 1
-        this('mint').should eql 2
-        this('verygood').should eql 3
-        this('good').should eql 4
-        this('acceptable').should eql 5
+      it "returns true if condition is equal to or better than minimum condition" do
+        Condition.new(1).should be_kosher
       end
 
-      it "casts unrecognized conditions as 6" do
-        this('refurbished').should eql 6
-      end
-    end
-
-    describe "#kosher?" do
-      it "returns true if condition is good or better" do
-        Condition.new('verygood').should be_kosher
-        Condition.new('good').should be_kosher
-        Condition.new('acceptable').should_not be_kosher
+      it "returns false if condition is less than minimum condition" do
+        Condition.new(2).should_not be_kosher
       end
     end
   end

data/spec/kosher/config_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+module Kosher
+  describe Config do
+    describe ".base_currency" do
+      it "defaults to EUR" do
+        Config.base_currency = nil
+        Config.base_currency.should eql 'EUR'
+      end
+    end
+
+    describe ".blacklist" do
+      it "defaults to an empty array" do
+        Config.blacklist = nil
+        Config.blacklist.should eql []
+      end
+    end
+
+    describe ".max_hours_shipped" do
+      it "defaults to 48" do
+        Config.max_hours_shipped = nil
+        Config.max_hours_shipped.should eql 48
+      end
+    end
+
+    describe ".min_rating" do
+      it "defaults to 4.8" do
+        Config.min_rating = nil
+        Config.min_rating.should eql 4.8
+      end
+    end
+
+    describe ".min_condition" do
+      it "defaults to 4" do
+        Config.min_condition = nil
+        Config.min_condition.should eql 4
+      end
+    end
+  end
+end

data/spec/kosher/description_spec.rb

@@ -2,54 +2,46 @@ require 'spec_helper'
 
 module Kosher
   describe Description do
-    def this(value)
-      Description.new(value)
-    end
-
-    it "inherits from String" do
-      Description.ancestors.should include String
-    end
-
     it "validates a blank description" do
-      this('').should be_kosher
+      Description.new('').should be_kosher
     end
 
     it "validates a non-blank description" do
-      this('foo').should be_kosher
+      Description.new('foo').should be_kosher
     end
 
     it "does not validate advance review copies" do
-      this('Uncorrected review copy').should_not be_kosher
-      this('arc').should_not be_kosher
-      this('arc.').should_not be_kosher
+      Description.new('Uncorrected review copy').should_not be_kosher
+      Description.new('arc').should_not be_kosher
+      Description.new('arc.').should_not be_kosher
 
-      this('marc').should be_kosher
+      Description.new('marc').should be_kosher
     end
 
     it "does not validate marked books" do
-      this('Some highlighting').should_not be_kosher
-      this('Underlining.').should_not be_kosher
-      this('Good. Hiliting.').should_not be_kosher
+      Description.new('Some highlighting').should_not be_kosher
+      Description.new('Underlining.').should_not be_kosher
+      Description.new('Good. Hiliting.').should_not be_kosher
 
-      this('No highlighting.').should be_kosher
+      Description.new('No highlighting.').should be_kosher
     end
 
     it "does not validate books with missing volumes" do
-      this('First vol only.').should_not be_kosher
+      Description.new('First vol only.').should_not be_kosher
     end
 
     it "does not validate damaged or worn books" do
-      this('Different').should be_kosher
-      this('Rental').should_not be_kosher
-      this('Torn pages').should_not be_kosher
+      Description.new('Different').should be_kosher
+      Description.new('Rental').should_not be_kosher
+      Description.new('Torn pages').should_not be_kosher
     end
 
     it "does not validate withdrawn library copies" do
-      this('xlib').should_not be_kosher
-      this('ex-library').should_not be_kosher
-      this('retired library copy').should_not be_kosher
+      Description.new('xlib').should_not be_kosher
+      Description.new('ex-library').should_not be_kosher
+      Description.new('retired library copy').should_not be_kosher
 
-      this('Not an ex-library').should be_kosher
+      Description.new('Not an ex-library').should be_kosher
     end
   end
 end