discounter 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: 5849c701150419b978cdd6fef7fd9648118c5629
+  data.tar.gz: 629a57c35222092975414096194ff22a52a75488
+!binary "U0hBNTEy":
+  metadata.gz: c7015c5ae00266cbd43115aabc76f61c3ff4d19c52ba896a97e51cc9405c4771cfa6f7a0c8b297b9b8660d6da7cd5587745165bdcb3889f4c65babb95c22bf61
+  data.tar.gz: 37aa7da010436101c92e4dabae6bc74e1bd35ef71ef5cb7807255f5979d5356997538bf7adf64229cff492568195b03456c47f91a66df4dacc1534f3b9b17810

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Dain Miller
+
+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,61 @@
+# Discounter
+
+Discounter allows you to create a tree of discount tiers for your application (currently max'd at 3, dynamic max coming soon).  We allow you to use this tree on the front-end via form post helpers or on the backend to help track and calculate currently applied discounts for a user.  This is aiming to be an entirely end-to-end solution for discounting.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'discounter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install discounter
+
+## Usage
+
+After you have required the gem in your project, then you can initialize it and add your discounts.  
+Note: you will not need to initialize both modules to work with this gem, you can pick if you just want it to help you with your views or with your calculations.
+
+First, add your discounts to the tree:
+
+    @discounts = Discounts.new(discount_percentage_1, discount_percentage_2, discount_percentage_3)
+    
+Then you have access to the following methods:
+    
+    @discounts.all 
+    @discounts.select_helper
+
+Now, let's say you have used the select helper to post a discount to the server in a join record.  
+Let's also pretend the entity is called Event, the join is called EventUser, and the user is simply a User record.
+
+In that case we might have a controller that looks like this:
+
+    @event  = Event.find(params[:id])
+    @user   = current_user
+    
+With that, we can easily calculate our new event price if the user viewing it has a discount able to be applied to them
+in the system.  Keep in mind we need to pass in the join model last.
+
+    @discounter  = Discounter.new(@event)
+    @event.price = @discounter.evaluate_discount(@user, EventUser)
+    
+Then we will query the database in an optimized fashion and find the discount able to be applied to that user, and if so
+we will go ahead and manipulate the current @event.price and return out the new discounted price.
+
+Then using @event in your view will easily allow you to display each current_users customized price.
+
+## ToDo: 
+- Add dynamic max, allowing users to mix in as many discount tiers as they want for their application.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/discounter.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'discounter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "discounter"
+  spec.version       = Discounter::VERSION
+  spec.authors       = ["Dain Miller"]
+  spec.email         = ["miller.dain@gmail.com"]
+  spec.description   = %q{Discounter helps you to quickly set up calculation and form post helpers for discount tiers.}
+  spec.summary       = %q{Discounter is a gem that allows you to set up a discount based tiering system, and then helps 
+                          you to use it both via posts to the server or as a method for evaluating current customer 
+                          discounts on an entity item view.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/discounter/discount.rb

@@ -0,0 +1,49 @@
+class Discounts
+  
+  def initialize(percentage_1, percentage_2, percentage_3)
+    @tier_1 = percentage_1
+    @tier_2 = percentage_2
+    @tier_3 = percentage_3
+  end
+  
+  # Make this dynamic, allow users to pass in as many
+  # discount percentages as they want.  Increment by one.
+  DISCOUNTS = {
+    'pretty_discounts': {
+      'Tier 1': @tier_1,
+      'Tier 2': @tier_2,
+      'Tier 3': @tier_3
+    },
+    
+    'tier_1': (@tier_1 * 0.01),
+    'tier_2': (@tier_2 * 0.01),
+    'tier_3': (@tier_3 * 0.01)
+  }
+  
+  # Instance based query method.
+  def all 
+    DISCOUNTS.values.flatten.uniq
+  end
+  
+  # Helper for select methods in the HTML.  
+  # Should you want a dropdown to choose discount type.
+  def select_helper
+    DISCOUNTS['pretty_discounts']
+  end
+
+end
+
+
+# Interface:
+# Somewhere in their application code they call:
+# perhaps on the purchase model or the controller for the show view that is 
+# responsible for making a purchase.
+#
+# @discounts = Discounts.new(percentage_1, percentage_2, percentage_3)
+# 
+# Then via our gem magically they have access to the following
+# @discounts.all
+# or 
+# <%= select_tag 'Choose a discount to apply', @discounts.select_helper' %>
+#
+# 

data/lib/discounter/version.rb

@@ -0,0 +1,3 @@
+module Discounter
+  VERSION = "0.0.2"
+end

data/lib/discounter.rb

@@ -0,0 +1,66 @@
+require 'discounter/version'
+require 'discounter/discount'
+
+# We expect the entity to have a price attribute.
+module Discounter
+  class << self
+    
+    attr_accessor :price
+    
+    # Entity is the entity in which the price to be set is on.
+    def initialize(entity)
+      @entity ||= entity
+      @price  ||= entity.try(:price)
+    end
+    
+    def initialize_discount 
+      # ?
+    end
+    
+    # User is the user that may have a discount for this entity.
+    # Join is the entity in which there is a setting for yes this user has a 
+    # discount associated to them.
+    # We expect the join model to have a discount_tier column that is set to either. 
+    # So we expect it to be set up this way:
+    # - Model Join - Attributes: user_id, discount_tier (optional column = entity_id (for discounting on)).
+    # nil if there is no discount, or the discount tier if there is indeed one.
+    def evaluate_discount(user, join)
+      Join.find_all_by_user_id(user.id).each(&method(:verify_discount_applicability))
+    end
+    
+    private
+    # This method is passed a row from the join table to verify the discount on.
+    def verify_discount_applicability(row)
+      if row.try(:discount).nil?
+        # There is no discount set for this user in the system
+        @price
+      else
+        # There is a discount tier applied.  Let's do the calculation
+        # And return out the price for the Interface.
+        @price = (@price.to_f * row.discount.to_f).to_i
+      end
+    end
+     
+  end # / class
+end # / module
+
+
+# Interface:
+# 
+# Entity in this case is an event that has a purchase price
+# That we sometimes want admins to be able to discount.
+#
+# event = Event.find(params[:id])
+# 
+# Safety check, as we expect a price on the model
+# IDEA: Mixin an options hash that has price true/false flag on it.
+# if event.price
+#   discounter = Discounter.new(event)
+#   
+#   One big use case for this gem is to proxy the price IF we have a discounted
+#   price available to it.
+#   @event.price = discounter.evaluate_discount(user, join)
+# end
+#
+#
+#

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: discounter
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Dain Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Discounter helps you to quickly set up calculation and form post helpers
+  for discount tiers.
+email:
+- miller.dain@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- discounter.gemspec
+- lib/discounter.rb
+- lib/discounter/discount.rb
+- lib/discounter/version.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Discounter is a gem that allows you to set up a discount based tiering system,
+  and then helps  you to use it both via posts to the server or as a method for evaluating
+  current customer  discounts on an entity item view.
+test_files: []