stripe-rails 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a48f7cd53408976274d19e00765d59c76aa0e4ae69e7accaf4b0e58de6737db
-  data.tar.gz: 0cdb70b8481b375c043ed622082376da4342712ed1a389170eccbc944a668713
+  metadata.gz: 4b35454f34ad04d0060f9ffc0bfc0f768717c75a5feaf000b5d5dd55850aecbf
+  data.tar.gz: 0000ba8f4f607ed56108fa6da955f7e03f3fc1ba092a6a8ad9f203c600ba189f
 SHA512:
-  metadata.gz: fe441c8ddb0f65fea0b8ae401609c8dc9ea3f24b8426168fc2b93f830fa895911e2f1649ef570d73b48f6f73dd80eb6b3fbd68f687561d5fd613424c97e558a9
-  data.tar.gz: e8451147cfcb761affc302a442da37ad0311ce09201a515d4c29205724463e301d9c63e5998df2af7481d9c38e33955fd24654837b88e7fda7a53e2878eebade
+  metadata.gz: dd48273cf821b7af2c5515aed2321fed95d0ed93496cf9c090698d9d2c231544b9264d676fbcbd58a4262d6e1f6621d7744b4e3638b09a46c834e5a9b398bb92
+  data.tar.gz: defdc32f8c2a558283324ed0f5164c7140cb03d9daecd4c8b24acd20f26837e090ed7a4655ad5abc46747980fedb0834c7ea461be418af049859e1f3f95b50f5

data/Changelog.md

@@ -1,3 +1,7 @@
+## 1.4.0 (2018-07-30)
+
+* Spanking new products builder for Stripe Billing (#117) - Thanks to @renchap for suggesting this and to @henryaj for reviewing it.
+
 ## 1.3.0 (2018-07-23)
 
 * do not create new product when product id is provided (#115) - Thanks to @renchap for reporting this

data/README.md

@@ -3,7 +3,6 @@
 [![Build Status](https://travis-ci.org/tansengming/stripe-rails.png?branch=master)](https://travis-ci.org/tansengming/stripe-rails)
 [![Code Climate](https://codeclimate.com/github/tansengming/stripe-rails/badges/gpa.svg)](https://codeclimate.com/github/tansengming/stripe-rails)
 [![Test Coverage](https://codeclimate.com/github/tansengming/stripe-rails/badges/coverage.svg)](https://codeclimate.com/github/tansengming/stripe-rails/coverage)
-[![Dependency Status](https://gemnasium.com/tansengming/stripe-rails.png)](https://gemnasium.com/tansengming/stripe-rails)
 
 
 This gem can help your rails application integrate with Stripe in the following ways
@@ -125,6 +124,7 @@ rails generate stripe:install
 this will generate the configuration files containing your plan and coupon definitions:
 
 ```console
+create  config/stripe/products.rb
 create  config/stripe/plans.rb
 create  config/stripe/coupons.rb
 ```
@@ -173,6 +173,16 @@ Stripe.coupon :super_elite_free_vip do |coupon|
 end
 ```
 
+
+As are Products:
+
+```ruby
+Stripe.products :primo do |products|
+  products.name = 'PRIMO as a service'
+  products.type = 'service'
+end
+```
+
 To upload your plans and coupons onto stripe.com, run:
 
 ```sh

data/lib/generators/stripe/install_generator.rb

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

data/lib/generators/templates/products.rb

@@ -0,0 +1,19 @@
+# This file contains descriptions of all your stripe products
+
+# Example
+# Stripe::Products::PRIMO #=> 'primo'
+
+# Stripe.products :primo do |products|
+#   # products name as it will appear on credit card statements
+#   products.name = 'Acme as a service PRIMO'
+#
+#   # Product, either 'service' or 'good'
+#   products.type = 'service'
+# end
+
+# Once you have your productss defined, you can run
+#
+#   rake stripe:prepare
+#
+# This will export any new plans to stripe.com so that you can
+# begin using them in your API calls.

data/lib/stripe/current_api_version.rb

@@ -0,0 +1,12 @@
+class CurrentApiVersion
+  def self.call
+    Stripe.api_version || begin
+      resp, _ = Stripe::Plan.request(:get, Stripe::Plan.resource_url)
+      resp.http_headers['stripe-version']
+    end
+  end
+
+  def self.after_switch_to_products_in_plans?
+    Date.parse(call) >= Date.parse('2018-02-05')
+  end
+end

data/lib/stripe/engine.rb

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

data/lib/stripe/plans.rb

@@ -36,24 +36,13 @@ module Stripe
       end
 
       def create_options
-        if api_version_after_switch_to_products_in_plans
+        if CurrentApiVersion.after_switch_to_products_in_plans?
           default_create_options
         else
           create_options_without_products
         end
       end
 
-      def api_version_after_switch_to_products_in_plans
-        Date.parse(current_api_version) >= Date.parse('2018-02-05')
-      end
-
-      def current_api_version
-        Stripe.api_version || begin
-          resp, _ = @stripe_class.request(:get, @stripe_class.resource_url)
-          resp.http_headers['stripe-version']
-        end
-      end
-
       def default_create_options
         {
           :currency => @currency,

data/lib/stripe/products.rb

@@ -0,0 +1,42 @@
+module Stripe
+  module Products
+    include ConfigurationBuilder
+
+    configuration_for :product do
+      attr_accessor :name,
+                    :type,
+                    :active,
+                    :attributes,
+                    :description,
+                    :caption,
+                    :metadata,
+                    :shippable,
+                    :url
+
+      validates_presence_of :name, :type
+
+      validates :active, :shippable, inclusion: { in: [true, false] }, allow_nil: true
+      validates :type, inclusion: { in: %w(service good) }
+      validates :caption, :description, :shippable, :url, absence: true, unless: :good?
+
+      private
+      def good?
+        type == 'good'
+      end
+
+      def create_options
+        {
+          name: name,
+          type: type,
+          active: active,
+          attributes: attributes,
+          description: description,
+          caption: caption,
+          metadata: metadata,
+          shippable: shippable,
+          url: url,
+        }.delete_if{|_, v| v.nil? }
+      end
+    end
+  end
+end

data/lib/stripe/rails.rb

@@ -2,6 +2,8 @@ require 'responders'
 require "stripe/rails/version"
 require 'stripe/engine'
 require 'stripe/configuration_builder'
+require 'stripe/current_api_version'
 require 'stripe/plans'
 require 'stripe/coupons'
-require 'stripe/callbacks'
+require 'stripe/products'
+require 'stripe/callbacks'

data/lib/stripe/rails/tasks.rake

@@ -1,6 +1,4 @@
-
 namespace :stripe do
-
   desc 'verify your stripe.com authentication configuration'
   task 'verify' => :environment do
     begin
@@ -11,6 +9,14 @@ namespace :stripe do
     end
   end
 
+  task 'products:prepare' => 'environment' do
+    if CurrentApiVersion.after_switch_to_products_in_plans?
+      Stripe::Products.put!
+    else
+      puts '[SKIPPED] Current API version does not support Products'
+    end
+  end
+
   task 'plans:prepare' => 'environment' do
     Stripe::Plans.put!
   end
@@ -24,6 +30,6 @@ namespace :stripe do
     Stripe::Coupons.reset!
   end
 
-  desc "create all plans and coupons defined in config/stripe/{plans|coupons}.rb"
-  task 'prepare' => ['plans:prepare', 'coupons:prepare']
+  desc "create all plans and coupons defined in config/stripe/{products|plans|coupons}.rb"
+  task 'prepare' => ['products:prepare', 'plans:prepare', 'coupons:prepare']
 end

data/lib/stripe/rails/version.rb

@@ -1,5 +1,5 @@
 module Stripe
   module Rails
-    VERSION = '1.3.0'
+    VERSION = '1.4.0'
   end
 end

data/test/coupon_builder_spec.rb

@@ -1,8 +1,6 @@
 require 'spec_helper'
 
 describe 'building coupons' do
-  parallelize_me!
-
   before do
     Stripe::Coupons.configurations.clear
   end

data/test/dummy/config/environments/development.rb

@@ -1,4 +1,5 @@
 Dummy::Application.configure do
+  config.eager_load = false
   # Settings specified here will take precedence over those in config/application.rb
 
   # In the development environment your application's code is reloaded on

data/test/product_builder_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe 'building products' do
+  before do
+    Stripe.product :primo do |product|
+      product.name        = 'Acme as a service PRIMO'
+      product.type        = 'service'
+      product.active      = true
+      product.attributes  = ['size', 'gender']
+      product.metadata    = {:number_of_awesome_things => 5}
+    end
+  end
+
+  after { Stripe::Products.send(:remove_const, :PRIMO) }
+
+  it 'is accessible via id' do
+    Stripe::Products::PRIMO.wont_be_nil
+  end
+
+  it 'is accessible via collection' do
+    Stripe::Products.all.must_include Stripe::Products::PRIMO
+  end
+
+  it 'is accessible via hash lookup (symbol/string agnostic)' do
+    Stripe::Products[:primo].must_equal  Stripe::Products::PRIMO
+    Stripe::Products['primo'].must_equal Stripe::Products::PRIMO
+  end
+
+  describe '.put!' do
+    describe 'when none exists on stripe.com' do
+      before { Stripe::Product.stubs(:retrieve).raises(Stripe::InvalidRequestError.new("not found", "id")) }
+
+      it 'creates the plan online' do
+        Stripe::Product.expects(:create).with(
+          :id => :primo,
+          :name => 'Acme as a service PRIMO',
+          :type => 'service',
+          :active => true,
+          :attributes => ['size', 'gender'],
+          :metadata => {:number_of_awesome_things => 5},
+        )
+        Stripe::Products::PRIMO.put!
+      end
+    end
+
+    describe 'when it is already present on stripe.com' do
+      before do
+        Stripe::Product.stubs(:retrieve).returns(Stripe::Product.construct_from({
+          :id => :primo,
+          :name => 'Acme as a service PRIMO',
+        }))
+      end
+
+      it 'is a no-op' do
+        Stripe::Product.expects(:create).never
+        Stripe::Products::PRIMO.put!
+      end
+    end
+  end
+
+  describe 'validations' do
+    describe 'with missing mandatory values' do
+      it 'raises an exception after configuring it' do
+        lambda { Stripe.product(:bad){} }.must_raise Stripe::InvalidConfigurationError
+      end
+    end
+
+    describe 'invalid type' do
+      it 'raises an exception during configuration' do
+        lambda {
+          Stripe.product :broken do |product|
+            product.name = 'Acme as a service BROKEN'
+            product.type = 'anything'
+          end
+        }.must_raise Stripe::InvalidConfigurationError
+      end
+    end
+
+    describe 'when using an attribute only for goods' do
+      it 'raises an exception during configuration' do
+        lambda {
+          Stripe.product :broken do |product|
+            product.name        = 'Broken Service'
+            product.type        = 'service'
+            product.caption     = 'So good it is Primo'
+          end
+        }.must_raise Stripe::InvalidConfigurationError
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stripe-rails
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Charles Lowell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-23 00:00:00.000000000 Z
+date: 2018-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -62,7 +62,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
-- ".github/release-drafter.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -84,13 +83,16 @@ files:
 - lib/generators/stripe/install_generator.rb
 - lib/generators/templates/coupons.rb
 - lib/generators/templates/plans.rb
+- lib/generators/templates/products.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/current_api_version.rb
 - lib/stripe/engine.rb
 - lib/stripe/plans.rb
+- lib/stripe/products.rb
 - lib/stripe/rails.rb
 - lib/stripe/rails/tasks.rake
 - lib/stripe/rails/testing.rb
@@ -147,6 +149,7 @@ files:
 - test/javascript_helper_spec.rb
 - test/pings_controller_spec.rb
 - test/plan_builder_spec.rb
+- test/product_builder_spec.rb
 - test/spec_helper.rb
 - test/stripe_initializers_spec.rb
 - test/support/application_system_test_case.rb
@@ -230,6 +233,7 @@ test_files:
 - test/javascript_helper_spec.rb
 - test/pings_controller_spec.rb
 - test/plan_builder_spec.rb
+- test/product_builder_spec.rb
 - test/spec_helper.rb
 - test/stripe_initializers_spec.rb
 - test/support/application_system_test_case.rb

data/.github/release-drafter.yml

@@ -1,4 +0,0 @@
-template: |
-  ## What's Changed
-
-  $CHANGES