charger 0.0.2 → 0.0.3

data/README.md

@@ -1,24 +1,44 @@
 # Charger
 
-TODO: Write a gem description
+A different gem to interact with Chargify's API.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-    gem 'charger'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install charger
+```rb
+gem 'charger'
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+If you are using Rails, you could do the following
+
+```rb
+# config/initializers/charger.rb
+Charger.configure do |config|
+  config.site = {
+    subdomain: ENV['CHARGIFY_URL'],
+    api_key: ENV['CHARGIFY_TOKEN']
+  }
+end
+
+# Some other file
+mrr = 0.0
+at_risk_mrr = 0.0
+
+Charger::Subscription.all.each do |subscription|
+  if subscription.live?
+    mrr += subscription.mrr
+  end
+  if subscription.problem?
+    at_risk_mrr += subscription.mrr
+  end
+end
+
+puts "MRR: #{mrr}"
+puts "At Risk MRR: #{at_risk_mrr}"
+```
+
+For more information on what is available, you'll need to check the source code.
 
 ## Contributing
 

data/lib/charger.rb

@@ -1,31 +1,59 @@
-require "charger/version"
-
 module Charger
   class << self
-    # Your api key assigned to you buy them
-    @@api_key = 'notset'
+    # The hash of configurations
+    @@configurations = {}
 
-    # The chargify site
-    @@subdomain = 'notset'
+    # The current client
+    @@current = nil
 
     def configure
       yield self
     end
   end
 
-  def self.api_key
-    @@api_key
+  # Add a configuration to Charger
+  #
+  # @param [Hash] params
+  # @return [void]
+  def self.site= params={}
+    return unless params[:subdomain] || params[:api_key]
+    config = Configuration.new(params)
+    @@configurations[config.subdomain] = config
+    @@current = config
+  end
+
+  # Switches between configurations. Useful if you want to connect to multiple
+  # chargify accounts at once.
+  #
+  # @return [Boolean]
+  def self.switch subdomain
+    @@current = @@configurations[subdomain]
+    true
+  rescue
+    false
   end
 
-  def self.api_key= api_key
-    @@api_key = api_key
+  # Clears all configurations
+  #
+  # @return [void]
+  def self.clear
+    @@configurations = Hash.new
+    @@current = nil
   end
 
-  def self.subdomain
-    @@subdomain
+  # @return [Charger::Client]
+  def self.client
+    @@current.client
+  rescue
+    nil
   end
 
-  def self.subdomain= subdomain
-    @@subdomain = subdomain
+  def self.configurations
+    @@configurations
   end
+
+  def self.current
+    @@current
+  end
+
 end

data/lib/charger/client.rb

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

data/lib/charger/component.rb

@@ -1,10 +1,7 @@
 module Charger
 
   class Component
-    include Virtus
-    extend ActiveModel::Naming
-    include ActiveModel::Conversion
-    include ActiveModel::Validations
+    include Resource
 
     attribute :id, Integer
     attribute :name, String
@@ -43,7 +40,6 @@ module Charger
     end
 
     def self.find_by_product_family_id id
-      client = Client.new
       components = []
 
       client.get("product_families/#{id}/components").each do |data|
@@ -61,7 +57,6 @@ module Charger
     end
 
     def self.find product_family_id, id
-      client = Client.new
       new(client.get("product_families/#{product_family_id}/components/#{id}")['component'])
     end
   end

data/lib/charger/configuration.rb

@@ -0,0 +1,17 @@
+module Charger
+
+  class Configuration
+    include Virtus
+
+    attribute :api_key, String
+    attribute :subdomain, String
+
+    # Retrieves this Configuration's client
+    #
+    # @return [Charger::Client]
+    def client
+      Client.new(api_key, subdomain)
+    end
+  end
+
+end

data/lib/charger/credit_card.rb

@@ -1,10 +1,7 @@
 module Charger
 
   class CreditCard
-    include Virtus
-    extend ActiveModel::Naming
-    include ActiveModel::Conversion
-    include ActiveModel::Validations
+    include Resource
 
     VAULTS = %w{cancellation_message trust_commerce payment_express beanstream braintree1}
 

data/lib/charger/customer.rb

@@ -1,10 +1,7 @@
 module Charger
 
   class Customer
-    include Virtus
-    extend ActiveModel::Naming
-    include ActiveModel::Conversion
-    include ActiveModel::Validations
+    include Resource
 
     attribute :id, Integer
     attribute :first_name, String

data/lib/charger/event.rb

@@ -0,0 +1,77 @@
+module Charger
+
+  class Event
+    include Resource
+
+    attribute :id, Integer
+    attribute :key, String
+    attribute :message, String
+    attribute :subscription_id, Integer
+    attribute :event_specific_data, Hash
+    attribute :created_at, DateTime
+
+    def subscription force=false
+      @subscription = nil if force
+      @subscription ||= Subscription.find(subscription_id)
+    end
+
+    def subscription= val
+      @subscription = val
+    end
+
+    # Grabs ALL of the events. Note this is a LONG running task especially if
+    # your account has a lot of events. You can shorten it up by passing in some
+    # optional parameters.
+    #
+    # Parameters Available:
+    #   * per_page
+    #   * since_id
+    #   * max_id
+    #   * direction - default is `desc`
+    #
+    # @param [Hash] params
+    # @return [Array<Event>]
+    def self.all params={}
+      params = { per_page: 200, direction: 'desc' }.merge(params)
+      events = []
+      num = 1
+      loop do
+        params[:page] = num
+        response = page(params)
+        break if response.empty?
+        num += 1
+        events += response
+        puts num
+      end
+      events
+    end
+
+    # Gets a single page of events
+    # Parameters available:
+    #   * page
+    #   * per_page
+    #   * since_id
+    #   * max_id
+    #   * direction - `asc` and `desc` are valid
+    # @param [Hash] params
+    def self.page params={}
+      params = { page: 1, per_page: 25, direction: 'desc' }.merge(params)
+      events = []
+      client.get('events', params: params).each do |data|
+        events << new(data['event'])
+      end
+      events
+    end
+
+    def self.find_by_subscription_id sub, params={}
+      params = { per_page: 200, direction: 'desc' }.merge(params)
+      events = []
+      client.get("subscriptions/#{sub}/events", params).each do |data|
+        events << new(data['event'])
+      end
+      events
+    end
+
+  end
+
+end

data/lib/charger/line_item.rb

@@ -1,10 +1,7 @@
 module Charger
 
   class LineItem
-    include Virtus
-    extend ActiveModel::Naming
-    include ActiveModel::Conversion
-    include ActiveModel::Validations
+    include Resource
 
     attribute :subscription_id, Integer
     attribute :component_id, Integer
@@ -12,10 +9,9 @@ module Charger
     attribute :unit_name, String
     attribute :kind, String
 
-    # @param [Integer] the id of the subscription
+    # @param [Integer] id 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|

data/lib/charger/product.rb

@@ -1,10 +1,7 @@
 module Charger
 
   class Product
-    include Virtus
-    extend ActiveModel::Naming
-    include ActiveModel::Conversion
-    include ActiveModel::Validations
+    include Resource
 
     attribute :id, Integer
     attribute :price_in_cents, Integer
@@ -30,7 +27,6 @@ module Charger
     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'])
@@ -41,6 +37,10 @@ module Charger
     def persisted?
       !!id
     end
+
+    def self.client
+      Charger.client
+    end
   end
 
 end

data/lib/charger/product_family.rb

@@ -1,10 +1,7 @@
 module Charger
 
   class ProductFamily
-    include Virtus
-    extend ActiveModel::Naming
-    include ActiveModel::Conversion
-    include ActiveModel::Validations
+    include Resource
 
     attribute :id, Integer
     attribute :name, String
@@ -12,6 +9,9 @@ module Charger
     attribute :accounting_code, String
     attribute :description, String
 
+    validates :name,   presence: true
+    validates :handle, presence: true
+
     # @param [Boolean] force will cause this to un-cache the results
     def products force=false
       @products = nil if force

data/lib/charger/request.rb

@@ -0,0 +1,17 @@
+module Charger
+
+  module Request
+    extend ActiveSupport::Concern
+
+    included do
+      def self.client
+        Charger.client
+      end
+
+      def client
+        Charger.client
+      end
+    end
+  end
+
+end

data/lib/charger/resource.rb

@@ -0,0 +1,13 @@
+module Charger
+  module Resource
+    extend ActiveSupport::Concern
+
+    included do
+      include Virtus
+      extend ActiveModel::Naming
+      include ActiveModel::Conversion
+      include ActiveModel::Validations
+      include Request
+    end
+  end
+end

data/lib/charger/statement.rb

@@ -0,0 +1,56 @@
+module Charger
+  class Statement
+    include Resource
+
+    attribute :id, Integer
+    attribute :subscription_id, Integer
+    attribute :opened_at, DateTime
+    attribute :closed_at, DateTime
+    attribute :settled_at, DateTime
+    attribute :text_view, String
+    attribute :basic_html_view, String
+    attribute :html_view, String
+    attribute :future_payments, String
+    attribute :starting_balance_in_cents, Integer
+    attribute :ending_balance_in_cents, Integer
+    attribute :customer_first_name, String
+    attribute :customer_last_name, String
+    attribute :customer_organization, String
+    attribute :customer_shipping_address, String
+    attribute :customer_shipping_address_2, String
+    attribute :customer_shipping_city, String
+    attribute :customer_shipping_state, String
+    attribute :customer_shipping_country, String
+    attribute :customer_shipping_zip, String
+    attribute :customer_billing_address, String
+    attribute :customer_billing_address_2, String
+    attribute :customer_billing_city, String
+    attribute :customer_billing_state, String
+    attribute :customer_billing_country, String
+    attribute :customer_billing_zip, String
+    attribute :transactions, Array[Transaction]
+    attribute :events, Array[Event]
+    attribute :created_at, DateTime
+    attribute :updated_at, DateTime
+
+    def subscription
+      @subscription ||= Subscription.find(subscription_id)
+    end
+
+    def subscription= sub
+      @subscription = sub
+    end
+
+    def self.find id
+      new(client.get("statements/#{id}")['statement'])
+    end
+
+    def self.find_by_subscription_id id
+      statements = []
+      client.get("subscriptions/#{id}/statements").each do |data|
+        statements << new(data['statement'])
+      end
+      statements
+    end
+  end
+end

data/lib/charger/subscription.rb

@@ -1,10 +1,7 @@
 module Charger
 
   class Subscription
-    include Virtus
-    extend ActiveModel::Naming
-    include ActiveModel::Conversion
-    include ActiveModel::Validations
+    include Resource
 
     STATES = %w{trialing trial_ended assessing active soft_failure past_due suspended canceled unpaid expired}
 
@@ -15,7 +12,6 @@ module Charger
     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
@@ -43,7 +39,6 @@ module Charger
     #   not found.
     # @return [Subscription]
     def self.find id
-      client = Client.new
       new(client.get("subscriptions/#{id}")['subscription'])
     end
 
@@ -52,7 +47,6 @@ module Charger
     #
     # @return [Array<Subscription>]
     def self.all
-      client = Client.new
       subscriptions = []
 
       num = 1
@@ -72,7 +66,6 @@ module Charger
     # @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'])
@@ -137,6 +130,26 @@ module Charger
       !!id
     end
 
+    def activated_on? date
+      return false unless activated?
+      activated_between?(date.beginning_of_day, date.end_of_day)
+    end
+
+    def activated_between? a, b
+      return false unless activated?
+      activated_at > a && activated_at < b
+    end
+
+    def canceled_on? date
+      return false unless canceled?
+      canceled_between?(date.beginning_of_day, date.end_of_day)
+    end
+
+    def canceled_between? a, b
+      return false unless canceled?
+      canceled_at > a && canceled_at < b
+    end
+
     def total
       sum = product.price_in_cents.to_f / 100.0
       line_items.each do |item|
@@ -153,6 +166,15 @@ module Charger
       end
     end
 
+    def events force=false
+      @events = nil if force
+      @events ||= Event.find_by_subscription_id(id)
+      @events.each do |event|
+        event.subscription = self
+      end
+      @events
+    end
+
     # @param [Boolean] force will cause this to un-cache the results
     def line_items force=false
       @line_items = nil if force
@@ -162,6 +184,24 @@ module Charger
       end
       @line_items
     end
+
+    def transactions force=false
+      @transactions = nil if force
+      @transactions ||= Transaction.find_by_subscription_id(id)
+      @transactions.each do |transaction|
+        transaction.subscription = self
+      end
+      @transactions
+    end
+
+    def statements force=false
+      @statements = nil if force
+      @statements ||= Statement.find_by_subscription_id(id)
+      @statements.each do |statement|
+        statement.subscription = self
+      end
+      @statements
+    end
   end
 
 end

data/lib/charger/transaction.rb

@@ -0,0 +1,93 @@
+module Charger
+  class Transaction
+    include Resource
+
+    TYPES = %W{charge refund payment credit payment_authorization info adjustment}
+
+    attribute :transaction_type, String
+    attribute :id, Integer
+    attribute :amount_in_cents, Integer
+    attribute :created_at, DateTime
+    attribute :ending_balance_in_cents, Integer
+    attribute :memo, String
+    attribute :subscription_id, Integer
+    attribute :product_id, Integer
+    attribute :success, Boolean
+    attribute :payment_id, Integer
+    attribute :kind, String
+    attribute :gateway_transaction_id, String
+
+    def subscription
+      @subscription ||= Subscription.find(subscription_id)
+    end
+
+    def subscription= sub
+      @subscription = sub
+    end
+
+    def reload
+      return false if id.nil?
+      self.attributes = client.get("transactions/#{id}")['transaction']
+      true
+    end
+
+    def self.find id
+      new(client.get("transactions/#{id}")['transaction'])
+    end
+
+    def self.page params={}
+      params = {:page => 1, :per_page => 20}.merge(params)
+      transactions = []
+      client.get("transactions", params: params).each do |data|
+        transactions << new(data['transaction'])
+      end
+      transactions
+    end
+
+    def self.all
+      transactions = []
+      params = {page: 1, per_page: 200}
+
+      loop do
+        response = page(params)
+        break if response.empty?
+        params[:page] += 1
+        transactions += response
+      end
+
+      transactions
+    end
+
+    # Finds a set of transactions for a subscription
+    #
+    # Optional Parameters:
+    #   * kinds[] : An array of transaction types, see above
+    #   * since_id : Returns transactions with an id greater than or equal to
+    #     the one specified
+    #   * max_id : Returns transactions with an id less than or equal to the one
+    #     specified
+    #   * since_date : (format YYYY-MM-DD) Returns transactions with a
+    #     created_at date greater than or equal to the one specified
+    #   * until_date : (format YYYY-MM-DD) Returns transactions with a
+    #     created_at date less than or equal to the one specified
+    #   * page : default is 1
+    #   * per_page : default is 20
+    #
+    # @param [Integer] id
+    # @param [Hash] params See optional params
+    # @return [Array<Transaction>]
+    def self.find_by_subscription_id id, params={}
+      params = {:page => 1, :per_page => 20}.merge(params)
+      transactions = []
+      loop do
+        response = client.get("subscriptions/#{id}/transactions", params: params)
+        break if response.empty?
+        response.each do |data|
+          transactions << new(data['transaction'])
+        end
+        params[:page] += 1
+      end
+      transactions
+    end
+  end
+end

data/lib/charger/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: charger
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-18 00:00:00.000000000 Z
+date: 2013-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -192,15 +192,21 @@ files:
 - lib/charger/component/on_off.rb
 - lib/charger/component/price.rb
 - lib/charger/component/quantity_based.rb
+- lib/charger/configuration.rb
 - lib/charger/credit_card.rb
 - lib/charger/customer.rb
+- lib/charger/event.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/request.rb
+- lib/charger/resource.rb
+- lib/charger/statement.rb
 - lib/charger/subscription.rb
+- lib/charger/transaction.rb
 - lib/charger/version.rb
 homepage: https://github.com/warmwaffles/charger
 licenses: []
@@ -214,18 +220,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 484567601979014021
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 484567601979014021
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -233,3 +233,4 @@ signing_key:
 specification_version: 3
 summary: Utilizes Chargify's REST API
 test_files: []
+has_rdoc: