ecircle 0.1.1 → 0.1.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ecircle (0.1.1)
+    ecircle (0.1.2)
       activesupport
       i18n
       rake
@@ -30,6 +30,7 @@ GEM
     nori (1.0.2)
     rack (1.3.5)
     rake (0.9.2.2)
+    random_data (1.5.2)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
       rspec-expectations (~> 2.6.0)
@@ -65,6 +66,7 @@ PLATFORMS
 
 DEPENDENCIES
   ecircle!
+  random_data (= 1.5.2)
   rspec (= 2.6.0)
   ruby-debug19
   yard

data/README.md

@@ -146,7 +146,7 @@ To do
  * deleteUser
  * deleteUserByEmail
  * lookupGroups
-* Write specs
+* Add more functional specs
 
 Logon
 -------------
@@ -154,6 +154,18 @@ Logon
 The ecircle gem does the session handling for you, there is no need to logon explicitly.
 Session tokens will be re-used to keep the number of session related traffic to a minimum.
 
+Running the specs
+-------------
+In order to run the functional specs you need to fill in the configuration values at the top of spec/api_spec.rb.disabled
+with your ecircle account data and then rename spec/api_spec.rb.disabled to spec/api_spec.rb.
+
+Currently you need to clean up created groups and members manually afterwards (yes, I know that sucks) since
+ecircle doesn't offer a test api so all tests are going against the live API.
+Without a test API I figured it's too dangerous to execute destructive actions like delete_group so the only actions
+which are actually tested are non-destructive like create_or_update_user.... and so on, but never methods like delete_group.
+Finding data that has been created by the tests is pretty easy, right now there is only one user with email
+'apitest@apitest.com' and one or more groups whose names are 'API TEST' so you can easily find test remnants via the web interface.
+
 Documentation
 -------------
 

data/ecircle.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'i18n'
   s.add_dependency 'rake'
   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 'yard'
   s.add_development_dependency 'ruby-debug19'

data/lib/ecircle.rb

@@ -15,6 +15,8 @@ dir = File.dirname(__FILE__)
 end
 
 module Ecircle
+  class InvalidLoginCredentials < StandardError; end
+
   class << self
 
     #@private

data/lib/ecircle/api.rb

@@ -15,15 +15,33 @@ module Ecircle
     #@private
     def ensuring_logon &block
       begin
-        @auth_token = logon
-        block.call
+        @auth_token ||= logon
       rescue Savon::SOAP::Fault => e
-        # If we are here this probably means that our login credentials are wrong.
+        # If we are here this means that our login credentials are wrong.
         wrapped_response = WrappedResponse.new(e)
-        if wrapped_response.permission_problem?
+        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
-        raise
       end
     end
 
@@ -56,9 +74,11 @@ module Ecircle
             }
           end
         rescue Savon::SOAP::Fault => e
-          return WrappedResponse.new(e)
+          WrappedResponse.new(e)
+        else
+          WrappedResponse.new :success => true,
+                              :ecircle_id => @response.body[:create_member_response][:create_member_return].to_s
         end
-        WrappedResponse.new :success => true, :ecircle_id => @response.body[:create_member_response][:create_member_return].to_s
       end
     end
 
@@ -78,9 +98,11 @@ module Ecircle
             }
           end
         rescue Savon::SOAP::Fault => e
-          return WrappedResponse.new(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
-      WrappedResponse.new :success => true, :ecircle_id => @response[:create_or_update_group_response][:create_or_update_group_return].to_i
       end
     end
 
@@ -100,10 +122,11 @@ module Ecircle
             }
           end
         rescue Savon::SOAP::Fault => e
-          return WrappedResponse.new(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
-        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
     end
 
@@ -121,10 +144,11 @@ module Ecircle
             }
           end
         rescue Savon::SOAP::Fault => e
-          return WrappedResponse.new(e)
+          WrappedResponse.new(e)
+        else
+          WrappedResponse.new(:success => true)
         end
       end
-      WrappedResponse.new(:success => true)
     end
 
     # Delete a member.
@@ -141,10 +165,11 @@ module Ecircle
             }
           end
         rescue Savon::SOAP::Fault => e
-          return WrappedResponse.new(e)
+          WrappedResponse.new(e)
+        else
+          WrappedResponse.new(:success => true)
         end
       end
-      WrappedResponse.new(:success => true)
     end
 
     # Logon. You don't need to call this explicitly but it's useful for debugging.
@@ -193,10 +218,11 @@ module Ecircle
             }
           end
         rescue Savon::SOAP::Fault => e
-          return WrappedResponse.new(e)
+          WrappedResponse.new(e)
+        else
+          WrappedResponse.new(:success => true)
         end
       end
-      WrappedResponse.new(:success => true)
     end
   end
 end

data/lib/ecircle/version.rb

@@ -1,3 +1,3 @@
 module Ecircle
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/ecircle/wrapped_response.rb

@@ -42,11 +42,15 @@ module Ecircle
     end
     alias :no_such_group? :permission_problem?
 
+    def not_authenticated?
+      @fault_code == 501 && @error_message == 'Not authenticated'
+    end
+
     # This method will tell you if you referred to a message id that ecircle doesn't know about.
     # Usefull for send_parametrized_message_to_user requests.
     # @return[Boolean]
     def message_id_does_not_exist?
-      @error_message =~ /MessageInfo '(\d+)' not found/
+      !!(@error_message =~ /MessageInfo '(\d+)' not found/)
     end
 
     def success?

data/spec/api_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+describe Ecircle::Api do
+  #IMPORTANT:
+  #In order to run the functional specs you need to fill in the configuration values at the top of spec/api_spec.rb.disabled
+  #with your ecircle account data and then rename spec/api_spec.rb.disabled to spec/api_spec.rb.
+  #
+  #Currently you need to clean up created groups and members manually afterwards (yes, I know that sucks) since
+  #ecircle doesn't offer a test api so all tests are going against the live API.
+  #Without a test API I figured it's too dangerous to execute destructive actions like delete_group so the only actions
+  #which are actually tested are non-destructive like create_or_update_user.... and so on, but never methods like delete_group.
+  #Finding data that has been created by the tests is pretty easy, right now there is only one user with email
+  #'apitest@apitest.com' and one or more groups whose names are 'API TEST' so you can easily find test remnants via the web interface.
+  # TODO Add more edge cases where things can go wrong, e.g. create_or_update_user with an invalid email etc.
+  before :each do
+    Ecircle.configure do |config|
+      config.user        = ''
+      config.sync_realm  = ''
+      config.password    = ''
+    end
+    @email_suffix = '' # This MUST be your ecircle domain e.g. 'newsletter.your.company.com'
+    # You need to create this message before in the webinterface, there's no way of doing this automatically.
+    @test_message_id = '1200095137'
+  end
+
+  describe 'ensuring_logon' do
+    context 'wrong credentials' do
+      it 'should immediately raise an exception' do
+        Ecircle.configuration.password = 'invalid'
+        expect do
+          dummy_proc = Proc.new {}
+          Ecircle.api.ensuring_logon &dummy_proc
+        end.to raise_error(Ecircle::InvalidLoginCredentials)
+      end
+
+      context 'stale session token' do
+        it 'should retry exactly once to obtain a new token' do
+          response = Ecircle::WrappedResponse.new :success => false
+          response.stub(:not_authenticated?).and_return(true)
+          dummy_proc = Proc.new { response }
+          expect do
+            Ecircle.api.ensuring_logon &dummy_proc
+          end.to raise_error
+        end
+      end
+    end
+  end
+
+  describe 'create_or_update_group' do
+    it 'should return the ecircle id' do
+      group_attributes = { :name        => 'API TEST',
+                           :description => 'API TEST',
+                           :email       => random_group_email(@email_suffix) }
+      res = Ecircle.create_or_update_group group_attributes
+      res.success?.should be_true
+      res.ecircle_id.to_s.should =~ /\d+/
+    end
+  end
+
+  describe 'create_member' do
+    it 'should create a member' do
+      group_id = create_random_group @email_suffix
+      user_id  = test_user_id
+      res = Ecircle.create_member user_id, group_id
+      res.success?.should be_true
+      res.ecircle_id.to_s.should =~ /\d+/
+    end
+  end
+
+  describe 'create_or_update_user_by_email' do
+    it 'should return the ecircle id' do
+      res = Ecircle.create_or_update_user_by_email :email => 'apitest@apitest.com'
+      res.success?.should be_true
+      res.ecircle_id.to_s.should =~ /\d+/
+    end
+  end
+
+  describe 'delete_group' do
+    # TODO Implement but ONLY once ecircle provides a test API.
+  end
+
+  describe 'delete_member' do
+    # TODO Implement but ONLY once ecircle provides a test API.
+  end
+
+  describe 'send_parametrized_single_message_to_user' do
+    it 'should return success' do
+      res = Ecircle.send_parametrized_single_message_to_user test_user_id, @test_message_id
+      res.success?.should be_true
+    end
+
+    it 'should return a corresponding error message if the template does not exist' do
+      res = Ecircle.send_parametrized_single_message_to_user test_user_id, Random.number(10000)
+      res.success?.should be_false
+      res.message_id_does_not_exist?.should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,2 +1,19 @@
 dir = File.dirname(__FILE__)
 require File.join(dir, '..', 'lib', 'ecircle')
+
+require 'random_data'
+
+def random_group_email suffix
+  "apitest#{Random.number(100000)}@#{suffix}"
+end
+
+def create_random_group suffix
+  group_attributes = { :name        => 'API TEST',
+                       :description => 'API TEST',
+                       :email       => random_group_email(suffix) }
+  @ecircle_group_id ||= Ecircle.create_or_update_group(group_attributes).ecircle_id
+end
+
+def test_user_id
+  @ecircle_user_id ||= Ecircle.create_or_update_user_by_email(:email => 'apitest@apitest.com').ecircle_id
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ecircle
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-22 00:00:00.000000000Z
+date: 2011-11-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &74974340 !ruby/object:Gem::Requirement
+  requirement: &85674020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *74974340
+  version_requirements: *85674020
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &74973630 !ruby/object:Gem::Requirement
+  requirement: &85673810 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *74973630
+  version_requirements: *85673810
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &74972700 !ruby/object:Gem::Requirement
+  requirement: &85673600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *74972700
+  version_requirements: *85673600
 - !ruby/object:Gem::Dependency
   name: savon
-  requirement: &74971890 !ruby/object:Gem::Requirement
+  requirement: &85673350 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,21 @@ dependencies:
         version: 0.9.7
   type: :runtime
   prerelease: false
-  version_requirements: *74971890
+  version_requirements: *85673350
+- !ruby/object:Gem::Dependency
+  name: random_data
+  requirement: &85673080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *85673080
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &74968680 !ruby/object:Gem::Requirement
+  requirement: &85672810 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -65,10 +76,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *74968680
+  version_requirements: *85672810
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &74967950 !ruby/object:Gem::Requirement
+  requirement: &85672580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *74967950
+  version_requirements: *85672580
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &74966950 !ruby/object:Gem::Requirement
+  requirement: &85636880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +98,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *74966950
+  version_requirements: *85636880
 description: The ecircle gem aims to be a full-fledged client for all ecircle services.
 email:
 - timo.roessner@googlemail.com
@@ -111,6 +122,7 @@ files:
 - lib/ecircle/job_package.rb
 - lib/ecircle/version.rb
 - lib/ecircle/wrapped_response.rb
+- spec/api_spec.rb
 - spec/job_package_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -127,7 +139,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 846535155
+      hash: 207876449
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -136,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 846535155
+      hash: 207876449
 requirements: []
 rubyforge_project: ecircle
 rubygems_version: 1.8.10