postal 0.2.3 → 0.3.0

data/lib/postal/member.rb

@@ -7,9 +7,13 @@ module Postal
         unless args.find { |arg| arg.match(/ListName/) }
           args << "ListName=#{Postal.options[:list_name]}"
         end
-        if soap_members = Postal.driver.selectMembers(args)
-          return parse_members(soap_members)
-        else
+        begin
+          if soap_members = Postal.driver.selectMembers(args)
+            return parse_members(soap_members)
+          else
+            return nil
+          end
+        rescue
           return nil
         end
       end
@@ -45,7 +49,7 @@ module Postal
           begin
             return find_by_filter("EmailAddress=#{email}")
             # return Postal.driver.getMemberID(Postal::Lmapi::SimpleMemberStruct.new(list_name,member_id,email))
-          rescue SOAP::FaultError
+          rescue Savon::SOAP::Fault => soap_fault
             return nil
           end
         end
@@ -70,19 +74,28 @@ module Postal
           end
         end
       
-        def parse_members(raw)
-          members = raw.collect do |member|
-            demographics = {}
-            member.demographics.each { |demo| demographics.merge!({ demo.name.to_sym => demo.value }) }
-            Member.new(:email => member.emailAddress, :name => member.fullName, :id => member.memberID, :list_name => member.listName, :demographics => demographics)
+        def parse_members(return_hash)
+          case return_hash[:item]
+          when Hash
+            member = build_member_from_hash(return_hash[:item])
+          when Array 
+            members = return_hash[:item].each do |member|
+              build_member_from_hash(member)
+            end
           end
-          if members.size == 1
-            return members.first
+          if member
+            return member
           else
             return members
           end
         end
         
+        def build_member_from_hash(member_hash)
+          demographics = {}
+          member_hash[:demographics][:item].each { |demo| demographics.merge!({ demo[:name].to_sym => demo[:value] }) }
+          Member.new(:email => member_hash[:email_address], :name => member_hash[:full_name], :id => member_hash[:member_id], :list_name => member_hash[:list_name], :demographics => demographics)
+        end
+        
     end
     
     DEFAULT_ATTRIBUTES = { :id => nil, :email => nil, :name => nil, :list_name => nil, :demographics => {} }
@@ -109,7 +122,7 @@ module Postal
         @id = Postal.driver.createSingleMember(@email, @name, list_name)
         update_attributes(@demographics) unless @demographics.empty?
         return @id
-      rescue SOAP::FaultError
+      rescue Savon::SOAP::Fault
         return false
       end
     end
@@ -123,14 +136,19 @@ module Postal
         raise Postal::CouldNotCreateMember, 'Could not create a new member. The most likely cause is that the specified list already contains this email address.'
       end
     end
+
+
+    def unsubscribe
+      list_name = @list_name
+      return Postal.driver.unsubscribe(list_name, @id, @email)
+    end
     
     
     # Update the demographics for a user
     def update_attributes(attributes={})
       list_name = @list_name
-      demos = attributes.collect { |key,value| Postal::Lmapi::KeyValueType.new(value,key.to_s) }
-      member = Postal::Lmapi::SimpleMemberStruct.new(list_name, @id, @email)
-      return Postal.driver.updateMemberDemographics(member,demos)
+      demos = attributes.collect { |key,value| {'Name' => key, 'Value' => value} }
+      return Postal.driver.updateMemberDemographics(list_name, @id, @email, demos)
     end
     
     

data/lib/postal/version.rb

@@ -0,0 +1,3 @@
+module Postal
+  VERSION = "0.3.0"
+end

data/postal.gemspec

@@ -1,11 +1,32 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "postal/version"
 
+Gem::Specification.new do |s|
+  s.name        = "postal"
+  s.version     = Postal::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['The Active Network']
+  s.email       = ['']
+  s.homepage    = ""
+  s.summary     = %q{Lyris is an enterprise email service. Postal makes it easy for Ruby to talk to Lyris's API.}
+  s.description = %q{Lyris is an enterprise email service. Postal makes it easy for Ruby to talk to Lyris's API.}
+
+  s.rubyforge_project = "postal"
+
+  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('savon', '=0.9.7')
+end
+
+
+=begin
 Gem::Specification.new do |s|
   s.name = %q{postal}
-  s.version = "0.2.3"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["The Active Network"]
@@ -57,16 +78,6 @@ Gem::Specification.new do |s|
      "test/test_helper.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<soap4r>, [">= 1.5.8"])
-    else
-      s.add_dependency(%q<soap4r>, [">= 1.5.8"])
-    end
-  else
-    s.add_dependency(%q<soap4r>, [">= 1.5.8"])
-  end
 end
+=end
+

data/test/content_test.rb

@@ -6,8 +6,8 @@ class ContentTest < Test::Unit::TestCase
 
   def setup
     load_config
-    Postal.options[:list_name] = 'active-casting'
-    Postal.options[:proxy] = "http://localhost:8888/"
+    #Postal.options[:list_name] = 'active-casting'
+    #Postal.options[:proxy] = "http://localhost:8888/"
   end
   
   def test_selecting_all_content

data/test/list_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative 'test_helper'
 
 class ListTest < Test::Unit::TestCase
   

data/test/mailing_test.rb

@@ -6,7 +6,7 @@ class MailingTest < Test::Unit::TestCase
 
   def setup
     load_config
-    Postal.options[:proxy] = "http://localhost:8888/"
+    #Postal.options[:proxy] = "http://localhost:8888/"
   end
   
   def test_can_send_valid_mailing

data/test/member_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require './test_helper'
 
 class MemberTest < Test::Unit::TestCase
   
@@ -12,14 +12,15 @@ class MemberTest < Test::Unit::TestCase
     delete_test_members
   end
   
+=begin
   # members
   def test_can_create_member
     assert Postal::Member.new(:email => "john.doe#{rand(1000000)}@anonymous.com", :name => "John Doe").save
     assert Postal::Member.new(:email => "john.doe#{rand(1000000)}@anonymous.com", :name => "John Doe").save!
-    assert Postal::Member.new(:email => "john.doe#{rand(1000000)}@anonymous.com").save              # create member with no name
-    assert Postal::Member.new(:email => "john.doe#{rand(1000000)}@anonymous.com").save!             # create member with no name
+    assert Postal::Member.new(:email => "john.doe#{rand(1000000)}@anonymous.com").save # create member with no name
+    assert Postal::Member.new(:email => "john.doe#{rand(1000000)}@anonymous.com").save! # create member with
   end
-  
+
   def test_can_create_member_with_explicit_list
     assert Postal::Member.new(:email => "john.doe#{rand(1000000)}@anonymous.com", :name => "John Doe", :list_name => @config['list_name']).save
   end
@@ -58,7 +59,14 @@ class MemberTest < Test::Unit::TestCase
     assert Postal::Member.find(new_member.email)
     assert Postal::Member.find(new_member.email, @config['list_name'])    # with explicit list_name
   end
+=end
+
+  def test_can_unsubscribe_member
+    new_member = Postal::Member.create(:email => "john.doe#{rand(1000000)}@anonymous.com", :name => "John Doe")
+    assert new_member.unsubscribe
+  end
   
+=begin
   def test_can_find_member_by_filters
     Postal::Member.create(:email => "john.doe#{rand(1000000)}@anonymous.com", :name => "John Doe")
     Postal::Member.create(:email => "john.doe#{rand(1000000)}@anonymous.com", :name => "John Doe 2")
@@ -93,5 +101,5 @@ class MemberTest < Test::Unit::TestCase
     assert member.update_attributes(:field_0 => 'Baseball')
     assert_equal Postal::Member.find(new_member.email).demographics[:field_0], 'Baseball'
   end
-  
+=end
 end

data/test/test_helper.rb

@@ -1,9 +1,8 @@
 require 'rubygems'
 require 'test/unit'
-# require 'shoulda'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'test'))
 require 'postal'
 
 class Test::Unit::TestCase

metadata

@@ -1,52 +1,51 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: postal
-version: !ruby/object:Gem::Version 
-  version: 0.2.3
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - The Active Network
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-01-29 00:00:00 -08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: soap4r
+date: 2012-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: &70139391646780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.9.7
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.5.8
-    version: 
-description: Lyris is an enterprise email service. Postal makes it easy for Ruby to talk to Lyris's API.
-email: rob.cameron@active.com
+  prerelease: false
+  version_requirements: *70139391646780
+description: Lyris is an enterprise email service. Postal makes it easy for Ruby to
+  talk to Lyris's API.
+email:
+- ''
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
-files: 
+extra_rdoc_files: []
+files:
 - .document
 - .gitignore
+- Gemfile
+- Gemfile.lock
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/postal.rb
 - lib/postal/base.rb
 - lib/postal/content.rb
+- lib/postal/driver.rb
 - lib/postal/list.rb
-- lib/postal/lmapi/lmapi.rb
-- lib/postal/lmapi/lmapi_driver.rb
-- lib/postal/lmapi/lmapi_mapping_registry.rb
 - lib/postal/mailing.rb
 - lib/postal/member.rb
+- lib/postal/version.rb
 - postal.gemspec
 - test/content_test.rb
 - test/list_test.rb
@@ -56,38 +55,36 @@ files:
 - test/member_test.rb
 - test/postal_suite.rb
 - test/test_helper.rb
-has_rdoc: true
-homepage: http://github.com/activenetwork/postal
+homepage: ''
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.5
+rubyforge_project: postal
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Gem for talking to the Lyris API
-test_files: 
+summary: Lyris is an enterprise email service. Postal makes it easy for Ruby to talk
+  to Lyris's API.
+test_files:
 - test/content_test.rb
 - test/list_test.rb
 - test/lmapiClient.rb
+- test/lyris_sample.yml
 - test/mailing_test.rb
 - test/member_test.rb
 - test/postal_suite.rb

data/README.rdoc

@@ -1,108 +0,0 @@
-== Introduction
-
-Postal is a gem for working with the Lyris API. "But the Lyris API is just a SOAP service, why
-don't I use something like Soap4r?" Well you could, but it wouldn't be very pretty. When the
-interface is created all properties passed to a method are required and always in a certain order.
-
-Postal does use the Soap4r interface behind the scenes but gives you a simple ActiveRecord-like
-interface for search and adding records.
-
-== Installation
-
-Get the gem:
-
-  gem sources -a http://gems.github.com
-  sudo gem install cannikin-postal
-  
-Then to use just add the require to your script:
-
-  require 'rubygems'
-  require 'postal'
-  
-== Usage
-
-Postal feels a lot like using ActiveRecord. You create/save new Members, find existing ones, etc.
-All of the examples below assume you've already set up Postal with your username, password and WSDL
-endpoint, and optionally the name of the list that all operations should use:
-
-  Postal.options[:wsdl] = 'http://mymailserver.com:82/?wsdl'
-  Postal.options[:username] = 'username'
-  Postal.options[:password] = 'password'
-  Postal.options[:list_name] = 'my-test-list'
-
-If you don't set your list name in the options you can pass it in with each method call.
-
-See the /test directory for examples of just about everything you can do with Postal.
-
-=== Lists
-
-  # find a list based on its name
-  Postal::List.find('my-list-name')
-  
-=== Members
-
-  # add a member to a list (the list saved to Postal.options)
-  new_member = Postal::Member.new(:email => "john.doe@anonymous.com", :name => "John Doe")
-  id = new_member.save
-  # id => 1234567 (the new member_id in Lyris)
-  
-  # add a member to a specific list and save in one call (both lines are equivalent)
-  Postal::Member.new(:email => "john.doe@anonymous.com", :name => "John Doe", :list_name => "new-list").save
-  Postal::Member.create(:email => "john.doe@anonymous.com", :name => "John Doe", :list_name => "new-list")
-  
-Postal also has a `save!` method that throws an error if the person can't be saved, rather than just
-returning false.
-
-  # update a member's demographics
-  new_member = Postal::Member.new(:email => "john.doe@anonymous.com", :name => "John Doe")
-  new_member.save
-  new_member.update_attributes(:field_0 => 'Male')
-  
-  # find a member's id based on an email address
-  Postal::Member.find('john.doe@anonymous.com')
-  
-  # find a member based on member_id
-  Postal::Member.find(1234567)
-  
-  # find a member based on Lyris "filters" (see Lyris API docs for syntax)
-  Postal::Member.find_by_filter('EmailAddress like john.doe%')
-  
-  # delete member(s) based on filters
-  Postal::Member.destroy("EmailAddress like john.doe-delete%")
-  
-=== Mailings
-
-  # directly send an email to an array of email addresses
-  mail = Postal::Mailing.new( :to => ['john.doe@anonymous.com','jane.doe@anonymous.com'], 
-                              :html_message => "<p>Test from Postal at #{Time.now.to_s}</p>", 
-                              :text_message => 'Test test from Postal at #{Time.now.to_s}', 
-                              :from => 'Postmaster <postmaster@company.com>',
-                              :subject => 'Test from Postal')
-  mail.valid?
-  mail.send
-  
-Mailings require a couple things to be valid, mainly someone to send to, a subject, and 
-the name of a list to send to. `mail.valid?` will return false if any of these do not exist.
-
-== To Do
-
-* Implement wrappers for remaining Lyris methods
-
-== Thanks
-
-Special thanks to this article: http://markthomas.org/2007/09/12/getting-started-with-soap4r/
-Mark details how to use Soap4r (for which there is very little documentation in the world) and
-his example includes talking to Lyris! Postal probably couldn't have happened without his article.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2009 Rob Cameron. See LICENSE for details.