charger 0.0.1 → 0.0.2

data/lib/charger.rb

@@ -2,10 +2,30 @@ require "charger/version"
 
 module Charger
   class << self
-    attr_accessor :api_key, :subdomain
+    # Your api key assigned to you buy them
+    @@api_key = 'notset'
+
+    # The chargify site
+    @@subdomain = 'notset'
 
     def configure
       yield self
     end
   end
+
+  def self.api_key
+    @@api_key
+  end
+
+  def self.api_key= api_key
+    @@api_key = api_key
+  end
+
+  def self.subdomain
+    @@subdomain
+  end
+
+  def self.subdomain= subdomain
+    @@subdomain = subdomain
+  end
 end

data/lib/charger/client.rb

@@ -3,9 +3,9 @@ module Charger
   class Client
     attr_accessor :api_key, :subdomain
 
-    def initialize api_key, subdomain
-      @api_key = api_key
-      @subdomain = subdomain
+    def initialize params={}
+      @api_key = params[:api_key] ? params[:api_key] : Charger.api_key
+      @subdomain = params[:subdomain] ? params[:subdomain] : Charger.subdomain
     end
 
     def get resource, headers={}
@@ -36,5 +36,4 @@ module Charger
     end
   end
 
-
 end

data/lib/charger/component.rb

@@ -0,0 +1,69 @@
+module Charger
+
+  class Component
+    include Virtus
+    extend ActiveModel::Naming
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+
+    attribute :id, Integer
+    attribute :name, String
+    attribute :unit_name, String
+    attribute :unit_price, Float
+    attribute :pricing_scheme, String
+    attribute :prices, Array[Component::Price]
+    attribute :product_family_id, Integer
+    attribute :kind, String
+    attribute :archived, Boolean
+
+    def total_for amount
+      prices.sort_by! { |k| k.starting_quantity }
+
+      total = 0.0
+
+      case pricing_scheme
+      when 'per_unit'
+        total = amount * unit_price
+      when 'volume'
+        total = amount * prices.select { |price| price.between_quantities?(amount) }.unit_price
+      when 'tiered'
+        prices.each do |price|
+          total += price.total(amount)
+        end
+      when 'stairstep'
+        total = prices.select { |price| price.between_quantities?(amount) }.unit_price
+      end
+
+      total
+    rescue => e
+      puts "[ERROR] #{e}"
+      puts "[ERROR] #{amount}"
+      puts "[ERROR] #{self.to_json}"
+      return 0.0
+    end
+
+    def self.find_by_product_family_id id
+      client = Client.new
+      components = []
+
+      client.get("product_families/#{id}/components").each do |data|
+        case data['component']['kind']
+        when 'quantity_based_component'
+          components << Component::QuantityBased.new(data['component'])
+        when 'metered_component'
+          components << Component::Metered.new(data['component'])
+        when 'on_off_component'
+          components << Component::OnOff.new(data['component'])
+        end
+      end
+
+      components
+    end
+
+    def self.find product_family_id, id
+      client = Client.new
+      new(client.get("product_families/#{product_family_id}/components/#{id}")['component'])
+    end
+  end
+
+end

data/lib/charger/component/metered.rb

@@ -0,0 +1,6 @@
+module Charger
+
+  class Component::Metered < Component
+  end
+
+end

data/lib/charger/component/on_off.rb

@@ -0,0 +1,9 @@
+module Charger
+
+  class Component::OnOff < Component
+    def total_for val
+      val > 0 ?  unit_price : 0.to_f
+    end
+  end
+
+end

data/lib/charger/component/price.rb

@@ -0,0 +1,36 @@
+module Charger
+
+  class Component::Price
+    include Virtus
+
+    attribute :ending_quantity,   Integer
+    attribute :starting_quantity, Integer, default: 0
+    attribute :unit_price,        Float
+
+    def between_quantities? amount
+      if ending_quantity
+        starting_quantity <= amount && ending_quantity >= amount
+      else
+        starting_quantity <= amount
+      end
+    end
+
+    def remaining_quantity amount
+      if ending_quantity
+        amount - ending_quantity
+      else
+        amount
+      end
+    end
+
+    def total amount
+      return 0.0 if amount < starting_quantity
+      if ending_quantity && amount > ending_quantity
+        ending_quantity * unit_price
+      else
+        (amount - (starting_quantity-1)) * unit_price
+      end
+    end
+  end
+
+end

data/lib/charger/component/quantity_based.rb

@@ -0,0 +1,6 @@
+module Charger
+
+  class Component::QuantityBased < Component
+  end
+
+end

data/lib/charger/credit_card.rb

@@ -0,0 +1,35 @@
+module Charger
+
+  class CreditCard
+    include Virtus
+    extend ActiveModel::Naming
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+
+    VAULTS = %w{cancellation_message trust_commerce payment_express beanstream braintree1}
+
+    attribute :id, Integer
+    attribute :payment_profile_id, Integer
+    attribute :card_type, String
+    attribute :expiration_month, Integer
+    attribute :expiration_year, Integer
+    attribute :first_name, String
+    attribute :last_name, String
+    attribute :masked_card_number, String
+    attribute :customer_id, Integer
+    attribute :customer_vault_token, String
+    attribute :vault_token, String
+    attribute :current_vault, String
+    attribute :billing_address, String
+    attribute :billing_address_2, String
+    attribute :billing_city, String
+    attribute :billing_state, String
+    attribute :billing_zip, String
+    attribute :billing_country, String
+
+    def persisted?
+      !!id
+    end
+  end
+
+end

data/lib/charger/customer.rb

@@ -0,0 +1,18 @@
+module Charger
+
+  class Customer
+    include Virtus
+    extend ActiveModel::Naming
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+
+    attribute :id, Integer
+    attribute :first_name, String
+    attribute :last_name, String
+
+    def persisted?
+      !!id
+    end
+  end
+
+end

data/lib/charger/line_item.rb

@@ -0,0 +1,75 @@
+module Charger
+
+  class LineItem
+    include Virtus
+    extend ActiveModel::Naming
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+
+    attribute :subscription_id, Integer
+    attribute :component_id, Integer
+    attribute :name, String
+    attribute :unit_name, String
+    attribute :kind, String
+
+    # @param [Integer] the id of the subscription
+    # @return [Array<LineItem>]
+    def self.find_by_subscription_id id
+      client = Client.new
+      items = []
+
+      client.get("subscriptions/#{id}/components").each do |data|
+        case data['component']['kind']
+        when 'metered_component'
+          items << LineItem::Metered.new(data['component'])
+        when 'quantity_based_component'
+          items << LineItem::QuantityBased.new(data['component'])
+        when 'on_off_component'
+          items << LineItem::OnOff.new(data['component'])
+        end
+      end
+
+      items
+    end
+
+    # @return [Float]
+    def total
+      0.0
+    end
+
+    def subscription= sub
+      @subscription = sub
+    end
+
+    # @param [Boolean] force uncache the results from chargify
+    # @return [Subscription]
+    def subscription force=false
+      @subscription = nil if force
+      @subscription ||= Subscription.find(subscription_id)
+    end
+
+    def component= comp
+      @component = comp
+    end
+
+    # @param [Boolean] force uncache the results from chargify
+    # @return [Component]
+    def component force=false
+      @component = nil if force
+
+      unless @component
+        product = subscription.product
+        family = product.product_family
+        @component = Component.find(family.id, component_id)
+      end
+
+      @component
+    end
+
+    # @return [Boolean]
+    def allocated?
+      false
+    end
+  end
+
+end

data/lib/charger/line_item/metered.rb

@@ -0,0 +1,17 @@
+module Charger
+
+  class LineItem::Metered < LineItem
+    attribute :unit_balance, Integer
+
+    # @return [Float]
+    def total
+      component.total_for(unit_balance)
+    end
+
+    # @return [Boolean]
+    def allocated?
+      unit_balance > 0
+    end
+  end
+
+end

data/lib/charger/line_item/on_off.rb

@@ -0,0 +1,21 @@
+module Charger
+
+  class LineItem::OnOff < LineItem
+    attribute :enabled, Boolean
+
+    # @return [Float]
+    def total
+      if enabled
+        component.total_for(1)
+      else
+        0
+      end
+    end
+
+    # @return [Boolean]
+    def allocated?
+      enabled
+    end
+  end
+
+end

data/lib/charger/line_item/quantity_based.rb

@@ -0,0 +1,17 @@
+module Charger
+
+  class LineItem::QuantityBased < LineItem
+    attribute :allocated_quantity, Integer
+
+    # @return [Float]
+    def total
+      component.total_for(allocated_quantity)
+    end
+
+    # @return [Boolean]
+    def allocated?
+      allocated_quantity > 0
+    end
+  end
+
+end

data/lib/charger/product.rb

@@ -0,0 +1,46 @@
+module Charger
+
+  class Product
+    include Virtus
+    extend ActiveModel::Naming
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+
+    attribute :id, Integer
+    attribute :price_in_cents, Integer
+    attribute :name, String
+    attribute :handle, String
+    attribute :description, String
+    attribute :product_family, ProductFamily
+    attribute :accounting_code, String
+    attribute :interval_unit, String
+    attribute :interval, Integer
+    attribute :initial_charge_in_cents, Integer
+    attribute :trial_price_in_cents, Integer
+    attribute :trial_interval, Integer
+    attribute :trial_interval_unit, String
+    attribute :expiration_interval, Integer
+    attribute :expiration_interval_unit, String
+    attribute :return_url, String
+    attribute :return_params, String
+    attribute :required_credit_card, Boolean
+    attribute :request_credit_card, Boolean
+    attribute :created_at, DateTime
+    attribute :updated_at, DateTime
+    attribute :archived_at, DateTime
+
+    def self.find_by_product_family_id id
+      client = Client.new
+      products = []
+      client.get("product_families/#{id}/products") do |data|
+        products << new(data['product'])
+      end
+      products
+    end
+
+    def persisted?
+      !!id
+    end
+  end
+
+end

data/lib/charger/product_family.rb

@@ -0,0 +1,35 @@
+module Charger
+
+  class ProductFamily
+    include Virtus
+    extend ActiveModel::Naming
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+
+    attribute :id, Integer
+    attribute :name, String
+    attribute :handle, String
+    attribute :accounting_code, String
+    attribute :description, String
+
+    # @param [Boolean] force will cause this to un-cache the results
+    def products force=false
+      @products = nil if force
+      @products ||= Product.find_by_product_family_id(id)
+    end
+
+    # Get all of the components descriptions associated to this product family
+    #
+    # @param [Boolean] force will cause this to un-cache the results
+    # @return [Array<Component>]
+    def components force=false
+      @components = nil if force
+      @components ||= Component.find_by_product_family_id(id)
+    end
+
+    def persisted?
+      !!id
+    end
+  end
+
+end

data/lib/charger/subscription.rb

@@ -0,0 +1,167 @@
+module Charger
+
+  class Subscription
+    include Virtus
+    extend ActiveModel::Naming
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+
+    STATES = %w{trialing trial_ended assessing active soft_failure past_due suspended canceled unpaid expired}
+
+    attribute :id, Integer
+    attribute :state, String, default: 'active'
+    attribute :balance_cents, Integer
+    attribute :current_period_started_at, DateTime
+    attribute :current_period_ends_at, DateTime
+    attribute :next_assessment_at, DateTime
+    attribute :trial_started_at, DateTime
+    attribute :trial_started_at, DateTime
+    attribute :trial_ended_at, DateTime
+    attribute :activated_at, DateTime
+    attribute :expires_at, DateTime
+    attribute :created_at, DateTime
+    attribute :updated_at, DateTime
+    attribute :customer, Customer
+    attribute :product, Product
+    attribute :credit_card, CreditCard
+    attribute :cancellation_message, String
+    attribute :canceled_at, DateTime
+    attribute :signup_revenue, Float
+    attribute :signup_payment_id, Integer
+    attribute :cancel_at_end_of_peroid, Boolean
+    attribute :delayed_cancel_at, DateTime
+    attribute :previous_state, String
+    attribute :coupon_code, String
+
+    validates :state,    inclusion: {in: STATES, allow_blank: true, allow_nil: true}
+    validates :product,  presence: true
+    validates :customer, presence: true
+
+    # Finds a [Subscription] in chargify. This can raise an exception.
+    #
+    # @raise [RestClient::Exception] if the id is invalid and the resource is
+    #   not found.
+    # @return [Subscription]
+    def self.find id
+      client = Client.new
+      new(client.get("subscriptions/#{id}")['subscription'])
+    end
+
+    # This is a **VERY** long running task. It will scrape all of the
+    # subscriptions in the chargify account/
+    #
+    # @return [Array<Subscription>]
+    def self.all
+      client = Client.new
+      subscriptions = []
+
+      num = 1
+      loop do
+        subs = page(num, 200)
+        break if subs.empty?
+        num += 1
+        subscriptions += subs
+      end
+
+      subscriptions
+    end
+
+    # Get all of the subscriptions for a specific page
+    #
+    # @param [Integer] num default is 1
+    # @param [Integer] limit max is 200 and default is 20
+    # @return [Array<Subscription>]
+    def self.page num=1, limit=20
+      client = Client.new
+      subscriptions = []
+      client.get("subscriptions", params: {page: num, per_page: limit}).each do |data|
+        subscriptions << new(data['subscription'])
+      end
+      subscriptions
+    end
+
+    def live?
+      %w{trialing assessing active}.include?(state)
+    end
+
+    def trialing?
+      state == 'trialing'
+    end
+
+    def assessing?
+      state == 'assessing'
+    end
+
+    def active?
+      state == 'active'
+    end
+
+    def problem?
+      %w{soft_failure past_due unpaid}.include?(state)
+    end
+
+    def soft_failure?
+      state == 'soft_failure'
+    end
+
+    def past_due?
+      state == 'past_due'
+    end
+
+    def unpaid?
+      state == 'unpaid'
+    end
+
+    def end_of_life?
+      %w{canceled expired suspended trial_ended}.include?(state)
+    end
+
+    def canceled?
+      state == 'canceled'
+    end
+
+    def expired?
+      state == 'expired'
+    end
+
+    def suspended?
+      state == 'suspended'
+    end
+
+    def trial_ended?
+      state == 'trial_ended'
+    end
+
+    # @return [Boolean]
+    def persisted?
+      !!id
+    end
+
+    def total
+      sum = product.price_in_cents.to_f / 100.0
+      line_items.each do |item|
+        sum += item.total if item.allocated?
+      end
+      sum
+    end
+
+    def mrr
+      if product.interval_unit == 'day'
+        total / (product.interval / 30)
+      else
+        total / product.interval
+      end
+    end
+
+    # @param [Boolean] force will cause this to un-cache the results
+    def line_items force=false
+      @line_items = nil if force
+      @line_items ||= LineItem.find_by_subscription_id(id)
+      @line_items.each do |item|
+        item.subscription = self
+      end
+      @line_items
+    end
+  end
+
+end

data/lib/charger/version.rb

@@ -1,3 +1,3 @@
 module Charger
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: charger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -187,6 +187,20 @@ files:
 - charger.gemspec
 - lib/charger.rb
 - lib/charger/client.rb
+- lib/charger/component.rb
+- lib/charger/component/metered.rb
+- lib/charger/component/on_off.rb
+- lib/charger/component/price.rb
+- lib/charger/component/quantity_based.rb
+- lib/charger/credit_card.rb
+- lib/charger/customer.rb
+- lib/charger/line_item.rb
+- lib/charger/line_item/metered.rb
+- lib/charger/line_item/on_off.rb
+- lib/charger/line_item/quantity_based.rb
+- lib/charger/product.rb
+- lib/charger/product_family.rb
+- lib/charger/subscription.rb
 - lib/charger/version.rb
 homepage: https://github.com/warmwaffles/charger
 licenses: []
@@ -202,7 +216,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4566746105116238615
+      hash: 484567601979014021
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -211,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4566746105116238615
+      hash: 484567601979014021
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24