simple_marketplace 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 584c4c8da0fb70ded67448e246ada28e30317e0e
+  data.tar.gz: efa875669befe8ca9df938129540b6daed179ff0
+SHA512:
+  metadata.gz: 1576db61c3a19fc15930ac31602c0283f6fecfc93d070b78f6a915c367b3159dd0c06ab50e8d948c5cc1ae7bf333a70cbbfef651d64925d1a01cb02788bc0a7e
+  data.tar.gz: '08fc80ae3a2551d10a9bc621710ebcf0b0f23513dcd51db9140408e266a656cad61d665103fe6e1ca044ecea54915c3d580b985dbcb726cffaa1fd073cc97398'

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# sublime files
+*.sublime-*
+*.gem

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+sm

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.0

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in simple_marketplace.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Pedro Benevides
+
+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,71 @@
+# SimpleMarketplace
+
+Ruby gem that operates simple checkout cart operations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_marketplace'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_marketplace
+
+## Usage
+
+Create some products
+
+```ruby
+# Let's create some products here...
+SimpleMarketplace::Product.create(
+    { code: "001", name: "Lavender Heart", price: BigDecimal.new("9.25") },
+    { code: "002", name: "Personalised cufflinks", price: BigDecimal.new("45", 4) },
+    { code: "003", name: "Kids T-shirt", price: BigDecimal.new("19.95", 4) })
+```
+
+Create a checkout basket and add items to it
+
+```ruby
+co = SimpleMarketplace::Checkout.new
+
+co.scan("001")
+co.scan("002")
+co.scan("001")
+```
+
+Check the total
+
+```ruby
+co.pretty_total
+=> £36.95
+```
+
+Customize promotions
+
+```ruby
+
+promotion = SimpleMarketplace::Offer::ProductDiscountByAmount.new('001', 2, BigDecimal.new("8.50"))
+co = SimpleMarketplace::Checkout.new(promotion)
+```
+
+## Development
+
+- `bin/setup` to install dependencies;
+- `rake spec` to run the tests;
+- `bin/console` for an interactive prompt that will allow you to experiment.
+- `ruby examples/usage` to see this gem in action (check the source).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pedroaugustosb/simple_marketplace.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple_marketplace"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/usage.rb

@@ -0,0 +1,52 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require "simple_marketplace"
+
+# Let's create some products here...
+SimpleMarketplace::Product.create(
+    { code: "001", name: "Lavender Heart", price: BigDecimal.new("9.25") },
+    { code: "002", name: "Personalised cufflinks", price: BigDecimal.new("45", 4) },
+    { code: "003", name: "Kids T-shirt", price: BigDecimal.new("19.95", 4) })
+
+
+# Offering a discount to a specifc product
+offer1 = SimpleMarketplace::Offer::ProductDiscountByAmount.new('001', 2, BigDecimal.new(8.5, 4))
+
+# Offering discount in the entire order
+offer2 = SimpleMarketplace::Offer::TotalPercentageDiscountByMinValue.new(BigDecimal.new(60.01, 4), 10)
+
+# Adding the discounts to this checkout
+co = SimpleMarketplace::Checkout.new(offer1, offer2)
+
+# Adding products
+co.scan("001")
+co.scan("002")
+co.scan("003")
+
+# reading the total
+puts "Basket 001,002,003"
+puts co.pretty_total
+
+# empty basket
+co.clear_items
+
+# Adding products
+co.scan("001")
+co.scan("003")
+co.scan("001")
+
+# reading the total
+puts "Basket 001,003,001"
+puts co.pretty_total
+
+# empty basket
+co.clear_items
+
+# Adding products
+co.scan("001")
+co.scan("002")
+co.scan("001")
+co.scan("003")
+
+# reading the total
+puts "Basket 001,002,001,003"
+puts co.pretty_total

data/lib/simple_marketplace.rb

@@ -0,0 +1,13 @@
+require "simple_marketplace/version"
+require "bigdecimal"
+
+module SimpleMarketplace
+  autoload :Product,   'simple_marketplace/product'
+  autoload :Offerable, 'simple_marketplace/offerable'
+  autoload :Checkout,  'simple_marketplace/checkout'
+
+  module Offer
+    autoload :ProductDiscountByAmount,           'simple_marketplace/offer/product_discount_by_amount'
+    autoload :TotalPercentageDiscountByMinValue, 'simple_marketplace/offer/total_percentage_discount_by_min_value'
+  end
+end

data/lib/simple_marketplace/checkout.rb

@@ -0,0 +1,43 @@
+module SimpleMarketplace
+  class Checkout
+
+    def initialize(*promotional_rules)
+      @promotional_rules = promotional_rules
+      @items = []
+    end
+
+    # Adds an item to the cart
+    def scan(product_code)
+      if (product = Product.get_by_code(product_code))
+        @items << product
+      end
+    end
+
+    # Calculates the total with promotions applied
+    def total
+      @total = @items.map(&:price).reduce(:+)
+      apply_promotional_rules
+      @total
+    end
+
+    # Shows the formated total
+    def pretty_total
+      "£#{'%.2f' % total}"
+    end
+
+    # Restart the cart
+    def clear_items
+      @items = []
+    end
+
+    private
+
+    # calls the promotional rules in order
+    def apply_promotional_rules
+      @promotional_rules.each do |rule|
+        @total = rule.call(@items, @total)
+      end
+    end
+
+  end
+end

data/lib/simple_marketplace/offer/product_discount_by_amount.rb

@@ -0,0 +1,19 @@
+module SimpleMarketplace::Offer
+  class ProductDiscountByAmount
+    include ::SimpleMarketplace::Offerable
+
+    def initialize(product_code, initial_amount, new_value)
+      @product_code, @initial_amount, @new_value = product_code, initial_amount, new_value
+    end
+
+    # Verify if the product amount is the desired to change the product value
+    def call(items, total)
+      if items.count{ |product| product.code == @product_code } >= @initial_amount
+        items.collect{|product| product.code == @product_code ? @new_value : product.price }.reduce(:+)
+      else
+        total
+      end
+    end
+
+  end
+end

data/lib/simple_marketplace/offer/total_percentage_discount_by_min_value.rb

@@ -0,0 +1,14 @@
+module SimpleMarketplace::Offer
+  class TotalPercentageDiscountByMinValue
+    include ::SimpleMarketplace::Offerable
+
+    def initialize(min_value, percentage)
+      @min_value, @percentage = min_value, percentage
+    end
+
+    # Applies the percentage discount if total is greater than min_value
+    def call(items, total)
+      total >= @min_value ? total.mult(BigDecimal.new(100).sub(@percentage, 4), 4).div(BigDecimal.new(100), 4) : total
+    end
+  end
+end

data/lib/simple_marketplace/offerable.rb

@@ -0,0 +1,8 @@
+module SimpleMarketplace::Offerable
+
+  # Every new offer/promotion will have to implement this method
+  # in order to execute its promotional rules.
+  def call(items, total)
+    raise "Must implement"
+  end
+end

data/lib/simple_marketplace/product.rb

@@ -0,0 +1,34 @@
+module SimpleMarketplace
+  class Product
+    attr_reader :code, :name, :price
+
+    @@all = Hash.new
+
+    def initialize(code, name, price)
+      @code, @name, @price = code, name, price
+    end
+
+    # Fills the products database
+    def self.create(*args)
+      args.each do |hash|
+        @@all[hash[:code]] = Product.new(hash[:code], hash[:name], hash[:price])
+      end
+    end
+
+    # returns product with the code
+    def self.get_by_code(code)
+      @@all[code]
+    end
+
+    # pretty print
+    def to_s
+      "Product(code: #{@code}, name: #{@name}, price: #{@price})"
+    end
+
+    # checks equality
+    def ==(other)
+      return code == other.code, name == other.name, price: other.price
+    end
+
+  end
+end

data/lib/simple_marketplace/version.rb

@@ -0,0 +1,3 @@
+module SimpleMarketplace
+  VERSION = "0.1.0"
+end

data/simple_marketplace.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "simple_marketplace/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_marketplace"
+  spec.version       = SimpleMarketplace::VERSION
+  spec.authors       = ["Pedro Benevides"]
+  spec.email         = ["pedro.augusto.sb@gmail.com"]
+
+  spec.summary       = %q{Library to handle basic checkout cart operations.}
+  spec.homepage      = "https://github.com/pedroaugustosb/simple_marketplace"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: simple_marketplace
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pedro Benevides
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- pedro.augusto.sb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/usage.rb
+- lib/simple_marketplace.rb
+- lib/simple_marketplace/checkout.rb
+- lib/simple_marketplace/offer/product_discount_by_amount.rb
+- lib/simple_marketplace/offer/total_percentage_discount_by_min_value.rb
+- lib/simple_marketplace/offerable.rb
+- lib/simple_marketplace/product.rb
+- lib/simple_marketplace/version.rb
+- simple_marketplace.gemspec
+homepage: https://github.com/pedroaugustosb/simple_marketplace
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Library to handle basic checkout cart operations.
+test_files: []