3scale-api 0.6.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81f6650cb30804268729027455963486ade4f7009cd7067481e0aa898174edad
-  data.tar.gz: 865ca95ae08a08d6558460256abe123e895cbb0dc291f5ff2035bae2722ae251
+  metadata.gz: 6acc1c28076fb874303586e42676f43af59d189a848e6dbb9beea439397c099d
+  data.tar.gz: 2901c2493c186e4649a54193f86da93e1a09e928fdfe05dde717148b37aabcfe
 SHA512:
-  metadata.gz: 5a9e0a4b84571fab32f61f9db8e332924fdf86c219bf976fa82fef39ca3d4b82a896becd7c4f6079d3f45c400a8142f71ee94ad045d4a7ba577a7d2e26914fcf
-  data.tar.gz: c4676676ba01ef337764202ebe0da7ef824e0b573c9e05a5095600b58266c9af60f6365a3f51355f3154ed162f675bc6d55a41dd61a29581a463660da2be8fec
+  metadata.gz: ad1b19c06a705bc370c2fa0362ab894f89e666f1fce9d24d42bccf7538640962fc8be201c1c65c1b70bf61c7c2d4f25550e93c22cd9f1bf3256f8989200cacb7
+  data.tar.gz: 100e91d761590d54b6ff9c96884586e96cc027f9e497f462ff9c00d244bba2febe78162d3f2dce0f1341efb777e379abc1dbc8e2d170017daa53bfbfd81a80ac

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

@@ -1,5 +1,8 @@
 module ThreeScale
   module API
+    MAX_BACKENDS_PER_PAGE = 500
+    MAX_SERVICES_PER_PAGE = 500
+
     class Client
       attr_reader :http_client
 
@@ -19,8 +22,8 @@ module ThreeScale
 
       # @api public
       # @return [Array<Hash>]
-      def list_services
-        response = http_client.get('/admin/api/services')
+      def list_services(params = nil)
+        response = http_client.get('/admin/api/services', params: params)
         extract(collection: 'services', entity: 'service', from: response)
       end
 
@@ -173,7 +176,7 @@ module ThreeScale
       # @return [Hash]
       # @param [Fixnum] service_id Service ID
       # @param [String] environment. Must be 'sandbox' or 'production'
-      # @param [Fixnum] proxy configuration version
+      # @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)
@@ -182,9 +185,9 @@ module ThreeScale
       # @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
+      # @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 })
@@ -200,6 +203,15 @@ module ThreeScale
         extract(entity: 'proxy', from: response)
       end
 
+      # @api public
+      # @return [Hash]
+      # @param [Fixnum] service_id Service ID
+      def proxy_deploy(service_id)
+        response = http_client.post("/admin/api/services/#{service_id}/proxy/deploy",
+                                    body: nil)
+        extract(entity: 'proxy', from: response)
+      end
+
       # @api public
       # @return [Array<Hash>]
       # @param [Fixnum] service_id Service ID
@@ -307,7 +319,7 @@ module ThreeScale
 
       # @api public
       # @param [Fixnum] service_id Service ID
-      # @param [Fixnum] id Parent metric ID
+      # @param [Fixnum] parent_id Parent metric ID
       # @param [Fixnum] id Method ID
       # @return [Hash]
       def show_method(service_id, parent_id, id)
@@ -352,7 +364,7 @@ module ThreeScale
       # @return [Bool]
       # @param [Fixnum] service_id Service ID
       # @param [Fixnum] parent_id Parent metric ID
-      # @param [Fixnum] metric_id 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
@@ -388,7 +400,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)
@@ -466,7 +478,7 @@ 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)
@@ -522,6 +534,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
@@ -561,7 +583,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}")
@@ -570,7 +592,7 @@ 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}")
@@ -578,7 +600,7 @@ module ThreeScale
       end
 
       # @api public
-      # @param [Fixnum] id Service ID
+      # @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")
@@ -586,7 +608,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",
@@ -717,7 +739,7 @@ module ThreeScale
         extract(collection: 'applications', entity: 'application', from: response)
       end
 
-      # @api public 
+      # @api public
       # @return [Array<Hash]
       def list_application_plans
         response = http_client.get("/admin/api/application_plans")
@@ -760,7 +782,7 @@ module ThreeScale
         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
@@ -816,6 +838,232 @@ module ThreeScale
         extract(entity: 'account', from: response)
       end
 
+      # @api public
+      # @return [List]
+      def list_backends(params = nil)
+        response = http_client.get('/admin/api/backend_apis', params: params)
+        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.6.0'.freeze
+    VERSION = '1.4.0'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: 3scale-api
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Michal Cichra
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-27 00:00:00.000000000 Z
+date: 2021-01-25 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