shopscan 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,18 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.1)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.0)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Rob Esris
+
+MIT License
+
+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.md

@@ -0,0 +1,14 @@
+shopscan
+========
+
+A very simple ruby API exercise.
+
+install and run rspec tests
+===========================
+
+git clone git://github.com/robesris/shopscan.git  
+cd shopscan  
+bundle install  
+  
+\# set LIST_LENGTH to any non-negative number to test all permutations of that length (default is 1)    
+LIST_LENGTH=5 rspec -fd  

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/shopscan.rb

@@ -0,0 +1,71 @@
+module ShopScan
+
+  # storage and retrieval methods that should be implmented by the including class 
+  def add_item(item)
+    raise "Please implement the add_item method to add a new product given a hash of the form: { 'A' => { :price => PRICE_IN_CENTS, :bulk_qty => BULK_QTY, :bulk_price => BULK_PRICE } }"
+  end
+
+  def product(product_name = nil)
+    raise "Please implement the product method, accepting a product name as a string."
+  end
+
+  def all_products
+    raise "Please implement the all_products method, returning a hash of all products."
+  end
+
+  def items
+    raise "Please implement the items method, to return an array of scanned item names."
+  end
+
+  def add_item_to_cart(item)
+    raise "Please implement the add_item_to_cart(item) method, accepting an item name."
+  end
+
+
+  # core methods
+  def set_pricing(price_list)
+    price_list.each_pair do |key, product|
+      self.add_item(key => product)
+    end
+  end
+
+  def price_list(product_name = nil)
+    if product_name
+      self.product(product_name)
+    else
+      self.all_products
+    end
+  end
+
+  def scan(item)
+    if all_products[item]
+      add_item_to_cart(item)
+      { :status => :success }
+    else
+      { :status => :failed, :message => "Unknown product skipped: '#{item}'" }
+    end
+  end
+
+  def total
+    item_counts = {}
+
+    self.items.each do |item|
+      item_counts[item] ||= 0
+      item_counts[item] += 1
+    end
+
+    total = 0
+    item_counts.each_pair do |key, item_count|
+      #raise @price_list.inspect
+      if item_info = self.price_list[key]
+        if (bulk_qty = item_info[:bulk_qty]) && bulk_price = item_info[:bulk_price]
+          total += item_count / bulk_qty * bulk_price
+          item_count %= bulk_qty
+        end
+        total += item_count * item_info[:price]
+      end
+    end
+
+    total
+  end
+end

data/lib/shopscan/version.rb

@@ -0,0 +1,3 @@
+module Shopscan
+  VERSION = "0.0.1"
+end

data/lib/terminal.rb

@@ -0,0 +1,29 @@
+require 'shopscan'
+
+class Terminal
+  include ShopScan
+
+  def add_item(item)
+    @price_list ||= {}
+    @price_list.merge! item
+  end
+
+  def product(product_name = nil)
+    return self.all_products unless product_name
+
+    @price_list[product_name.to_s.upcase]
+  end
+
+  def all_products
+    @price_list
+  end
+
+  def items
+    @items ||= []
+  end
+
+  def add_item_to_cart(item)
+    @items ||= []
+    @items << item
+  end
+end

data/shopscan.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/shopscan/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Rob Esris"]
+  gem.email         = ["robesris@gmail.com"]
+  gem.description   = %q{A simple demo api for scanning/totaling products}
+  gem.summary       = %q{A simple demo api for scanning/totaling products}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "shopscan"
+  gem.require_paths = ["lib"]
+  gem.version       = Shopscan::VERSION
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+

data/spec/terminal_spec.rb

@@ -0,0 +1,156 @@
+require 'terminal'
+
+# helper method
+def default_prices
+  {'A' => { :price => 200, :bulk_qty => 4, :bulk_price => 700 },
+   'B' => { :price => 1200 },
+   'C' => { :price => 125, :bulk_qty => 6, :bulk_price => 600 },
+   'D' => { :price => 15 }}
+end
+
+
+# basic functionality
+describe Terminal do
+  it "allows us to set and retrieve pricing" do
+    terminal = Terminal.new
+    expect {terminal.set_pricing({'A' => { :price => 200, :bulk_qty => 4, :bulk_price => 700 },
+                                  'B' => { :price => 1200 },
+                                  'C' => { :price => 125, :bulk_qty => 6, :bulk_price => 600 },
+                                  'D' => { :price => 15 }}) }.to_not raise_error
+    terminal.price_list['A'][:price].should == 200
+    terminal.price_list['A'][:bulk_qty].should == 4
+    terminal.price_list['B'][:price].should == 1200
+    terminal.price_list(:c)[:price].should == 125
+    terminal.price_list('C')[:bulk_price].should == 600
+    terminal.price_list('d')[:price].should == 15
+  end
+
+  it "scans items and stores them as an array of product names" do
+    terminal = Terminal.new
+    terminal.set_pricing(default_prices)
+
+    terminal.scan("A")
+    terminal.scan("A")
+    terminal.scan("C")
+    terminal.scan("B")
+    terminal.scan("D")
+
+    terminal.items.should == [ "A", "A", "C", "B", "D" ]
+  end
+
+  it "correctly totals the minimal cases" do
+    test_cases = [ { :list => "ABCDABAA", :expected => 3240 },
+                   { :list => "CCCCCCC", :expected => 725 },
+                   { :list => "ABCD", :expected => 1540 } ]
+    
+    test_cases.each do |test_case|
+      terminal = Terminal.new
+      terminal.set_pricing(default_prices)
+
+      items = test_case[:list].split ""
+      items.each do |item|
+        terminal.scan(item)
+      end
+
+      terminal.total.should == test_case[:expected]
+    end
+  end
+
+  it "gracefully rejects unknown items with a warning" do
+    terminal = Terminal.new
+    terminal.set_pricing(default_prices)
+
+    terminal.scan('A')[:status].should == :success
+
+    # unknown product
+    result = terminal.scan('E')
+    result[:status].should == :failed
+    result[:message].should == "Unknown product skipped: 'E'"
+
+    # case sensitive
+    result = terminal.scan('a')
+    result[:status].should == :failed
+    result[:message].should == "Unknown product skipped: 'a'"
+
+    result = terminal.scan('B')
+    result[:status].should == :success
+    result[:message].should be_nil
+
+    result = terminal.scan('ABCD')
+    result[:status].should == :failed
+    result[:message].should == "Unknown product skipped: 'ABCD'"
+
+    terminal.items.should == [ 'A', 'B' ]
+    terminal.total.should == 1400
+  end
+
+  it "correctly totals all 'carts' of length #{ENV['LIST_LENGTH'] || 1}" do
+    list_length = ENV['LIST_LENGTH'] || 1
+
+    terminal = Terminal.new
+    terminal.set_pricing(default_prices)
+    
+    item_names = terminal.price_list.map { |key, item| key }
+
+    list_length = list_length.to_i
+    if list_length >= 1
+      old_combos = [ { :list => "", :value => 0, 'A' => 0, 'B' => 0, 'C' => 0, 'D' => 0 } ]
+      1.upto(list_length) do |length|
+        new_combos = []
+        puts "\nLENGTH #{length}:"
+        old_combos.each do |old_combo|
+          item_names.each do |item_name|
+            new_combo = { :list => old_combo[:list] + item_name, 
+                          :value => nil, # we're going to recalculate
+                          'A' => old_combo['A'],
+                          'B' => old_combo['B'],
+                          'C' => old_combo['C'],
+                          'D' => old_combo['D']
+                        }
+            new_combo[item_name] += 1
+            
+            combo_value = 0
+
+            terminal = Terminal.new
+            terminal.set_pricing(default_prices)
+            'A'.upto('D') do |combo_item_name|
+              combo_item = terminal.price_list[combo_item_name]
+              bulk_qty = combo_item[:bulk_qty]
+              bulk_price = combo_item[:bulk_price]
+              remaining = new_combo[combo_item_name]
+
+              if bulk_qty && bulk_price
+                combo_value += remaining / bulk_qty * bulk_price
+                remaining %= bulk_qty
+              end
+              combo_value += remaining * combo_item[:price]
+            end
+            new_combo[:value] = combo_value
+
+            # now scan and check against expected values
+            items = new_combo[:list].split ""
+            items.each do |item|
+              terminal.scan(item)
+            end
+
+            # moment of truth...
+            grand_total = terminal.total
+            result_s = if grand_total == new_combo[:value]
+              "*** PASSED:"
+            else
+              "!!! FAILED:"
+            end
+
+            puts "#{result_s} Expected: #{new_combo[:value]}\tActual: #{grand_total}\tCart: #{new_combo[:list]}"
+
+            # the actual test
+            grand_total.should == new_combo[:value]
+
+            new_combos << new_combo
+          end
+        end
+        old_combos = new_combos
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: shopscan
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Rob Esris
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-27 00:00:00.000000000 Z
+dependencies: []
+description: A simple demo api for scanning/totaling products
+email:
+- robesris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/shopscan.rb
+- lib/shopscan/version.rb
+- lib/terminal.rb
+- shopscan.gemspec
+- spec/spec_helper.rb
+- spec/terminal_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A simple demo api for scanning/totaling products
+test_files:
+- spec/spec_helper.rb
+- spec/terminal_spec.rb