chartmogul-ruby 0.1.1

data/lib/chartmogul/import/line_items/subscription.rb

@@ -0,0 +1,31 @@
+module ChartMogul
+  module Import
+    module LineItems
+      class Subscription < ChartMogul::Object
+        readonly_attr :uuid
+
+        writeable_attr :type, default: 'subscription'
+        writeable_attr :subscription_external_id
+        writeable_attr :service_period_start, type: :time
+        writeable_attr :service_period_end, type: :time
+        writeable_attr :amount_in_cents
+        writeable_attr :cancelled_at, type: :time
+        writeable_attr :prorated
+        writeable_attr :quantity
+        writeable_attr :discount_amount_in_cents
+        writeable_attr :discount_code
+        writeable_attr :tax_amount_in_cents
+        writeable_attr :external_id
+
+        readonly_attr :subscription_uuid
+        writeable_attr :invoice_uuid
+        writeable_attr :plan_uuid
+
+        def initialize(attributes = {})
+          super(attributes)
+          @type = 'subscription'
+        end
+      end
+    end
+  end
+end

data/lib/chartmogul/import/plan.rb

@@ -0,0 +1,21 @@
+module ChartMogul
+  module Import
+    class Plan < APIResource
+      set_resource_name 'Plan'
+      set_resource_path '/v1/import/plans'
+      set_resource_root_key :plans
+
+      readonly_attr :uuid
+
+      writeable_attr :name
+      writeable_attr :interval_count
+      writeable_attr :interval_unit
+      writeable_attr :external_id
+
+      writeable_attr :data_source_uuid
+
+      include API::Actions::All
+      include API::Actions::Create
+    end
+  end
+end

data/lib/chartmogul/import/subscription.rb

@@ -0,0 +1,30 @@
+module ChartMogul
+  module Import
+    class Subscription < APIResource
+      set_resource_name 'Subscription'
+      set_resource_path '/v1/import/customers/:customer_uuid/subscriptions'
+      set_resource_root_key :subscriptions
+
+      readonly_attr :uuid
+      readonly_attr :external_id
+      readonly_attr :cancellation_dates, default: []
+
+      readonly_attr :plan_uuid
+      readonly_attr :data_source_uuid
+      writeable_attr :customer_uuid
+
+      include API::Actions::All
+      include API::Actions::Custom
+
+      def set_cancellation_dates(cancellation_dates_array)
+        @cancellation_dates = cancellation_dates_array.map do |cancellation_date|
+          Time.parse(cancellation_date)
+        end
+      end
+
+      def cancel(cancelled_at)
+        custom!(:patch, "/v1/import/subscriptions/#{uuid}", cancelled_at: cancelled_at)
+      end
+    end
+  end
+end

data/lib/chartmogul/import/transactions/payment.rb

@@ -0,0 +1,26 @@
+module ChartMogul
+  module Import
+    module Transactions
+      class Payment < APIResource
+        set_resource_name 'Payment Transaction'
+        set_resource_path '/v1/import/invoices/:invoice_uuid/transactions'
+
+        readonly_attr :uuid
+
+        writeable_attr :type, default: 'payment'
+        writeable_attr :date, type: :time
+        writeable_attr :result
+        writeable_attr :external_id
+
+        writeable_attr :invoice_uuid
+
+        def initialize(attributes = {})
+          super(attributes)
+          @type = 'payment'
+        end
+
+        include API::Actions::Create
+      end
+    end
+  end
+end

data/lib/chartmogul/import/transactions/refund.rb

@@ -0,0 +1,26 @@
+module ChartMogul
+  module Import
+    module Transactions
+      class Refund < APIResource
+        set_resource_name 'Refund Transaction'
+        set_resource_path '/v1/import/invoices/:invoice_uuid/transactions'
+
+        readonly_attr :uuid
+
+        writeable_attr :type, default: 'refund'
+        writeable_attr :date, type: :time
+        writeable_attr :result
+        writeable_attr :external_id
+
+        writeable_attr :invoice_uuid
+
+        def initialize(attributes = {})
+          super(attributes)
+          @type = 'refund'
+        end
+
+        include API::Actions::Create
+      end
+    end
+  end
+end

data/lib/chartmogul/metrics/activity.rb

@@ -0,0 +1,32 @@
+module ChartMogul
+  module Metrics
+    class Activity < ChartMogul::Object
+      readonly_attr :id
+      readonly_attr :description
+      readonly_attr :type
+      readonly_attr :date, type: :time
+      readonly_attr :activity_arr
+      readonly_attr :activity_mrr
+      readonly_attr :activity_mrr_movement
+      readonly_attr :currency
+      readonly_attr :currency_sign
+
+      def self.all(options = {})
+        ChartMogul::Metrics::Activities.all(options)
+      end
+    end
+
+    class Activities < APIResource
+      set_resource_name 'Activities'
+      set_resource_path '/v1/customers/:customer_uuid/activities'
+
+      writeable_attr :customer_uuid
+
+      include Concerns::Entries
+      include Concerns::Pageable
+
+      set_entry_class Activity
+    end
+  end
+end
+

data/lib/chartmogul/metrics/all_key_metrics.rb

@@ -0,0 +1,25 @@
+module ChartMogul
+  module Metrics
+    class AllKeyMetric < ChartMogul::Object
+      readonly_attr :date, type: :date
+      readonly_attr :arpa
+      readonly_attr :arr
+      readonly_attr :asp
+      readonly_attr :customer_churn_rate
+      readonly_attr :customers
+      readonly_attr :ltv
+      readonly_attr :mrr
+      readonly_attr :mrr_churn_rate
+    end
+
+    class AllKeyMetrics < APIResource
+      set_resource_name 'All Key Metrics'
+      set_resource_path '/v1/metrics/all'
+
+      include Concerns::Entries
+
+      set_entry_class AllKeyMetric
+    end
+  end
+end
+

data/lib/chartmogul/metrics/arpa.rb

@@ -0,0 +1,19 @@
+module ChartMogul
+  module Metrics
+    class ARPA < ChartMogul::Object
+      readonly_attr :date, type: :date
+      readonly_attr :arpa
+    end
+
+    class ARPAs < APIResource
+      set_resource_name 'ARPAs'
+      set_resource_path '/v1/metrics/arpa'
+
+      include Concerns::Entries
+      include Concerns::Summary
+
+      set_entry_class ARPA
+    end
+  end
+end
+

data/lib/chartmogul/metrics/arr.rb

@@ -0,0 +1,19 @@
+module ChartMogul
+  module Metrics
+    class ARR < ChartMogul::Object
+      readonly_attr :date, type: :date
+      readonly_attr :arr
+    end
+
+    class ARRs < APIResource
+      set_resource_name 'ARRs'
+      set_resource_path '/v1/metrics/arr'
+
+      include Concerns::Entries
+      include Concerns::Summary
+
+      set_entry_class ARR
+    end
+  end
+end
+

data/lib/chartmogul/metrics/asp.rb

@@ -0,0 +1,19 @@
+module ChartMogul
+  module Metrics
+    class ASP < ChartMogul::Object
+      readonly_attr :date, type: :date
+      readonly_attr :asp
+    end
+
+    class ASPs < APIResource
+      set_resource_name 'ASPs'
+      set_resource_path '/v1/metrics/asp'
+
+      include Concerns::Entries
+      include Concerns::Summary
+
+      set_entry_class ASP
+    end
+  end
+end
+

data/lib/chartmogul/metrics/base.rb

@@ -0,0 +1,56 @@
+module ChartMogul
+  module Metrics
+
+    def self.all(options = {})
+      ChartMogul::Metrics::AllKeyMetrics.all(preprocess_params(options))
+    end
+
+    def self.arpa(options = {})
+      ChartMogul::Metrics::ARPAs.all(preprocess_params(options))
+    end
+
+    def self.arr(options = {})
+      ChartMogul::Metrics::ARRs.all(preprocess_params(options))
+    end
+
+    def self.asp(options = {})
+      ChartMogul::Metrics::ASPs.all(preprocess_params(options))
+    end
+
+    def self.customer_churn_rate(options = {})
+      ChartMogul::Metrics::CustomerChurnRates.all(preprocess_params(options))
+    end
+
+    def self.customer_count(options = {})
+      ChartMogul::Metrics::CustomerCounts.all(preprocess_params(options))
+    end
+
+    def self.mrr(options = {})
+      ChartMogul::Metrics::MRRs.all(preprocess_params(options))
+    end
+
+    def self.ltv(options = {})
+      ChartMogul::Metrics::LTVs.all(preprocess_params(options))
+    end
+
+    def self.mrr_churn_rate(options = {})
+      ChartMogul::Metrics::MRRChurnRates.all(preprocess_params(options))
+    end
+
+    private
+
+    def self.preprocess_params(options)
+      [:start_date, :end_date].each do |param_name|
+        options[param_name.to_s.gsub('_', '-')] = options.delete(param_name) if options[param_name]
+      end
+
+      [:geo, :plans].each do |param_name|
+        if options[param_name] && options[param_name].kind_of?(Array)
+          options[param_name] = options[param_name].join(',')
+        end
+      end
+      options
+    end
+  end
+end
+

data/lib/chartmogul/metrics/customer_churn_rate.rb

@@ -0,0 +1,19 @@
+module ChartMogul
+  module Metrics
+    class CustomerChurnRate < ChartMogul::Object
+      readonly_attr :date, type: :date
+      readonly_attr :customer_churn_rate
+    end
+
+    class CustomerChurnRates < APIResource
+      set_resource_name 'Customer Churn Rates'
+      set_resource_path '/v1/metrics/customer-churn-rate'
+
+      include Concerns::Entries
+      include Concerns::Summary
+
+      set_entry_class CustomerChurnRate
+    end
+  end
+end
+

data/lib/chartmogul/metrics/customer_count.rb

@@ -0,0 +1,19 @@
+module ChartMogul
+  module Metrics
+    class CustomerCount < ChartMogul::Object
+      readonly_attr :date, type: :date
+      readonly_attr :customers
+    end
+
+    class CustomerCounts < APIResource
+      set_resource_name 'Customer Counts'
+      set_resource_path '/v1/metrics/customer-count'
+
+      include Concerns::Entries
+      include Concerns::Summary
+
+      set_entry_class CustomerCount
+    end
+  end
+end
+

data/lib/chartmogul/metrics/ltv.rb

@@ -0,0 +1,19 @@
+module ChartMogul
+  module Metrics
+    class LTV < ChartMogul::Object
+      readonly_attr :date, type: :date
+      readonly_attr :ltv
+    end
+
+    class LTVs < APIResource
+      set_resource_name 'LTVs'
+      set_resource_path '/v1/metrics/ltv'
+
+      include Concerns::Entries
+      include Concerns::Summary
+
+      set_entry_class LTV
+    end
+  end
+end
+

data/lib/chartmogul/metrics/mrr.rb

@@ -0,0 +1,26 @@
+module ChartMogul
+  module Metrics
+    class MRR < ChartMogul::Object
+      readonly_attr :date, type: :date
+      readonly_attr :mrr
+
+      readonly_attr :mrr_new_business
+
+      readonly_attr :mrr_expansion
+      readonly_attr :mrr_contraction
+
+      readonly_attr :mrr_churn
+      readonly_attr :mrr_reactivation
+    end
+
+    class MRRs < APIResource
+      set_resource_name 'MRRs'
+      set_resource_path '/v1/metrics/mrr'
+
+      include Concerns::Entries
+      include Concerns::Summary
+
+      set_entry_class MRR
+    end
+  end
+end

data/lib/chartmogul/metrics/mrr_churn_rate.rb

@@ -0,0 +1,19 @@
+module ChartMogul
+  module Metrics
+    class MRRChurnRate < ChartMogul::Object
+      readonly_attr :date, type: :date
+      readonly_attr :mrr_churn_rate
+    end
+
+    class MRRChurnRates < APIResource
+      set_resource_name 'MRR Churn Rates'
+      set_resource_path '/v1/metrics/mrr-churn-rate'
+
+      include Concerns::Entries
+      include Concerns::Summary
+
+      set_entry_class MRRChurnRate
+    end
+  end
+end
+

data/lib/chartmogul/metrics/subscription.rb

@@ -0,0 +1,35 @@
+module ChartMogul
+  module Metrics
+    class Subscription < ChartMogul::Object
+      readonly_attr :id
+      readonly_attr :plan
+      readonly_attr :quantity
+      readonly_attr :mrr
+      readonly_attr :arr
+      readonly_attr :status
+      readonly_attr :billing_cycle
+      readonly_attr :billing_cycle_count
+      readonly_attr :start_date, type: :time
+      readonly_attr :end_date, type: :time
+      readonly_attr :currency
+      readonly_attr :currency_sign
+
+      def self.all(options = {})
+        ChartMogul::Metrics::Subscriptions.all(options)
+      end
+    end
+
+    class Subscriptions < APIResource
+      set_resource_name 'Subscriptions'
+      set_resource_path '/v1/customers/:customer_uuid/subscriptions'
+
+      writeable_attr :customer_uuid
+
+      include Concerns::Entries
+      include Concerns::Pageable
+
+      set_entry_class Subscription
+    end
+  end
+end
+