ecircle 0.0.5 → 0.0.6

data/.travis.yml

@@ -0,0 +1 @@
+rvm: 1.9.2

data/Gemfile.lock

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

data/README.md

@@ -1,4 +1,7 @@
+[![Build Status](https://secure.travis-ci.org/troessner/ecircle.png)](http://travis-ci.org/troessner/ecircle)
 
+Synopsis
+-------------
 
 This gem aims to be a full-fledged solution for the ecircle API, the [synchronous one](http://webservices.ecircle-ag.com/soap/javadoc/com/ecircleag/webservices/EcMApi.html) and the [asynchronous one](http://developer.ecircle-ag.com/apiwiki/wiki/AsynchronousAPI).
 

data/Rakefile

@@ -1 +1,7 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/ecircle/client.rb

@@ -1,5 +1,48 @@
 module Ecircle
   class Client
+    attr_accessor :auth_token
+
+    def ensuring_logon &block
+      begin
+        @auth_token ||= logon
+      rescue Savon::SOAP::Fault => e
+        # If we are here this probably means that our login credentials are wrong.
+        response = e.to_hash
+        if response[:fault][:faultcode] == 'soapenv:Server.userException' && response[:fault][:detail][:fault][:code] == '502'
+          help = <<-doc
+          !!!
+          Got an authentication exception, chances are good that you're credentials are wrong, so better double check that.
+          You can explicitly check for it by calling something like:
+          Ecircle.configure do..
+          Ecircle.logon
+          !!!
+          doc
+          puts help
+        else
+          puts "!!! Got an unexpected fault code from Savon: #{response.inspect} !!!"
+        end
+        raise
+      rescue => e
+        puts  "!!! Got unexpected non-Savon exception: #{e.class} !!!"
+        raise
+      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.
+        if first_try
+          first_try = false
+          @auth_token = logon
+          retry
+        else
+          puts "!!! Could not re-authenticate after session expired: #{e.to_hash.inspect} !!!"
+          raise
+        end
+      end
+    end
+
     def client
       @client ||= Savon::Client.new do
         wsdl.document =  Ecircle.configuration.wsdl
@@ -9,40 +52,43 @@ module Ecircle
     end
 
     def create_member user_id, group_id, invite = false, send_message = false
-      session_id = logon
-      @response = client.request :createMember do
-        soap.body = {
-          :session     => session_id,
-          :userId      => user_id,
-          :groupId     => group_id,
-          :invite      => invite.to_s,
-          :sendMessage => send_message.to_s
-        }
+      ensuring_logon do
+        @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
+        @response.body[:create_member_response][:create_member_return].to_s
       end
-      @response.body[:create_member_response][:create_member_return].to_s
     end
 
     def create_or_update_user_by_email email
-      session_id = logon
-      @response = client.request :createOrUpdateUserByEmail do
-        soap.body = {
-          :session     => session_id,
-          :userXml     => "<user><email>#{email}</email></user>",
-          :sendMessage => 0
-        }
+      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     => "<user><email>#{email}</email></user>",
+            :sendMessage => 0
+          }
+        end
+        @response.body[:create_or_update_user_by_email_response][:create_or_update_user_by_email_return].to_s
       end
-      @response.body[:create_or_update_user_by_email_response][:create_or_update_user_by_email_return].to_s
     end
 
     def delete_member member_id
-      session_id = logon
-      @response = client.request :deleteMember do
-        soap.body = {
-          :session  => session_id,
-          :memberId => member_id
-        }
+      ensuring_logon do
+        @response = client.request :deleteMember do
+          soap.body = {
+            :session  => auth_token,
+            :memberId => member_id
+          }
+        end
+        @response.body[:delete_member_response][:delete_member_return].to_s
       end
-      @response.body[:delete_member_response][:delete_member_return].to_s
     end
 
     def logon
@@ -57,15 +103,16 @@ module Ecircle
     end
 
     def send_parametrized_single_message_to_user user_id, message_id, names = [], values = []
-      session_id = logon
-      @response = client.request :sendParametrizedSingleMessageToUser do
-        soap.body = {
-          :session           => session_id,
-          :singleMessageId   => message_id,
-          :userId            => user_id,
-          :names             => names,
-          :values            => values
-        }
+      ensuring_logon do
+        @response = client.request :sendParametrizedSingleMessageToUser do
+          soap.body = {
+            :session           => auth_token,
+            :singleMessageId   => message_id,
+            :userId            => user_id,
+            :names             => names,
+            :values            => values
+          }
+        end
       end
     end
   end

data/lib/ecircle/helper.rb

@@ -3,7 +3,9 @@ module Ecircle
     extend self
 
     def date_format date
-      date.strftime("%Y-%m-%dT%H:%M:%S")
+      tz = date.strftime('%z')
+      matcher = /(.*)(00)/.match(tz) # We need to do that because ecircle won't accept +0200, just +02:00.
+      "#{date.strftime('%Y-%m-%dT%H:%M:%S')}#{matcher[1]}:#{matcher[2]}"
     end
   end
 end

data/lib/ecircle/job_package.rb

@@ -4,11 +4,11 @@ module Ecircle
 
     def self.send_async_message_to_group(options)
       client = Savon::Client.new do
-        wsdl.endpoint = 'http://webservices.ecircle-ag.com/ws'
+        wsdl.endpoint  = options[:endpoint]
         wsdl.namespace = "http://webservices.ecircleag.com/ws"
       end
 
-      response = client.request :control, 'xmlns' => "http://webservices.ecircle-ag.com/ecm", 'request-id' => options[:request_id], 'group-id' => options[:group_id] do
+      response = client.request :postGroupRequest,  'xmlns' => 'http://webservices.ecircle-ag.com/ws' do
         soap.header =  { :authenticate => { :realm    => Ecircle.configuration.async_realm,
                                             :email    => Ecircle.configuration.user,
                                             :password => Ecircle.configuration.password },
@@ -19,47 +19,49 @@ module Ecircle
 
     def self.soap_body(options)
       xml = Builder::XmlMarkup.new(:indent => 2)
-      xml.message 'message-id' => 'new', 'delete' => 'false' do
-        xml.tag! 'sendout-preferences' do
-          xml.tag! 'object-handling', 'html-images' => 'untouched'
-          xml.tag! 'email-channel', 'preferred-format' => 'email-html-multipart'
-        end
-        xml.tag! 'send-date' do
-          xml.date Helper.date_format(options[:send_out_date])
-        end
-        xml.tag! 'send-report-address' do
-          xml.tag! 'email-address' do
-            xml.email options[:report_email]
-            xml.name "Send report for newsletter for location #{options[:location_name]} sent out on #{options[:send_out_date]}"
+      xml.control 'xmlns' => "http://webservices.ecircle-ag.com/ecm", 'request-id' => options[:request_id], 'group-id' => options[:group_id] do
+        xml.message 'message-id' => 'new', 'delete' => 'false' do
+          xml.tag! 'sendout-preferences' do
+            xml.tag! 'object-handling', 'html-images' => 'untouched'
+            xml.tag! 'email-channel', 'preferred-format' => 'email-html-multipart'
           end
-        end
-        xml.tag! 'status-report', 'report-id' => 'new', 'delete' => 'false', 'user-tracking-details' => 'false',  'link-tracking-details' => 'false', 'bouncing-details' => 'false' do
-          xml.tag! 'report-address' do
+          xml.tag! 'send-date' do
+            xml.date Helper.date_format(options[:send_out_date])
+          end
+          xml.tag! 'send-report-address' do
             xml.tag! 'email-address' do
               xml.email options[:report_email]
-              xml.name "Status report for newsletter for location #{options[:location_name]} sent out on #{options[:send_out_date]}"
+              xml.name "Send report for newsletter for location #{options[:location_name]} sent out on #{options[:send_out_date]}"
             end
           end
-          xml.tag! 'send-date' do
-            xml.date Helper.date_format(options[:send_date_for_report])
+          xml.tag! 'status-report', 'report-id' => 'new', 'delete' => 'false', 'user-tracking-details' => 'false',  'link-tracking-details' => 'false', 'bouncing-details' => 'false' do
+            xml.tag! 'report-address' do
+              xml.tag! 'email-address' do
+                xml.email options[:report_email]
+                xml.name "Status report for newsletter for location #{options[:location_name]} sent out on #{options[:send_out_date]}"
+              end
+            end
+            xml.tag! 'send-date' do
+              xml.date Helper.date_format(options[:send_date_for_report])
+            end
+          end
+          xml.content 'target-content-encoding' => TARGET_CONTENT_ENCODING do
+            xml.subject options[:subject], 'target-encoding' => TARGET_CONTENT_ENCODING
+            xml.text options[:text], 'target-content-encoding' => TARGET_CONTENT_ENCODING
+            xml.html options[:html], 'target-content-encoding' => TARGET_CONTENT_ENCODING
           end
         end
-        xml.content 'target-content-encoding' => TARGET_CONTENT_ENCODING do
-          xml.subject options[:subject], 'target-encoding' => TARGET_CONTENT_ENCODING
-          xml.text options[:text], 'target-content-encoding' => TARGET_CONTENT_ENCODING
-          xml.html options[:html], 'target-content-encoding' => TARGET_CONTENT_ENCODING
-        end
-      end
-      xml.tag! 'success-report-address' do
-        xml.tag! 'email-address' do
-          xml.email options[:report_email]
-          xml.name "Success report for newsletter for location #{options[:location_name]} sent out on #{options[:send_out_date]}"
+        xml.tag! 'success-report-address' do
+          xml.tag! 'email-address' do
+            xml.email options[:report_email]
+            xml.name "Success report for newsletter for location #{options[:location_name]} sent out on #{options[:send_out_date]}"
+          end
         end
-      end
-      xml.tag! 'failure-report-address' do
-        xml.tag! 'email-address' do
-          xml.email options[:report_email]
-          xml.name "Failure report for newsletter for location #{options[:location_name]} sent out on #{options[:send_out_date]}"
+        xml.tag! 'failure-report-address' do
+          xml.tag! 'email-address' do
+            xml.email options[:report_email]
+            xml.name "Failure report for newsletter for location #{options[:location_name]} sent out on #{options[:send_out_date]}"
+          end
         end
       end
       xml.target!

data/lib/ecircle/version.rb

@@ -1,3 +1,3 @@
 module Ecircle
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/client_spec.rb

@@ -16,8 +16,7 @@ describe Ecircle::JobPackage do
     }
 
     @doc = <<xml
-<?xml version="1.0" encoding="UTF-8"?>
-<control xmlns="http://webservices.ecircle-ag.com/ecm" request-id="#{@options[:request_id]}" group-id="#{@options[:group_id]}">
+<control xmlns="http://webservices.ecircle-ag.com/ecm" request-id="1234" group-id="5678">
   <message message-id="new" delete="false">
     <sendout-preferences>
       <object-handling html-images="untouched"/>
@@ -67,7 +66,7 @@ xml
 
   describe 'xml_for_asynch_calls' do
     it 'should generate valid xml' do
-      Ecircle::JobPackage.xml_for_asynch_calls(@options).should == @doc
+      Ecircle::JobPackage.soap_body(@options).should == @doc
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ecircle
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-25 00:00:00.000000000Z
+date: 2011-11-02 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &81915150 !ruby/object:Gem::Requirement
+  requirement: &78327690 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *81915150
+  version_requirements: *78327690
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &81914550 !ruby/object:Gem::Requirement
+  requirement: &78326710 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *81914550
+  version_requirements: *78326710
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &81914140 !ruby/object:Gem::Requirement
+  requirement: &78325790 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *81914140
+  version_requirements: *78325790
 - !ruby/object:Gem::Dependency
   name: savon
-  requirement: &81913720 !ruby/object:Gem::Requirement
+  requirement: &78324890 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.9.7
   type: :runtime
   prerelease: false
-  version_requirements: *81913720
+  version_requirements: *78324890
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &81879230 !ruby/object:Gem::Requirement
+  requirement: &78323840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -65,7 +65,7 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *81879230
+  version_requirements: *78323840
 description: The ecircle gem aims to be a full-fledged client for all ecircle services.
 email:
 - timo.roessner@googlemail.com
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rvmrc
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -102,7 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -975259857
+      hash: 645926193
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -111,10 +112,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -975259857
+      hash: 645926193
 requirements: []
 rubyforge_project: ecircle
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Ecircle gem