interspire 0.1.1 → 0.2.0

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+
+branches:
+  only:
+    - master

data/README.md

@@ -1,4 +1,4 @@
-# Interspire
+# Interspire [![Build Status](https://travis-ci.org/Oshuma/interspire.png?branch=master)](https://travis-ci.org/Oshuma/interspire)
 
 Ruby library for the {http://www.interspire.com/ Interspire} API ({https://www.interspire.com/support/kb/questions/1224/Email+Marketer+XML+API+Documentation pdf}).
 

data/interspire.gemspec

@@ -17,8 +17,9 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_runtime_dependency 'nokogiri'
+  gem.add_runtime_dependency('nokogiri', "~> 1.6")
 
+  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'webmock'
   gem.add_development_dependency 'yard'

data/lib/interspire.rb

@@ -4,5 +4,5 @@ require "interspire/interspire_exception"
 require "interspire/subscriber"
 
 module Interspire
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/interspire/api.rb

@@ -1,5 +1,8 @@
-require 'net/http'
-require 'nokogiri'
+begin
+  require 'net/http'
+  require 'nokogiri'
+rescue LoadError
+end
 
 module Interspire
   # TODO: The methods expecting a list ID should also accept a ContactList object.
@@ -20,9 +23,12 @@ module Interspire
     # @param email [String] The subscriber's email address.
     # @param confirmed [boolean] (optional) +true+ if the subscriber should be set as confirmed; defaults to +false+.
     # @param format [String] (optional) The email format; either +html+ or +text+; defaults to +html+.
+    # @param custom_fields [Hash] (optional) Any custom fields for the subscriber (e.g. {1 => 'Banana', 2 => 'Hamster'})
     #
     # @return [Integer] Returns the subscriber's ID upon success.
-    def add_subscriber(list_id, email, confirmed = false, format = 'html')
+    def add_subscriber(list_id, email, confirmed = false, format = 'html', custom_fields = {})
+      custom_fields_xml = custom_fields.map { |key, value| "<item><fieldid>#{key}</fieldid><value>#{value}</value></item>" }.join
+
       xml = %Q[
         <xmlrequest>
           <username>#{@user}</username>
@@ -34,6 +40,9 @@ module Interspire
             <mailinglist>#{list_id}</mailinglist>
             <format>#{format}</format>
             <confirmed>#{confirmed}</confirmed>
+            <customfields>
+              #{custom_fields_xml}
+            </customfields>
           </details>
         </xmlrequest>
       ]
@@ -165,29 +174,60 @@ module Interspire
     #
     # @return [boolean] +true+ or +false+ if the +email+ is on the given contact list.
     def in_contact_list?(list_id, email)
+      response = check_contact_list(list_id, email)
+
+      if success?(response)
+        # The 'data' element will contain the subscriber ID.
+        ! response.xpath('response/data').first.content.empty?
+      else
+        false
+      end
+    end
+
+    # @param list_id [Integer] The ID of the contact list.
+    # @param email [String] The subscriber's email address.
+    #
+    # @return [Integer] Returns the subscriber's ID upon success.
+    def get_subscriber_id(list_id, email)
+      response = check_contact_list(list_id, email)
+
+      if success?(response)
+        response.xpath('response/data').first.content.to_i
+      else
+        error!(response)
+      end
+    end
+
+    # This is an undocumented API function.  Refer to the 'xml_updatesubscriber.php' attachment
+    # on this page: https://www.interspire.com/support/kb/questions/1217/Email+Marketer+XML+API+usage+and+examples
+    #
+    # @param subscriber_id [Integer] The ID of the subscriber.
+    # @param field_id [Integer] The ID of the custom field
+    # @param data [String] The data of the field
+    #
+    # @return [boolean] Returns +true+ if the field was updated.
+    def update_subscriber_custom_field(subscriber_id, field_id, data)
       xml = %Q[
         <xmlrequest>
-          <username>#{@user}</username>
-          <usertoken>#{@token}</usertoken>
+          <username>#{@username}</username>
+          <usertoken>#{@usertoken}</usertoken>
           <requesttype>subscribers</requesttype>
-          <requestmethod>IsSubscriberOnList</requestmethod>
+          <requestmethod>SaveSubscriberCustomField</requestmethod>
           <details>
-            <emailaddress>#{email}</emailaddress>
-            <listids>#{list_id}</listids>
+            <subscriberids>
+              <id>#{subscriber_id}</id>
+            </subscriberids>
+            <fieldid>#{field_id}</fieldid>
+            <data>#{data}</data>
           </details>
         </xmlrequest>
       ]
 
       response = get_response(xml)
-
-      if success?(response)
-        # The 'data' element will contain the subscriber ID.
-        ! response.xpath('response/data').first.content.empty?
-      else
-        false
-      end
+      success?(response)
     end
 
+
     private
 
     # @param xml [String] A String containing the XML request.
@@ -219,5 +259,22 @@ module Interspire
       raise InterspireException, "#{type}: #{error.empty? ? 'No error message given.' : error}"
     end
 
+    def check_contact_list(list_id, email)
+      xml = %Q[
+        <xmlrequest>
+          <username>#{@user}</username>
+          <usertoken>#{@token}</usertoken>
+          <requesttype>subscribers</requesttype>
+          <requestmethod>IsSubscriberOnList</requestmethod>
+          <details>
+            <emailaddress>#{email}</emailaddress>
+            <listids>#{list_id}</listids>
+          </details>
+        </xmlrequest>
+      ]
+
+      get_response(xml)
+    end
+
   end
 end

data/spec/fixtures/update_subscriber_custom_field.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<response>
+    <status>SUCCESS</status>
+    <data>1</data>
+</response>

data/spec/interspire/api_spec.rb

@@ -80,6 +80,20 @@ describe Interspire::API do
       stub_request(:post, @api_url).to_return(:body => fixture("not_in_contact_list.xml"))
       @api.in_contact_list?(1, 'foo@example.com').should_not be_true
     end
+
+    it 'should get subscriber ID' do
+      stub_request(:post, @api_url).to_return(:body => fixture("in_contact_list.xml"))
+      subscriber_id = @api.get_subscriber_id(1, 'foo@example.com') # '1' is the (fake) contact list ID.
+      subscriber_id.should be_a(Integer)
+    end
+
+    it 'should update the subscriber custom field' do
+      stub_request(:post, @api_url).to_return(:body => fixture("update_subscriber_custom_field.xml"))
+      # '1' is the (fake) contact ID
+      # '2' is the (fake) custom field ID
+      response = @api.update_subscriber_custom_field(1, 2, "Jane")
+      response.should be_true
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: interspire
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,43 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-20 00:00:00.000000000 Z
+date: 2013-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &80803630 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
-  version_requirements: *80803630
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &80803380 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *80803380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &80803110 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +69,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *80803110
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &80802850 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +85,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *80802850
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby library for the Interspire API.
 email:
 - oshuma@gmail.com
@@ -64,6 +100,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -83,6 +120,7 @@ files:
 - spec/fixtures/not_authenticated.xml
 - spec/fixtures/not_in_contact_list.xml
 - spec/fixtures/subscribers.xml
+- spec/fixtures/update_subscriber_custom_field.xml
 - spec/interspire/api_spec.rb
 - spec/interspire/contact_list_spec.rb
 - spec/spec_helper.rb
@@ -100,7 +138,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 316495037
+      hash: -3473573730335399156
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -109,10 +147,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 316495037
+      hash: -3473573730335399156
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Ruby library for the Interspire API.
@@ -125,6 +163,7 @@ test_files:
 - spec/fixtures/not_authenticated.xml
 - spec/fixtures/not_in_contact_list.xml
 - spec/fixtures/subscribers.xml
+- spec/fixtures/update_subscriber_custom_field.xml
 - spec/interspire/api_spec.rb
 - spec/interspire/contact_list_spec.rb
 - spec/spec_helper.rb