3scale_client 2.4.2 → 2.5.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5238de4c88e0a7855f14b85f3fc667954a3c1d84
-  data.tar.gz: dbaf66645cf58a69fb8af3126145bac76b7fe5f9
+  metadata.gz: ab7fb31122fd7138a87cb410914466949e6f7034
+  data.tar.gz: 077f77ad68034e85e57a32d529aaaffb0078b9fd
 SHA512:
-  metadata.gz: 2ec89086c7ea68dd50f5c5aa86338bfa45b9e5c079ef0526743f0db772ccb79ec67b97261e9ea92d088a6ed94dcef8de10038aba6796cbbbb2a52e2a6581a03e
-  data.tar.gz: efefcbfd4a99502127ee99dc0dddbec290d0216c0ce0e8f165a644d5967039db537570062db5161d2282fc5a71b2d8921a8f4ca6dc122cb474417ac1aeca2e65
+  metadata.gz: 1a987bb2bdc1cfcfa1472ca5c5180fa6211ac781bf8a264afbb01083a83ef7cfb1f64ab45e7753928790967f86144dd076a84fcb64c336bedff7c5a72ce30deb
+  data.tar.gz: ae03b5bac34c9da2b53d11445ecf795ead9ff875f6840e44234f3a09029405ee1cf6b00fae2c92883158d41db60e6e709b8f6d703e6a0b3de6f04f95d96d4515

data/.travis.yml

@@ -3,8 +3,8 @@ cache: bundler
 rvm:
 - 1.9.3
 - 2.0.0
-- 2.1.1
-- 2.1.2
+- 2.1
+- 2.2
 - jruby
 matrix:
   include:

data/3scale_client.gemspec

@@ -18,11 +18,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rdoc"
   spec.add_development_dependency "fakeweb"
   spec.add_development_dependency "mocha"
   spec.add_development_dependency "net-http-persistent"
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rack'
   spec.add_dependency 'nokogiri'
 end

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+## [Unreleased][unreleased]
+### Fixed
+### Added
+
+## [2.5.0.pre1] - 2015-01-29
+### Added
+- Native support for persistent connections (without net-http-persistent gem)
+- `ThreeScale::Middleware` for Rack

data/Gemfile

@@ -1,2 +1,7 @@
 source "https://rubygems.org"
 gemspec
+
+# TODO: when travis bundler version is >= 1.7.11
+# platform :mri_22 do
+#  gem 'minitest'
+# end

data/README.md

@@ -6,9 +6,9 @@
 3scale is an API Infrastructure service which handles API Keys, Rate Limiting, Analytics, Billing Payments and Developer Management. Includes a configurable API dashboard and developer portal CMS. More product stuff at http://www.3scale.net/, support information at http://support.3scale.net/.
 
 ### Tutorials
-Plugin Setup: https://support.3scale.net/howtos/api-configuration/plugin-setup  
-Rate Limiting: https://support.3scale.net/howtos/basics/provision-rate-limits  
-Analytics Setup: https://support.3scale.net/quickstarts/3scale-api-analytics  
+Plugin Setup: https://support.3scale.net/howtos/api-configuration/plugin-setup
+Rate Limiting: https://support.3scale.net/howtos/basics/provision-rate-limits
+Analytics Setup: https://support.3scale.net/quickstarts/3scale-api-analytics
 
 ## Installation
 
@@ -252,5 +252,13 @@ human readable error description:
 ```ruby
 response.error_code    # "provider_key_invalid"
 response.error_message # "provider key \"foo\" is invalid"
-```  
-  
+```
+
+
+## Rack Middleware
+
+You can use our Rack middleware to automatically authenticate your Rack applications.
+
+```ruby
+use ThreeScale::Middleware, provider_key, :user_key # or :app_id
+```

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

@@ -8,31 +8,43 @@ module ThreeScale
       def_delegators :@http, :get, :post, :use_ssl?, :active?
       USER_CLIENT_HEADER = ['X-3scale-User-Agent', "plugin-ruby-v#{VERSION}"]
 
-      def initialize(options)
+      class PersistenceNotAvailable < LoadError
+        def initialize(*)
+          super 'persistence is available only on Ruby 2.0 or with net-http-persistent gem'.freeze
+        end
+      end
 
+      def initialize(options)
         @secure = !!options[:secure]
         @host = options.fetch(:host)
         @persistent = options[:persistent]
 
-        backend_class = @persistent ? Persistent : NetHttp
+        backend_class = @persistent ? self.class.persistent_backend : NetHttp or raise PersistenceNotAvailable
+        backend_class.prepare
 
         @http = backend_class.new(@host)
         @http.ssl! if @secure
       end
 
       class BaseClient
+        def self.available?
+        end
+
+        def self.prepare
+        end
+
         def initialize(host)
           @host = host
         end
 
-        def get(path)
+        def get_request(path)
           get = Net::HTTP::Get.new(path)
           get.add_field(*USER_CLIENT_HEADER)
           get.add_field('Host', @host)
           get
         end
 
-        def post(path, payload)
+        def post_request(path, payload)
           post = Net::HTTP::Post.new(path)
           post.add_field(*USER_CLIENT_HEADER)
           post.add_field('Host', @host)
@@ -41,10 +53,20 @@ module ThreeScale
         end
       end
 
-      class Persistent < BaseClient
+      class NetHttpPersistent < BaseClient
+        def self.available?
+          prepare
+          true
+        rescue LoadError
+          false
+        end
+
+        def self.prepare
+          require 'net/http/persistent'
+        end
+
         def initialize(host)
           super
-          require 'net/http/persistent'
           @http = ::Net::HTTP::Persistent.new
           @protocol = 'http'
         end
@@ -55,13 +77,13 @@ module ThreeScale
 
         def get(path)
           uri = full_uri(path)
-          @http.request(uri, super)
+          @http.request(uri, get_request(path))
         end
 
 
         def post(path, payload)
           uri = full_uri(path)
-          @http.request(uri, super)
+          @http.request(uri, post_request(path, payload))
         end
 
         def full_uri(path)
@@ -84,13 +106,54 @@ module ThreeScale
         end
 
         def get(path)
-          @http.request(super)
+          @http.request get_request(path)
         end
 
         def post(path, payload)
-          @http.request(super)
+          @http.request post_request(path, payload)
+        end
+      end
+
+      class NetHttpKeepAlive < NetHttp
+        HTTP_CONNECTION = 'connection'.freeze
+        HTTP_KEEPALIVE = 'keep-alive'.freeze
+
+        MARK_KEEPALIVE = ->(req) { req[HTTP_CONNECTION] ||= HTTP_KEEPALIVE }
+
+        private_constant :MARK_KEEPALIVE
+        private_constant :HTTP_CONNECTION
+        private_constant :HTTP_KEEPALIVE
+
+        def self.available?
+          Net::HTTP.instance_method(:keep_alive_timeout)
+        rescue NameError
+          false
+        end
+
+        def initialize(*)
+          super
+          @http.start
+        end
+
+        def ssl!
+          super
+          @http.start
         end
+
+        def get_request(*)
+          super.tap(&MARK_KEEPALIVE)
+        end
+
+        def post_request(*)
+          super.tap(&MARK_KEEPALIVE)
+        end
+      end
+
+      class << self
+        attr_accessor :persistent_backend
       end
+
+      self.persistent_backend = [NetHttpKeepAlive, NetHttpPersistent].find(&:available?)
     end
   end
 end

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

@@ -1,5 +1,5 @@
 module ThreeScale
   class Client
-    VERSION = '2.4.2'
+    VERSION = '2.5.0.pre1'
   end
 end

data/lib/3scale/middleware.rb

@@ -0,0 +1,88 @@
+require '3scale_client'
+
+require 'rack/utils'
+require 'rack/auth/basic'
+
+module ThreeScale
+  class Middleware < Rack::Auth::Basic
+    attr_reader :client, :authenticator
+
+    DEFAULT_OPTIONS = { secure: true, persistent: true }
+
+    def initialize(app, provider_key, mode, options = {})
+      options = DEFAULT_OPTIONS.merge(options).merge(provider_key: provider_key)
+      @client = ThreeScale::Client.new(options)
+
+      super(app, '3scale Authentication', &authenticator_for(mode))
+    end
+
+    private
+
+    def authenticator_for(mode)
+      klass = case mode
+                when :user_key then UserKeyAuthenticator
+                when :app_id then AppIdAuthenticator
+                when nil then NilAuthenticator
+                else raise "Unknown auth mode #{mode}"
+              end
+
+      klass.new(@client)
+    end
+
+    class BaseAuthenticator
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def provided?(username, password)
+        username && !username.empty? && password && !password.empty?
+      end
+
+      def credentials(*)
+        nil
+      end
+
+      def to_proc
+        lambda { |username, password|
+          return false unless provided?(username, password)
+
+          auth = credentials(username, password)
+          # Do not do authrep for now, as rate limitin requires more work:
+          # we would need to send headers with remaining limits & proper codes
+          response = @client.authorize(auth)
+          response.success?
+        }
+      end
+    end
+
+    private_constant :BaseAuthenticator
+
+    class UserKeyAuthenticator < BaseAuthenticator
+      def provided?(username, *)
+        username && !username.empty?
+      end
+
+      def credentials(username, *)
+        { user_key: username }
+      end
+    end
+
+    class AppIdAuthenticator < BaseAuthenticator
+      def credentials(username, password)
+        { app_id: username, app_key: password }
+      end
+    end
+
+    class NilAuthenticator < BaseAuthenticator
+      def provided?(*)
+        true
+      end
+
+      def to_proc
+        proc { true }
+      end
+    end
+  end
+end

data/test/client_test.rb

@@ -1,10 +1,11 @@
-require 'test/unit'
+require 'minitest/autorun'
+
 require 'fakeweb'
 require 'mocha/setup'
 
 require '3scale/client'
 
-class ThreeScale::ClientTest < Test::Unit::TestCase
+class ThreeScale::ClientTest < MiniTest::Unit::TestCase
 
   def client(options = {})
     ThreeScale::Client.new({:provider_key => '1234abcd'}.merge(options))
@@ -19,7 +20,7 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
   end
 
   def test_raises_exception_if_provider_key_is_missing
-    assert_raise ArgumentError do
+    assert_raises ArgumentError do
       ThreeScale::Client.new({})
     end
   end
@@ -206,7 +207,7 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
   def test_authorize_with_server_error
     FakeWeb.register_uri(:get, "http://#{@host}/transactions/authorize.xml?provider_key=1234abcd&app_id=foo", :status => ['500', 'Internal Server Error'], :body => 'OMG! WTF!')
 
-    assert_raise ThreeScale::ServerError do
+    assert_raises ThreeScale::ServerError do
       @client.authorize(:app_id => 'foo')
     end
   end
@@ -311,13 +312,13 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
   def test_oauth_authorize_with_server_error
     FakeWeb.register_uri(:get, "http://#{@host}/transactions/oauth_authorize.xml?provider_key=1234abcd&app_id=foo", :status => ['500', 'Internal Server Error'], :body => 'OMG! WTF!')
 
-    assert_raise ThreeScale::ServerError do
+    assert_raises ThreeScale::ServerError do
       @client.oauth_authorize(:app_id => 'foo')
     end
   end
 
   def test_report_raises_an_exception_if_no_transactions_given
-    assert_raise ArgumentError do
+    assert_raises ArgumentError do
       @client.report
     end
   end
@@ -380,7 +381,7 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
                          :status => ['500', 'Internal Server Error'],
                          :body   => 'OMG! WTF!')
 
-    assert_raise ThreeScale::ServerError do
+    assert_raises ThreeScale::ServerError do
       @client.report({:app_id => 'foo', :usage => {'hits' => 1}})
     end
   end
@@ -457,8 +458,16 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
   end
 end
 
-class ThreeScale::PersistentClientTest < ThreeScale::ClientTest
+class ThreeScale::NetHttpPersistentClientTest < ThreeScale::ClientTest
   def client(options = {})
+    ThreeScale::Client::HTTPClient.persistent_backend = ThreeScale::Client::HTTPClient::NetHttpPersistent
     ThreeScale::Client.new({:provider_key => '1234abcd', :persistent => true}.merge(options))
   end
-end
+end
+
+class ThreeScale::NetHttpKeepAliveClientTest < ThreeScale::NetHttpPersistentClientTest
+  def client(options = {})
+    ThreeScale::Client::HTTPClient.persistent_backend = ThreeScale::Client::HTTPClient::NetHttpKeepAlive
+    super
+  end
+end

data/test/middleware_test.rb

@@ -0,0 +1,45 @@
+require 'minitest/autorun'
+require '3scale/middleware'
+require 'mocha/setup'
+
+class ThreeScale::MiddlewareTest < MiniTest::Unit::TestCase
+
+  def setup
+    @app = ->(_env) {  [ 200, {}, ['']] }
+    @provider_key = 'fake-provider-key'
+  end
+
+  def client(credentials, response = success)
+    mock('client') do
+      expects(:authorize).with(credentials).returns(response)
+    end
+  end
+
+  def success
+    mock('response', success?: true)
+  end
+
+  def test_user_key_authenticator
+    credentials = { user_key: 'user' }
+    authenticator = ThreeScale::Middleware::UserKeyAuthenticator.new(client(credentials))
+    assert authenticator.provided?('user', nil)
+    assert_equal credentials, authenticator.credentials('user')
+    assert authenticator.to_proc.call('user', nil)
+  end
+
+  def test_app_id_authenticator
+    credentials = { app_id: 'app', app_key: 'key' }
+    authenticator = ThreeScale::Middleware::AppIdAuthenticator.new(client(credentials))
+
+    assert authenticator.provided?('app', 'key')
+    assert_equal credentials, authenticator.credentials('app', 'key')
+    assert authenticator.to_proc.call('app', 'key')
+  end
+
+  def test_nil_authenticator
+    authenticator = ThreeScale::Middleware::NilAuthenticator.new(mock)
+    assert authenticator.provided?
+    assert_equal(nil, authenticator.credentials)
+    assert authenticator.to_proc.call(nil, nil)
+  end
+end

data/test/persistence_test.rb

@@ -1,15 +1,19 @@
+require 'minitest/autorun'
+
 require '3scale/client'
-require 'test/unit'
+require 'mocha/setup'
 
 if ENV['TEST_3SCALE_PROVIDER_KEY'] && ENV['TEST_3SCALE_APP_IDS'] && ENV['TEST_3SCALE_APP_KEYS']
-  class ThreeScale::PersistenceTest < Test::Unit::TestCase
+  class ThreeScale::NetHttpPersistenceTest < MiniTest::Unit::TestCase
     def setup
+      ThreeScale::Client::HTTPClient.persistent_backend = ThreeScale::Client::HTTPClient::NetHttpPersistent
+
       provider_key = ENV['TEST_3SCALE_PROVIDER_KEY']
 
       @app_id = ENV['TEST_3SCALE_APP_IDS']
       @app_key = ENV['TEST_3SCALE_APP_KEYS']
 
-      @client = ThreeScale::Client.new(:provider_key => provider_key, :persistence => true)
+      @client = ThreeScale::Client.new(provider_key: provider_key, persistence: true)
 
       if defined?(FakeWeb)
         FakeWeb.allow_net_connect = true
@@ -26,5 +30,13 @@ if ENV['TEST_3SCALE_PROVIDER_KEY'] && ENV['TEST_3SCALE_APP_IDS'] && ENV['TEST_3S
       assert @client.authorize(:app_id => @app_id, :app_key => @app_key).success?
     end
   end
+
+
+  class ThreeScale::NetHttpKeepaliveTest < ThreeScale::NetHttpPersistenceTest
+    def setup
+      ThreeScale::Client::HTTPClient.persistent_backend = ThreeScale::Client::HTTPClient::NetHttpKeepAlive
+      super
+    end
+  end
 end
 

data/test/remote_test.rb

@@ -1,10 +1,10 @@
-require 'test/unit'
+require 'minitest/autorun'
 require '3scale/client'
 
 if ENV['TEST_3SCALE_PROVIDER_KEY'] &&
    ENV['TEST_3SCALE_APP_IDS']      &&
    ENV['TEST_3SCALE_APP_KEYS']
-  class ThreeScale::RemoteTest < Test::Unit::TestCase
+  class ThreeScale::RemoteTest < MiniTest::Unit::TestCase
     def setup
       @provider_key = ENV['TEST_3SCALE_PROVIDER_KEY']
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: 3scale_client
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.5.0.pre1
 platform: ruby
 authors:
 - Michal Cichra
@@ -12,104 +12,132 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-01 00:00:00.000000000 Z
+date: 2015-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: This gem allows to easily connect an application that provides a Web
@@ -121,9 +149,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - 3scale_client.gemspec
+- CHANGELOG.md
 - Gemfile
 - LICENCE
 - README.md
@@ -133,10 +162,12 @@ files:
 - lib/3scale/client.rb
 - lib/3scale/client/http_client.rb
 - lib/3scale/client/version.rb
+- lib/3scale/middleware.rb
 - lib/3scale/response.rb
 - lib/3scale_client.rb
 - test/benchmark.rb
 - test/client_test.rb
+- test/middleware_test.rb
 - test/persistence_test.rb
 - test/remote_test.rb
 homepage: http://www.3scale.net
@@ -149,22 +180,23 @@ 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'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Client for 3scale Web Service Management System API
 test_files:
 - test/benchmark.rb
 - test/client_test.rb
+- test/middleware_test.rb
 - test/persistence_test.rb
 - test/remote_test.rb