chartmogul-ruby 1.7.1 → 2.1.0

data/lib/chartmogul/customer.rb

@@ -4,7 +4,7 @@ module ChartMogul
   class Customer < APIResource
     set_resource_name 'Customer'
     set_resource_path '/v1/customers'
-    set_skip_case_conversion true
+    set_immutable_keys([:attributes, :custom])
 
     readonly_attr :uuid
     readonly_attr :id
@@ -132,7 +132,7 @@ module ChartMogul
   class Customers < APIResource
     set_resource_name 'Customers'
     set_resource_path '/v1/customers'
-    set_skip_case_conversion true
+    set_immutable_keys([:attributes, :custom])
 
     include Concerns::Entries
     include API::Actions::Custom

data/lib/chartmogul/metrics/activities_export.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ChartMogul
+  module Metrics
+    class ActivitiesExport < APIResource
+      set_resource_name 'ActivitiesExport'
+      set_resource_path '/v1/activities_export'
+
+      readonly_attr :id
+      readonly_attr :status
+      readonly_attr :file_url
+      readonly_attr :params
+      readonly_attr :expires_at
+      readonly_attr :created_at
+
+      writeable_attr :start_date
+      writeable_attr :end_date
+      writeable_attr :type
+
+      include API::Actions::Retrieve
+      include API::Actions::Create
+
+      def serialize_for_write
+        super.tap do |attributes|
+          attributes.clone.each do |k, v|
+            attributes[preprocess_attributes(k)] = attributes.delete(k)
+          end
+        end
+      end
+
+      def preprocess_attributes(attribute)
+        return attribute unless %i[start_date end_date].include?(attribute)
+
+        attribute.to_s.tr('_', '-')
+      end
+    end
+  end
+end

data/lib/chartmogul/metrics/activity.rb

@@ -3,7 +3,6 @@
 module ChartMogul
   module Metrics
     class Activity < ChartMogul::Object
-      readonly_attr :id
       readonly_attr :description
       readonly_attr :type
       readonly_attr :date, type: :time
@@ -11,25 +10,30 @@ module ChartMogul
       readonly_attr :activity_mrr
       readonly_attr :activity_mrr_movement
       readonly_attr :currency
-      readonly_attr :currency_sign
       readonly_attr :subscription_external_id
+      readonly_attr :plan_external_id
+      readonly_attr :customer_name
+      readonly_attr :customer_uuid
+      readonly_attr :customer_external_id
+      readonly_attr :billing_connector_uuid
+      readonly_attr :uuid
 
-      def self.all(customer_uuid, options = {})
-        ChartMogul::Metrics::Activities.all(customer_uuid, options)
+      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'
+      set_resource_path '/v1/activities'
 
       include Concerns::Entries
-      include Concerns::Pageable
+      include Concerns::PageableWithAnchor
 
       set_entry_class Activity
 
-      def self.all(customer_uuid, options = {})
-        super(options.merge(customer_uuid: customer_uuid))
+      def self.all(options = {})
+        super(options)
       end
     end
   end

data/lib/chartmogul/metrics/customers/activity.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ChartMogul
+  module Metrics
+    module Customers
+      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
+        readonly_attr :subscription_external_id
+
+        def self.all(customer_uuid, options = {})
+          ChartMogul::Metrics::Customers::Activities.all(customer_uuid, options)
+        end
+      end
+
+      class Activities < APIResource
+        set_resource_name 'Activities'
+        set_resource_path '/v1/customers/:customer_uuid/activities'
+
+        include Concerns::Entries
+        include Concerns::Pageable
+
+        set_entry_class Activity
+
+        def self.all(customer_uuid, options = {})
+          super(options.merge(customer_uuid: customer_uuid))
+        end
+      end
+    end
+  end
+end

data/lib/chartmogul/metrics/customers/subscription.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ChartMogul
+  module Metrics
+    module Customers
+      class Subscription < ChartMogul::Object
+        readonly_attr :id
+        readonly_attr :external_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(customer_uuid, options = {})
+          ChartMogul::Metrics::Customers::Subscriptions.all(customer_uuid, options)
+        end
+      end
+
+      class Subscriptions < APIResource
+        set_resource_name 'Subscriptions'
+        set_resource_path '/v1/customers/:customer_uuid/subscriptions'
+
+        include Concerns::Entries
+        include Concerns::Pageable
+
+        set_entry_class Subscription
+
+        def self.all(customer_uuid, options = {})
+          super(options.merge(customer_uuid: customer_uuid))
+        end
+      end
+    end
+  end
+end

data/lib/chartmogul/utils/hash_snake_caser.rb

@@ -8,8 +8,9 @@ module ChartMogul
       # Rubyish snake_case, suitable for use during instantiation of Ruby
       # model attributes.
       #
-      def initialize(hash)
+      def initialize(hash, immutable_keys: [])
         @hash = hash
+        @immutable_keys = immutable_keys
       end
 
       def to_snake_keys(value = @hash)
@@ -26,7 +27,13 @@ module ChartMogul
       private
 
       def snake_hash(value)
-        Hash[value.map { |k, v| [underscore_key(k), to_snake_keys(v)] }]
+        Hash[value.map { |k, v| [underscore_key(k), immutable_check(k, v)] }]
+      end
+
+      def immutable_check(k,v)
+        return v if @immutable_keys.include?(k)
+
+        to_snake_keys(v)
       end
 
       def underscore_key(k)

data/lib/chartmogul/utils/json_parser.rb

@@ -4,11 +4,9 @@ module ChartMogul
   module Utils
     class JSONParser
       class << self
-        def parse(json_string, skip_case_conversion: false)
+        def parse(json_string, immutable_keys: [])
           hash = JSON.parse(json_string, symbolize_names: true)
-          return hash if skip_case_conversion
-
-          HashSnakeCaser.new(hash).to_snake_keys
+          HashSnakeCaser.new(hash, immutable_keys: immutable_keys).to_snake_keys
         end
 
         def typecast_custom_attributes(custom_attributes)

data/lib/chartmogul/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chartmogul-ruby
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Petr Kopac
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-12 00:00:00.000000000 Z
+date: 2021-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -171,9 +171,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- 2.0-Upgrade.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -221,21 +222,26 @@ files:
 - fixtures/vcr_cassettes/ChartMogul_Metrics_ARR/behaves_like_Metrics_API_resource/should_have_entries.yml
 - fixtures/vcr_cassettes/ChartMogul_Metrics_ASP/behaves_like_Metrics_API_resource/behaves_like_Summary/should_have_summary.yml
 - fixtures/vcr_cassettes/ChartMogul_Metrics_ASP/behaves_like_Metrics_API_resource/should_have_entries.yml
-- fixtures/vcr_cassettes/ChartMogul_Metrics_Activity/behaves_like_Pageable/should_be_pageable.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_ActivitiesExport/get_activities_export.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_ActivitiesExport/post_activities_export.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_Activity.yml
+- 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_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
 - fixtures/vcr_cassettes/ChartMogul_Metrics_CustomerCount/behaves_like_Metrics_API_resource/should_have_entries.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_Customers_Activity/behaves_like_Pageable/should_be_pageable.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_Customers_Activity/should_have_Activity_entries.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_Customers_Subscription/behaves_like_Pageable/should_be_pageable.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_Customers_Subscription/should_have_Subscription_entries.yml
 - fixtures/vcr_cassettes/ChartMogul_Metrics_LTV/behaves_like_Metrics_API_resource/behaves_like_Summary/should_have_summary.yml
 - fixtures/vcr_cassettes/ChartMogul_Metrics_LTV/behaves_like_Metrics_API_resource/should_have_entries.yml
 - fixtures/vcr_cassettes/ChartMogul_Metrics_MRR/behaves_like_Summary/should_have_summary.yml
 - fixtures/vcr_cassettes/ChartMogul_Metrics_MRR/should_have_entries.yml
 - fixtures/vcr_cassettes/ChartMogul_Metrics_MRRChurnRate/behaves_like_Metrics_API_resource/behaves_like_Summary/should_have_summary.yml
 - fixtures/vcr_cassettes/ChartMogul_Metrics_MRRChurnRate/behaves_like_Metrics_API_resource/should_have_entries.yml
-- fixtures/vcr_cassettes/ChartMogul_Metrics_Subscription/behaves_like_Pageable/should_be_pageable.yml
-- fixtures/vcr_cassettes/ChartMogul_Metrics_Subscription/should_have_Subscription_entries.yml
 - fixtures/vcr_cassettes/ChartMogul_Ping/pings/and_fails_on_incorrect_credentials.yml
 - fixtures/vcr_cassettes/ChartMogul_Ping/pings/and_fails_with_500_internal_server_error.yml
 - fixtures/vcr_cassettes/ChartMogul_Ping/pings/and_fails_with_504_gateway_timeout_error.yml
@@ -274,6 +280,7 @@ files:
 - lib/chartmogul/concerns/entries.rb
 - lib/chartmogul/concerns/pageable.rb
 - lib/chartmogul/concerns/pageable2.rb
+- lib/chartmogul/concerns/pageable_with_anchor.rb
 - lib/chartmogul/concerns/summary.rb
 - lib/chartmogul/config_attributes.rb
 - lib/chartmogul/configuration.rb
@@ -292,6 +299,7 @@ files:
 - lib/chartmogul/invoice.rb
 - lib/chartmogul/line_items/one_time.rb
 - lib/chartmogul/line_items/subscription.rb
+- lib/chartmogul/metrics/activities_export.rb
 - lib/chartmogul/metrics/activity.rb
 - lib/chartmogul/metrics/all_key_metrics.rb
 - lib/chartmogul/metrics/arpa.rb
@@ -300,10 +308,11 @@ files:
 - lib/chartmogul/metrics/base.rb
 - lib/chartmogul/metrics/customer_churn_rate.rb
 - lib/chartmogul/metrics/customer_count.rb
+- lib/chartmogul/metrics/customers/activity.rb
+- lib/chartmogul/metrics/customers/subscription.rb
 - lib/chartmogul/metrics/ltv.rb
 - lib/chartmogul/metrics/mrr.rb
 - lib/chartmogul/metrics/mrr_churn_rate.rb
-- lib/chartmogul/metrics/subscription.rb
 - lib/chartmogul/object.rb
 - lib/chartmogul/ping.rb
 - lib/chartmogul/plan.rb

data/.travis.yml

@@ -1,25 +0,0 @@
-os: linux
-dist: bionic
-
-language: ruby
-
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-
-before_install: gem install bundler
-
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-
-branches:
-  only:
-    - main
-
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/lib/chartmogul/metrics/subscription.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module ChartMogul
-  module Metrics
-    class Subscription < ChartMogul::Object
-      readonly_attr :id
-      readonly_attr :external_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(customer_uuid, options = {})
-        ChartMogul::Metrics::Subscriptions.all(customer_uuid, options)
-      end
-    end
-
-    class Subscriptions < APIResource
-      set_resource_name 'Subscriptions'
-      set_resource_path '/v1/customers/:customer_uuid/subscriptions'
-
-      include Concerns::Entries
-      include Concerns::Pageable
-
-      set_entry_class Subscription
-
-      def self.all(customer_uuid, options = {})
-        super(options.merge(customer_uuid: customer_uuid))
-      end
-    end
-  end
-end