3scale-api 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a193e21d894bbcbc922ecce719af6737c68b71e77ebee260ad4de038bf6676de
-  data.tar.gz: 7b2d0644e45a953242a700f950b268dec38d719e73c5619bef14961bc13ea672
+  metadata.gz: 35e0461eb588d4122409263fd94afe29e14b40cb0d34dca1d2a2c4f4ea91737f
+  data.tar.gz: ee61ee6359a8ff0c5cb9165dfb15bf8c8fe1d647bfc53056dc58838062d83255
 SHA512:
-  metadata.gz: e0e2b6d70e63fb1c1a4965178ba99f4ffe9cfc93f89404e4123364dc50fad56b37d89bf05243998854dd43bcefb1d93806eb0a88b32ae7b0040e7e35a38f5af0
-  data.tar.gz: 0de8726e6eed9011f1fe694b46a1e2b242040d137b430259b6b1d31ccc58c4a02a01a6eb969ea46c32a4764d58d74ef2bcf159b04f670fb94ba73750d0f5bc06
+  metadata.gz: 328d7a9238eb7ab5efc71e2d71702b9c938af24e07a0cbd75d60ddd1ef637e87d45a1fd17f19dc1f917f629f2b4a39269d7e243d7bc6a01ef9b4f23837888e30
+  data.tar.gz: 8b6440a49570f16618f81e73ccc5089694dc91f8615412ec3e4ed379737824b975fe99eef5c67413afaa40955c0bf93c660576f6051f8be1511412adfe6b5eee

data/lib/3scale/api/client.rb

@@ -32,10 +32,11 @@ module ThreeScale
       end
 
       # @api public
-      # @return [Array<Hash>]
       # @param [Fixnum] service_id Service ID
-      def list_applications(service_id: nil)
-        params = service_id ? { service_id: service_id } : nil
+      # @param [Fixnum] plan_id Application Plan ID
+      # @return [Array<Hash>]
+      def list_applications(service_id: nil, plan_id: nil)
+        params = { service_id: service_id, plan_id: plan_id }.compact
         response = http_client.get('/admin/api/applications', params: params)
         extract(collection: 'applications', entity: 'application', from: response)
       end
@@ -73,6 +74,16 @@ module ThreeScale
         extract(entity: 'application', from: response)
       end
 
+      # @api public
+      # @param [Fixnum] account_id Account ID
+      # @param [Fixnum] id Application ID
+      # @param [Hash] attrs Application Attributes
+      # @return [Hash] an Application
+      def update_application(account_id, id, attrs)
+        response = http_client.put("/admin/api/accounts/#{account_id}/applications/#{id}", body: attrs)
+        extract(entity: 'application', from: response)
+      end
+
       # @api public
       # @return [Hash] a Plan
       # @param [Fixnum] account_id Account ID
@@ -139,18 +150,40 @@ module ThreeScale
       # @return [Hash]
       # @param [Fixnum] service_id Service ID
       # @param [String] environment. Must be 'sandbox' or 'production'
-      def proxy_config_list(service_id, environment='sandbox')
+      def proxy_config_list(service_id, environment = 'sandbox')
         response = http_client.get("/admin/api/services/#{service_id}/proxy/configs/#{environment}")
-        extract(entity: 'proxy', from: response)
+        extract(collection: 'proxy_configs', entity: 'proxy_config', from: response)
       end
 
       # @api public
       # @return [Hash]
       # @param [Fixnum] service_id Service ID
       # @param [String] environment. Must be 'sandbox' or 'production'
-      def proxy_config_latest(service_id, environment='sandbox')
+      def proxy_config_latest(service_id, environment = 'sandbox')
         response = http_client.get("/admin/api/services/#{service_id}/proxy/configs/#{environment}/latest")
-        extract(entity: 'proxy', from: response)
+        extract(entity: 'proxy_config', from: response)
+      end
+
+      # @api public
+      # @return [Hash]
+      # @param [Fixnum] service_id Service ID
+      # @param [String] environment. Must be 'sandbox' or 'production'
+      # @param [Fixnum] proxy configuration version
+      def show_proxy_config(service_id, environment, version)
+        response = http_client.get("/admin/api/services/#{service_id}/proxy/configs/#{environment}/#{version}")
+        extract(entity: 'proxy_config', from: response)
+      end
+
+      # @api public
+      # @return [Hash]
+      # @param [Fixnum] service_id Service ID
+      # @param [String] environment. Must be 'sandbox' or 'production'
+      # @param [Fixnum] proxy configuration version to promote
+      # @param [Fixnum] proxy configuration to which the specified proxy configuration will be promoted to
+      def promote_proxy_config(service_id, environment, version, to)
+        response = http_client.post("/admin/api/services/#{service_id}/proxy/configs/#{environment}/#{version}/promote",
+                                    body: { to: to })
+        extract(entity: 'proxy_config', from: response)
       end
 
       # @api public
@@ -219,7 +252,7 @@ module ThreeScale
 
       # @api public
       # @param [Fixnum] service_id Service ID
-      # @param [Fixnum] id Metric ID 
+      # @param [Fixnum] id Metric ID
       # @return [Hash]
       def show_metric(service_id, id)
         response = http_client.get("/admin/api/services/#{service_id}/metrics/#{id}")
@@ -269,8 +302,8 @@ module ThreeScale
 
       # @api public
       # @param [Fixnum] service_id Service ID
-      # @param [Fixnum] id Parent metric ID 
-      # @param [Fixnum] id Method ID 
+      # @param [Fixnum] id Parent metric ID
+      # @param [Fixnum] id Method ID
       # @return [Hash]
       def show_method(service_id, parent_id, id)
         response = http_client.get("/admin/api/services/#{service_id}/metrics/#{parent_id}/methods/#{id}")
@@ -280,7 +313,7 @@ module ThreeScale
       # @api public
       # @return [Hash]
       # @param [Fixnum] service_id Service ID
-      # @param [Fixnum] parent_id Parent metric ID 
+      # @param [Fixnum] parent_id Parent metric ID
       # @param [Fixnum] id Method ID
       # @param [Hash] attributes Method Attributes
       def update_method(service_id, parent_id, id, attributes)
@@ -313,14 +346,13 @@ module ThreeScale
       # @api public
       # @return [Bool]
       # @param [Fixnum] service_id Service ID
-      # @param [Fixnum] parent_id Parent metric ID 
+      # @param [Fixnum] parent_id Parent metric ID
       # @param [Fixnum] metric_id Metric ID
       def delete_method(service_id, parent_id, id)
         http_client.delete("/admin/api/services/#{service_id}/metrics/#{parent_id}/methods/#{id}")
         true
       end
 
-
       # @api public
       # @param [Fixnum] application_plan_id Application Plan ID
       # @param [Fixnum] metric_id Metric ID
@@ -374,7 +406,7 @@ module ThreeScale
       # @return [Bool]
       # @param [Fixnum] service_id Service ID
       # @param [Fixnum] application_plan_id Application Plan ID
-      def delete_application_plan(service_id,application_plan_id)
+      def delete_application_plan(service_id, application_plan_id)
         http_client.delete("/admin/api/services/#{service_id}/application_plans/#{application_plan_id}")
         true
       end
@@ -416,7 +448,7 @@ module ThreeScale
       # @param [Hash] attributes Limit Attributes
       def update_application_plan_limit(application_plan_id, metric_id, limit_id, attributes)
         response = http_client.put("/admin/api/application_plans/#{application_plan_id}/metrics/#{metric_id}/limits/#{limit_id}",
-                                    body: { usage_limit: attributes })
+                                   body: { usage_limit: attributes })
         extract(entity: 'limit', from: response)
       end
 
@@ -436,6 +468,14 @@ module ThreeScale
         extract(entity: 'account', from: response)
       end
 
+      # @api public
+      # @param [Fixnum] id Account Id
+      # @return [Hash]
+      def show_account(id)
+        response = http_client.get("/admin/api/accounts/#{id}")
+        extract(entity: 'account', from: response)
+      end
+
       # @api public
       # @return [Array]
       # @param [Fixnum] id Service ID
@@ -532,7 +572,7 @@ module ThreeScale
         true
       end
 
-       # @api public
+      # @api public
       # @param [Fixnum] id Service ID
       # @return [Array<Hash>]
       def show_oidc(service_id)
@@ -590,7 +630,7 @@ module ThreeScale
       # @return [Hash]
       def create_service_feature(id, attributes)
         response = http_client.post("/admin/api/services/#{id}/features",
-                                    body: { feature: attributes})
+                                    body: { feature: attributes })
         extract(entity: 'feature', from: response)
       end
 
@@ -623,6 +663,154 @@ module ThreeScale
         true
       end
 
+      # @api public
+      # @param [Fixnum] account_id Account ID
+      # @param [String] state State
+      # @param [String] role Role
+      # @return [Array<Hash>]
+      def list_users(account_id, state: nil, role: nil)
+        params = { state: state, role: role }.reject { |_, value| value.nil? }
+        response = http_client.get("/admin/api/accounts/#{account_id}/users", params: params)
+        extract(collection: 'users', entity: 'user', from: response)
+      end
+
+      # @api public
+      # @param [String] account_id Account ID
+      # @param [String] email User email
+      # @param [String] username User Username
+      # @param [String] password User password
+      # @param [Hash] attributes User Attributes
+      # @return [Hash]
+      def create_user(account_id:, email:, username:, password:, **rest)
+        body = { email: email, username: username, password: password }.merge(rest)
+        response = http_client.post("/admin/api/accounts/#{account_id}/users", body: body)
+        extract(entity: 'user', from: response)
+      end
+
+      # @api public
+      # @param [String] account_id Account ID
+      # @param [String] user_id User ID
+      # @return [Hash]
+      def activate_user(account_id, user_id)
+        response = http_client.put("/admin/api/accounts/#{account_id}/users/#{user_id}/activate")
+        extract(entity: 'user', from: response)
+      end
+
+      # @api public
+      # @param [String] account_id Account ID
+      # @return [Hash]
+      def approve_account(account_id)
+        response = http_client.put("/admin/api/accounts/#{account_id}/approve")
+        extract(entity: 'account', from: response)
+      end
+
+      # @api public
+      # @param [String] account_id Account ID
+      # @return [Array<Hash>]
+      def list_account_applications(account_id)
+        response = http_client.get("/admin/api/accounts/#{account_id}/applications")
+        extract(collection: 'applications', entity: 'application', from: response)
+      end
+
+      # @api public 
+      # @return [Array<Hash]
+      def list_application_plans
+        response = http_client.get("/admin/api/application_plans")
+        extract(collection: 'plans', entity: 'application_plan', from: response)
+      end
+
+      # @api public
+      # @param [String] account_id Account ID
+      # @param [String] application_id Application ID
+      # @return [Array<Hash>]
+      def list_application_keys(account_id, application_id)
+        response = http_client.get("/admin/api/accounts/#{account_id}/applications/#{application_id}/keys")
+        extract(collection: 'keys', entity: 'key', from: response)
+      end
+
+      # @api public
+      # @param [String] account_id Account ID
+      # @param [String] application_id Application ID
+      # @param [String] key Key
+      # @return [Hash]
+      def create_application_key(account_id, application_id, key)
+        response = http_client.post("/admin/api/accounts/#{account_id}/applications/#{application_id}/keys", body: {key: key})
+        extract(entity: 'application', from: response)
+      end
+
+      # @api public
+      # @param [String] account_id Account ID
+      # @param [String] application_id Application ID
+      # @return [Hash] application Application
+      def accept_application(account_id, application_id)
+        response = http_client.put("/admin/api/accounts/#{account_id}/applications/#{application_id}/accept")
+        extract(entity: 'application', from: response)
+      end
+
+      # @api public
+      # @param [String] account_id Account ID
+      # @param [String] application_id Application ID
+      # @return [Hash] application Application
+      def suspend_application(account_id, application_id)
+        response = http_client.put("/admin/api/accounts/#{account_id}/applications/#{application_id}/suspend")
+        extract(entity: 'application', from: response)
+      end
+      
+      # @api public
+      # @param [String] account_id Account ID
+      # @param [String] application_id Application ID
+      # @return [Hash] application Application
+      def resume_application(account_id, application_id)
+        response = http_client.put("/admin/api/accounts/#{account_id}/applications/#{application_id}/resume")
+        extract(entity: 'application', from: response)
+      end
+
+      # @api public
+      # @return [Array<Hash>]
+      def list_policy_registry
+        response = http_client.get('/admin/api/registry/policies')
+        extract(collection: 'policies', entity: 'policy', from: response)
+      end
+
+      # @api public
+      # @param [Hash] attributes Policy Registry Attributes
+      # @return [Hash]
+      def create_policy_registry(attributes)
+        response = http_client.post('/admin/api/registry/policies', body: attributes)
+        extract(entity: 'policy', from: response)
+      end
+
+      # @api public
+      # @return [Hash]
+      # @param [Fixnum] id Policy Registry Id
+      def show_policy_registry(id)
+        response = http_client.get("/admin/api/registry/policies/#{id}")
+        extract(entity: 'policy', from: response)
+      end
+
+      # @api public
+      # @return [Hash]
+      # @param [Fixnum] id Policy Registry Id
+      # @param [Hash] attributes Policy Registry Attributes
+      def update_policy_registry(id, attributes)
+        response = http_client.put("/admin/api/registry/policies/#{id}", body: attributes)
+        extract(entity: 'policy', from: response)
+      end
+
+      # @api public
+      # @param [Fixnum] id Policy Registry Id
+      def delete_policy_registry(id)
+        http_client.delete("/admin/api/registry/policies/#{id}")
+        true
+      end
+
+      # @api public
+      # @return [Hash]
+      def show_provider
+        response = http_client.get('/admin/api/provider')
+        extract(entity: 'account', from: response)
+      end
+
       protected
 
       def extract(collection: nil, entity:, from:)

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

@@ -1,5 +1,5 @@
 module ThreeScale
   module API
-    VERSION = '0.4.0'.freeze
+    VERSION = '0.5.0'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: 3scale-api
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Michal Cichra
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-13 00:00:00.000000000 Z
+date: 2019-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler