pisoni 1.29.0 → 1.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f1ad974b6dcbbf155ca09a341c90299512b202c25be5d02313d8230b3643050
-  data.tar.gz: ceaaa69cfa602b690ab20f48dbc98bc46a2fdcfaa52f36330e1fd698b37a6bbc
+  metadata.gz: bc7b659e66478ddb954b8144e47cd83cbf80acd54e16f7f051c82f07f47c221f
+  data.tar.gz: fb1ab6344af206a17085bf42134622fef72e57093bad247ce8efaa2b823b8ff6
 SHA512:
-  metadata.gz: bb81cdc2713b7be7ab6fd06983769df7f62b966816a0b71c7a97454ffb511ea059e896aca2bd6397b0bebeb7250b37616ade6f43d5fb6f680192891a85a8fd22
-  data.tar.gz: 268a297b87ac353451fe91a9b2963acd200e5c1a6470ac610989b21f13683d2ca32a939eb14b10ea6f893f9210dbdd89af85ac0bd7377a3c226410d8101d3f68
+  metadata.gz: 2b39b7a9ed13db3500fb782b1f1f5e75cc9d15261938f70e11788f84a96957a6f38ca3cc801bf84f7b5ee94cb4bac4a1bfed12ec9a4bc99fb5c01f73ed4ea860
+  data.tar.gz: 1de636e31c5d8c5897eda7282283a157553a032c81f26b58378c39a342021786285b851c59bd786dbbf3f5ea536ed3cd4f564c415240887af136e46e18345c2f

data/CHANGELOG.md

@@ -2,12 +2,27 @@
 
 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
+
+- Fixed the issue with updating/deleting keys for applications with special characters in the
+application IDs by escaping them. [#31](https://github.com/3scale/pisoni/pull/31)
+
 ## 1.29.0 - 2020-03-17
 
 ### Removed
 
 - "Latest transactions" functionality
-[#26](https://github.com/3scale/pisoni/pull/26)
+[#27](https://github.com/3scale/pisoni/pull/27)
 
 ## 1.28.0 - 2019-12-20
 

data/Gemfile

@@ -3,14 +3,12 @@ source "https://rubygems.org"
 gemspec
 
 group :test do
-  gem 'turn', '~> 0.9.7'
   gem 'minitest'
   gem "codeclimate-test-reporter", require: nil
 end
 
 group :development, :test do
-  gem 'pry',      '~> 0.10.0'
-  gem 'pry-doc',  '~> 0.6.0'
-  gem 'pry-byebug', '~> 2.0.0'
+  gem 'pry-doc', '>= 0.8'
+  gem 'pry-byebug', '>= 3.7.0'
   gem 'license_finder', '~> 5', require: false
 end

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)
-
-        "#{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,14 +21,12 @@ module ThreeScale
       end
 
       def self.base_uri(service_id, application_id)
-        "#{default_uri}#{service_id}/applications/#{application_id}/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 = '')
-        escaped_value = CGI::escape(value)
-
-        "#{base_uri(service_id, application_id)}#{escaped_value}"
+        "#{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/service.rb

@@ -2,8 +2,7 @@ module ThreeScale
   module Core
     class Service < APIClient::Resource
       attributes :provider_key, :id, :backend_version, :referrer_filters_required,
-                 :user_registration_required, :default_user_plan_id,
-                 :default_user_plan_name, :default_service, :state
+                 :default_service, :state
 
       class << self
         def load_by_id(service_id)
@@ -85,10 +84,6 @@ module ThreeScale
         @referrer_filters_required
       end
 
-      def user_registration_required?
-        @user_registration_required
-      end
-
       def active?
         state == :active
       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.0'
+    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/alert_limit_spec.rb

@@ -5,17 +5,17 @@ module ThreeScale
       describe '.load_all' do
         describe 'when there are alert limits' do
           let(:service_id) { 100 }
-          let(:values)     { [50, 100] }
+          let(:limits)     { [50, 100] }
           before do
-            values.map { |value| AlertLimit.delete(service_id, value) }
-            values.map { |value| AlertLimit.save(service_id, value) }
+            limits.map { |value| AlertLimit.delete(service_id, value) }
+            limits.map { |value| AlertLimit.save(service_id, value) }
           end
 
           it 'returns a list of alert limits' do
             alert_limits = AlertLimit.load_all(service_id)
 
             alert_limits.size.must_equal 2
-            alert_limits.map(&:value).must_equal values
+            alert_limits.map(&:value).must_equal limits
           end
         end
 
@@ -30,40 +30,40 @@ module ThreeScale
 
       describe '.save' do
         let(:service_id) { 500 }
-        let(:value)      { 100 }
+        let(:limit)      { 100 }
 
         before do
-          AlertLimit.delete(service_id, value)
+          AlertLimit.delete(service_id, limit)
         end
 
         it 'returns a AlertLimit object' do
-          alert_limit = AlertLimit.save(service_id, value)
+          alert_limit = AlertLimit.save(service_id, limit)
 
           alert_limit.must_be_kind_of AlertLimit
-          alert_limit.value.must_equal value
+          alert_limit.value.must_equal limit
         end
       end
 
       describe '.delete' do
         describe 'with an existing alert limit' do
           let(:service_id) { 300 }
-          let(:value)      { 50 }
+          let(:limit)      { 50 }
 
           before do
-            AlertLimit.save(service_id, value)
+            AlertLimit.save(service_id, limit)
           end
 
           it 'returns true' do
-            AlertLimit.delete(service_id, value).must_equal true
+            AlertLimit.delete(service_id, limit).must_equal true
           end
         end
 
         describe 'with a non-existing alert limit' do
           let(:service_id) { 300 }
-          let(:value)      { 75  }
+          let(:limit)      { 75  }
 
           it 'returns true' do
-            AlertLimit.delete(service_id, value).must_equal false
+            AlertLimit.delete(service_id, limit).must_equal false
           end
         end
       end

data/spec/application_key_spec.rb

@@ -6,21 +6,21 @@ module ThreeScale
         describe 'when there are application keys' do
           let(:service_id) { 100 }
           let(:app_id)     { 2001 }
-          let(:values)     { ["foo", "bar"] }
+          let(:keys)     { %w[foo bar] }
           before do
-            values.map { |value| ApplicationKey.delete(service_id, app_id, value) }
+            keys.map { |key| ApplicationKey.delete(service_id, app_id, key) }
 
             Application.save service_id: service_id, id: app_id, state: 'suspended',
                              plan_id: '3066', plan_name: 'crappy', redirect_url: 'blah'
 
-            values.map { |value| ApplicationKey.save(service_id, app_id, value) }
+            keys.map { |key| ApplicationKey.save(service_id, app_id, key) }
           end
 
           it 'returns a list of application keys' do
             application_keys = ApplicationKey.load_all(service_id, app_id)
 
             application_keys.size.must_equal 2
-            application_keys.map(&:value).sort.must_equal values.sort
+            application_keys.map(&:value).sort.must_equal keys.sort
           end
         end
 
@@ -42,24 +42,40 @@ module ThreeScale
       describe '.save' do
         let(:service_id) { 500 }
         let(:app_id)     { 500 }
-        let(:value)      { "foobar" }
+        let(:key)      { "foobar" }
 
         before do
-          ApplicationKey.delete(service_id, app_id, value)
+          ApplicationKey.delete(service_id, app_id, key)
 
           Application.save service_id: service_id, id: app_id, state: 'suspended',
                            plan_id: '3066', plan_name: 'crappy', redirect_url: 'blah'
         end
 
         it 'returns an ApplicationKey object' do
-          application_key = ApplicationKey.save(service_id, app_id, value)
+          application_key = ApplicationKey.save(service_id, app_id, key)
 
           application_key.must_be_kind_of ApplicationKey
-          application_key.value.must_equal value
+          application_key.value.must_equal key
         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)
+          end
+
+          it 'saves it correctly' do
+            application_key = ApplicationKey.save(service_id, app_id, key)
+
+            application_key.must_be_kind_of ApplicationKey
+            application_key.value.must_equal key
+          end
+        end
+
+        describe 'with app ID that contains special characters ({, $, ? etc.)' do
+          let(:app_id) { SPECIAL_CHARACTERS }
+          let(:key) { SPECIAL_CHARACTERS }
 
           before do
             ApplicationKey.delete(service_id, app_id, key)
@@ -103,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,22 +24,23 @@ module ThreeScale
       end
 
       describe '.load_all' do
+        subject { ApplicationReferrerFilter.load_all(service_id, app_id) }
+
         describe 'Getting all referrer filters' do
-          let(:values)     { %w(foo bar) }
+          let(:ref_filters)     { %w(foo bar) }
 
           before do
-            values.map { |value| ApplicationReferrerFilter.save(service_id, app_id, value) }
+            ref_filters.map { |value| ApplicationReferrerFilter.save(service_id, app_id, value) }
           end
 
           it 'returns a sorted list of filters' do
-            filters = ApplicationReferrerFilter.load_all(service_id, app_id)
-            filters.must_equal values.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/service_spec.rb

@@ -26,8 +26,6 @@ module ThreeScale
                                 id: default_service_id,
                                 referrer_filters_required: true,
                                 backend_version: 'oauth',
-                                default_user_plan_id: 15,
-                                default_user_plan_name: 'test name',
                                 default_service: true
         raise unless service.default_service
 
@@ -47,10 +45,7 @@ module ThreeScale
             service.provider_key.must_equal default_provider_key
             service.id.must_equal default_service_id.to_s
             service.referrer_filters_required?.must_equal true
-            service.user_registration_required?.must_equal true
             service.backend_version.must_equal 'oauth'
-            service.default_user_plan_id.must_equal '15'
-            service.default_user_plan_name.must_equal 'test name'
           end
         end
 

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.0
+  version: 1.30.0
 platform: ruby
 authors:
 - Alejandro Martinez Ruiz
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-17 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
@@ -137,7 +149,7 @@ homepage: https://github.com/3scale/pisoni
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -146,15 +158,15 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Client for the Apisonator internal API for model data
 test_files: