chartmogul-ruby 3.0.0 → 3.0.2

data/fixtures/vcr_cassettes/ChartMogul_SubscriptionEvent/API_interactions/updates_the_subscription_event.yml

@@ -0,0 +1,377 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.chartmogul.com/v1/data_sources
+    body:
+      encoding: UTF-8
+      string: '{"name":"Subscription Events Test ds_update"}'
+    headers:
+      User-Agent:
+      - chartmogul-ruby/3.0.0
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic hidden
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      access-control-allow-credentials:
+      - 'true'
+      content-type:
+      - application/json
+      date:
+      - Fri, 27 May 2022 21:54:17 GMT
+      status:
+      - 201 Created
+      content-length:
+      - '172'
+      connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"uuid":"ds_8e206f5e-de07-11ec-8815-7b519b46d260","name":"Subscription
+        Events Test ds_update","system":"Import API","created_at":"2022-05-27T21:54:17.215Z","status":"idle"}'
+    http_version:
+  recorded_at: Fri, 27 May 2022 21:54:17 GMT
+- request:
+    method: post
+    uri: https://api.chartmogul.com/v1/customers
+    body:
+      encoding: UTF-8
+      string: '{"external_id":"test_cus_ext_id","name":"Test Customer","data_source_uuid":"ds_8e206f5e-de07-11ec-8815-7b519b46d260"}'
+    headers:
+      User-Agent:
+      - chartmogul-ruby/3.0.0
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic hidden
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      access-control-allow-credentials:
+      - 'true'
+      content-type:
+      - application/json
+      date:
+      - Fri, 27 May 2022 21:54:17 GMT
+      status:
+      - 201 Created
+      content-length:
+      - '772'
+      connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"id":131944260,"uuid":"cus_8e5f5b06-de07-11ec-bf8c-e3f6cf4804ac","external_id":"test_cus_ext_id","name":"Test
+        Customer","email":"","status":"Lead","customer-since":null,"attributes":{"custom":{},"clearbit":{},"stripe":{},"tags":[]},"data_source_uuid":"ds_8e206f5e-de07-11ec-8815-7b519b46d260","data_source_uuids":["ds_8e206f5e-de07-11ec-8815-7b519b46d260"],"external_ids":["test_cus_ext_id"],"company":"","country":null,"state":null,"city":"","zip":null,"lead_created_at":null,"free_trial_started_at":null,"address":{"country":null,"state":null,"city":"","address_zip":null},"mrr":0,"arr":0,"billing-system-url":null,"chartmogul-url":"https://app.chartmogul.com/#/customers/131944260-Test_Customer","billing-system-type":"Import
+        API","currency":"USD","currency-sign":"$"}'
+    http_version:
+  recorded_at: Fri, 27 May 2022 21:54:17 GMT
+- request:
+    method: post
+    uri: https://api.chartmogul.com/v1/plans
+    body:
+      encoding: UTF-8
+      string: '{"name":"Test Plan1","interval_count":7,"interval_unit":"day","data_source_uuid":"ds_8e206f5e-de07-11ec-8815-7b519b46d260"}'
+    headers:
+      User-Agent:
+      - chartmogul-ruby/3.0.0
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic hidden
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      access-control-allow-credentials:
+      - 'true'
+      cache-control:
+      - max-age=0, private, must-revalidate
+      content-type:
+      - application/json; charset=utf-8
+      date:
+      - Fri, 27 May 2022 21:54:18 GMT
+      etag:
+      - W/"48a3a10d72b78dec8060fa5517045a31"
+      referrer-policy:
+      - strict-origin-when-cross-origin
+      status:
+      - 201 Created
+      x-content-type-options:
+      - nosniff
+      x-download-options:
+      - noopen
+      x-frame-options:
+      - DENY
+      x-permitted-cross-domain-policies:
+      - none
+      x-request-id:
+      - daa8ab3a17de0a3a3b9d5285e57964c6
+      x-runtime:
+      - '0.043259'
+      x-xss-protection:
+      - 1; mode=block
+      content-length:
+      - '225'
+      connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"external_id":"7b1fc3a0-c035-013a-2b32-2ae6b33040d8","name":"Test
+        Plan1","interval_count":7,"interval_unit":"day","data_source_uuid":"ds_8e206f5e-de07-11ec-8815-7b519b46d260","uuid":"pl_7b1fc3a0-c035-013a-2b32-2ae6b33040d8"}'
+    http_version:
+  recorded_at: Fri, 27 May 2022 21:54:18 GMT
+- request:
+    method: post
+    uri: https://api.chartmogul.com/v1/subscription_events
+    body:
+      encoding: UTF-8
+      string: '{"subscription_event":{"id":null,"data_source_uuid":"ds_8e206f5e-de07-11ec-8815-7b519b46d260","customer_external_id":"test_cus_ext_id","subscription_set_external_id":"","subscription_external_id":"test_cus_sub_ext_id1","plan_external_id":"","event_date":"2022-05-18T09:48:34Z","effective_date":"2021-12-30T00:01:00Z","event_type":"subscription_cancelled","external_id":"test_ev_id_update_1","errors":null,"created_at":null,"updated_at":null,"quantity":"","currency":"","amount_in_cents":"","tax_amount_in_cents":null,"retracted_event_id":null}}'
+    headers:
+      User-Agent:
+      - chartmogul-ruby/3.0.0
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic hidden
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      access-control-allow-credentials:
+      - 'true'
+      cache-control:
+      - max-age=0, private, must-revalidate
+      content-type:
+      - application/json; charset=utf-8
+      date:
+      - Fri, 27 May 2022 21:54:18 GMT
+      etag:
+      - W/"a0199d2ce12eef4fc0a5abfe03e28a41"
+      referrer-policy:
+      - strict-origin-when-cross-origin
+      status:
+      - 201 Created
+      x-content-type-options:
+      - nosniff
+      x-download-options:
+      - noopen
+      x-frame-options:
+      - DENY
+      x-permitted-cross-domain-policies:
+      - none
+      x-request-id:
+      - a3c959e856dd2c84a3c160428ef97a31
+      x-runtime:
+      - '0.039881'
+      x-xss-protection:
+      - 1; mode=block
+      content-length:
+      - '560'
+      connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"id":138979498,"data_source_uuid":"ds_8e206f5e-de07-11ec-8815-7b519b46d260","customer_external_id":"test_cus_ext_id","subscription_set_external_id":"","subscription_external_id":"test_cus_sub_ext_id1","plan_external_id":"","event_date":"2022-05-18T09:48:34Z","effective_date":"2021-12-30T00:01:00Z","event_type":"subscription_cancelled","external_id":"test_ev_id_update_1","errors":{},"created_at":"2022-05-27T21:54:18Z","updated_at":"2022-05-27T21:54:18Z","quantity":"","currency":"","amount_in_cents":"","tax_amount_in_cents":null,"retracted_event_id":null}'
+    http_version:
+  recorded_at: Fri, 27 May 2022 21:54:18 GMT
+- request:
+    method: patch
+    uri: https://api.chartmogul.com/v1/subscription_events
+    body:
+      encoding: UTF-8
+      string: '{"subscription_event":{"external_id":"test_ev_id_update_2","id":138979498}}'
+    headers:
+      User-Agent:
+      - chartmogul-ruby/3.0.0
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic hidden
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      access-control-allow-credentials:
+      - 'true'
+      cache-control:
+      - max-age=0, private, must-revalidate
+      content-type:
+      - application/json; charset=utf-8
+      date:
+      - Fri, 27 May 2022 21:54:18 GMT
+      etag:
+      - W/"63531fd647f063a29d241a2ed4e9287a"
+      referrer-policy:
+      - strict-origin-when-cross-origin
+      status:
+      - 200 OK
+      vary:
+      - Accept-Encoding, Accept-Encoding
+      x-content-type-options:
+      - nosniff
+      x-download-options:
+      - noopen
+      x-frame-options:
+      - DENY
+      x-permitted-cross-domain-policies:
+      - none
+      x-request-id:
+      - 9e95374a6e8b5c5843fb3a2b9cbd9d5c
+      x-runtime:
+      - '0.049703'
+      x-xss-protection:
+      - 1; mode=block
+      content-length:
+      - '305'
+      connection:
+      - keep-alive
+    body:
+      encoding: ASCII-8BIT
+      string: '{"id":138979498,"data_source_uuid":"ds_8e206f5e-de07-11ec-8815-7b519b46d260","customer_external_id":"test_cus_ext_id","subscription_set_external_id":"","subscription_external_id":"test_cus_sub_ext_id1","plan_external_id":"","event_date":"2022-05-18T09:48:34Z","effective_date":"2021-12-30T00:01:00Z","event_type":"subscription_cancelled","external_id":"test_ev_id_update_2","errors":{},"created_at":"2022-05-27T21:54:18Z","updated_at":"2022-05-27T21:54:18Z","quantity":"","currency":"","amount_in_cents":"","tax_amount_in_cents":null,"retracted_event_id":null}'
+    http_version:
+  recorded_at: Fri, 27 May 2022 21:54:18 GMT
+- request:
+    method: get
+    uri: https://api.chartmogul.com/v1/subscription_events?data_source_uuid=ds_8e206f5e-de07-11ec-8815-7b519b46d260
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - chartmogul-ruby/3.0.0
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic hidden
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      access-control-allow-credentials:
+      - 'true'
+      cache-control:
+      - max-age=0, private, must-revalidate
+      content-type:
+      - application/json; charset=utf-8
+      date:
+      - Fri, 27 May 2022 21:54:19 GMT
+      etag:
+      - W/"993c2837a0d8cc9bf8c71ace5d08133d"
+      referrer-policy:
+      - strict-origin-when-cross-origin
+      status:
+      - 200 OK
+      vary:
+      - Accept-Encoding, Accept-Encoding
+      x-content-type-options:
+      - nosniff
+      x-download-options:
+      - noopen
+      x-frame-options:
+      - DENY
+      x-permitted-cross-domain-policies:
+      - none
+      x-request-id:
+      - 5a970a6116d23f9a5862192529f8fe70
+      x-runtime:
+      - '0.025956'
+      x-xss-protection:
+      - 1; mode=block
+      content-length:
+      - '370'
+      connection:
+      - keep-alive
+    body:
+      encoding: ASCII-8BIT
+      string: '{"subscription_events":[{"id":138979498,"data_source_uuid":"ds_8e206f5e-de07-11ec-8815-7b519b46d260","customer_external_id":"test_cus_ext_id","subscription_set_external_id":"","subscription_external_id":"test_cus_sub_ext_id1","plan_external_id":"","event_date":"2022-05-18T09:48:34Z","effective_date":"2021-12-30T00:01:00Z","event_type":"subscription_cancelled","external_id":"test_ev_id_update_2","errors":{},"created_at":"2022-05-27T21:54:18Z","updated_at":"2022-05-27T21:54:18Z","quantity":"","currency":"","amount_in_cents":"","tax_amount_in_cents":null,"retracted_event_id":null}],"meta":{"next_key":null,"prev_key":null,"before_key":"2022-05-27T21:54:19.186Z","page":1,"total_pages":1}}'
+    http_version:
+  recorded_at: Fri, 27 May 2022 21:54:19 GMT
+- request:
+    method: delete
+    uri: https://api.chartmogul.com/v1/subscription_events?subscription_event%5Bid%5D=138979498
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - chartmogul-ruby/3.0.0
+      Authorization:
+      - Basic hidden
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      access-control-allow-credentials:
+      - 'true'
+      cache-control:
+      - no-cache
+      date:
+      - Fri, 27 May 2022 21:54:19 GMT
+      referrer-policy:
+      - strict-origin-when-cross-origin
+      status:
+      - 204 No Content
+      x-content-type-options:
+      - nosniff
+      x-download-options:
+      - noopen
+      x-frame-options:
+      - DENY
+      x-permitted-cross-domain-policies:
+      - none
+      x-request-id:
+      - 466c85b83831cd5366f4dba5697e605b
+      x-runtime:
+      - '0.034773'
+      x-xss-protection:
+      - 1; mode=block
+      connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version:
+  recorded_at: Fri, 27 May 2022 21:54:19 GMT
+- request:
+    method: delete
+    uri: https://api.chartmogul.com/v1/data_sources/ds_8e206f5e-de07-11ec-8815-7b519b46d260
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - chartmogul-ruby/3.0.0
+      Authorization:
+      - Basic hidden
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      access-control-allow-credentials:
+      - 'true'
+      date:
+      - Fri, 27 May 2022 21:54:20 GMT
+      status:
+      - 204 No Content
+      connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version:
+  recorded_at: Fri, 27 May 2022 21:54:19 GMT
+recorded_with: VCR 5.1.0

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ChartMogul
+  module API
+    module Actions
+      module DestroyWithParams
+        def self.included(base)
+          base.extend ClassMethods
+        end
+
+        def destroy_with_params!
+          handling_errors do
+            connection.delete(resource_path.path, instance_attributes)
+          end
+          true
+        end
+
+        module ClassMethods
+          def destroy_with_params!(options = {})
+            handling_errors do
+              connection.delete(resource_path.path, options)
+            end
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chartmogul/api_resource.rb

@@ -89,7 +89,7 @@ module ChartMogul
     private
 
     def self.build_connection
-      Faraday.new(url: ChartMogul.api_base) do |faraday|
+      Faraday.new(url: ChartMogul.api_base, headers: { 'User-Agent' => "chartmogul-ruby/#{ChartMogul::VERSION}" }) do |faraday|
         faraday.use Faraday::Request::BasicAuthentication, ChartMogul.api_key, ''
         faraday.use Faraday::Response::RaiseError
         faraday.request :retry, max: ChartMogul.max_retries, retry_statuses: RETRY_STATUSES,

data/lib/chartmogul/concerns/summary_all.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ChartMogul
+  module Concerns
+    module SummaryAll
+      def self.included(base)
+        base.send :prepend, InstanceMethods
+
+        base.instance_eval do
+          readonly_attr :summary
+        end
+      end
+
+      module InstanceMethods
+        def set_summary(summary_attributes)
+          @summary = ChartMogul::SummaryAll.new_from_json(summary_attributes)
+        end
+      end
+    end
+  end
+end

data/lib/chartmogul/metrics/all_key_metrics.rb

@@ -12,6 +12,14 @@ module ChartMogul
       readonly_attr :ltv
       readonly_attr :mrr
       readonly_attr :mrr_churn_rate
+      readonly_attr :arpa_percentage_change
+      readonly_attr :arr_percentage_change
+      readonly_attr :asp_percentage_change
+      readonly_attr :customer_churn_rate_percentage_change
+      readonly_attr :customers_percentage_change
+      readonly_attr :ltv_percentage_change
+      readonly_attr :mrr_percentage_change
+      readonly_attr :mrr_churn_rate_percentage_change
     end
 
     class AllKeyMetrics < APIResource
@@ -19,6 +27,7 @@ module ChartMogul
       set_resource_path '/v1/metrics/all'
 
       include Concerns::Entries
+      include Concerns::SummaryAll
 
       set_entry_class AllKeyMetric
     end

data/lib/chartmogul/metrics/arpa.rb

@@ -5,6 +5,7 @@ module ChartMogul
     class ARPA < ChartMogul::Object
       readonly_attr :date, type: :date
       readonly_attr :arpa
+      readonly_attr :percentage_change
     end
 
     class ARPAs < APIResource

data/lib/chartmogul/metrics/arr.rb

@@ -5,6 +5,7 @@ module ChartMogul
     class ARR < ChartMogul::Object
       readonly_attr :date, type: :date
       readonly_attr :arr
+      readonly_attr :percentage_change
     end
 
     class ARRs < APIResource

data/lib/chartmogul/metrics/asp.rb

@@ -5,6 +5,7 @@ module ChartMogul
     class ASP < ChartMogul::Object
       readonly_attr :date, type: :date
       readonly_attr :asp
+      readonly_attr :percentage_change
     end
 
     class ASPs < APIResource

data/lib/chartmogul/metrics/customer_churn_rate.rb

@@ -5,6 +5,7 @@ module ChartMogul
     class CustomerChurnRate < ChartMogul::Object
       readonly_attr :date, type: :date
       readonly_attr :customer_churn_rate
+      readonly_attr :percentage_change
     end
 
     class CustomerChurnRates < APIResource

data/lib/chartmogul/metrics/customer_count.rb

@@ -5,6 +5,7 @@ module ChartMogul
     class CustomerCount < ChartMogul::Object
       readonly_attr :date, type: :date
       readonly_attr :customers
+      readonly_attr :percentage_change
     end
 
     class CustomerCounts < APIResource

data/lib/chartmogul/metrics/ltv.rb

@@ -5,6 +5,7 @@ module ChartMogul
     class LTV < ChartMogul::Object
       readonly_attr :date, type: :date
       readonly_attr :ltv
+      readonly_attr :percentage_change
     end
 
     class LTVs < APIResource

data/lib/chartmogul/metrics/mrr.rb

@@ -13,6 +13,7 @@ module ChartMogul
 
       readonly_attr :mrr_churn
       readonly_attr :mrr_reactivation
+      readonly_attr :percentage_change
     end
 
     class MRRs < APIResource

data/lib/chartmogul/metrics/mrr_churn_rate.rb

@@ -5,6 +5,7 @@ module ChartMogul
     class MRRChurnRate < ChartMogul::Object
       readonly_attr :date, type: :date
       readonly_attr :mrr_churn_rate
+      readonly_attr :percentage_change
     end
 
     class MRRChurnRates < APIResource

data/lib/chartmogul/subscription_event.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module ChartMogul
+  class SubscriptionEvent < APIResource
+    set_resource_name 'SubscriptionEvent'
+    set_resource_path '/v1/subscription_events'
+
+    readonly_attr :id
+    writeable_attr :data_source_uuid
+    writeable_attr :customer_external_id
+    writeable_attr :subscription_set_external_id
+    writeable_attr :subscription_external_id
+    writeable_attr :plan_external_id
+    writeable_attr :event_date
+    writeable_attr :effective_date
+    writeable_attr :event_type
+    writeable_attr :external_id
+    readonly_attr :errors
+    readonly_attr :created_at
+    readonly_attr :updated_at
+    writeable_attr :quantity
+    writeable_attr :currency
+    writeable_attr :amount_in_cents
+    writeable_attr :tax_amount_in_cents
+    writeable_attr :retracted_event_id
+
+    include API::Actions::Custom
+    include API::Actions::DestroyWithParams
+
+    def self.all(options = {})
+      SubscriptionEvents.all(options)
+    end
+
+    def create!
+      custom!(:post, resource_path.path, subscription_event: instance_attributes)
+    end
+
+    def update!(attrs)
+      custom!(:patch, resource_path.path, subscription_event: attrs.merge(id: instance_attributes[:id]))
+    end
+
+    def destroy!
+      handling_errors do
+        connection.delete(resource_path.path, subscription_event: { id: instance_attributes[:id] })
+      end
+    end
+  end
+
+  class SubscriptionEvents < APIResource
+    set_resource_name 'SubscriptionEvents'
+    set_resource_path '/v1/subscription_events'
+
+    set_resource_root_key :subscription_events
+
+    writeable_attr :meta
+
+    include API::Actions::All
+    include Concerns::Entries
+
+    set_entry_class SubscriptionEvent
+  end
+end

data/lib/chartmogul/summary_all.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ChartMogul
+  class SummaryAll < ChartMogul::Object
+    readonly_attr :current_arpa
+    readonly_attr :current_arr
+    readonly_attr :current_asp
+    readonly_attr :current_customer_churn_rate
+    readonly_attr :current_customers
+    readonly_attr :current_ltv
+    readonly_attr :current_mrr
+    readonly_attr :current_mrr_churn_rate
+    readonly_attr :previous_arpa
+    readonly_attr :previous_arr
+    readonly_attr :previous_asp
+    readonly_attr :previous_customer_churn_rate
+    readonly_attr :previous_customers
+    readonly_attr :previous_ltv
+    readonly_attr :previous_mrr
+    readonly_attr :previous_mrr_churn_rate
+    readonly_attr :arpa_percentage_change
+    readonly_attr :arr_percentage_change
+    readonly_attr :asp_percentage_change
+    readonly_attr :customer_churn_rate_percentage_change
+    readonly_attr :customers_percentage_change
+    readonly_attr :ltv_percentage_change
+    readonly_attr :mrr_percentage_change
+    readonly_attr :mrr_churn_rate_percentage_change
+  end
+end

data/lib/chartmogul/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ChartMogul
-  VERSION = '3.0.0'
+  VERSION = '3.0.2'
 end

data/lib/chartmogul.rb

@@ -25,11 +25,13 @@ require 'chartmogul/object'
 require 'chartmogul/resource_path'
 require 'chartmogul/api_resource'
 require 'chartmogul/summary'
+require 'chartmogul/summary_all'
 
 require 'chartmogul/api/actions/all'
 require 'chartmogul/api/actions/create'
 require 'chartmogul/api/actions/custom'
 require 'chartmogul/api/actions/destroy'
+require 'chartmogul/api/actions/destroy_with_params'
 require 'chartmogul/api/actions/retrieve'
 require 'chartmogul/api/actions/update'
 
@@ -41,6 +43,7 @@ require 'chartmogul/transactions/refund'
 
 require 'chartmogul/concerns/entries'
 require 'chartmogul/concerns/summary'
+require 'chartmogul/concerns/summary_all'
 require 'chartmogul/concerns/pageable'
 require 'chartmogul/concerns/pageable2'
 require 'chartmogul/concerns/pageable_with_anchor'
@@ -55,6 +58,7 @@ require 'chartmogul/plan'
 require 'chartmogul/plan_group'
 require 'chartmogul/plan_groups/plans'
 require 'chartmogul/account'
+require 'chartmogul/subscription_event'
 
 require 'chartmogul/metrics/arpa'
 require 'chartmogul/metrics/arr'