colt 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 358052b6cbdb6930c17f1beba72d6539b3b5d024
-  data.tar.gz: 51f8911325af53efdf7f45a84a192ddf3600a400
+  metadata.gz: c509e05ca3f0604b1c6726d3ba025b19de7bf7cd
+  data.tar.gz: 98addf173347dcbbabba501ac88025dcbb6e947c
 SHA512:
-  metadata.gz: e6c752768d7a60e541220f8f3c23fd95e385a3a81ec816d0c49edbcf98742c0621ced7b29b38769a597f860a7a6601aed865b437d744568a8bb3c2cd34a4345e
-  data.tar.gz: 332cd7e3264db657c1565df2a23238b77d3cb2c30b1079a99bd179c82b4a5cb2076de4c1bfa69d998b4060584c840f7804b9a4b72639d8e299955ca0e45052a9
+  metadata.gz: aadae8203559ce61714d601908c624161ec6957c2ab378059112ad5b9df0494fd114672b9e517691ec8f22b4949e2b36b6802ddbc2c8fa466c6a9b67f3a5445e
+  data.tar.gz: 98057ccfb2b431b195b286188f5125aeb95650017996ac4c5607ad92fc49f87a5611ce7600de0e6126bd09abe727557e670950459e91e852e6998567ae47f2ec

data/README.md

@@ -1,11 +1,19 @@
 # Colt
 
-Colt is a micro gem used to subscribe to a given plan using the Stripe API. The plans must already exist in your account. It provides methods to add, update and save credit cards on Stripe servers. To experiment with the code, run `bin/console` for an interactive prompt.
+Colt is a micro gem used to subscribe to a given plan using the Stripe API. The plans must already exist in your account. To experiment with the code, run `bin/console` for an interactive prompt.
 
 ## Our Sponsor
 
 This project is sponsored by Zepho Inc. If you are interested in learning TDD in Ruby, you can redeem the coupon here: https://www.udemy.com/learn-test-driven-development-in-ruby/?couponCode=svr
 
+## Features:
+
+1. Recurring billing
+	- Subscribe to a plan
+	- Change plan 
+	- Cancel subscription
+2. Process Subscription Payment Failures for Webhooks
+
 ## Version
 
 Ruby 	   : 2.2.3
@@ -38,10 +46,9 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). To run the tests:
 
 ```ruby
-$ruby -rminitest/pride test/credential_test.rb --verbose
 $ruby -rminitest/pride test/colt_integration_test.rb --verbose
 $ruby -rminitest/pride test/subscription_test.rb --verbose
-$ruby -rminitest/pride test/credit_card_test.rb --verbose
+$ruby -rminitest/pride test/subscription_payment_test.rb --verbose
 ```
 
 or 

data/colt.gemspec

@@ -24,5 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.8"
-  spec.add_development_dependency "rubycritic"
+  spec.add_development_dependency "rubycritic", "~> 1.4"
 end

data/lib/colt.rb

@@ -1,10 +1,8 @@
 require "stripe"
 
 require "colt/version"
-require "colt/credential"
 require "colt/subscription"
 require "colt/subscription_payment"
-require "colt/credit_card"
 
 module Colt
   STRIPE_API_VERSION = '2015-09-03 (latest)'  

data/lib/colt/subscription.rb

@@ -2,6 +2,13 @@ require 'stripe'
 
 module Colt
   class Subscription
+    
+    #
+    # email        : The email of the customer
+    # stripe_token : Token representing the credit card
+    #
+    # Returns      : Stripe::Customer object
+    # 
     def self.create(email, stripe_token, plan_id, description='none')
       Stripe::Customer.create(email:       email, 
                               description: description, 
@@ -9,11 +16,22 @@ module Colt
                               plan:        plan_id)
     end
     
+    #
+    # customer_id : Stripe customer to add a new credit card 
+    # plan_id     : The plan to subscribe the customer. It is a string like 'gold'.
+    #
+    # Returns     :  Stripe::Subscription object
+    #
     def self.update(customer_id, plan_id)
       customer = Stripe::Customer.retrieve(customer_id)
       customer.update_subscription(plan: plan_id)
     end
     
+    #
+    # customer_id : Stripe customer to add a new credit card 
+    #
+    # Returns     : Stripe::Subscription object
+    #
     def self.cancel(customer_id)
       customer = Stripe::Customer.retrieve(customer_id) 
       customer.cancel_subscription

data/lib/colt/version.rb

@@ -1,3 +1,3 @@
 module Colt
-  VERSION = "0.4.3"
+  VERSION = "0.4.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: colt
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Bala Paranj
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-04 00:00:00.000000000 Z
+date: 2015-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stripe
@@ -70,16 +70,16 @@ dependencies:
   name: rubycritic
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 description: This gem simplifies subscribing a user to a given recurring plan using
   Stripe API.
 email:
@@ -92,7 +92,6 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
-- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -101,8 +100,6 @@ files:
 - bin/setup
 - colt.gemspec
 - lib/colt.rb
-- lib/colt/credential.rb
-- lib/colt/credit_card.rb
 - lib/colt/subscription.rb
 - lib/colt/subscription_payment.rb
 - lib/colt/version.rb
@@ -126,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: A micro gem to subscribe to a plan using stripe gem.

data/CHANGELOG.md

@@ -1,4 +0,0 @@
-== Version 0.1.1 on July 2, 2015
-
-- Check for Stripe API version
-- Check for Stripe credentials

data/lib/colt/credential.rb

@@ -1,23 +0,0 @@
-module Colt
-  class Credential
-    def self.check
-      message = <<ERROR 
-  Stripe credentials is not set properly or it is incorrect. 
-  Define the following Stripe environment variables.
-
-  export STRIPE_PUBLISHABLE_KEY='pk_test your publishable key' 
-  export STRIPE_SECRET_KEY='sk_test your secret key'
-  
-  and define:
-  
-  Stripe.api_key = 'sk_test your secret key'
-ERROR
-      begin
-        ::Stripe::Account.retrieve
-      rescue ::Stripe::AuthenticationError => exception
-        raise exception
-      end      
-    end
-  end
-end
-

data/lib/colt/credit_card.rb

@@ -1,38 +0,0 @@
-module Colt
-
-  class CreditCard
-    #
-    # Adds a new credit card as the active default card for an existing customer
-    #
-    # Returns : ?
-    def self.add(stripe_customer_id, stripe_token)
-      customer = Stripe::Customer.retrieve(stripe_customer_id)
-      card = customer.sources.create(source: stripe_token)
-      customer.default_card = card.id
-      customer.save
-      card
-    end
-
-    #
-    # Create a new credit card for a customer
-    #
-    # Returns : ?
-    def self.save(stripe_token, description)
-      Stripe::Customer.create(card: stripe_token, description: description)
-    end
-
-    #
-    # Update expiration date of an existing credit card for a customer
-    #    
-    # Returns ?
-    def self.update_expiration_date(stripe_customer_id, card_month, card_year)
-      customer = Stripe::Customer.retrieve(stripe_customer_id)
-      card = customer.sources.first
-      card.exp_month = card_month
-      card.exp_year = card_year
-      card.save      
-    end
-    
-  end
-
-end