pisoni 1.28.0 → 1.29.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4bd300163940397f3151f3648985d23dfa38da6a18d1fabb235020f69cd3ef0
-  data.tar.gz: de16fdc8e8dc900f80c33bac0e324ac831e1260830d5a456b4bc509bcbc4d54e
+  metadata.gz: 4bc480ca255fad3679c652ee5913824d543c7f4e5d51b0866f3919d4d1a496c3
+  data.tar.gz: d5b36dd8d28242573d3e476ae4420c93dfd30275848ea16c4526ad61db1a386e
 SHA512:
-  metadata.gz: 5f582b3622c904272fccad3c65ca34789fc16f6601825c11b62f63d46aefe2c820ed786038e69def7e278432fc7435ee4bfc80e2e5e04e095a7b6971fd0007da
-  data.tar.gz: 2c1994bd77a4baadcc19fb75b87d99b872842cc0bee6e0d6f9a77ab52fd1aa0677ae976aeccc85f5fec463679106a30252c80efe0325a0cc5fd79a8b369c8bdc
+  metadata.gz: ffb11b5ae16138162d9fbb2c5b0784618b94d478cbbfd6e8edc377ae05b3554471ffd360db902ba5e569b0c90b96ceca3005860d53f57cfdab744cb48f019716
+  data.tar.gz: 5ff19f326743a8e56b8cb2df1ab37bbef54bafbd075a4e8d6a90ee729b51e8950e7248d331724982fbf7f42c5e6ceb265f13767bd4c9b7d4c09633ab982b3eca

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 Notable changes to Pisoni will be tracked in this document.
 
+## 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
+[#27](https://github.com/3scale/pisoni/pull/27)
+
 ## 1.28.0 - 2019-12-20
 
 ### Changed

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/application.rb

@@ -25,7 +25,7 @@ module ThreeScale
       private_class_method :app_uri
 
       def self.key_uri(service_id, key)
-        escaped_key = CGI::escape(key)
+        escaped_key = CGI::escape(key.to_s)
 
         "#{base_uri(service_id)}key/#{escaped_key}"
       end

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

@@ -23,14 +23,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/#{CGI::escape(application_id.to_s)}/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)}#{CGI::escape(value.to_s)}"
       end
       private_class_method :application_key_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/version.rb

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

data/lib/3scale/core.rb

@@ -24,7 +24,6 @@ require '3scale/core/errors'
 require '3scale/core/application_key'
 require '3scale/core/application_referrer_filter'
 require '3scale/core/service_error'
-require '3scale/core/transaction'
 require '3scale/core/utilization'
 require '3scale/core/service_token'
 

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,20 +42,20 @@ 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
@@ -72,6 +72,22 @@ module ThreeScale
             application_key.value.must_equal key
           end
         end
+
+        describe 'with app ID that contains special characters ({, $, ? etc.)' do
+          let(:app_id) { 'abc{1}$3?' }
+          let(:key) { 'z#$*' }
+
+          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
       end
 
       describe '.delete' do

data/spec/application_referrer_filter_spec.rb

@@ -25,15 +25,15 @@ module ThreeScale
 
       describe '.load_all' do
         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
+            filters.must_equal ref_filters.sort
           end
         end
 

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/utilization_spec.rb

@@ -53,8 +53,6 @@ module ThreeScale
             end
           end
           usage_limits.each { |limit| UsageLimit.save(limit) }
-
-          Transaction.delete_all(service_id)
         end
 
         # This is a basic test that only checks the structure of the response.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pisoni
 version: !ruby/object:Gem::Version
-  version: 1.28.0
+  version: 1.29.1
 platform: ruby
 authors:
 - Alejandro Martinez Ruiz
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-20 00:00:00.000000000 Z
+date: 2023-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -113,7 +113,6 @@ files:
 - lib/3scale/core/service.rb
 - lib/3scale/core/service_error.rb
 - lib/3scale/core/service_token.rb
-- lib/3scale/core/transaction.rb
 - lib/3scale/core/usage_limit.rb
 - lib/3scale/core/utilization.rb
 - lib/3scale/core/version.rb
@@ -128,19 +127,17 @@ files:
 - spec/metric_spec.rb
 - spec/private_endpoints/event.rb
 - spec/private_endpoints/service_error.rb
-- spec/private_endpoints/transaction.rb
 - spec/service_error_spec.rb
 - spec/service_spec.rb
 - spec/service_token_spec.rb
 - spec/spec_helper.rb
-- spec/transaction_spec.rb
 - spec/usagelimit_spec.rb
 - spec/utilization_spec.rb
 homepage: https://github.com/3scale/pisoni
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -156,8 +153,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !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:
@@ -169,11 +166,9 @@ test_files:
 - spec/metric_spec.rb
 - spec/private_endpoints/event.rb
 - spec/private_endpoints/service_error.rb
-- spec/private_endpoints/transaction.rb
 - spec/service_error_spec.rb
 - spec/service_spec.rb
 - spec/service_token_spec.rb
 - spec/spec_helper.rb
-- spec/transaction_spec.rb
 - spec/usagelimit_spec.rb
 - spec/utilization_spec.rb

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

@@ -1,26 +0,0 @@
-module ThreeScale
-  module Core
-    class Transaction < APIClient::Resource
-      attributes :application_id, :usage, :timestamp
-
-      default_uri '/internal/services/'
-
-      def self.transactions_uri(service_id)
-        "#{default_uri}#{service_id}/transactions/"
-      end
-      private_class_method :transactions_uri
-
-      def self.load_all(service_id)
-        result = api_do_get({}, { uri: transactions_uri(service_id),
-                                  rprefix: :transactions })  do |res|
-          return nil if res[:response].status == 404
-          true
-        end
-
-        return nil if result.nil?
-
-        APIClient::Collection.new(result[:attributes].map { |attrs| new attrs })
-      end
-    end
-  end
-end

data/spec/private_endpoints/transaction.rb

@@ -1,16 +0,0 @@
-module PrivateEndpoints
-  module Transaction
-    def save(service_id, transactions)
-      api_create(transactions,
-                 { uri: transactions_uri(service_id),
-                   prefix: :transactions })
-    end
-
-    def delete_all(service_id)
-      api_delete({}, uri: transactions_uri(service_id))
-    end
-  end
-end
-
-ThreeScale::Core::Transaction.extend PrivateEndpoints::Transaction
-

data/spec/transaction_spec.rb

@@ -1,71 +0,0 @@
-require_relative './spec_helper'
-require_relative './private_endpoints/transaction'
-
-module ThreeScale
-  module Core
-    describe Transaction do
-      before do
-        Service.delete_by_id!(service_id)
-        Service.save!(provider_key: 'foo_transaction_spec', id: service_id)
-      end
-
-      describe '.load_all' do
-        let(:service_id) { '7575_transaction_spec' }
-        let(:non_existing_service_id) { service_id.to_i.succ.to_s }
-
-        before do
-          Transaction.delete_all(service_id)
-        end
-
-        describe 'when there are transactions' do
-          let(:first_transaction_time) { Time.new(2015, 1, 1) }
-          let(:second_transaction_time) { Time.new(2015, 1, 2) }
-          let(:test_transactions) do
-            transactions = []
-            transactions << { application_id: 'first_test_application',
-                              usage: 'first_usage',
-                              timestamp: first_transaction_time.to_s }
-            transactions << { application_id: 'second_test_application',
-                              usage: 'second_usage',
-                              timestamp: second_transaction_time.to_s }
-          end
-
-          before do
-            Transaction.save(service_id, test_transactions)
-          end
-
-          it 'returns a collection with the transactions' do
-            transactions = Transaction.load_all(service_id)
-
-            transactions.total.must_equal test_transactions.size
-            transactions.size.must_equal test_transactions.size
-
-            latest_transaction = transactions[0]
-            latest_transaction.application_id.must_equal test_transactions[1][:application_id]
-            latest_transaction.usage.must_equal test_transactions[1][:usage]
-            latest_transaction.timestamp.must_equal second_transaction_time
-
-            previous_transaction = transactions[1]
-            previous_transaction.application_id.must_equal test_transactions[0][:application_id]
-            previous_transaction.usage.must_equal test_transactions[0][:usage]
-            previous_transaction.timestamp.must_equal first_transaction_time
-          end
-        end
-
-        describe 'when there are no transactions' do
-          it 'returns an empty collection' do
-            transactions = Transaction.load_all(service_id)
-            transactions.must_be_empty
-            transactions.total.must_equal 0
-          end
-        end
-
-        describe 'with an invalid service ID' do
-          it 'returns nil' do
-            Transaction.load_all(non_existing_service_id).must_be_nil
-          end
-        end
-      end
-    end
-  end
-end