3scale_client 2.3.4 → 2.4.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f95988b20e7b5a97d35e78533ebcf14c1fbbe79
-  data.tar.gz: c53f311c11d7026ebd7209623623ae7647c17826
+  metadata.gz: ca13a0b71b091111263b305b227d8384e3648e53
+  data.tar.gz: 204c15465a171d3c181f72e7f7877155ca77933c
 SHA512:
-  metadata.gz: 3f1952038035863de0ee38e63eff23f16f32bdb2d779ada36193b9f1ea204331743c99fb6c9d8004f8f9fe8cae27dc1905d4f9bbcb1b28fd796e8e32ee9bfe48
-  data.tar.gz: a8f67924fb05935f4113102b41fcb321fbec2fca212ff2a5bab234b12cb3264e3e05a7d43b947b1bdccadf379490deb6daf07f7e6fb270093a6ccc5b470b2798
+  metadata.gz: 245f5ad62823a036a60fb6c1209f87053bd084fda544b0be17be338f4dfdde45e88931cd1241071115ddc40ce5c4ed6a3f409616c25681fe8e0544ec8111facc
+  data.tar.gz: 003b18dd48bcc5117169e6326bb9e7a268cf7e6e92f97de2d8d0a9669ec4f80141b8c99d9b8638c566e24b0907bc3053826d84dee30bb84ce051a1cfbf3a679f

data/.travis.yml

@@ -1,5 +1,16 @@
 language: ruby
+cache: bundler
 rvm:
-  - '1.9.3'
-  - '2.0.0'
-  - 'jruby'
+- 1.9.3
+- 2.0.0
+- 2.1.1
+- 2.1.2
+- jruby
+matrix:
+  include:
+  - rvm: jruby
+    env: JRUBY_OPTS="--2.0"
+env:
+  global:
+    - TEST_3SCALE_APP_IDS=4d4b20b9 TEST_3SCALE_APP_KEYS=ecce202ecc2eb8dc7a499c34a34d5987
+    - secure: VSElS0KvnufcZKStV7kj6xHFEiWvQkpxk1IEuhKq5JqywniN/6ScaNUFxbBKrOUrqhzXIRUCteBP2wvYRjlNhLFZSnYskzh7dLkOp/WV+WK6KjrdflTiF6UTxW4pBSsg6YDJ/wWJlmwsPVty1pRvOE3ru6uco+dTWCCLn4BvWqc=

data/3scale_client.gemspec

@@ -23,5 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rdoc"
   spec.add_development_dependency "fakeweb"
   spec.add_development_dependency "mocha"
+  spec.add_development_dependency "net-http-persistent"
   spec.add_dependency 'nokogiri'
 end

data/Rakefile

@@ -9,7 +9,7 @@ require 'rake/testtask'
 require 'rdoc/task'
 
 desc 'Default: run unit tests.'
-task :default => :test
+task :default => %w[test benchmark]
 
 desc 'Run unit tests.'
 Rake::TestTask.new(:test) do |t|
@@ -17,6 +17,10 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = true
 end
 
+task :benchmark do
+  system 'ruby', '-Ilib', 'test/benchmark.rb'
+end
+
 desc 'Generate documentation.'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'

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

@@ -0,0 +1,74 @@
+require 'forwardable'
+
+module ThreeScale
+  class Client
+    class HTTPClient
+      extend Forwardable
+      def_delegators :@http, :get, :post, :use_ssl?, :active?
+
+      def initialize(options)
+
+        @secure = !!options[:secure]
+        @host = options.fetch(:host)
+        @persistent = options[:persistent]
+
+        backend_class = @persistent ? Persistent : NetHttp
+
+        @http = backend_class.new(@host)
+        @http.ssl! if @secure
+      end
+
+      class Persistent
+        def initialize(host)
+          require 'net/http/persistent'
+          @http = ::Net::HTTP::Persistent.new
+          @host = host
+          @protocol = 'http'
+        end
+
+        def ssl!
+          @protocol = 'https'
+        end
+
+        def get(path)
+          uri = full_uri(path)
+          get = Net::HTTP::Get.new(uri.request_uri)
+          @http.request(uri, get)
+        end
+
+
+        def post(path, payload)
+          uri = full_uri(path)
+          post = Net::HTTP::Post.new uri.path
+          post.set_form_data(payload)
+
+          @http.request(uri, post)
+        end
+
+        def full_uri(path)
+          URI.join "#{@protocol}://#{@host}", path
+        end
+
+      end
+
+      class NetHttp
+        extend Forwardable
+        def_delegators :@http, :get, :post, :use_ssl?, :active?
+
+        def initialize(host)
+          @host = host
+          @http = Net::HTTP.new(@host, 80)
+        end
+
+        def ssl!
+          @http = Net::HTTP.new(@host, 443)
+          @http.use_ssl = true
+        end
+
+        def post(path, payload)
+          @http.post(path, URI.encode_www_form(payload))
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 module ThreeScale
   class Client
-    VERSION = '2.3.4'
+    VERSION = '2.4.0.pre.1'
   end
 end

data/lib/3scale/client.rb

@@ -2,6 +2,7 @@ require 'cgi'
 require 'uri'
 require 'net/http'
 require 'nokogiri'
+require '3scale/client/http_client'
 
 require '3scale/response'
 require '3scale/authorize_response'
@@ -45,11 +46,13 @@ module ThreeScale
       end
 
       @provider_key = options[:provider_key]
-      @host = options[:host] || DEFAULT_HOST
+
+      @host = options[:host] ||= DEFAULT_HOST
+
+      @http = ThreeScale::Client::HTTPClient.new(options)
     end
 
-    attr_reader :provider_key
-    attr_reader :host
+    attr_reader :provider_key, :host, :http
 
     # Authorize and report an application.
     # TODO (in the mean time read authorize comments or head over to https://support.3scale.net/reference/activedocs#operation/66 for details
@@ -81,8 +84,7 @@ module ThreeScale
         path += "&#{log.join('&')}"
       end
 
-      uri = URI.parse("http://#{host}#{path}")
-      http_response = Net::HTTP.get_response(uri)
+      http_response = @http.get(path)
 
       case http_response
       when Net::HTTPSuccess,Net::HTTPConflict
@@ -139,8 +141,7 @@ module ThreeScale
       payload = encode_transactions(transactions)
       payload['provider_key'] = CGI.escape(provider_key)
 
-      uri = URI.parse("http://#{host}/transactions.xml")
-      http_response = Net::HTTP.post_form(uri, payload)
+      http_response = @http.post('/transactions.xml', payload)
 
       case http_response
       when Net::HTTPSuccess
@@ -185,8 +186,7 @@ module ThreeScale
     def authorize(options)
       path = "/transactions/authorize.xml" + options_to_params(options, ALL_PARAMS)
 
-      uri = URI.parse("http://#{host}#{path}")
-      http_response = Net::HTTP.get_response(uri)
+      http_response = @http.get(path)
 
       case http_response
       when Net::HTTPSuccess,Net::HTTPConflict
@@ -232,8 +232,7 @@ module ThreeScale
     def oauth_authorize(options)
       path = "/transactions/oauth_authorize.xml" + options_to_params(options, OAUTH_PARAMS)
 
-      uri = URI.parse("http://#{host}#{path}")
-      http_response = Net::HTTP.get_response(uri)
+      http_response = @http.get(path)
 
       case http_response
       when Net::HTTPSuccess,Net::HTTPConflict

data/test/benchmark.rb

@@ -0,0 +1,21 @@
+require 'benchmark'
+
+require '3scale/client'
+
+provider_key = ENV['TEST_3SCALE_PROVIDER_KEY']
+
+client = ThreeScale::Client.new(:provider_key => provider_key)
+persistent_client = ThreeScale::Client.new(:provider_key => provider_key, :persistent => true)
+persistent_ssl_client = ThreeScale::Client.new(:provider_key => provider_key, :secure => true, :persistent => true)
+ssl_client = ThreeScale::Client.new(:provider_key => provider_key, :secure => true)
+
+auth = { :app_id => ENV['TEST_3SCALE_APP_IDS'], :app_key => ENV['TEST_3SCALE_APP_KEYS'] }
+
+N = 10
+
+Benchmark.bmbm do |x|
+  x.report('http') { N.times{ client.authorize(auth) } }
+  x.report('http+persistent') { N.times{ persistent_client.authorize(auth) } }
+  x.report('https+persistent') { N.times{ persistent_ssl_client.authorize(auth) } }
+  x.report('https') { N.times{ ssl_client.authorize(auth) } }
+end

data/test/client_test.rb

@@ -1,15 +1,20 @@
 require 'test/unit'
 require 'fakeweb'
-require 'mocha'
+require 'mocha/setup'
 
 require '3scale/client'
 
 class ThreeScale::ClientTest < Test::Unit::TestCase
+
+  def client(options = {})
+    ThreeScale::Client.new({:provider_key => '1234abcd'}.merge(options))
+  end
+
   def setup
     FakeWeb.clean_registry
     FakeWeb.allow_net_connect = false
 
-    @client = ThreeScale::Client.new(:provider_key => '1234abcd')
+    @client = client
     @host   = ThreeScale::Client::DEFAULT_HOST
   end
 
@@ -31,12 +36,32 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
     assert_equal 'example.com', client.host
   end
 
+  def test_default_protocol
+    client = ThreeScale::Client.new(:provider_key => 'test')
+    assert_equal false, client.http.use_ssl?
+  end
+
+  def test_insecure_protocol
+    client = ThreeScale::Client.new(:provider_key => 'test', :secure => false)
+    assert_equal false, client.http.use_ssl?
+  end
+
+  def test_secure_protocol
+    client = ThreeScale::Client.new(:provider_key => 'test', :secure => true)
+    assert_equal true, client.http.use_ssl?
+  end
+
   def test_authrep_usage_is_encoded
     assert_authrep_url_with_params "&%5Busage%5D%5Bmethod%5D=666"
 
     @client.authrep({:usage => {:method=> 666}})
   end
 
+  def test_secure_authrep
+    assert_secure_authrep_url_with_params
+    client(:secure => true).authrep({})
+  end
+
   def test_authrep_usage_values_are_encoded
     assert_authrep_url_with_params "&%5Busage%5D%5Bhits%5D=%230"
 
@@ -62,9 +87,9 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
   end
 
   #TODO these authrep tests
-  def test_authrep_supports_api_key_auth_mode; end
-  def test_authrep_log_is_encoded;end
-  def test_authrep_passes_all_params_to_backend;end
+  # def test_authrep_supports_api_key_auth_mode; end
+  # def test_authrep_log_is_encoded;end
+  # def test_authrep_passes_all_params_to_backend;end
 
   def test_successful_authorize
     body = '<status>
@@ -283,7 +308,7 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
     assert_equal 'application with id="foo" was not found', response.error_message
   end
 
-  def test_authorize_with_server_error
+  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
@@ -312,16 +337,19 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
     http_response = stub
     Net::HTTPSuccess.stubs(:===).with(http_response).returns(true)
 
-    Net::HTTP.expects(:post_form).
-      with(anything,
-           'provider_key'                 => '1234abcd',
-           'transactions[0][app_id]'      => 'foo',
-           'transactions[0][usage][hits]' => '1',
-           'transactions[0][timestamp]'   => CGI.escape('2010-04-27 15:42:17 0200'),
-           'transactions[1][app_id]'      => 'bar',
-           'transactions[1][usage][hits]' => '1',
-           'transactions[1][timestamp]'   => CGI.escape('2010-04-27 15:55:12 0200')).
-      returns(http_response)
+    payload = {
+        'transactions[0][app_id]'      => 'foo',
+        'transactions[0][timestamp]'   => CGI.escape('2010-04-27 15:42:17 0200'),
+        'transactions[0][usage][hits]' => '1',
+        'transactions[1][app_id]'      => 'bar',
+        'transactions[1][timestamp]'   => CGI.escape('2010-04-27 15:55:12 0200'),
+        'transactions[1][usage][hits]' => '1',
+        'provider_key'                 => '1234abcd'
+    }
+
+    @client.http.expects(:post)
+      .with('/transactions.xml', payload)
+      .returns(http_response)
 
     @client.report({:app_id    => 'foo',
                     :usage     => {'hits' => 1},
@@ -362,8 +390,8 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
   #OPTIMIZE this tricky test helper relies on fakeweb catching the urls requested by the client
   # it is brittle: it depends in the correct order or params in the url
   #
-  def assert_authrep_url_with_params(str)
-    authrep_url = "http://#{@host}/transactions/authrep.xml?provider_key=#{@client.provider_key}"
+  def assert_authrep_url_with_params(str, protocol = 'http')
+    authrep_url = "#{protocol}://#{@host}/transactions/authrep.xml?provider_key=#{@client.provider_key}"
     params = str # unless str.scan(/log/)
     params << "&%5Busage%5D%5Bhits%5D=1" unless params.scan(/usage.*hits/)
     parsed_authrep_url = URI.parse(authrep_url + params)
@@ -376,4 +404,14 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
     # this is the actual assertion, if fakeweb raises the client is submiting with wrong params
     FakeWeb.register_uri(:get, parsed_authrep_url, :status => ['200', 'OK'], :body => body)
   end
+
+  def assert_secure_authrep_url_with_params(str = '&%5Busage%5D%5Bhits%5D=1')
+    assert_authrep_url_with_params(str, 'https')
+  end
+end
+
+class ThreeScale::PersistentClientTest < ThreeScale::ClientTest
+  def client(options = {})
+    ThreeScale::Client.new({:provider_key => '1234abcd', :persistent => true}.merge(options))
+  end
 end

data/test/persistence_test.rb

@@ -0,0 +1,30 @@
+require '3scale/client'
+require 'test/unit'
+
+if ENV['TEST_3SCALE_PROVIDER_KEY'] && ENV['TEST_3SCALE_APP_IDS'] && ENV['TEST_3SCALE_APP_KEYS']
+  class ThreeScale::PersistenceTest < Test::Unit::TestCase
+    def setup
+      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)
+
+      if defined?(FakeWeb)
+        FakeWeb.allow_net_connect = true
+      end
+    end
+
+    def test_authorize
+      assert @client.authorize(:app_id => @app_id, :app_key => @app_key).success?
+    end
+
+    def test_keepalive_disconnect
+      assert @client.authorize(:app_id => @app_id, :app_key => @app_key).success?
+      sleep 70
+      assert @client.authorize(:app_id => @app_id, :app_key => @app_key).success?
+    end
+  end
+end
+

data/test/remote_test.rb

@@ -21,6 +21,14 @@ if ENV['TEST_3SCALE_PROVIDER_KEY'] &&
       end
     end
 
+    def test_app_ids_are_passed
+      assert @app_ids.length > 0, 'expected TEST_3SCALE_APP_IDS to contain app ids'
+    end
+
+    def test_app_keys_are_passed
+      assert @app_keys.length > 0, 'expected TEST_3SCALE_APP_KEYS to contain app keys'
+    end
+
     def test_successful_authrep
       @app_keys.each do |app_key|
         response = @client.authrep(:app_id => @app_ids[0], :app_key => app_key,
@@ -30,6 +38,11 @@ if ENV['TEST_3SCALE_PROVIDER_KEY'] &&
       end
     end
 
+    def test_successful_secure_authrep
+      @client = ThreeScale::Client.new(:provider_key => @provider_key, :secure => true)
+      test_successful_authrep
+    end
+
 
     def test_failed_authrep
       response = @client.authrep(:app_id => 'invalid-id')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: 3scale_client
 version: !ruby/object:Gem::Version
-  version: 2.3.4
+  version: 2.4.0.pre.1
 platform: ruby
 authors:
 - Michal Cichra
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-09 00:00:00.000000000 Z
+date: 2014-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,6 +84,20 @@ dependencies:
     - - '>='
       - !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: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -117,10 +131,13 @@ files:
 - VERSION
 - lib/3scale/authorize_response.rb
 - lib/3scale/client.rb
+- lib/3scale/client/http_client.rb
 - lib/3scale/client/version.rb
 - lib/3scale/response.rb
 - lib/3scale_client.rb
+- test/benchmark.rb
 - test/client_test.rb
+- test/persistence_test.rb
 - test/remote_test.rb
 homepage: http://www.3scale.net
 licenses:
@@ -137,15 +154,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
       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.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Client for 3scale Web Service Management System API
 test_files:
+- test/benchmark.rb
 - test/client_test.rb
+- test/persistence_test.rb
 - test/remote_test.rb