snl-kosher 0.1.0

data/README.rdoc

@@ -0,0 +1,26 @@
+= Kosher
+
+People sell stuff online. Some are bad sellers. Some sell bad stuff. This module provides some basic methods to filter out those iffy listings you probably do not want to buy.
+
+The current incarnation only works with Amazon sellers and book descriptions in English, but the idea is easily expandable to other product groups, venues, or languages.
+
+== Example usage
+
+  >> load "lib/kosher.rb"
+  => true
+  >> Kosher.seller? :amazon, nil, 0
+  => true
+  >> Kosher.seller? :amazon, 4.9, 1000
+  => true
+  >> Kosher.seller? :amazon, 4.5, 1000
+  => false
+  >> Kosher.description? :book, "Fine/Fine."
+  => true
+  >> Kosher.description? :book, "Very good. Not an exlib."
+  => true
+  >> Kosher.description? :book, "Withdrawn library copy."
+  => false
+  >> Kosher.description? :book, "Some highlighting."
+  => false
+
+That's about it!

data/data/rules.yml

@@ -0,0 +1,8 @@
+--- 
+:en:
+  :book:
+  - bad: (has|have|contains?|some|considerable|neatly) (hi|under|writing|marginalia|marking|note)
+  - bad: \. *highlight|\. *hili|^ *highlight|^ *hili
+  - bad: missing|torn|broken|split|different|no cd|sticker|stain|damaged|water
+  - bad: discard|withdrawn|x.{0,2}lib|retired.*library|former.*library|has.*library|may have library|school
+    good: not a?n? ?(e?x.{0,2}lib|library)

data/lib/kosher.rb

@@ -0,0 +1,38 @@
+require "yaml"
+
+module Kosher  
+  RULES = File.open(File.join(File.dirname(__FILE__), "../data/rules.yml")) {|f| YAML.load(f)}
+  
+  # Check if a book description is kosher.
+  def self.description?(product_group, description, language = :en)
+    if RULES[language].is_a?(Hash) && RULES[language][product_group].is_a?(Array)
+      RULES[language][product_group].each do |rule|
+        if description =~ Regexp.new(rule["bad"], true)
+          if rule["good"].nil? || description !~ Regexp.new(rule["good"], true)
+            return false
+          end
+        end 
+      end
+    end
+    true
+  end
+  
+  # Check if a seller is kosher.
+  def self.seller?(venue, ave_feedback, total_feedback, feedback_threshold = 4.8)
+    # Give small sellers the benefit of doubt.
+    if total_feedback == 0 
+      true
+    else
+      if venue == :amazon
+        if total_feedback < 5
+          ave_feedback > 4.4 ? true : false
+        else
+          ave_feedback >= feedback_threshold ? true : false
+        end
+      else
+        # Other venues are not included at the moment.
+        true
+      end
+    end
+  end
+end

data/test/kosher_test.rb

@@ -0,0 +1,42 @@
+require "test/unit"
+require File.dirname(__FILE__) + '/../lib/kosher'
+
+class KosherTest < Test::Unit::TestCase
+	def test_book_descriptions
+		kosher_descriptions = {:en => {:book => [nil,
+  		                                       "",
+                  		                       "Lorem ipsum",
+                  		                       "Not exlib",
+                  		                       "No highlighting"]}}
+		unkosher_descriptions = {:en => {:book => ["Some underlining",
+		                                           "Has highlighting",
+                  		                         "A withdrawn library copy",
+                  		                         "Awesome book. EXLIB!",
+                  		                         "A former school library book"]}}
+		kosher_descriptions.each do |language, product_groups|
+		  product_groups.each do |product_group, descriptions|
+		    descriptions.each do |description|
+		      assert_equal true, (Kosher.description? product_group, description, language), description
+	      end
+	    end
+	  end
+		unkosher_descriptions.each do |language, product_groups|
+		  product_groups.each do |product_group, descriptions|
+		    descriptions.each do |description|
+		      assert_equal false, (Kosher.description? product_group, description, language), description
+	      end
+	    end
+	  end
+	end
+	
+	def test_amazon_sellers
+	  assert_equal true, (Kosher.seller? :amazon, nil, 0), "Kosher new Amazon seller"
+	  assert_equal true, (Kosher.seller? :amazon, 4.5, 1), "Kosher small Amazon seller"
+	  assert_equal true, (Kosher.seller? :amazon, 4.9, 100), "Kosher big Amazon seller"
+	  assert_equal false, (Kosher.seller? :amazon, 4, 1), "Unkosher small Amazon seller"
+	  assert_equal false, (Kosher.seller? :amazon, 4.5, 100), "Unkosher big Amazon seller"
+  end
+end
+
+require 'test/unit/ui/console/testrunner'
+Test::Unit::UI::Console::TestRunner.run(KosherTest)

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification 
+name: snl-kosher
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Hakan \xC5\x9Eenol Ensari"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-07 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Kosher is a Ruby module that provides some methods to filter out iffy listings on Amazon and similar venues.
+email: snl@theorydot.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- data/rules.yml
+- lib/kosher.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/snl/kosher
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Kosher is a Ruby module that provides some methods to filter out iffy listings on Amazon and similar venues.
+test_files: 
+- test/kosher_test.rb