chargebee_rails 0.1.3

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task :default => :spec

data/app/controllers/chargebee_rails/webhooks_controller.rb

@@ -0,0 +1,40 @@
+module ChargebeeRails
+  class WebhooksController < ActionController::Base
+    include WebhookHandler
+    before_filter :authenticate, if: "ChargebeeRails.configuration.secure_webhook_api"
+
+    # Handle ChargeBee webhook events
+    # From the post request received from chargebee, the event for which the
+    # webhook is triggered is found from the id parameter sent.
+    # The event is then handled by the WebhookHandler module.
+    # * *Raises* :
+    #   - +ChargebeeRails::Error+ -> If event is not valid or if event unprocessable
+    def handle_event
+      event = ChargeBee::Event.retrieve(params[:id]).event
+      handle(event)
+      head :ok
+      rescue ChargebeeRails::Error => e
+        log_errors(e)
+        head :internal_server_error
+    end
+
+    private
+
+    def log_errors(e)
+      logger.error e.message
+      e.backtrace.each { |line| logger.error " #{line}" }
+    end
+
+    # Basic http authentication for ChargeBee webhook apis
+    # The username and password used to secure the webhook at chargebee
+    # is compared with the configured webhook_authentication user and
+    # secret in the application.
+    def authenticate
+      authenticate_or_request_with_http_basic do |user, password|
+        user == ChargebeeRails.configuration.webhook_authentication[:user] &&
+        password == ChargebeeRails.configuration.webhook_authentication[:secret]
+      end
+    end
+
+  end
+end

data/config/routes.rb

@@ -0,0 +1,9 @@
+Rails.application.routes.draw do #:nodoc:
+  # ChargeBee webhook route
+  # This is the default route that the chargebee's webhooks reach the application
+  # and can be configured.
+  # The default webhook_api_path is +chargebee_rails_event+ - can be configured;
+  # and the default webhook_handler (webhook handling controller) is 
+  # +chargebee_rails/webhooks+ - can be configured as well.
+  post ChargebeeRails.configuration.webhook_api_path => "#{ChargebeeRails.configuration.webhook_handler}#handle_event"
+end

data/lib/chargebee_rails.rb

@@ -0,0 +1,119 @@
+require "chargebee_rails/version"
+require "chargebee"
+require "rails"
+require "chargebee_rails/engine"
+require "chargebee_rails/webhook_handler"
+require "chargebee_rails/configuration"
+require "chargebee_rails/errors"
+require "generators/chargebee_rails/install_generator"
+require "chargebee_rails/subscription"
+require "chargebee_rails/subscription_builder"
+require "chargebee_rails/hosted_page_subscription_manager"
+require "chargebee_rails/customer"
+require "chargebee_rails/metered_billing"
+
+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 
+  # 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* :
+  #   - the updated subscription owner
+  # * *Raises*  :
+  #   - +ChargeBee::InvalidRequestError+ -> If customer or options is invalid
+  #
+  def self.update_customer(customer, options={})
+    chargebee_customer = ChargeBee::Customer.update(customer.chargebee_id, options).customer
+    customer.update(chargebee_id: chargebee_customer.id, chargebee_data: chargebee_customer_data(chargebee_customer))
+    customer
+  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+ 
+  # * *Args*    :
+  #   - +customer+ -> the subscription owner
+  #   - +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* :
+  #   - the updated subscription owner
+  # * *Raises*  :
+  #   - +ChargeBee::InvalidRequestError+ -> If customer or options is invalid
+  #
+  def self.update_billing_info(customer, options={})
+    chargebee_customer = ChargeBee::Customer.update_billing_info(customer.chargebee_id, options).customer
+    customer.update(chargebee_id: chargebee_customer.id, chargebee_data: chargebee_customer_data(chargebee_customer))
+    customer
+  end
+
+  # 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 
+  # 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* :
+  #   - the updated chargebee customer
+  # * *Raises*  :
+  #   - +ChargeBee::InvalidRequestError+ -> If customer or options is invalid
+  #
+  def self.add_customer_contacts(customer, options={})
+    ChargeBee::Customer.add_contact(customer.chargebee_id, options).customer
+  end
+
+  # Update the contacts for a chargebee customer - the chargebee contact id
+  # must be passed in the options to update the existing contact for the
+  # subscription owner
+  # * *Args*    :
+  #   - +customer+ -> the subscription owner
+  #   - +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* :
+  #   - the updated chargebee customer
+  # * *Raises*  :
+  #   - +ChargeBee::InvalidRequestError+ -> If customer or options is invalid
+  #
+  def self.update_customer_contacts(customer, options={})
+    ChargeBee::Customer.update_contact(customer.chargebee_id, options).customer
+  end
+
+  private
+
+  def chargebee_customer_data customer
+    {
+      customer_details: customer_details(customer),
+      billing_address: billing_address(customer.billing_address)
+    }
+  end
+
+  def customer_details customer
+    {
+      first_name: customer.first_name,
+      last_name: customer.last_name,
+      email: customer.email,
+      company: customer.company,
+      vat_number: customer.vat_number
+    }
+  end
+
+  def billing_address customer_billing_address
+    {
+      first_name: customer_billing_address.first_name,
+      last_name: customer_billing_address.last_name,
+      company: customer_billing_address.company,
+      address_line1: customer_billing_address.line1,
+      address_line2: customer_billing_address.line2,
+      address_line3: customer_billing_address.line3,
+      city: customer_billing_address.city,
+      state: customer_billing_address.state,
+      country: customer_billing_address.country,
+      zip: customer_billing_address.zip
+    } if customer_billing_address.present?
+  end
+end

data/lib/chargebee_rails/configuration.rb

@@ -0,0 +1,47 @@
+# :nodoc: all
+module ChargebeeRails
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.setup
+    ::ChargeBee.configure(
+      site: configuration.chargebee_site, 
+      api_key: configuration.chargebee_api_key
+    )
+  end
+
+  def self.configure
+    yield configuration
+    setup
+  end
+
+  class Configuration
+    attr_accessor :default_plan_id
+    attr_accessor :end_of_term
+    attr_accessor :proration
+    attr_accessor :include_delayed_charges
+    attr_accessor :chargebee_site
+    attr_accessor :chargebee_api_key
+    attr_accessor :currency
+    attr_accessor :webhook_handler
+    attr_accessor :webhook_api_path
+    attr_accessor :secure_webhook_api
+    attr_accessor :webhook_authentication
+
+    def initialize
+      @default_plan_id = nil
+      @end_of_term = false
+      @proration = true
+      @include_delayed_charges = {changes_estimate: false, renewal_estimate: true}
+      @webhook_handler = 'chargebee_rails/webhooks'
+      @webhook_api_path = 'chargebee_rails_event'
+      @secure_webhook_api = false
+      @webhook_authentication = {user: nil, secret: nil}
+      @chargebee_site = nil
+      @chargebee_api_key = nil
+      @currency = "US Dollars [USD]"
+    end
+  end
+end

data/lib/chargebee_rails/customer.rb

@@ -0,0 +1,85 @@
+module ChargebeeRails
+  module Customer
+
+    # Subscribe customer to a new subscription in chargebee.
+    # * *Args*    :
+    #   - +options+ -> the options hash allowed for subscription update in chargebee 
+    # For more details on the options hash, refer the input parameters for
+    # https://apidocs.chargebee.com/docs/api/subscriptions?lang=ruby#create_a_subscription
+    # * *Returns* :
+    #   - the subscription
+    # * *Raises*  :
+    #   - +ChargeBee::InvalidRequestError+ -> If subscription options is invalid
+    #
+    def subscribe(options={})
+      SubscriptionBuilder.new(self, options).create
+    end
+
+    # Subscribe customer to a new subscription in chargebee via chargebee's hosted page.
+    # * *Args*    :
+    #   - +hosted_page+ -> the +hosted_page+ returned by chargebee 
+    # The subscription for the customer is created from the +hosted_page+ 
+    # returned by chargebee. This +hosted_page+ object contains the details 
+    # about the subscription in chargebee for the customer. For more on +hosted_page+
+    # https://apidocs.chargebee.com/docs/api/hosted_pages?lang=ruby#checkout_new_subscription
+    # * *Returns* :
+    #   - the subscription
+    # * *Raises*  :
+    #   - +ChargeBee::InvalidRequestError+ -> If +hosted_page+ is invalid
+    #
+    def subscribe_via_hosted_page(hosted_page)
+      HostedPageSubscriptionManager.new(self, hosted_page).create
+    end
+
+    # Subscribe customer to a new subscription in chargebee via chargebee's hosted page.
+    # * *Args*    :
+    #   - +hosted_page+ -> the +hosted_page+ returned by chargebee 
+    # The subscription for the customer is updated from the +hosted_page+ 
+    # returned by chargebee. This +hosted_page+ object contains the details 
+    # about the updated subscription in chargebee for the customer. 
+    # * *Returns* :
+    #   - the subscription
+    # * *Raises*  :
+    #   - +ChargeBee::InvalidRequestError+ -> If +hosted_page+ is invalid
+    #
+    def update_subscription_via_hosted_page(hosted_page)
+      HostedPageSubscriptionManager.new(self, hosted_page).update
+    end
+
+    # Update the customer's subscription
+    # * *Args*    :
+    #   - +options+ -> the options hash allowed for subscription update in chargebee 
+    # For more details on the options hash, refer the input parameters for
+    # https://apidocs.chargebee.com/docs/api/subscriptions?lang=ruby#update_a_subscription
+    # * *Returns* :
+    #   - the updated subscription
+    # * *Raises*  :
+    #   - +ChargeBee::InvalidRequestError+ -> If subscription or options is invalid
+    #
+    def update_subscription(options={})
+      SubscriptionBuilder.new(self, options).update
+    end
+
+    # Retrieve the chargebee customer of the subscription owner -
+    # i.e subscription owner as chargebee customer
+    # * *Returns* :
+    #   - the chargebee customer
+    # * *Raises*  :
+    #   - +ChargeBee::InvalidRequestError+ -> If subscription owner is invalid
+    #
+    def as_chargebee_customer
+      ChargeBee::Customer.retrieve(chargebee_id).customer
+    end
+
+    # List all invoices for the subscription owner (customer).
+    # * *Returns* :
+    #   - the list of invoices for the customer in chargebee
+    # * *Raises*  :
+    #   - +ChargeBee::InvalidRequestError+ -> If customer is invalid
+    #
+    def invoices
+      ChargeBee::Invoice.invoices_for_customer(chargebee_id).map(&:invoice)
+    end
+
+  end
+end

data/lib/chargebee_rails/engine.rb

@@ -0,0 +1,6 @@
+# :nodoc: all
+module ChargebeeRails
+  class EventEngine < ::Rails::Engine
+    # isolate_namespace ChargebeeRails
+  end
+end

data/lib/chargebee_rails/errors.rb

@@ -0,0 +1,26 @@
+# :nodoc: all
+module ChargebeeRails
+  
+  class Error < StandardError
+    attr_reader :original_error
+
+    def initialize(message=nil, original_error=nil)
+      super message
+      @original_error = original_error
+    end
+  end
+
+  class PlanError < Error
+    # Raise this error when the plan is not present in active_record
+    def plan_not_found
+      "Plan Not Found"
+    end
+
+    # Raise this error when the plan is not setup in ChargeBee
+    def plan_not_configured
+      "Plan Not Configured"
+    end
+  end
+
+  class UnauthorizedError < Error; end
+end

data/lib/chargebee_rails/hosted_page_subscription_manager.rb

@@ -0,0 +1,134 @@
+module ChargebeeRails
+  class HostedPageSubscriptionManager
+
+    def initialize(customer, hosted_page)
+      @customer = customer
+      @hosted_page = hosted_page
+    end
+
+    # Create a subscription for the customer in application, 
+    # from the subscription details got from chargebee's hosted page
+    def create
+      @customer.update(
+        chargebee_id: hosted_customer.id,
+        chargebee_data: chargebee_customer_data
+      )
+      @subscription = @customer.create_subscription(subscription_attrs)
+      manage_payment_method if hosted_payment_method.present?
+      @subscription
+    end
+
+    # Update the subscription for the customer in application, 
+    # from the subscription details got from chargebee's hosted page
+    def update
+      @subscription = @customer.subscription
+      @subscription.update(subscription_attrs)
+      manage_payment_method if hosted_payment_method.present?
+      @subscription
+    end
+
+    private
+
+    # Update payment method for subscrption if one exists or create new one
+    def manage_payment_method
+      @subscription.payment_method.present? &&
+      @subscription.payment_method.update(payment_method_attrs) ||
+      create_payment_method
+    end
+
+    # Create the payment method for the subscription
+    def create_payment_method
+      @subscription.create_payment_method(payment_method_attrs)
+    end
+
+    def hosted_subscription
+      @hosted_subscription ||= @hosted_page.content.subscription
+    end
+
+    def hosted_customer
+      @hosted_customer ||= @hosted_page.content.customer
+    end
+
+    def hosted_payment_method
+      @hosted_payment_method ||= hosted_customer.payment_method
+    end
+
+    def hosted_card
+      @hosted_card ||= @hosted_page.content.card
+    end
+
+    def hosted_billing_address
+      @hosted_billing_address ||= @hosted_customer.billing_address
+    end
+
+    def subscription_attrs
+      {
+        chargebee_id: hosted_subscription.id,
+        status: hosted_subscription.status,
+        plan_quantity: hosted_subscription.plan_quantity,
+        chargebee_data: chargebee_subscription_data,
+        plan: Plan.find_by(plan_id: hosted_subscription.plan_id)
+      }
+    end
+
+    def chargebee_subscription_data
+      {
+        trial_ends_at: hosted_subscription.trial_end,
+        next_renewal_at: hosted_subscription.current_term_end,
+        cancelled_at: hosted_subscription.cancelled_at,
+        is_scheduled_for_cancel: (hosted_subscription.status == 'non-renewing' ? true : false),
+        has_scheduled_changes: hosted_subscription.has_scheduled_changes
+      }
+    end
+
+    def chargebee_customer_data
+      {
+        customer_details: customer_details(hosted_customer),
+        billing_address: billing_address(hosted_customer.billing_address)
+      }
+    end
+
+    def customer_details customer
+      {
+        first_name: customer.first_name,
+        last_name: customer.last_name,
+        email: customer.email,
+        company: customer.company,
+        vat_number: customer.vat_number
+      }
+    end
+
+    def billing_address customer_billing_address
+      {
+        first_name: customer_billing_address.first_name,
+        last_name: customer_billing_address.last_name,
+        company: customer_billing_address.company,
+        address_line1: customer_billing_address.line1,
+        address_line2: customer_billing_address.line2,
+        address_line3: customer_billing_address.line3,
+        city: customer_billing_address.city,
+        state: customer_billing_address.state,
+        country: customer_billing_address.country,
+        zip: customer_billing_address.zip
+      } if customer_billing_address.present?
+    end
+
+    def payment_method_attrs
+      if hosted_payment_method.type == 'card'
+        card_last4, card_type = hosted_card.last4, hosted_card.card_type
+      else
+        card_last4, card_type = nil, nil
+      end
+      {
+        cb_customer_id: hosted_customer.id,
+        auto_collection: hosted_customer.auto_collection,
+        payment_type: hosted_payment_method.type,
+        reference_id: hosted_payment_method.reference_id,
+        card_last4: card_last4, 
+        card_type: card_type,
+        status: hosted_payment_method.status
+      }
+    end
+
+  end
+end