3scale-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e87913474e0e2e316880dd063c559bbee086470b
+  data.tar.gz: 6f734f9eb252fe2cb0c99e12d0cb6c21694d7932
+SHA512:
+  metadata.gz: 73ea2d8cade0bb30df5dd0f5d7d79a70bbf26911accc042d6c7ac063ea5ef2c1fa03be8197919e3499743974f1c8b01acbf0cab29aa3ff3a1f4483983d67be2c
+  data.tar.gz: 530916190be47420386900d6de3489062dedf9ef33f44d88f8ad906039373dcff847e7816686d7ee66905e0ea739999a96c8b91be25d094db3c4d62195065928

data/README.md

@@ -0,0 +1,52 @@
+# ThreeScale::API
+
+
+This gem aims to expose all [3scale](http://3scale.net) APIs with a Ruby interface.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem '3scale-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install 3scale-api
+
+## Usage
+
+
+```ruby
+require '3scale/api'
+client = ThreeScale::API.new(endpoint: 'https://foo-admin.3scale.net', provider_key: 'foobar')
+
+services = client.list_services
+```
+
+## Design
+
+Design decisions:
+
+* 0 runtime dependencies
+* thread safety
+* tested
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To run tests run `rake` or `rspec`.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/3scale/3scale-api-ruby.
+

data/lib/3scale/api.rb

@@ -0,0 +1,14 @@
+require '3scale/api/version'
+
+module ThreeScale
+  module API
+    autoload :Client, '3scale/api/client'
+    autoload :HttpClient, '3scale/api/http_client'
+
+    def self.new(endpoint:, provider_key:)
+      http_client = HttpClient.new(endpoint: endpoint,
+                                   provider_key: provider_key)
+      Client.new(http_client)
+    end
+  end
+end

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

@@ -0,0 +1,144 @@
+module ThreeScale
+  module API
+    class Client
+
+      attr_reader :http_client
+
+      # @param [ThreeScale::API::HttpClient] http_client
+
+      def initialize(http_client)
+        @http_client = http_client
+      end
+
+      # @api public
+      # @return [Hash]
+      # @param [Fixnum] id Service ID
+      def show_service(id)
+        response = http_client.get("/admin/api/services/#{id}")
+        extract(entity: 'service', from: response)
+      end
+
+      # @api public
+      # @return [Array<Hash>]
+      def list_services
+        response = http_client.get('/admin/api/services')
+        extract(collection: 'services', entity: 'service', from: response)
+      end
+
+      # @api public
+      # @return [Hash]
+      # @param [Hash] attributes Service Attributes
+      # @option attributes [String] :name Service Name
+      def create_service(attributes)
+        response = http_client.post('/admin/api/services', body: { service: attributes })
+        extract(entity: 'service', from: response)
+      end
+
+      # @api public
+      # @return [Array<Hash>]
+      # @param [Fixnum] service_id Service ID
+      def list_metrics(service_id)
+        response = http_client.get("/admin/api/services/#{service_id}/metrics")
+        extract(collection: 'metrics', entity: 'metric', from: response)
+      end
+
+      # @api public
+      # @return [Hash]
+      # @param [Fixnum] service_id Service ID
+      # @param [Hash] attributes Metric Attributes
+      # @option attributes [String] :name Metric Name
+      def create_metric(service_id, attributes)
+        response = http_client.post("/admin/api/services/#{service_id}/metrics", body: { metric: attributes })
+        extract(entity: 'metric', from: response)
+      end
+
+      # @api public
+      # @return [Array<Hash>]
+      # @param [Fixnum] service_id Service ID
+      # @param [Fixnum] metric_id Metric ID
+      def list_methods(service_id, metric_id)
+        response = http_client.get("/admin/api/services/#{service_id}/metrics/#{metric_id}/methods")
+        extract(collection: 'methods', entity: 'method', from: response)
+      end
+
+      # @api public
+      # @return [Hash]
+      # @param [Fixnum] service_id Service ID
+      # @param [Fixnum] metric_id Metric ID
+      # @param [Hash] attributes Metric Attributes
+      # @option attributes [String] :name Method Name
+      def create_method(service_id, metric_id, attributes)
+        response = http_client.post("/admin/api/services/#{service_id}/metrics/#{metric_id}/methods",
+                                   body: { metric: attributes })
+        extract(entity: 'method', from: response)
+      end
+
+      # @api public
+      # @return [Array<Hash>]
+      # @param [Fixnum] service_id Service ID
+      def list_service_application_plans(service_id)
+        response = http_client.get("/admin/api/services/#{service_id}/application_plans")
+
+        extract(collection: 'plans', entity: 'application_plan', from: response)
+      end
+
+      # @api public
+      # @return [Hash]
+      # @param [Fixnum] service_id Service ID
+      # @param [Hash] attributes Metric Attributes
+      # @option attributes [String] :name Application Plan Name
+      def create_application_plan(service_id, attributes)
+        response = http_client.post("/admin/api/services/#{service_id}/application_plans",
+                                    body: { application_plan: attributes })
+        extract(entity: 'application_plan', from: response)
+      end
+
+      # @api public
+      # @return [Array<Hash>]
+      # @param [Fixnum] application_plan_id Application Plan ID
+      def list_application_plan_limits(application_plan_id)
+        response = http_client.get("/admin/api/application_plans/#{application_plan_id}/limits")
+
+        extract(collection: 'limits', entity: 'limit', from: response)
+      end
+
+      # @api public
+      # @return [Hash]
+      # @param [Fixnum] application_plan_id Application Plan ID
+      # @param [Hash] attributes Metric Attributes
+      # @param [Fixnum] metric_id Metric ID
+      # @option attributes [String] :period Usage Limit period
+      # @option attributes [String] :value Usage Limit value
+      def create_application_plan_limit(application_plan_id, metric_id, attributes)
+        response = http_client.post("/admin/api/application_plans/#{application_plan_id}/metrics/#{metric_id}/limits",
+                                    body: { usage_limit: attributes })
+        extract(entity: 'limit', from: response)
+      end
+
+      # @param [Fixnum] application_plan_id Application Plan ID
+      # @param [Fixnum] metric_id Metric ID
+      # @param [Fixnum] limit_id Usage Limit ID
+      def delete_application_plan_limit(application_plan_id, metric_id, limit_id)
+        http_client.delete("/admin/api/application_plans/#{application_plan_id}/metrics/#{metric_id}/limits/#{limit_id}")
+        true
+      end
+
+      protected
+
+      def extract(collection: nil, entity: , from: )
+        if collection
+          from = from.fetch(collection)
+        end
+
+        case from
+          when Array then from.map { |e| e.fetch(entity) }
+          when Hash then from.fetch(entity) { from }
+          when nil then nil # raise exception?
+          else
+            raise "unknown #{from}"
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+require 'json'
+
+module ThreeScale
+  module API
+    class HttpClient
+      attr_reader :endpoint, :admin_domain, :provider_key, :headers, :format
+
+      def initialize(endpoint: , provider_key: , format: :json)
+        @endpoint = URI(endpoint).freeze
+        @admin_domain = @endpoint.host.freeze
+        @provider_key = provider_key.freeze
+        @http = Net::HTTP.new(admin_domain, @endpoint.port)
+        @http.use_ssl = @endpoint.is_a?(URI::HTTPS)
+
+        @headers = {
+            'Accept' => "application/#{format}",
+            'Content-Type' => "application/#{format}",
+            'Authorization' =>  'Basic ' + [":#{@provider_key}"].pack('m').delete("\r\n")
+        }
+
+        if debug?
+          @http.set_debug_output($stdout)
+          @headers['Accept-Encoding'] = 'identity'
+        end
+
+        @headers.freeze
+
+        @format = format
+      end
+
+      def get(path)
+        parse @http.get("#{path}.#{format}", headers)
+      end
+
+      def post(path, body: )
+        parse @http.post("#{path}.#{format}", serialize(body), headers)
+      end
+
+      def delete(path)
+        parse @http.delete("#{path}.#{format}", headers)
+      end
+
+      # @param [::Net::HTTPResponse] response
+      def parse(response)
+        case response
+          when Net::HTTPUnprocessableEntity, Net::HTTPSuccess then parser.decode(response.body)
+          when Net::HTTPForbidden then forbidden!(response)
+          else "Can't handle #{response.inspect}"
+        end
+      end
+
+      class ForbiddenError < StandardError; end
+
+      def forbidden!(response)
+        raise ForbiddenError, response
+      end
+
+      def serialize(body)
+        case body
+          when String then body
+          else parser.encode(body)
+        end
+      end
+
+      def parser
+        case format
+          when :json then JSONParser
+          else "unknown format #{format}"
+        end
+      end
+
+      protected
+
+      def debug?
+        ENV.fetch('3SCALE_DEBUG', '0') == '1'
+      end
+
+      module JSONParser
+        module_function
+
+        def decode(string)
+          case string
+            when ' '.freeze, ''.freeze then nil
+            else ::JSON.parse(string)
+          end
+        end
+
+        def encode(query)
+          ::JSON.generate(query)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module ThreeScale
+  module API
+    VERSION = "0.1.0"
+  end
+end

data/lib/three_scale/api.rb

@@ -0,0 +1 @@
+require '3scale/api'

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: 3scale-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michal Cichra
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+description: 'API Client to access your 3scale APIs: Account Management API'
+email:
+- michal@3scale.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/3scale/api.rb
+- lib/3scale/api/client.rb
+- lib/3scale/api/http_client.rb
+- lib/3scale/api/version.rb
+- lib/three_scale/api.rb
+homepage: https://github.com/3scale/3scale-api-ruby.
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: API Client for 3scale APIs
+test_files: []
+has_rdoc: