pisoni 1.27.0 → 1.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b9921a2c40849229cd27b57db87570d21794d2d65d4673aef8faa157f5f4782
-  data.tar.gz: 5b6b50ff45e57e8c55ba4b873b0529b7902a2c67c34372475aefe39938e0df74
+  metadata.gz: b4bd300163940397f3151f3648985d23dfa38da6a18d1fabb235020f69cd3ef0
+  data.tar.gz: de16fdc8e8dc900f80c33bac0e324ac831e1260830d5a456b4bc509bcbc4d54e
 SHA512:
-  metadata.gz: f3c2931b7987037a397b43e491db1dcf3985148672270b33b5703b08a4a4f9e01ac15de8a29433f13fdd9d5985d50f87275a7a17542bfddc2d71b2e42f6d528d
-  data.tar.gz: 2fa14e7b0ff82f7701b279503e2957a6978aca5bdb07b59a2ba75d9a1724926009bf46876202985c4a3414c1694a28929e7f6b79424686171e8d1d9eabedccf9
+  metadata.gz: 5f582b3622c904272fccad3c65ca34789fc16f6601825c11b62f63d46aefe2c820ed786038e69def7e278432fc7435ee4bfc80e2e5e04e095a7b6971fd0007da
+  data.tar.gz: 2c1994bd77a4baadcc19fb75b87d99b872842cc0bee6e0d6f9a77ab52fd1aa0677ae976aeccc85f5fec463679106a30252c80efe0325a0cc5fd79a8b369c8bdc

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 Notable changes to Pisoni will be tracked in this document.
 
+## 1.28.0 - 2019-12-20
+
+### Changed
+
+- `Service.delete_stats` has been adapted to the changes in Apisonator. Now it
+only needs to receive the service ID as a param and deletes all the stats for
+that service. The second param of the function, "delete_job" is ignored now.
+[#24](https://github.com/3scale/pisoni/pull/24)
+
+### Removed
+
+- Support for end-users, a feature that's no longer supported in recent
+Apisonator. [#25](https://github.com/3scale/pisoni/pull/25)
+
 ## 1.27.0 - 2019-06-28
 
 ### Added

data/lib/3scale/core.rb

@@ -18,7 +18,6 @@ require '3scale/core/application'
 require '3scale/core/metric'
 require '3scale/core/service'
 require '3scale/core/usage_limit'
-require '3scale/core/user'
 require '3scale/core/event'
 require '3scale/core/alert_limit'
 require '3scale/core/errors'

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

@@ -37,12 +37,6 @@ module ThreeScale
       end
     end
 
-    class ServiceRequiresDefaultUserPlan < Error
-      def initialize
-        super %(Services without the need for registered users require a default user plan)
-      end
-    end
-
     class ServiceIsDefaultService < Error
       def initialize(id = nil)
         super %(Service id="#{id}" is the default service, must be removed forcefully or make it not default before removal)
@@ -55,30 +49,6 @@ module ThreeScale
       end
     end
 
-    class UserRequiresUsername < Error
-      def initialize
-        super %(User requires username)
-      end
-    end
-
-    class UserRequiresServiceId < Error
-      def initialize
-        super %(User requires a service id)
-      end
-    end
-
-    class UserRequiresValidServiceId < Error
-      def initialize(id)
-        super %(Service id #{id} is invalid, user requires a valid id)
-      end
-    end
-
-    class UserRequiresDefinedPlan < Error
-      def initialize(plan_id, plan_name)
-        super %(User requires a defined plan, plan id: #{plan_id} plan name: #{plan_name})
-      end
-    end
-
     class InvalidProviderKeys < Error
       def initialize
         super %(Provider keys are not valid, must be not nil and different)

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

@@ -20,12 +20,7 @@ module ThreeScale
 
         def save!(attributes)
           id = attributes.fetch(:id)
-          api_update(attributes, uri: service_uri(id)) do |result|
-            if result[:response].status == 400
-              raise ServiceRequiresDefaultUserPlan
-            end
-            true
-          end
+          api_update(attributes, uri: service_uri(id))
         end
 
         def change_provider_key!(old_key, new_key)
@@ -46,8 +41,11 @@ module ThreeScale
           save! id: service_id, default_service: true
         end
 
-        def delete_stats(service_id, delete_job)
-          api_delete(delete_job, uri: "#{service_uri(service_id)}/stats", prefix: '')
+        # Deletes all the stats for the given service.
+        # Note: delete_job is no longer needed. It's kept to avoid breaking
+        # compatibility.
+        def delete_stats(service_id, _delete_job)
+          api_delete({}, uri: "#{service_uri(service_id)}/stats", prefix: '')
         end
 
         private

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

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

data/spec/service_spec.rb

@@ -97,14 +97,6 @@ module ThreeScale
           service.provider_key.must_equal default_provider_key
         end
 
-        it 'raises an exception when missing a default user plan' do
-          @service_params.merge! user_registration_required: false
-
-          lambda do
-            Service.save!(@service_params)
-          end.must_raise ServiceRequiresDefaultUserPlan
-        end
-
         it 'save active service' do
           service = Service.new(@service_params)
           service.wont_be_nil
@@ -240,8 +232,14 @@ module ThreeScale
           }
         end
 
-        describe 'with valid job' do
+        describe 'with a service ID' do
           it 'does not raise error' do
+            Service.delete_stats(default_service_id, nil).must_equal true
+          end
+        end
+
+        describe 'with a deprecated delete_job param' do
+          it 'ignores it without raising error' do
             Service.delete_stats(default_service_id, delete_job).must_equal true
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pisoni
 version: !ruby/object:Gem::Version
-  version: 1.27.0
+  version: 1.28.0
 platform: ruby
 authors:
 - Alejandro Martinez Ruiz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-28 00:00:00.000000000 Z
+date: 2019-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -115,7 +115,6 @@ files:
 - lib/3scale/core/service_token.rb
 - lib/3scale/core/transaction.rb
 - lib/3scale/core/usage_limit.rb
-- lib/3scale/core/user.rb
 - lib/3scale/core/utilization.rb
 - lib/3scale/core/version.rb
 - lib/3scale_core.rb
@@ -136,7 +135,6 @@ files:
 - spec/spec_helper.rb
 - spec/transaction_spec.rb
 - spec/usagelimit_spec.rb
-- spec/user_spec.rb
 - spec/utilization_spec.rb
 homepage: https://github.com/3scale/pisoni
 licenses:
@@ -178,5 +176,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/transaction_spec.rb
 - spec/usagelimit_spec.rb
-- spec/user_spec.rb
 - spec/utilization_spec.rb

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

@@ -1,58 +0,0 @@
-module ThreeScale
-  module Core
-    class User < APIClient::Resource
-      attributes :service_id, :username, :state, :plan_id, :plan_name
-
-      default_uri '/internal/services/'
-
-      def self.base_uri(service_id, username)
-        "#{default_uri}#{service_id}/users/#{username}"
-      end
-      private_class_method :base_uri
-
-      def self.users_base_uri(service_id)
-        "#{default_uri}#{service_id}/users"
-      end
-      private_class_method :users_base_uri
-
-      def self.check_params(service_id, username)
-        raise UserRequiresUsername if username.nil? || username == ''.freeze
-        raise UserRequiresServiceId if service_id.nil? || service_id == ''.freeze
-      end
-      private_class_method :check_params
-
-      def self.load(service_id, username)
-        check_params service_id, username
-        api_read({}, uri: base_uri(service_id, username))
-      end
-
-      def self.save!(attributes)
-        service_id, username = attributes[:service_id], attributes[:username]
-        check_params service_id, username
-        api_update(attributes,
-                   uri: base_uri(service_id, username)) do |result|
-          if result[:response].status == 400
-            if result[:response_json][:error] =~ /requires a valid service/
-              raise UserRequiresValidServiceId.new(service_id)
-            elsif result[:response_json][:error] =~ /requires a defined plan/
-              raise UserRequiresDefinedPlan.new(attributes[:plan_id],
-                                                attributes[:plan_name])
-            end
-          end
-          true
-        end
-      end
-
-      def self.delete!(service_id, username)
-        check_params service_id, username
-        api_delete({}, uri: base_uri(service_id, username))
-      end
-
-      def self.delete_all_for_service(service_id)
-        raise UserRequiresServiceId if service_id.nil? || service_id == ''.freeze
-
-        api_delete({}, uri: users_base_uri(service_id))
-      end
-    end
-  end
-end

data/spec/user_spec.rb

@@ -1,192 +0,0 @@
-require_relative './spec_helper'
-
-module ThreeScale
-  module Core
-    describe User do
-      def nothing_raised
-        yield
-        true
-      rescue => e
-        e
-      end
-
-      let(:service_id) { 2001 }
-      let(:nonexistent_service_id) { service_id.succ }
-      let(:provider_key) { 'provider_for_user_spec' }
-      let(:username) { 'pancho' }
-      let(:nonexistent_username) { 'rodolfo' }
-      let(:state) { :active }
-      let(:plan_id) { 6789 }
-      let(:plan_name) { 'plan_for_panchos' }
-
-      before do
-        Service.save! provider_key: provider_key,
-                      id: service_id, default_service: true
-
-        Service.delete_by_id! nonexistent_service_id rescue nil
-        User.delete! service_id, nonexistent_username
-        @user = User.save! service_id: service_id, username: username, state: state,
-                           plan_id: plan_id, plan_name: plan_name
-      end
-
-      describe '.load' do
-        it 'returns a User object' do
-          User.load(service_id, username).class.must_equal User
-        end
-
-        it 'parses data from received JSON' do
-          user = User.load(service_id, username)
-
-          user.wont_be_nil
-          user.service_id.must_equal service_id.to_s
-          user.state.must_equal state.to_s
-          user.plan_id.must_equal plan_id.to_s
-          user.plan_name.must_equal plan_name
-        end
-
-        it 'raises when the service id is missing or empty' do
-          ['', nil].each do |service_id|
-            lambda do
-              User.load service_id, username
-            end.must_raise UserRequiresServiceId
-          end
-        end
-
-        it 'raises when the user name is missing or empty' do
-          ['', nil].each do |user_name|
-            lambda do
-              User.load service_id, user_name
-            end.must_raise UserRequiresUsername
-          end
-        end
-
-        it 'returns nil when a non-existent service id is used' do
-          User.load(nonexistent_service_id, username).must_be_nil
-        end
-
-        it 'returns nil when a non-existent user name is used' do
-           User.load(service_id, nonexistent_username).must_be_nil
-        end
-      end
-
-      describe '.save!' do
-        before do
-          User.delete! service_id, nonexistent_username
-        end
-
-        it 'returns a User object' do
-          @user.wont_be_nil
-          @user.class.must_equal User
-        end
-
-        it 'returns an object with the saved attributes' do
-          @user.wont_be_nil
-          @user.service_id.must_equal service_id.to_s
-          @user.username.must_equal username
-          @user.state.must_equal state.to_s
-          @user.plan_id.must_equal plan_id
-          @user.plan_name.must_equal plan_name
-        end
-
-        it 'raises when the service id is missing or empty' do
-          ['', nil].each do |service_id|
-            lambda do
-              User.save! service_id: service_id, username: username, plan_id: plan_id,
-                plan_name: plan_name
-            end.must_raise UserRequiresServiceId
-          end
-        end
-
-        it 'raises when the user name is missing or empty' do
-          ['', nil].each do |user_name|
-            lambda do
-              User.save! service_id: service_id, username: user_name, plan_id: plan_id,
-                plan_name: plan_name
-            end.must_raise UserRequiresUsername
-          end
-        end
-
-        it 'raises when a non-existent service id is used' do
-          lambda do
-            User.save! service_id: nonexistent_service_id, username: username,
-                       plan_id: plan_id, plan_name: plan_name
-          end.must_raise UserRequiresValidServiceId
-        end
-
-        it 'raises when plan_id is nil' do
-          lambda do
-            User.save! service_id: service_id, username: username,
-                       plan_id: nil, plan_name: plan_name
-          end.must_raise UserRequiresDefinedPlan
-        end
-
-        it 'raises when plan_name is nil' do
-          lambda do
-            User.save! service_id: service_id, username: username,
-                       plan_id: plan_id, plan_name: nil
-          end.must_raise UserRequiresDefinedPlan
-        end
-
-        it 'returns a new user when a non-existent user name is used' do
-          nothing_raised do
-            User.save! service_id: service_id, username: nonexistent_username,
-                       plan_id: plan_id, plan_name: plan_name
-          end.must_equal true
-
-          user = User.load service_id, nonexistent_username
-
-          user.wont_be_nil
-          user.service_id.must_equal service_id.to_s
-          user.username.must_equal nonexistent_username
-          user.state.must_equal state.to_s
-          user.plan_id.must_equal plan_id.to_s
-          user.plan_name.must_equal plan_name
-        end
-      end
-
-      describe '.delete!' do
-        before do
-          User.save! service_id: service_id, username: username, state: state,
-                     plan_id: plan_id, plan_name: plan_name
-        end
-
-        it 'deletes the user' do
-          nothing_raised do
-            User.delete! service_id, username
-          end.must_equal true
-
-          User.save! service_id: service_id, username: username, state: state,
-                     plan_id: plan_id, plan_name: plan_name
-        end
-      end
-
-      describe '.delete_all_for_service' do
-        let(:service_id) { '2001_delete_all_for_service' }
-        let(:provider_key) { 'provider_for_delete_all_for_service' }
-        let(:state) { :active }
-
-        before do
-          Service.save! provider_key: provider_key, id: service_id, default_service: true
-        end
-
-        it 'deletes all users' do
-          user01 = User.save!(service_id: service_id, username: 'username01', state: :active,
-                              plan_id: 'plan_id_01', plan_name: 'plan_01')
-          user02 = User.save!(service_id: service_id, username: 'username02', state: :active,
-                              plan_id: 'plan_id_02', plan_name: 'plan_02')
-          User.delete_all_for_service(service_id).must_equal true
-          User.load(service_id, user01.username).must_be_nil
-          User.load(service_id, user02.username).must_be_nil
-        end
-
-        it 'raises error on empty service' do
-          proc { User.delete_all_for_service('') }.must_raise UserRequiresServiceId
-        end
-
-        it 'raises error on nil service' do
-          proc { User.delete_all_for_service(nil) }.must_raise UserRequiresServiceId
-        end
-      end
-    end
-  end
-end