chargebee_rails 0.1.3

data/lib/chargebee_rails/metered_billing.rb

@@ -0,0 +1,56 @@
+module ChargebeeRails
+  class MeteredBilling
+    class << self
+
+      #
+      # Add charge to pending invoice
+      # * *Args*    :
+      #   - +invoice_id+ -> the pending invoice id
+      #   - +amount+ -> the charge on item to be added
+      #   - +description+ -> the description of the added item
+      # * *Returns* :
+      #   - the chargebee pending invoice
+      # For more details on the +add_charge+ for pending invoice, refer 
+      # {Add charge item to pending invoice}[https://apidocs.chargebee.com/docs/api/invoices?lang=ruby#add_charge_item_to_pending_invoice]
+      #
+      def add_charge(invoice_id, amount, description)
+        ChargeBee::Invoice.add_charge(invoice_id, {
+          amount: amount, 
+          description: description
+        }).invoice
+      end
+
+      #
+      # Add addon charge to pending invoice
+      # * *Args*    :
+      #   - +invoice_id+ -> the pending invoice id
+      #   - +addon_id+ -> the id of the addon in chargebee
+      #   - +addon_quantity+ -> the quantity of addon, defaults to 1
+      # * *Returns* :
+      #   - the chargebee pending invoice
+      # For more details on the +addon_charge+ for pending invoice, refer 
+      # {Add addon item to pending invoice}[https://apidocs.chargebee.com/docs/api/invoices?lang=ruby#add_addon_item_to_pending_invoice]
+      #
+      def add_addon_charge(invoice_id, addon_id, addon_quantity=1)
+        ChargeBee::Invoice.add_addon_charge(invoice_id, {
+          addon_id: addon_id,
+          addon_quantity: addon_quantity
+        }).invoice
+      end
+
+      #
+      # Close pending invoice
+      # * *Args*    :
+      #   - +invoice_id+ -> the pending invoice id
+      # * *Returns* :
+      #   - the chargebee invoice
+      # For more details on closing pending invoice, refer 
+      # {Close a pending invoice}[https://apidocs.chargebee.com/docs/api/invoices?lang=ruby#close_a_pending_invoice]
+      #
+      def close_invoice(invoice_id)
+        ChargeBee::Invoice.close(invoice_id).invoice
+      end
+
+    end
+  end
+end

data/lib/chargebee_rails/subscription.rb

@@ -0,0 +1,163 @@
+module ChargebeeRails
+  module Subscription
+
+    # Extend the class methods of including class
+    def self.included(base) #:nodoc:
+      base.extend(ClassMethods)
+    end
+
+    # Retrieve subscription as chargebee subscription
+    def as_chargebee_subscription
+      ChargeBee::Subscription.retrieve(chargebee_id).subscription
+    end
+
+    #
+    # Update the plan for a subscription
+    # * *Args*    :
+    #   - +plan+ -> the plan to be updated
+    #   - +end_of_term+ -> this boolean option specifies if the update takes 
+    #     effect after term end, the default behavior will be as per configuration
+    #   - +prorate+ -> this boolean option specifies if the updates to subscription
+    #     are prorated, the default behavior will be as per configuration
+    # For more details on the *updating plan for subscription*, refer 
+    # {Update a subscription}[https://apidocs.chargebee.com/docs/api/subscriptions?lang=ruby#update_a_subscription]
+    #
+    def change_plan(plan, end_of_term=nil, prorate=nil)
+      end_of_term ||= ChargebeeRails.configuration.end_of_term
+      prorate ||= ChargebeeRails.configuration.proration
+      chargebee_subscription = ChargeBee::Subscription.update(
+        chargebee_id, { plan_id: plan.plan_id, end_of_term: end_of_term, prorate: prorate }
+      ).subscription
+      update(subscription_attrs(chargebee_subscription, plan))
+    end
+
+    #
+    # Update plan quantity for subscription
+    # * *Args*    :
+    #   - +quantity+ -> the plan quantity to be updated (integer)
+    #   - +end_of_term+ -> this boolean option specifies if the update takes 
+    #     effect after term end, the default behavior will be as per configuration
+    #   - +prorate+ -> this boolean option specifies if the updates to subscription
+    #     are prorated, the default behavior will be as per configuration
+    # For more details on the *updating plan quantity for subscription*, refer 
+    # {Set plan quantity for subscription}[https://apidocs.chargebee.com/docs/api/subscriptions?lang=ruby#update_a_subscription]
+    #
+    def set_plan_quantity(quantity, end_of_term=nil, prorate=nil)
+      end_of_term ||= ChargebeeRails.configuration.end_of_term
+      prorate ||= ChargebeeRails.configuration.proration
+      chargebee_subscription = ChargeBee::Subscription.update(
+        chargebee_id, { plan_quantity: quantity, end_of_term: end_of_term, prorate: prorate }
+      ).subscription
+      update(subscription_attrs(chargebee_subscription, self.plan))
+    end
+
+    #
+    # Add or remove addons for the subscription
+    # * *Args*    :
+    #   - +addon_id+ -> the id of addon in chargebee
+    #   - +quantity+ -> the quantity of addon, defaults to 1
+    #   - +replace_addon_list+ -> this boolean option specifies if the current
+    #     addon list me be replaced with the updated one, defaults to false
+    # * *Returns* :
+    #   - the chargebee subscription
+    # For more details on the *updating addon for subscription*, refer 
+    # {Manage addons for subscription}[https://apidocs.chargebee.com/docs/api/subscriptions?lang=ruby#update_a_subscription]
+    #
+    def manage_addons(addon_id, quantity=1, replace_addon_list=false)
+      chargebee_subscription = ChargeBee::Subscription.update(
+        chargebee_id, { replace_addon_list: replace_addon_list, addons: [{ id: addon_id, quantity: quantity }] }
+      ).subscription
+    end
+
+    # Cancel a subscription - it will be scheduled for cancellation at term end
+    # when end_of_term is passed as true. If no options are passed the 
+    # default configured value for end_of_term is taken
+    # * *Args*    :
+    #   - +options+ -> the options hash allowed for subscription cancellation in chargebee
+    # For more details on the *updating addon for subscription*, refer 
+    # {Manage addons for subscription}[https://apidocs.chargebee.com/docs/api/subscriptions?lang=ruby#update_a_subscription]
+    #
+    def cancel(options={})
+      options[:end_of_term] ||= ChargebeeRails.configuration.end_of_term
+      chargebee_subscription = ChargeBee::Subscription.cancel(chargebee_id, options).subscription
+      update(status: chargebee_subscription.status)
+    end
+
+    # Stop a scheduled cancellation of a subscription
+    def stop_cancellation
+      chargebee_subscription = ChargeBee::Subscription.remove_scheduled_cancellation(chargebee_id).subscription
+      update(status: chargebee_subscription.status)
+    end
+
+    #
+    # Estimates the subscription's renewal
+    # * *Args*    :
+    #   - +options+ -> the options hash allowed for renewal estimate in chargebee
+    # * *Returns* :
+    #   - the chargebee estimate
+    # For more details on the *options for renewal of estimate*, refer 
+    # {Subscription renewal estimate}[https://apidocs.chargebee.com/docs/api/estimates?lang=ruby#subscription_renewal_estimate]
+    #
+    def estimate_renewal(options={})
+      options[:include_delayed_charges] ||= ChargebeeRails.configuration.include_delayed_charges[:renewal_estimate]
+      ChargeBee::Estimate.renewal_estimate(chargebee_id, options).estimate
+    end
+
+    module ClassMethods
+      #
+      # Estimates the cost of subscribing to a new subscription
+      # * *Args*    :
+      #   - +estimation_params+ -> the estimation options permitted for estimating 
+      #     new subscription in chargebee
+      # * *Returns* :
+      #   - the chargebee estimate
+      # For more details on the *estimation params for new subscription estimate*, refer 
+      # {Create subscription estimate}[https://apidocs.chargebee.com/docs/api/estimates?lang=ruby#create_subscription_estimate]
+      #
+      def estimate(estimation_params)
+        estimation_params[:trial_end] ||= 0
+        ::ChargeBee::Estimate.create_subscription(estimation_params).estimate
+      end
+
+      # Estimates the cost of changes to an existing subscription
+      # estimates the upgrade/downgrade or other changes
+      # * *Args*    :
+      #   - +estimation_params+ -> the estimation options permitted for estimating 
+      #     subscription update in chargebee
+      # * *Returns* :
+      #   - the chargebee estimate
+      # For more details on the *estimation params for subscription update estimate*, refer 
+      # {Update subscription estimate}[https://apidocs.chargebee.com/docs/api/estimates?lang=ruby#update_subscription_estimate]
+      #
+      def estimate_changes(estimation_params)
+        estimation_params[:include_delayed_charges] ||= ChargebeeRails.configuration.include_delayed_charges[:changes_estimate]
+        estimation_params[:prorate] ||= ChargebeeRails.configuration.proration
+        ::ChargeBee::Estimate.update_subscription(estimation_params).estimate
+      end
+
+    end
+
+    private
+
+    def subscription_attrs(subscription, plan)
+      {
+        chargebee_id: subscription.id,
+        plan_id: plan.id,
+        plan_quantity: subscription.plan_quantity,
+        status: subscription.status,
+        chargebee_data: chargebee_subscription_data(subscription)
+      }
+    end
+
+    def chargebee_subscription_data subscription
+      {
+        trial_ends_at: subscription.trial_end,
+        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
+      }
+    end
+
+  end
+end

data/lib/chargebee_rails/subscription_builder.rb

@@ -0,0 +1,162 @@
+module ChargebeeRails
+  class SubscriptionBuilder
+
+    def initialize(customer, options)
+      @customer = customer
+      @options = options
+    end
+
+    # Create a subscription in Chargebee,
+    # update the resulting subscription details for the customer in the 
+    # application and finally return the subscription
+    def create
+      build_subscription_payload
+      create_subscriptions
+      manage_payment_method if chargebee_payment_method.present?
+      @subscription
+    end
+
+    # Update existing subscription in Chargebee,
+    # the resulting subscription details are then updated in application
+    def update
+      update_subscriptions
+      manage_payment_method if chargebee_payment_method.present?
+      @subscription
+    end
+
+    private
+
+    # Create a subscription in Chargebee with the passed options payload
+    def create_subscriptions
+      @result = ChargeBee::Subscription.create(@options)
+      @customer.update(
+        chargebee_id: chargebee_customer.id,
+        chargebee_data: chargebee_customer_data
+      ) # Update the chargebee customer id for the subscription owner
+      @subscription = @customer.create_subscription(subscription_attrs) # Create an active record subscription of the chargebee subscription object for the customer
+    end
+
+    # Update subscription in ChargeBee and the application model
+    def update_subscriptions
+      @subscription = @customer.subscription
+      @options[:prorate] ||= ChargebeeRails.configuration.proration
+      @result = ChargeBee::Subscription.update(@subscription.chargebee_id, @options)
+      @plan = Plan.find_by(plan_id: @result.subscription.plan_id)
+      @subscription.update(subscription_attrs)
+    end
+
+    # 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
+
+    # Check for the default plan if one is not passed in the options payload
+    # raise plan not configured error incase plan is not passed and a default
+    # plan is not set in the ChargebeeRails configuration. 
+    # Raise plan not found if the plan passed is not found in active record
+    def build_subscription_payload
+      @options[:trial_end] = 0 if @options[:skip_trial]
+      @options[:plan_id] ||= ChargebeeRails.configuration.default_plan_id
+      raise PlanError.new.plan_not_configureed unless @options[:plan_id]
+      @plan = Plan.find_by(plan_id: @options[:plan_id])
+      raise PlanError.new.plan_not_found unless @plan
+    end
+
+    def chargebee_subscription
+      @chargebee_subscription ||= @result.subscription
+    end
+
+    def chargebee_customer
+      @chargebee_customer ||= @result.customer
+    end
+
+    def chargebee_payment_method
+      @chargebee_payment_method ||= chargebee_customer.payment_method
+    end
+
+    def chargebee_card
+      @chargebee_card ||= @result.card
+    end
+
+    def chargebee_billing_address
+      @chargebee_billing_address ||= chargebee_customer.billing_address
+    end
+
+    def subscription_attrs
+      {
+        chargebee_id: chargebee_subscription.id,
+        status: chargebee_subscription.status,
+        plan_quantity: chargebee_subscription.plan_quantity,
+        chargebee_data: chargebee_subscription_data,
+        plan: @plan
+      }
+    end
+
+    def chargebee_subscription_data
+      {
+        trial_ends_at: chargebee_subscription.trial_end,
+        next_renewal_at: chargebee_subscription.current_term_end,
+        cancelled_at: chargebee_subscription.cancelled_at,
+        is_scheduled_for_cancel: (chargebee_subscription.status == 'non-renewing' ? true : false),
+        has_scheduled_changes: chargebee_subscription.has_scheduled_changes
+      }
+    end
+
+    def chargebee_customer_data
+      {
+        customer_details: customer_details(chargebee_customer),
+        billing_address: billing_address(chargebee_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 chargebee_payment_method.type == 'card'
+        card_last4, card_type = chargebee_card.last4, chargebee_card.card_type
+      else
+        card_last4, card_type = nil, nil
+      end
+      {
+        cb_customer_id: chargebee_customer.id,
+        auto_collection: chargebee_customer.auto_collection,
+        payment_type: chargebee_payment_method.type,
+        reference_id: chargebee_payment_method.reference_id,
+        card_last4: card_last4,
+        card_type: card_type,
+        status: chargebee_payment_method.status
+      }
+    end
+
+  end
+end

data/lib/chargebee_rails/version.rb

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

data/lib/chargebee_rails/webhook_handler.rb

@@ -0,0 +1,175 @@
+# :nodoc:all
+module ChargebeeRails
+  module WebhookHandler
+
+    # 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)
+    end
+
+    # Set event as ChargeBee event
+    def event
+      @event ||= @chargebee_event
+    end
+
+    # All the event types in ChargeBee
+
+    def customer_created; end
+
+    def customer_changed; end
+
+    def customer_deleted; end
+
+    def subscription_created; end
+
+    def subscription_started; end
+
+    def subscription_trial_end_reminder; end
+
+    def subscription_activated; end
+
+    def subscription_changed; end
+
+    def subscription_cancellation_scheduled; end
+
+    def subscription_cancellation_reminder; end
+
+    def subscription_cancelled; end
+
+    def subscription_reactivated; end
+
+    def subscription_renewed; end
+
+    def subscription_scheduled_cancellation_removed; end
+
+    def subscription_shipping_address_updated; end
+
+    def subscription_deleted; end
+
+    def pending_invoice_created
+      ::ChargebeeRails::MeteredBilling.close_invoice(@event.content.invoice.id)
+    end
+
+    def invoice_generated; end
+
+    def invoice_updated; end
+
+    def invoice_deleted; end
+
+    def credit_note_created; end
+
+    def credit_note_updated; end
+    
+    def credit_note_deleted; end
+
+    def subscription_renewal_reminder; end
+
+    def transaction_created; end
+
+    def transaction_updated; end
+
+    def transaction_deleted; end
+
+    def payment_succeeded; end
+
+    def payment_failed; end
+
+    def payment_refunded; end
+
+    def payment_initiated; end
+    
+    def refund_initiated; end
+    
+    def card_added; end
+
+    def card_updated; end
+
+    def card_expiry_reminder; end
+
+    def card_expired; end
+
+    def card_deleted; end
+
+    private
+
+    def sync_events_list
+      %w( 
+        card_expired
+        card_updated
+        card_expiry_reminder
+        subscription_started
+        subscription_trial_end_reminder
+        subscription_activated
+        subscription_changed
+        subscription_cancellation_scheduled
+        subscription_cancellation_reminder
+        subscription_cancelled
+        subscription_reactivated
+        subscription_renewed
+        subscription_scheduled_cancellation_removed
+        subscription_renewal_reminder
+      )
+    end
+
+    def sync_events
+      sync(existing_subscription, subscription_attrs(event.content.subscription)) if event.event_type.include?('subscription') && can_sync?(existing_subscription)
+      sync(existing_payment_method, payment_method_attrs(event.content.customer, event.content.card)) if event.event_type.include?('card') && event.content.customer.payment_method.present? && can_sync?(existing_payment_method)
+    end
+
+    def sync obj, attrs
+      obj.update_all(attrs)
+      send(event.event_type)
+    end
+
+    def existing_subscription
+      @existing_subscription ||= ::Subscription.where(chargebee_id: event.content.subscription.id)
+    end
+
+    def existing_payment_method
+      @existing_payment_method ||= ::PaymentMethod.where(cb_customer_id: event.content.customer.id)
+    end
+
+    def can_sync? obj
+      obj.first && (obj.first.event_last_modified_at.to_i < event.occurred_at)
+    end
+
+    def subscription_attrs subscription
+      {
+        chargebee_id: subscription.id,
+        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,
+        updated_at: Time.now,
+        chargebee_data: chargebee_subscription_data(subscription)
+      }
+    end
+
+    def chargebee_subscription_data subscription
+      {
+        trial_ends_at: subscription.trial_end,
+        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
+      }
+    end
+
+    def payment_method_attrs customer, card
+      {
+        cb_customer_id: customer.id,
+        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,
+        status: customer.payment_method.status,
+        event_last_modified_at: event.occurred_at,
+        updated_at: Time.now
+      }
+    end
+
+  end
+end