3scale_client 2.8.2 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28ffdb9dae79d7cf57bba5fd70090b08ae4e7294
-  data.tar.gz: 8e47fe8d96fc80bc7cc21c5550b177db5c86a01c
+  metadata.gz: 8fd79baa77606faea09171e9c577d1694c17ea5a
+  data.tar.gz: 87ab11fd2aee6b31888ba5f22dcce546ee36d265
 SHA512:
-  metadata.gz: 4fb00544bd08be909781d624dcacb0fe8b997d1000e74a0339b720530624695e462adfdaa5b138b838256bfeb6613f36f85150c1c8e58b438fc49ec700c6a08a
-  data.tar.gz: 41e02fdb1210e8aeede906e3bb34134bd90da8e719ba9ab197f252ba7a5429c2dae7af24c03149f65785bac56dc33b65c801cdba448210fd88b0f9c2233d8225
+  metadata.gz: 172557eb19d4c5bdca48c89e8a3d8785defdafc0300aac49d5d6692b9d32279fb78d5b059b8aea936cd1fa636ff62c4a559a11fdc06f88ffb79407f829d48845
+  data.tar.gz: 631bea0687f9ae848ba1622ceb375edf27d82b039963651c8fb969e1a25e96ae350b27a21cb6f4bfa04155c851f15d5162e1de9c21cea77e32adf819f0518abc

data/.travis.yml

@@ -1,27 +1,24 @@
+sudo: required
+dist: trusty
 language: ruby
 cache: bundler
-sudo: false
 rvm:
-- 2.0.0
-- 2.1
-- 2.2
-- 2.3.0
-- jruby
+  - 2.1
+  - 2.2
+  - 2.3
 gemfile:
   - Gemfile
-  - gemfiles/rack_1.gemfile
 matrix:
   exclude:
-  - rvm: 2.0.0
-    gemfile: Gemfile
   - rvm: 2.1
     gemfile: Gemfile
-  - rvm: 2.2
-    gemfile: Gemfile
-  - rvm: jruby
+  include:
+  - rvm: 2.1
+    gemfile: gemfiles/rack_1.gemfile
+  - rvm: jruby-9.1.5.0
     gemfile: Gemfile
+    jdk: oraclejdk8
 env:
   global:
     - TEST_3SCALE_APP_IDS=4d4b20b9 TEST_3SCALE_APP_KEYS=ecce202ecc2eb8dc7a499c34a34d5987
     - secure: VSElS0KvnufcZKStV7kj6xHFEiWvQkpxk1IEuhKq5JqywniN/6ScaNUFxbBKrOUrqhzXIRUCteBP2wvYRjlNhLFZSnYskzh7dLkOp/WV+WK6KjrdflTiF6UTxW4pBSsg6YDJ/wWJlmwsPVty1pRvOE3ru6uco+dTWCCLn4BvWqc=
-    - JRUBY_OPTS="--2.0"

data/3scale_client.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.0'
+  spec.required_ruby_version = '>= 2.1'
 
-  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rdoc"
   spec.add_development_dependency "fakeweb"

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [2.9.0] - 2016-10-21
+This version drops support for Ruby versions < 2.1 and JRuby < 9.1.1.0.
+
+### Added
+- Added method `ThreeScale::Client::AuthorizeResponse#limits_exceeded?`
+  to check whether an authorization is denied and is so because at least
+  one metric went over the limits.
+
 ## [2.8.2] - 2016-10-18
 ### Added
 - Added support for retrieving metric hierarchies in authorize calls.

data/README.md

@@ -12,7 +12,8 @@ Analytics Setup: https://support.3scale.net/quickstarts/3scale-api-analytics
 
 ## Installation
 
-This library is distributed as a gem:
+This library is distributed as a gem, for which Ruby 2.1 or JRuby 9.1.1.0 are
+minimum requirements:
 ```sh
 gem install 3scale_client
 ```
@@ -92,19 +93,19 @@ The example is using the app_id authentication pattern, but you can also use oth
 class ApplicationController < ActionController
   # Call the authenticate method on each request to the API
   before_filter :authenticate
-        
+
   # You only need to instantiate a new Client once and store it as a global variable
   # You should store your provider key in the environment because this key is secret!
   def create_client
-    @@threescale_client ||= ThreeScale::Client.new(:provider_key => ENV['PROVIDER_KEY'])    
+    @@threescale_client ||= ThreeScale::Client.new(:provider_key => ENV['PROVIDER_KEY'])
   end
-        
-  # To record usage, create a new metric in your application plan. You will use the 
-  # "system name" that you specifed on the metric/method to pass in as the key to the usage hash. 
-  # The key needs to be a symbol. 
+
+  # To record usage, create a new metric in your application plan. You will use the
+  # "system name" that you specifed on the metric/method to pass in as the key to the usage hash.
+  # The key needs to be a symbol.
   # A way to pass the metric is to add a parameter that will pass the name of the metric/method along
   def authenticate
-    response = create_client.authrep(:app_id => params["app_id"], 
+    response = create_client.authrep(:app_id => params["app_id"],
                                      :app_key => params["app_key"],
                                      :usage => { params[:metric].to_sym => 1 })
     if response.success?

data/lib/3scale/authorize_response.rb

@@ -27,6 +27,13 @@ module ThreeScale
       end
     end
 
+    # These 2 constants are defined according to what the 3scale
+    # backend returns in the response of authorize calls.
+    LIMITS_EXCEEDED = 'limits_exceeded'.freeze
+    private_constant :LIMITS_EXCEEDED
+    LIMITS_EXCEEDED_MSG = 'usage limits are exceeded'.freeze
+    private_constant :LIMITS_EXCEEDED_MSG
+
     attr_accessor :plan
     attr_accessor :app_key
     attr_accessor :redirect_url
@@ -51,5 +58,11 @@ module ThreeScale
     def add_metric_to_hierarchy(metric_name, children)
       @hierarchy[metric_name] = children
     end
+
+    # The response already specifies whether any usage report (if present)
+    # is over the limits, so use that instead of scanning the reports.
+    def limits_exceeded?
+      error_code == LIMITS_EXCEEDED || error_message == LIMITS_EXCEEDED_MSG
+    end
   end
 end

data/lib/3scale/client.rb

@@ -92,7 +92,7 @@ module ThreeScale
       when Net::HTTPSuccess,Net::HTTPConflict
         build_authorize_response(http_response.body)
       when Net::HTTPClientError
-        build_error_response(http_response.body)
+        build_error_response(http_response.body, AuthorizeResponse)
       else
         raise ServerError.new(http_response)
       end
@@ -218,7 +218,7 @@ module ThreeScale
       when Net::HTTPSuccess,Net::HTTPConflict
         build_authorize_response(http_response.body)
       when Net::HTTPClientError
-        build_error_response(http_response.body)
+        build_error_response(http_response.body, AuthorizeResponse)
       else
         raise ServerError.new(http_response)
       end
@@ -267,7 +267,7 @@ module ThreeScale
       when Net::HTTPSuccess,Net::HTTPConflict
         build_authorize_response(http_response.body)
       when Net::HTTPClientError
-        build_error_response(http_response.body)
+        build_error_response(http_response.body, AuthorizeResponse)
       else
         raise ServerError.new(http_response)
       end
@@ -374,11 +374,11 @@ module ThreeScale
       response
     end
 
-    def build_error_response(body)
+    def build_error_response(body, klass = Response)
       doc = Nokogiri::XML(body)
       node = doc.at_css('error')
 
-      response = Response.new
+      response = klass.new
       response.error!(node.content.to_s.strip, node['code'].to_s.strip)
       response
     end

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

@@ -1,5 +1,5 @@
 module ThreeScale
   class Client
-    VERSION = '2.8.2'
+    VERSION = '2.9.0'
   end
 end

data/test/client_test.rb

@@ -119,6 +119,7 @@ class ThreeScale::ClientTest < MiniTest::Test
     response = @client.authorize(:app_id => 'foo')
 
     assert response.success?
+    assert !response.limits_exceeded?
     assert_equal 'Ultimate', response.plan
     assert_equal 2, response.usage_reports.size
 
@@ -188,8 +189,9 @@ class ThreeScale::ClientTest < MiniTest::Test
     response = @client.authorize(:app_id => 'foo')
 
     assert !response.success?
+    assert response.limits_exceeded?
     assert_equal 'usage limits are exceeded', response.error_message
-    assert response.usage_reports[0].exceeded?
+    assert response.usage_reports.any? { |report| report.exceeded? }
   end
 
   def test_authorize_with_invalid_app_id
@@ -200,6 +202,7 @@ class ThreeScale::ClientTest < MiniTest::Test
     response = @client.authorize(:app_id => 'foo')
 
     assert !response.success?
+    assert !response.limits_exceeded?
     assert_equal 'application_not_found',                   response.error_code
     assert_equal 'application with id="foo" was not found', response.error_message
   end
@@ -227,6 +230,7 @@ class ThreeScale::ClientTest < MiniTest::Test
                                  :usage => { 'metric1' => 1, 'metric2' => 2 })
 
     assert response.success?
+    assert !response.limits_exceeded?
   end
 
   def test_authorize_with_usage_and_limits_exceeded
@@ -254,6 +258,7 @@ class ThreeScale::ClientTest < MiniTest::Test
     response = @client.authorize(:app_id => 'foo', :usage => { 'hits' => 1 })
 
     assert !response.success?
+    assert response.limits_exceeded?
     assert_equal 'usage limits are exceeded', response.error_message
   end
 
@@ -347,6 +352,7 @@ class ThreeScale::ClientTest < MiniTest::Test
 
     response = @client.oauth_authorize(:app_id => 'foo', :redirect_url => "http://localhost:8080/oauth/oauth_redirect")
     assert response.success?
+    assert !response.limits_exceeded?
 
     assert_equal '883bdb8dbc3b6b77dbcf26845560fdbb', response.app_key
     assert_equal 'http://localhost:8080/oauth/oauth_redirect', response.redirect_url
@@ -399,8 +405,9 @@ class ThreeScale::ClientTest < MiniTest::Test
     response = @client.oauth_authorize(:app_id => 'foo')
 
     assert !response.success?
+    assert response.limits_exceeded?
     assert_equal 'usage limits are exceeded', response.error_message
-    assert response.usage_reports[0].exceeded?
+    assert response.usage_reports.any? { |report| report.exceeded? }
   end
 
   def test_oauth_authorize_with_invalid_app_id
@@ -411,6 +418,7 @@ class ThreeScale::ClientTest < MiniTest::Test
     response = @client.oauth_authorize(:app_id => 'foo')
 
     assert !response.success?
+    assert !response.limits_exceeded?
     assert_equal 'application_not_found',                   response.error_code
     assert_equal 'application with id="foo" was not found', response.error_message
   end
@@ -439,6 +447,7 @@ class ThreeScale::ClientTest < MiniTest::Test
         :app_id => 'foo', :usage => { 'metric1' => 1, 'metric2' => 2 })
 
     assert response.success?
+    assert !response.limits_exceeded?
   end
 
   def test_oauth_authorize_with_usage_and_limits_exceeded
@@ -467,6 +476,7 @@ class ThreeScale::ClientTest < MiniTest::Test
                                        :usage => { 'hits' => 1 })
 
     assert !response.success?
+    assert response.limits_exceeded?
     assert_equal 'usage limits are exceeded', response.error_message
   end
 
@@ -653,6 +663,7 @@ class ThreeScale::ClientTest < MiniTest::Test
     response = client.authorize(:app_id => 'foo')
 
     assert response.success?
+    assert !response.limits_exceeded?
     request = FakeWeb.last_request
     assert_equal "plugin-ruby-v#{version}", request["X-3scale-User-Agent"]
     assert_equal "su1.3scale.net", request["host"]
@@ -685,6 +696,7 @@ class ThreeScale::ClientTest < MiniTest::Test
     response = client.authrep(:app_id => 'abc')
 
     assert response.success?
+    assert !response.limits_exceeded?
     request = FakeWeb.last_request
     assert_equal "plugin-ruby-v#{version}", request["X-3scale-User-Agent"]
     assert_equal "su1.3scale.net", request["host"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: 3scale_client
 version: !ruby/object:Gem::Version
-  version: 2.8.2
+  version: 2.9.0
 platform: ruby
 authors:
 - Michal Cichra
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-18 00:00:00.000000000 Z
+date: 2016-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -20,14 +20,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -198,7 +198,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -206,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Client for 3scale Web Service Management System API