chartmogul-ruby 1.7.1 → 2.1.0

data/fixtures/vcr_cassettes/ChartMogul_Metrics_ActivitiesExport/post_activities_export.yml

@@ -0,0 +1,83 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.chartmogul.com/v1/activities_export
+    body:
+      encoding: UTF-8
+      string: '{"start-date":"2020-01-01T00:00:00Z","end-date":"2020-12-31T00:00:00Z","type":"new_biz"}'
+    headers:
+      User-Agent:
+      - Faraday v1.0.1
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic hidden
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/1.10.1
+      date:
+      - Fri, 09 Jul 2021 14:37:32 GMT
+      content-type:
+      - application/json
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+      vary:
+      - Accept-Encoding, Accept-Encoding
+      status:
+      - 200 OK
+      access-control-allow-credentials:
+      - 'true'
+    body:
+      encoding: ASCII-8BIT
+      string: '{"id":"17042239-3674-4a61-b838-b6b307f28506","status":"pending","file_url":null,"params":{"kind":"activities","params":{"activity_type":"new_biz","start_date":"2020-01-01
+        00:00:00 +0000","end_date":"2020-12-31 00:00:00 +0000"}},"expires_at":null,"created_at":"2021-07-09T14:37:32+00:00"}'
+    http_version:
+  recorded_at: Fri, 09 Jul 2021 14:37:32 GMT
+- request:
+    method: get
+    uri: https://api.chartmogul.com/v1/activities_export/17042239-3674-4a61-b838-b6b307f28506
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v1.0.1
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic hidden
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/1.10.1
+      date:
+      - Fri, 09 Jul 2021 14:38:10 GMT
+      content-type:
+      - application/json
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+      vary:
+      - Accept-Encoding, Accept-Encoding
+      status:
+      - 200 OK
+      access-control-allow-credentials:
+      - 'true'
+    body:
+      encoding: ASCII-8BIT
+      string: '{"id":"17042239-3674-4a61-b838-b6b307f28506","status":"succeeded","file_url":"https://chartmogul-customer-export.s3.eu-west-1.amazonaws.com/activities-acme-corp-062ea48c-5d74-46dd-bd60-23206cdc241a.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256\u0026X-Amz-Credential=123%2Feu-west-1%2Fs3%2Faws4_request\u0026X-Amz-Date=20210709T135547Z\u0026X-Amz-Expires=604800\u0026X-Amz-SignedHeaders=host\u0026X-Amz-Signature=abc","params":{"kind":"activities","params":{"end_date":"2020-12-31
+        00:00:00 +0000","start_date":"2020-01-01 00:00:00 +0000","activity_type":"new_biz"}},"expires_at":"2021-07-16T14:37:43+00:00","created_at":"2021-07-09T14:37:32+00:00"}'
+    http_version:
+  recorded_at: Fri, 09 Jul 2021 14:38:10 GMT
+recorded_with: VCR 5.1.0

data/fixtures/vcr_cassettes/ChartMogul_Metrics_Activity.yml

@@ -0,0 +1,37 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.chartmogul.com/v1/activities
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v1.0.1
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic hidden
+  response:
+    status:
+      code: 401
+      message: Unauthorized
+    headers:
+      server:
+      - nginx/1.10.1
+      date:
+      - Fri, 18 Jun 2021 10:37:37 GMT
+      content-type:
+      - application/json
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+      status:
+      - 401 Unauthorized
+    body:
+      encoding: UTF-8
+      string: '{"code":401,"message":"No valid API key provided","param":null}'
+  recorded_at: Fri, 18 Jun 2021 10:37:37 GMT
+recorded_with: VCR 6.0.0

data/fixtures/vcr_cassettes/ChartMogul_Metrics_Activity/behaves_like_PageableWithAnchor/should_be_pageable.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.chartmogul.com/v1/activities?per_page=2
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v1.0.1
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic hidden
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/1.10.1
+      date:
+      - Fri, 18 Jun 2021 11:59:07 GMT
+      content-type:
+      - application/json
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+      vary:
+      - Accept-Encoding, Accept-Encoding
+      status:
+      - 200 OK
+      access-control-allow-credentials:
+      - 'true'
+    body:
+      encoding: ASCII-8BIT
+      string: '{"entries":[{"description":"purchased the Basic1 plan","activity-mrr-movement":4478,"activity-mrr":4478,"activity-arr":53736,"date":"2016-08-01T06:28:25+00:00","type":"new_biz","currency":"EUR","subscription-external-id":"si_18dZuXAN0YShtow4jjqxxNnW","plan-external-id":"a3e832e1-1bd1-4889-8466-8efdbfbdd94b","customer-name":"Customer
+        for test@example.com","customer-uuid":"6456e930-8c8e-11eb-a506-0ff43d2cc026","customer-external-id":"cus_8vQm8XjeEOw75p","billing-connector-uuid":"decdeb4c-8c8d-11eb-a506-b3974867f58c","uuid":"2f545d5f-f241-458c-8e99-38c0e5a6e6ff"},{"description":"purchased
+        the Basic1 plan","activity-mrr-movement":4425,"activity-mrr":4425,"activity-arr":53100,"date":"2016-08-17T09:28:10+00:00","type":"new_biz","currency":"EUR","subscription-external-id":"si_18jQLGAN0YShtow4kFWpOMVX","plan-external-id":"a3e832e1-1bd1-4889-8466-8efdbfbdd94b","customer-name":"Customer
+        for test@example.com","customer-uuid":"63ad1285-8c8e-11eb-a506-47d6b1cc7553","customer-external-id":"cus_91TH9rjhhYCpai","billing-connector-uuid":"decdeb4c-8c8d-11eb-a506-b3974867f58c","uuid":"9d5ba7fd-e06d-4750-a8f6-2983f3a30fb2"}],"has_more":true,"per_page":2}'
+  recorded_at: Fri, 18 Jun 2021 11:59:07 GMT
+recorded_with: VCR 6.0.0

data/fixtures/vcr_cassettes/ChartMogul_Metrics_Activity/should_have_Activity_entries.yml

@@ -2,13 +2,13 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.chartmogul.com/v1/customers/cus_91af761e-9d0a-11e5-b514-1feab446feac/activities
+    uri: https://api.chartmogul.com/v1/activities?per_page=2
     body:
       encoding: US-ASCII
       string: ''
     headers:
       User-Agent:
-      - Faraday v0.9.2
+      - Faraday v1.0.1
       Content-Type:
       - application/json
       Authorization:
@@ -16,26 +16,29 @@ http_interactions:
   response:
     status:
       code: 200
-      message: 
+      message: OK
     headers:
       server:
-      - nginx/1.9.10
+      - nginx/1.10.1
       date:
-      - Fri, 01 Jul 2016 14:47:49 GMT
+      - Fri, 18 Jun 2021 11:59:07 GMT
       content-type:
       - application/json
-      content-length:
-      - '278'
+      transfer-encoding:
+      - chunked
       connection:
-      - close
+      - keep-alive
+      vary:
+      - Accept-Encoding, Accept-Encoding
       status:
       - 200 OK
       access-control-allow-credentials:
       - 'true'
     body:
-      encoding: UTF-8
-      string: '{"entries":[{"id":16664702,"description":"purchased the Yael Cohen
-        plan","activity-mrr-movement":10871,"activity-mrr":10871,"activity-arr":130452,"date":"2015-04-16T13:38:29+00:00","type":"new_biz","currency":"USD","currency-sign":"$","subscription_external_id":"si_IJxVS1c1TjSB0s"}],"has_more":false,"per_page":200,"page":1}'
-    http_version: 
-  recorded_at: Fri, 01 Jul 2016 14:47:49 GMT
-recorded_with: VCR 3.0.3
+      encoding: ASCII-8BIT
+      string: '{"entries":[{"description":"purchased the Basic1 plan","activity-mrr-movement":4478,"activity-mrr":4478,"activity-arr":53736,"date":"2016-08-01T06:28:25+00:00","type":"new_biz","currency":"EUR","subscription-external-id":"si_18dZuXAN0YShtow4jjqxxNnW","plan-external-id":"a3e832e1-1bd1-4889-8466-8efdbfbdd94b","customer-name":"Customer
+        for test@example.com","customer-uuid":"6456e930-8c8e-11eb-a506-0ff43d2cc026","customer-external-id":"cus_8vQm8XjeEOw75p","billing-connector-uuid":"decdeb4c-8c8d-11eb-a506-b3974867f58c","uuid":"2f545d5f-f241-458c-8e99-38c0e5a6e6ff"},{"description":"purchased
+        the Basic1 plan","activity-mrr-movement":4425,"activity-mrr":4425,"activity-arr":53100,"date":"2016-08-17T09:28:10+00:00","type":"new_biz","currency":"EUR","subscription-external-id":"si_18jQLGAN0YShtow4kFWpOMVX","plan-external-id":"a3e832e1-1bd1-4889-8466-8efdbfbdd94b","customer-name":"Customer
+        for test@example.com","customer-uuid":"63ad1285-8c8e-11eb-a506-47d6b1cc7553","customer-external-id":"cus_91TH9rjhhYCpai","billing-connector-uuid":"decdeb4c-8c8d-11eb-a506-b3974867f58c","uuid":"9d5ba7fd-e06d-4750-a8f6-2983f3a30fb2"}],"has_more":true,"per_page":2}'
+  recorded_at: Fri, 18 Jun 2021 11:59:07 GMT
+recorded_with: VCR 6.0.0

data/fixtures/vcr_cassettes/ChartMogul_Metrics_Customers_Activity/should_have_Activity_entries.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.chartmogul.com/v1/customers/cus_91af761e-9d0a-11e5-b514-1feab446feac/activities
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic hidden
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - nginx/1.9.10
+      date:
+      - Fri, 01 Jul 2016 14:47:49 GMT
+      content-type:
+      - application/json
+      content-length:
+      - '278'
+      connection:
+      - close
+      status:
+      - 200 OK
+      access-control-allow-credentials:
+      - 'true'
+    body:
+      encoding: UTF-8
+      string: '{"entries":[{"id":16664702,"description":"purchased the Yael Cohen
+        plan","activity-mrr-movement":10871,"activity-mrr":10871,"activity-arr":130452,"date":"2015-04-16T13:38:29+00:00","type":"new_biz","currency":"USD","currency-sign":"$","subscription_external_id":"si_IJxVS1c1TjSB0s"}],"has_more":false,"per_page":200,"page":1}'
+    http_version: 
+  recorded_at: Fri, 01 Jul 2016 14:47:49 GMT
+recorded_with: VCR 3.0.3

data/lib/chartmogul.rb

@@ -43,6 +43,7 @@ require 'chartmogul/concerns/entries'
 require 'chartmogul/concerns/summary'
 require 'chartmogul/concerns/pageable'
 require 'chartmogul/concerns/pageable2'
+require 'chartmogul/concerns/pageable_with_anchor'
 
 require 'chartmogul/subscription'
 require 'chartmogul/invoice'
@@ -66,8 +67,10 @@ require 'chartmogul/metrics/mrr_churn_rate'
 require 'chartmogul/metrics/all_key_metrics'
 require 'chartmogul/metrics/base'
 
+require 'chartmogul/metrics/customers/activity'
+require 'chartmogul/metrics/customers/subscription'
 require 'chartmogul/metrics/activity'
-require 'chartmogul/metrics/subscription'
+require 'chartmogul/metrics/activities_export'
 
 require 'chartmogul/enrichment/customer'
 
@@ -79,10 +82,14 @@ module ChartMogul
   class << self
     extend ConfigAttributes
 
+    def global_config
+      @global_config ||= ChartMogul::Configuration.new
+    end
 
+    # This configuration is thread-safe and fits multi-account async
+    # jobs processing use case.
     def config
-      Thread.current[CONFIG_THREAD_KEY] = ChartMogul::Configuration.new if Thread.current[CONFIG_THREAD_KEY].nil?
-      Thread.current[CONFIG_THREAD_KEY]
+      Thread.current[CONFIG_THREAD_KEY] ||= ChartMogul::Configuration.new
     end
 
     config_accessor :account_token

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

@@ -16,7 +16,7 @@ module ChartMogul
               end
             end
 
-            json = ChartMogul::Utils::JSONParser.parse(resp.body, skip_case_conversion: skip_case_conversion)
+            json = ChartMogul::Utils::JSONParser.parse(resp.body, immutable_keys: immutable_keys)
             new_from_json(json)
           end
         end

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

@@ -15,7 +15,7 @@ module ChartMogul
               req.body = JSON.dump(serialize_for_write)
             end
           end
-          json = ChartMogul::Utils::JSONParser.parse(resp.body, skip_case_conversion: self.class.skip_case_conversion)
+          json = ChartMogul::Utils::JSONParser.parse(resp.body, immutable_keys: self.class.immutable_keys)
 
           assign_all_attributes(json)
         end
@@ -30,7 +30,7 @@ module ChartMogul
                 req.body = JSON.dump(resource.serialize_for_write)
               end
             end
-            json = ChartMogul::Utils::JSONParser.parse(resp.body, skip_case_conversion: skip_case_conversion)
+            json = ChartMogul::Utils::JSONParser.parse(resp.body, immutable_keys: immutable_keys)
 
             new_from_json(json)
           end

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

@@ -25,7 +25,7 @@ module ChartMogul
                 req.body = JSON.dump(body_data)
               end
             end
-            ChartMogul::Utils::JSONParser.parse(resp.body, skip_case_conversion: skip_case_conversion)
+            ChartMogul::Utils::JSONParser.parse(resp.body, immutable_keys: immutable_keys)
           end
 
           def custom!(http_method, http_path, body_data = {})

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

@@ -15,7 +15,8 @@ module ChartMogul
                 req.headers['Content-Type'] = 'application/json'
               end
             end
-            json = ChartMogul::Utils::JSONParser.parse(resp.body, skip_case_conversion: skip_case_conversion)
+
+            json = ChartMogul::Utils::JSONParser.parse(resp.body, immutable_keys: immutable_keys)
             new_from_json(json)
           end
         end

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

@@ -16,7 +16,7 @@ module ChartMogul
             end
           end
 
-          json = ChartMogul::Utils::JSONParser.parse(resp.body, skip_case_conversion: self.class.skip_case_conversion)
+          json = ChartMogul::Utils::JSONParser.parse(resp.body, immutable_keys: self.class.immutable_keys)
 
           assign_all_attributes(json)
         end
@@ -31,7 +31,7 @@ module ChartMogul
                 req.body = JSON.dump(resource.serialize_for_write)
               end
             end
-            json = ChartMogul::Utils::JSONParser.parse(resp.body, skip_case_conversion: skip_case_conversion)
+            json = ChartMogul::Utils::JSONParser.parse(resp.body, immutable_keys: immutable_keys)
 
             new_from_json(json)
           end

data/lib/chartmogul/api_resource.rb

@@ -17,7 +17,7 @@ module ChartMogul
     MAX_INTERVAL = 60
     THREAD_CONNECTION_KEY = 'chartmogul_ruby.api_resource.connection'
 
-    class << self; attr_reader :resource_path, :resource_name, :resource_root_key, :skip_case_conversion end
+    class << self; attr_reader :resource_path, :resource_name, :resource_root_key end
 
     def self.set_resource_path(path)
       @resource_path = ChartMogul::ResourcePath.new(path)
@@ -31,9 +31,13 @@ module ChartMogul
       @resource_root_key = root_key
     end
 
-    # When true, response hash keys won't be converted to snake case
-    def self.set_skip_case_conversion(value)
-      @skip_case_conversion = value
+    def self.immutable_keys
+      @immutable_keys ||= []
+    end
+
+    # When set with keys, nested hash keys of these immutable keys won't be converted to snake case
+    def self.set_immutable_keys(array)
+      @immutable_keys = array
     end
 
     def self.connection

data/lib/chartmogul/concerns/pageable_with_anchor.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ChartMogul
+  module Concerns
+    module PageableWithAnchor
+      def self.included(base)
+        base.instance_eval do
+          readonly_attr :has_more
+          readonly_attr :per_page
+        end
+      end
+    end
+  end
+end

data/lib/chartmogul/config_attributes.rb

@@ -4,7 +4,7 @@ module ChartMogul
   module ConfigAttributes
     def config_accessor(attribute, default_value = nil)
       define_method(attribute) do
-        attr = config.send(attribute) || default_value
+        attr = config.send(attribute) || global_config.send(attribute) || default_value
         if attr.nil?
           raise ConfigurationError, "Configuration for #{attribute} not set"
         end
@@ -12,9 +12,25 @@ module ChartMogul
         attr
       end
 
+      define_method("global_#{attribute}") do
+        attr = global_config.send(attribute) || default_value
+        if attr.nil?
+          raise ConfigurationError, "Global configuration for #{attribute} not set"
+        end
+
+        attr
+      end
+
       define_method("#{attribute}=") do |val|
         config.send("#{attribute}=", val)
         Thread.current[ChartMogul::APIResource::THREAD_CONNECTION_KEY] = nil
+        val
+      end
+
+      define_method("global_#{attribute}=") do |val|
+        global_config.send("#{attribute}=", val)
+        Thread.current[ChartMogul::APIResource::THREAD_CONNECTION_KEY] = nil
+        val
       end
     end
   end