pisoni 1.26.0 → 1.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1675046183f0f1221921e9e2637d5107875f6528a1f829467cbf6d634752f263
-  data.tar.gz: 593203983ca15e7249917cb66ceb3bdb9884585faa1fe1bc91e1ae4a88f341fc
+  metadata.gz: 0b9921a2c40849229cd27b57db87570d21794d2d65d4673aef8faa157f5f4782
+  data.tar.gz: 5b6b50ff45e57e8c55ba4b873b0529b7902a2c67c34372475aefe39938e0df74
 SHA512:
-  metadata.gz: bbd28ac55fa5feadf7cba3759e123f72f2df9c4b47fb63053d0f535fbf437cdea9a7dfcb8c75496ad4401ff84a72df1462f17d748f973000e3d6af294ecb6e4a
-  data.tar.gz: f4135e0196aa5e3d7ade69fd44f101bf5bb024ba36691125a93adb3dab75145df0f9a5664e47d3bb95b98b836f7362d145f2d416a9dfe244ba831d225b1db56d
+  metadata.gz: f3c2931b7987037a397b43e491db1dcf3985148672270b33b5703b08a4a4f9e01ac15de8a29433f13fdd9d5985d50f87275a7a17542bfddc2d71b2e42f6d528d
+  data.tar.gz: 2fa14e7b0ff82f7701b279503e2957a6978aca5bdb07b59a2ba75d9a1724926009bf46876202985c4a3414c1694a28929e7f6b79424686171e8d1d9eabedccf9

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 Notable changes to Pisoni will be tracked in this document.
 
+## 1.27.0 - 2019-06-28
+
+### Added
+
+- Support for app credentials with special characters ('*', '$', etc.). [#22](https://github.com/3scale/pisoni/pull/22)
+
 ## 1.26.0 - 2019-03-05
 
 ### Added

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

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

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

@@ -1,3 +1,5 @@
+require 'cgi'
+
 module ThreeScale
   module Core
     class ApplicationKey < APIClient::Resource
@@ -25,8 +27,10 @@ module ThreeScale
       end
       private_class_method :base_uri
 
-      def self.application_key_uri(service_id, application_id, value = nil)
-        "#{base_uri(service_id, application_id)}#{value}"
+      def self.application_key_uri(service_id, application_id, value = '')
+        escaped_value = CGI::escape(value)
+
+        "#{base_uri(service_id, application_id)}#{escaped_value}"
       end
       private_class_method :application_key_uri
     end

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

@@ -1,5 +1,5 @@
 module ThreeScale
   module Core
-    VERSION = '1.26.0'
+    VERSION = '1.27.0'
   end
 end

data/spec/application_key_spec.rb

@@ -57,38 +57,60 @@ module ThreeScale
           application_key.must_be_kind_of ApplicationKey
           application_key.value.must_equal value
         end
+
+        describe 'with a key that contains special chars (*, _, etc.)' do
+          let(:key) { '#$*' }
+
+          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
-        describe 'with an existing application key' do
-          let(:service_id) { 300 }
-          let(:app_id)     { 200 }
-          let(:value)      { "foo" }
+        let(:service_id) { 300 }
+        let(:app_id) { 200 }
+        let(:key) { 'foo' }
 
-          before do
-            Application.save service_id: service_id, id: app_id, state: 'suspended',
-                             plan_id: '3066', plan_name: 'crappy', redirect_url: 'blah'
+        before do
+          Application.save service_id: service_id, id: app_id, state: 'suspended',
+                           plan_id: '3066', plan_name: 'crappy', redirect_url: 'blah'
+        end
 
-            ApplicationKey.save(service_id, app_id, value)
+        describe 'with an existing application key' do
+          before do
+            ApplicationKey.save(service_id, app_id, key)
           end
 
           it 'returns true' do
-            ApplicationKey.delete(service_id, app_id, value).must_equal true
+            ApplicationKey.delete(service_id, app_id, key).must_equal true
           end
         end
 
         describe 'with a non-existing application key' do
-          let(:service_id) { 300 }
-          let(:app_id)     { 500 }
-          let(:value)      { "nonexistingkey" }
+          let(:key) { 'non_existing_key' }
+
+          it 'returns false' do
+            ApplicationKey.delete(service_id, app_id, key).must_equal false
+          end
+        end
+
+        describe 'with a key that contains special chars (*, _, etc.)' do
+          let(:key_with_special_chars) { '#$*' }
 
           before do
-            Application.save service_id: service_id, id: app_id, state: 'suspended',
-                             plan_id: '3066', plan_name: 'crappy', redirect_url: 'blah'
+            ApplicationKey.save(service_id, app_id, key)
           end
 
           it 'returns true' do
-            ApplicationKey.delete(service_id, app_id, value).must_equal false
+            ApplicationKey.delete(service_id, app_id, key).must_equal true
           end
         end
       end

data/spec/application_spec.rb

@@ -44,6 +44,20 @@ module ThreeScale
             Application.load(1999, 7999).must_be_nil
           end
         end
+
+        describe 'with an app ID that contains special characters' do
+          let(:service_id) { 2001 }
+          let(:app_id) { '#$*' }
+
+          before do
+            Application.save service_id: service_id, id: app_id, state: 'suspended',
+                             plan_id: '3066', plan_name: 'crappy', redirect_url: 'blah'
+          end
+
+          it 'returns an app with the correct ID' do
+            Application.load(service_id, app_id).id.must_equal app_id
+          end
+        end
       end
 
       describe '.delete' do
@@ -73,6 +87,20 @@ module ThreeScale
             Application.delete(1999, 8011).must_equal false
           end
         end
+
+        describe 'with an app ID that contains special characters' do
+          let(:service_id) { 2001 }
+          let(:app_id) { '#$*' }
+
+          before do
+            Application.save service_id: service_id, id: app_id, state: 'suspended',
+                             plan_id: '3066', plan_name: 'crappy', redirect_url: 'blah'
+          end
+
+          it 'returns true when deleting an existing app' do
+            Application.delete(service_id, app_id).must_equal true
+          end
+        end
       end
 
       describe '.save' do
@@ -126,6 +154,22 @@ module ThreeScale
             end.must_raise KeyError # minitest wont catch parent exceptions :/
           end
         end
+
+        describe 'with an app ID that contains special characters' do
+          let(:service_id) { 2001 }
+          let(:app_id) { '#$*' }
+
+          before do
+            Application.delete(service_id, app_id)
+          end
+
+          it 'returns an object with the correct ID' do
+            app = Application.save service_id: service_id, id: app_id, state: 'suspended',
+                                   plan_id: '3066', plan_name: 'crappy', redirect_url: 'blah'
+
+            app.id.must_equal app_id
+          end
+        end
       end
 
       describe '#save' do
@@ -226,31 +270,70 @@ module ThreeScale
       end
 
       describe 'by_key' do
+        let(:key) { 'a_key' }
+        let(:key_with_special_chars) { '#$*' }
+        let(:service_id) { 2001 }
+        let(:app_id) { 8011 }
+
         before do
-          Application.save_id_by_key(2001, 'a_key', 8011)
+          Application.save_id_by_key(service_id, key, app_id)
         end
 
         describe '.load_id_by_key' do
           it 'returns the app ID linked to the specified service and key' do
-            Application.load_id_by_key(2001, 'a_key').must_equal '8011'
+            Application.load_id_by_key(service_id, key).must_equal app_id.to_s
+          end
+
+          describe 'with a key that contains special chars (*, _, etc.)' do
+            before do
+              Application.save_id_by_key(service_id, key_with_special_chars, app_id)
+            end
+
+            it 'returns the correct app ID' do
+              Application.load_id_by_key(service_id, key_with_special_chars).must_equal app_id.to_s
+            end
           end
         end
 
         describe '.save_id_by_key' do
+          let(:another_key) { key.succ }
+
           it 'changes the key linked to the app ID and service' do
-            Application.load_id_by_key(2001, 'another_key').must_be_nil
-            Application.save_id_by_key(2001, 'another_key', 8011).must_equal true
-            Application.load_id_by_key(2001, 'another_key').must_equal '8011'
+            Application.load_id_by_key(service_id, another_key).must_be_nil
+            Application.save_id_by_key(service_id, another_key, app_id).must_equal true
+            Application.load_id_by_key(service_id, another_key).must_equal app_id.to_s
             # clean up this key
-            Application.delete_id_by_key(2001, 'another_key')
+            Application.delete_id_by_key(service_id, another_key)
+          end
+
+          describe 'with a key that contains special chars (*, _, etc.)' do
+            after do
+              Application.delete_id_by_key(service_id, key_with_special_chars)
+            end
+
+            it 'changes the key linked to the app ID and service' do
+              Application.save_id_by_key(service_id, key_with_special_chars, app_id).must_equal true
+              Application.load_id_by_key(service_id, key_with_special_chars).must_equal app_id.to_s
+            end
           end
         end
 
         describe '.delete_id_by_key' do
           it 'deletes the key linked to the app ID and service' do
-            Application.load_id_by_key(2001, 'a_key').must_equal '8011'
-            Application.delete_id_by_key(2001, 'a_key')
-            Application.load_id_by_key(2001, 'a_key').must_be_nil
+            Application.load_id_by_key(service_id, key).must_equal app_id.to_s
+            Application.delete_id_by_key(service_id, key)
+            Application.load_id_by_key(service_id, key).must_be_nil
+          end
+
+          describe 'with a key that contains special chars (*, _, etc.)' do
+            before do
+              Application.save_id_by_key(service_id, key_with_special_chars, app_id)
+            end
+
+            it 'deletes the app' do
+              Application.delete_id_by_key(service_id, key_with_special_chars)
+              Application.load_id_by_key(service_id, key_with_special_chars).must_be_nil
+            end
           end
         end
       end

data/spec/service_spec.rb

@@ -245,16 +245,6 @@ module ThreeScale
             Service.delete_stats(default_service_id, delete_job).must_equal true
           end
         end
-
-        describe 'with invalid job' do
-          # to < from
-          let(:to) { Time.new(2001, 10, 31).to_i }
-          it 'raises error' do
-            lambda {
-              Service.delete_stats(default_service_id, delete_job)
-            }.must_raise APIClient::APIError
-          end
-        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pisoni
 version: !ruby/object:Gem::Version
-  version: 1.26.0
+  version: 1.27.0
 platform: ruby
 authors:
 - Alejandro Martinez Ruiz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-05 00:00:00.000000000 Z
+date: 2019-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -158,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Client for the Apisonator internal API for model data