3scale-api 0.4.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a193e21d894bbcbc922ecce719af6737c68b71e77ebee260ad4de038bf6676de
-  data.tar.gz: 7b2d0644e45a953242a700f950b268dec38d719e73c5619bef14961bc13ea672
+  metadata.gz: ea3ac51993c3762a0a40625807148fdba4dbf390aa032bc97183f660220bf410
+  data.tar.gz: 3f5c198b2fbe44894007990f4f7e6d926400c4f89597acf9533a281c2fb77cd7
 SHA512:
-  metadata.gz: e0e2b6d70e63fb1c1a4965178ba99f4ffe9cfc93f89404e4123364dc50fad56b37d89bf05243998854dd43bcefb1d93806eb0a88b32ae7b0040e7e35a38f5af0
-  data.tar.gz: 0de8726e6eed9011f1fe694b46a1e2b242040d137b430259b6b1d31ccc58c4a02a01a6eb969ea46c32a4764d58d74ef2bcf159b04f670fb94ba73750d0f5bc06
+  metadata.gz: a5e4aff97c1716b24cdd5ba27385cf2babe88183dcc4894fcad0ca0df3e03df150e77fb80ff01485cca4bea47c4f6bade61a8c31aebdac8bd312aede6799af29
+  data.tar.gz: 2b86b756c210e5cc8270279d9f8ae258624ae6656594864d63d082b492b91b76e4c62a822ae6654243ba4585565acf6055906327303f71ec6e915b6603f22a16

data/lib/3scale/api.rb

@@ -1,4 +1,5 @@
 require '3scale/api/version'
+require '3scale/api/errors'
 
 module ThreeScale
   module API

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
@@ -52,8 +53,13 @@ module ThreeScale
       # @param [Fixnum] id Application ID
       # @param [String] user_key Application User Key
       # @param [String] application_id Application app_id
-      def find_application(id: nil, user_key: nil, application_id: nil)
-        params = { application_id: id, user_key: user_key, app_id: application_id }.reject { |_, value| value.nil? }
+      def find_application(id: nil, user_key: nil, application_id: nil, service_id: nil)
+        params = {
+          application_id: id,
+          user_key: user_key,
+          app_id: application_id,
+          service_id: service_id,
+        }.compact
         response = http_client.get('/admin/api/applications/find', params: params)
         extract(entity: 'application', from: response)
       end
@@ -73,6 +79,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 +155,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] version 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] version Version to promote
+      # @param [Fixnum] to 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 +257,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 +307,8 @@ module ThreeScale
 
       # @api public
       # @param [Fixnum] service_id Service ID
-      # @param [Fixnum] id Parent metric ID 
-      # @param [Fixnum] id Method ID 
+      # @param [Fixnum] parent_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 +318,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 +351,13 @@ module ThreeScale
       # @api public
       # @return [Bool]
       # @param [Fixnum] service_id Service ID
-      # @param [Fixnum] parent_id Parent metric ID 
-      # @param [Fixnum] metric_id Metric ID
+      # @param [Fixnum] parent_id Parent metric ID
+      # @param [Fixnum] 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
@@ -351,7 +388,7 @@ module ThreeScale
       end
 
       # @api public
-      # @param [Fixnum] id Service ID
+      # @param [Fixnum] service_id Service ID
       # @param [Fixnum] id Application Plan ID
       # @return [Hash]
       def show_application_plan(service_id, id)
@@ -374,7 +411,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 +453,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
 
@@ -429,13 +466,21 @@ module ThreeScale
       end
 
       # @api public
-      # @param [Hash] account criteria
+      # @param [Hash] criteria Search parameters
       # @return [Hash]
       def find_account(criteria)
         response = http_client.get('/admin/api/accounts/find', params: criteria)
         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
@@ -477,6 +522,16 @@ module ThreeScale
         extract(entity: 'pricing_rule', from: response)
       end
 
+      # @api public
+      # @param [Fixnum] application_plan_id Application Plan ID
+      # @param [Fixnum] metric_id Metric ID
+      # @param [Fixnum] id Rule ID
+      # @return [Bool]
+      def delete_application_plan_pricingrule(application_plan_id, metric_id, id)
+        http_client.delete("/admin/api/application_plans/#{application_plan_id}/metrics/#{metric_id}/pricing_rules/#{id}")
+        true
+      end
+
       # @api public
       # @return [Array<Hash>]
       def list_activedocs
@@ -516,7 +571,7 @@ module ThreeScale
       end
 
       # @api public
-      # @param [Fixnum] account_id Account ID
+      # @param [Fixnum] id Account ID
       # @return [Bool]
       def delete_account(id)
         http_client.delete("/admin/api/accounts/#{id}")
@@ -525,15 +580,15 @@ module ThreeScale
 
       # @api public
       # @param [Fixnum] account_id Account ID
-      # @param [Fixnum] application_id Application ID
+      # @param [Fixnum] id Application ID
       # @return [Bool]
       def delete_application(account_id, id)
         http_client.delete("/admin/api/accounts/#{account_id}/applications/#{id}")
         true
       end
 
-       # @api public
-      # @param [Fixnum] id Service ID
+      # @api public
+      # @param [Fixnum] service_id Service ID
       # @return [Array<Hash>]
       def show_oidc(service_id)
         response = http_client.get("/admin/api/services/#{service_id}/proxy/oidc_configuration")
@@ -541,7 +596,7 @@ module ThreeScale
       end
 
       # @api public
-      # @param [Fixnum] id Service ID
+      # @param [Fixnum] service_id Service ID
       # @return [Hash]
       def update_oidc(service_id, attributes)
         response = http_client.patch("/admin/api/services/#{service_id}/proxy/oidc_configuration",
@@ -590,7 +645,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 +678,380 @@ 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
+
+      # @api public
+      # @return [List]
+      def list_backends
+        response = http_client.get('/admin/api/backend_apis')
+        extract(collection: 'backend_apis', entity: 'backend_api', from: response)
+      end
+
+      # @api public
+      # @param [Hash] attributes Backend attributes
+      # @return [Hash]
+      def create_backend(attributes)
+        response = http_client.post('/admin/api/backend_apis', body: attributes)
+        extract(entity: 'backend_api', from: response)
+      end
+
+      # @api public
+      # @param [Fixnum] id Backend ID
+      def delete_backend(id)
+        http_client.delete("/admin/api/backend_apis/#{id}")
+        true
+      end
+
+      # @api public
+      # @param [Fixnum] id Backend ID
+      # @return [Hash]
+      def backend(id)
+        response = http_client.get("/admin/api/backend_apis/#{id}")
+        extract(entity: 'backend_api', from: response)
+      end
+
+      # @api public
+      # @param [Fixnum] id Backend ID
+      # @param [Hash] attributes Backend attributes
+      # @return [Hash]
+      def update_backend(id, attributes)
+        response = http_client.put("/admin/api/backend_apis/#{id}", body: attributes)
+        extract(entity: 'backend_api', from: response)
+      end
+
+      # @api public
+      # @param [Fixnum] id Backend ID
+      # @return [List]
+      def list_backend_metrics(id)
+        response = http_client.get("/admin/api/backend_apis/#{id}/metrics")
+        extract(collection: 'metrics', entity: 'metric', from: response)
+      end
+
+      # @api public
+      # @param [Fixnum] id Backend ID
+      # @param [Hash] attributes Metric attributes
+      # @return [Hash]
+      def create_backend_metric(id, attrs)
+        response = http_client.post("/admin/api/backend_apis/#{id}/metrics", body: attrs)
+        extract(entity: 'metric', from: response)
+      end
+
+      # @api public
+      # @param [Fixnum] backend_id Backend ID
+      # @param [Fixnum] metric_id Backend Metric ID
+      def delete_backend_metric(backend_id, metric_id)
+        http_client.delete("/admin/api/backend_apis/#{backend_id}/metrics/#{metric_id}")
+        true
+      end
+
+      # @api public
+      # @param [Fixnum] backend_id Backend ID
+      # @param [Fixnum] metric_id Backend Metric ID
+      # @return [Hash]
+      def backend_metric(backend_id, metric_id)
+        response = http_client.get("/admin/api/backend_apis/#{backend_id}/metrics/#{metric_id}")
+        extract(entity: 'metric', from: response)
+      end
+
+      # @api public
+      # @param [Fixnum] backend_id Backend ID
+      # @param [Fixnum] metric_id Backend Metric ID
+      # @param [Hash] attributes Backend attributes
+      # @return [Hash]
+      def update_backend_metric(backend_id, metric_id, attributes)
+        response = http_client.put("/admin/api/backend_apis/#{backend_id}/metrics/#{metric_id}", body: attributes)
+        extract(entity: 'metric', from: response)
+      end
+
+      # @api public
+      # @param [Fixnum] backend_id Backend ID
+      # @param [Fixnum] metric_id Backend Metric ID
+      # @return [List]
+      def list_backend_methods(backend_id, metric_id)
+        response = http_client.get("/admin/api/backend_apis/#{backend_id}/metrics/#{metric_id}/methods")
+        extract(collection: 'methods', entity: 'method', from: response)
+      end
+
+      # @api public
+      # @param [Fixnum] backend_id Backend ID
+      # @param [Fixnum] metric_id Backend Metric ID
+      # @param [Hash] attributes Metric attributes
+      # @return [Hash]
+      def create_backend_method(backend_id, metric_id, attrs)
+        response = http_client.post("/admin/api/backend_apis/#{backend_id}/metrics/#{metric_id}/methods",
+                                    body: attrs)
+        extract(entity: 'method', from: response)
+      end
+
+      # @api public
+      # @param [Fixnum] backend_id Backend ID
+      # @param [Fixnum] metric_id Backend Metric ID
+      # @param [Fixnum] method_id Backend Method ID
+      def delete_backend_method(backend_id, metric_id, method_id)
+        http_client.delete("/admin/api/backend_apis/#{backend_id}/metrics/#{metric_id}/methods/#{method_id}")
+        true
+      end
+
+      # @api public
+      # @param [Fixnum] backend_id Backend ID
+      # @param [Fixnum] metric_id Backend Metric ID
+      # @param [Fixnum] method_id Backend Method ID
+      # @return [Hash]
+      def backend_method(backend_id, metric_id, method_id)
+        response = http_client.get("/admin/api/backend_apis/#{backend_id}/metrics/#{metric_id}/methods/#{method_id}")
+        extract(entity: 'method', from: response)
+      end
+
+      # @api public
+      # @param [Fixnum] backend_id Backend ID
+      # @param [Fixnum] metric_id Backend Metric ID
+      # @param [Fixnum] method_id Backend Method ID
+      # @param [Hash] attributes Backend attributes
+      # @return [Hash]
+      def update_backend_method(backend_id, metric_id, method_id, attributes)
+        response = http_client.put("/admin/api/backend_apis/#{backend_id}/metrics/#{metric_id}/methods/#{method_id}",
+                                   body: attributes)
+        extract(entity: 'method', from: response)
+      end
+
+      # @api public
+      # @param [Fixnum] backend_id Backend ID
+      # @return [List]
+      def list_backend_mapping_rules(backend_id)
+        response = http_client.get("/admin/api/backend_apis/#{backend_id}/mapping_rules")
+        extract(collection: 'mapping_rules', entity: 'mapping_rule', from: response)
+      end
+
+      # @api public
+      # @param [Fixnum] backend_id Backend ID
+      # @param [Hash] attrs Metric attributes
+      # @return [Hash]
+      def create_backend_mapping_rule(backend_id, attrs)
+        response = http_client.post("/admin/api/backend_apis/#{backend_id}/mapping_rules",
+                                    body: attrs)
+        extract(entity: 'mapping_rule', from: response)
+      end
+
+      # @api public
+      # @param [Fixnum] backend_id Backend ID
+      # @param [Fixnum] mapping_rule_id MappingRule ID
+      def delete_backend_mapping_rule(backend_id, mapping_rule_id)
+        http_client.delete("/admin/api/backend_apis/#{backend_id}/mapping_rules/#{mapping_rule_id}")
+        true
+      end
+
+      # @api public
+      # @param [Fixnum] backend_id Backend ID
+      # @param [Fixnum] mapping_rule_id MappingRule ID
+      # @return [Hash]
+      def backend_mapping_rule(backend_id, mapping_rule_id)
+        response = http_client.get("/admin/api/backend_apis/#{backend_id}/mapping_rules/#{mapping_rule_id}")
+        extract(entity: 'mapping_rule', from: response)
+      end
+
+      # @api public
+      # @param [Fixnum] backend_id Backend ID
+      # @param [Fixnum] mapping_rule_id MappingRule ID
+      # @param [Hash] attributes Backend attributes
+      # @return [Hash]
+      def update_backend_mapping_rule(backend_id, mapping_rule_id, attributes)
+        response = http_client.put("/admin/api/backend_apis/#{backend_id}/mapping_rules/#{mapping_rule_id}",
+                                   body: attributes)
+        extract(entity: 'mapping_rule', from: response)
+      end
+
+      # @api public
+      # @param [Fixnum] product_id Product ID
+      # @return [List]
+      def list_backend_usages(product_id)
+        response = http_client.get("/admin/api/services/#{product_id}/backend_usages")
+        extract(entity: 'backend_usage', from: response)
+      end
+
+      # @api public
+      # @param [Fixnum] product_id Product ID
+      # @param [Hash] attrs Backend Usage attributes
+      # @return [Hash]
+      def create_backend_usage(product_id, attrs)
+        response = http_client.post("/admin/api/services/#{product_id}/backend_usages",
+                                    body: attrs)
+        extract(entity: 'backend_usage', from: response)
+      end
+
+      # @api public
+      # @param [Fixnum] product_id Product ID
+      # @param [Fixnum] id Backend Usage ID
+      def delete_backend_usage(product_id, id)
+        http_client.delete("/admin/api/services/#{product_id}/backend_usages/#{id}")
+        true
+      end
+
+      # @api public
+      # @param [Fixnum] product_id Product ID
+      # @param [Fixnum] id Backend Usage ID
+      # @return [Hash]
+      def backend_usage(product_id, id)
+        response = http_client.get("/admin/api/services/#{product_id}/backend_usages/#{id}")
+        extract(entity: 'backend_usage', from: response)
+      end
+
+      # @api public
+      # @param [Fixnum] product_id Product ID
+      # @param [Fixnum] id Backend Usage ID
+      # @param [Hash] attrs Backend Usage attributes
+      # @return [Hash]
+      def update_backend_usage(product_id, id, attrs)
+        response = http_client.put("/admin/api/services/#{product_id}/backend_usages/#{id}",
+                                   body: attrs)
+        extract(entity: 'backend_usage', from: response)
+      end
+
       protected
 
       def extract(collection: nil, entity:, from:)

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

@@ -0,0 +1,12 @@
+module ThreeScale
+  module API
+    class ResponseError < StandardError
+      attr_reader :response
+
+      def initialize(response, message = response.to_s)
+        super(message)
+        @response = response
+      end
+    end
+  end
+end

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

@@ -58,26 +58,32 @@ module ThreeScale
         when Net::HTTPUnprocessableEntity, Net::HTTPSuccess then parser.decode(response.body)
         when Net::HTTPForbidden then forbidden!(response)
         when Net::HTTPNotFound then notfound!(response)
-        else unexpected!(response.inspect)
+        else unexpected!(response)
         end
       end
 
-      class ForbiddenError < StandardError; end
+      class ForbiddenError < ResponseError; end
 
-      class UnexpectedResponseError < StandardError; end
+      class UnexpectedResponseError < ResponseError; end
 
-      class NotFoundError < StandardError; end
+      class NotFoundError < ResponseError; end
+
+      class UnknownFormatError < StandardError; end
 
       def forbidden!(response)
-        raise ForbiddenError, response
+        raise ForbiddenError.new(response, format_response(response))
       end
 
       def notfound!(response)
-        raise NotFoundError, response
+        raise NotFoundError.new(response, format_response(response))
       end
 
       def unexpected!(response)
-        raise UnexpectedResponseError, response
+        raise UnexpectedResponseError.new(response, format_response(response))
+      end
+
+      def unknownformat!
+        raise UnknownFormatError, "unknown format #{format}"
       end
 
       def serialize(body)
@@ -91,7 +97,7 @@ module ThreeScale
       def parser
         case format
         when :json then JSONParser
-        else "unknown format #{format}"
+        else unknownformat!
         end
       end
 
@@ -108,6 +114,16 @@ module ThreeScale
         path
       end
 
+      def format_response(response)
+        body = response.body if text_based?(response)
+        "#{response.inspect} body=#{body}"
+      end
+
+      def text_based?(response)
+        response.content_type =~ /^text/ ||
+          response.content_type =~ /^application/ && !['application/octet-stream', 'application/pdf'].include?(response.content_type)
+      end
+
       module JSONParser
         module_function
 

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

@@ -1,5 +1,5 @@
 module ThreeScale
   module API
-    VERSION = '0.4.0'.freeze
+    VERSION = '1.2.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: 1.2.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: 2020-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +78,7 @@ files:
 - README.md
 - lib/3scale/api.rb
 - lib/3scale/api/client.rb
+- lib/3scale/api/errors.rb
 - lib/3scale/api/http_client.rb
 - lib/3scale/api/version.rb
 - lib/three_scale/api.rb
@@ -100,8 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: API Client for 3scale APIs