3scale_client 2.2.7 → 2.2.8

data/.gitignore

@@ -1 +1,3 @@
 pkg
+Gemfile.lock
+.*.swp

data/3scale_client.gemspec

@@ -5,14 +5,14 @@
 
 Gem::Specification.new do |s|
   s.name = %q{3scale_client}
-  s.version = "2.2.7"
+  s.version = "2.2.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Adam Cigánek", "Tiago Macedo"]
   s.date = %q{2011-01-27}
   s.description = %q{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.
 }
-  s.email = %q{adam@3scale.net}
+  s.email = %q{adam@3scale.net tiago@3scale.net}
   s.extra_rdoc_files = [
     "README.rdoc"
   ]
@@ -51,5 +51,9 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<nokogiri>, [">= 0"])
   end
+
+  s.add_development_dependency 'fakeweb'
+  s.add_development_dependency 'jeweler'
+  s.add_development_dependency 'mocha'
 end
 

data/README.rdoc

@@ -6,12 +6,18 @@ This library is distributed as a gem:
 
   gem install 3scale_client
 
-Or alternatively, download the source code from github: 
+Or alternatively, download the source code from github:
 http://github.com/3scale/3scale_ws_api_for_ruby
 
-If you are using Rails, put this into your config/environment.rb
+If you are using Bundler, please add this to your Gemfile:
 
-  config.gem "3scale_client"
+  gem '3scale_client', :require => '3scale/client'
+
+and do a bundle install.
+
+If you are using Rails' config.gems, put this into your config/environment.rb
+
+  config.gem "3scale_client", :lib => '3scale/client'
 
 Otherwise, require the gem in whatever way is natural to your framework of choice.
 
@@ -28,7 +34,7 @@ Because the object is stateless, you can create just one and store it globally.
 To authorize an application, call the +authorize+ method passing it the application's id and
 optionally a key:
 
-  response = client.authorize(:app_id => "the app id", :app_id => "the app key")
+  response = client.authorize(: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.
@@ -68,12 +74,23 @@ down by the metrics and usage limit periods.
   # If the limit is exceeded, this will be true, otherwise false:
   usage_report.exceeded?     # false
 
-If the authorization failed, the +error_code+ returns system error code and +error_message+ 
+If the authorization failed, the +error_code+ returns system error code and +error_message+
 human readable error description:
- 
+
   response.error_code    # "usage_limits_exceeded"
   response.error_message # "Usage limits are exceeded"
 
+=== OAuth Authorize
+
+To authorize an application with OAuth, call the +oauth_authorize+ method passing it the application's id.
+
+  response = client.authorize(:app_id => "the app id")
+
+If the authorization is successful, the response will contain the +app_key+ and +redirect_url+ defined for this application:
+
+  response.app_key
+  response.redirect_url
+
 === Report
 
 To report usage, use the +report+ method. You can report multiple transaction at the same time:
@@ -93,7 +110,7 @@ string has to be in a format parseable by the Time.parse method. For example:
 
   "2010-04-28 12:38:33 +0200"
 
-If the timestamp is not in UTC, you have to specify a time offset. That's the "+0200" 
+If the timestamp is not in UTC, you have to specify a time offset. That's the "+0200"
 (two hours ahead of the Universal Coordinate Time) in the example abowe.
 
 Then call the +success?+ method on the returned response object to see if the report was

data/Rakefile

@@ -1,8 +1,10 @@
 # encoding: utf-8
+require "rubygems"
+require "bundler/setup"
 
 require 'rake'
 require 'rake/testtask'
-require 'rake/rdoctask'
+require 'rdoc/task'
 
 desc 'Default: run unit tests.'
 task :default => :test
@@ -11,7 +13,6 @@ desc 'Run unit tests.'
 Rake::TestTask.new(:test) do |t|
   t.pattern = 'test/**/*_test.rb'
   t.verbose = true
-  t.ruby_opts << '-rubygems'
 end
 
 desc 'Generate documentation.'

data/VERSION

@@ -1 +1 @@
-2.2.4
+2.2.7

data/lib/3scale/authorize_response.rb

@@ -8,6 +8,8 @@ module ThreeScale
     end
 
     attr_accessor :plan
+    attr_accessor :app_key
+    attr_accessor :redirect_url
 
     class UsageReport
       attr_reader :metric
@@ -32,7 +34,7 @@ module ThreeScale
       def exceeded?
         current_value > max_value
       end
-    end      
+    end
 
     attr_reader :usage_reports
 

data/lib/3scale/client.rb

@@ -8,7 +8,7 @@ require '3scale/authorize_response'
 
 module ThreeScale
   Error = Class.new(RuntimeError)
-    
+
   class ServerError < Error
     def initialize(response)
       super('server error')
@@ -61,11 +61,11 @@ module ThreeScale
     #   app_id::    ID of the application to report the transaction for. This parameter is
     #               required.
     #   usage::     Hash of usage values. The keys are metric names and values are
-    #               correspoding numeric values. Example: {'hits' => 1, 'transfer' => 1024}. 
+    #               correspoding numeric values. Example: {'hits' => 1, 'transfer' => 1024}.
     #               This parameter is required.
     #   timestamp:: Timestamp of the transaction. This can be either a object of the
     #               ruby's Time class, or a string in the "YYYY-MM-DD HH:MM:SS" format
-    #               (if the time is in the UTC), or a string in 
+    #               (if the time is in the UTC), or a string in
     #               the "YYYY-MM-DD HH:MM:SS ZZZZZ" format, where the ZZZZZ is the time offset
     #               from the UTC. For example, "US Pacific Time" has offset -0800, "Tokyo"
     #               has offset +0900. This parameter is optional, and if not provided, equals
@@ -98,7 +98,7 @@ module ThreeScale
 
       uri = URI.parse("http://#{host}/transactions.xml")
       http_response = Net::HTTP.post_form(uri, payload)
-      
+
       case http_response
       when Net::HTTPSuccess
         build_report_response
@@ -112,7 +112,7 @@ module ThreeScale
     # Authorize an application.
     #
     # == Parameters
-    # 
+    #
     # Hash with options:
     #
     #   app_id::  id of the application to authorize. This is required.
@@ -157,11 +157,61 @@ module ThreeScale
       end
     end
 
+    # Authorize an application with OAuth.
+    #
+    # == Parameters
+    #
+    # Hash with options:
+    #
+    #   app_id::  id of the application to authorize. This is required.
+    #
+    # == Return
+    #
+    # A ThreeScale::AuthorizeResponse object. It's +success?+ method returns true if
+    # the authorization is successful, false otherwise. It contains additional information
+    # about the status of the usage. See the ThreeScale::AuthorizeResponse for more information.
+    #
+    # It also returns the app_key that corresponds to the given app_id
+    #
+    # In case of error, the +error_code+ returns code of the error and +error_message+
+    # human readable error description.
+    #
+    # In case of unexpected internal server error, this method raises a ThreeScale::ServerError
+    # exception.
+    #
+    # == Examples
+    #
+    #   response = client.authorize(:app_id => '1234')
+    #
+    #   if response.success?
+    #     # All good. Proceed...
+    #   end
+    #
+    def oauth_authorize(options)
+      path = "/transactions/oauth_authorize.xml" +
+        "?provider_key=#{CGI.escape(provider_key)}" +
+        "&app_id=#{CGI.escape(options[:app_id].to_s)}"
+      path += "&app_key=#{CGI.escape(options[:app_key])}" if options[:app_key]
+      path += "&redirect_url=#{CGI.escape(options[:redirect_url])}" if options[:redirect_url]
+
+      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
+
     private
 
     def encode_transactions(transactions)
       result = {}
-      
+
       transactions.each_with_index do |transaction, index|
         append_encoded_value(result, index, [:app_id],    transaction[:app_id])
         append_encoded_value(result, index, [:timestamp], transaction[:timestamp])
@@ -195,6 +245,11 @@ module ThreeScale
         response.error!(doc.at_css('reason').content)
       end
 
+      if doc.at_css('application')
+        response.app_key      = doc.at_css('application key').content.to_s.strip
+        response.redirect_url = doc.at_css('application redirect_url').content.to_s.strip
+      end
+
       response.plan = doc.at_css('plan').content.to_s.strip
 
       doc.css('usage_reports usage_report').each do |node|
@@ -212,7 +267,7 @@ module ThreeScale
     def build_error_response(body)
       doc = Nokogiri::XML(body)
       node = doc.at_css('error')
-      
+
       response = Response.new
       response.error!(node.content.to_s.strip, node['code'].to_s.strip)
       response

data/test/client_test.rb

@@ -29,7 +29,7 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
     body = '<status>
               <authorized>true</authorized>
               <plan>Ultimate</plan>
-             
+
               <usage_reports>
                 <usage_report metric="hits" period="day">
                   <period_start>2010-04-26 00:00:00 +0000</period_start>
@@ -54,7 +54,7 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
     assert response.success?
     assert_equal 'Ultimate', response.plan
     assert_equal 2, response.usage_reports.size
-    
+
     assert_equal :day, response.usage_reports[0].period
     assert_equal Time.utc(2010, 4, 26), response.usage_reports[0].period_start
     assert_equal Time.utc(2010, 4, 27), response.usage_reports[0].period_end
@@ -67,7 +67,7 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
     assert_equal 999872, response.usage_reports[1].current_value
     assert_equal 150000, response.usage_reports[1].max_value
   end
-  
+
   def test_successful_authorize_with_app_keys
     body = '<status>
               <authorized>true</authorized>
@@ -86,7 +86,7 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
               <reason>usage limits are exceeded</reason>
 
               <plan>Ultimate</plan>
-             
+
               <usage_reports>
                 <usage_report metric="hits" period="day" exceeded="true">
                   <period_start>2010-04-26 00:00:00 +0000</period_start>
@@ -103,9 +103,9 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
                 </usage_report>
               </usage_reports>
             </status>'
-    
+
     FakeWeb.register_uri(:get, "http://#{@host}/transactions/authorize.xml?provider_key=1234abcd&app_id=foo", :status => ['409'], :body => body)
-    
+
     response = @client.authorize(:app_id => 'foo')
 
     assert !response.success?
@@ -115,7 +115,7 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
 
   def test_authorize_with_invalid_app_id
     body = '<error code="application_not_found">application with id="foo" was not found</error>'
-    
+
     FakeWeb.register_uri(:get, "http://#{@host}/transactions/authorize.xml?provider_key=1234abcd&app_id=foo", :status => ['403', 'Forbidden'], :body => body)
 
     response = @client.authorize(:app_id => 'foo')
@@ -124,7 +124,7 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
     assert_equal 'application_not_found',                   response.error_code
     assert_equal 'application with id="foo" was not found', response.error_message
   end
-  
+
   def test_authorize_with_server_error
     FakeWeb.register_uri(:get, "http://#{@host}/transactions/authorize.xml?provider_key=1234abcd&app_id=foo", :status => ['500', 'Internal Server Error'], :body => 'OMG! WTF!')
 
@@ -133,6 +133,111 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
     end
   end
 
+  def test_successful_oauth_authorize
+    body = '<status>
+              <authorized>true</authorized>
+              <application>
+                <id>94bd2de3</id>
+                <key>883bdb8dbc3b6b77dbcf26845560fdbb</key>
+                <redirect_url>http://localhost:8080/oauth/oauth_redirect</redirect_url>
+              </application>
+              <plan>Ultimate</plan>
+              <usage_reports>
+                <usage_report metric="hits" period="week">
+                  <period_start>2012-01-30 00:00:00 +0000</period_start>
+                  <period_end>2012-02-06 00:00:00 +0000</period_end>
+                  <max_value>5000</max_value>
+                  <current_value>1</current_value>
+                </usage_report>
+                <usage_report metric="update" period="minute">
+                  <period_start>2012-02-03 00:00:00 +0000</period_start>
+                  <period_end>2012-02-03 00:00:00 +0000</period_end>
+                  <max_value>0</max_value>
+                  <current_value>0</current_value>
+                </usage_report>
+              </usage_reports>
+            </status>'
+
+    FakeWeb.register_uri(:get, "http://#{@host}/transactions/oauth_authorize.xml?provider_key=1234abcd&app_id=foo&redirect_url=http%3A%2F%2Flocalhost%3A8080%2Foauth%2Foauth_redirect", :status => ['200', 'OK'], :body => body)
+
+    response = @client.oauth_authorize(:app_id => 'foo', :redirect_url => "http://localhost:8080/oauth/oauth_redirect")
+    assert response.success?
+
+    assert_equal '883bdb8dbc3b6b77dbcf26845560fdbb', response.app_key
+    assert_equal 'http://localhost:8080/oauth/oauth_redirect', response.redirect_url
+
+    assert_equal 'Ultimate', response.plan
+    assert_equal 2, response.usage_reports.size
+
+    assert_equal :week, response.usage_reports[0].period
+    assert_equal Time.utc(2012, 1, 30), response.usage_reports[0].period_start
+    assert_equal Time.utc(2012, 02, 06), response.usage_reports[0].period_end
+    assert_equal 1, response.usage_reports[0].current_value
+    assert_equal 5000, response.usage_reports[0].max_value
+
+    assert_equal :minute, response.usage_reports[1].period
+    assert_equal Time.utc(2012, 2, 03), response.usage_reports[1].period_start
+    assert_equal Time.utc(2012, 2, 03), response.usage_reports[1].period_end
+    assert_equal 0, response.usage_reports[1].current_value
+    assert_equal 0, response.usage_reports[1].max_value
+  end
+
+  def test_oauth_authorize_with_exceeded_usage_limits
+    body = '<status>
+              <authorized>false</authorized>
+              <reason>usage limits are exceeded</reason>
+              <application>
+                <id>94bd2de3</id>
+                <key>883bdb8dbc3b6b77dbcf26845560fdbb</key>
+                <redirect_url>http://localhost:8080/oauth/oauth_redirect</redirect_url>
+              </application>
+              <plan>Ultimate</plan>
+              <usage_reports>
+                <usage_report metric="hits" period="day" exceeded="true">
+                  <period_start>2010-04-26 00:00:00 +0000</period_start>
+                  <period_end>2010-04-27 00:00:00 +0000</period_end>
+                  <current_value>50002</current_value>
+                  <max_value>50000</max_value>
+                </usage_report>
+
+                <usage_report metric="hits" period="month">
+                  <period_start>2010-04-01 00:00:00 +0000</period_start>
+                  <period_end>2010-05-01 00:00:00 +0000</period_end>
+                  <current_value>999872</current_value>
+                  <max_value>150000</max_value>
+                </usage_report>
+              </usage_reports>
+            </status>'
+
+    FakeWeb.register_uri(:get, "http://#{@host}/transactions/oauth_authorize.xml?provider_key=1234abcd&app_id=foo", :status => ['409'], :body => body)
+
+    response = @client.oauth_authorize(:app_id => 'foo')
+
+    assert !response.success?
+    assert_equal 'usage limits are exceeded', response.error_message
+    assert response.usage_reports[0].exceeded?
+  end
+
+  def test_oauth_authorize_with_invalid_app_id
+    body = '<error code="application_not_found">application with id="foo" was not found</error>'
+
+    FakeWeb.register_uri(:get, "http://#{@host}/transactions/oauth_authorize.xml?provider_key=1234abcd&app_id=foo", :status => ['403', 'Forbidden'], :body => body)
+
+    response = @client.oauth_authorize(:app_id => 'foo')
+
+    assert !response.success?
+    assert_equal 'application_not_found',                   response.error_code
+    assert_equal 'application with id="foo" was not found', response.error_message
+  end
+
+  def test_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
+      @client.oauth_authorize(:app_id => 'foo')
+    end
+  end
+
   def test_report_raises_an_exception_if_no_transactions_given
     assert_raise ArgumentError do
       @client.report
@@ -180,8 +285,8 @@ class ThreeScale::ClientTest < Test::Unit::TestCase
     FakeWeb.register_uri(:post, "http://#{@host}/transactions.xml",
                          :status => ['403', 'Forbidden'],
                          :body   => error_body)
-   
-    client   = ThreeScale::Client.new(:provider_key => 'foo')                         
+
+    client   = ThreeScale::Client.new(:provider_key => 'foo')
     response = client.report({:app_id => 'abc', :usage => {'hits' => 1}})
 
     assert !response.success?

data/test/remote_test.rb

@@ -1,7 +1,7 @@
 require 'test/unit'
 require '3scale/client'
 
-if ENV['TEST_3SCALE_PROVIDER_KEY'] && 
+if ENV['TEST_3SCALE_PROVIDER_KEY'] &&
    ENV['TEST_3SCALE_APP_IDS']      &&
    ENV['TEST_3SCALE_APP_KEYS']
   class ThreeScale::RemoteTest < Test::Unit::TestCase
@@ -24,7 +24,7 @@ if ENV['TEST_3SCALE_PROVIDER_KEY'] &&
     def test_successful_authorize
       @app_keys.each do |app_key|
         response = @client.authorize(:app_id => @app_ids[0], :app_key => app_key)
-        assert response.success?, "Authorize should succeed for app_id=#{@app_ids[0]} and app_key=#{app_key}, but it didn't"
+        assert response.success?, "Authorize should succeed for app_id=#{@app_ids[0]} and app_key=#{app_key}, but it failed with: '#{response.error_message}'"
       end
     end
 
@@ -35,6 +35,21 @@ if ENV['TEST_3SCALE_PROVIDER_KEY'] &&
       assert_equal 'application with id="invalid-id" was not found', response.error_message
     end
 
+    def test_successful_oauth_authorize
+      @app_keys.each do |app_key|
+        response = @client.oauth_authorize(:app_id => @app_ids[0])
+        assert response.success?, "Authorize should succeed for app_id=#{@app_ids[0]} and app_key=#{app_key}, but it failed with: '#{response.error_message}'"
+        assert_equal app_key, response.app_key
+      end
+    end
+
+    def test_failed_oauth_authorize
+      response = @client.oauth_authorize(: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_report
       transactions = @app_ids.map do |app_id|
         {:app_id => app_id, :usage => {'hits' => 1}}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: 3scale_client
 version: !ruby/object:Gem::Version 
-  hash: 9
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
   - 2
   - 2
-  - 7
-  version: 2.2.7
+  - 8
+  version: 2.2.8
 platform: ruby
 authors: 
 - "Adam Cig\xC3\xA1nek"
@@ -16,8 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-27 00:00:00 +01:00
-default_executable: 
+date: 2011-01-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
@@ -33,10 +32,52 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: |
   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.
 
-email: adam@3scale.net
+email: adam@3scale.net tiago@3scale.net
 executables: []
 
 extensions: []
@@ -55,7 +96,6 @@ files:
 - lib/3scale/response.rb
 - test/client_test.rb
 - test/remote_test.rb
-has_rdoc: true
 homepage: http://www.3scale.net
 licenses: []
 
@@ -85,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Client for 3scale Web Service Management System API