ecircle 0.1.0 → 0.1.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ecircle (0.1.0)
+    ecircle (0.1.1)
       activesupport
       i18n
       rake

data/README.md

@@ -12,39 +12,6 @@ The API coverage is far from complete, however as far as I can see the most usef
 
 The existing API methods can be considered stable and are used in production.
 
-Features
--------------
-
-###Synchronous API
-
-The following methods are implemented:
-
-* createMember
-* createOrUpdateGroup
-* createOrUpdateUserByEmail
-* deleteGroup
-* deleteMember
-* logon (only for debugging purposes)
-* logout
-* sendParametrizedSingleMessageToUser
-
-See the [online API documentation](http://rubydoc.info/github/troessner/ecircle/master/frames) for details on arguments and return values
-
-###Asnchronous API
-
-Since the asynchronous API is neither documented by ecircle nor intuitive at all, you're on your own. Jump to the examples section and good luck.
-
-To do
--------------
-
-* Fix TODOs in source code
-* Implement missing API methods:
- * deleteUser
- * deleteUserByEmail
- * lookupGroups
-* Write specs
-
-
 Installation
 -------------
 
@@ -54,7 +21,6 @@ Either as a gem:
 
 or via Bundler by adding it to your Gemfile.
 
-
 Configuration
 -------------
 
@@ -64,16 +30,9 @@ Configuration
       config.password   = 'your_password'
     end
 
-
 The reason for the unusual configuration setting "sync_realm" is that there is also an asynchronous ecircle API with a different realm.
 
-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.
-
-Response
+Response handling
 -------------
 
 The ecircle gem will always return a wrapped response for all API methods, except for the logon method (see examples below or the API doc).
@@ -87,12 +46,37 @@ The most usefull (and self-explanatory) would be:
 * fault_code
 * ecircle_id IF the API returns an ID an success, e.g. for create_member and create_or_update_user_by_email
 * convenience methods which depend on your (failed request), e.g.:
-  * member_does_not_exist? (relevant for create_member requests)
-  * TODO Explain all convenience methods.
+  * member_does_not_exist? (delete_member requests)
+  * message_id_does_not_exist? (send_parametrized_message_to_user requests)
+  * no_such_group? (create_member requests)
+  * no_such_user? (create_member_requests)
 
 For details see [here](http://rubydoc.info/github/troessner/ecircle/master/Ecircle/WrappedResponse)
 
-Examples
+Features
+-------------
+
+###Synchronous API
+
+The following methods are implemented:
+
+* createMember
+* createOrUpdateGroup
+* createOrUpdateUserByEmail
+* deleteGroup
+* deleteMember
+* logon (only for debugging purposes)
+* logout
+* sendParametrizedSingleMessageToUser
+
+See the [online API documentation](http://rubydoc.info/github/troessner/ecircle/master/frames) for details on arguments and return values
+
+###Asnchronous API
+
+Since the asynchronous API is neither documented by ecircle nor intuitive at all, you're on your own. Jump to the examples section and good luck.
+
+
+Using ecircle
 -------------
 
 ### Synchronous API
@@ -155,6 +139,21 @@ Note the async_realm in the configure block, this another realm as for the sync
 
     Ecircle::JobPackage.send_async_message_to_group @options
 
+To do
+-------------
+
+* Implement missing API methods:
+ * deleteUser
+ * deleteUserByEmail
+ * lookupGroups
+* Write specs
+
+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.
+
 Documentation
 -------------
 

data/lib/ecircle/api.rb

@@ -15,34 +15,15 @@ module Ecircle
     #@private
     def ensuring_logon &block
       begin
-        @auth_token ||= logon
+        @auth_token = logon
+        block.call
       rescue Savon::SOAP::Fault => e
         # If we are here this probably means that our login credentials are wrong.
         wrapped_response = WrappedResponse.new(e)
         if wrapped_response.permission_problem?
           puts @@help
-          raise
-        end
-      end
-
-      first_try = true
-      begin
-        block.call
-      rescue Savon::SOAP::Fault => e
-        # If we are here that probably means that our session token has expired.
-        wrapped_response = WrappedResponse.new(e)
-        if wrapped_response.permission_problem?
-          if first_try
-            first_try = false
-            @auth_token = logon
-            retry
-          else
-            puts "!!! Could not re-authenticate after session expired: #{wrapped_response.inspect} !!!"
-            raise
-          end
-        else
-          raise  # Re-raise cause something else went wrong.
         end
+        raise
       end
     end
 

data/lib/ecircle/version.rb

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

data/lib/ecircle/wrapped_response.rb

@@ -22,27 +22,29 @@ module Ecircle
       end
     end
 
+    # Useful for `delete_member` requests.
+    # @return [Boolean]
     def member_does_not_exist?
-      @fault_code == 100
-    end
-
-    def group_does_not_exist?
-      @fault_code == 500
+      @fault_code == 100 && @error_message == 'No Member Id'
     end
 
+    # This method will tell you if referred to a user id that doesn't exist for ecircle.
+    # Usefull for create_member requests
     def no_such_user?
-      @fault_code == 500
+      @fault_code == 103 && @error_message == 'No such User'
     end
 
+    # If you do a create_member request where the group id you pass in doesn't exist you get back a "permission problem".
+    # Yes, I know. It hurts.
+    # @return [Boolean]
     def permission_problem?
       @fault_code == 502 && @error_message = 'Permission Problem'
     end
+    alias :no_such_group? :permission_problem?
 
-    def no_such_group_when_a_user_was_given?
-      # YES, this IS horrible. Thanks ecircle. "Group does not exist" error codes vary depending on context.
-      @fault_code == 502 && @error_message = 'Permission Problem'
-    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/
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ecircle
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-17 00:00:00.000000000Z
+date: 2011-11-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &75171370 !ruby/object:Gem::Requirement
+  requirement: &74974340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *75171370
+  version_requirements: *74974340
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &75170720 !ruby/object:Gem::Requirement
+  requirement: &74973630 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *75170720
+  version_requirements: *74973630
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &75169990 !ruby/object:Gem::Requirement
+  requirement: &74972700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *75169990
+  version_requirements: *74972700
 - !ruby/object:Gem::Dependency
   name: savon
-  requirement: &75169080 !ruby/object:Gem::Requirement
+  requirement: &74971890 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.9.7
   type: :runtime
   prerelease: false
-  version_requirements: *75169080
+  version_requirements: *74971890
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &75166030 !ruby/object:Gem::Requirement
+  requirement: &74968680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -65,10 +65,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *75166030
+  version_requirements: *74968680
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &75165330 !ruby/object:Gem::Requirement
+  requirement: &74967950 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *75165330
+  version_requirements: *74967950
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &75164260 !ruby/object:Gem::Requirement
+  requirement: &74966950 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *75164260
+  version_requirements: *74966950
 description: The ecircle gem aims to be a full-fledged client for all ecircle services.
 email:
 - timo.roessner@googlemail.com
@@ -127,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 36995713
+      hash: 846535155
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 36995713
+      hash: 846535155
 requirements: []
 rubyforge_project: ecircle
 rubygems_version: 1.8.10