bolseragency-ecircle 0.1.0

data/lib/ecircle.rb

@@ -0,0 +1,135 @@
+module Ecircle  
+  require 'rubygems'
+  require 'hpricot'
+  gem 'soap4r'
+  require "soap/wsdlDriver"
+  require "builder"
+  
+  class Authentication
+    attr_accessor :driver
+    attr_accessor :session
+    
+    def authenticate(authentication_parameters)
+      require File.expand_path(File.dirname(__FILE__) + '/../synchronous/synchronousDriver')           
+      self.driver = EcMSoapBridge.new
+      self.session = driver.logon(:realm => authentication_parameters['ecmessenger_url'], 
+                                  :user => authentication_parameters['ecmessenger_username'], 
+                                  :passwd => authentication_parameters['ecmessenger_password'] ).logonReturn
+    end
+  end
+    
+  class Member < Authentication    
+    attr_accessor :doc #the xml document from ecircle
+    attr_accessor :email #the persons email address
+    attr_accessor :groupId
+    
+    def self.find_by_email(email, groupId, authentication_parameters)
+      member = Member.new
+      member.authenticate(authentication_parameters)
+      member.email = email      
+      lookup = member.driver.lookupMemberByEmail_v2_0(:session => member.session, :groupId => groupId, :email => email, :onlyActive => false).lookupMemberByEmail_v2_0Return
+      return nil if lookup.nil?
+      member.doc = Hpricot.XML(lookup)  
+      member.groupId = groupId
+      return member
+    end
+    
+    def id
+      @doc.nil? ? nil : (@doc/"member").first.attributes['id'].to_i
+    end
+  
+    
+    def method_missing(method_name, *args)
+      if method_name.to_s =~ /^.*=$/
+        return instance_variable_set("@#{method_name.to_s.gsub('=','')}",  args[0])
+      else
+        unless instance_variable_get("@#{method_name}").nil?
+          return instance_variable_get("@#{method_name}")           
+        end
+        if self.custom_atributes.include?(method_name)
+          if element = (@doc/"namedattr[@name='#{method_name}']")
+            if element.respond_to?(:inner_html)
+              instance_variable_set("@#{method_name}",  element.inner_html) if instance_variable_get("@#{method_name}").nil?
+              return instance_variable_get("@#{method_name}")
+            end
+          end
+        elsif self.standard_attributes.include?(method_name)
+          if element = (@doc/"#{method_name}")
+            if element.respond_to?(:inner_html)
+              instance_variable_set("@#{method_name}",  element.inner_html) if instance_variable_get("@#{method_name}").nil?
+              return instance_variable_get("@#{method_name}")
+            end
+          end
+        end          
+      end  
+      super      
+    end
+
+    
+    def unsubscribe(sendMessage = false)
+      driver.unsubscribeMemberByEmail(:session => session, :email => email, :groupId => groupId, :sendMessage => false).unsubscribeMemberByEmailResponse
+    end
+    
+    def save
+      driver.createOrUpdateUserMemberByEmail(:session => session, :memberXml => self.to_xml, :groupId => groupId, :sendMessage => false)
+    end
+    
+    def self.create(attributes, authentication_parameters)
+      member = Member.new
+      member.authenticate(authentication_parameters)
+      
+      #setup default values of the standard attributes any standard 
+      member.standard_attributes.each { |attribute| member.instance_variable_set("@#{attribute}",  "") }
+      
+      attributes.each do |field, value|
+        member.instance_variable_set("@#{field}", value)
+        unless member.standard_attributes.include?(field)
+          #must be a custom attribute. Add it to the custom_atributes array
+          @custom_attributes = Array.new if @custom_attributes.nil?
+          @custom_attributes << field
+        end
+      end
+      
+
+      member.set_custom_attributes @custom_attributes
+      member.save
+      return member
+    end
+    
+    def to_xml
+      x = Builder::XmlMarkup.new
+      x.member do |member|
+        standard_attributes.each do |attribute|  
+          val = self.send(attribute)
+          eval("member.#{attribute}('#{self.send(attribute)}')") unless self.id.nil? && self.send(attribute) == '' #if value is blank, only set if updating
+        end
+        custom_atributes.each do |attribute| 
+          member.namedattr({:name => attribute}, self.send(attribute)) unless self.id.nil? && self.send(attribute) == '' #if value is blank, only set if updating
+        end
+      end
+    end
+    
+    def custom_atributes
+      @custom_atributes ||= (@doc/"namedattr").collect { |field| field.attributes['name'].to_sym }         
+    end
+    
+    def set_custom_attributes(attributes)
+      @custom_atributes = attributes
+    end
+    
+    def standard_attributes
+      [:email, :title, :firstname, :lastname, :dob_dd, :dob_mm, :dob_yyyy, :countrycode, :languagecode, :nickname,
+       :cust_attr_0, :cust_attr_1, :cust_attr_2, :cust_attr_3, :cust_attr_4, :cust_attr_5, :cust_attr_6, :cust_attr_7,
+       :cust_attr_8, :cust_attr_9]
+    end
+    
+    def send_message(message_id)
+      driver.sendParametrizedSingleMessageToUser(:session => session,
+                                                 :singleMessageId => message_id,
+                                                 :userId => self.id,
+                                                 :names => "",
+                                                 :values => "")
+      
+    end
+  end       
+end

data/spec/ecircle_spec.rb

@@ -0,0 +1,106 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'CGI'
+
+describe "Ecircle" do
+  before(:each) do
+    @configuration = YAML::load( File.open( File.expand_path(File.dirname(__FILE__) + '/ecircle.yml') ) )    
+    @matt = Ecircle::Member.find_by_email("mail@matthewfawcett.co.uk", groupId = 351026868, @configuration)
+  end
+  
+  it "should be able to find a user" do
+    @matt.firstname.should eql("Matt")
+    @matt.lastname.should eql("Fawcett")
+  end
+  
+  it "should return nil if the user is not found" do
+    @fake = Ecircle::Member.find_by_email(email = "fakeuser123588@fakedomain.com", groupId = 351026868, @configuration)
+    @fake.should be_nil
+  end
+  
+  it "should allow me access to custom attributes" do
+    @matt.FullName.should eql("Matt Fawcett")
+  end
+  
+  it "should give me asccess to the user id" do
+    @matt.id.should eql(3500322370)
+  end
+  
+  it "should allow me to update a standard attribute" do
+    #update the name
+    @matt.firstname = "New name"
+    @matt.save
+    # #now refresh and make sure its changed
+    @matt = Ecircle::Member.find_by_email("mail@matthewfawcett.co.uk", groupId = 351026868, @configuration)
+    @matt.firstname.should eql("New name")
+    # #Now reset it back again for future tests
+    @matt.firstname = "Matt"
+    @matt.save
+  end
+  
+  it "should allow me to update a custom attribute" do
+    #update the name
+    @matt.FullName = "New full name"
+    @matt.save
+    #now refresh and make sure its changed
+    @matt = Ecircle::Member.find_by_email("mail@matthewfawcett.co.uk", groupId = 351026868, @configuration)
+    @matt.FullName.should eql("New full name")
+    #Now reset it back again for future tests
+    @matt.FullName = "Matt Fawcett"
+    @matt.save
+  end
+  
+  it "should allow me to set an attribute to blank" do
+    pending #Iv emailed Ecircle as it seems to igore blank fields
+    #update the name
+    @matt.firstname = ""
+    @matt.save
+    # #now refresh and make sure its changed
+    @matt = Ecircle::Member.find_by_email("mail@matthewfawcett.co.uk", groupId = 351026868, @configuration)
+    @matt.firstname.should eql("")
+    # #Now reset it back again for future tests
+    @matt.firstname = "Matt"
+    @matt.save
+  end
+  
+  describe "custom_atributes" do
+    it "should return an array of custom atributes on the user" do
+      @matt.custom_atributes.should include(:Addr1)
+      @matt.custom_atributes.should include(:Addr2)
+      @matt.custom_atributes.should include(:Country)
+      @matt.custom_atributes.should include(:FreeTitle)
+      @matt.custom_atributes.should include(:FullName)
+      @matt.custom_atributes.should include(:LastName)
+      @matt.custom_atributes.should include(:Postcode)
+      @matt.custom_atributes.should include(:RestID)
+      @matt.custom_atributes.should include(:RestName)
+      @matt.custom_atributes.should include(:RestNameCaps)
+      @matt.custom_atributes.should include(:Sport)
+      @matt.custom_atributes.should include(:Tel)
+      @matt.custom_atributes.should include(:TemplateRef)
+      @matt.custom_atributes.should include(:ask_list_id)
+      @matt.custom_atributes.should include(:ask_source_description)
+      @matt.custom_atributes.should include(:xLanguage)
+    end
+  end
+  
+  describe "send_message" do
+    it "should send a message to the user" do
+      @matt.send_message(351197566).should be_true
+    end
+  end
+  
+  describe "creating a new user" do    
+    it "should craete an instance of a new user with standard and custom attributes" do
+      @unique = Time.now.to_i + rand(1000)
+      @user = Ecircle::Member.create({:email => "user_#{@unique}@matthewfawcett.co.uk", 
+                                      :firstname => "FN#{@unique}", 
+                                      :FullName => "Full Name #{@unique}",
+                                      :groupId => 351026868}, 
+                                     @configuration)
+      @user.firstname.should eql("FN#{@unique}")
+      @user.FullName.should eql("Full Name #{@unique}")
+    end
+  
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'ecircle'
+
+Spec::Runner.configure do |config|
+  
+end