chartmogul-ruby 3.0.0 → 3.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/pageable_with_cursor.rb

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

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/contact.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module ChartMogul
+  class Contact < APIResource
+    set_resource_name 'Contact'
+    set_resource_path '/v1/contacts'
+    set_immutable_keys([:custom])
+
+    readonly_attr :uuid
+
+    writeable_attr :customer_uuid
+    writeable_attr :data_source_uuid
+    writeable_attr :customer_external_id
+    writeable_attr :position
+    writeable_attr :first_name
+    writeable_attr :last_name
+    writeable_attr :title
+    writeable_attr :email
+    writeable_attr :phone
+    writeable_attr :linked_in
+    writeable_attr :twitter
+    writeable_attr :notes
+    writeable_attr :custom
+
+    include API::Actions::Create
+    include API::Actions::Custom
+    include API::Actions::Destroy
+    include API::Actions::Retrieve
+    include API::Actions::Update
+
+    def self.all(options = {})
+      Contacts.all(options)
+    end
+
+    def self.merge!(into_uuid:, from_uuid:)
+      custom!(:post, "/v1/contacts/#{into_uuid}/merge/#{from_uuid}")
+    end
+
+    def serialize_for_write
+      super.tap do |attributes|
+        attributes.clone.each do |attribute_name, attribute_value|
+          if attribute_name == :custom && attribute_value.is_a?(Hash)
+            payload = attribute_value.each_with_object([]) do |custom_value, arr|
+              key, value = custom_value
+              arr << { key: key, value: value }
+            end
+            attributes[:custom] = payload
+          else
+            attributes[attribute_name] = attribute_value
+          end
+        end
+      end
+    end
+  end
+
+  class Contacts < APIResource
+    set_resource_name 'Contacts'
+    set_resource_path '/v1/contacts'
+
+    include Concerns::Entries
+    include Concerns::PageableWithCursor
+
+    set_entry_class Contact
+
+    def next(options = {})
+      Contacts.all(options.merge(cursor: cursor))
+    end
+  end
+end

data/lib/chartmogul/customer.rb

@@ -65,6 +65,14 @@ module ChartMogul
       @invoices = ChartMogul::CustomerInvoices.new(customer_uuid: uuid, invoices: invoices_array)
     end
 
+    def contacts(options = {})
+      Contacts.all(options.merge(customer_uuid: uuid))
+    end
+
+    def create_contact(options = {})
+      Contact.create!(options.merge(customer_uuid: uuid))
+    end
+
     # Enrichment
     def tags
       @attributes[:tags]

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.1.0'
 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,20 +43,24 @@ 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'
+require 'chartmogul/concerns/pageable_with_cursor'
 
 require 'chartmogul/subscription'
 require 'chartmogul/invoice'
 require 'chartmogul/customer_invoices'
 require 'chartmogul/customer'
+require 'chartmogul/contact'
 require 'chartmogul/data_source'
 require 'chartmogul/ping'
 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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chartmogul-ruby
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Petr Kopac
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 2023-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -186,11 +186,18 @@ files:
 - fixtures/vcr_cassettes/ChartMogul_APIResource/connection/works_in_a_threaded_environment.yml
 - fixtures/vcr_cassettes/ChartMogul_APIResource/connection/works_when_credentials_are_updated.yml
 - fixtures/vcr_cassettes/ChartMogul_Account/returns_details_of_current_account.yml
+- fixtures/vcr_cassettes/ChartMogul_Contact/API_Interactions/creates_contact_correctly.yml
+- fixtures/vcr_cassettes/ChartMogul_Contact/API_Interactions/destroys_contact_correctly.yml
+- fixtures/vcr_cassettes/ChartMogul_Contact/API_Interactions/merges_contact_correctly.yml
+- fixtures/vcr_cassettes/ChartMogul_Contact/API_Interactions/paginates_correctly.yml
+- fixtures/vcr_cassettes/ChartMogul_Contact/API_Interactions/updates_contact_correctly.yml
 - fixtures/vcr_cassettes/ChartMogul_Customer/API_Interactions/adds_custom_attributes.yml
 - fixtures/vcr_cassettes/ChartMogul_Customer/API_Interactions/adds_required_tags.yml
 - fixtures/vcr_cassettes/ChartMogul_Customer/API_Interactions/can_page_through_search_endpoint.yml
 - fixtures/vcr_cassettes/ChartMogul_Customer/API_Interactions/correctly_handles_a_422_response.yml
 - fixtures/vcr_cassettes/ChartMogul_Customer/API_Interactions/correctly_interracts_with_the_API.yml
+- fixtures/vcr_cassettes/ChartMogul_Customer/API_Interactions/creates_a_contact_belonging_to_the_customer_correctly.yml
+- fixtures/vcr_cassettes/ChartMogul_Customer/API_Interactions/lists_the_contacts_belonging_to_the_customer_correctly.yml
 - fixtures/vcr_cassettes/ChartMogul_Customer/API_Interactions/merges_customers.yml
 - fixtures/vcr_cassettes/ChartMogul_Customer/API_Interactions/raises_401_if_invalid_credentials.yml
 - fixtures/vcr_cassettes/ChartMogul_Customer/API_Interactions/raises_404_if_no_customers_found.yml
@@ -228,6 +235,7 @@ files:
 - fixtures/vcr_cassettes/ChartMogul_Metrics_Activity/behaves_like_PageableWithAnchor/should_be_pageable.yml
 - fixtures/vcr_cassettes/ChartMogul_Metrics_Activity/should_have_Activity_entries.yml
 - fixtures/vcr_cassettes/ChartMogul_Metrics_AllKeyMetric/should_have_entries.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_AllKeyMetric/should_have_summary.yml
 - fixtures/vcr_cassettes/ChartMogul_Metrics_CustomerChurnRate/behaves_like_Metrics_API_resource/behaves_like_Summary/should_have_summary.yml
 - fixtures/vcr_cassettes/ChartMogul_Metrics_CustomerChurnRate/behaves_like_Metrics_API_resource/should_have_entries.yml
 - fixtures/vcr_cassettes/ChartMogul_Metrics_CustomerCount/behaves_like_Metrics_API_resource/behaves_like_Summary/should_have_summary.yml
@@ -267,6 +275,10 @@ files:
 - fixtures/vcr_cassettes/ChartMogul_Subscription/_update_cancellation_dates/when_array_includes_invalid_entries/raises_an_exception.yml
 - fixtures/vcr_cassettes/ChartMogul_Subscription/_update_cancellation_dates/when_array_includes_valid_entries/is_setting_the_cancellation_dates_of_the_subscription.yml
 - fixtures/vcr_cassettes/ChartMogul_Subscription/_update_cancellation_dates/when_array_is_empty/makes_an_API_call_and_removes_the_cancellation_dates.yml
+- fixtures/vcr_cassettes/ChartMogul_SubscriptionEvent/API_interactions/creates_a_new_subscription_event.yml
+- fixtures/vcr_cassettes/ChartMogul_SubscriptionEvent/API_interactions/deletes_the_subscription_event.yml
+- fixtures/vcr_cassettes/ChartMogul_SubscriptionEvent/API_interactions/lists_all_subscription_events.yml
+- fixtures/vcr_cassettes/ChartMogul_SubscriptionEvent/API_interactions/updates_the_subscription_event.yml
 - fixtures/vcr_cassettes/ChartMogul_Transactions_Payment/API_Interactions/correctly_interracts_with_the_API.yml
 - lib/chartmogul.rb
 - lib/chartmogul/account.rb
@@ -274,6 +286,7 @@ files:
 - lib/chartmogul/api/actions/create.rb
 - lib/chartmogul/api/actions/custom.rb
 - lib/chartmogul/api/actions/destroy.rb
+- lib/chartmogul/api/actions/destroy_with_params.rb
 - lib/chartmogul/api/actions/retrieve.rb
 - lib/chartmogul/api/actions/update.rb
 - lib/chartmogul/api_resource.rb
@@ -281,9 +294,12 @@ files:
 - lib/chartmogul/concerns/pageable.rb
 - lib/chartmogul/concerns/pageable2.rb
 - lib/chartmogul/concerns/pageable_with_anchor.rb
+- lib/chartmogul/concerns/pageable_with_cursor.rb
 - lib/chartmogul/concerns/summary.rb
+- lib/chartmogul/concerns/summary_all.rb
 - lib/chartmogul/config_attributes.rb
 - lib/chartmogul/configuration.rb
+- lib/chartmogul/contact.rb
 - lib/chartmogul/customer.rb
 - lib/chartmogul/customer_invoices.rb
 - lib/chartmogul/data_source.rb
@@ -320,7 +336,9 @@ files:
 - lib/chartmogul/plan_groups/plans.rb
 - lib/chartmogul/resource_path.rb
 - lib/chartmogul/subscription.rb
+- lib/chartmogul/subscription_event.rb
 - lib/chartmogul/summary.rb
+- lib/chartmogul/summary_all.rb
 - lib/chartmogul/transactions/payment.rb
 - lib/chartmogul/transactions/refund.rb
 - lib/chartmogul/utils/hash_snake_caser.rb
@@ -351,7 +369,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Chartmogul API Ruby Client