billingly 0.1.6 → 0.1.7

data/app/models/billingly/base_customer.rb

@@ -130,6 +130,17 @@ module Billingly
         on_subscription_success
       end
     end
+    
+    # Customers can subscribe to a plan using a special subscription code which would
+    # allow them to access an otherwise hidden plan.
+    # @param code [String] The 13 digit EAN-13 code being redeemed
+    def redeem_special_plan_code(code_string)
+      code = Billingly::SpecialPlanCode.find_by_code(code_string)
+      return if code.nil?
+      return if code.redeemed?
+      subscribe_to_plan(code.plan)
+      code.update_attributes(customer: self, redeemed_on: Time.now)
+    end
 
     # Callback called whenever this customer is successfully subscribed to a plan.
     # This callback does not differentiate if the customer is subscribing for the first time,

data/app/models/billingly/special_plan_code.rb

@@ -0,0 +1,60 @@
+require 'set'
+require 'ean13'
+
+# A SpecialPlanCode lets the {Customer} subscribe to a plan which is hidden from regular
+# customers.
+# Customers would visit your site and redeem the code instead of subscribing to
+# a plan directly. The code will then subscribe them to a plan with the given special pricing.
+class Billingly::SpecialPlanCode < ActiveRecord::Base
+  belongs_to :plan
+  belongs_to :customer
+  validates :plan, presence: true
+  validates :code, presence: true
+  
+  attr_accessible :plan, :code, :customer, :redeemed_on
+  
+  # !@attribute [r] redeemed?
+  # @return [Boolean] Whether this code has been redeemed or not
+  def redeemed?
+    !redeemed_on.nil?   
+  end
+
+  # Creates a list of valid random ean-13 codes.
+  # @param how_many [Integer] How many codes to create.
+  # @return [Array<String>] The list of generated ean-13 codes.
+  def self.generate_ean_13_codes(how_many)
+    randoms = Set.new
+    loop do
+      ean = EAN13.complete( (100000000000 + rand(100000000000)).to_s )
+      randoms << ean if ean
+      return randoms.to_a if randoms.size == how_many
+    end
+  end
+  
+  # Generates rows in the database with codes for a specific plan.
+  # It creates new rows with new codes, and it makes sure that the new codes don't clash
+  # with pre-existing codes.
+  # @param plan [Plan] The plan to generate the codes for.
+  # @param how_many [Integer] How many new codes to issue.
+  def self.generate_for_plan(plan, how_many)
+    generate_ean_13_codes(how_many).collect do |code|
+      self.create!(code: code, plan: plan)
+    end
+  end
+  
+  # Exports all the codes for each plan. You may export only the unused ones.
+  # The codes are exported into CSV files inside the current user's home directory.
+  # There is one file per plan. Each file contains all the available codes for a given plan.
+  def self.export_codes
+    where('redeemed_on IS NULL').group_by(&:plan).each do |plan, special_codes|
+      filename = "ean_13_codes_for_#{plan.description.gsub(/[^a-zA-Z0-9]/,'_')}.csv"
+      File.open(File.expand_path("~/#{filename}"),'w') do |file|
+        file.write(special_codes.collect(&:code).join("\n"))
+      end
+    end
+  end
+  
+  def self.cleanup_exported_files
+    `rm #{File.expand_path('~/ean_13_codes_for_*.csv')}`
+  end
+end

data/lib/billingly/version.rb

@@ -1,3 +1,3 @@
 module Billingly
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/lib/generators/templates/create_billingly_tables.rb

@@ -64,6 +64,15 @@ class CreateBillinglyTables < ActiveRecord::Migration
       t.boolean 'hidden_on'
       t.timestamps
     end
+    
+    create_table :billingly_special_plan_codes do |t|
+      t.references :plan, null: false
+      t.string :code
+      t.references :customer
+      t.datetime :redeemed_on
+      t.timestamps
+    end
+    add_index :billingly_special_plan_codes, :code, :unique => true
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: billingly
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-23 00:00:00.000000000 Z
+date: 2012-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70131414660960 !ruby/object:Gem::Requirement
+  requirement: &70221659484260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70131414660960
+  version_requirements: *70221659484260
 - !ruby/object:Gem::Dependency
   name: validates_email_format_of
-  requirement: &70131414660300 !ruby/object:Gem::Requirement
+  requirement: &70221659483740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70131414660300
+  version_requirements: *70221659483740
 - !ruby/object:Gem::Dependency
   name: has_duration
-  requirement: &70131414659780 !ruby/object:Gem::Requirement
+  requirement: &70221659499360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70131414659780
+  version_requirements: *70221659499360
+- !ruby/object:Gem::Dependency
+  name: ean13
+  requirement: &70221659498700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70221659498700
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &70131414659360 !ruby/object:Gem::Requirement
+  requirement: &70221659497480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70131414659360
+  version_requirements: *70221659497480
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70131414658940 !ruby/object:Gem::Requirement
+  requirement: &70221659496980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70131414658940
+  version_requirements: *70221659496980
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &70131414674900 !ruby/object:Gem::Requirement
+  requirement: &70221659496400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70131414674900
+  version_requirements: *70221659496400
 - !ruby/object:Gem::Dependency
   name: factory_girl_rails
-  requirement: &70131414674480 !ruby/object:Gem::Requirement
+  requirement: &70221659495600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +98,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70131414674480
+  version_requirements: *70221659495600
 description: Rails Engine for SaaS subscription management. Manage subscriptions,
   plan changes, free trials and more!!!
 email:
@@ -107,6 +118,7 @@ files:
 - app/models/billingly/journal_entry.rb
 - app/models/billingly/payment.rb
 - app/models/billingly/plan.rb
+- app/models/billingly/special_plan_code.rb
 - app/models/billingly/subscription.rb
 - app/models/billingly/tasks.rb
 - app/views/billingly/mailer/overdue_notification.html.erb