3scale_client 2.2.10 → 2.3.0

data/3scale_client.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{3scale_client}
-  s.version = "2.2.10"
+  s.version = "2.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Adam Cigánek", "Tiago Macedo"]
-  s.description = %q{This gem allows to easily connect an application that provides a Web Service with the 3scale API Management System to authorize its users and report the usage.
+  s.authors = ["Adam Cigánek", "Tiago Macedo", "Joaquin Rivera Padron (joahking)"]
+  s.description = %q{Ruby client for 3scale platform. 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 information at http://www.3scale.net/ or http://support.3scale.net/.
 }
   s.email = %q{adam@3scale.net tiago@3scale.net}
   s.extra_rdoc_files = [

data/README.rdoc

@@ -21,7 +21,7 @@ and do a bundle install.
 
 If you are using Rails' config.gems, put this into your config/environment.rb
 
-  config.gem '3scale_client
+  config.gem '3scale_client'
 
 Otherwise, require the gem in whatever way is natural to your framework of choice.
 
@@ -33,6 +33,36 @@ First, create an instance of the client, giving it your provider API key:
 
 Because the object is stateless, you can create just one and store it globally.
 
+==== Authrep
+
+Authrep is a 'one-shot' operation to authorize an application and report the associated transaction at the same time.
+The main difference between this call and the regular authorize call is that usage will be reported if the authorization is successful. Read more about authrep at the [active docs page on the 3scale's support site](https://support.3scale.net/reference/activedocs#operation/66)
+
+You can make request to this backend operation like this:
+
+  response = client.authrep(:app_id => "the app id", :app_key => "the app key")
+
+Then call the +success?+ method on the returned object to see if the authorization was
+successful.
+
+  if response.success?
+    # All fine, the usage will be reported automatically. Proceeed.
+  else
+    # Something's wrong with this application.
+  end
+
+The example is using the app_id authentication pattern, but you can also use other patterns.
+
+=== Using Varnish to speed up things
+
+3scale provides a [varnish module](https://github.com/3scale/libvmod-3scale) to cache the responses of its backend to help you achieve a close to zero latency. Go and install the module and [configure it the easy way](https://github.com/3scale/libvmod-3scale/blob/master/vcl/default_3scale_simple.vcl)
+
+When that's done all you have to do is to initialize your 3scale client pointing to the location of your varnish, by passing the host parameter to it, like this:
+
+  client = ThreeScale::Client.new(:provider_key => "your provider key", :host => "your.varnish.net:8080")
+
+that's it, your API should now be authorized and reported for you, and all that at full speed.
+
 === Authorize
 
 To authorize an application, call the +authorize+ method passing it the application's id and

data/Rakefile

@@ -33,9 +33,9 @@ begin
     gemspec.description = <<END
 This gem allows to easily connect an application that provides a Web Service with the 3scale API Management System to authorize it's users and report the usage.
 END
-    gemspec.email    = 'adam@3scale.net'
+    gemspec.email    = 'support@3scale.net'
     gemspec.homepage = 'http://www.3scale.net'
-    gemspec.authors  = ['Adam Cigánek']
+    gemspec.authors  = ['Adam Cigánek', 'Tiago Macedo', 'Joaquin Rivera Padron (joahking)']
 
     gemspec.add_dependency 'nokogiri'
   end

data/lib/3scale/client.rb

@@ -51,6 +51,49 @@ module ThreeScale
     attr_reader :provider_key
     attr_reader :host
 
+    # 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
+    #
+    def authrep(options)
+      path = "/transactions/authrep.xml?provider_key=#{CGI.escape(provider_key)}"
+
+      options_usage = options.delete :usage
+      options_log   = options.delete :log
+
+      options.each_pair do |param, value|
+        path += "&#{param}=#{CGI.escape(value.to_s)}"
+      end
+
+      options_usage ||= {:hits => 1}
+      usage = []
+      options_usage.each_pair do |metric, value|
+        escaped_metric = CGI.escape "[usage][#{metric}]"
+        usage << "#{escaped_metric}=#{CGI.escape(value.to_s)}"
+      end
+      path += "&#{usage.join('&')}"
+
+      if options_log
+        log = []
+        options_log.each_pair do |key, value|
+          escaped_key = CGI.escape "[log][#{key}]"
+          log << "#{escaped_key}=#{CGI.escape(value)}"
+        end
+        path += "&#{log.join('&')}"
+      end
+
+      uri = URI.parse("http://#{host}#{path}")
+      http_response = Net::HTTP.get_response(uri)
+
+      case http_response
+      when Net::HTTPSuccess,Net::HTTPConflict
+        build_authorize_response(http_response.body)
+      when Net::HTTPClientError
+        build_error_response(http_response.body)
+      else
+        raise ServerError.new(http_response)
+      end
+    end
+
     # Report transaction(s).
     #
     # == Parameters

data/test/client_test.rb

@@ -25,6 +25,41 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
     assert_equal 'su1.3scale.net', client.host
   end
 
+  def test_custom_host
+    client = ThreeScale::Client.new(:provider_key => '1234abcd', :host => "example.com")
+
+    assert_equal 'example.com', client.host
+  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_authrep_usage_values_are_encoded
+    assert_authrep_url_with_params "&%5Busage%5D%5Bhits%5D=%230"
+
+    @client.authrep({:usage => {:hits => "#0"}})
+  end
+
+  def test_authrep_usage_defaults_to_hits_1
+    assert_authrep_url_with_params "&%5Busage%5D%5Bhits%5D=1"
+
+    @client.authrep({})
+  end
+
+  def test_authrep_supports_app_id_app_key_auth_mode
+    assert_authrep_url_with_params "&app_id=appid&app_key=appkey&%5Busage%5D%5Bhits%5D=1"
+
+    @client.authrep(:app_id => "appid", :app_key => "appkey")
+  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_successful_authorize
     body = '<status>
               <authorized>true</authorized>
@@ -303,4 +338,24 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
       @client.report({:app_id => 'foo', :usage => {'hits' => 1}})
     end
   end
+
+  private
+
+  #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}"
+    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)
+    # set to have the client working
+    body = '<status>
+              <authorized>true</authorized>
+              <plan>Ultimate</plan>
+            </status>'
+
+    # 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
 end

data/test/remote_test.rb

@@ -21,6 +21,23 @@ if ENV['TEST_3SCALE_PROVIDER_KEY'] &&
       end
     end
 
+    def test_successful_authrep
+      @app_keys.each do |app_key|
+        response = @client.authrep(:app_id => @app_ids[0], :app_key => app_key,
+                                   :usage => {:hits => 2},
+                                   :log => {:request => "a/a", :response => "b/b", :code => "c/c"})
+        assert response.success?, "AuthRep should succeed for app_id=#{@app_ids[0]} and app_key=#{app_key}, but it failed with: '#{response.error_message}'"
+      end
+    end
+
+
+    def test_failed_authrep
+      response = @client.authrep(:app_id => 'invalid-id')
+      assert !response.success?
+      assert_equal 'application_not_found',                          response.error_code
+      assert_equal 'application with id="invalid-id" was not found', response.error_message
+    end
+
     def test_successful_authorize
       @app_keys.each do |app_key|
         response = @client.authorize(:app_id => @app_ids[0], :app_key => app_key)

metadata

@@ -1,20 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: 3scale_client
 version: !ruby/object:Gem::Version
-  version: 2.2.10
+  version: 2.3.0
   prerelease: 
 platform: ruby
 authors:
 - Adam Cigánek
 - Tiago Macedo
+- Joaquin Rivera Padron (joahking)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-06 00:00:00.000000000 Z
+date: 2012-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &24631000 !ruby/object:Gem::Requirement
+  requirement: &20757120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +23,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *24631000
+  version_requirements: *20757120
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &24630620 !ruby/object:Gem::Requirement
+  requirement: &20756740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +34,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *24630620
+  version_requirements: *20756740
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &24630160 !ruby/object:Gem::Requirement
+  requirement: &20756260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +45,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *24630160
+  version_requirements: *20756260
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &24629740 !ruby/object:Gem::Requirement
+  requirement: &20773160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +56,11 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *24629740
-description: ! 'This gem allows to easily connect an application that provides a Web
-  Service with the 3scale API Management System to authorize its users and report
-  the usage.
+  version_requirements: *20773160
+description: ! 'Ruby client for 3scale platform. 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
+  information at http://www.3scale.net/ or http://support.3scale.net/.
 
 '
 email: adam@3scale.net tiago@3scale.net