3scale-api 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ef997b197fed97f1128b943ea537e75e185d9236
-  data.tar.gz: 67eb15978f939ff8ab8f120536e6785960171e62
+SHA256:
+  metadata.gz: e3ae48b0911ac65f9a45bd02e2a378e234b2235dd9ebfd92f44cb97f6f62225f
+  data.tar.gz: 0fac2326c5a08a52ae7a25aabd510a4d2da1a5a4ed4f2431f88f561a2e6e7eff
 SHA512:
-  metadata.gz: aca3bee10f6dc8ac0a549fc5bd40fb932424143d9e6c6e9e9c54e61cb1aad91d812f4f9f4920822dbcafc713e6035298c859cd5900a82b8406ef848ed939a35e
-  data.tar.gz: aded44e98dfee38fd83858ba98dd4ace7b2d6f22aa878d1bfbaff3c003badfd9534efb2d63e7773c60086503527a888a3812c6cdeb3833859c5c5daa0be00e41
+  metadata.gz: b424f617c927c6ec4e5e41d45cbbd15274bc460744b13d632a1a26163691669368148147838a50b4bc9e5c8f12ebaaa151779ba037cad688d6ce359bfc5c2ecc
+  data.tar.gz: 1ba5fb1af0f06f9a8b83f02fc31dba8ee6abc829d34556520db4ed29a374e461d53106923c57074f2db3a93e0ceda2c022c1148eb1cce4cab2e93086420a7b0f

data/README.md

@@ -44,11 +44,30 @@ Design decisions:
 
 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.
 
+## Testing
+
 To run tests run `rake` or `rspec`.
 
+There are two kinds of tests: unit (see [spec/api](spec/api)) and integration (see [spec/integration](spec/integration)).
+
+For running the integration tests you will need to have a real 3scale account, you can set the details of the account via environment variables. The easiest way to set everything up is it to have a `.env` file in the root of the project with the following environment variables (set your own values):
+
+```
+ENDPOINT=https://your-domain-admin.3scale.net
+PROVIDER_KEY=abc123
+SERVICE_ID=12345
+METRIC_ID=12345 # should be a numeric value, not the system name
+APPLICATION_PLAN_ID=12345
+VERIFY_SSL=true (by default true)
+```
+
+**Note:** for the tests to pass the following requirements need to be met:
+- authorization mode of the service should be *API key*
+- there should be at least 1 method for the 'hits' metric
+- the field `billing_address` should be added to the Account model in **Settings > Fields Definitions**
+
 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

@@ -5,9 +5,10 @@ module ThreeScale
     autoload :Client, '3scale/api/client'
     autoload :HttpClient, '3scale/api/http_client'
 
-    def self.new(endpoint:, provider_key:)
+    def self.new(endpoint:, provider_key:, verify_ssl: true)
       http_client = HttpClient.new(endpoint: endpoint,
-                                   provider_key: provider_key)
+                                   provider_key: provider_key,
+                                   verify_ssl: verify_ssl)
       Client.new(http_client)
     end
   end

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

@@ -101,6 +101,16 @@ module ThreeScale
         extract(entity: 'service', from: response)
       end
 
+      # @api public
+      # @return [Hash]
+      # @param [Fixnum] service_id Service ID
+      # @param [Hash] attributes Service Attributes
+      # @option attributes [String] :name Service Name
+      def update_service(service_id, attributes)
+        response = http_client.put("/admin/api/services/#{service_id}", body: { service: attributes })
+        extract(entity: 'service', from: response)
+      end
+
       # @api public
       # @return [Hash]
       # @param [Fixnum] service_id Service ID

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

@@ -1,18 +1,20 @@
 require 'json'
 require 'uri'
 require 'net/http'
+require 'openssl'
 
 module ThreeScale
   module API
     class HttpClient
       attr_reader :endpoint, :admin_domain, :provider_key, :headers, :format
 
-      def initialize(endpoint:, provider_key:, format: :json)
+      def initialize(endpoint:, provider_key:, format: :json, verify_ssl: true)
         @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)
+        @http.verify_mode = OpenSSL::SSL::VERIFY_NONE unless verify_ssl
 
         @headers = {
           'Accept' => "application/#{format}",

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

@@ -1,5 +1,5 @@
 module ThreeScale
   module API
-    VERSION = '0.1.5'.freeze
+    VERSION = '0.1.6'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: 3scale-api
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Michal Cichra
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-23 00:00:00.000000000 Z
+date: 2018-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: API Client for 3scale APIs