3scale_client 2.8.1 → 2.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a79b84280ee4de834649b3414dbbec268c2df8c
-  data.tar.gz: 2a97f59f1449f9fd7f9a44437827594b5d0ca342
+  metadata.gz: 28ffdb9dae79d7cf57bba5fd70090b08ae4e7294
+  data.tar.gz: 8e47fe8d96fc80bc7cc21c5550b177db5c86a01c
 SHA512:
-  metadata.gz: dcc864a4ec5df888603e3976e75a639bbeb25dcb2e8870b23955c72317be63f6ba0ce6895a4680d4e64c5f1d3fec23c9c80ab5d3711c9494c469f0999cc7fef7
-  data.tar.gz: 502b0293a51d9d23be62d33365dc33d8aaac9a3ff79d53d8e47c5ce49aa714b2ec392ac9881476c6d7e184baa81bc51d684ddd44d2843ed1d58923610b5121af
+  metadata.gz: 4fb00544bd08be909781d624dcacb0fe8b997d1000e74a0339b720530624695e462adfdaa5b138b838256bfeb6613f36f85150c1c8e58b438fc49ec700c6a08a
+  data.tar.gz: 41e02fdb1210e8aeede906e3bb34134bd90da8e719ba9ab197f252ba7a5429c2dae7af24c03149f65785bac56dc33b65c801cdba448210fd88b0f9c2233d8225

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [2.8.2] - 2016-10-18
+### Added
+- Added support for retrieving metric hierarchies in authorize calls.
+  This is an experimental feature and its support is not guaranteed for
+  future releases.
+
 ## [2.8.1] - 2016-10-11
 ### Changed
 - Improved parsing performance of the response of the authorize call.

data/VERSION

@@ -1 +1 @@
-2.8.1
+2.8.2

data/lib/3scale/authorize_response.rb

@@ -2,16 +2,6 @@ require 'time'
 
 module ThreeScale
   class AuthorizeResponse < Response
-    def initialize
-      super
-      @usage_reports = []
-    end
-
-    attr_accessor :plan
-    attr_accessor :app_key
-    attr_accessor :redirect_url
-    attr_accessor :service_id
-
     class UsageReport
       attr_reader :metric
       attr_reader :period
@@ -37,10 +27,29 @@ module ThreeScale
       end
     end
 
+    attr_accessor :plan
+    attr_accessor :app_key
+    attr_accessor :redirect_url
+    attr_accessor :service_id
     attr_reader :usage_reports
+    attr_reader :hierarchy # Not part of the stable API
+
+    def initialize
+      super
+      @usage_reports = []
+
+      # hierarchy is a hash where the keys are metric names, and the values
+      # their children (array of metric names).
+      # Only metrics that have at least one child appear as keys.
+      @hierarchy = {}
+    end
 
     def add_usage_report(options)
       @usage_reports << UsageReport.new(options)
     end
+
+    def add_metric_to_hierarchy(metric_name, children)
+      @hierarchy[metric_name] = children
+    end
   end
-end
+end

data/lib/3scale/client.rb

@@ -275,8 +275,10 @@ module ThreeScale
 
     private
 
-    OAUTH_PARAMS = [:app_id, :app_key, :service_id, :redirect_url, :usage]
-    ALL_PARAMS = [:user_key, :app_id, :app_key, :service_id, :redirect_url, :usage]
+    # 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]
     REPORT_PARAMS = [:user_key, :app_id, :service_id, :timestamp]
 
     def options_to_params(options, allowed_keys)
@@ -363,6 +365,12 @@ module ThreeScale
                                   :max_value     => node.at('max_value').content.to_i)
       end
 
+      doc.css('hierarchy metric').each do |node|
+        metric_name = node['name'].to_s.strip
+        children = node['children'].to_s.strip.split(' ')
+        response.add_metric_to_hierarchy(metric_name, children)
+      end
+
       response
     end
 

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

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

data/test/client_test.rb

@@ -257,6 +257,67 @@ class ThreeScale::ClientTest < MiniTest::Test
     assert_equal 'usage limits are exceeded', response.error_message
   end
 
+  def test_hierarchy
+    # Hierarchies can be retrieved in authorize, authrep, and oauth_authorize
+    # 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"
+      acc[method] << "&%5Busage%5D%5Bhits%5D=1" if method == :authrep
+      acc
+    end
+
+    body = '<status>
+              <authorized>true</authorized>
+              <plan>Ultimate</plan>
+
+              <usage_reports>
+                <usage_report metric="parent1" period="day">
+                  <period_start>2016-01-01 00:00:00 +0000</period_start>
+                  <period_end>2016-01-02 00:00:00 +0000</period_end>
+                  <max_value>1000</max_value>
+                  <current_value>10</current_value>
+                </usage_report>
+                <usage_report metric="parent2" period="day">
+                  <period_start>2016-01-01 00:00:00 +0000</period_start>
+                  <period_end>2016-01-02 00:00:00 +0000</period_end>
+                  <max_value>100</max_value>
+                  <current_value>1</current_value>
+                </usage_report>
+                <usage_report metric="child1" period="day">
+                  <period_start>2016-01-01 00:00:00 +0000</period_start>
+                  <period_end>2016-01-02 00:00:00 +0000</period_end>
+                  <max_value>1000</max_value>
+                  <current_value>5</current_value>
+                </usage_report>
+                <usage_report metric="child2" period="day">
+                  <period_start>2016-01-01 00:00:00 +0000</period_start>
+                  <period_end>2016-01-02 00:00:00 +0000</period_end>
+                  <max_value>1000</max_value>
+                  <current_value>5</current_value>
+                </usage_report>
+                <usage_report metric="child3" period="day">
+                  <period_start>2016-01-01 00:00:00 +0000</period_start>
+                  <period_end>2016-01-02 00:00:00 +0000</period_end>
+                  <max_value>100</max_value>
+                  <current_value>5</current_value>
+                </usage_report>
+              </usage_reports>
+
+              <hierarchy>
+                <metric name="parent1" children="child1 child2" />
+                <metric name="parent2" children="child3" />
+              </hierarchy>
+            </status>'
+
+    urls.each do |method, url|
+      FakeWeb.register_uri(:get, url, :status => ['200', 'OK'], :body => body)
+      response = @client.send(method, :app_id => 'foo', :hierarchy => 1)
+      assert_equal response.hierarchy, { 'parent1' => ['child1', 'child2'],
+                                         'parent2' => ['child3'] }
+    end
+  end
+
   def test_successful_oauth_authorize
     body = '<status>
               <authorized>true</authorized>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: 3scale_client
 version: !ruby/object:Gem::Version
-  version: 2.8.1
+  version: 2.8.2
 platform: ruby
 authors:
 - Michal Cichra
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-11 00:00:00.000000000 Z
+date: 2016-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler