billingly 0.1.10 → 0.1.11

data/README.md

@@ -34,5 +34,5 @@ Billingly does not receive payments directly (from Paypal, or Worldpay for examp
   * Explore the [Docs](http://rubydoc.info/github/nubis/billingly/master/frames/file/README.md).
 
 # License
-  MIT License. Copyright 2012 Nubis (nubis@woobiz.com.ar)
+  MIT License. Copyright 2012 Nubis (yo@nubis.im)
 

data/app/controllers/billingly/redemptions_controller.rb

@@ -0,0 +1,7 @@
+# (see Billingly::RedemptionsControllerBase)
+class Billingly::RedemptionsController < Billingly::RedemptionsControllerBase
+  
+  def on_redemption_by_non_customer
+    redirect_to subscriptions_path
+  end
+end

data/app/controllers/billingly/redemptions_controller_base.rb

@@ -0,0 +1,47 @@
+# People who have a {Billingly::SpecialPlanCode SpecialPlanCode} can redeem it through
+# the {Billingly::RedemptionsController}
+class Billingly::RedemptionsControllerBase < ::ApplicationController
+  def new
+  end
+  
+  def create
+    code = Billingly::SpecialPlanCode.find_redeemable(params[:promo_code])
+    if code.nil?
+      flash[:invalid_promo_code] = t('billingly.promo_codes.invalid')
+      redirect_to new_redemption_path
+      return
+    end
+
+    unless current_customer
+      session[:current_promo_code] = params[:promo_code] 
+      on_redemption_by_non_customer
+      return
+    end
+
+    unless current_customer.can_subscribe_to?(code.plan)
+      flash[:invalid_promo_code_plan] = t('billingly.promo_codes.cannot_subscribe_to_plan')
+      redirect_to new_redemption_path
+      return
+    end
+
+    current_customer.redeem_special_plan_code(code)
+    on_redemption
+  end
+  
+  # When a code is redeemed successfully by the current customer this callback is called.
+  # The default behavior is redirecting to the subscriptions index page.
+  def on_redemption
+    redirect_to subscriptions_path, notice: t('billingly.promo_codes.redeemed_successfully')
+  end
+  
+  # The redemptions page is public, therefore there may be people redeeming valid codes
+  # without being a customer.
+  #
+  # In such cases, the validated code is stored in the session and this callback is called.
+  # You should redirect to your signup page here, and subscribe the customer using the saved
+  # code after they sign up.
+  # The code and plan associated to this code can be retrieved using {#current_promo_code}
+  # and {#current_promo_code_plan}
+  def on_redemption_by_non_customer
+  end
+end

data/app/controllers/billingly/subscriptions_controller.rb

@@ -8,7 +8,7 @@ class Billingly::SubscriptionsController < ::ApplicationController
   # It's likely the only reachable page for deactivated customers.
   def index
     @subscription = current_customer.active_subscription
-    @plans = Billingly::Plan.all
+    @plans = Billingly::Plan.where('hidden = false')
     @invoices = current_customer.invoices.order('created_at DESC')
   end
   

data/app/models/billingly/base_customer.rb

@@ -133,10 +133,9 @@ module Billingly
     
     # 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?
+    # The {SpecialPlanCode} can also contain an amount to be redeemed.
+    # @param code [SpecialPlanCode] The code being redeemed.
+    def redeem_special_plan_code(code)
       return if code.redeemed?
       credit_payment(code.bonus_amount) if code.bonus_amount
       subscribe_to_plan(code.plan)

data/app/models/billingly/base_plan.rb

@@ -5,7 +5,7 @@ module Billingly
     self.table_name = 'billingly_plans'
 
     attr_accessible :name, :plan_code, :description, :periodicity,
-      :amount, :payable_upfront, :grace_period
+      :amount, :payable_upfront, :grace_period, :hidden
     
     has_duration :grace_period
     validates :grace_period, presence: true

data/app/models/billingly/special_plan_code.rb

@@ -57,4 +57,12 @@ class Billingly::SpecialPlanCode < ActiveRecord::Base
   def self.cleanup_exported_files
     `rm #{File.expand_path('~/ean_13_codes_for_*.csv')}`
   end
+  
+  # Shorthand finder for a redeemable code.
+  # This means that the code exists and has not been redeemed yet.
+  # @param code [String] The code to lookup.
+  # @return [SpecialPlanCode, nil] the SpecialPlanCode instance, or nothing.
+  def self.find_redeemable(code)
+    self.find_by_code_and_redeemed_on(code, nil)
+  end
 end

data/app/views/billingly/redemptions/new.html.haml

@@ -0,0 +1,6 @@
+.span4.offset4
+  .well
+    %h3 Enter your Promo Code
+    = form_tag redemptions_path, :class => 'form-inline' do
+      = text_field_tag :promo_code, params[:promo_code], :class => 'input-large', :placeholder => 'Promo Code'
+      = submit_tag 'Redeem!', :class => 'btn btn-success btn-large'

data/config/locales/en.yml

@@ -1,5 +1,9 @@
 en:
   billingly:
+    promo_codes:
+      redeemed_successfully: Your promo code has been redeemed!
+      invalid: The promo code you entered was invalid
+      cannot_subscribe_to_plan: You can't subscribe to the plan provided by your promo code
     your_account_was_suspended: Your account was suspended
     your_invoice_is_available: Your invoice is available
     payment_receipt: Payment Receipt

data/lib/billingly/engine.rb

@@ -33,6 +33,21 @@ module Billingly
               redirect_to(subscriptions_path)
             end
           end
+          
+          # When an anonymous user redeems a {SpecialPlanCode} the code is stored
+          # in the session. You should first sign them up and then subscribe them
+          # using the code they previously redeemed.
+          # @return [SpecialPlanCode] The instance for the code they redeemed.
+          def current_promo_code
+            @current_promo_code ||=
+              Billingly::SpecialPlanCode.find_redeemable(session[:current_promo_code])
+          end
+          
+          # Shortcut for getting the plan for the current promo code, if any.
+          # @return [Billingly::Plan] The plan referred to by the current code.
+          def current_promo_code_plan
+            @current_promo_code.plan if @current_promo_code
+          end
         end
 
         helper_method :current_customer

data/lib/billingly/rails/routes.rb

@@ -8,6 +8,8 @@ class ActionDispatch::Routing::Mapper
           post :deactivate
         end
       end
+      resources :redemptions, controller: 'billingly/redemptions', only: [:new, :create]
+      get 'redeem' => "billingly/redemptions#new"
     end
     if skope then scope(skope, as: skope, &route) else route.call end
   end

data/lib/billingly/version.rb

@@ -1,3 +1,3 @@
 module Billingly
-  VERSION = "0.1.10"
+  VERSION = "0.1.11"
 end

data/lib/generators/templates/create_billingly_tables.rb

@@ -63,7 +63,7 @@ class CreateBillinglyTables < ActiveRecord::Migration
       t.boolean 'payable_upfront', null: false
       t.string 'grace_period', null: false
       t.integer 'signup_price'
-      t.boolean 'hidden_on'
+      t.boolean 'hidden', default: false, null: false
       t.timestamps
     end
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: billingly
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-05 00:00:00.000000000 Z
+date: 2012-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70101883663420 !ruby/object:Gem::Requirement
+  requirement: &70200335482980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70101883663420
+  version_requirements: *70200335482980
 - !ruby/object:Gem::Dependency
   name: validates_email_format_of
-  requirement: &70101883679240 !ruby/object:Gem::Requirement
+  requirement: &70200335482480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70101883679240
+  version_requirements: *70200335482480
 - !ruby/object:Gem::Dependency
   name: has_duration
-  requirement: &70101883678660 !ruby/object:Gem::Requirement
+  requirement: &70200335481840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70101883678660
+  version_requirements: *70200335481840
 - !ruby/object:Gem::Dependency
   name: ean13
-  requirement: &70101883678160 !ruby/object:Gem::Requirement
+  requirement: &70200335481100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70101883678160
+  version_requirements: *70200335481100
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &70101883677620 !ruby/object:Gem::Requirement
+  requirement: &70200335496720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70101883677620
+  version_requirements: *70200335496720
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70101883677080 !ruby/object:Gem::Requirement
+  requirement: &70200335496140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70101883677080
+  version_requirements: *70200335496140
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &70101883676580 !ruby/object:Gem::Requirement
+  requirement: &70200335495700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70101883676580
+  version_requirements: *70200335495700
 - !ruby/object:Gem::Dependency
   name: factory_girl_rails
-  requirement: &70101883676080 !ruby/object:Gem::Requirement
+  requirement: &70200335495240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70101883676080
+  version_requirements: *70200335495240
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &70200335494780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70200335494780
 description: Rails Engine for SaaS subscription management. Manage subscriptions,
   plan changes, free trials and more!!!
 email:
@@ -107,6 +118,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- app/controllers/billingly/redemptions_controller.rb
+- app/controllers/billingly/redemptions_controller_base.rb
 - app/controllers/billingly/subscriptions_controller.rb
 - app/mailers/billingly/base_mailer.rb
 - app/mailers/billingly/mailer.rb
@@ -126,6 +139,7 @@ files:
 - app/views/billingly/mailer/pending_notification.html.erb
 - app/views/billingly/mailer/task_results.html.erb
 - app/views/billingly/mailer/trial_expired_notification.html.erb
+- app/views/billingly/redemptions/new.html.haml
 - app/views/billingly/subscriptions/_current_subscription.html.haml
 - app/views/billingly/subscriptions/_deactivation_notice.html.haml
 - app/views/billingly/subscriptions/_invoice_details.html.haml