3scale_client 2.4.0 → 2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19f4ab95abe489a21be3179370e39eff488ee4ce
-  data.tar.gz: e9cff93cb9a39f429a2cbd9fb181a5a323b6d518
+  metadata.gz: 5238de4c88e0a7855f14b85f3fc667954a3c1d84
+  data.tar.gz: dbaf66645cf58a69fb8af3126145bac76b7fe5f9
 SHA512:
-  metadata.gz: 75ca5b9124b2eee69e3e8df07a28cdaf8778d858238175b679f4440d1d52b50eda5d3fb0475e8c2602826f3f7690117f2b487a34a3f969fdd4cbb7c526c145b7
-  data.tar.gz: 64f308475bcfe6a25fe80d38695795ce5409762edbc7caffeaf56c7fa44539791de49acaf55135b20c67d996858dddf87f8b7ef63e529fb15ec6bc25677906d9
+  metadata.gz: 2ec89086c7ea68dd50f5c5aa86338bfa45b9e5c079ef0526743f0db772ccb79ec67b97261e9ea92d088a6ed94dcef8de10038aba6796cbbbb2a52e2a6581a03e
+  data.tar.gz: efefcbfd4a99502127ee99dc0dddbec290d0216c0ce0e8f165a644d5967039db537570062db5161d2282fc5a71b2d8921a8f4ca6dc122cb474417ac1aeca2e65

data/lib/3scale/client.rb

@@ -3,6 +3,7 @@ require 'uri'
 require 'net/http'
 require 'nokogiri'
 require '3scale/client/http_client'
+require '3scale/client/version'
 
 require '3scale/response'
 require '3scale/authorize_response'

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

@@ -1,10 +1,12 @@
 require 'forwardable'
+require '3scale/client/version'
 
 module ThreeScale
   class Client
     class HTTPClient
       extend Forwardable
       def_delegators :@http, :get, :post, :use_ssl?, :active?
+      USER_CLIENT_HEADER = ['X-3scale-User-Agent', "plugin-ruby-v#{VERSION}"]
 
       def initialize(options)
 
@@ -18,11 +20,32 @@ module ThreeScale
         @http.ssl! if @secure
       end
 
-      class Persistent
+      class BaseClient
         def initialize(host)
+          @host = host
+        end
+
+        def get(path)
+          get = Net::HTTP::Get.new(path)
+          get.add_field(*USER_CLIENT_HEADER)
+          get.add_field('Host', @host)
+          get
+        end
+
+        def post(path, payload)
+          post = Net::HTTP::Post.new(path)
+          post.add_field(*USER_CLIENT_HEADER)
+          post.add_field('Host', @host)
+          post.set_form_data(payload)
+          post
+        end
+      end
+
+      class Persistent < BaseClient
+        def initialize(host)
+          super
           require 'net/http/persistent'
           @http = ::Net::HTTP::Persistent.new
-          @host = host
           @protocol = 'http'
         end
 
@@ -32,31 +55,26 @@ module ThreeScale
 
         def get(path)
           uri = full_uri(path)
-          get = Net::HTTP::Get.new(uri.request_uri)
-          @http.request(uri, get)
+          @http.request(uri, super)
         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)
+          @http.request(uri, super)
         end
 
         def full_uri(path)
           URI.join "#{@protocol}://#{@host}", path
         end
-
       end
 
-      class NetHttp
+      class NetHttp < BaseClient
         extend Forwardable
-        def_delegators :@http, :get, :post, :use_ssl?, :active?
+        def_delegators :@http, :use_ssl?, :active?
 
         def initialize(host)
-          @host = host
+          super
           @http = Net::HTTP.new(@host, 80)
         end
 
@@ -65,8 +83,12 @@ module ThreeScale
           @http.use_ssl = true
         end
 
+        def get(path)
+          @http.request(super)
+        end
+
         def post(path, payload)
-          @http.post(path, URI.encode_www_form(payload))
+          @http.request(super)
         end
       end
     end

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

@@ -1,5 +1,5 @@
 module ThreeScale
   class Client
-    VERSION = '2.4.0'
+    VERSION = '2.4.2'
   end
 end

data/test/client_test.rb

@@ -338,18 +338,18 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
     Net::HTTPSuccess.stubs(:===).with(http_response).returns(true)
 
     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'
+      '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)
+    .with('/transactions.xml', payload)
+    .returns(http_response)
 
     @client.report({:app_id    => 'foo',
                     :usage     => {'hits' => 1},
@@ -385,6 +385,53 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
     end
   end
 
+  def test_authorize_client_header_sent
+    success_body = '<?xml version="1.0" encoding="UTF-8"?><status><authorized>true</authorized><plan>Default</plan><usage_reports><usage_report metric="hits" period="minute"><period_start>2014-08-22 09:06:00 +0000</period_start><period_end>2014-08-22 09:07:00 +0000</period_end><max_value>5</max_value><current_value>0</current_value></usage_report></usage_reports></status>'
+    version       = ThreeScale::Client::VERSION
+    FakeWeb.register_uri(:get, "http://#{@host}/transactions/authorize.xml?provider_key=foo&app_id=foo",
+                         :status => ['200', 'OK'],
+                         :body   => success_body)
+
+    client = ThreeScale::Client.new(:provider_key => 'foo')
+    response = client.authorize(:app_id => 'foo')
+
+    assert response.success?
+    request = FakeWeb.last_request
+    assert_equal "plugin-ruby-v#{version}", request["X-3scale-User-Agent"]
+    assert_equal "su1.3scale.net", request["host"]
+
+  end
+
+  def test_report_client_header_sent
+    success_body = '<?xml version="1.0" encoding="UTF-8"?><status><authorized>true</authorized><plan>Default</plan><usage_reports><usage_report metric="hits" period="minute"><period_start>2014-08-22 09:06:00 +0000</period_start><period_end>2014-08-22 09:07:00 +0000</period_end><max_value>5</max_value><current_value>0</current_value></usage_report></usage_reports></status>'
+    version       = ThreeScale::Client::VERSION
+    FakeWeb.register_uri(:post, "http://#{@host}/transactions.xml",
+                         :status => ['200', 'OK'],
+                         :body   => success_body)
+    client = ThreeScale::Client.new(:provider_key => 'foo')
+    response = client.report({:app_id => 'abc', :usage => {'hits' => 1}})
+
+    request = FakeWeb.last_request
+    assert_equal "plugin-ruby-v#{version}", request["X-3scale-User-Agent"]
+    assert_equal "su1.3scale.net", request["host"]
+  end
+
+  def test_authrep_client_header_sent
+    success_body = '<?xml version="1.0" encoding="UTF-8"?><status><authorized>true</authorized><plan>Default</plan><usage_reports><usage_report metric="hits" period="minute"><period_start>2014-08-22 09:06:00 +0000</period_start><period_end>2014-08-22 09:07:00 +0000</period_end><max_value>5</max_value><current_value>0</current_value></usage_report></usage_reports></status>'
+    version       = ThreeScale::Client::VERSION
+    FakeWeb.register_uri(:get, "http://#{@host}/transactions/authrep.xml?provider_key=foo&app_id=abc&%5Busage%5D%5Bhits%5D=1",
+                         :status => ['200', 'OK'],
+                         :body   => success_body)
+
+    client = ThreeScale::Client.new(:provider_key => 'foo')
+    response = client.authrep(:app_id => 'abc')
+
+    assert response.success?
+    request = FakeWeb.last_request
+    assert_equal "plugin-ruby-v#{version}", request["X-3scale-User-Agent"]
+    assert_equal "su1.3scale.net", request["host"]
+  end
+
   private
 
   #OPTIMIZE this tricky test helper relies on fakeweb catching the urls requested by the client
@@ -414,4 +461,4 @@ class ThreeScale::PersistentClientTest < ThreeScale::ClientTest
   def client(options = {})
     ThreeScale::Client.new({:provider_key => '1234abcd', :persistent => true}.merge(options))
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: 3scale_client
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.4.2
 platform: ruby
 authors:
 - Michal Cichra
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-13 00:00:00.000000000 Z
+date: 2014-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler