freemium-ajb 0.0.4

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,27 @@
+# yard generated
+doc
+.yardoc
+
+
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/public/

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+freemium

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p194

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - '1.9.2'
+  - '1.9.3'
+  - '2.0.0'
+script: bundle exec rspec

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Lance Ivy
+
+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 @@
+## Freemium [![](https://codeclimate.com/github/adamjacobbecker/freemium.png)](https://codeclimate.com/github/adamjacobbecker/freemium) [![](https://travis-ci.org/adamjacobbecker/freemium.png)](https://travis-ci.org/adamjacobbecker/freemium) [![](https://coveralls.io/repos/adamjacobbecker/freemium/badge.png)](https://coveralls.io/r/adamjacobbecker/freemium)

data/app/mailers/freemium_mailer.rb

@@ -0,0 +1,36 @@
+class FreemiumMailer < ActionMailer::Base
+  prepend_view_path(File.dirname(__FILE__))
+
+  default :from => 'billing@example.com',
+          :return_path => 'no-reply@example.com'
+
+  def invoice(transaction)
+    @amount = transaction.amount
+    @subscription = transaction.subscription
+    mail(:to => transaction.subscription.subscribable.email,
+         :bcc => Freemium.configuration.admin_report_recipients,
+         :subject => "Your invoice")
+  end
+
+  def expiration_warning(subscription)
+    @subscription = subscription
+    mail(:to => subscription.subscribable.email,
+         :bcc => Freemium.configuration.admin_report_recipients,
+         :subject => "Your subscription is set to expire")
+  end
+
+  def expiration_notice(subscription)
+    @subscription = subscription
+    mail(:to => subscription.subscribable.email,
+         :bcc => Freemium.configuration.admin_report_recipients,
+         :subject => "Your subscription has expired")
+  end
+
+  def admin_report(transactions)
+    @amount_charged = transactions.select{|t| t && t.success?}.collect{|t| t.amount}.sum
+    @transactions = transactions
+    @amount_charged = @amount_charged
+    mail(:to => Freemium.configuration.admin_report_recipients,
+         :subject => "Billing report (#{@amount_charged} charged)")
+  end
+end

data/app/views/subscription_mailer/admin_report.text.erb

@@ -0,0 +1,4 @@
+<% @transactions.each do |subscription, events| %>
+subscription #<%= subscription.id %> (billing key <%= subscription.billing_key %>)
+<%= events.collect{|e| "- #{e.to_s}"}.join("\n") %>
+<% end %>

data/app/views/subscription_mailer/expiration_notice.text.erb

@@ -0,0 +1 @@
+Your subscription has expired.

data/app/views/subscription_mailer/expiration_warning.text.erb

@@ -0,0 +1 @@
+We were unable to process your payment, and your subscription is set to expire in <%= @subscription.remaining_days_of_grace %> days. Please contact us to correct this.

data/app/views/subscription_mailer/invoice.text.erb

@@ -0,0 +1,5 @@
+Thanks for paying!
+
+  Your Plan: <%= @subscription.subscription_plan.name %> (<%= @subscription.subscription_plan.rate %> / month)
+  Paid: <%= @amount %>
+  Paid Through: <%= @subscription.paid_through.to_s %>

data/freemium.gemspec

@@ -0,0 +1,29 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'freemium/version'
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name = 'freemium-ajb'
+  s.version = Freemium::VERSION
+  s.authors = ['Lance Ivy', 'Anton Oryol', 'Christian Trosclair', 'Adam Becker']
+  s.email = %q{adam@dobt.co}
+  s.homepage = %q{http://github.com/adamjacobbecker/freemium}
+  s.summary = ""
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {spec}/*`.split("\n")
+  s.extra_rdoc_files = %w(LICENSE.md README.md)
+  s.rdoc_options = ['--charset=UTF-8']
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = Gem::Requirement.new('>= 1.9.2')
+
+  s.add_dependency 'rails', '>= 3.0'
+  s.add_dependency 'money'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'coveralls'
+end

data/lib/freemium.rb

@@ -0,0 +1,25 @@
+require 'money'
+require_relative '../app/mailers/freemium_mailer'
+require "freemium/version"
+require 'freemium/configuration'
+require 'freemium/coupon'
+require 'freemium/coupon_redemption'
+require 'freemium/credit_card'
+require 'freemium/engine'
+require 'freemium/rates'
+require 'freemium/response'
+require 'freemium/subscription'
+require 'freemium/subscription_change'
+require 'freemium/subscription_plan'
+require 'freemium/transaction'
+require 'freemium/gateways/base'
+require 'freemium/gateways/brain_tree'
+require 'freemium/gateways/test'
+
+module Freemium
+  class CreditCardStorageError < RuntimeError; end
+
+  def self.root
+    File.expand_path('../..', __FILE__)
+  end
+end

data/lib/freemium/configuration.rb

@@ -0,0 +1,27 @@
+module Freemium
+  class Configuration
+    attr_accessor \
+      :mailer,
+      :gateway,
+      :days_grace,
+      :days_free_trial,
+      :expired_plan,
+      :admin_report_recipients
+
+    def initialize
+      @mailer = FreemiumMailer
+      @gateway = Freemium::Gateways::Test.new
+      @days_grace = 3
+      @days_free_trial = 0
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield configuration
+  end
+end

data/lib/freemium/coupon.rb

@@ -0,0 +1,37 @@
+module Freemium
+  module Coupon
+
+    def self.included(base)
+      base.class_eval do
+        has_many :coupon_redemptions, :dependent => :destroy
+        has_many :subscriptions, :through => :coupon_redemptions
+        has_and_belongs_to_many :subscription_plans
+
+        validates :description, presence: true
+        validates :discount_percentage, presence: true, :inclusion => 0..100
+
+        before_save :normalize_redemption_key
+      end
+    end
+
+    def discount(rate)
+      rate * (1 - self.discount_percentage.to_f / 100)
+    end
+
+    def expired?
+      (self.redemption_expiration && Date.today > self.redemption_expiration) || (self.redemption_limit && self.coupon_redemptions.count >= self.redemption_limit)
+    end
+
+    def applies_to_plan?(subscription_plan)
+      return true if self.subscription_plans.blank? # applies to all plans
+      self.subscription_plans.include?(subscription_plan)
+    end
+
+    protected
+
+    def normalize_redemption_key
+      self.redemption_key.downcase! unless self.redemption_key.blank?
+    end
+
+  end
+end

data/lib/freemium/coupon_redemption.rb

@@ -0,0 +1,59 @@
+module Freemium
+  module CouponRedemption
+
+    def self.included(base)
+      base.class_eval do
+        belongs_to :subscription, :class_name => "Subscription"
+        belongs_to :coupon, :class_name => "Coupon"
+
+        before_validation :upgrade_plan_automatically
+        before_create :set_redeemed_on
+
+        validates_presence_of :coupon
+        validates_presence_of :subscription
+        validates_uniqueness_of :coupon_id, :scope => :subscription_id, :message => "has already been applied"
+        validate :custom_validation, :on => :create
+      end
+    end
+
+    def expire!(date = Date.today)
+      self.update_attribute :expired_on, date
+    end
+
+    def active?(date = Date.today)
+      expires_on ? date <= self.expires_on : true
+    end
+
+    def expires_on
+      return nil unless self.coupon.duration_in_months
+      self.redeemed_on + self.coupon.duration_in_months.months
+    end
+
+    def redeemed_on
+      self['redeemed_on'] || Date.today
+    end
+
+    protected
+
+    def set_redeemed_on
+      self.redeemed_on = Date.today
+    end
+
+    def upgrade_plan_automatically
+      if self.coupon &&
+         self.coupon.discount_percentage == 100 &&
+         self.coupon.subscription_plans.count == 1 &&
+         self.coupon.subscription_plans.first.rate > self.subscription.subscription_plan.rate
+
+        self.subscription.subscription_plan = self.coupon.subscription_plans.first
+      end
+    end
+
+    def custom_validation
+      errors.add :subscription,  "must be paid"             if self.subscription && !self.subscription.subscription_plan.paid?
+      errors.add :coupon,  "has expired"                    if self.coupon && (self.coupon.expired? || self.coupon.expired?)
+      errors.add :coupon,  "is not valid for selected plan" if self.coupon && self.subscription && !self.coupon.applies_to_plan?(self.subscription.subscription_plan)
+    end
+
+  end
+end

data/lib/freemium/credit_card.rb

@@ -0,0 +1,222 @@
+module Freemium
+  module CreditCard
+
+    CARD_COMPANIES = {
+      :visa               => /^4[0-9]{12}(?:[0-9]{3})?$/,
+      :master             => /^(5[1-5]\d{4}|677189)\d{10}$/,
+      :discover           => /^(6011|65\d{2})\d{12}$/,
+      :american_express   => /^3[47]\d{13}$/,
+      :diners_club        => /^3(0[0-5]|[68]\d)\d{11}$/,
+      :jcb                => /^3528\d{12}$/,
+      :switch             => /^6759\d{12}(\d{2,3})?$/,
+      :solo               => /^6767\d{12}(\d{2,3})?$/,
+      :dankort            => /^5019\d{12}$/,
+      :maestro            => /(^6759[0-9]{2}([0-9]{10})$)|(^6759[0-9]{2}([0-9]{12})$)|(^6759[0-9]{2}([0-9]{13})$)/,
+      :forbrugsforeningen => /^600722\d{10}$/,
+      :laser              => /^(6304[89]\d{11}(\d{2,3})?|670695\d{13})$/
+    }
+
+    def self.included(base)
+      base.class_eval do
+        # Essential attributes for a valid, non-bogus creditcards
+        attr_accessor :number, :month, :year, :name
+
+        # Required for Switch / Solo cards
+        attr_accessor :start_month, :start_year, :issue_number
+
+        # Optional verification_value (CVV, CVV2 etc). Gateways will try their best to
+        # run validation on the passed in value if it is supplied
+        attr_accessor :verification_value
+
+        has_one :subscription
+
+        before_validation :sanitize_data, :if => :new_or_changed?
+
+        validate :validate_card, :if => :new_or_changed?
+
+        validates :name, presence: true, :if => :new_or_changed?
+        validates :month, presence: true, inclusion: 1..12, :if => :new_or_changed?
+        validates :year, presence: true, inclusion: (Time.now.year..Time.now.year + 20), :if => :new_or_changed?
+        validates :number, presence: true, :if => :new_or_changed?
+        validates :verification_value, presence: true, :if => :new_or_changed?
+      end
+
+      base.extend(ClassMethods)
+    end
+
+    ##
+    ## Callbacks
+    ##
+
+    protected
+
+    def sanitize_data #:nodoc:
+      self.month = month.to_i if month
+      self.year  = year.to_i if year
+      self.number = number.to_s.gsub(/[^\d]/, "")
+      self.card_type = self.class.card_type?(number) if card_type.blank?
+      self.display_number = display_number
+    end
+
+    public
+
+    ##
+    ## Class Methods
+    ##
+
+    module ClassMethods
+      # Returns true if it validates. Optionally, you can pass a card type as an argument and
+      # make sure it is of the correct type.
+      #
+      # References:
+      # - http://perl.about.com/compute/perl/library/nosearch/P073000.htm
+      # - http://www.beachnet.com/~hstiles/cardtype.html
+      def valid_number?(number)
+        valid_card_number_length?(number) &&
+          valid_checksum?(number)
+      end
+
+      # Regular expressions for the known card companies.
+      #
+      # References:
+      # - http://en.wikipedia.org/wiki/Credit_card_number
+      # - http://www.barclaycardbusiness.co.uk/information_zone/processing/bin_rules.html
+      def card_companies
+        CARD_COMPANIES
+      end
+
+      # Returns a string containing the type of card from the list of known information below.
+      # Need to check the cards in a particular order, as there is some overlap of the allowable ranges
+      #--
+      # TODO Refactor this method. We basically need to tighten up the Maestro Regexp.
+      #
+      # Right now the Maestro regexp overlaps with the MasterCard regexp (IIRC). If we can tighten
+      # things up, we can boil this whole thing down to something like...
+      #
+      #   def type?(number)
+      #     return 'visa' if valid_test_mode_card_number?(number)
+      #     card_companies.find([nil]) { |type, regexp| number =~ regexp }.first.dup
+      #   end
+      #
+      def card_type?(number)
+        card_companies.each do |company, pattern|
+          return company if number =~ pattern
+        end
+
+        return nil
+      end
+
+      def last_digits(number)
+        number.to_s.length <= 4 ? number : number.to_s.slice(-4..-1)
+      end
+
+      def mask(number)
+        "XXXX-XXXX-XXXX-#{last_digits(number)}"
+      end
+
+      # Checks to see if the calculated type matches the specified type
+      def matching_card_type?(number, card_type)
+        card_type?(number) == card_type
+      end
+
+      private
+
+      def valid_card_number_length?(number) #:nodoc:
+        number.to_s.length >= 12
+      end
+
+      # Checks the validity of a card number by use of the the Luhn Algorithm.
+      # Please see http://en.wikipedia.org/wiki/Luhn_algorithm for details.
+      def valid_checksum?(number) #:nodoc:
+        sum = 0
+        for i in 0..number.length
+          weight = number[-1 * (i + 2), 1].to_i * (2 - (i % 2))
+          sum += (weight < 10) ? weight : weight - 9
+        end
+
+        (number[-1,1].to_i == (10 - sum % 10) % 10)
+      end
+
+    end
+
+    ##
+    ## From ActiveMerchant::Billing::CreditCard
+    ##
+
+    # Provides proxy access to an expiry date object
+    def expiration_date
+      if @month && @year
+        month_days = [nil,31,28,31,30,31,30,31,31,30,31,30,31]
+        begin
+          month_days[2] = 29 if Date.leap?(@year)
+          str = "#{year}/#{@month}/#{month_days[@month]} 23:59:59"
+          self['expiration_date'] = Time.parse(str)
+        end
+      else
+        self['expiration_date']
+      end
+    end
+
+    def expired?
+      return false unless expiration_date
+      Time.now > expiration_date
+    end
+
+    # Show the card number, with all but last 4 numbers replace with "X". (XXXX-XXXX-XXXX-4338)
+    def display_number
+      self['display_number'] ||= self.class.mask(number)
+      self['display_number']
+    end
+
+    def last_digits
+      self.class.last_digits(number)
+    end
+
+    ##
+    ## Overrides
+    ##
+
+    # We're overriding AR#changed? to include instance vars that aren't persisted to see if a new card is being set
+    def changed?
+      card_type_changed? || [:number, :month, :year, :name, :start_month, :start_year, :issue_number, :verification_value].any? {|attr| !self.send(attr).nil?}
+    end
+
+    def new_or_changed?
+      new_record? || changed?
+    end
+
+    ##
+    ## Validation
+    ##
+
+    def validate_card
+      errors.add :year, "expired" if expired?
+      validate_card_number
+      validate_switch_or_solo_attributes
+    end
+
+    private
+
+    def validate_card_number #:nodoc:
+      errors.add :number, "is not a valid credit card number" unless self.class.valid_number?(number)
+    end
+
+    def validate_switch_or_solo_attributes #:nodoc:
+      if %w[switch solo].include?(card_type)
+        unless valid_month?(@start_month) && valid_start_year?(@start_year) || valid_issue_number?(@issue_number)
+          errors.add :start_month,  "is invalid"      unless valid_month?(@start_month)
+          errors.add :start_year,   "is invalid"      unless valid_start_year?(@start_year)
+          errors.add :issue_number, "cannot be empty" unless valid_issue_number?(@issue_number)
+        end
+      end
+    end
+
+    def valid_start_year?(year)
+      year.to_s =~ /^\d{4}$/ && year.to_i > 1987
+    end
+
+    def valid_issue_number?(number)
+      number.to_s =~ /^\d{1,2}$/
+    end
+  end
+end