ecircle 0.1.3 → 0.1.4

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ecircle (0.1.3)
+    ecircle (0.1.4)
       activesupport
       i18n
       rake
@@ -10,7 +10,7 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.1.1)
+    activesupport (3.1.3)
       multi_json (~> 1.0)
     akami (1.0.0)
       gyoku (>= 0.4.0)
@@ -25,6 +25,9 @@ GEM
     i18n (0.6.0)
     linecache19 (0.5.12)
       ruby_core_source (>= 0.1.4)
+    metaclass (0.0.1)
+    mocha (0.10.0)
+      metaclass (~> 0.0.1)
     multi_json (1.0.3)
     nokogiri (1.5.0)
     nori (1.0.2)
@@ -57,6 +60,10 @@ GEM
       nokogiri (>= 1.4.0)
       nori (~> 1.0)
       wasabi (~> 2.0)
+    savon_spec (0.1.6)
+      mocha (>= 0.9.8)
+      rspec (>= 2.0.0)
+      savon (>= 0.8.0)
     wasabi (2.0.0)
       nokogiri (>= 1.4.0)
     yard (0.7.3)
@@ -69,4 +76,5 @@ DEPENDENCIES
   random_data (= 1.5.2)
   rspec (= 2.6.0)
   ruby-debug19
+  savon_spec (~> 0.1.6)
   yard

data/ecircle.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'savon', '>=0.9.7'
   s.add_development_dependency 'random_data', '1.5.2'
   s.add_development_dependency 'rspec', '2.6.0'
+  s.add_development_dependency 'savon_spec', '~> 0.1.6'
   s.add_development_dependency 'yard'
   s.add_development_dependency 'ruby-debug19'
 end

data/lib/ecircle/api.rb

@@ -11,39 +11,9 @@ module Ecircle
     !!!
     doc
 
-
-    #@private
-    def ensuring_logon &block
-      begin
-        @auth_token ||= logon
-      rescue Savon::SOAP::Fault => e
-        # If we are here this means that our login credentials are wrong.
-        wrapped_response = WrappedResponse.new(e)
-        if wrapped_response.not_authenticated? || wrapped_response.permission_problem?
-          puts @@help
-          raise InvalidLoginCredentials
-        else
-          raise
-        end
-      end
-
-      first_try = true
-      # -> In case the session token has expired (which means 'not_authenticated') retry once.
-      # -> In case we can't get a token on second there's nothing we can do, so give up.
-      # -> In all other cases (regardless if success? is true or false) return the response.
-      loop do
-        wrapped_response = block.call
-        if first_try && wrapped_response.not_authenticated?
-          first_try = false
-          @auth_token = logon
-        elsif wrapped_response.not_authenticated?
-          puts "!!! Could not re-authenticate after session expired: #{wrapped_response.inspect} !!!"
-          raise
-        else
-          return wrapped_response
-        end
-      end
-    end
+    # According to http://developer.ecircle-ag.com/apiwiki/wiki/SynchronousSoapAPI#section-SynchronousSoapAPI-SampleProtocolExcerpt,
+    # a session expires after 10 minutes (600 seconds) of idleness. We give ourselves a 30-second margin.
+    AUTH_TOKEN_TIMEOUT = 570
 
     # @private
     def client
@@ -62,24 +32,19 @@ module Ecircle
     # @param [Boolean] send_message send a message by ecircle
     # @return [WrappedResponse]
     def create_member user_id, group_id, invite = false, send_message = false
-      ensuring_logon do
-        begin
-          @response = client.request :createMember do
-            soap.body = {
-              :session     => auth_token,
-              :userId      => user_id,
-              :groupId     => group_id,
-              :invite      => invite.to_s,
-              :sendMessage => send_message.to_s
-            }
-          end
-        rescue Savon::SOAP::Fault => e
-          WrappedResponse.new(e)
-        else
-          WrappedResponse.new :success => true,
-                              :ecircle_id => @response.body[:create_member_response][:create_member_return].to_s
-        end
+      response = client.request :createMember do
+        soap.body = {
+          :session     => obtain_auth_token,
+          :userId      => user_id,
+          :groupId     => group_id,
+          :invite      => invite.to_s,
+          :sendMessage => send_message.to_s
+        }
       end
+      WrappedResponse.new :success => true,
+                          :ecircle_id => response.body[:create_member_response][:create_member_return].to_s
+    rescue Savon::SOAP::Fault => e
+      WrappedResponse.new(e)
     end
 
     # Create or update group
@@ -89,21 +54,16 @@ module Ecircle
     # @return [WrappedResponse]
     # Important note: `email` must be unique across all groups AND must be a subdomain of the system you registered at ecircle.
     def create_or_update_group group_attributes
-      ensuring_logon do
-        begin
-          @response = client.request :createOrUpdateGroup do
-            soap.body = {
-              :session   => auth_token,
-              :groupXml  => Helper.build_group_xml(group_attributes)
-            }
-          end
-        rescue Savon::SOAP::Fault => e
-          WrappedResponse.new(e)
-        else
-          WrappedResponse.new :success => true,
-                              :ecircle_id => @response[:create_or_update_group_response][:create_or_update_group_return].to_i
-        end
+      response = client.request :createOrUpdateGroup do
+        soap.body = {
+          :session   => obtain_auth_token,
+          :groupXml  => Helper.build_group_xml(group_attributes)
+        }
       end
+      WrappedResponse.new :success => true,
+                          :ecircle_id => response[:create_or_update_group_response][:create_or_update_group_return].to_i
+    rescue Savon::SOAP::Fault => e
+      WrappedResponse.new(e)
     end
 
     # Create or update user by email
@@ -112,22 +72,17 @@ module Ecircle
     # @param [Hash] user_xml, in it's most simple form a { :email => 'test@test.com' } is sufficient
     # @return [Integer] the user id
     def create_or_update_user_by_email user_attributes
-      ensuring_logon do
-        begin
-          @response = client.request :createOrUpdateUserByEmail do
-            soap.body = {
-              :session     => auth_token, # TODO We can't use @auth_token here cause then the session_id is nil. Why?
-              :userXml     => Helper.build_user_xml(user_attributes),
-              :sendMessage => 0
-            }
-          end
-        rescue Savon::SOAP::Fault => e
-          WrappedResponse.new(e)
-        else
-          WrappedResponse.new :success => true,
-                              :ecircle_id => @response.body[:create_or_update_user_by_email_response][:create_or_update_user_by_email_return].to_i
-        end
+      response = client.request :createOrUpdateUserByEmail do
+        soap.body = {
+          :session     => obtain_auth_token,
+          :userXml     => Helper.build_user_xml(user_attributes),
+          :sendMessage => 0
+        }
       end
+      WrappedResponse.new :success => true,
+                          :ecircle_id => response.body[:create_or_update_user_by_email_response][:create_or_update_user_by_email_return].to_i
+    rescue Savon::SOAP::Fault => e
+      WrappedResponse.new(e)
     end
 
     # Delete a member.
@@ -135,20 +90,15 @@ module Ecircle
     # @param [Integer] group_id ecircle group id
     # @return [WrappedResponse]
     def delete_group group_id
-      ensuring_logon do
-        begin
-          @response = client.request :deleteGroup do
-            soap.body = {
-              :session  => auth_token,
-              :memberId => group_id
-            }
-          end
-        rescue Savon::SOAP::Fault => e
-          WrappedResponse.new(e)
-        else
-          WrappedResponse.new(:success => true)
-        end
+      response = client.request :deleteGroup do
+        soap.body = {
+          :session  => obtain_auth_token,
+          :memberId => group_id
+        }
       end
+      WrappedResponse.new(:success => true)
+    rescue Savon::SOAP::Fault => e
+      WrappedResponse.new(e)
     end
 
     # Delete a member.
@@ -156,34 +106,37 @@ module Ecircle
     # @param [Integer] member_id ecircle member id
     # @return [WrappedResponse]
     def delete_member member_id
-      ensuring_logon do
-        begin
-          @response = client.request :deleteMember do
-            soap.body = {
-              :session  => auth_token,
-              :memberId => member_id
-            }
-          end
-        rescue Savon::SOAP::Fault => e
-          WrappedResponse.new(e)
-        else
-          WrappedResponse.new(:success => true)
-        end
+      client.request :deleteMember do
+        soap.body = {
+          :session  => obtain_auth_token,
+          :memberId => member_id
+        }
       end
+      WrappedResponse.new(:success => true)
+    rescue Savon::SOAP::Fault => e
+      WrappedResponse.new(e)
     end
 
     # Logon. You don't need to call this explicitly but it's useful for debugging.
     #
     # @return [String] the session id
     def logon
-      @response = client.request :logon do
+      response = client.request :logon do
         soap.body = {
           :user   => Ecircle.configuration.user,
           :realm  => Ecircle.configuration.sync_realm,
           :passwd => Ecircle.configuration.password
         }
       end
-      @response.body[:logon_response][:logon_return].to_s
+      response.body[:logon_response][:logon_return].to_s
+    rescue Savon::SOAP::Fault => e
+      wrapped_response = WrappedResponse.new(e)
+      if wrapped_response.not_authenticated? || wrapped_response.permission_problem?
+        puts @@help
+        raise InvalidLoginCredentials
+      else
+        raise
+      end
     end
 
     # Log out. Uses the last session token.
@@ -206,23 +159,28 @@ module Ecircle
     # @param [Array] the values of the variables you want to interpolate in the template
     # @return [WrappedResponse]
     def send_parametrized_single_message_to_user user_id, message_id, names = [], values = []
-      ensuring_logon do
-        begin
-          client.request :sendParametrizedSingleMessageToUser do
-            soap.body = {
-              :session           => auth_token,
-              :singleMessageId   => message_id,
-              :userId            => user_id,
-              :names             => names,
-              :values            => values
-            }
-          end
-        rescue Savon::SOAP::Fault => e
-          WrappedResponse.new(e)
-        else
-          WrappedResponse.new(:success => true)
-        end
+      client.request :sendParametrizedSingleMessageToUser do
+        soap.body = {
+          :session           => obtain_auth_token,
+          :singleMessageId   => message_id,
+          :userId            => user_id,
+          :names             => names,
+          :values            => values
+        }
       end
+      WrappedResponse.new(:success => true)
+    rescue Savon::SOAP::Fault => e
+      WrappedResponse.new(e)
+    end
+
+    def obtain_auth_token
+      @auth_token = logon unless auth_token_valid?
+      @auth_token_last_used_at = Time.now
+      @auth_token
+    end
+
+    def auth_token_valid?
+      @auth_token_last_used_at && Time.now - @auth_token_last_used_at < AUTH_TOKEN_TIMEOUT
     end
   end
 end

data/lib/ecircle/version.rb

@@ -1,3 +1,3 @@
 module Ecircle
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/spec/ecircle/api_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe Ecircle::Api do
+  describe 'obtain_auth_token' do
+    it 'should obtain an auth token for the first time' do
+      savon.expects(:logon).returns(:success)
+      subject.obtain_auth_token
+    end
+
+    it 'should touch auth_token_last_used_at' do
+      savon.expects(:logon).returns(:success)
+      before_call = Time.now
+      subject.obtain_auth_token
+
+      auth_token_last_used_at = subject.instance_variable_get('@auth_token_last_used_at')
+      before_call.should <= auth_token_last_used_at
+      auth_token_last_used_at.should <= Time.now
+    end
+
+    it 'should return the token' do
+      savon.expects(:logon).returns(:success)
+      subject.obtain_auth_token.should eq('foo')
+    end
+
+    describe 'subsequent calls' do
+      before do
+        savon.expects(:logon).returns(:success)
+        @auth_token = subject.obtain_auth_token
+      end
+
+      it 'should re-use auth token' do
+        savon.expects(:logon).never
+        subject.obtain_auth_token.should eq(@auth_token)
+      end
+
+      it 'should touch auth_token_last_used_at' do
+        before_call = Time.now
+        subject.obtain_auth_token
+
+        auth_token_last_used_at = subject.instance_variable_get('@auth_token_last_used_at')
+        before_call.should <= auth_token_last_used_at
+        auth_token_last_used_at.should <= Time.now
+      end
+
+      it 'should request another auth token if current one expired' do
+        subject.instance_variable_set('@auth_token_last_used_at', Time.now - Ecircle::Api::AUTH_TOKEN_TIMEOUT - 1)
+        savon.expects(:logon).returns(:success)
+        subject.obtain_auth_token
+      end
+    end
+  end
+
+  describe 'create_member' do
+    it 'should obtain an auth token' do
+      savon.stubs(:createMember).returns(:success)
+      subject.expects(:obtain_auth_token)
+
+      subject.create_member(nil, nil)
+    end
+
+    it 'should pass proper parameters' do
+      savon.expects(:createMember).
+        with(:session => 'foo', :userId => 1, :groupId => 2,
+             :invite => 'false', :sendMessage => 'false').
+        returns(:success)
+      subject.stubs(:obtain_auth_token).returns('foo')
+
+      wrapped_response = subject.create_member(1, 2)
+    end
+
+    it 'should parse proper response segment' do
+      savon.stubs(:createMember).returns(:success)
+      subject.stubs(:obtain_auth_token)
+
+      wrapped_response = subject.create_member(nil, nil)
+
+      wrapped_response.ecircle_id.should eq('123456')
+    end
+  end
+end

data/spec/fixtures/create_member/success.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><soapenv:Body><createMemberResponse xmlns="http://webservices.ecircleag.com/rpcns"><createMemberReturn>123456</createMemberReturn></createMemberResponse></soapenv:Body></soapenv:Envelope>

data/spec/fixtures/logon/success.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><soapenv:Body><logonResponse xmlns="http://webservices.ecircleag.com/rpcns"><logonReturn>foo</logonReturn></logonResponse></soapenv:Body></soapenv:Envelope>

data/spec/spec_helper.rb

@@ -1,7 +1,5 @@
-dir = File.dirname(__FILE__)
-require File.join(dir, '..', 'lib', 'ecircle')
-
-require 'random_data'
+Bundler.require
+require 'savon_spec'
 
 def random_group_email suffix
   "apitest#{Random.number(100000)}@#{suffix}"
@@ -17,3 +15,12 @@ end
 def test_user_id
   @ecircle_user_id ||= Ecircle.create_or_update_user_by_email(:email => 'apitest@apitest.com').ecircle_id
 end
+
+Savon::Spec::Fixture.path = File.expand_path('../fixtures', __FILE__)
+
+RSpec::configure do |c|
+  c.include Savon::Spec::Macros
+  c.treat_symbols_as_metadata_keys_with_true_values = true
+  c.filter_run :focus => true
+  c.run_all_when_everything_filtered = true
+end

metadata

@@ -1,112 +1,128 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: ecircle
-version: !ruby/object:Gem::Version
-  version: 0.1.3
+version: !ruby/object:Gem::Version 
   prerelease: 
+  version: 0.1.4
 platform: ruby
-authors:
-- Timo Rößner
+authors: 
+- "Timo R\xC3\xB6\xC3\x9Fner"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-23 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2011-11-28 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: activesupport
-  requirement: &81840600 !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :runtime
   prerelease: false
-  version_requirements: *81840600
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: i18n
-  requirement: &81840390 !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :runtime
   prerelease: false
-  version_requirements: *81840390
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: &81840180 !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :runtime
   prerelease: false
-  version_requirements: *81840180
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: savon
-  requirement: &81839920 !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
         version: 0.9.7
   type: :runtime
   prerelease: false
-  version_requirements: *81839920
-- !ruby/object:Gem::Dependency
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: random_data
-  requirement: &81839640 !ruby/object:Gem::Requirement
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - =
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *81839640
-- !ruby/object:Gem::Dependency
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &81839350 !ruby/object:Gem::Requirement
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - =
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *81839350
-- !ruby/object:Gem::Dependency
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: savon_spec
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.1.6
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
   name: yard
-  requirement: &81802840 !ruby/object:Gem::Requirement
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
   prerelease: false
-  version_requirements: *81802840
-- !ruby/object:Gem::Dependency
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
   name: ruby-debug19
-  requirement: &81802590 !ruby/object:Gem::Requirement
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
   prerelease: false
-  version_requirements: *81802590
+  version_requirements: *id009
 description: The ecircle gem aims to be a full-fledged client for all ecircle services.
-email:
+email: 
 - timo.roessner@googlemail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
+- .rspec
 - .rvmrc
 - .travis.yml
 - .yardopts
@@ -123,37 +139,44 @@ files:
 - lib/ecircle/version.rb
 - lib/ecircle/wrapped_response.rb
 - spec/api_spec.rb.disabled
+- spec/ecircle/api_spec.rb
+- spec/fixtures/create_member/success.xml
+- spec/fixtures/logon/success.xml
 - spec/job_package_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: ""
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -815952973
+      segments: 
       - 0
-      hash: 733065171
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -815952973
+      segments: 
       - 0
-      hash: 733065171
+      version: "0"
 requirements: []
+
 rubyforge_project: ecircle
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Ecircle gem
 test_files: []
+
 has_rdoc: