amiando 0.3.7 → 0.3.8

data/.gitignore

@@ -5,3 +5,4 @@ pkg/*
 /.rvmrc
 /TAGS
 /.yardoc/*
+doc

data/lib/amiando.rb

@@ -17,22 +17,33 @@ module Amiando
   autoload :TicketShop,     'amiando/ticket_shop'
   autoload :PaymentType,    'amiando/payment_type'
 
-  module Error
-    class ServiceDown    < Exception; end
-    class ApiKeyNeeded   < Exception; end
-    class NotAuthorized  < Exception; end
-    class NotFound       < Exception; end
-    class NotImplemented < Exception; end
-    class NotInitialized < Exception; end
-    class MissingApiKey  < Exception; end
+  class Error < StandardError
+    class ServiceDown    < Error; end
+    class Timeout        < Error; end
+    class ApiKeyNeeded   < Error; end
+    class NotAuthorized  < Error; end
+    class NotFound       < Error; end
+    class NotImplemented < Error; end
+    class NotInitialized < Error; end
+    class MissingApiKey  < Error; end
   end
 
   class << self
+
+    # Api key to be used at all times.
     attr_accessor :api_key
+
+    # Logger instance. There's no logger by default.
     attr_accessor :logger
+
     attr_accessor :verbose
+
+    # If set to true, will run the requests automatically when needed.
     attr_accessor :autorun
 
+    # Timeout value (in milliseconds). Default: 15 seconds.
+    attr_accessor :timeout
+
     URL       = 'https://amiando.com'
     TEST_URL  = 'https://test.amiando.com'
 
@@ -63,10 +74,6 @@ module Amiando
       @requests = []
     end
 
-    def hydra
-      @hydra ||= Typhoeus::Hydra.new
-    end
-
     ##
     # Allows to switch temporarily the API key
     #
@@ -81,5 +88,16 @@ module Amiando
       Amiando.api_key = old_key
     end
 
+    private
+
+    def hydra
+      @hydra ||= Typhoeus::Hydra.new
+    end
+
   end
+
+  ##
+  # Default timeout of 15 seconds
+  self.timeout = 15000
+
 end

data/lib/amiando/payment_type.rb

@@ -6,15 +6,13 @@ module Amiando
     #
     # @param event_id
     # @param type string or symbol of the following:
-    #   * PAYMENT_TYPE_ELV
-    #   * PAYMENT_TYPE_CC
+    #   * PAYMENT_TYPE_ELV (debit card)
+    #   * PAYMENT_TYPE_CC (credit card)
     #   * PAYMENT_TYPE_INVOICE
     #   * PAYMENT_TYPE_PREPAYMENT
-    #   * PAYMENT_TYPE_PP
+    #   * PAYMENT_TYPE_PP (PayPal)
     #   * PAYMENT_TYPE_ONLOCATION
     #
-    #   [CC = CreditCard, PP = PayPal]
-    #
     #   It will also accept :cc, :invoice, etc and convert them appropriately
     #
     def self.create(event_id, type)

data/lib/amiando/request.rb

@@ -12,7 +12,7 @@ module Amiando
         params = default_params.merge(params || {})
       end
 
-      super(path, :method => verb, :params => params, :verbose => Amiando.verbose)
+      super(path, :method => verb, :params => params, :verbose => Amiando.verbose, :timeout => Amiando.timeout)
     end
 
     def log_request

data/lib/amiando/resource.rb

@@ -65,6 +65,10 @@ module Amiando
         req.on_complete do |response|
           req.log_response
 
+          if response.timed_out?
+            raise Error::Timeout
+          end
+
           # Raise different errors depending on the return codes
           case response.code
           when 403
@@ -73,6 +77,8 @@ module Amiando
             raise Error::NotFound.new(response.body)
           when 503
             raise Error::ServiceDown.new(response.body)
+          when 0
+            raise Error.new(response.body)
           end
 
           parsed_body = MultiJson.decode(response.body)

data/lib/amiando/version.rb

@@ -1,3 +1,3 @@
 module Amiando
-  VERSION = "0.3.7"
+  VERSION = "0.3.8"
 end

data/test/amiando/resource_test.rb

@@ -28,11 +28,32 @@ describe Amiando::Resource do
   it 'raises error when amiando is down' do
     stub_request(:post, /somewhere/).to_return(:status => 503)
     lambda {
-      key = Wadus.create
+      Wadus.create
       Amiando.run
     }.must_raise Amiando::Error::ServiceDown
   end
 
+  ##
+  # Not working because of issue between webmock and typhoeus
+  #
+  # it 'raises error when the request times out' do
+  #   stub_request(:post, /somewhere/).to_timeout
+  #   lambda {
+  #     Wadus.create
+  #     Amiando.run
+  #   }.must_raise Amiando::Error::Timeout
+  # end
+
+  it 'raises error when the request returns code 0' do
+    stub_request(:post, /somewhere/).to_return(:status => 0)
+
+    lambda {
+      Wadus.create
+      Amiando.run
+    }.must_raise Amiando::Error
+  end
+
+
   it 'raises an error if populate method is not implemented' do
     lambda {
       Wadus.new.populate(nil)

data/test/test_helper.rb

@@ -18,8 +18,8 @@ require 'support/hydra_cache'
 require 'support/factory'
 require 'support/hydra_monkey_patch'
 
-Amiando.hydra.cache_setter &HydraCache.method(:setter)
-Amiando.hydra.cache_getter &HydraCache.method(:getter)
+Amiando.send(:hydra).cache_setter &HydraCache.method(:setter)
+Amiando.send(:hydra).cache_getter &HydraCache.method(:getter)
 HydraCache.revision = 2
 
 WebMock.allow_net_connect!

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: amiando
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 3
   prerelease: 
   segments: 
   - 0
   - 3
-  - 7
-  version: 0.3.7
+  - 8
+  version: 0.3.8
 platform: ruby
 authors: 
 - Jorge Dias
@@ -16,7 +16,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-20 00:00:00 Z
+date: 2012-01-02 00:00:00 +01:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: typhoeus
@@ -225,6 +226,7 @@ files:
 - test/support/hydra_cache.rb
 - test/support/hydra_monkey_patch.rb
 - test/test_helper.rb
+has_rdoc: true
 homepage: ""
 licenses: []
 
@@ -254,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: amiando
-rubygems_version: 1.8.10
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A ruby client for the amiando REST API