ecircle 0.0.9 → 0.1.0

data/Gemfile.lock

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

data/README.md

@@ -20,6 +20,7 @@ Features
 The following methods are implemented:
 
 * createMember
+* createOrUpdateGroup
 * createOrUpdateUserByEmail
 * deleteGroup
 * deleteMember
@@ -38,7 +39,6 @@ To do
 
 * Fix TODOs in source code
 * Implement missing API methods:
- * createOrUpdateGroup
  * deleteUser
  * deleteUserByEmail
  * lookupGroups
@@ -76,8 +76,7 @@ Session tokens will be re-used to keep the number of session related traffic to
 Response
 -------------
 
-The ecircle gem will always return a wrapped response. Except for when it doesn't because I didn't find the time which is
-for create_or_update_user_by_email and logon (see examples below or the API doc).
+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).
 
 The wrapped response object is just a neat abstraction to hide Ecircle's horrible, horrible error handling from you and provides several methods for doing so.
 
@@ -101,26 +100,33 @@ Examples
     # Given you have called Ecircle.configure appropriatly...
 
     # 1.) Create a user
-    uid = Ecircle.create_or_update_user_by_email 'your@email.com'
+    r = Ecircle.create_or_update_user_by_email 'your@email.com'
+    uid = r.ecircle_id
     puts "Ecircle user ID: #{uid}"
 
-    # 2.) Add this user as a member to a group - e.g. for newsletters
-    response = Ecircle.create_member uid, 'your_group_id'
-    puts "Ecircle member Id: #{response.ecircle_id}"
+    # 2.) Create a group
+    r = Ecircle.create_or_update_group :name => 'ecircletestgroup', :description => 'ecircletestgroup', :email => 'email@your.ecircle.domain.de'
+    gid = r.ecircle_id
+    puts "Ecircle group ID: #{gid}"
 
-    # 3.) Delete member from group - e.g. when he unsubscribes
+    # 3.) Add this user as a member to a group - e.g. for newsletters
+    r = Ecircle.create_member uid, gid
+    mid = r.ecircle_id
+    puts "Ecircle member Id: #{mid}"
+
+    # 4.) Delete member from group - e.g. when he unsubscribes
     Ecircle.delete_member mid
 
-    # 4.) Send the user a transactional email:
+    # 5.) Send the user a transactional email:
     Ecircle.send_parametrized_single_message_to_user uid,
                                                     your_template_id_at_ecircle,
                                                     [ :name, :message ],
                                                     [ 'Tom', 'welcome!' ]
 
-    # 5.) Delete the group
+    # 6.) Delete the group
     Ecircle.delete_group your_group_id
 
-    # 6.) Log out
+    # 7.) Log out
     Ecircle.logout
 
 

data/lib/ecircle/api.rb

@@ -77,7 +77,7 @@ module Ecircle
         rescue Savon::SOAP::Fault => e
           return WrappedResponse.new(e)
         end
-        WrappedResponse.new(:success => true, :ecircle_id => @response.body[:create_member_response][:create_member_return].to_s)
+        WrappedResponse.new :success => true, :ecircle_id => @response.body[:create_member_response][:create_member_return].to_s
       end
     end
 
@@ -90,16 +90,16 @@ module Ecircle
     def create_or_update_group group_attributes
       ensuring_logon do
         begin
-          client.request :createOrUpdateGroup do
+          @response = client.request :createOrUpdateGroup do
             soap.body = {
               :session   => auth_token,
-              'wsdl:groupXml'  => Helper.build_group_xml(group_attributes)
+              :groupXml  => Helper.build_group_xml(group_attributes)
             }
           end
         rescue Savon::SOAP::Fault => e
           return WrappedResponse.new(e)
         end
-      WrappedResponse.new(:success => true)
+      WrappedResponse.new :success => true, :ecircle_id => @response[:create_or_update_group_response][:create_or_update_group_return].to_i
       end
     end
 
@@ -108,18 +108,21 @@ module Ecircle
     # for an example of the user xml
     # @param [Hash] user_xml, in it's most simple form a { :email => 'test@test.com' } is sufficient
     # @return [Integer] the user id
-    # TODO Error handling is missing.
-    # TODO Return a wrapped response.
     def create_or_update_user_by_email user_attributes
       ensuring_logon do
-        @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
-          }
+        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
+          return WrappedResponse.new(e)
         end
-        @response.body[:create_or_update_user_by_email_response][:create_or_update_user_by_email_return].to_i
+        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
 

data/lib/ecircle/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ecircle
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-11-17 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &84616970 !ruby/object:Gem::Requirement
+  requirement: &75171370 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *84616970
+  version_requirements: *75171370
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &84616320 !ruby/object:Gem::Requirement
+  requirement: &75170720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *84616320
+  version_requirements: *75170720
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &84615600 !ruby/object:Gem::Requirement
+  requirement: &75169990 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *84615600
+  version_requirements: *75169990
 - !ruby/object:Gem::Dependency
   name: savon
-  requirement: &84614520 !ruby/object:Gem::Requirement
+  requirement: &75169080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.9.7
   type: :runtime
   prerelease: false
-  version_requirements: *84614520
+  version_requirements: *75169080
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &84611650 !ruby/object:Gem::Requirement
+  requirement: &75166030 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -65,10 +65,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *84611650
+  version_requirements: *75166030
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &84610850 !ruby/object:Gem::Requirement
+  requirement: &75165330 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *84610850
+  version_requirements: *75165330
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &84609900 !ruby/object:Gem::Requirement
+  requirement: &75164260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *84609900
+  version_requirements: *75164260
 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: 133028911
+      hash: 36995713
 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: 133028911
+      hash: 36995713
 requirements: []
 rubyforge_project: ecircle
 rubygems_version: 1.8.10