pisoni 1.24.0 → 1.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4dc7a68d6d7ae8b6523c0956c9425a587c53b4cac5a18eb7466e9455c38ef15
-  data.tar.gz: e930a4713a961846d6c84207a2435c72f1a957acc6c4ea313c48123a5d953678
+  metadata.gz: e9b028a5986ee4a1afc4e1a07c3029e30861b4563b936084fc0c8f9c684b78f3
+  data.tar.gz: '00391525ce6ea29046aed52421a9df0882bf878d0e9e8a25e336efb4674626e3'
 SHA512:
-  metadata.gz: 5aa1351666750cd74d9b55652268155898ec5e3554bd085f8d0590fadc8d1a60d63152f6e31d7f7f48da191f26a503a543a6b6b31a470739f6af1a23d0aad11d
-  data.tar.gz: a40c08e47e58ec21db44a12e01dc0b202f0d264a34677ca9029fa23816689acb7426f4fe7d2a24abd6cb08f17c4833ea417a8d46e4833fdd3885b56b29c2d095
+  metadata.gz: a2bd6747faf1121c04e66149bf60cbf0b246e5dffc893fb599988034b2609cf8fee2e4fafd54bdcfdbb7a246c0aae32958f93bb5e3d009f8da4645f10b7b3edb
+  data.tar.gz: fced6e7795fffaf5489d63bb41cf911a1ad661aeb6e96bb99d8a897af6c9e04a903e7b64b687685c6f533329f9c9e32f82bd3a17c125eef7a71d285951d5ac4b

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 Notable changes to Pisoni will be tracked in this document.
 
+## 1.25.0 - 2019-02-20
+
+### Added
+
+- Applications can now be activated/deactivated. [#12](https://github.com/3scale/pisoni/pull/12)
+- Users of a service can now be deleted. [#15](https://github.com/3scale/pisoni/pull/15)
+
 ## 1.24.0 - 2018-06-29
 
 ### Added

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

@@ -38,6 +38,23 @@ module ThreeScale
         api_delete({}, uri: app_uri(service_id, id))
       end
 
+      def initialize(attributes = {})
+        @state = :active
+        super(attributes)
+      end
+
+      def activate
+        self.state = :active
+      end
+
+      def deactivate
+        self.state = :suspended
+      end
+
+      def active?
+        state == :active
+      end
+
       def save
         api_save uri: self.class.send(:app_uri, service_id, id)
       end
@@ -62,6 +79,12 @@ module ThreeScale
         api_delete({}, uri: key_uri(service_id, user_key))
       end
 
+      private
+
+      def state=(value)
+        # only :active or nil will be considered as :active
+        @state = value.nil? || value.to_sym == :active ? :active : :suspended
+      end
     end
   end
 end

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

@@ -10,6 +10,11 @@ module ThreeScale
       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
@@ -42,6 +47,12 @@ module ThreeScale
         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/lib/3scale/core/version.rb

@@ -1,5 +1,5 @@
 module ThreeScale
   module Core
-    VERSION = '1.24.0'
+    VERSION = '1.25.0'
   end
 end

data/spec/application_spec.rb

@@ -20,7 +20,7 @@ module ThreeScale
 
             application.service_id.must_equal '2001'
             application.id.must_equal '8011'
-            application.state.must_equal 'suspended'
+            application.active?.must_equal false
             application.plan_id.must_equal '3066'
             application.plan_name.must_equal 'crappy'
             application.redirect_url.must_equal 'blah'
@@ -93,7 +93,7 @@ module ThreeScale
         it 'returns an Application object with correct fields' do
           @app.id.must_equal '8011'
           @app.service_id.must_equal '2001'
-          @app.state.must_equal 'suspended'
+          @app.active?.must_equal false
           @app.plan_id.must_equal '3066'
           @app.plan_name.must_equal 'crappy'
           @app.redirect_url.must_equal 'blah'
@@ -152,6 +152,77 @@ module ThreeScale
           newapp.plan_name.must_equal 'some_other_plan'
         end
 
+        it 'save active application' do
+          @app.activate
+          @app.save
+          newapp = Application.load @app.service_id, @app.id
+          newapp.active?.must_equal true
+        end
+
+        it 'save inactive application' do
+          @app.deactivate
+          @app.save
+          newapp = Application.load @app.service_id, @app.id
+          newapp.active?.must_equal false
+        end
+
+        it 'save application with no explicit state' do
+          svc_id = 2001
+          app_id = 9011
+          # Make sure there is nothing in db
+          Application.delete(svc_id, app_id)
+          Application.load(svc_id, app_id).must_be_nil
+          app_def_state = Application.new service_id: svc_id, id: app_id
+          app_def_state.save
+          newapp = Application.load app_def_state.service_id, app_def_state.id
+          newapp.wont_be_nil
+          newapp.active?.must_equal true
+        end
+      end
+
+      describe '.active?' do
+        it 'should be active when application is initialized as active' do
+          [
+            { state: :active },
+            { state: 'active' },
+            # even when state is not set
+            {},
+            # even when state is intentionally set as nil
+            { state: nil }
+          ].each do |app_attrs|
+            Application.new(app_attrs).active?.must_equal true
+          end
+        end
+
+        it 'should be inactive when application is initialized as disabled' do
+          [
+            { state: :suspended },
+            { state: 'suspended' },
+            { state: :something },
+            { state: :disable },
+            { state: :disabled },
+            { state: '1' },
+            { state: '0' },
+            { state: 'true' },
+            { state: 'false' }
+          ].each do |app_attrs|
+            Application.new(app_attrs).active?.must_equal false
+          end
+        end
+
+        it 'should be active when the application is activated' do
+          app = Application.new(state: :disable)
+          app.active?.must_equal false
+          app.activate
+          app.active?.must_equal true
+        end
+
+        it 'should be inactive when the application is deactivated' do
+          app = Application.new(state: :active)
+          app.active?.must_equal true
+          app.deactivate
+          app.active?.must_equal false
+        end
       end
 
       describe 'by_key' do

data/spec/service_error_spec.rb

@@ -4,7 +4,8 @@ require_relative './private_endpoints/service_error'
 module ThreeScale
   module Core
     describe ServiceError do
-      let(:service_id) { '7575' }
+      let(:service_id) { '7575_service_error_spec' }
+      let(:provider_key) { 'foo_service_error_spec' }
       let(:non_existing_service_id) { service_id.to_i.succ.to_s }
 
       describe '.load_all' do
@@ -17,7 +18,7 @@ module ThreeScale
 
         before do
           Service.delete_by_id!(service_id)
-          Service.save!(provider_key: 'foo', id: service_id)
+          Service.save!(provider_key: provider_key, id: service_id)
           ServiceError.delete_all(service_id)
           ServiceError.save(service_id, error_messages)
         end
@@ -100,7 +101,7 @@ module ThreeScale
       describe '.delete_all' do
         before do
           Service.delete_by_id!(service_id)
-          Service.save!(provider_key: 'foo', id: service_id)
+          Service.save!(provider_key: provider_key, id: service_id)
           ServiceError.delete_all(service_id)
         end
 

data/spec/service_spec.rb

@@ -6,10 +6,10 @@ module ThreeScale
       let(:default_service_id) { 7001 }
       let(:non_default_service_id) { default_service_id.succ }
       let(:non_existent_service_id) { non_default_service_id.succ }
-      let(:default_provider_key) { 'foo' }
-      let(:other_provider_key) { 'bazinga' }
-      let(:another_provider_key) { 'bar' }
-      let(:non_existent_provider_key) { 'bunga' }
+      let(:default_provider_key) { 'foo_service_spec' }
+      let(:other_provider_key) { 'bazinga_service_spec' }
+      let(:another_provider_key) { 'bar_service_spec' }
+      let(:non_existent_provider_key) { 'bunga_service_spec' }
 
       before do
         # We create a new service for our provider as the default, then
@@ -62,23 +62,22 @@ module ThreeScale
       end
 
       describe '.delete_by_id!' do
-        before do
-          Service.save! provider_key: default_provider_key,
-                        id: default_service_id,
-                        default_service: true
-        end
-
         it 'returns true if deleting a non-default service' do
           Service.save! provider_key: default_provider_key,
                         id: non_default_service_id
           Service.delete_by_id!(non_default_service_id).must_equal true
         end
 
-        it 'raises an exception when deleting a default service' do
+        it 'raises an exception when deleting a default service and not unique' do
+          Service.save! provider_key: default_provider_key, id: non_default_service_id
           lambda do
             Service.delete_by_id! default_service_id
           end.must_raise ServiceIsDefaultService
         end
+
+        it 'returns true when deleting a default service and is unique for the provider' do
+          Service.delete_by_id!(default_service_id).must_equal true
+        end
       end
 
       describe '.save!' do

data/spec/transaction_spec.rb

@@ -6,11 +6,11 @@ module ThreeScale
     describe Transaction do
       before do
         Service.delete_by_id!(service_id)
-        Service.save!(provider_key: 'foo', id: service_id)
+        Service.save!(provider_key: 'foo_transaction_spec', id: service_id)
       end
 
       describe '.load_all' do
-        let(:service_id) { '7575' }
+        let(:service_id) { '7575_transaction_spec' }
         let(:non_existing_service_id) { service_id.to_i.succ.to_s }
 
         before do

data/spec/user_spec.rb

@@ -159,6 +159,34 @@ module ThreeScale
                      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

data/spec/utilization_spec.rb

@@ -3,9 +3,9 @@ require_relative './spec_helper'
 module ThreeScale
   module Core
     describe Utilization do
-      let(:service_id) { '1001' }
+      let(:service_id) { '1001_utilization_spec' }
       let(:non_existing_service_id) { service_id.to_i.succ.to_s }
-      let(:provider_key) { 'foo' }
+      let(:provider_key) { 'foo_utilization_spec' }
 
       let(:app_id) { '2001' }
       let(:non_existing_app_id) { app_id.to_i.succ.to_s }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pisoni
 version: !ruby/object:Gem::Version
-  version: 1.24.0
+  version: 1.25.0
 platform: ruby
 authors:
 - Alejandro Martinez Ruiz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-29 00:00:00.000000000 Z
+date: 2019-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -158,8 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Client for the Apisonator internal API for model data