chartmogul-ruby 0.1.1

data/fixtures/vcr_cassettes/ChartMogul_Metrics_MRR/should_have_entries.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.chartmogul.com/v1/metrics/mrr?end-date=2015-02-01&start-date=2015-01-01
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic YzU0NjYwNDU5ZTMzODBkYzUyNmVhYjNiZjlhZGIyOGQ6N2MyMDEzOTYzZjQ2NGZiMmQ3ZjVjOTJkZDZiMjk2NDQ=
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - nginx/1.9.10
+      date:
+      - Fri, 01 Jul 2016 14:47:47 GMT
+      content-type:
+      - application/json
+      content-length:
+      - '4199'
+      connection:
+      - close
+      vary:
+      - Accept-Encoding
+      status:
+      - 200 OK
+      access-control-allow-credentials:
+      - 'true'
+    body:
+      encoding: UTF-8
+      string: '{"entries":[{"date":"2015-01-01","mrr":0,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-02","mrr":0,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-03","mrr":0,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-04","mrr":0,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-05","mrr":0,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-06","mrr":0,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-07","mrr":0,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-08","mrr":0,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-09","mrr":34112,"mrr-new-business":34112,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-10","mrr":34112,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-11","mrr":34112,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-12","mrr":64366,"mrr-new-business":30254,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-13","mrr":64366,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-14","mrr":55853,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":-30254,"mrr-reactivation":21741},{"date":"2015-01-15","mrr":55853,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-16","mrr":55853,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-17","mrr":55853,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-18","mrr":65853,"mrr-new-business":10000,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-19","mrr":65853,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-20","mrr":65853,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-21","mrr":65853,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-22","mrr":54982,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":-10871,"mrr-reactivation":0},{"date":"2015-01-23","mrr":53895,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":-1087,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-24","mrr":53895,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-25","mrr":53895,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-26","mrr":0,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":-64766,"mrr-reactivation":10871},{"date":"2015-01-27","mrr":10000,"mrr-new-business":10000,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-28","mrr":10000,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-29","mrr":6871,"mrr-new-business":4750,"mrr-expansion":12121,"mrr-contraction":0,"mrr-churn":-20000,"mrr-reactivation":0},{"date":"2015-01-30","mrr":15620,"mrr-new-business":0,"mrr-expansion":8749,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-01-31","mrr":15620,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0},{"date":"2015-02-01","mrr":15620,"mrr-new-business":0,"mrr-expansion":0,"mrr-contraction":0,"mrr-churn":0,"mrr-reactivation":0}],"summary":{"current":43371,"previous":43371,"percentage-change":0.0}}'
+    http_version: 
+  recorded_at: Fri, 01 Jul 2016 14:47:47 GMT
+recorded_with: VCR 3.0.3

data/fixtures/vcr_cassettes/ChartMogul_Metrics_MRRChurnRate/behaves_like_Metrics_API_resource/behaves_like_Summary/should_have_summary.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.chartmogul.com/v1/metrics/mrr-churn-rate?end-date=2015-02-01&start-date=2015-01-01
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic YzU0NjYwNDU5ZTMzODBkYzUyNmVhYjNiZjlhZGIyOGQ6N2MyMDEzOTYzZjQ2NGZiMmQ3ZjVjOTJkZDZiMjk2NDQ=
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - nginx/1.9.10
+      date:
+      - Fri, 01 Jul 2016 16:56:26 GMT
+      content-type:
+      - application/json
+      content-length:
+      - '160'
+      connection:
+      - close
+      status:
+      - 200 OK
+      access-control-allow-credentials:
+      - 'true'
+    body:
+      encoding: UTF-8
+      string: '{"entries":[{"date":"2015-01-31","mrr-churn-rate":0.0},{"date":"2015-02-01","mrr-churn-rate":0.0}],"summary":{"current":0,"previous":0,"percentage-change":0.0}}'
+    http_version: 
+  recorded_at: Fri, 01 Jul 2016 16:56:26 GMT
+recorded_with: VCR 3.0.3

data/fixtures/vcr_cassettes/ChartMogul_Metrics_MRRChurnRate/behaves_like_Metrics_API_resource/should_have_entries.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.chartmogul.com/v1/metrics/mrr-churn-rate?end-date=2015-02-01&start-date=2015-01-01
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic YzU0NjYwNDU5ZTMzODBkYzUyNmVhYjNiZjlhZGIyOGQ6N2MyMDEzOTYzZjQ2NGZiMmQ3ZjVjOTJkZDZiMjk2NDQ=
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - nginx/1.9.10
+      date:
+      - Fri, 01 Jul 2016 16:56:25 GMT
+      content-type:
+      - application/json
+      content-length:
+      - '160'
+      connection:
+      - close
+      status:
+      - 200 OK
+      access-control-allow-credentials:
+      - 'true'
+    body:
+      encoding: UTF-8
+      string: '{"entries":[{"date":"2015-01-31","mrr-churn-rate":0.0},{"date":"2015-02-01","mrr-churn-rate":0.0}],"summary":{"current":0,"previous":0,"percentage-change":0.0}}'
+    http_version: 
+  recorded_at: Fri, 01 Jul 2016 16:56:25 GMT
+recorded_with: VCR 3.0.3

data/fixtures/vcr_cassettes/ChartMogul_Metrics_Subscription/behaves_like_Pageable/should_be_pageable.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.chartmogul.com/v1/customers/cus_91af761e-9d0a-11e5-b514-1feab446feac/subscriptions
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic YzU0NjYwNDU5ZTMzODBkYzUyNmVhYjNiZjlhZGIyOGQ6N2MyMDEzOTYzZjQ2NGZiMmQ3ZjVjOTJkZDZiMjk2NDQ=
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - nginx/1.9.10
+      date:
+      - Fri, 01 Jul 2016 14:47:48 GMT
+      content-type:
+      - application/json
+      content-length:
+      - '308'
+      connection:
+      - close
+      status:
+      - 200 OK
+      access-control-allow-credentials:
+      - 'true'
+    body:
+      encoding: UTF-8
+      string: '{"entries":[{"id":9201273,"plan":"Yael Cohen","quantity":1,"mrr":10871,"arr":130452,"status":"active","billing-cycle":"day","billing-cycle-count":7,"start-date":"2015-10-15T13:41:40+00:00","end-date":"2015-10-22T13:41:40+00:00","currency":"USD","currency-sign":"$"}],"has_more":false,"per_page":200,"page":1}'
+    http_version: 
+  recorded_at: Fri, 01 Jul 2016 14:47:48 GMT
+recorded_with: VCR 3.0.3

data/fixtures/vcr_cassettes/ChartMogul_Metrics_Subscription/should_have_Subscription_entries.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.chartmogul.com/v1/customers/cus_91af761e-9d0a-11e5-b514-1feab446feac/subscriptions
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic YzU0NjYwNDU5ZTMzODBkYzUyNmVhYjNiZjlhZGIyOGQ6N2MyMDEzOTYzZjQ2NGZiMmQ3ZjVjOTJkZDZiMjk2NDQ=
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - nginx/1.9.10
+      date:
+      - Fri, 01 Jul 2016 14:47:47 GMT
+      content-type:
+      - application/json
+      content-length:
+      - '308'
+      connection:
+      - close
+      status:
+      - 200 OK
+      access-control-allow-credentials:
+      - 'true'
+    body:
+      encoding: UTF-8
+      string: '{"entries":[{"id":9201273,"plan":"Yael Cohen","quantity":1,"mrr":10871,"arr":130452,"status":"active","billing-cycle":"day","billing-cycle-count":7,"start-date":"2015-10-15T13:41:40+00:00","end-date":"2015-10-22T13:41:40+00:00","currency":"USD","currency-sign":"$"}],"has_more":false,"per_page":200,"page":1}'
+    http_version: 
+  recorded_at: Fri, 01 Jul 2016 14:47:47 GMT
+recorded_with: VCR 3.0.3

data/lib/chartmogul.rb

@@ -0,0 +1,77 @@
+require 'time'
+require 'json'
+require 'faraday'
+
+require "chartmogul/version"
+
+require "chartmogul/utils/hash_snake_caser"
+require "chartmogul/utils/json_parser"
+
+require "chartmogul/errors/chartmogul_error"
+require "chartmogul/errors/not_found_error"
+require "chartmogul/errors/configuration_error"
+require "chartmogul/errors/resource_invalid_error"
+require "chartmogul/errors/schema_invalid_error"
+
+require "chartmogul/config_attributes"
+require "chartmogul/configuration"
+
+require "chartmogul/object"
+require "chartmogul/resource_path"
+require "chartmogul/api_resource"
+require "chartmogul/summary"
+
+require "chartmogul/api/actions/all"
+require "chartmogul/api/actions/create"
+require "chartmogul/api/actions/update"
+require "chartmogul/api/actions/destroy"
+require "chartmogul/api/actions/custom"
+
+require "chartmogul/import/line_items/one_time"
+require "chartmogul/import/line_items/subscription"
+
+require "chartmogul/import/transactions/payment"
+require "chartmogul/import/transactions/refund"
+
+require "chartmogul/import/invoice"
+require "chartmogul/import/customer_invoices"
+
+require "chartmogul/import/subscription"
+require "chartmogul/import/customer"
+require "chartmogul/import/data_source"
+require "chartmogul/import/plan"
+
+require "chartmogul/concerns/entries"
+require "chartmogul/concerns/summary"
+require "chartmogul/concerns/pageable"
+
+require "chartmogul/metrics/arpa"
+require "chartmogul/metrics/arr"
+require "chartmogul/metrics/asp"
+require "chartmogul/metrics/customer_churn_rate"
+require "chartmogul/metrics/customer_count"
+require "chartmogul/metrics/ltv"
+require "chartmogul/metrics/mrr"
+require "chartmogul/metrics/mrr_churn_rate"
+require "chartmogul/metrics/all_key_metrics"
+require "chartmogul/metrics/base"
+
+require "chartmogul/metrics/activity"
+require "chartmogul/metrics/subscription"
+
+require "chartmogul/enrichment/customer"
+
+module ChartMogul
+  API_BASE = 'https://api.chartmogul.com'
+
+  class << self
+    extend ConfigAttributes
+
+    def config
+      @config ||= ChartMogul::Configuration.new
+    end
+
+    config_accessor :account_token
+    config_accessor :secret_key
+  end
+end

data/lib/chartmogul/api/actions/all.rb

@@ -0,0 +1,28 @@
+module ChartMogul
+  module API
+    module Actions
+      module All
+        def self.included(base)
+          base.extend ClassMethods
+        end
+
+        module ClassMethods
+          def all(options = {})
+            resp = handling_errors do
+              connection.get(resource_path.apply_with_get_params(options)) do |req|
+                req.headers['Content-Type'] = 'application/json'
+              end
+            end
+            json = ChartMogul::Utils::JSONParser.parse(resp.body)
+
+            if resource_root_key && json.key?(resource_root_key)
+              json[resource_root_key].map { |attributes| new_from_json(attributes) }
+            else
+              new_from_json(json)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chartmogul/api/actions/create.rb

@@ -0,0 +1,39 @@
+module ChartMogul
+  module API
+    module Actions
+      module Create
+        def self.included(base)
+          base.extend ClassMethods
+        end
+
+        def create!
+          resp = handling_errors do
+            connection.post(resource_path.apply(self.instance_attributes)) do |req|
+              req.headers['Content-Type'] = 'application/json'
+              req.body = JSON.dump(self.serialize_for_write)
+            end
+          end
+          json = ChartMogul::Utils::JSONParser.parse(resp.body)
+
+          assign_all_attributes(json)
+        end
+
+        module ClassMethods
+          def create!(attributes = {})
+            resource = new(attributes)
+
+            resp = handling_errors do
+              connection.post(resource_path.apply(attributes)) do |req|
+                req.headers['Content-Type'] = 'application/json'
+                req.body = JSON.dump(resource.serialize_for_write)
+              end
+            end
+            json = ChartMogul::Utils::JSONParser.parse(resp.body)
+
+            new_from_json(json)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chartmogul/api/actions/custom.rb

@@ -0,0 +1,42 @@
+module ChartMogul
+  module API
+    module Actions
+      module Custom
+        def self.included(base)
+          base.extend ClassMethods
+        end
+
+        def custom_without_assign!(http_method, http_path, body_data = {})
+          self.class.custom_without_assign!(http_method, http_path, body_data)
+        end
+
+        def custom!(http_method, http_path, body_data = {})
+          json = custom_without_assign!(http_method, http_path, body_data = {})
+          assign_all_attributes(json)
+        end
+
+        module ClassMethods
+          def custom_without_assign!(http_method, http_path, body_data = {})
+            resp = handling_errors do
+              connection.send(http_method, http_path) do |req|
+                req.headers['Content-Type'] = 'application/json'
+                req.body = JSON.dump(body_data)
+              end
+            end
+            ChartMogul::Utils::JSONParser.parse(resp.body)
+          end
+
+          def custom!(http_method, http_path, body_data = {})
+            json = custom_without_assign!(http_method, http_path, body_data = {})
+
+            if resource_root_key && json.key?(resource_root_key)
+              json[resource_root_key].map { |attributes| new_from_json(attributes) }
+            else
+              new_from_json(json)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chartmogul/api/actions/destroy.rb

@@ -0,0 +1,14 @@
+module ChartMogul
+  module API
+    module Actions
+      module Destroy
+        def destroy!
+          handling_errors do
+            connection.delete("#{resource_path.apply(self.instance_attributes)}/#{uuid}")
+          end
+          true
+        end
+      end
+    end
+  end
+end

data/lib/chartmogul/api/actions/update.rb

@@ -0,0 +1,19 @@
+module ChartMogul
+  module API
+    module Actions
+      module Update
+        def update!
+          resp = handling_errors do
+            connection.patch("#{resource_path.apply(self.instance_attributes)}/#{uuid}") do |req|
+              req.headers['Content-Type'] = 'application/json'
+              req.body = JSON.dump(self.serialize_for_write)
+            end
+          end
+          json = ChartMogul::Utils::JSONParser.parse(resp.body)
+
+          assign_all_attributes(json)
+        end
+      end
+    end
+  end
+end

data/lib/chartmogul/api_resource.rb

@@ -0,0 +1,57 @@
+require 'forwardable'
+
+module ChartMogul
+  class APIResource < ChartMogul::Object
+    extend Forwardable
+
+    class << self; attr_reader :resource_path, :resource_name, :resource_root_key end
+
+    def self.set_resource_path(path)
+      @resource_path = ChartMogul::ResourcePath.new(path)
+    end
+
+    def self.set_resource_name(name)
+      @resource_name = name
+    end
+
+    def self.set_resource_root_key(root_key)
+      @resource_root_key = root_key
+    end
+
+    def self.connection
+      @connection ||= Faraday.new(url: ChartMogul::API_BASE) do |faraday|
+        faraday.use Faraday::Request::BasicAuthentication, ChartMogul.account_token, ChartMogul.secret_key
+        faraday.use Faraday::Response::RaiseError
+        faraday.use Faraday::Adapter::NetHttp
+      end
+    end
+
+    def self.handling_errors
+      yield
+    rescue Faraday::ClientError => exception
+      response = exception.response[:body]
+      http_status = exception.response[:status]
+      case http_status
+      when 400
+        message = "JSON schema validation hasn't passed."
+        raise ChartMogul::SchemaInvalidError.new(message, http_status: 400, response: response)
+      when 403
+        message = "The requested action is forbidden."
+        raise ChartMogul::ForbiddenError.new(message, http_status: 403, response: response)
+      when 404
+        message = "The requested #{resource_name} could not be found."
+        raise ChartMogul::NotFoundError.new(message, http_status: 404, response: response)
+      when 422
+        message = "The #{resource_name} could not be created or updated."
+        raise ChartMogul::ResourceInvalidError.new(message, http_status: 422, response: response)
+      else
+        message = "#{resource_name} request error has occurred."
+        raise ChartMogul::ChartMogulError.new(message, http_status: http_status, response: response)
+      end
+    rescue => exception
+      raise ChartMogul::ChartMogulError.new(exception.message)
+    end
+
+    def_delegators 'self.class', :resource_path, :resource_name, :resource_root_key, :connection, :handling_errors
+  end
+end