kosher 0.2.24 → 0.3.0

data/Gemfile

@@ -1,6 +1,2 @@
 source 'http://rubygems.org'
-
-gem 'rspec', '~> 2.5.0'
-gem 'ruby-debug19', '~> 0.11.6'
-
 gemspec

data/kosher.gemspec

@@ -14,7 +14,19 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = 'kosher'
 
-  s.add_dependency('money', '~> 3.6.1')
+ {
+    'rspec'         => '~> 2.6.0',
+    'ruby-debug19'  => '~> 0.11.6'
+  }.each do |lib, version|
+    s.add_development_dependency lib, version
+  end
+
+ {
+    'money'         => '~> 3.6.1',
+    'structure'     => '~> 0.5.0'
+  }.each do |lib, version|
+    s.add_runtime_dependency lib, version
+  end
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/kosher/availability.rb

@@ -1,11 +1,22 @@
 module Kosher
-  class Availability < Struct.new(:hours)
+
+  # The availability of an offer.
+  #
+  # This represents within how many hours an offer is expected to ship out.
+  class Availability < Structure
     include Threshold
 
-    self.threshold = 48
+    key :hours, :type => Integer
 
+    # Returns whether the availability is kosher.
+    #
+    # An availability is kosher if the item ships within a maximum threshold of
+    # hours.
+    #
+    # If we do not know when an item will ship (e.g. Amazon's preorders), we
+    # should set hours to nil, which will render the availability unkosher.
     def kosher?
-      hours <= threshold
+      !hours.nil? && hours <= threshold
     end
   end
 end

data/lib/kosher/book.rb

@@ -1,10 +1,17 @@
 module Kosher
-  class Book < Struct.new(:venue, :isbn, :asin, :offers_total, :offers)
 
+  # A book.
+  #
+  # A book is offered on many venues and has many offers through those venues.
+  class Book < Structure
+    key :isbn
+    key :asin
+    key :offers, :type => Array, :default => []
+
+    # Returns the best kosher offer or nil if there are none.
     def best_kosher_offer
       offer = offers.sort.first
-
-      (offer && offer.kosher?) ? offer : nil
+      offer && offer.kosher? ? offer : nil
     end
   end
 end

data/lib/kosher/condition.rb

@@ -1,9 +1,18 @@
 module Kosher
-  class Condition < Struct.new(:grade)
+
+  # The condition of a book.
+  #
+  # This condition is modeled on a numeric range starting from 1, which
+  # represents `new' offers.
+  class Condition < Structure
     include Threshold
 
-    self.threshold = 4
+    key :grade, :type => Integer
 
+    # Returns whether the condition is kosher.
+    #
+    # A condition is kosher if its grade is below a minimum threshold. We
+    # usually consider books that are good or better kosher.
     def kosher?
       grade <= threshold
     end

data/lib/kosher/description.rb

@@ -1,5 +1,8 @@
 module Kosher
-  class Description < Struct.new(:text)
+
+  # The seller's description of the offer.
+  class Description < Structure
+    key :text, :default => ''
 
     DAMAGED     = "\\b(?:missing|torn|broken|split|discard|withdrawn|rent|stain|school|damaged|water)"
     EXLIB       = "(?:e?x|discarded|retired|former|has|have)[\\s._-]*lib"
@@ -8,7 +11,7 @@ module Kosher
     REVIEW_COPY = "\\b(?:uncorrected|advanced?\\sreview|arc)\\b"
 
     def damaged?
-      matches?(DAMAGED)
+      matches? DAMAGED
     end
 
     def ex_lib?
@@ -16,7 +19,7 @@ module Kosher
     end
 
     def kosher?
-      !(damaged? || ex_lib? || marked? || missing_volume? || review_copy?)
+      !damaged? && !ex_lib? && !marked? && !missing_volume? && !review_copy?
     end
 
     def marked?
@@ -24,11 +27,11 @@ module Kosher
     end
 
     def missing_volume?
-      matches?(MISSING_VOL)
+      matches? MISSING_VOL
     end
 
     def review_copy?
-      matches?(REVIEW_COPY)
+      matches? REVIEW_COPY
     end
 
     private

data/lib/kosher/item.rb

@@ -1,10 +1,21 @@
 module Kosher
-  class Item < Struct.new(:cents, :currency, :quantity, :condition, :description)
+
+  # The actual item offered by a seller.
+  #
+  # An item has a price, quantity, condition, and description.
+  class Item < Structure
+    key :cents, :type => Integer
+    key :currency
+    key :quantity, :type => Integer
+    key :condition, :type => Structure
+    key :description, :type => Structure
+
     def kosher?
       condition.kosher? && description.kosher?
     end
 
     def price
+      raise TypeError, "Can't render money" unless cents
       Money.new(cents, currency)
     end
   end

data/lib/kosher/location.rb

@@ -1,4 +1,8 @@
 module Kosher
-  class Location < Struct.new(:country, :state)
+
+  # The location of a seller.
+  class Location < Structure
+    key :country
+    key :state
   end
 end

data/lib/kosher/offer.rb

@@ -1,17 +1,16 @@
 module Kosher
 
-  # An offer by a book seller.
-  class Offer < Struct.new(:id, :venue, :item, :seller, :shipping, :readable)
-
+  # An offer.
+  #
+  # This is an actual item offered on a particular venue by a seller.
+  class Offer < Structure
     include Comparable
 
-    class << self
-
-      # The base currency.
-      attr_accessor :base_currency
-    end
-
-    self.base_currency = 'EUR'
+    key :id
+    key :venue
+    key :item, :type => Structure
+    key :seller, :type => Structure
+    key :shipping, :type => Structure
 
     # Compares offer with another offer.
     #
@@ -21,29 +20,20 @@ module Kosher
       if kosher? != other.kosher?
         kosher? ? -1 : 1
       else
-        exchanged_price <=> other.exchanged_price
+        price <=> other.price
       end
     end
 
-    # The price exchanged to the base currency.
-    def exchanged_price
-      price.exchange_to(base_currency)
-    end
-
     # Returns whether the offer is kosher.
+    #
+    # An offer is kosher if its item, seller, and shipping are kosher.
     def kosher?
       item.kosher? && seller.kosher? && shipping.kosher?
     end
 
-    # The total price, including the shipping cost.
+    # The total price of an offer.
     def price
       item.price + shipping.cost
     end
-
-    private
-
-    def base_currency
-      self.class.base_currency
-    end
   end
 end

data/lib/kosher/seller.rb

@@ -1,22 +1,25 @@
 module Kosher
-  class Seller < Struct.new(:id, :name, :rating, :location)
-    include Threshold
-
-    class << self
-      attr_accessor :blacklist
-    end
 
-    self.threshold = 4.8
-    self.blacklist = []
+  # The seller offering a book on a venue.
+  #
+  # A seller may have a location.
+  class Seller < Structure
+    include Threshold
 
-    def blacklist
-      self.class.blacklist
-    end
+    key :id
+    key :name
+    key :rating, :type => Float
+    key :location, :type => Structure
 
+    # Returns whether we blacklist the seller.
     def blacklisted?
-      blacklist.include?(id)
+      Kosher.seller_blacklist.include? id
     end
 
+    # Returns whether the seller is kosher.
+    #
+    # A seller is kosher as long as he is not blacklisted and his rating is
+    # unknown, 0.0, or above our minimum threshold.
     def kosher?
       !blacklisted? && (rating.to_f == 0.0 || rating >= threshold)
     end

data/lib/kosher/shipping.rb

@@ -1,15 +1,26 @@
 module Kosher
-  class Shipping < Struct.new(:cents, :currency, :availability)
+  # Shipping details of an offer.
+  #
+  # Shipping costs something (or nothing) and is subject to availability.
+  class Shipping < Structure
+    key :cents, :type => Integer
+    key :currency
+    key :availability, :type => Structure
+
+    # Returns whether the item ships for free.
     def free?
-      cents.to_i == 0
+      cents == 0
     end
 
+    # Returns true if the item is available to ship.
     def kosher?
       availability.kosher?
     end
 
+    # The shipping cost.
     def cost
-      Money.new(cents.to_i, currency)
+      raise TypeError, "Can't render money" unless cents
+      Money.new(cents, currency)
     end
   end
 end

data/lib/kosher/threshold.rb

@@ -9,13 +9,7 @@ module Kosher
     end
 
     module ClassMethods
-      def threshold
-        @threshold
-      end
-
-      def threshold=(value)
-        @threshold = value
-      end
+      attr_accessor :threshold
     end
   end
 end

data/lib/kosher/version.rb

@@ -1,3 +1,3 @@
 module Kosher
-  VERSION = '0.2.24'
+  VERSION = '0.3.0'
 end

data/lib/kosher.rb

@@ -1,7 +1,14 @@
+# Kosher is a somewhat overengineered attempt to abstract bookdealing into a
+# set of models.
+
 require 'money'
+require 'structure'
+require 'structure/json'
 
+# Require this module before all models.
 require 'kosher/threshold'
 
+# Require the models.
 require 'kosher/availability'
 require 'kosher/book'
 require 'kosher/condition'
@@ -9,6 +16,20 @@ require 'kosher/description'
 require 'kosher/item'
 require 'kosher/location'
 require 'kosher/offer'
-require 'kosher/readable'
 require 'kosher/seller'
 require 'kosher/shipping'
+
+module Kosher
+  class << self
+    attr_writer :seller_blacklist
+
+    def seller_blacklist
+      @seller_blacklist ||= []
+    end
+  end
+
+  # Set threshold defaults.
+  Availability.threshold = 48
+  Condition.threshold    = 4
+  Seller.threshold       = 4.8
+end

data/spec/kosher/availability_spec.rb

@@ -12,15 +12,27 @@ module Kosher
       end
 
       context "when available within threshold" do
-        it "returns true" do
+        before do
           @availability.hours = 48
+        end
+
+        it "returns true" do
           @availability.should be_kosher
         end
       end
 
       context "when not available within threshold" do
-        it "returns false" do
+        before do
           @availability.hours = 96
+        end
+
+        it "should return false" do
+          @availability.should_not be_kosher
+        end
+      end
+
+      context "when availability is not known" do
+        it "should return false" do
           @availability.should_not be_kosher
         end
       end

data/spec/kosher/book_spec.rb

@@ -5,7 +5,6 @@ module Kosher
     describe "#best_kosher_offer" do
       before do
         @book = Book.new
-        @book.offers = []
 
         @offer1 = Offer.new
         @offer2 = Offer.new

data/spec/kosher/item_spec.rb

@@ -4,17 +4,14 @@ module Kosher
   describe Item do
     before do
       @item = Item.new
+      @item.condition = Condition.new(:grade => 1)
     end
 
     describe "#kosher?" do
       context "when condition is kosher" do
-        before do
-          @item.condition = Condition.new(1)
-        end
-
         context "when description is kosher" do
           before do
-            @item.description = Description.new('')
+            @item.description = Description.new
           end
 
           it "returns true" do
@@ -24,7 +21,8 @@ module Kosher
 
         context "when description is not kosher" do
           before do
-            @item.description = Description.new('Withdrawn library book')
+            @item.description = Description.new(
+              :text => 'Withdrawn library book')
           end
 
           it "returns false" do
@@ -35,7 +33,7 @@ module Kosher
 
       context "when condition is not kosher" do
         before do
-          @item.condition = Condition.new(5)
+          @item.condition.grade = 5
         end
 
         it "returns false" do
@@ -43,5 +41,15 @@ module Kosher
         end
       end
     end
+
+    describe "#price" do
+      context "when no cents are specified" do
+        it "raises an error" do
+          expect do
+            @item.price
+          end.to raise_error TypeError
+        end
+      end
+    end
   end
 end

data/spec/kosher/offer_spec.rb

@@ -9,12 +9,6 @@ module Kosher
       @offer.shipping = Shipping.new
     end
 
-    describe "#base_currency" do
-      it "defaults to EUR" do
-        @offer.send(:base_currency).should eql 'EUR'
-      end
-    end
-
     describe "#kosher?" do
       context "when item is kosher" do
         before do

data/spec/kosher/seller_spec.rb

@@ -6,15 +6,9 @@ module Kosher
       @seller = Seller.new
     end
 
-    describe "#blacklist" do
-      it "defaults to an empty array" do
-        @seller.blacklist.should eql []
-      end
-    end
-
     describe "#blacklisted?" do
       before do
-        Seller.blacklist = ['foo']
+        Kosher.seller_blacklist = ['foo']
       end
 
       it "returns true if the seller is blacklisted" do
@@ -54,7 +48,7 @@ module Kosher
 
       it "returns false if seller is blacklisted" do
         @seller.id = ['foo']
-        Seller.blacklist = [@seller.id]
+        Kosher.seller_blacklist = [@seller.id]
         @seller.should_not be_kosher
       end
     end

data/spec/kosher/shipping_spec.rb

@@ -14,13 +14,6 @@ module Kosher
         end
       end
 
-      context "when shipping costs nil" do
-        it "returns true" do
-          @shipping.cents = nil
-          @shipping.should be_free
-        end
-      end
-
       context "when shipping is not free" do
         it "returns false" do
           @shipping.cents = 1
@@ -32,23 +25,26 @@ module Kosher
     describe "#kosher?" do
       context "when available" do
         it "returns true" do
-          @shipping.availability = Availability.new(0)
+          @shipping.availability = Availability.new(:hours => 0)
           @shipping.should be_kosher
         end
       end
 
       context "when not available" do
         it "returns false" do
-          @shipping.availability = Availability.new(96)
+          @shipping.availability = Availability.new(:hours => 96)
           @shipping.should_not be_kosher
         end
       end
     end
 
     describe "#cost" do
-      it "returns 0 if no cents given" do
-        @shipping.cents = nil
-        @shipping.cost.cents.should eql 0
+      context "when no cents are specified" do
+        it "raises an error" do
+          expect do
+            @shipping.cost
+          end.to raise_error TypeError
+        end
       end
     end
   end

data/spec/kosher_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Kosher do
+end

metadata

@@ -1,8 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: kosher
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.2.24
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Paper Cavalier
@@ -10,20 +14,69 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-11 00:00:00 +01:00
+date: 2011-05-27 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: money
+  name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 11
+        - 6
+        version: 0.11.6
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: money
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 6
+        - 1
         version: 3.6.1
   type: :runtime
-  version_requirements: *id001
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: structure
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  type: :runtime
+  version_requirements: *id004
 description: Kosher is a somewhat overengineered attempt to abstract bookselling into a set of models.
 email: code@papercavalier.com
 executables: []
@@ -47,7 +100,6 @@ files:
 - lib/kosher/item.rb
 - lib/kosher/location.rb
 - lib/kosher/offer.rb
-- lib/kosher/readable.rb
 - lib/kosher/seller.rb
 - lib/kosher/shipping.rb
 - lib/kosher/threshold.rb
@@ -59,9 +111,9 @@ files:
 - spec/kosher/item_spec.rb
 - spec/kosher/location_spec.rb
 - spec/kosher/offer_spec.rb
-- spec/kosher/readable_spec.rb
 - spec/kosher/seller_spec.rb
 - spec/kosher/shipping_spec.rb
+- spec/kosher_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: https://rubygems.org/gems/kosher
@@ -77,17 +129,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: kosher
-rubygems_version: 1.6.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A somewhat overengineered attempt to abstract bookselling into a set of models
@@ -99,7 +155,7 @@ test_files:
 - spec/kosher/item_spec.rb
 - spec/kosher/location_spec.rb
 - spec/kosher/offer_spec.rb
-- spec/kosher/readable_spec.rb
 - spec/kosher/seller_spec.rb
 - spec/kosher/shipping_spec.rb
+- spec/kosher_spec.rb
 - spec/spec_helper.rb

data/lib/kosher/readable.rb

@@ -1,4 +0,0 @@
-module Kosher
-  class Readable < Struct.new(:price, :description)
-  end
-end

data/spec/kosher/readable_spec.rb

@@ -1,5 +0,0 @@
-require 'spec_helper'
-
-module Kosher
-  describe Readable
-end