3scale_client 2.9.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fd79baa77606faea09171e9c577d1694c17ea5a
-  data.tar.gz: 87ab11fd2aee6b31888ba5f22dcce546ee36d265
+  metadata.gz: a0c46a8b42107a91987d9861498f796287909fb5
+  data.tar.gz: 5d43b1ee44766fe2057fec8eea21f5a30a8ac83f
 SHA512:
-  metadata.gz: 172557eb19d4c5bdca48c89e8a3d8785defdafc0300aac49d5d6692b9d32279fb78d5b059b8aea936cd1fa636ff62c4a559a11fdc06f88ffb79407f829d48845
-  data.tar.gz: 631bea0687f9ae848ba1622ceb375edf27d82b039963651c8fb969e1a25e96ae350b27a21cb6f4bfa04155c851f15d5162e1de9c21cea77e32adf819f0518abc
+  metadata.gz: 1c3b09b26c8ec29367f68fc231b52c3d7af036d8360179b968d50d231a2a1332ba5b0c11139539e4af6a711cb2716fe47972eaa34e66fb4ba8addc29c876e33b
+  data.tar.gz: 3d3136b451d4694fc00291d013e07dd1fd562f4c605caf1bc32a7c4f1e5ca6c6bb9808eed46f54909d7e551fea5f7260363d6ef5c75aca9ef4f00b85f9d6c717

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [2.10.0] - 2016-11-25
+### Added
+- Added support for 3scale extensions (experimental or non-standard
+  features that are not part of the official API). You just need to
+  add the `:extensions` symbol and the value to the hash of options that
+  the client methods accept. The value is itself a hash containing the
+  parameter names as keys and the parameter values as values.
+
 ## [2.9.0] - 2016-10-21
 This version drops support for Ruby versions < 2.1 and JRuby < 9.1.1.0.
 

data/lib/3scale/client.rb

@@ -7,6 +7,7 @@ require '3scale/client/version'
 
 require '3scale/response'
 require '3scale/authorize_response'
+require '3scale/rack_query'
 
 module ThreeScale
   Error = Class.new(RuntimeError)
@@ -47,6 +48,9 @@ module ThreeScale
       'def report(transactions: [], service_id: nil).'.freeze
     private_constant :DEPRECATION_MSG_OLD_REPORT
 
+    EXTENSIONS_HEADER = '3scale-options'.freeze
+    private_constant :EXTENSIONS_HEADER
+
     def initialize(options)
       if options[:provider_key].nil? || options[:provider_key] =~ /^\s*$/
         raise ArgumentError, 'missing :provider_key'
@@ -69,6 +73,7 @@ module ThreeScale
 
       options_usage = options.delete :usage
       options_log   = options.delete :log
+      extensions    = options.delete :extensions
 
       options.each_pair do |param, value|
         path += "&#{param}=#{CGI.escape(value.to_s)}"
@@ -86,7 +91,8 @@ module ThreeScale
         path += "&#{log.join('&')}"
       end
 
-      http_response = @http.get(path)
+      headers = extensions_to_header extensions if extensions
+      http_response = @http.get(path, headers: headers)
 
       case http_response
       when Net::HTTPSuccess,Net::HTTPConflict
@@ -148,7 +154,7 @@ module ThreeScale
     # The signature of this method is a bit complicated because we decided to
     # keep backwards compatibility with a previous version of the method:
     # def report(*transactions)
-    def report(*reports, transactions: [], service_id: nil, **rest)
+    def report(*reports, transactions: [], service_id: nil, extensions: nil, **rest)
       if (!transactions || transactions.empty?) && rest.empty?
         raise ArgumentError, 'no transactions to report'
       end
@@ -164,7 +170,8 @@ module ThreeScale
       payload['provider_key'] = CGI.escape(provider_key)
       payload['service_id'] = CGI.escape(service_id.to_s) if service_id
 
-      http_response = @http.post('/transactions.xml', payload)
+      headers = extensions_to_header extensions if extensions
+      http_response = @http.post('/transactions.xml', payload, headers: headers)
 
       case http_response
       when Net::HTTPSuccess
@@ -189,6 +196,7 @@ module ThreeScale
     #   usage::      predicted usage. It is optional. It is a hash where the keys are metrics
     #                and the values their predicted usage.
     #                Example: {'hits' => 1, 'my_metric' => 100}
+    #   extensions:: Optional. Hash of extension keys and values.
     #
     # == Return
     #
@@ -210,9 +218,11 @@ module ThreeScale
     #   end
     #
     def authorize(options)
+      extensions = options.delete :extensions
       path = "/transactions/authorize.xml" + options_to_params(options, ALL_PARAMS)
 
-      http_response = @http.get(path)
+      headers = extensions_to_header extensions if extensions
+      http_response = @http.get(path, headers: headers)
 
       case http_response
       when Net::HTTPSuccess,Net::HTTPConflict
@@ -259,9 +269,11 @@ module ThreeScale
     #   end
     #
     def oauth_authorize(options)
+      extensions = options.delete :extensions
       path = "/transactions/oauth_authorize.xml" + options_to_params(options, OAUTH_PARAMS)
 
-      http_response = @http.get(path)
+      headers = extensions_to_header extensions if extensions
+      http_response = @http.get(path, headers: headers)
 
       case http_response
       when Net::HTTPSuccess,Net::HTTPConflict
@@ -275,10 +287,8 @@ module ThreeScale
 
     private
 
-    # The support for the 'hierarchy' param is experimental. Its support is not
-    # guaranteed for future versions.
-    OAUTH_PARAMS = [:app_id, :app_key, :service_id, :redirect_url, :usage, :hierarchy]
-    ALL_PARAMS = [:user_key, :app_id, :app_key, :service_id, :redirect_url, :usage, :hierarchy]
+    OAUTH_PARAMS = [:app_id, :app_key, :service_id, :redirect_url, :usage]
+    ALL_PARAMS = [:user_key, :app_id, :app_key, :service_id, :redirect_url, :usage]
     REPORT_PARAMS = [:user_key, :app_id, :service_id, :timestamp]
 
     def options_to_params(options, allowed_keys)
@@ -382,5 +392,10 @@ module ThreeScale
       response.error!(node.content.to_s.strip, node['code'].to_s.strip)
       response
     end
+
+    # Encode extensions header
+    def extensions_to_header(extensions)
+      { EXTENSIONS_HEADER => RackQuery.encode(extensions) }
+    end
   end
 end

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

@@ -39,20 +39,32 @@ module ThreeScale
           @port = port
         end
 
-        def get_request(path)
+        def get_request(path, headers: nil)
           get = Net::HTTP::Get.new(path)
           get.add_field(*USER_CLIENT_HEADER)
           get.add_field('Host', @host)
+          add_request_headers(get, headers) if headers
           get
         end
 
-        def post_request(path, payload)
+        def post_request(path, payload, headers: nil)
           post = Net::HTTP::Post.new(path)
           post.add_field(*USER_CLIENT_HEADER)
           post.add_field('Host', @host)
+          add_request_headers(post, headers) if headers
           post.set_form_data(payload)
           post
         end
+
+        private
+
+        def add_request_headers(req, headers)
+          if headers
+            headers.each do |hk, hv|
+              req.add_field(hk, hv)
+            end
+          end
+        end
       end
 
       class NetHttpPersistent < BaseClient
@@ -77,15 +89,15 @@ module ThreeScale
           @protocol = 'https'
         end
 
-        def get(path)
+        def get(path, headers: nil)
           uri = full_uri(path)
-          @http.request(uri, get_request(path))
+          @http.request(uri, get_request(path, headers: headers))
         end
 
 
-        def post(path, payload)
+        def post(path, payload, headers: nil)
           uri = full_uri(path)
-          @http.request(uri, post_request(path, payload))
+          @http.request(uri, post_request(path, payload, headers: headers))
         end
 
         def full_uri(path)
@@ -107,12 +119,12 @@ module ThreeScale
           @http.use_ssl = true
         end
 
-        def get(path)
-          @http.request get_request(path)
+        def get(path, headers: nil)
+          @http.request get_request(path, headers: headers)
         end
 
-        def post(path, payload)
-          @http.request post_request(path, payload)
+        def post(path, payload, headers: nil)
+          @http.request post_request(path, payload, headers: headers)
         end
       end
 

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

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

data/lib/3scale/rack_query.rb

@@ -0,0 +1,37 @@
+# A simple module to encode hashes of param keys and values as expected by
+# Rack in its nested queries parsing.
+#
+module RackQuery
+  class << self
+    def encode(hash)
+      hash.flat_map do |hk, hv|
+        encode_value(CGI.escape(hk.to_s), hv)
+      end.join('&'.freeze)
+    end
+
+    private
+
+    def encode_value(rack_param, val)
+      if val.is_a? Array
+        encode_array(rack_param, val)
+      elsif val.is_a? Hash
+        encode_hash(rack_param, val)
+      else
+        "#{rack_param}=#{CGI.escape(val.to_s)}"
+      end
+    end
+
+    def encode_array(rack_param, val)
+      rack_param = rack_param + '[]'
+      val.flat_map do |v|
+        encode_value(rack_param, v)
+      end
+    end
+
+    def encode_hash(rack_param, val)
+      val.flat_map do |k, v|
+        encode_value(rack_param + "[#{CGI.escape(k.to_s)}]", v)
+      end
+    end
+  end
+end

data/test/client_test.rb

@@ -267,7 +267,7 @@ class ThreeScale::ClientTest < MiniTest::Test
     # calls.
     urls = [:authorize, :authrep, :oauth_authorize].inject({}) do |acc, method|
       acc[method] = "http://#{@host}/transactions/#{method}.xml?"\
-                    "provider_key=1234abcd&app_id=foo&hierarchy=1"
+                    "provider_key=1234abcd&app_id=foo"
       acc[method] << "&%5Busage%5D%5Bhits%5D=1" if method == :authrep
       acc
     end
@@ -317,7 +317,7 @@ class ThreeScale::ClientTest < MiniTest::Test
 
     urls.each do |method, url|
       FakeWeb.register_uri(:get, url, :status => ['200', 'OK'], :body => body)
-      response = @client.send(method, :app_id => 'foo', :hierarchy => 1)
+      response = @client.send(method, :app_id => 'foo', extensions: { :hierarchy => 1 })
       assert_equal response.hierarchy, { 'parent1' => ['child1', 'child2'],
                                          'parent2' => ['child3'] }
     end
@@ -702,6 +702,65 @@ class ThreeScale::ClientTest < MiniTest::Test
     assert_equal "su1.3scale.net", request["host"]
   end
 
+  EXTENSIONS_HASH = {
+    'a special &=key' => 'a special =&value',
+    'ary' => [1,2],
+    'a hash' => { one: 'one', two: 'two' },
+    'combined' =>
+      { v: 'v', nested: [1, { h: [ { hh: [ { hhh: :deep }, 'val' ] } ], h2: :h2 } ] }
+  }
+  private_constant :EXTENSIONS_HASH
+  EXTENSIONS_STR  = "a+special+%26%3Dkey=a+special+%3D%26value&ary[]=1&ary[]=2&" \
+                    "a+hash[one]=one&a+hash[two]=two&combined[v]=v&" \
+                    "combined[nested][]=1&combined[nested][][h][][hh][][hhh]=deep&" \
+                    "combined[nested][][h][][hh][]=val&combined[nested][][h2]=h2".freeze
+  private_constant :EXTENSIONS_STR
+
+  def test_authorize_with_extensions
+    body = '<status>
+              <authorized>true</authorized>
+              <plan>Ultimate</plan>
+            </status>'
+    FakeWeb.register_uri(:get,
+                         "http://#{@host}/transactions/authorize.xml?provider_key=1234abcd&app_id=foo",
+                         :status => ['200', 'OK'], body: body)
+
+    @client.authorize(:app_id => 'foo', extensions: EXTENSIONS_HASH)
+
+    request = FakeWeb.last_request
+    assert_equal EXTENSIONS_STR, request[ThreeScale::Client.const_get('EXTENSIONS_HEADER')]
+  end
+
+  def test_authrep_with_extensions
+    body = '<status>
+              <authorized>true</authorized>
+              <plan>Ultimate</plan>
+            </status>'
+    FakeWeb.register_uri(:get,
+                         "http://#{@host}/transactions/authrep.xml?provider_key=1234abcd&app_id=foo&%5Busage%5D%5Bhits%5D=1",
+                         :status => ['200', 'OK'], body: body)
+
+    @client.authrep(:app_id => 'foo', extensions: EXTENSIONS_HASH)
+
+    request = FakeWeb.last_request
+    assert_equal EXTENSIONS_STR, request['3scale-options']
+  end
+
+  def test_report_with_extensions
+    FakeWeb.register_uri(:post, "http://#{@host}/transactions.xml",
+                         :status => ['200', 'OK'])
+
+    transactions = [{ :app_id    => 'app_id_1',
+                      :usage     => { 'hits' => 1 },
+                      :timestamp => '2016-07-18 15:42:17 0200' }]
+
+    @client.report(transactions: transactions, service_id: 'a_service_id',
+                   extensions: EXTENSIONS_HASH)
+
+    request = FakeWeb.last_request
+    assert_equal EXTENSIONS_STR, request['3scale-options']
+  end
+
   private
 
   #OPTIMIZE this tricky test helper relies on fakeweb catching the urls requested by the client

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: 3scale_client
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 2.10.0
 platform: ruby
 authors:
 - Michal Cichra
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-21 00:00:00.000000000 Z
+date: 2016-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -172,13 +172,13 @@ files:
 - LICENCE
 - README.md
 - Rakefile
-- VERSION
 - gemfiles/rack_1.gemfile
 - lib/3scale/authorize_response.rb
 - lib/3scale/client.rb
 - lib/3scale/client/http_client.rb
 - lib/3scale/client/version.rb
 - lib/3scale/middleware.rb
+- lib/3scale/rack_query.rb
 - lib/3scale/response.rb
 - lib/3scale_client.rb
 - test/benchmark.rb

data/VERSION

@@ -1 +0,0 @@
-2.8.2