ecircle 0.0.2

data/.gitignore

@@ -0,0 +1,3 @@
+.idea
+pkg
+runner.rb

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create ruby-1.9.2-p180@ecircle

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    ecircle (0.0.2)
+      active_support
+      i18n
+      rake
+      savon (>= 0.9.7)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    active_support (3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    akami (1.0.0)
+      gyoku (>= 0.4.0)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    gyoku (0.4.4)
+      builder (>= 2.1.2)
+    httpi (0.9.5)
+      rack
+    i18n (0.6.0)
+    nokogiri (1.5.0)
+    nori (1.0.2)
+    rack (1.3.4)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    savon (0.9.7)
+      akami (~> 1.0)
+      builder (>= 2.1.2)
+      gyoku (>= 0.4.0)
+      httpi (~> 0.9)
+      nokogiri (>= 1.4.0)
+      nori (~> 1.0)
+      wasabi (~> 2.0)
+    wasabi (2.0.0)
+      nokogiri (>= 1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ecircle!
+  rspec (= 2.6.0)

data/README.md

@@ -0,0 +1,44 @@
+
+
+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).
+
+This is WIP and far from complete.
+
+Features
+-------------
+
+So far just a couple of methods:
+
+* create_member
+* create_or_update_user_by_email
+* delete_member
+* logon
+* send_parametrized_single_message_to_user
+
+To do
+-------------
+
+* Rethink current structure e.g.
+ * doing an explicit logon in every method is ugly at best
+ * inefficient handling of session token (we could and should reuse it instead of requesting a new one every time)
+* Implement missing API methods
+* Specs
+* RDoc
+
+Configuration
+-------------
+
+```Ruby
+Ecircle.configure do |config|
+  config.user     = 'your@user.com'
+  config.realm    = 'http://your.realm.com'
+  config.password = 'your_password'
+end
+```
+
+Usage
+-------------
+
+```Ruby
+Ecircle.create_or_update_user_by_email 'user@email.com'
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/ecircle.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ecircle/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ecircle"
+  s.version     = Ecircle::VERSION
+  s.authors     = ["Timo Rößner"]
+  s.email       = ["timo.roessner@googlemail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Ecircle gem}
+  s.description = %q{The ecircle gem aims to be a full-fledged client for all ecircle services.}
+
+  s.rubyforge_project = "ecircle"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'active_support'
+  s.add_dependency 'i18n'
+  s.add_dependency 'rake'
+  s.add_dependency 'savon', '>=0.9.7'
+  s.add_development_dependency 'rspec', '2.6.0'
+end

data/lib/ecircle.rb

@@ -0,0 +1,37 @@
+require 'bundler'
+require 'active_support/all'
+require 'savon'
+
+# TODO Improve requiring of gems.
+# `Bundler.require :default` works for an irb session with `require lib/ecircle` (e.g. Savon exists)
+# but this won't work from within the rails project since `Bundler.require :default` uses the current rails
+# projects Gemfile, not ecircle's one. Not sure if there is a solution for this problem, but I'd
+# rather do requires via bundler instead of explicit requires.
+
+dir = File.dirname(__FILE__)
+
+%w!version configuration client helper job_package!.each do |file|
+  require File.join(dir, 'ecircle', file)
+end
+
+module Ecircle
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def client
+      @client ||= Client.new
+    end
+
+    def configure &block
+      block.call configuration
+    end
+  end
+
+  (Ecircle::Client.instance_methods(false) - [:client]).each do |meth|
+    define_singleton_method meth do |*args|
+      client.send meth, *args
+    end
+  end
+end

data/lib/ecircle/client.rb

@@ -0,0 +1,71 @@
+module Ecircle
+  class Client
+    def client
+      @client ||= Savon::Client.new do
+        wsdl.document =  Ecircle.configuration.wsdl
+        wsdl.endpoint =  Ecircle.configuration.endpoint
+        wsdl.namespace = Ecircle.configuration.namespace
+      end
+    end
+
+    def create_member user_id, group_id, invite = false, sendMessage = false
+      session_id = logon
+      @response = client.request :createMember do
+        soap.body = {
+          :session     => session_id,
+          :userId      => user_id,
+          :groupId     => group_id,
+          :invite      => 0,
+          :sendMessage => 0
+        }
+      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
+        }
+      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
+        }
+      end
+      @response.body[:delete_member_response][:delete_member_return].to_s
+    end
+
+    def logon
+      @response = client.request :logon do
+        soap.body = {
+          :user   => Ecircle.configuration.user,
+          :realm  => Ecircle.configuration.realm,
+          :passwd => Ecircle.configuration.password
+        }
+      end
+      @response.body[:logon_response][:logon_return].to_s
+    end
+
+    def send_parametrized_single_message_to_user user_id, message_id, names = [], values = []
+      @response = client.request :sendParametrizedSingleMessageToUser do
+        soap.body = {
+          :session           => logon,
+          :singleMessageId   => message_id,
+          :userId            => user_id,
+          :names             => names,
+          :values            => values
+        }
+      end
+    end
+  end
+end

data/lib/ecircle/configuration.rb

@@ -0,0 +1,15 @@
+module Ecircle
+  class Configuration
+    WSDL      = 'http://webservices.ecircle-ag.com/soap/ecm.wsdl'
+    ENDPOINT  = 'http://webservices.ecircle-ag.com/rpc'
+    NAMESPACE = "http://webservices.ecircleag.com/rpcns"
+
+    attr_accessor :user, :password, :realm, :wsdl, :endpoint, :namespace
+
+    def initialize
+      @wsdl      = WSDL
+      @endpoint  = ENDPOINT
+      @namespace = NAMESPACE
+    end
+  end
+end

data/lib/ecircle/helper.rb

@@ -0,0 +1,9 @@
+module Ecircle
+  module Helper
+    extend self
+
+    def date_format date
+      date.strftime("%Y-%m-%dT%H:%M:%S")
+    end
+  end
+end

data/lib/ecircle/job_package.rb

@@ -0,0 +1,60 @@
+module Ecircle
+  module JobPackage
+    TARGET_CONTENT_ENCODING = 'ISO-8859-1'
+
+    def self.send_asynch_message_to_group(options)
+      xml = xml_for_asynch_calls(options)
+    end
+
+    def self.xml_for_asynch_calls(options)
+      xml = Builder::XmlMarkup.new(:indent => 2)
+      xml.instruct!
+      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
+          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]}"
+            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! '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.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
+        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!
+    end
+  end
+end

data/lib/ecircle/version.rb

@@ -0,0 +1,3 @@
+module Ecircle
+  VERSION = "0.0.2"
+end

data/spec/client_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Ecircle::JobPackage do
+  before :all do
+    date = 1.hour.from_now
+    @options = {
+      :request_id                   => '1234',
+      :group_id                     => '5678',
+      :send_out_date                => date,
+      :send_date_for_report         => date,
+      :report_email                 => 'report@dealvertise.de',
+      :location_name                => 'Berlin',
+      :subject                      => 'Berlin newsletter',
+      :text                         => 'Newsletter text content',
+      :html                         => 'Newsletter html content'
+    }
+
+    @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]}">
+  <message message-id="new" delete="false">
+    <sendout-preferences>
+      <object-handling html-images="untouched"/>
+      <email-channel preferred-format="email-html-multipart"/>
+    </sendout-preferences>
+    <send-date>
+      <date>#{Ecircle::Helper.date_format(@options[:send_out_date])}</date>
+    </send-date>
+    <send-report-address>
+      <email-address>
+        <email>#{@options[:report_email]}</email>
+        <name>Send report for newsletter for location #{@options[:location_name]} sent out on #{@options[:send_out_date]}</name>
+      </email-address>
+    </send-report-address>
+    <status-report report-id="new" delete="false" user-tracking-details="false" link-tracking-details="false" bouncing-details="false">
+      <report-address>
+        <email-address>
+          <email>#{@options[:report_email]}</email>
+          <name>Status report for newsletter for location #{@options[:location_name]} sent out on #{@options[:send_out_date]}</name>
+        </email-address>
+      </report-address>
+      <send-date>
+        <date>#{Ecircle::Helper.date_format(@options[:send_date_for_report])}</date>
+      </send-date>
+    </status-report>
+    <content target-content-encoding="ISO-8859-1">
+      <subject target-encoding="ISO-8859-1">#{@options[:subject]}</subject>
+      <text target-content-encoding="ISO-8859-1">#{@options[:text]}</text>
+      <html target-content-encoding="ISO-8859-1">#{@options[:html]}</html>
+    </content>
+  </message>
+  <success-report-address>
+    <email-address>
+      <email>#{@options[:report_email]}</email>
+      <name>Success report for newsletter for location #{@options[:location_name]} sent out on #{@options[:send_out_date]}</name>
+    </email-address>
+  </success-report-address>
+  <failure-report-address>
+    <email-address>
+      <email>#{@options[:report_email]}</email>
+      <name>Failure report for newsletter for location #{@options[:location_name]} sent out on #{@options[:send_out_date]}</name>
+    </email-address>
+  </failure-report-address>
+</control>
+xml
+  end
+
+  describe 'xml_for_asynch_calls' do
+    it 'should generate valid xml' do
+      Ecircle::JobPackage.xml_for_asynch_calls(@options).should == @doc
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+dir = File.dirname(__FILE__)
+require File.join(dir, '..', 'lib', 'ecircle')

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification 
+name: ecircle
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.2
+platform: ruby
+authors: 
+- "Timo R\xC3\xB6\xC3\x9Fner"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-23 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: active_support
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: savon
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+description: The ecircle gem aims to be a full-fledged client for all ecircle services.
+email: 
+- timo.roessner@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- ecircle.gemspec
+- lib/ecircle.rb
+- lib/ecircle/client.rb
+- lib/ecircle/configuration.rb
+- lib/ecircle/helper.rb
+- lib/ecircle/job_package.rb
+- lib/ecircle/version.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -289051661
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -289051661
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: ecircle
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Ecircle gem
+test_files: []
+