amiando 0.1.0 → 0.2.0

data/.travis.yml

@@ -0,0 +1,6 @@
+branches:
+  only:
+    - master
+rvm:
+  - 1.8.7
+  - 1.9.2

data/Gemfile

@@ -9,6 +9,7 @@ unless ENV["TRAVIS"]
 end
 
 group :development do
+  gem 'minitest-reporters'
   gem 'guard-minitest'
   if RbConfig::CONFIG['target_os'] =~ /darwin/i
     gem 'rb-fsevent', '>= 0.4.0', :require => false

data/README.md

@@ -1,4 +1,4 @@
-# amiando
+# amiando [![Build Status](https://secure.travis-ci.org/xing/amiando.png)](http://travis-ci.org/xing/amiando)
 
 This is a gem to access the amiando REST API. You can check the original
 documentation here:
@@ -12,15 +12,19 @@ parallel using [Typhoeus](https://github.com/dbalatero/typhoeus).
 
 You can query multiple requests and run then like this:
 
-```ruby
-albert = Amiando::User.find(1234)
-jorge  = Amiando::User.find(5678)
+    albert = Amiando::User.find(1234)
+    jorge  = Amiando::User.find(5678)
 
-Amiando.run
-```
+    Amiando.run
 
 Both requests will happen in parallel.
 
+You can also do synchronous requests by prepending 'sync_' to the method name:
+
+    albert = Amiando::User.sync_find(1234)
+
+### Note
+
 All attributes should be used in snake_case format instead of the CamelCase
 used in the official documentation. For example, for a user, you should call
-first_name instead of firstName.
+first_name instead of firstName.

data/lib/amiando.rb

@@ -13,6 +13,7 @@ module Amiando
   autoload :TicketCategory, 'amiando/ticket_category'
   autoload :TicketShop,     'amiando/ticket_shop'
   autoload :PaymentType,    'amiando/payment_type'
+  autoload :Autorun,        'amiando/autorun'
 
   module Error
     class ServiceDown    < Exception; end
@@ -26,6 +27,9 @@ module Amiando
 
   class << self
     attr_accessor :api_key
+    attr_accessor :logger
+    attr_accessor :verbose
+    attr_accessor :autorun
 
     URL       = 'https://amiando.com'
     TEST_URL  = 'https://test.amiando.com'

data/lib/amiando/autorun.rb

@@ -0,0 +1,24 @@
+module Amiando
+  module Autorun
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def autorun(*fields)
+        fields.each do |field|
+          class_eval <<-EOS, __FILE__, __LINE__
+            def #{field}
+              Amiando.run if Amiando.autorun && !defined?(@#{field})
+              if defined?(@#{field})
+                @#{field}
+              else
+                raise Error::NotInitialized.new('Called result before the query was run')
+              end
+            end
+          EOS
+        end
+      end
+    end
+  end
+end

data/lib/amiando/boolean.rb

@@ -8,8 +8,12 @@ module Amiando
   # After the object is populated, you can ask the result with the result
   # method.
   class Boolean
+    include Amiando::Autorun
+
     attr_accessor :request, :response
 
+    autorun :request, :response, :result
+
     def initialize(response_attribute)
       @response_attribute = response_attribute.to_s
     end

data/lib/amiando/request.rb

@@ -12,7 +12,19 @@ module Amiando
         params = default_params.merge(params || {})
       end
 
-      super(path, :method => verb, :params => params, :verbose => 1)
+      super(path, :method => verb, :params => params, :verbose => Amiando.verbose)
+    end
+
+    def log_response
+      if Amiando.logger
+        filtered_url = url.gsub(/password=([^&]+)/, "password=[FILTERED]")
+        Amiando.logger.info "REST request #{filtered_url} returned #{response.code} and took #{response.time} seconds"
+
+        if Amiando.logger.debug? && response.body
+          filtered_body = response.body.inspect.gsub(/password: .*/,'password: [FILTERED]')
+          Amiando.logger.debug "REST request body: #{filtered_body}"
+        end
+      end
     end
 
     private

data/lib/amiando/resource.rb

@@ -1,8 +1,12 @@
 module Amiando
   class Resource
+    include Amiando::Autorun
+
     attr_accessor :request, :response
     attr_reader :success, :attributes
 
+    autorun :request, :response, :success, :attributes
+
     class << self
       def map(local, remote, options = {})
         mapping[local] = remote
@@ -57,6 +61,7 @@ module Amiando
         object.request = req
 
         req.on_complete do |response|
+          req.log_response
 
           # Raise different errors depending on the return codes
           case response.code
@@ -115,15 +120,15 @@ module Amiando
     end
 
     def method_missing(method_name, *args, &block)
-      if @attributes.key?(method_name) && args.empty?
-        @attributes[method_name]
+      if attributes.key?(method_name) && args.empty?
+        attributes[method_name]
       else
         super
       end
     end
 
     def id
-      @attributes[:id]
+      attributes[:id]
     end
 
     def populate(reponse_body)
@@ -150,9 +155,9 @@ module Amiando
     protected
 
     def set_attributes(attributes)
-      @attributes = {}
-
       if attributes
+        @attributes = {}
+
         self.class.reverse_map_params(attributes).each do |k,v|
           @attributes[k.to_sym] = v
         end

data/lib/amiando/result.rb

@@ -8,8 +8,12 @@ module Amiando
   # After the object is populated, you can ask the result with the result
   # method.
   class Result
+    include Amiando::Autorun
+
     attr_accessor :request, :response, :errors
 
+    autorun :request, :response, :result, :errors
+
     def initialize(&block)
       @populator = block
     end
@@ -21,13 +25,5 @@ module Amiando
         @result = @populator.call(response_body, self)
       end
     end
-
-    def result
-      if defined?(@result)
-        @result
-      else
-        raise Error::NotInitialized.new('Called result before the query was run')
-      end
-    end
   end
 end

data/lib/amiando/version.rb

@@ -1,3 +1,3 @@
 module Amiando
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/test/amiando/amiando_test.rb

@@ -10,4 +10,15 @@ describe Amiando do
     Amiando.base_url.must_equal 'https://amiando.com'
     Amiando.development!
   end
+
+  describe 'logger' do
+    it 'should define a logger' do
+      log = StringIO.new
+      Amiando.logger = Logger.new(log)
+      Amiando.logger.debug 'hi'
+
+      log.string.must_match(/hi/)
+      Amiando.logger = nil
+    end
+  end
 end

data/test/amiando/event_test.rb

@@ -11,23 +11,23 @@ describe Amiando::Event do
 
   describe 'find' do
     it 'finds an already existing event' do
-      original = Amiando::Factory(:event, :identifier => 'wadus')
-      Amiando.run
+      identifier = "event-find-#{HydraCache.revision}"
+      original   = Amiando::Factory.create(:event, :identifier => identifier)
 
       event = Amiando::Event.find(original.id)
       Amiando.run
 
       event.id.must_equal original.id
-      event.identifier.must_equal 'wadus'
+      event.identifier.must_equal identifier
     end
   end
 
   describe 'exists' do
-    it 'checks if an event an already exists' do
-      original = Amiando::Factory(:event, :identifier => 'wadus')
-      Amiando.run
+    it 'checks if an event already exists' do
+      identifier = "event-exists-#{HydraCache.revision}"
+      original   = Amiando::Factory.create(:event, :identifier => identifier)
 
-      exists = Amiando::Event.exists?('wadus')
+      exists = Amiando::Event.exists?(identifier)
       Amiando.run
 
       exists.result.must_equal true
@@ -35,12 +35,12 @@ describe Amiando::Event do
   end
 
   describe 'create' do
-    it 'creates an event wit valid parameters passed' do
+    it 'creates an event with valid parameters passed' do
       event = Amiando::Event.create(
         :host_id       => Amiando::TEST_USER.id,
         :title         => 'Secret title',
         :country       => 'es',
-        :selected_date => Time.at(0)
+        :selected_date => Time.at(0).utc
       )
 
       Amiando.run
@@ -112,10 +112,11 @@ describe Amiando::Event do
 
   describe 'search' do
     it 'finds events by identifier' do
-      event = Amiando::Factory(:event, :identifier => 'waduswadus1234')
+      identifier = "event-search-#{HydraCache.revision}"
+      event = Amiando::Factory(:event, :identifier => identifier)
       Amiando.run
 
-      search = Amiando::Event.search(:identifier => 'waduswadus1234')
+      search = Amiando::Event.search(:identifier => identifier)
       Amiando.run
 
       search.result.must_include event.id

data/test/amiando/resource_test.rb

@@ -11,11 +11,6 @@ describe Amiando::Resource do
       post object, 'somewhere', :populate_method => :populate_create
       object
     end
-
-    def populate_create(response_body)
-      @success = response_body['success']
-    end
-
   end
 
   it 'raises error when amiando is down' do
@@ -56,21 +51,21 @@ describe Amiando::Resource do
   end
 
   it 'maps attributes with typecasting' do
-    time      = Time.at(0)
-    expected  = { :creation => '1970-01-01T01:00:00+01:00' }
+    time      = Time.at(0).utc
+    expected  = { :creation => '1970-01-01T00:00:00Z' }
     Wadus.map_params(:creation => time).must_equal expected
   end
 
   it 'automatically typecasts if the object is a Time' do
-    time      = Time.at(0)
-    expected  = { :firstName => '1970-01-01T01:00:00+01:00' }
+    time      = Time.at(0).utc
+    expected  = { :firstName => '1970-01-01T00:00:00Z' }
     Wadus.map_params(:first_name => time).must_equal expected
   end
 
   it 'reverse maps attributes with typecasting' do
-    time      = Time.at(0)
+    time      = Time.at(0).utc
     expected  = { :creation => time }
-    Wadus.reverse_map_params(:creation => '1970-01-01T01:00:00+01:00').must_equal expected
+    Wadus.reverse_map_params(:creation => '1970-01-01T00:00:00Z').must_equal expected
   end
 
   describe 'synchronous calls' do
@@ -79,4 +74,37 @@ describe Amiando::Resource do
       Wadus.sync_create.success.must_equal true
     end
   end
+
+  describe 'autorun' do
+    before do
+      Amiando.autorun = true
+      stub_request(:post, /somewhere/).to_return(:status => 200, :body => '{"success":true, "id": 1}')
+    end
+
+    after do
+      Amiando.autorun = nil
+    end
+
+    let(:wadus) { Wadus.create }
+
+    it 'should return the result when calling autorun' do
+      wadus.id.must_equal 1
+    end
+
+    it 'should return the success' do
+      wadus.success.must_equal true
+    end
+
+    it 'should return no errors' do
+      wadus.errors.must_be_nil
+    end
+
+    it 'should return the request' do
+      wadus.request.wont_be_nil
+    end
+
+    it 'should return the response' do
+      wadus.response.wont_be_nil
+    end
+  end
 end

data/test/fixtures/ApiKey/{ded8694c21d2e1c0cec845f72ba452b5.yml → 1d8e3d55d45a77d6eb7796e5abb70281.yml}

@@ -1,26 +1,26 @@
 --- !ruby/object:Typhoeus::Response 
-app_connect_time: 0.00017
+app_connect_time: 4.7e-05
 body: "{\"success\":true}"
 code: 200
-connect_time: 0.00017
+connect_time: 4.7e-05
 curl_error_message: No error
 curl_return_code: 0
-effective_url: https://test.amiando.com/api/apiKey/179114?apikey=58EvysiFmBVz2BzeirkJTorpWhI1XJ6UHH2YLIdbZ9d4SpgbcD&version=1&format=json
+effective_url: https://test.amiando.com/api/apiKey/179133?version=1&apikey=0wDGphOP9KiqovK8mrCFQB6vn8a6DKzxQ0Zo9nev1OTSGebnOK&format=json
 first_header_line: HTTP/1.1 200 OK
 headers: |
   HTTP/1.1 200 OK
-  Date: Fri, 21 Oct 2011 13:32:40 GMT
+  Date: Tue, 25 Oct 2011 14:52:32 GMT
   Server: Apache/2.0.55 (Red Hat)
-  Set-Cookie: JSESSIONID=798680CF9CC357FA429C9A714B5DAB94.web01; Path=/; Secure
-  Set-Cookie: JSESSIONID=798680CF9CC357FA429C9A714B5DAB94.web01; Path=/
+  Set-Cookie: JSESSIONID=C4B1E16C88A6EDEE31C26E104A1D4454.web01; Path=/; Secure
+  Set-Cookie: JSESSIONID=C4B1E16C88A6EDEE31C26E104A1D4454.web01; Path=/
   accept-charset: utf-8
   P3P: policyref="/w3c/p3p.xml", CP="CAO DSP COR CUR ADM DEV TAI PSA PSD CON OUR IND UNI PUR COM CNT"
   Access-Control-Allow-Origin: *
   Access-Control-Allow-Methods: POST, GET, OPTIONS, DELETE, PUT
-  Set-Cookie: ANONYMOUS_HASHED_REMEMBER_ME_COOKIE_KEY=dzQxRjl3SkJoMFdCd1I3ZToxMzIwNDEzNzM3Mjk0OjMwZGQ5OTc0NDM2OWE4MjA4MmViOGUxOGYzZGU2ZDY0; Expires=Wed, 19-Oct-2016 13:35:37 GMT; Path=/
+  Set-Cookie: ANONYMOUS_HASHED_REMEMBER_ME_COOKIE_KEY=NjNzbWVlN25mUmJ4ZHd6NToxMzIwNzY0MTQxNjI4OjJkZmUwMTYwMDUwOGZlYjc4ZGRhM2Q5NThmZWZlNTA3; Expires=Sun, 23-Oct-2016 14:55:41 GMT; Path=/
   Accept-Ranges: bytes
   Cache-Control: max-age=7200
-  Expires: Fri, 21 Oct 2011 15:32:40 GMT
+  Expires: Tue, 25 Oct 2011 16:52:32 GMT
   Vary: User-Agent
   Transfer-Encoding: chunked
   Content-Type: application/json;charset=UTF-8
@@ -33,28 +33,28 @@ headers_hash: !map:Typhoeus::NormalizedHeaderHash
   Transfer-Encoding: chunked
   Access-Control-Allow-Origin: "*"
   Content-Type: application/json;charset=UTF-8
-  Date: Fri, 21 Oct 2011 13:32:40 GMT
+  Date: Tue, 25 Oct 2011 14:52:32 GMT
   Accept-Ranges: bytes
   Server: Apache/2.0.55 (Red Hat)
   Set-Cookie: 
-  - JSESSIONID=798680CF9CC357FA429C9A714B5DAB94.web01; Path=/; Secure
-  - JSESSIONID=798680CF9CC357FA429C9A714B5DAB94.web01; Path=/
-  - ANONYMOUS_HASHED_REMEMBER_ME_COOKIE_KEY=dzQxRjl3SkJoMFdCd1I3ZToxMzIwNDEzNzM3Mjk0OjMwZGQ5OTc0NDM2OWE4MjA4MmViOGUxOGYzZGU2ZDY0; Expires=Wed, 19-Oct-2016 13:35:37 GMT; Path=/
-  Expires: Fri, 21 Oct 2011 15:32:40 GMT
+  - JSESSIONID=C4B1E16C88A6EDEE31C26E104A1D4454.web01; Path=/; Secure
+  - JSESSIONID=C4B1E16C88A6EDEE31C26E104A1D4454.web01; Path=/
+  - ANONYMOUS_HASHED_REMEMBER_ME_COOKIE_KEY=NjNzbWVlN25mUmJ4ZHd6NToxMzIwNzY0MTQxNjI4OjJkZmUwMTYwMDUwOGZlYjc4ZGRhM2Q5NThmZWZlNTA3; Expires=Sun, 23-Oct-2016 14:55:41 GMT; Path=/
+  Expires: Tue, 25 Oct 2011 16:52:32 GMT
   Cache-Control: max-age=7200
   Accept-Charset: utf-8
 http_version: 
 mock: false
-name_lookup_time: 0.00017
-pretransfer_time: 0.000188
+name_lookup_time: 4.7e-05
+pretransfer_time: 5.6e-05
 request: |-
   :method => :post,
-  	:url => https://test.amiando.com/api/apiKey/179114?apikey=58EvysiFmBVz2BzeirkJTorpWhI1XJ6UHH2YLIdbZ9d4SpgbcD&version=1&format=json,
+  	:url => https://test.amiando.com/api/apiKey/179133?version=1&apikey=0wDGphOP9KiqovK8mrCFQB6vn8a6DKzxQ0Zo9nev1OTSGebnOK&format=json,
   	:params => {:enabled=>false},
   	:headers => {"User-Agent"=>"Typhoeus - http://github.com/dbalatero/typhoeus/tree/master"}
 requested_http_method: 
 requested_url: 
 start_time: 
-start_transfer_time: 0.048987
+start_transfer_time: 0.140784
 status_message: OK
-time: 0.049024
+time: 0.140835

data/test/fixtures/ApiKey/1f62195e173114773b3ec2613582ece9.yml

@@ -1,26 +1,26 @@
 --- !ruby/object:Typhoeus::Response 
-app_connect_time: 0.08915
-body: "{\"id\":179115,\"success\":true,\"apiKey\":{\"id\":179115,\"enabled\":true,\"name\":\"wadus1\",\"identifier\":\"EopaMPlPFB7XaKcP\",\"key\":\"wZxhTWwGPRGbsx5ZW4FFbnEtUuUj6kfnFtPxXfDYa8uBHhbAhM\"}}"
+app_connect_time: 5.4e-05
+body: "{\"id\":179134,\"success\":true,\"apiKey\":{\"id\":179134,\"enabled\":true,\"name\":\"wadus1\",\"identifier\":\"goePEGEozdjz4S1L\",\"key\":\"vAkR1Y5tN5s1p1GV566TriYq6dmhh7AuW7uxMwAEUvpNA4Apyz\"}}"
 code: 201
-connect_time: 0.039197
+connect_time: 5.4e-05
 curl_error_message: No error
 curl_return_code: 0
 effective_url: https://test.amiando.com/api/apiKey/create?version=1&format=json
 first_header_line: HTTP/1.1 201 Created
 headers: |
   HTTP/1.1 201 Created
-  Date: Fri, 21 Oct 2011 13:32:40 GMT
+  Date: Tue, 25 Oct 2011 14:52:32 GMT
   Server: Apache/2.0.55 (Red Hat)
-  Set-Cookie: JSESSIONID=22E1738857D739D3983B8FFE28C2A511.web01; Path=/; Secure
-  Set-Cookie: JSESSIONID=22E1738857D739D3983B8FFE28C2A511.web01; Path=/
+  Set-Cookie: JSESSIONID=8D97AA2BF2114EF413FE0C307C03F6C0.web01; Path=/; Secure
+  Set-Cookie: JSESSIONID=8D97AA2BF2114EF413FE0C307C03F6C0.web01; Path=/
   accept-charset: utf-8
   P3P: policyref="/w3c/p3p.xml", CP="CAO DSP COR CUR ADM DEV TAI PSA PSD CON OUR IND UNI PUR COM CNT"
   Access-Control-Allow-Origin: *
   Access-Control-Allow-Methods: POST, GET, OPTIONS, DELETE, PUT
-  Set-Cookie: ANONYMOUS_HASHED_REMEMBER_ME_COOKIE_KEY=VHlwRzhPanhRdHNpQ05LYjoxMzIwNDEzNzM3MTU0OmNkNTRjOTUzMDk2YTExODczZmI3NzQ3MGE3ZDFmNzEx; Expires=Wed, 19-Oct-2016 13:35:37 GMT; Path=/
+  Set-Cookie: ANONYMOUS_HASHED_REMEMBER_ME_COOKIE_KEY=MDBtWmI1Vk5BeXZiNWhHaDoxMzIwNzY0MTQxNzgyOjM5YWMxMmZiMDhiZTllMDNjNWYzYzBjNWEzOTBmYjY3; Expires=Sun, 23-Oct-2016 14:55:41 GMT; Path=/
   Accept-Ranges: bytes
   Cache-Control: max-age=7200
-  Expires: Fri, 21 Oct 2011 15:32:40 GMT
+  Expires: Tue, 25 Oct 2011 16:52:32 GMT
   Vary: User-Agent
   Transfer-Encoding: chunked
   Content-Type: application/json;charset=UTF-8
@@ -33,20 +33,20 @@ headers_hash: !map:Typhoeus::NormalizedHeaderHash
   Transfer-Encoding: chunked
   Access-Control-Allow-Origin: "*"
   Content-Type: application/json;charset=UTF-8
-  Date: Fri, 21 Oct 2011 13:32:40 GMT
+  Date: Tue, 25 Oct 2011 14:52:32 GMT
   Accept-Ranges: bytes
   Server: Apache/2.0.55 (Red Hat)
   Set-Cookie: 
-  - JSESSIONID=22E1738857D739D3983B8FFE28C2A511.web01; Path=/; Secure
-  - JSESSIONID=22E1738857D739D3983B8FFE28C2A511.web01; Path=/
-  - ANONYMOUS_HASHED_REMEMBER_ME_COOKIE_KEY=VHlwRzhPanhRdHNpQ05LYjoxMzIwNDEzNzM3MTU0OmNkNTRjOTUzMDk2YTExODczZmI3NzQ3MGE3ZDFmNzEx; Expires=Wed, 19-Oct-2016 13:35:37 GMT; Path=/
-  Expires: Fri, 21 Oct 2011 15:32:40 GMT
+  - JSESSIONID=8D97AA2BF2114EF413FE0C307C03F6C0.web01; Path=/; Secure
+  - JSESSIONID=8D97AA2BF2114EF413FE0C307C03F6C0.web01; Path=/
+  - ANONYMOUS_HASHED_REMEMBER_ME_COOKIE_KEY=MDBtWmI1Vk5BeXZiNWhHaDoxMzIwNzY0MTQxNzgyOjM5YWMxMmZiMDhiZTllMDNjNWYzYzBjNWEzOTBmYjY3; Expires=Sun, 23-Oct-2016 14:55:41 GMT; Path=/
+  Expires: Tue, 25 Oct 2011 16:52:32 GMT
   Cache-Control: max-age=7200
   Accept-Charset: utf-8
 http_version: 
 mock: false
-name_lookup_time: 3.1e-05
-pretransfer_time: 0.089152
+name_lookup_time: 5.4e-05
+pretransfer_time: 6.2e-05
 request: |-
   :method => :post,
   	:url => https://test.amiando.com/api/apiKey/create?version=1&format=json,
@@ -55,6 +55,6 @@ request: |-
 requested_http_method: 
 requested_url: 
 start_time: 
-start_transfer_time: 0.209639
+start_transfer_time: 0.101058
 status_message: Created
-time: 0.209708
+time: 0.101107