chargebee_rails 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 561fb92b294e45b5e8751253d42b2ee6f69da36f
-  data.tar.gz: b807b9ca0edd034bfffb21e0bb8f0f9108f8b6d5
+  metadata.gz: 11ff4b416fd4203067991d079471d7368cab7d60
+  data.tar.gz: 98ed912ceacbc95089c1f12e8289a8ae649e7d5d
 SHA512:
-  metadata.gz: 02cd698ebea899fb0bcbc131e2bdcbffbb6ff489b9d2d1d3f4833c7c652e6a9e96bfa8b84f593aaaaeda742b81c209abd32373034027475353216f98d041dc9e
-  data.tar.gz: ff12e20b15178b51f12e2d4420990dc8f6533b8bac96dc2bcef8a5a0bd3bf3719567dcb1145410f48b249e3dd1fb8dddd8a3d34326c49a485de39f7386fcb476
+  metadata.gz: e476b76a87343f79a4a1b8afea8fb1b0b5c667ccbb9db5aac92fbb28640debb17281ffc3c31c703bd79a9030bac292657285fa63f18797774bcb70dbb0745db3
+  data.tar.gz: 41ad4b3e6163f875d3f5b605f27d4a04efc6098735a9f88c8e0283eeb0ba7e5925ba7c7ab32566864ba13b24673d38f1c3c4960257034a53c4a94fd6fb7e3047

data/README.md

@@ -1,4 +1,7 @@
 # Chargebee Rails
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/2f9b7a79d17605b51f5e/maintainability)](https://codeclimate.com/github/spritlesoftware/chargebee-rails-subscriptions/maintainability)
+
 This is the Rails gem for integrating with Chargebee. If you're new to Chargebee, sign up for an account [here](https://www.chargebee.com).
 
 [Introduction](#introduction)
@@ -67,7 +70,7 @@ If the rest-client version is less than 1.8.0, update the latest version by runn
 
 # Installation
 
-##Step 1: Install the “chargebee_rails” gem to your application
+### Step 1: Install the “chargebee_rails” gem to your application
 
 Add the below line to your Gemfile:
 
@@ -87,7 +90,7 @@ And, run
 ```
 
 
-##Step 2:  Add Subscription models to your app
+### Step 2:  Add Subscription models to your app
 
 The entity that uniquely identifies a customer account within your application is referred to as a subscription owner module. For example, if you are building a CRM application, the entity that represents the customer’s account will be your subscription owner entity.
 
@@ -119,7 +122,7 @@ Now, you will have models and database tables set for subscriptions, plans, paym
 
 
 
-##Step 3: Set up Chargebee
+### Step 3: Set up Chargebee
 
 
 Configure your Chargebee site name and API key in the `config/initializers/chargebee_rails.rb` file. 
@@ -137,12 +140,12 @@ Configure your Chargebee site name and API key in the `config/initializers/charg
 ```
 
 
-##Gateway credentials
+## Gateway credentials
 
 Payment Gateway credentials have to be set up in Chargebee under *Settings> Site Settings> Gateway Settings*.
 
 
-##Webhook notifications
+## Webhook notifications
 
 You can set up basic authentication for your incoming webhook notifications in `config/initializers/chargebee_rails.rb` file. 
 
@@ -156,7 +159,7 @@ You can set up basic authentication for your incoming webhook notifications in `
 
 
 
-##Set the controller name used to handle webhooks
+## Set the controller name used to handle webhooks
 
 If you’d like to use a different controller to handle webhooks, you can extend the `ChargebeeRails::WebhookController` and add the controller name in config.webhook_handler.
 
@@ -178,7 +181,7 @@ For instance, if you have a controller *MyAppEventsController* in the `my_app_ev
 
 ```
 
-##Configure the webhook url in Chargebee
+## Configure the webhook url in Chargebee
 
 Configure the webhook url in Chargebee under *API & Webhooks> Webhook* Settings. The path can be specified as shown below:
 
@@ -193,7 +196,7 @@ Configure the webhook url in Chargebee under *API & Webhooks> Webhook* Settings.
 The webhook url for your site will be  _http(s)://<your-domain>.com/chargebee_rails_event_. 
 
 
-##Sync plans
+## Sync plans
 
 Currently Chargebee does not support webhook notifications for addition, update and removal of Plans. However, this gem comes with a rake task to sync plans between Chargebee and your application. Hence, each time a plan is created in Chargebee, it will automatically be synced with your application. In the future, we will have webhooks events in place to support plan related operations. Once that's done, the rake task’s code will be included as part of the event handler.
 
@@ -209,7 +212,7 @@ The plans can be synced to your application using the following command:
 **Note**: The archived plans will also be synced in this method.
 
 
-##Sync failed events
+## Sync failed events
 
 Chargebee attempts to send webhook notifications for upto 2 days. After 2 days, if the webhook event has failed due to some reason, the webhook’s status is marked as “Failed” and further attempts are stopped.  Once the error has been fixed at your end, the rake task will sync the failed events with your application. The failed events will be selectively sent to the webhook handler as well as hook methods, provided the event does not have an outdated update.
 
@@ -222,7 +225,7 @@ Chargebee attempts to send webhook notifications for upto 2 days. After 2 days,
 
 
 
-##Sync events with your application##
+## Sync events with your application
 
 The event types listed below are synced with the application by this gem
 
@@ -256,7 +259,7 @@ The event types listed below are synced with the application by this gem
 
 
 
-##Configure your default plan Id##
+## Configure your default plan Id#
 
 When a customer signs up for a trial account, you will associate the subscription with a particular plan in Chargebee. This plan can be configured as the default plan in the gem, so that the the plan name is automatically passed during subscription creation.
 This way, when calling the [create a subscription](https://apidocs.chargebee.com/docs/api/subscriptions#create_a_subscription) API, if the plan id is not passed in the subscription method,  it will be taken from `config.default_plan_id`.
@@ -270,7 +273,7 @@ This way, when calling the [create a subscription](https://apidocs.chargebee.com
 
 
 
-##Advanced settings##
+## Advanced settings
 
 If you would like to control the subscription upgrade/downgrade behaviour, you can specify this in:
 
@@ -309,7 +312,7 @@ If you’d like to include delayed charges during [update_subscription_estimate]
 
  ```
 
-##Customer
+## Customer
 
 **Retrieve as Chargebee Customer**
 
@@ -346,7 +349,7 @@ If you’d like to include delayed charges during [update_subscription_estimate]
  ```
 
 
-##Subscription
+## Subscription
 
 **Create a Subscription**
 

data/app/controllers/chargebee_rails/webhooks_controller.rb

@@ -1,7 +1,7 @@
 module ChargebeeRails
   class WebhooksController < ActionController::Base
     include WebhookHandler
-    before_filter :authenticate, if: "ChargebeeRails.configuration.secure_webhook_api"
+    before_action :authenticate, if: :chargebee_configuration_webhook
 
     # Handle ChargeBee webhook events
     # From the post request received from chargebee, the event for which the
@@ -20,6 +20,10 @@ module ChargebeeRails
 
     private
 
+    def chargebee_configuration_webhook
+      ChargebeeRails.configuration.secure_webhook_api
+    end
+
     def log_errors(e)
       logger.error e.message
       e.backtrace.each { |line| logger.error " #{line}" }

data/lib/chargebee_rails.rb

@@ -11,13 +11,15 @@ require "chargebee_rails/subscription_builder"
 require "chargebee_rails/hosted_page_subscription_manager"
 require "chargebee_rails/customer"
 require "chargebee_rails/metered_billing"
+require "chargebee_rails/sync_plans"
+
 
 module ChargebeeRails
   # This method is used to update the chargebee customer and also reflects the
   # changes to the subscription owner in the application.
   # * *Args*    :
   #   - +customer+ -> the subscription owner
-  #   - +options+ -> the options hash allowed for customer update in chargebee 
+  #   - +options+ -> the options hash allowed for customer update in chargebee
   # For more details on the options hash, refer the input parameters for
   # https://apidocs.chargebee.com/docs/api/customers?lang=ruby#update_a_customer
   # * *Returns* :
@@ -32,11 +34,11 @@ module ChargebeeRails
   end
 
   # Update the billing information of the chargebee customer. The changes in the
-  # billing details are also reflected in the subscription owner's 
-  # +chargebee_customer_data+ 
+  # billing details are also reflected in the subscription owner's
+  # +chargebee_customer_data+
   # * *Args*    :
   #   - +customer+ -> the subscription owner
-  #   - +options+ -> the options hash allowed for updating customer billing info in chargebee 
+  #   - +options+ -> the options hash allowed for updating customer billing info in chargebee
   # For more details on the options hash, refer the input parameters for
   # https://apidocs.chargebee.com/docs/api/customers?lang=ruby#update_billing_info_for_a_customer
   # * *Returns* :
@@ -50,11 +52,11 @@ module ChargebeeRails
     customer
   end
 
-  # Add contacts to a chargebee customer, the subscription owner 
+  # Add contacts to a chargebee customer, the subscription owner
   # and the contact details hash is given as options.
   # * *Args*    :
   #   - +customer+ -> the subscription owner
-  #   - +options+ -> the options hash allowed for adding contacts to customer in chargebee 
+  #   - +options+ -> the options hash allowed for adding contacts to customer in chargebee
   # For more details on the options hash, refer the input parameters for
   # https://apidocs.chargebee.com/docs/api/customers?lang=ruby#add_contacts_to_a_customer
   # * *Returns* :
@@ -71,7 +73,7 @@ module ChargebeeRails
   # subscription owner
   # * *Args*    :
   #   - +customer+ -> the subscription owner
-  #   - +options+ -> the options hash allowed for updating customer contacts in chargebee 
+  #   - +options+ -> the options hash allowed for updating customer contacts in chargebee
   # For more details on the options hash, refer the input parameters for
   # https://apidocs.chargebee.com/docs/api/customers?lang=ruby#update_contacts_for_a_customer
   # * *Returns* :

data/lib/chargebee_rails/hosted_page_subscription_manager.rb

@@ -22,7 +22,10 @@ module ChargebeeRails
     # from the subscription details got from chargebee's hosted page
     def update
       @subscription = @customer.subscription
-      @subscription.update(subscription_attrs)
+
+      #if we're just updating the payment method, then the subscription can be empty
+      @subscription.update(subscription_attrs) if hosted_subscription.present?
+
       manage_payment_method if hosted_payment_method.present?
       @subscription
     end

data/lib/chargebee_rails/subscription.rb

@@ -51,6 +51,21 @@ module ChargebeeRails
       update(subscription_attrs(chargebee_subscription, self.plan))
     end
 
+    #
+    # Remove scheduled changes to the subscription
+    #
+    def remove_scheduled_changes
+      begin
+      chargebee_subscription = ChargeBee::Subscription.remove_scheduled_changes(
+        chargebee_id
+      ).subscription
+      update(subscription_attrs(chargebee_subscription, self.plan))
+      rescue ChargeBee::InvalidRequestError
+        Rails.logger.warn("No changes are scheduled for this subscription")
+      end
+
+    end
+
     #
     # Add or remove addons for the subscription
     # * *Args*    :

data/lib/chargebee_rails/sync_plans.rb

@@ -0,0 +1,92 @@
+module ChargebeeRails
+  class SyncPlans
+    attr_accessor :messages
+
+  	def self.sync(create:true, update:true, delete:false)
+  		syncer = SyncPlans.new
+  		return syncer.do_sync(create:create, update:update, delete:delete)
+  	end
+
+  	def do_sync(create:true, update:true, delete:false)
+  		self.get_plans
+  		self.sync_plans(create:create, update:update, delete:delete)
+
+      return messages
+  	end
+
+  protected
+
+  def output(message)
+    puts(message)
+    self.messages ||= []
+    self.messages << message
+  end
+
+  def get_plans
+      loop do
+        plan_list = retrieve_plan_list
+        @offset = plan_list.next_offset
+        cb_plans << plan_list.flat_map(&:plan)
+        break unless @offset.present?
+      end
+      @cb_plans = cb_plans.flatten
+  end
+
+  def cb_plans
+    @cb_plans ||= []
+  end
+
+  def sync_plans(create:true, update:true, delete:false)
+    output "Removed #{remove_plans.count} plan(s)" if (delete)
+    output "Created #{create_new_plans.count} plan(s)" if (create)
+    output "Updated all #{update_all_plans.count} plan(s)" if (update)
+  end
+
+  # Retrieve the plan list from chargebee
+  def retrieve_plan_list
+    options = { limit: 100 }
+    options[:offset] = @offset if @offset.present?
+    ChargeBee::Plan.list(options)
+  end
+
+  # Remove plans from application that do not exist in chargebee
+  def remove_plans
+    cb_plan_ids = cb_plans.flat_map(&:id)
+    Plan.all.reject { |plan| cb_plan_ids.include?(plan.plan_id) }
+            .each   { |plan| output "Deleting Plan - #{plan.plan_id}"; plan.destroy }
+  end
+
+  # Create new plans that are not present in app but are available in chargebee
+  def create_new_plans
+    plan_ids = Plan.all.map(&:plan_id)
+    cb_plans.reject { |cb_plan| plan_ids.include?(cb_plan.id) }
+            .each   { |new_plan| output "Creating Plan - #{new_plan.id}"; Plan.create(plan_params(new_plan)) }
+  end
+
+  # Update all existing plans in the application
+  def update_all_plans
+    cb_plans.map do |cb_plan|
+      Plan.find_by(plan_id: cb_plan.id).update(plan_params(cb_plan))
+    end
+  end
+
+  # Build the plan params to be created or updated in the application
+  def plan_params plan
+    {
+      name: plan.name,
+      plan_id: plan.id,
+      status: plan.status,
+      chargebee_data: {
+        price: plan.price,
+        period: plan.period,
+        period_unit: plan.period_unit,
+        trial_period: plan.trial_period,
+        trial_period_unit: plan.trial_period_unit,
+        charge_model: plan.charge_model,
+        free_quantity: plan.free_quantity
+      }
+    }
+  end
+
+  end
+end

data/lib/chargebee_rails/version.rb

@@ -1,4 +1,4 @@
 # :nodoc:all
 module ChargebeeRails
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/chargebee_rails/webhook_handler.rb

@@ -5,8 +5,16 @@ module ChargebeeRails
     # Handle the ChargeBee event retrieved from webhook and call the
     # corresponding event type handler for the event
     def handle(chargebee_event)
-      @chargebee_event = chargebee_event
-      sync_events_list.include?(event.event_type) ? sync_events : send(event.event_type)
+        @chargebee_event = chargebee_event
+        if sync_events_list.include?(event.event_type)
+            sync_events
+        end
+
+        if self.respond_to?(event.event_type)
+            send(event.event_type)
+        else
+            Rails.logger.warn("Unrecognised chargebee event type #{event.event_type}")
+        end
     end
 
     # Set event as ChargeBee event
@@ -14,7 +22,37 @@ module ChargebeeRails
       @event ||= @chargebee_event
     end
 
-    # All the event types in ChargeBee
+    # All the event types in ChargeBee as of API V2
+
+    def plan_created; end
+
+    def plan_updated; end
+
+    def plan_deleted; end
+
+    def addon_created; end
+
+    def addon_updated; end
+
+    def addon_deleted; end
+
+    def coupon_created; end
+
+    def coupon_updated; end
+
+    def coupon_deleted; end
+
+    def coupon_set_created; end
+
+    def coupon_set_updated; end
+
+    def coupon_set_deleted; end
+
+    def coupon_codes_added; end
+
+    def coupon_codes_deleted; end
+
+    def coupon_codes_updated; end
 
     def customer_created; end
 
@@ -22,6 +60,10 @@ module ChargebeeRails
 
     def customer_deleted; end
 
+    def customer_moved_out; end
+
+    def customer_moved_in; end
+
     def subscription_created; end
 
     def subscription_started; end
@@ -44,6 +86,10 @@ module ChargebeeRails
 
     def subscription_scheduled_cancellation_removed; end
 
+    def subscription_changes_scheduled; end
+
+    def subscription_scheduled_changes_removed; end
+
     def subscription_shipping_address_updated; end
 
     def subscription_deleted; end
@@ -61,7 +107,7 @@ module ChargebeeRails
     def credit_note_created; end
 
     def credit_note_updated; end
-    
+
     def credit_note_deleted; end
 
     def subscription_renewal_reminder; end
@@ -79,9 +125,11 @@ module ChargebeeRails
     def payment_refunded; end
 
     def payment_initiated; end
-    
+
     def refund_initiated; end
-    
+
+    def netd_payment_due_reminder; end
+
     def card_added; end
 
     def card_updated; end
@@ -92,10 +140,25 @@ module ChargebeeRails
 
     def card_deleted; end
 
+    def payment_source_added; end
+
+    def payment_source_updated; end
+
+    def payment_source_deleted; end
+
+    def unbilled_charges_created; end
+
+    def unbilled_charges_voided; end
+
+    def unbilled_charges_deleted; end
+
+    def unbilled_charges_invoiced; end
+
+
     private
 
     def sync_events_list
-      %w( 
+      %w(
         card_expired
         card_updated
         card_expiry_reminder
@@ -141,7 +204,7 @@ module ChargebeeRails
         plan_id: ::Plan.find_by(plan_id: subscription.plan_id).id,
         plan_quantity: subscription.plan_quantity,
         status: subscription.status,
-        event_last_modified_at: event.occurred_at,
+        event_last_modified_at: Time.at(event.occurred_at),
         updated_at: Time.now,
         chargebee_data: chargebee_subscription_data(subscription)
       }
@@ -153,7 +216,8 @@ module ChargebeeRails
         next_renewal_at: subscription.current_term_end,
         cancelled_at: subscription.cancelled_at,
         is_scheduled_for_cancel: (subscription.status == 'non-renewing' ? true : false),
-        has_scheduled_changes: subscription.has_scheduled_changes
+        has_scheduled_changes: subscription.has_scheduled_changes,
+        addons: subscription.addons
       }
     end
 
@@ -163,10 +227,10 @@ module ChargebeeRails
         auto_collection: customer.auto_collection,
         payment_type: customer.payment_method.type,
         reference_id: customer.payment_method.reference_id,
-        card_last4: card.last4,
-        card_type: card.card_type,
+        card_last4: card && card.last4,
+        card_type: card && card.card_type,
         status: customer.payment_method.status,
-        event_last_modified_at: event.occurred_at,
+        event_last_modified_at: Time.at(event.occurred_at),
         updated_at: Time.now
       }
     end

data/lib/tasks/sync_plans.rake

@@ -1,82 +1,11 @@
+require 'chargebee_rails/sync_plans'
+
 namespace :chargebee_rails do
+  #include ChargebeeRails#
 
   desc "chargebee plans sync with application"
   task :sync_plans => :environment do
-    # Prompt user input to get confirmation of the plan sync
-    begin
-      STDOUT.puts "\n This will sync plans in your application with chargebee, do you want to continue ? [y/n]"
-      input = STDIN.gets.strip.downcase
-    end until %w(y n).include?(input)
-    if input == "y"
-      # Keep collecting the plans from chargebee until an offset is not provided
-      loop do
-        plan_list = retrieve_plan_list
-        @offset = plan_list.next_offset
-        cb_plans << plan_list.flat_map(&:plan)
-        break unless @offset.present?
-      end
-      @cb_plans = cb_plans.flatten
-      sync_plans
-    else
-      STDOUT.puts "Plan sync aborted!"
-    end
-  end
-
-  private
-
-  def cb_plans
-    @cb_plans ||= []
-  end
-
-  def sync_plans
-    # puts "Removed #{remove_plans.count} plan(s)"
-    puts "Created #{create_new_plans.count} plan(s)"
-    # puts "Updated all #{update_all_plans.count} plan(s)"
-  end
-
-  # Retrieve the plan list from chargebee
-  def retrieve_plan_list
-    options = { limit: 100 }
-    options[:offset] = @offset if @offset.present?
-    ChargeBee::Plan.list(options)
+    ChargebeeRails::SyncPlans.sync
   end
 
-  # Remove plans from application that do not exist in chargebee
-  def remove_plans
-    cb_plan_ids = cb_plans.flat_map(&:id)
-    Plan.all.reject { |plan| cb_plan_ids.include?(plan.plan_id) }
-            .each   { |plan| puts "Deleting Plan - #{plan.plan_id}"; plan.destroy }
-  end
-
-  # Create new plans that are not present in app but are available in chargebee
-  def create_new_plans
-    plan_ids = Plan.all.map(&:plan_id)
-    cb_plans.reject { |cb_plan| plan_ids.include?(cb_plan.id) }
-            .each   { |new_plan| puts "Creating Plan - #{new_plan.id}"; Plan.create(plan_params(new_plan)) }
-  end
-
-  # Update all existing plans in the application
-  def update_all_plans
-    cb_plans.map do |cb_plan|
-      Plan.find_by(plan_id: cb_plan.id).update(plan_params(cb_plan))
-    end
-  end
-
-  # Build the plan params to be created or updated in the application
-  def plan_params plan
-    {
-      name: plan.name,
-      plan_id: plan.id,
-      status: plan.status,
-      chargebee_data: {
-        price: plan.price,
-        period: plan.period,
-        period_unit: plan.period_unit,
-        trial_period: plan.trial_period,
-        trial_period_unit: plan.trial_period_unit,
-        charge_model: plan.charge_model,
-        free_quantity: plan.free_quantity
-      }
-    }
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chargebee_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Chargebee
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-29 00:00:00.000000000 Z
+date: 2019-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chargebee
@@ -166,6 +166,7 @@ files:
 - lib/chargebee_rails/metered_billing.rb
 - lib/chargebee_rails/subscription.rb
 - lib/chargebee_rails/subscription_builder.rb
+- lib/chargebee_rails/sync_plans.rb
 - lib/chargebee_rails/version.rb
 - lib/chargebee_rails/webhook_handler.rb
 - lib/generators/chargebee_rails/install_generator.rb
@@ -203,4 +204,3 @@ signing_key:
 specification_version: 4
 summary: A subscription management gem for Rails with ChargeBee.
 test_files: []
-has_rdoc: