fail_mail 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4fb832f8a06a77964741782ed647222f6e07b699
+  data.tar.gz: 35c92f64211ff1ce04051f3c400e8c2ad2a6ab5e
+SHA512:
+  metadata.gz: 6dc10894079897b1558b98819fb7be8329de159380fdb7b3f715c623cdd24331500048a37dbfed2b82a5ce1121348075f08261f7c40b61c6365db3f4bd987baa
+  data.tar.gz: adbc33c69f9bc0d56e98b48c4729cce0c5a285432f39130cd0ff8160fa5bac5360a2e6aca09e9085fee839e709d6cbc6d09da9f1e7c8ada0fa28f9e1cf967f9c

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fail_mail.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Adam Zaninovich
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Fail Mail
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fail_mail'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fail_mail
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/fail_mail.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fail_mail/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fail_mail"
+  spec.version       = FailMail::VERSION
+  spec.authors       = ['Adam Zaninovich']
+  spec.email         = ['adam.zaninovich@gmail.com']
+  spec.homepage      = ""
+  spec.summary       = %q{Lyris is an enterprise email service. FailMail makes it easy for Ruby to talk to Lyris's API.}
+  spec.description   = %q{Lyris is an enterprise email service. FailMail makes it easy for Ruby to talk to Lyris's API.}
+  spec.license       = "MIT"
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency "savon", "~> 2.2.0"
+end

data/lib/fail_mail/base.rb

@@ -0,0 +1,14 @@
+module FailMail
+  class Base
+    attr_reader :client
+
+    def initialize client=FailMail.client
+      @client = client
+    end
+
+    def call *args, &block
+      client.call *args, &block
+    end
+
+  end
+end

data/lib/fail_mail/client.rb

@@ -0,0 +1,19 @@
+require 'savon'
+
+module FailMail
+  class Client
+    def initialize options={}
+      options[:convert_request_keys_to] = :none
+      @lyris_client = Savon.client options
+    end
+
+    def call *args, &block
+      @lyris_client.call *args, &block
+    end
+
+    def operations
+      @lyris_client.operations
+    end
+
+  end
+end

data/lib/fail_mail/configurable.rb

@@ -0,0 +1,16 @@
+module FailMail
+  module Configurable
+
+    def self.keys
+      [:wsdl, :basic_auth]
+    end
+
+    attr_accessor *keys
+
+    def configure
+      yield self
+      self
+    end
+
+  end
+end

data/lib/fail_mail/list.rb

@@ -0,0 +1,8 @@
+module FailMail
+  class List < Base
+
+    def initialize
+    end
+
+  end
+end

data/lib/fail_mail/member.rb

@@ -0,0 +1,71 @@
+module FailMail
+  class Member < Base
+    attr_reader :email, :name
+
+    def initialize email, name, client=FailMail.client
+      super client
+      @email = email
+      @name = name
+    end
+
+    def subscribe! list_name
+      create_member list_name
+    rescue Savon::SOAPFault => exception
+      member_id = extract_member_id_from_exception exception.message, list_name
+      subscribe_member member_id, list_name if member_id
+    end
+
+    def unsubscribe! list_name
+      subscription = subscriptions.find { |sub| sub.list_name == list_name }
+      subscription.unsubscribe! if subscription
+    end
+
+    def subscriptions
+      @subscriptions ||= begin
+        response = call :select_members_ex, message: {
+          FieldsToFetch: { string: %w[MemberID ListName MemberType] },
+          FilterCriteriaArray: { string: ["EmailAddress = #{email}", "MemberType = normal"] }
+        }
+        subscriptions = response.body[:select_members_ex_response][:return][:item]
+        subscriptions.shift
+        subscriptions.map do |list|
+          member_id, list_name, _ = list[:item]
+          FailMail::Subscription.new list_name, member_id, self
+        end
+      end
+    end
+
+    private
+
+    def create_member list_name
+      response = call :create_single_member, message: {
+        EmailAddress: email,
+        FullName: name,
+        ListName: list_name
+      }
+      member_id = response.body[:create_single_member_response][:return]
+      FailMail::Subscription.new list_name, member_id, self
+    end
+
+    def subscribe_member member_id, list_name
+      response = call :update_member_status, message: {
+        MemberStatus: 'needs-confirm',
+        SimpleMemberStructIn: {
+          MemberID: member_id,
+          EmailAddress: email,
+          ListName: list_name
+        }
+      }
+      if response.body[:update_member_status_response][:return]
+        FailMail::Subscription.new list_name, member_id, self
+      end
+    end
+
+    def extract_member_id_from_exception message, list_name
+      e_list_name, e_email, member_id = message.scan(/'([^']*)'/).map &:first
+      member_id if e_list_name == list_name && e_email == email
+    end
+
+  end
+end
+

data/lib/fail_mail/subscription.rb

@@ -0,0 +1,26 @@
+module FailMail
+  class Subscription < Base
+    attr_reader :list_name, :member_id, :member
+
+    def initialize list_name, member_id, member, client=FailMail.client
+      super client
+      @list_name = list_name
+      @member_id = member_id
+      @member = member
+    end
+
+    def unsubscribe!
+      response = call :unsubscribe, message: {
+        SimpleMemberStructArrayIn: {
+          item: {
+            MemberID: member_id,
+            EmailAddress: member.email,
+            ListName: list_name
+          }
+        }
+      }
+      response.body[:unsubscribe_response][:return] == "1"
+    end
+
+  end
+end

data/lib/fail_mail/version.rb

@@ -0,0 +1,3 @@
+module FailMail
+  VERSION = "0.1.1"
+end

data/lib/fail_mail.rb

@@ -0,0 +1,31 @@
+require "fail_mail/version"
+require "fail_mail/configurable"
+require "fail_mail/base"
+require "fail_mail/client"
+require "fail_mail/member"
+require "fail_mail/subscription"
+require "fail_mail/list"
+
+# Configuration Example
+#
+# FailMail.configure do |config|
+#   config.wsdl = "http://example.com/?wsdl"
+#   config.basic_auth = ["username", "password"]
+# end
+
+module FailMail
+  extend FailMail::Configurable
+
+  def self.client
+    FailMail::Client.new options
+  end
+
+  def self.options
+    options = {}
+    FailMail::Configurable.keys.each do |key|
+      options[key] = send key
+    end
+    options
+  end
+
+end

data/spec/fail_mail/list_spec.rb

@@ -0,0 +1,4 @@
+require "spec_helper"
+
+describe FailMail::List do
+end

data/spec/fail_mail/member_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+require 'savon/mock/spec_helper'
+
+describe FailMail::Member do
+  include Savon::SpecHelper
+
+  before(:all) { savon.mock! }
+  after(:all) { savon.unmock! }
+  let(:email) { 'test@example.com' }
+  let(:name) { 'Example User' }
+  let(:member) { FailMail::Member.new email, name }
+
+  describe "initialization" do
+    it "initializes with an email" do
+      member.email.should == email
+    end
+
+    it "initializes with an name" do
+      member.name.should == name
+    end
+
+    it "has a client" do
+      member.client.should be_a FailMail::Client
+    end
+  end
+
+  describe "#subscribe!" do
+    let(:email) { "test@example.com" }
+    let(:list_name) { "my-awesome-list" }
+    let(:member_id) { "123456789" }
+
+    context "when the member is not already on the list" do
+      let(:xml_response) { %Q|<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:ns1="http://tempuri.org/ns1.xsd" xmlns:ns="http://www.lyris.com/lmapi"><SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"><ns:CreateSingleMemberResponse><return xsi:type="xsd:int">#{member_id}</return></ns:CreateSingleMemberResponse></SOAP-ENV:Body></SOAP-ENV:Envelope>| }
+      let(:options) { { message: { EmailAddress: email, FullName: name, ListName: list_name } } }
+
+      it "calls create_single_member and returns something" do
+        savon.expects(:create_single_member).with(options).returns xml_response
+        member.subscribe!(list_name).member_id.should == member_id
+      end
+    end
+
+    context "when the member is already on the list" do
+      let(:create_xml_response) { %Q|<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:ns1="http://tempuri.org/ns1.xsd" xmlns:ns="http://www.lyris.com/lmapi"><SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"><SOAP-ENV:Fault><faultcode>SOAP-ENV:Server</faultcode><faultstring xsi:type="xsd:string">A member already exists on list '#{list_name}' with email address '#{email}', with ID '#{member_id}'</faultstring></SOAP-ENV:Fault></SOAP-ENV:Body></SOAP-ENV:Envelope>| }
+      let(:update_xml_response) { %Q|<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:ns1="http://tempuri.org/ns1.xsd" xmlns:ns="http://www.lyris.com/lmapi"><SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"><ns:UpdateMemberStatusResponse><return xsi:type="xsd:boolean">true</return></ns:UpdateMemberStatusResponse></SOAP-ENV:Body></SOAP-ENV:Envelope>| }
+      let(:create_options) { { message: { EmailAddress: email, FullName: name, ListName: list_name } } }
+      let(:update_options) { { message: { MemberStatus: 'needs-confirm', SimpleMemberStructIn: { MemberID: member_id, EmailAddress: email, ListName: list_name } } } }
+
+      it "calls both create_single_member and update_member_status which returns true" do
+        savon.expects(:create_single_member).with(create_options).returns create_xml_response
+        savon.expects(:update_member_status).with(update_options).returns update_xml_response
+        member.subscribe!(list_name).member_id.should == member_id
+      end
+    end
+
+  end
+
+  describe "#unsubscribe!" do
+    let(:subscription) { FailMail::Subscription.new 'example_list', '1234', member }
+
+    it "calls subscriptions" do
+      subscription.stub :unsubscribe!
+      member.should_receive(:subscriptions).and_return [subscription]
+      member.unsubscribe! 'example_list'
+    end
+
+    it "calls unsubscribe! on the subscription" do
+      subscription.should_receive :unsubscribe!
+      member.stub subscriptions: [subscription]
+      member.unsubscribe! 'example_list'
+    end
+  end
+
+  describe "#subscriptions" do
+    let(:options) { { message: { FieldsToFetch: { string: %w[MemberID ListName MemberType] }, FilterCriteriaArray: { string: ["EmailAddress = #{email}", "MemberType = normal"] } } } }
+    let(:xml_response) { "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SOAP-ENV:Envelope xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:SOAP-ENC=\"http://schemas.xmlsoap.org/soap/encoding/\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:ns1=\"http://tempuri.org/ns1.xsd\" xmlns:ns=\"http://www.lyris.com/lmapi\"><SOAP-ENV:Body SOAP-ENV:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\"><ns:SelectMembersExResponse><return xsi:type=\"SOAP-ENC:Array\" SOAP-ENC:arrayType=\"xsd:string[][2]\"><item xsi:type=\"SOAP-ENC:Array\" SOAP-ENC:arrayType=\"xsd:string[3]\"><item xsi:type=\"xsd:string\">memberid</item><item xsi:type=\"xsd:string\">listname</item><item xsi:type=\"xsd:string\">membertype</item></item><item xsi:type=\"SOAP-ENC:Array\" SOAP-ENC:arrayType=\"xsd:string[3]\"><item xsi:type=\"xsd:string\">114376836</item><item xsi:type=\"xsd:string\">active-trainer2</item><item xsi:type=\"xsd:string\">normal</item></item></return></ns:SelectMembersExResponse></SOAP-ENV:Body></SOAP-ENV:Envelope>" }
+
+    it "returns an array of Subscriptions" do
+      savon.expects(:select_members_ex).with(options).returns xml_response
+      member.subscriptions.first.should be_a FailMail::Subscription
+    end
+  end
+
+end
+

data/spec/fail_mail/subscription_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'savon/mock/spec_helper'
+
+describe FailMail::Subscription do
+  include Savon::SpecHelper
+
+  before(:all) { savon.mock! }
+  after(:all) { savon.unmock! }
+  let(:email) { "test@example.com" }
+  let(:member_id) { "123456789" }
+  let(:list_name) { "my-awesome-list" }
+  let(:member) { FailMail::Member.new email, 'Name' }
+  let(:subscription) { FailMail::Subscription.new list_name, member_id, member }
+
+  describe "initialization" do
+    it "initializes with a list name" do
+      subscription.list_name.should == "my-awesome-list"
+    end
+    it "initializes with a member id" do
+      subscription.member_id.should == "123456789"
+    end
+
+    it "has a client" do
+      subscription.client.should be_a FailMail::Client
+    end
+  end
+
+  describe "#unsubscribe!" do
+    let(:options) { { message: { SimpleMemberStructArrayIn: { item: { MemberID: member_id, EmailAddress: member.email, ListName: list_name } } } } }
+    context "when the response is 1" do
+      let(:xml_response) { "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SOAP-ENV:Envelope xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:SOAP-ENC=\"http://schemas.xmlsoap.org/soap/encoding/\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:ns1=\"http://tempuri.org/ns1.xsd\" xmlns:ns=\"http://www.lyris.com/lmapi\"><SOAP-ENV:Body SOAP-ENV:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\"><ns:UnsubscribeResponse><return xsi:type=\"xsd:int\">1</return></ns:UnsubscribeResponse></SOAP-ENV:Body></SOAP-ENV:Envelope>" }
+
+      it "is true" do
+        savon.expects(:unsubscribe).with(options).returns xml_response
+        response = subscription.unsubscribe!
+        response.should be_true
+      end
+    end
+    context "when the response is 0" do
+      let(:xml_response) { "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SOAP-ENV:Envelope xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:SOAP-ENC=\"http://schemas.xmlsoap.org/soap/encoding/\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:ns1=\"http://tempuri.org/ns1.xsd\" xmlns:ns=\"http://www.lyris.com/lmapi\"><SOAP-ENV:Body SOAP-ENV:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\"><ns:UnsubscribeResponse><return xsi:type=\"xsd:int\">0</return></ns:UnsubscribeResponse></SOAP-ENV:Body></SOAP-ENV:Envelope>" }
+      it "is false" do
+        savon.expects(:unsubscribe).with(options).returns xml_response
+        response = subscription.unsubscribe!
+        response.should be_false
+      end
+    end
+  end
+
+end

data/spec/fail_mail_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe FailMail do
+
+  describe '.client' do
+    it "returns a FailMail::Client" do
+      FailMail.client.should be_a FailMail::Client
+    end
+  end
+
+  describe '.configure' do
+    FailMail::Configurable.keys.each do |key|
+      it "sets the #{key}" do
+        FailMail.configure do |config|
+          config.send "#{key}=", key
+        end
+        FailMail.send(key).should == key
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'fail_mail'
+

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: fail_mail
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Adam Zaninovich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+description: Lyris is an enterprise email service. FailMail makes it easy for Ruby
+  to talk to Lyris's API.
+email:
+- adam.zaninovich@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fail_mail.gemspec
+- lib/fail_mail.rb
+- lib/fail_mail/base.rb
+- lib/fail_mail/client.rb
+- lib/fail_mail/configurable.rb
+- lib/fail_mail/list.rb
+- lib/fail_mail/member.rb
+- lib/fail_mail/subscription.rb
+- lib/fail_mail/version.rb
+- spec/fail_mail/list_spec.rb
+- spec/fail_mail/member_spec.rb
+- spec/fail_mail/subscription_spec.rb
+- spec/fail_mail_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: Lyris is an enterprise email service. FailMail makes it easy for Ruby to
+  talk to Lyris's API.
+test_files:
+- spec/fail_mail/list_spec.rb
+- spec/fail_mail/member_spec.rb
+- spec/fail_mail/subscription_spec.rb
+- spec/fail_mail_spec.rb
+- spec/spec_helper.rb