stripe-rails 0.2.0 → 0.2.1

data/Changelog.md

@@ -1,3 +1,6 @@
+## 0.2.1 (2012-12-17)
+* manage coupons with config/stripe/coupons.rb
+
 ## 0.2.0 (2012-12-13)
 
 * out of the box support for webhooks and critical/non-critical event handlers

data/README.md

@@ -71,7 +71,7 @@ this will generate the configuration files containing your plan and coupon defin
       create  config/stripe/plans.rb
       create  config/stripe/coupons.rb
 
-### Configuring your plans
+### Configuring your plans and coupons
 
 Use the plan builder to define as many plans as you want in `config/stripe/plans.rb`
 
@@ -93,12 +93,22 @@ can refer to them by reference as opposed to an id string.
     Stripe::Plans::SILVER # => 'silver: ACME Silver'
     Stripe::Plans::GOLD # => 'gold: ACME Gold'
 
-To upload these plans onto stripe.com, run:
+
+Coupons are created in much the same way:
+
+    Stripe.coupon :super_elite_free_vip do |coupon|
+      coupon.duration = 'forever'
+      coupon.percent_off = 100
+      coupon.max_redemptions = 5
+    end
+
+To upload your plans and coupons onto stripe.com, run:
 
     rake stripe:prepare
 
-This will create any plans that do not currently exist, and treat as a NOOP any
-plans that do, so you can run this command safely as many times as you wish.
+This will create any plans and coupons that do not currently exist, and treat as a NOOP any
+plans that do, so you can run this command safely as many times as you wish. Now you can
+use any of these plans in your application.
 
 NOTE: You must destroy plans manually from your stripe dashboard.
 

data/lib/generators/stripe/install_generator.rb

@@ -5,6 +5,7 @@ module Stripe
     desc "copy plans.rb"
     def copy_plans_file
       copy_file "plans.rb", "config/stripe/plans.rb"
+      copy_file "coupons.rb", "config/stripe/coupons.rb"
     end
   end
 end

data/lib/generators/templates/coupons.rb

@@ -0,0 +1,39 @@
+# This file contains descriptions of all your statically defined
+# stripe coupons. You may wish to define unique one-off coupons
+# elsewhere, but for ones you will use many times, and will be
+# shared between users, this is a good place.
+
+# Example
+# Stripe::Coupons::Gold25 #=> 'gold25'
+
+# Stripe.coupon :gold25 do |coupon|
+#
+#   # specify if this coupon is useable 'once', 'forever', or 'repeating
+#   coupon.duration = 'repeating'
+#
+#   # absolute amount, in cents, to discount
+#   coupon.amount_off = 199
+#
+#   # what currency to interpret the coupon amount
+#   coupon.currency = 'usd'
+#
+#   # how long will this coupon last? (only valid for duration of 'repeating')
+#   coupon.duration_in_months = 6
+#
+#   # percentage off
+#   coupon.percent_off = 25
+#
+#   UTC timestamp specifying the last time at which the coupon can be redeemed
+#   coupon.reedem_by = (Time.now + 15.days).utc
+#
+#   # How many times can this coupon be redeemed?
+#   coupon.max_redemptions = 10
+# end
+#
+# Once you have your coupons defined, you can run
+#
+#   rake stripe:prepare
+#
+# This will export any new coupons to stripe.com so that you can
+# begin using them in your API calls. Any coupons found that are not in this
+# file will be left as-is.

data/lib/stripe/configuration_builder.rb

@@ -0,0 +1,99 @@
+module Stripe
+  module ConfigurationBuilder
+    extend ActiveSupport::Concern
+
+    included do
+      class << self
+        def configuration_for(class_id, &block)
+          @_configuration_storage = "@#{class_id.to_s.pluralize}"
+          instance_variable_set(@_configuration_storage, {})
+          configuration_class = Class.new(Stripe::ConfigurationBuilder::Configuration)
+          const_set(:Configuration, configuration_class)
+          configuration_class.class_eval(&block)
+          stripe_class = Stripe.const_get(class_id.to_s.camelize)
+          stripe_configuration_class = self
+          send(:define_method, class_id) do |id, &block|
+            config = configuration_class.new(id, stripe_class, stripe_configuration_class)
+            block.call config
+            config.finalize!
+          end
+          ::Stripe.send(:extend, self)
+        end
+
+        def configurations
+          instance_variable_get(@_configuration_storage)
+        end
+
+        def all
+          configurations.values
+        end
+
+        def [](key)
+          configurations[key.to_s]
+        end
+
+        def []=(key, value)
+          configurations[key.to_s] = value
+        end
+
+        def put!
+          all.each(&:put!)
+        end
+      end
+    end
+
+    class Configuration
+      include ActiveModel::Validations
+      attr_reader :id
+
+      def initialize(id, stripe_class, stripe_configuration_class)
+        @id = id
+        @stripe_class = stripe_class
+        @stripe_configuration_class = stripe_configuration_class
+      end
+
+      def finalize!
+        validate!
+        globalize!
+      end
+
+      def validate!
+        fail Stripe::InvalidConfigurationError, errors if invalid?
+      end
+
+      def globalize!
+        @stripe_configuration_class[@id.to_s] = self
+        @stripe_configuration_class.const_set(@id.to_s.upcase, self)
+      end
+
+      def put!
+        if exists?
+          puts "[EXISTS] - #{@stripe_class}:#{@id}" unless Stripe::Engine.testing
+        else
+          object = @stripe_class.create({:id => @id}.merge create_options)
+          puts "[CREATE] - #{@stripe_class}:#{object}" unless Stripe::Engine.testing
+        end
+      end
+
+      def to_s
+        @id.to_s
+      end
+
+      def exists?
+        !!@stripe_class.retrieve(to_s)
+      rescue Stripe::InvalidRequestError
+        false
+      end
+    end
+  end
+
+  class InvalidConfigurationError < StandardError
+    attr_reader :errors
+
+    def initialize(errors)
+      super errors.messages
+      @errors = errors
+    end
+
+  end
+end

data/lib/stripe/coupons.rb

@@ -0,0 +1,38 @@
+module Stripe
+  module Coupons
+    include ConfigurationBuilder
+
+    configuration_for :coupon do
+      attr_accessor :duration, :amount_off, :currency, :duration_in_months, :max_redemptions, :percent_off, :redeem_by
+
+      validates_presence_of :id, :duration
+      validates_presence_of :duration_in_months, :if => :repeating?
+      validates_inclusion_of :duration, :in => %w(forever once repeating), :message => "'%{value}' is not one of 'forever', 'once' or 'repeating'"
+      validates_inclusion_of :percent_off, in: 1..100, unless: ->(coupon) {coupon.percent_off.nil?}
+      validates_numericality_of :percent_off, :greater_than => 0
+      validates_numericality_of :duration_in_months, :greater_than => 0, :if => :repeating?
+      validates_numericality_of :max_redemptions, :greater_than => 0
+
+      def initialize(*args)
+        super
+        @currency = 'usd'
+      end
+
+      def repeating?
+        duration == 'repeating'
+      end
+
+      def create_options
+        {
+          :duration => duration,
+          :percent_off => percent_off,
+          :amount_off => amount_off,
+          :currency => currency,
+          :duration_in_months => duration_in_months,
+          :max_redemptions => max_redemptions,
+          :redeem_by => redeem_by
+        }
+      end
+    end
+  end
+end

data/lib/stripe/engine.rb

@@ -38,9 +38,11 @@ environment file directly.
       end
     end
 
-    initializer 'stripe.plans' do |app|
-      path = app.root.join('config/stripe/plans.rb')
-      load path if path.exist?
+    initializer 'stripe.plans_and_coupons' do |app|
+      for configuration in %w(plans coupons)
+        path = app.root.join("config/stripe/#{configuration}.rb")
+        load path if path.exist?
+      end
     end
 
     rake_tasks do

data/lib/stripe/plans.rb

@@ -1,98 +1,31 @@
 module Stripe
   module Plans
-    @plans = {}
+    include ConfigurationBuilder
 
-    def self.all
-      @plans.values
-    end
-
-    def self.[](key)
-      @plans[key.to_s]
-    end
-
-    def self.[]=(key, value)
-      @plans[key.to_s] = value
-    end
-
-    def self.put!
-      all.each do |plan|
-        plan.put!
-      end
-    end
-
-    def plan(id)
-      config = Configuration.new(id)
-      yield config
-      config.finalize!
-    end
-
-    class Configuration
-      include ActiveModel::Validations
-      attr_reader :id, :currency
+    configuration_for :plan do
+      attr_reader :currency
       attr_accessor :name, :amount, :interval, :interval_count, :trial_period_days
 
       validates_presence_of :id, :name, :amount
       validates_inclusion_of :interval, :in => %w(month year), :message => "'%{value}' is not one of 'month' or 'year'"
 
-      def initialize(id)
-        @id = id
+      def initialize(*args)
+        super(*args)
         @currency = 'usd'
         @interval_count = 1
         @trial_period_days = 0
       end
 
-      def finalize!
-        validate!
-        globalize!
-      end
-
-      def validate!
-        fail InvalidPlanError, errors if invalid?
-      end
-
-      def globalize!
-        Stripe::Plans[@id.to_s] = self
-        Stripe::Plans.const_set(@id.to_s.upcase, self)
-      end
-
-      def put!
-        if exists?
-          puts "[EXISTS] - #{@id}" unless Stripe::Engine.testing
-        else
-          plan = Stripe::Plan.create(
-            :id => @id,
-            :currency => @currency,
-            :name => @name,
-            :amount => @amount,
-            :interval => @interval,
-            :interval_count => @interval_count,
-            :trial_period_days => @trial_period_days
-          )
-          puts "[CREATE] - #{plan}" unless Stripe::Engine.testing
-        end
-      end
-
-      def to_s
-        @id.to_s
-      end
-
-      def exists?
-        !!Stripe::Plan.retrieve("#{@id}")
-      rescue Stripe::InvalidRequestError
-        false
+      def create_options
+        {
+          :currency => @currency,
+          :name => @name,
+          :amount => @amount,
+          :interval => @interval,
+          :interval_count => @interval_count,
+          :trial_period_days => @trial_period_days
+        }
       end
     end
-
-    class InvalidPlanError < StandardError
-      attr_reader :errors
-
-      def initialize(errors)
-        super errors.messages
-        @errors = errors
-      end
-
-    end
-
   end
-  extend Plans
 end

data/lib/stripe/rails.rb

@@ -1,4 +1,6 @@
 require "stripe/rails/version"
 require 'stripe/engine'
+require 'stripe/configuration_builder'
 require 'stripe/plans'
+require 'stripe/coupons'
 require 'stripe/callbacks'

data/lib/stripe/rails/tasks.rake

@@ -15,6 +15,10 @@ namespace :stripe do
     Stripe::Plans.put!
   end
 
-  desc "create all plans defined in config/stripe/plans.rb"
-  task 'prepare' => 'plans:prepare'
+  task 'coupons:prepare' => 'environment' do
+    Stripe::Coupons.put!
+  end
+
+  desc "create all plans and coupons defined in config/stripe/{plans|coupons}.rb"
+  task 'prepare' => ['plans:prepare', 'coupons:prepare']
 end

data/lib/stripe/rails/version.rb

@@ -1,5 +1,5 @@
 module Stripe
   module Rails
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

data/test/coupon_builder_spec.rb

@@ -0,0 +1,64 @@
+require 'minitest/autorun'
+require 'spec_helper'
+
+describe 'building plans' do
+  describe 'simply' do
+    before do
+      @now = Time.now.utc
+      Stripe.coupon(:gold25) do |coupon|
+        coupon.duration = 'repeating'
+        coupon.duration_in_months = 10
+        coupon.amount_off = 100
+        coupon.currency = 'USD'
+        coupon.max_redemptions = 3
+        coupon.percent_off = 25
+        coupon.redeem_by = @now
+      end
+    end
+    after {Stripe::Coupons.send(:remove_const, :GOLD25)}
+
+    it 'is accessible via hash lookup (symbol/string agnostic)' do
+      Stripe::Coupons[:gold25].must_equal Stripe::Coupons::GOLD25
+      Stripe::Coupons['gold25'].must_equal Stripe::Coupons::GOLD25
+    end
+
+    describe 'uploading' do
+      describe 'when none exists on stripe.com' do
+        before do
+          Stripe::Coupon.stubs(:retrieve).raises(Stripe::InvalidRequestError.new("not found", "id"))
+        end
+        it 'creates the plan online' do
+          Stripe::Coupon.expects(:create).with(
+            :id => :gold25,
+            :duration => 'repeating',
+            :duration_in_months => 10,
+            :amount_off => 100,
+            :currency => 'USD',
+            :max_redemptions => 3,
+            :percent_off => 25,
+            :redeem_by => @now
+          )
+          Stripe::Coupons.put!
+        end
+
+      end
+      describe 'when it is already present on stripe.com' do
+        before do
+          Stripe::Coupon.stubs(:retrieve).returns(Stripe::Coupon.construct_from({
+            :id => :gold25,
+          }))
+        end
+        it 'is a no-op' do
+          Stripe::Coupon.expects(:create).never
+          Stripe::Coupons.put!
+        end
+      end
+    end
+  end
+
+  describe 'with missing mandatory values' do
+    it 'raises an exception after configuring it' do
+      proc {Stripe.plan(:bad) {}}.must_raise Stripe::InvalidConfigurationError
+    end
+  end
+end

data/test/plan_builder_spec.rb

@@ -65,7 +65,7 @@ describe 'building plans' do
 
   describe 'with missing mandatory values' do
     it 'raises an exception after configuring it' do
-      proc {Stripe.plan(:bad) {}}.must_raise Stripe::Plans::InvalidPlanError
+      proc {Stripe.plan(:bad) {}}.must_raise Stripe::InvalidConfigurationError
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stripe-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-13 00:00:00.000000000 Z
+date: 2012-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -113,10 +113,13 @@ files:
 - app/views/stripe/_js.html.erb
 - config/routes.rb
 - lib/generators/stripe/install_generator.rb
+- lib/generators/templates/coupons.rb
 - lib/generators/templates/plans.rb
 - lib/stripe-rails.rb
 - lib/stripe/callbacks.rb
 - lib/stripe/callbacks/builder.rb
+- lib/stripe/configuration_builder.rb
+- lib/stripe/coupons.rb
 - lib/stripe/engine.rb
 - lib/stripe/plans.rb
 - lib/stripe/rails.rb
@@ -125,6 +128,7 @@ files:
 - stripe-rails.gemspec
 - test/.DS_Store
 - test/callbacks_spec.rb
+- test/coupon_builder_spec.rb
 - test/dummy/README.rdoc
 - test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js
@@ -189,6 +193,7 @@ summary: A gem to integrate stripe into your rails app
 test_files:
 - test/.DS_Store
 - test/callbacks_spec.rb
+- test/coupon_builder_spec.rb
 - test/dummy/README.rdoc
 - test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js