chartmogul-ruby 3.3.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21d9a4cf92007310afc20b247902c00c7f8b9ff72af318b68f2ead99d684e883
-  data.tar.gz: 21839b81aa52218acbc90283dd41da929bf5e3962c3beb14fc3002a8b7b80ed2
+  metadata.gz: 8f528ebe8e70838100b70e1b0b303f7032bb406cb982840de597fcef929e5f1f
+  data.tar.gz: 21150268340facfa3466b2a31d3d0eac3c1aed868608f0de265b2a6d619cb000
 SHA512:
-  metadata.gz: 936baf5615aca48e08be7dca9d6cee0af52742ee4514d8a17300891cd192f857c99be4e12809932b808e2e2c2c7ed1116b577f6d5968a94e1ce1782555e42465
-  data.tar.gz: f27864dd15a8ab31d0faa8ccf9dd66b04a45da59d703b523437b84b632677b7396f6d23b1266629754452df12116c761e95139df3c33e2df68d005a06c136a01
+  metadata.gz: c822a95c9fa65a4c13ad4d0bc35c370714fdfac2dd375bbca1b494ce19d2e8e6482639136a67d43278d25ae53c0e53694e02e08e7fd89b5a8c1faf077c4d559e
+  data.tar.gz: 2313f6a228d0d0cbfd17550a41ae7fbe31be01187779217bff7a7ece3505df310bdef483eb308c784cb8dd238184955f383a0236bcb6c2b0df42e2253d14c496

data/.github/workflows/test.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: [2.6, 2.7, 3.0, 3.1, 3.2]
+        ruby-version: [2.7, 3.0, 3.1, 3.2]
     steps:
       - uses: actions/checkout@v2
       - name: Set up Ruby ${{ matrix.ruby-version }}

data/4.0-Upgrade.md

@@ -0,0 +1,43 @@
+# Upgrading to chartmogul-ruby 4.0.0
+
+This new version replaces the existing pagination for the `.all()` endpoints that used a combination
+of `page` and `per_page` parameters, and instead uses a `cursor` based pagination. So to list
+(as an example) Plans you now can:
+
+```ruby
+ChartMogul.api_key = '<API key goes here>'
+
+# Getting the first page
+plans = ChartMogul::Plan.all(per_page: 12)
+```
+
+This will return an array of plans (if available), and a cursor + has_more fields:
+
+```json
+{
+    "plans": [
+        {
+            "uuid": "some_uuid",
+            "data_source_uuid": "some_uuid",
+            "name": "Master Plan"
+        }
+    ],
+    "has_more": true,
+    "cursor": "MjAyMy0wNy0yOFQwODowOToyMi4xNTQyMDMwMDBaJjk0NDQ0Mg=="
+}
+```
+
+```ruby
+# You can get the following pages by passing a cursor to .all
+if plans.has_more
+  more_plans = ChartMogul::Plan.all(per_page: 12, cursor: plans.cursor)
+end
+
+# Or by calling .next on the result
+if plans.has_more
+  more_plans = plans.next(per_page: 3)
+end
+```
+
+If you have existing code that relies on the `page` parameter, those requests will now throw an error
+alerting you of their deprecation.

data/README.md

@@ -47,7 +47,8 @@ Or install it yourself as:
     $ gem install chartmogul-ruby
 
 ### Supported Ruby Versions
-This gem supports Ruby 2.3 and above.
+
+This gem supports Ruby 2.7 and above.
 
 ## Configuration
 
@@ -66,6 +67,7 @@ ChartMogul.api_key = '<API key goes here>'
 Thread-safe configuration is used if available, otherwise global is used.
 
 Test your authentication:
+
 ```ruby
 ChartMogul::Ping.ping
 ```
@@ -100,9 +102,11 @@ You can find examples for each endpoint in the ChartMogul [API documentation](ht
 The library will keep retrying if the request exceeds the rate limit or if there's any network related error. By default, the request will be retried for 20 times (approximated 15 minutes) before finally giving up.
 
 You can change the retry count with:
+
 ```ruby
 ChartMogul.max_retries = 15
 ```
+
 Set it to 0 to disable it.
 
 ## Development

data/changelog.md

@@ -1,5 +1,15 @@
 # chartmogul-ruby Change Log
 
+## Version 4.1.0 - December 20, 2023
+- Adds support for Customer Notes
+
+## Version 4.0.1 - November 7 2023
+- Add upgrade guide from v3.x to v4.x
+
+## Version 4.0.0 - November 1 2023
+- Remove support for old pagination using `page` parameter.
+- Drop support for Ruby versions below 2.7.
+
 ## Version 3.3.1 - October 27 2023
 - Add support for cursor based pagination to `.all` endpoints.
 - Add `.next` pagination method for all supported cursor based endpoints.

data/chartmogul-ruby.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.description           = 'Official Ruby client for ChartMogul\'s API'
   spec.homepage              = 'https://github.com/chartmogul/chartmogul-ruby'
   spec.license               = 'MIT'
-  spec.required_ruby_version = '>= 2.3'
+  spec.required_ruby_version = '>= 2.7'
 
   spec.post_install_message  = %q{
   Starting October 29 2021, we are updating our developer libraries to support the enhanced API Access Management. Please use the same API Key for both API Token and Secret Key.

data/lib/chartmogul/customer.rb

@@ -84,6 +84,14 @@ module ChartMogul
       Contact.create!(options.merge(customer_uuid: uuid))
     end
 
+    def notes(options = {})
+      Notes.all(options.merge(customer_uuid: uuid))
+    end
+
+    def create_note(options = {})
+      Note.create!(options.merge(customer_uuid: uuid))
+    end
+
     # Enrichment
     def tags
       @attributes[:tags]

data/lib/chartmogul/errors/deprecated_parameter_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ChartMogul
+  class DeprecatedParameterError < ChartMogulError
+  end
+end

data/lib/chartmogul/note.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module ChartMogul
+  class Note < APIResource
+    set_resource_name 'CustomerNote'
+    set_resource_path '/v1/customer_notes'
+
+    readonly_attr :uuid
+
+    writeable_attr :customer_uuid
+    writeable_attr :type
+    writeable_attr :text
+    writeable_attr :author
+    writeable_attr :text
+    writeable_attr :call_duration
+    writeable_attr :created_at
+    writeable_attr :updated_at
+
+    include API::Actions::Create
+    include API::Actions::Destroy
+    include API::Actions::Retrieve
+    include API::Actions::Update
+
+    def self.all(options = {})
+      Notes.all(options)
+    end
+  end
+
+  class Notes < APIResource
+    set_resource_name 'CustomerNotes'
+    set_resource_path '/v1/customer_notes'
+
+    include Concerns::Entries
+    include Concerns::PageableWithCursor
+
+    set_entry_class Note
+  end
+end

data/lib/chartmogul/resource_path.rb

@@ -9,6 +9,8 @@ module ChartMogul
 
     class RequiredParameterMissing < StandardError; end
 
+    DEPRECATED_PARAMETER = 'page'
+
     def initialize(path)
       @path = path
       @named_params = path.scan(/:\w+/).each_with_object({}) do |named_param, hash|
@@ -22,7 +24,6 @@ module ChartMogul
 
     # For path = '/hello/:hello_id/say' & params = { hello_id: 1, search: 'cat' }
     # it will return '/hello/1/say?search=cat'
-
     def apply_with_get_params(params = {})
       base_path = apply_named_params(params)
       get_params = params.reject { |param_name| named_params.values.include?(param_name) }
@@ -33,6 +34,10 @@ module ChartMogul
     private
 
     def apply_named_params(params)
+      if params.keys.map(&:to_s).include?(DEPRECATED_PARAMETER)
+        raise(ChartMogul::DeprecatedParameterError, "#{DEPRECATED_PARAMETER} is deprecated.")
+      end
+
       path.dup.tap do |path|
         named_params.each do |named_param, param_key|
           unless params.key?(param_key)

data/lib/chartmogul/version.rb

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

data/lib/chartmogul.rb

@@ -18,6 +18,7 @@ require 'chartmogul/errors/resource_invalid_error'
 require 'chartmogul/errors/schema_invalid_error'
 require 'chartmogul/errors/server_error'
 require 'chartmogul/errors/unauthorized_error'
+require 'chartmogul/errors/deprecated_parameter_error'
 
 require 'chartmogul/config_attributes'
 require 'chartmogul/configuration'
@@ -54,6 +55,7 @@ require 'chartmogul/subscription'
 require 'chartmogul/invoice'
 require 'chartmogul/customer_invoices'
 require 'chartmogul/customer'
+require 'chartmogul/note'
 require 'chartmogul/contact'
 require 'chartmogul/data_source'
 require 'chartmogul/ping'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chartmogul-ruby
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Petr Kopac
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-30 00:00:00.000000000 Z
+date: 2023-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -189,6 +189,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - 2.0-Upgrade.md
+- 4.0-Upgrade.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -223,6 +224,7 @@ files:
 - lib/chartmogul/enrichment/customer.rb
 - lib/chartmogul/errors/chartmogul_error.rb
 - lib/chartmogul/errors/configuration_error.rb
+- lib/chartmogul/errors/deprecated_parameter_error.rb
 - lib/chartmogul/errors/forbidden_error.rb
 - lib/chartmogul/errors/not_found_error.rb
 - lib/chartmogul/errors/resource_invalid_error.rb
@@ -246,6 +248,7 @@ files:
 - lib/chartmogul/metrics/ltv.rb
 - lib/chartmogul/metrics/mrr.rb
 - lib/chartmogul/metrics/mrr_churn_rate.rb
+- lib/chartmogul/note.rb
 - lib/chartmogul/object.rb
 - lib/chartmogul/ping.rb
 - lib/chartmogul/plan.rb
@@ -279,14 +282,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: Chartmogul API Ruby Client