chargebee_rails 0.1.3

data/lib/generators/chargebee_rails/install_generator.rb

@@ -0,0 +1,58 @@
+# This generator is based on rails_admin's install generator.
+# https://www.github.com/sferik/rails_admin/master/lib/generators/rails_admin/install_generator.rb
+
+require 'rails/generators'
+
+# http://guides.rubyonrails.org/generators.html
+
+module ChargebeeRails
+  class InstallGenerator < Rails::Generators::Base
+
+    include Rails::Generators::Migration
+
+    argument :subscriber_model, :type => :string, :required => true, :desc => "Owner of the subscription"
+    desc "ChargebeeRails installation generator"
+
+    # The path for the custom migration templates
+    def self.source_paths
+      [File.expand_path("../templates", __FILE__)]
+    end
+
+    # Next migration number
+    def self.next_migration_number(dir)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    # Override subscriber_model to ensure it is always returned lowercase.
+    def subscriber_model
+      @subscriber_model.downcase
+    end
+
+    def install
+
+      # Generate chargebee_rails configuration file template
+      template "config/initializers/chargebee_rails.rb"
+
+      # Generate plan.
+      generate("model", "plan name:string plan_id:string status:string chargebee_data:text")
+      template "app/models/plan.rb"
+
+      # Generate subscription.
+      migration_template "new_subscription_migration.rb", "db/migrate/create_subscriptions.rb"
+      template "app/models/subscription.rb"
+
+      # Generate payment methods.
+      generate("model", "payment_method cb_customer_id:string auto_collection:boolean payment_type:string reference_id:string card_last4:string card_type:string status:string event_last_modified_at:datetime subscription:references")
+
+      # Generate chargebee rails event.
+      migration_template "event_sync_log_migration.rb", "db/migrate/create_event_sync_log.rb"
+
+      # Add related fields to the subscription owner table
+      generate("migration", "add_chargebee_id_to_#{subscriber_model} chargebee_id:string event_last_modified_at:datetime chargebee_data:text")
+
+      # Specify the relationship between subscription and owner
+      inject_into_class "app/models/#{subscriber_model}.rb", subscriber_model.camelize.constantize,
+                        "  include ChargebeeRails::Customer\n\n  # Added by ChargebeeRails.\n  has_one :subscription\n  serialize :chargebee_data, JSON\n"
+    end
+  end
+end

data/lib/generators/chargebee_rails/templates/app/models/payment_method.rb

@@ -0,0 +1,3 @@
+class PaymentMethod
+  belongs_to :subscription
+end

data/lib/generators/chargebee_rails/templates/app/models/plan.rb

@@ -0,0 +1,4 @@
+class Plan < ActiveRecord::Base
+  has_many :subscriptions
+  serialize :chargebee_data, JSON
+end

data/lib/generators/chargebee_rails/templates/app/models/subscription.rb

@@ -0,0 +1,7 @@
+class Subscription < ActiveRecord::Base
+  belongs_to :<%= subscriber_model %>
+  belongs_to :plan
+  has_one :payment_method
+  include ChargebeeRails::Subscription
+  serialize :chargebee_data, JSON
+end

data/lib/generators/chargebee_rails/templates/config/initializers/chargebee_rails.rb

@@ -0,0 +1,38 @@
+ChargebeeRails.configure do |config|
+  # This will be the default plan when a subscription is not provided with one
+  # make sure that this plan exists in your active record model
+  # config.default_plan_id = 'your_default_plan_id'
+
+  # Specify the default end of term value for subscription related changes like 
+  # subscription updation and cancellation. Setting this as true will make the 
+  # changes for subscription at end of term or at next renewal. Reference - 
+  # https://apidocs.chargebee.com/docs/api/subscriptions#update_a_subscription
+  # config.end_of_term = false
+
+  # Set default proration for subscription related changes Reference - 
+  # https://apidocs.chargebee.com/docs/api/subscriptions#update_a_subscription
+  # config.proration = true
+
+  # Configure the default behavior of including delayed charges while estimating
+  # Reference - https://apidocs.chargebee.com/docs/api/estimates#update_subscription_estimate
+  # config.include_delayed_charges = { changes_estimate: false, renewal_estimate: true }
+  
+  # setup chargebee with your site and api_key
+  config.chargebee_site = 'CHARGEBEE_SITE'
+  config.chargebee_api_key = 'CHARGEBEE_API_KEY'
+
+  # Webhook related configurations
+  # Set the controller name that is used to override the webhook events
+  # config.webhook_handler = 'webhook_overriding_controller_name' 
+
+  # Configure your own webhook path for ChargeBee events
+  # the default_path is 'chargebee_rails_event'
+  # config.webhook_api_path = 'your_webhook_path'
+
+  # Set this as true if you have enabled basic http authentication for your
+  # webhook api
+  # config.secure_webhook_api = true
+
+  # Set the authentication credentials for securing your webhook api
+  # config.webhook_authentication = {user: nil, secret: nil}
+end

data/lib/generators/chargebee_rails/templates/event_sync_log_migration.rb

@@ -0,0 +1,8 @@
+class CreateEventSyncLog < ActiveRecord::Migration
+  def change
+    create_table :event_sync_logs do |t|
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/generators/chargebee_rails/templates/new_subscription_migration.rb

@@ -0,0 +1,16 @@
+class CreateSubscriptions < ActiveRecord::Migration
+  def change
+    create_table :subscriptions do |t|
+      t.string :chargebee_id
+      t.references :plan, index: true, foreign_key: true
+      t.integer :plan_quantity, default: 1
+      t.references :<%= subscriber_model %>, index: true, foreign_key: true
+      t.string :status
+      t.datetime :event_last_modified_at
+      t.text :chargebee_data
+
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/tasks/chargebee_rails_tasks.rake

@@ -0,0 +1,7 @@
+namespace :chargebee_rails do
+  # Rake task to setup the necessary tables for subscription
+  desc "Install ChargebeeRails"
+  task :install do
+    system 'rails g chargebee_rails:install'
+  end
+end

data/lib/tasks/sync_failed_events.rake

@@ -0,0 +1,72 @@
+require 'chargebee_rails/webhook_handler'
+
+namespace :chargebee_rails do
+  include ChargebeeRails::WebhookHandler
+  
+  desc "Sync Failed Events"
+  task sync_failed_events: :environment do
+    # Keep collecting the failed events until no offset is present
+    loop do
+      event_list = retrieve_failed_events
+      @offset = event_list.next_offset
+      failed_events << event_list.flat_map(&:event)
+      break unless @offset.present?
+    end
+    @failed_events = failed_events.flatten
+    puts "Syncing events..."
+    sync_failed_events
+    update_event_synced_at
+  end
+
+  def failed_events
+    @failed_events ||= []
+  end
+
+  # Retrieve the failed events from chargebee
+  def retrieve_failed_events
+    options[:start_time] = events_last_synced_at.to_i # Integer timestamp of the last time this rake task ran
+    options[:offset] = @offset if @offset.present? # Pass the offset if it is present
+    ChargeBee::Event.list(options)
+  end
+
+  # Send all the failed events to the ChargebeeRails::WebhookHandler
+  def sync_failed_events
+    failed_events.each do |chargebee_event|
+      handle(chargebee_event)
+    end
+  end
+
+  # Build the options to retrieve the failed events from chargebee 
+  def options
+    @options ||= {
+      limit: 100,
+      webhook_status: 'failed',
+      end_time: Time.now.to_i
+    }
+  end
+
+  # Get the time the rake task was last run
+  def events_last_synced_at
+    select_query = "SELECT * FROM event_sync_logs;"
+    event_sync_logs = ActiveRecord::Base.connection.execute(select_query)
+    Time.parse(event_sync_logs.first['updated_at']) if event_sync_logs.first.present?
+  end
+
+  # Update the event_sync_logs table with the time once the rake task is completed
+  def update_event_synced_at
+    events_last_synced_at.present? ? update_record : insert_new_record
+  end
+
+  # Set the updated_at column of the existing event_sync_log record
+  def update_record
+    update_query = "UPDATE event_sync_logs SET updated_at='#{Time.now}' WHERE id=1 ;"
+    ActiveRecord::Base.connection.execute(update_query)
+  end
+
+  # Create new event_sync_logs record for the first time the rake task is run 
+  def insert_new_record
+    insert_query = "INSERT INTO event_sync_logs (id, created_at, updated_at) VALUES (1, '#{Time.now}', '#{Time.now}');"
+    ActiveRecord::Base.connection.execute(insert_query)
+  end
+
+end

data/lib/tasks/sync_plans.rake

@@ -0,0 +1,82 @@
+namespace :chargebee_rails do
+
+  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)
+  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

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: chargebee_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Chargebee
+- Spritle
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chargebee
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  This gem provides developers with the ability to easily
+                          integrate chargebee's subscription management into their
+                          application backed by active record models.
+email:
+- chargebee@spritle.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/controllers/chargebee_rails/webhooks_controller.rb
+- config/routes.rb
+- lib/chargebee_rails.rb
+- lib/chargebee_rails/configuration.rb
+- lib/chargebee_rails/customer.rb
+- lib/chargebee_rails/engine.rb
+- lib/chargebee_rails/errors.rb
+- lib/chargebee_rails/hosted_page_subscription_manager.rb
+- lib/chargebee_rails/metered_billing.rb
+- lib/chargebee_rails/subscription.rb
+- lib/chargebee_rails/subscription_builder.rb
+- lib/chargebee_rails/version.rb
+- lib/chargebee_rails/webhook_handler.rb
+- lib/generators/chargebee_rails/install_generator.rb
+- lib/generators/chargebee_rails/templates/app/models/payment_method.rb
+- lib/generators/chargebee_rails/templates/app/models/plan.rb
+- lib/generators/chargebee_rails/templates/app/models/subscription.rb
+- lib/generators/chargebee_rails/templates/config/initializers/chargebee_rails.rb
+- lib/generators/chargebee_rails/templates/event_sync_log_migration.rb
+- lib/generators/chargebee_rails/templates/new_subscription_migration.rb
+- lib/tasks/chargebee_rails_tasks.rake
+- lib/tasks/sync_failed_events.rake
+- lib/tasks/sync_plans.rake
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A subscription management gem for Rails with ChargeBee.
+test_files: []
+has_rdoc: