email_vision 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+spec/account.yml
+example.php

data/Rakefile

@@ -0,0 +1,55 @@
+task :default => :spec
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new {|t| t.spec_opts = ['--color --backtrace']}
+
+def account
+  YAML.load(File.read('spec/account.yml')) rescue {}
+end
+
+def email_vision
+  @email_vision ||= begin
+    $LOAD_PATH << 'lib'
+    require 'email_vision'
+    require 'yaml'
+    EmailVision.new(account)
+  end
+end
+
+desc 'possible actions'
+task :actions do
+  unnecessary_actions = [:open_api_connection, :close_api_connection]
+  actions = email_vision.send(:connection).wsdl.soap_actions
+  puts (actions - unnecessary_actions).map{|x|" - #{x}"}.sort.join("\n")
+end
+
+desc 'test update here, since it takes forever to be processed'
+task :test_update do
+  user = account[:changeable_user]
+  value = rand(1111111)
+  email_vision.update(user[:email], :firstname => value)
+  start = Time.now
+  loop do
+    sleep 5
+    puts (Time.now - start).to_i
+    data = email_vision.find(user[:email])
+    break if data[:firstname] == value.to_s
+  end
+  puts "SUCCESS!!!!!! #{(Time.now - start).to_i}"
+end
+
+begin
+  require 'jeweler'
+  project_name = 'email_vision'
+  Jeweler::Tasks.new do |gem|
+    gem.name = project_name
+    gem.summary = "Ruby SOAP Api Client for EmailVision / CampaignCommander"
+    gem.email = "grosser.michael@gmail.com"
+    gem.homepage = "http://github.com/grosser/#{project_name}"
+    gem.authors = ["Michael Grosser"]
+    gem.add_dependency 'savon'
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
+end

data/Readme.md

@@ -0,0 +1,28 @@
+EmailVision SOAP Api Client
+
+    gem install email_vision
+
+Usage
+=====
+
+    emv = EmailVision.new(:password => 'foo', :login => 'bar', :key => 'token')
+    emv.find 'me@host.com'
+    emv.create_or_update :email => 'me@host.com', :foo => 1
+
+    emv.create :email => 'me@host.com', :foo => 1
+    emv.update :email => 'me@host.com', :foo => 1
+    emv.change_email 'me@host.com', 'you@host.com'
+
+    emv.columns
+
+    emv.unjoin 'me@host.com'
+    emv.rejoin 'me@host.com'
+
+    # create, create_or_update, update, change_email return a job-id
+    emv.job_status job_id
+
+Author
+======
+[Michael Grosser](http://pragmatig.wordpress.com)  
+grosser.michael@gmail.com  
+Hereby placed under public domain, do what you want, just do not hold me accountable...

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/email_vision.gemspec

@@ -0,0 +1,46 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{email_vision}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Grosser"]
+  s.date = %q{2010-07-31}
+  s.email = %q{grosser.michael@gmail.com}
+  s.files = [
+    ".gitignore",
+     "Rakefile",
+     "Readme.md",
+     "VERSION",
+     "email_vision.gemspec",
+     "lib/email_vision.rb",
+     "spec/account.yml.example",
+     "spec/email_vision_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/grosser/email_vision}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Ruby SOAP Api Client for EmailVision / CampaignCommander}
+  s.test_files = [
+    "spec/email_vision_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<savon>, [">= 0"])
+    else
+      s.add_dependency(%q<savon>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<savon>, [">= 0"])
+  end
+end
+

data/lib/email_vision.rb

@@ -0,0 +1,109 @@
+require 'savon'
+
+class EmailVision
+  WSDL = "http://emvapi.emv3.com/apimember/services/MemberService?wsdl"
+  SESSION_TIMEOUT = 10*60
+  VERSION = File.read( File.join(File.dirname(__FILE__),'..','VERSION') ).strip
+  attr_accessor :options
+
+  def initialize(options)
+    self.options = options
+  end
+
+  def find(email_or_id)
+    result = execute_by_email_or_id(:get_member, email_or_id)
+    return unless result.is_a?(Hash)
+    result = convert_to_hash(result[:attributes][:entry], :key, :value)
+    result.reject{|k,v| v.nil? }
+  end
+
+  def unjoin(email_or_id)
+    execute_by_email_or_id(:unjoin_member, email_or_id)
+  end
+
+  def rejoin(email_or_id)
+    execute_by_email_or_id(:rejoin_member, email_or_id)
+  end
+
+  def update(attributes)
+    execute_by_obj(:update_member_by_obj, attributes)
+  end
+
+  def update_email(old, new)
+    execute(:update_member, :email => old, :field => :email, :value => new)
+  end
+
+  def create(attributes)
+    execute_by_obj(:insert_member_by_obj, attributes)
+  end
+
+  def create_or_update(attributes)
+    execute_by_obj(:insert_or_update_member_by_obj, attributes)
+  end
+
+  # should be one of: Insert, Processing, Processed, Error, Job_Done_Or_Does_Not_Exist
+  def job_status(job_id)
+    execute(:get_member_job_status, :synchro_id => job_id)[:status]
+  end
+
+  def columns
+    result = execute(:desc_member_table)
+    result = convert_to_hash(result[:fields], :name, :type)
+    result.each{|k,v| result[k] = to_ruby_style(v)}
+    result
+  end
+
+  private
+
+  def connection
+    unless connected?
+      response = client.open_api_connection{|r|
+        r.body = {
+          :login => options[:login],
+          :pwd => options[:password],
+          :key => options[:key]
+        }
+      }
+      @token = response.to_hash[:open_api_connection_response][:return]
+      @token_requested = Time.now.to_i
+    end
+    client
+  end
+
+  def client
+    @client ||= Savon::Client.new WSDL
+  end
+
+  def connected?
+    @token and @token_requested > (Time.now.to_i - SESSION_TIMEOUT)
+  end
+
+  def execute_by_email_or_id(method, email_or_id)
+    if email_or_id.to_s.include?('@')
+      execute("#{method}_by_email", :email => email_or_id)
+    else
+      execute("#{method}_by_id", :id => email_or_id)
+    end
+  end
+
+  def to_ruby_style(name)
+    name.downcase.to_sym
+  end
+
+  def execute_by_obj(method, attributes)
+    entries = attributes.map{|k,v| {:entry => {:key => k, :value => v}}}
+    execute(method, :member => {:email => attributes[:email], :dynContent => entries})
+  end
+
+  def execute(method, options={})
+    response = connection.send(method){|r| r.body = options.merge(:token => @token) }
+    response.to_hash["#{method}_response".to_sym][:return]
+  end
+
+  def convert_to_hash(entries, key, value)
+    entries.inject({}) do |hash, part|
+      hash[to_ruby_style(part[key])] = part[value]
+      hash
+    end
+  end
+end

data/spec/account.yml.example

@@ -0,0 +1,9 @@
+:login: api_your_host
+:password: your_password
+:key: your_api_key
+:test_user: # this must be the complete data of a user currently in email vision
+  :gender: "0"
+  :email: test@test.de
+  :datejoin: 2009-12-07T13:36:15+01:00
+  :firstname: Test
+  :member_id: "1014086935042"

data/spec/email_vision_spec.rb

@@ -0,0 +1,157 @@
+$LOAD_PATH << 'lib'
+require 'rubygems'
+require 'email_vision'
+
+describe "EmailVision" do
+  let(:email){"#{rand(1111111)}.foo@justatest.com"}
+  let(:random_value){rand(11111111111).to_s}
+  let(:expired_token){'Duy-M5FktALawBJ7dZN94s6hLEgLGKXC_j7cCqlDUMXRGw2shqHYbR9Zud_19EBtFkSCbJ0ZmrZ_d0ieBqgR'}
+
+  # updates need some time to finish on the server...
+  def wait_for_job_to_finish
+    job_id = yield
+    20.times do
+      sleep 5
+      puts status = client.job_status(job_id)
+      return if status == 'Job_Done_Or_Does_Not_Exist'
+    end
+    raise "Job not finished in time!"
+  end
+
+  def reset_email
+    email = client.find(changeable_user[:member_id])[:email]
+    wait_for_job_to_finish do
+      client.update_email(email, changeable_user[:email])
+    end
+    email = client.find(changeable_user[:member_id])[:email]
+    email.should == changeable_user[:email]
+  end
+
+  let(:config){YAML.load(File.read('spec/account.yml'))}
+  let(:client){EmailVision.new(config)}
+  let(:findable_user) do
+    data = config[:findable_user]
+    data[:datejoin] = DateTime.parse(data[:datejoin].to_s)
+    data
+  end
+  let(:changeable_user){config[:changeable_user]}
+
+  it "has a VERSION" do
+    EmailVision::VERSION.should =~ /^\d+\.\d+\.\d+$/
+  end
+
+  it "can call more than one method" do
+    first = client.find(findable_user[:email])
+    first.should == client.find(findable_user[:email])
+  end
+
+  it "can reconnect when token is expired" do
+    client.instance_variable_set('@token', expired_token)
+    client.instance_variable_set('@token_requested', Time.now.to_i - EmailVision::SESSION_TIMEOUT - 10)
+    client.find(findable_user[:email])[:email].should == findable_user[:email]
+  end
+
+  describe :find do
+    it "can find by email" do
+      response = client.find(findable_user[:email])
+      response.should == findable_user
+    end
+
+    it "can find by id" do
+      response = client.find(findable_user[:member_id])
+      response.should == findable_user
+    end
+
+    it "is nil when nothing was found" do
+      client.find('foo@bar.baz').should == nil
+    end
+  end
+
+  describe :update do
+    it "can update a attribute" do
+      wait_for_job_to_finish do
+        client.update(:email => changeable_user[:email], :firstname => random_value)
+      end
+      puts data = client.find(changeable_user[:email])
+      data[:firstname].should == random_value
+
+      # it does not overwrite other attributes
+      data[:lastname].should == changeable_user[:lastname]
+    end
+
+    it "returns a job id" do
+      job_id = client.update(:email => changeable_user[:email], :firstname => random_value)
+      client.job_status(job_id).should == 'Insert'
+    end
+  end
+
+  describe :update_email do
+    after do
+      reset_email
+    end
+
+    it "updates the email" do
+      wait_for_job_to_finish do
+        client.update_email(changeable_user[:email], email)
+      end
+      client.find(email)[:email].should == email
+    end
+  end
+
+  describe :create_or_update do
+    it "can create a record" do
+      wait_for_job_to_finish do
+        client.create_or_update(:email => email, :firstname => 'first-name')
+      end
+      data = client.find(email)
+      data[:firstname].should == 'first-name'
+    end
+
+    it "can update a record" do
+      wait_for_job_to_finish do
+        client.create_or_update(:email => changeable_user[:email], :firstname => random_value)
+      end
+      data = client.find(changeable_user[:email])
+      data[:firstname].should == random_value
+    end
+  end
+
+  describe :create do
+    it "can create a record" do
+      wait_for_job_to_finish do
+        client.create(:email => email, :firstname => 'first-name')
+      end
+      data = client.find(email)
+      data[:firstname].should == 'first-name'
+    end
+  end
+
+  describe :columns do
+    it "can read them" do
+      data = client.columns
+      data[:dateunjoin].should == :date
+    end
+  end
+
+  describe :unjoin do
+    it "can unjoin a member" do
+      wait_for_job_to_finish do
+        client.unjoin(changeable_user[:email])
+      end
+      date = client.find(changeable_user[:email])[:dateunjoin]
+      date.is_a?(DateTime).should == true
+      Time.parse(date.to_s).should be_close(Time.now, 40)
+    end
+  end
+
+  describe :rejoin do
+    it "can rejoin a member" do
+      wait_for_job_to_finish do
+        client.rejoin(changeable_user[:email])
+      end
+      date = client.find(changeable_user[:email])[:datejoin]
+      date.is_a?(DateTime).should == true
+      Time.parse(date.to_s).should be_close(Time.now, 40)
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: email_vision
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-31 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: savon
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: grosser.michael@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Rakefile
+- Readme.md
+- VERSION
+- email_vision.gemspec
+- lib/email_vision.rb
+- spec/account.yml.example
+- spec/email_vision_spec.rb
+has_rdoc: true
+homepage: http://github.com/grosser/email_vision
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ruby SOAP Api Client for EmailVision / CampaignCommander
+test_files: 
+- spec/email_vision_spec.rb