chartmogul-ruby 3.3.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21d9a4cf92007310afc20b247902c00c7f8b9ff72af318b68f2ead99d684e883
-  data.tar.gz: 21839b81aa52218acbc90283dd41da929bf5e3962c3beb14fc3002a8b7b80ed2
+  metadata.gz: 66ebd465c81aa14f0e68e406fd7a4b29137d3d019d6ceb4e1da1aaf1d40b0ef4
+  data.tar.gz: 7380c7be4a87d8d8822702eeed51d50dbf36fabbb727d4469239d023282c14eb
 SHA512:
-  metadata.gz: 936baf5615aca48e08be7dca9d6cee0af52742ee4514d8a17300891cd192f857c99be4e12809932b808e2e2c2c7ed1116b577f6d5968a94e1ce1782555e42465
-  data.tar.gz: f27864dd15a8ab31d0faa8ccf9dd66b04a45da59d703b523437b84b632677b7396f6d23b1266629754452df12116c761e95139df3c33e2df68d005a06c136a01
+  metadata.gz: 20c35e5c04d023dce1487916c10a543afe6773c2781ffe10b324045e9c6cad1c7e9b7521d16007fae4ce7345c1f34d06dfd40ed98dd8941ead4f435728ffda06
+  data.tar.gz: fd0be8d9cee2c624e945f33f55effcea1825d7f72913f0d765b97e70084a1ba3fc0561ad0b922f4691e3b2daa3a70a82b87b8d7b44ec72bb69a107e528bfb332

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/README.md

@@ -47,7 +47,7 @@ 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
 

data/changelog.md

@@ -1,5 +1,9 @@
 # chartmogul-ruby Change Log
 
+## 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/errors/deprecated_parameter_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ChartMogul
+  class DeprecatedParameterError < ChartMogulError
+  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.0.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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chartmogul-ruby
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Petr Kopac
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-30 00:00:00.000000000 Z
+date: 2023-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -223,6 +223,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
@@ -279,7 +280,7 @@ 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:
   - - ">="