pisoni 1.29.1 → 1.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bc480ca255fad3679c652ee5913824d543c7f4e5d51b0866f3919d4d1a496c3
-  data.tar.gz: d5b36dd8d28242573d3e476ae4420c93dfd30275848ea16c4526ad61db1a386e
+  metadata.gz: bc7b659e66478ddb954b8144e47cd83cbf80acd54e16f7f051c82f07f47c221f
+  data.tar.gz: fb1ab6344af206a17085bf42134622fef72e57093bad247ce8efaa2b823b8ff6
 SHA512:
-  metadata.gz: ffb11b5ae16138162d9fbb2c5b0784618b94d478cbbfd6e8edc377ae05b3554471ffd360db902ba5e569b0c90b96ceca3005860d53f57cfdab744cb48f019716
-  data.tar.gz: 5ff19f326743a8e56b8cb2df1ab37bbef54bafbd075a4e8d6a90ee729b51e8950e7248d331724982fbf7f42c5e6ceb265f13767bd4c9b7d4c09633ab982b3eca
+  metadata.gz: 2b39b7a9ed13db3500fb782b1f1f5e75cc9d15261938f70e11788f84a96957a6f38ca3cc801bf84f7b5ee94cb4bac4a1bfed12ec9a4bc99fb5c01f73ed4ea860
+  data.tar.gz: 1de636e31c5d8c5897eda7282283a157553a032c81f26b58378c39a342021786285b851c59bd786dbbf3f5ea536ed3cd4f564c415240887af136e46e18345c2f

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 Notable changes to Pisoni will be tracked in this document.
 
+## 1.30.0 - 2024-02-29
+
+### Changed
+
+- Fixed the issue with fetching utilization and managing referrer filters for applications with special characters in the
+  application IDs by escaping them. [#33](https://github.com/3scale/pisoni/pull/33)
+- Upgrade dependencies, specifically `faraday` and `json`, making Ruby 2.6 the minimum supported version. [#34](https://github.com/3scale/pisoni/pull/34)
+
 ## 1.29.1 - 2023-11-30
 
 ### Changed

data/lib/3scale/core/api_client/operations.rb

@@ -106,7 +106,7 @@ module ThreeScale
             else
               Core.faraday.send method, uri, attributes.to_json
             end
-          rescue Faraday::Error::ClientError, SystemCallError => e
+          rescue Faraday::ClientError, SystemCallError => e
             raise ConnectionError, e
           end
           private :api_http

data/lib/3scale/core/api_client/support.rb

@@ -1,3 +1,5 @@
+require 'erb'
+
 module ThreeScale
   module Core
     module APIClient
@@ -38,6 +40,10 @@ module ThreeScale
             @default_prefix = prefix
           end
 
+          def url_encode(str)
+            ERB::Util.url_encode(str)
+          end
+
           private
 
           def internal_api_error(status)

data/lib/3scale/core/application.rb

@@ -1,5 +1,3 @@
-require 'cgi'
-
 module ThreeScale
   module Core
     class Application < APIClient::Resource
@@ -18,16 +16,12 @@ module ThreeScale
       private_class_method :base_uri
 
       def self.app_uri(service_id, id)
-        escaped_id = CGI::escape(id.to_s)
-
-        "#{base_uri(service_id)}#{escaped_id}"
+        "#{base_uri(service_id)}#{url_encode(id)}"
       end
       private_class_method :app_uri
 
       def self.key_uri(service_id, key)
-        escaped_key = CGI::escape(key.to_s)
-
-        "#{base_uri(service_id)}key/#{escaped_key}"
+        "#{base_uri(service_id)}key/#{url_encode(key)}"
       end
       private_class_method :key_uri
 
@@ -77,8 +71,7 @@ module ThreeScale
 
       def self.save_id_by_key(service_id, user_key, id)
         raise ApplicationHasInconsistentData.new(id, user_key) if (service_id.nil? || id.nil? || user_key.nil? || service_id=="" || id=="" || user_key=="")
-        escaped_key = CGI::escape(user_key)
-        ret = api_do_put({}, uri: "#{app_uri(service_id, id)}/key/#{escaped_key}")
+        ret = api_do_put({}, uri: "#{app_uri(service_id, id)}/key/#{url_encode(user_key)}")
         ret[:ok]
       end
 

data/lib/3scale/core/application_key.rb

@@ -1,5 +1,3 @@
-require 'cgi'
-
 module ThreeScale
   module Core
     class ApplicationKey < APIClient::Resource
@@ -23,12 +21,12 @@ module ThreeScale
       end
 
       def self.base_uri(service_id, application_id)
-        "#{default_uri}#{service_id}/applications/#{CGI::escape(application_id.to_s)}/keys/"
+        "#{default_uri}#{service_id}/applications/#{url_encode(application_id)}/keys/"
       end
       private_class_method :base_uri
 
       def self.application_key_uri(service_id, application_id, value = '')
-        "#{base_uri(service_id, application_id)}#{CGI::escape(value.to_s)}"
+        "#{base_uri(service_id, application_id)}#{url_encode(value)}"
       end
       private_class_method :application_key_uri
     end

data/lib/3scale/core/application_referrer_filter.rb

@@ -25,7 +25,7 @@ module ThreeScale
       end
 
       def self.base_uri(service_id, application_id)
-        "#{default_uri}#{service_id}/applications/#{application_id}/referrer_filters"
+        "#{default_uri}#{service_id}/applications/#{url_encode(application_id)}/referrer_filters"
       end
       private_class_method :base_uri
     end

data/lib/3scale/core/utilization.rb

@@ -6,7 +6,7 @@ module ThreeScale
       default_uri '/internal/services/'
 
       def self.utilization_uri(service_id, app_id)
-        "#{default_uri}#{service_id}/applications/#{app_id}/utilization/"
+        "#{default_uri}#{service_id}/applications/#{url_encode(app_id)}/utilization/"
       end
       private_class_method :utilization_uri
 

data/lib/3scale/core/version.rb

@@ -1,5 +1,5 @@
 module ThreeScale
   module Core
-    VERSION = '1.29.1'
+    VERSION = '1.30.0'
   end
 end

data/lib/3scale/core.rb

@@ -1,14 +1,7 @@
 require 'uri'
 require 'json'
 require 'faraday'
-require 'net/http/persistent'
-
-# Warn that Faraday < 0.13 and Net::HTTP::Persistent >= 3.0.0 don't mix well
-if Faraday::VERSION =~ /0\.([0-9]|1[012])\.\d+/ &&
-    Net::HTTP::Persistent::VERSION =~ /^[^012]\.\d+\.\d+/
-  warn 'The combination of faraday < 0.13 and net-http-persistent 3.0+ is ' \
-    'known to have issues. See https://github.com/lostisland/faraday/issues/617'
-end
+require 'faraday/net_http_persistent'
 
 require '3scale/core/version'
 require '3scale/core/logger'
@@ -56,7 +49,7 @@ module ThreeScale
         @password = uri.password
       end
 
-      @faraday.basic_auth(@username, @password) if @username || @password
+      @faraday.set_basic_auth(@username, @password) if @username || @password
       @faraday
     end
 

data/pisoni.gemspec

@@ -18,12 +18,13 @@ Gem::Specification.new do |s|
   s.description = 'Client for the Apisonator internal API for model data.'
   s.license     = 'Apache-2.0'
 
-  s.add_dependency 'faraday', '>= 0.9.1'
-  s.add_dependency 'json', '>= 1.8.1'
-  s.add_dependency 'injectedlogger', '>= 0.0.13'
-  s.add_dependency 'net-http-persistent'
+  # faraday v2.9.0 removes support for Ruby 2.7, see https://github.com/lostisland/faraday/releases/tag/v2.9.0
+  s.add_runtime_dependency 'faraday', '~> 2.0', '<= 2.9'
+  s.add_runtime_dependency 'json', '~> 2.7', '>= 2.7.1'
+  s.add_runtime_dependency 'injectedlogger', '0.0.13'
+  s.add_runtime_dependency 'faraday-net_http_persistent', '~> 2.1'
 
-  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rake', '~> 13.1'
 
   s.files         = `git ls-files`.split($/).reject do |f| [
                         %r{^\.[^\/]},
@@ -39,5 +40,5 @@ Gem::Specification.new do |s|
 
   s.rdoc_options = ["--charset=UTF-8"]
 
-  s.required_ruby_version = '>= 2.3.0'
+  s.required_ruby_version = '>= 2.6.0'
 end

data/spec/application_key_spec.rb

@@ -59,7 +59,7 @@ module ThreeScale
         end
 
         describe 'with a key that contains special chars (*, _, etc.)' do
-          let(:key) { '#$*' }
+          let(:key) { SPECIAL_CHARACTERS }
 
           before do
             ApplicationKey.delete(service_id, app_id, key)
@@ -74,8 +74,8 @@ module ThreeScale
         end
 
         describe 'with app ID that contains special characters ({, $, ? etc.)' do
-          let(:app_id) { 'abc{1}$3?' }
-          let(:key) { 'z#$*' }
+          let(:app_id) { SPECIAL_CHARACTERS }
+          let(:key) { SPECIAL_CHARACTERS }
 
           before do
             ApplicationKey.delete(service_id, app_id, key)
@@ -119,7 +119,7 @@ module ThreeScale
         end
 
         describe 'with a key that contains special chars (*, _, etc.)' do
-          let(:key_with_special_chars) { '#$*' }
+          let(:key_with_special_chars) { SPECIAL_CHARACTERS }
 
           before do
             ApplicationKey.save(service_id, app_id, key)

data/spec/application_referrer_filter_spec.rb

@@ -3,7 +3,7 @@ module ThreeScale
   module Core
     describe ApplicationReferrerFilter do
       let(:service_id) { 10 }
-      let(:app_id)     { 100 }
+      let(:app_id)     { SPECIAL_CHARACTERS }
       let(:filters) { %w(foo bar doopah) }
       let(:application) do
         { service_id: service_id,
@@ -24,6 +24,8 @@ module ThreeScale
       end
 
       describe '.load_all' do
+        subject { ApplicationReferrerFilter.load_all(service_id, app_id) }
+
         describe 'Getting all referrer filters' do
           let(:ref_filters)     { %w(foo bar) }
 
@@ -32,14 +34,13 @@ module ThreeScale
           end
 
           it 'returns a sorted list of filters' do
-            filters = ApplicationReferrerFilter.load_all(service_id, app_id)
-            filters.must_equal ref_filters.sort
+            subject.must_equal ref_filters.sort
           end
         end
 
         describe 'when there are no referrer filters' do
           it 'returns an empty list' do
-            ApplicationReferrerFilter.load_all(service_id, app_id).must_equal []
+            subject.must_equal []
           end
         end
       end

data/spec/application_spec.rb

@@ -47,7 +47,7 @@ module ThreeScale
 
         describe 'with an app ID that contains special characters' do
           let(:service_id) { 2001 }
-          let(:app_id) { '#$*' }
+          let(:app_id) { SPECIAL_CHARACTERS }
 
           before do
             Application.save service_id: service_id, id: app_id, state: 'suspended',
@@ -90,7 +90,7 @@ module ThreeScale
 
         describe 'with an app ID that contains special characters' do
           let(:service_id) { 2001 }
-          let(:app_id) { '#$*' }
+          let(:app_id) { SPECIAL_CHARACTERS }
 
           before do
             Application.save service_id: service_id, id: app_id, state: 'suspended',
@@ -157,7 +157,7 @@ module ThreeScale
 
         describe 'with an app ID that contains special characters' do
           let(:service_id) { 2001 }
-          let(:app_id) { '#$*' }
+          let(:app_id) { SPECIAL_CHARACTERS }
 
           before do
             Application.delete(service_id, app_id)
@@ -271,7 +271,7 @@ module ThreeScale
 
       describe 'by_key' do
         let(:key) { 'a_key' }
-        let(:key_with_special_chars) { '#$*' }
+        let(:key_with_special_chars) { SPECIAL_CHARACTERS }
         let(:service_id) { 2001 }
         let(:app_id) { 8011 }
 

data/spec/spec_helper.rb

@@ -13,3 +13,5 @@ $:.unshift(File.dirname(__FILE__) + '/../lib')
 require 'minitest/autorun'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
+
+SPECIAL_CHARACTERS = "! \"#$%&'()*+,-.:;<=>?@[]^_`{|}~\\/".freeze

data/spec/utilization_spec.rb

@@ -105,6 +105,16 @@ module ThreeScale
             Utilization.load(service_id, non_existing_app_id).must_be_nil
           end
         end
+
+        describe 'with an application ID with special characters' do
+          let(:app_id) { SPECIAL_CHARACTERS }
+
+          subject { Utilization.load(service_id, app_id) }
+
+          it 'gets expected results' do
+            subject.wont_be_empty
+          end
+        end
       end
     end
   end

metadata

@@ -1,85 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: pisoni
 version: !ruby/object:Gem::Version
-  version: 1.29.1
+  version: 1.30.0
 platform: ruby
 authors:
 - Alejandro Martinez Ruiz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-12 00:00:00.000000000 Z
+date: 2024-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '2.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 2.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 2.7.1
 - !ruby/object:Gem::Dependency
   name: injectedlogger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.0.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.0.13
 - !ruby/object:Gem::Dependency
-  name: net-http-persistent
+  name: faraday-net_http_persistent
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.1'
 description: Client for the Apisonator internal API for model data.
 email:
 - alex@3scale.net
@@ -146,7 +158,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="