eroi 0.0.1 → 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+pkg/
+test/fixtures.yml

data/README.rdoc

@@ -2,6 +2,8 @@
 
 API interface to eROI.
 
+This gem only contains contact management. If you need more support, please fork and add it.
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -19,7 +19,7 @@ end
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'eroi'
-  test.pattern = 'test/**/*_test.rb'
+  test.pattern = 'test/eroi/*_test.rb'
   test.verbose = true
 end
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/eroi.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{eroi}
-  s.version = "0.0.1"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["CardPlayer"]
-  s.date = %q{2009-12-03}
+  s.date = %q{2009-12-04}
   s.description = %q{API interface to eROI.}
   s.email = %q{techteam@cardplayer.com}
   s.extra_rdoc_files = [
@@ -17,7 +17,8 @@ Gem::Specification.new do |s|
      "README.rdoc"
   ]
   s.files = [
-    "LICENSE",
+    ".gitignore",
+     "LICENSE",
      "Manifest",
      "README.rdoc",
      "Rakefile",
@@ -25,9 +26,12 @@ Gem::Specification.new do |s|
      "eroi.gemspec",
      "lib/eroi.rb",
      "lib/eroi/client.rb",
+     "lib/eroi/request.rb",
      "lib/eroi/response.rb",
      "lib/eroi/version.rb",
      "test/eroi/client_test.rb",
+     "test/fixtures.yml.sample",
+     "test/remote/client_test.rb",
      "test/test_helper.rb"
   ]
   s.homepage = %q{http://github.com/cardplayer/eroi}
@@ -37,6 +41,7 @@ Gem::Specification.new do |s|
   s.summary = %q{API interface to eROI.}
   s.test_files = [
     "test/eroi/client_test.rb",
+     "test/remote/client_test.rb",
      "test/test_helper.rb"
   ]
 

data/lib/eroi/client.rb

@@ -4,71 +4,46 @@ module EROI
   end
 
   class Client
-    POST_API_URL = 'http://emailer.emailroi.com/dbadmin/xml_post.pl'
-    GET_API_URL = 'http://emailer.emailroi.com/dbadmin/xml_retrieve2.pl'
+    attr_reader :user_token, :api_password
 
     def initialize(user_token, api_password)
       @user_token = user_token
       @api_password = api_password
     end
 
+    def contact(email, options = {})
+      Request::Get.send(self,
+        { :contact => email }.merge(options))
+    end
+
     def add_contact(fields)
-      send_post(build_contact_record(fields))
+      Request::Post.send(self, build_contact_record(fields))
     end
 
     alias :update_contact :add_contact
 
     def change_contact_email(current_email, new_email)
-      send_post(build_contact_record(
-        :email => current_email, :change_email => new_email))
+      Request::Post.send(self, build_contact_record(
+        :email => current_email,
+        :change_email => new_email))
     end
 
     def remove_contact(email)
-      send_post(build_contact_record( :email => email, :clear_record => 1 ))
-    end
-
-    def user_field_definitions
-      response = send_get(:getUserFieldDefinitions => 1)
-
-      if response.success?
-        fields = {}
-        response.data['UserFieldDefinitions']['UserField'].each_with_index do |field,i|
-          fields[field] = "User#{i + 1}"
-        end
-        [ response, fields ]
-      else
-        [ response, {} ]
-      end
+      Request::Post.send(self, build_contact_record(
+        :email => email,
+        :clear_record => 1 ))
     end
 
   private
 
     def build_contact_record(fields)
       xml = Builder::XmlMarkup.new
-      xml.record do |r|
+      xml.tag!('Record') do |r|
         fields.each do |k,v|
           r.tag!(k.to_s.camelize, v)
         end
       end
       xml
     end
-
-    def send_get(fields)
-      uri = URI.parse(GET_API_URL)
-      uri.query = fields.merge({
-        :user_token => @user_token,
-        :api_password => @api_password }).collect { |k,v| "#{k}=#{v}" }.join('&')
-
-      Response::Get.new(Crack::XML.parse(Net::HTTP.get(uri))['Retrieve'])
-    end
-
-    def send_post(xml)
-      response = Net::HTTP.post_form(
-         URI.parse(POST_API_URL),
-         { :user_token => @user_token,
-           :api_password => @api_password,
-           :body => xml }).body
-      Response::Post.new(Crack::XML.parse("<Response>#{response}</Response>")['Response'])
-    end
   end
 end

data/lib/eroi/request.rb

@@ -0,0 +1,28 @@
+module EROI
+  module Request
+    class Get
+      API_URL = 'http://emailer.emailroi.com/dbadmin/xml_retrieve2.pl'
+
+      def self.send(client, fields)
+        uri = URI.parse(API_URL)
+        uri.query = fields.merge({
+          :user_token => client.user_token,
+          :api_password => client.api_password }).collect { |k,v| "#{k}=#{v}" }.join('&')
+        Response::Get.new(Crack::XML.parse(Net::HTTP.get(uri)))
+      end
+    end
+
+    class Post
+      API_URL = 'http://emailer.emailroi.com/dbadmin/xml_post.pl'
+
+      def self.send(client, xml)
+        response = Net::HTTP.post_form(
+           URI.parse(API_URL),
+           { :user_token => client.user_token,
+             :api_password => client.api_password,
+             :xml_body => xml }).body
+        Response::Post.new(Crack::XML.parse("<Response>#{response}</Response>"))
+      end
+    end
+  end
+end

data/lib/eroi/response.rb

@@ -12,9 +12,15 @@ module EROI
 
     class Get < Base
       def success?
-        !@data['ErrorCode']
+        (@data['ErrorCode'] || @data['xml']) ? false : true
       end
 
+      def contact
+        @data['Retrieve']['Record']
+      end
+
+      alias :contacts :contact
+
       def error_message
         case @data['ErrorCode'].to_i
         when 1
@@ -29,13 +35,13 @@ module EROI
 
     class Post < Base
       def success?
-        @data['Compiled'] == 'Yes' &&
-        @data['DBConnect'] == 'OK' &&
-        @data['XMLUpload'] == 'Complete'
+        @data['Response']['Compiled'] == 'Yes' &&
+        @data['Response']['DBConnect'] == 'OK' &&
+        @data['Response']['XMLUpload'] == 'Complete'
       end
 
       def number_of_records
-        @data['ImportRecords'].to_i
+        @data['Response']['ImportRecords'].to_i
       end
     end
   end

data/lib/eroi.rb

@@ -5,8 +5,9 @@ require 'net/http'
 require 'uri'
 require 'crack'
 require 'builder'
-require 'activesupport'
+require 'active_support'
 
 require 'eroi/version'
+require 'eroi/request'
 require 'eroi/response'
 require 'eroi/client'

data/test/eroi/client_test.rb

@@ -3,17 +3,31 @@ require File.join(File.dirname(__FILE__), '..', 'test_helper.rb')
 class TestClient < Test::Unit::TestCase
   context "client module" do
     should "create a new eroi client" do
-      client = EROI.new(user_token, api_password)
+      credentials = fixture(:test)
+      client = EROI.new(credentials[:user_token], credentials[:api_password])
       assert_equal EROI::Client, client.class
     end
   end
 
   context "using the eroi client" do
     setup do
-      @client = EROI.new(user_token, api_password)
+      credentials = fixture(:test)
+      @client = EROI.new(credentials[:user_token], credentials[:api_password])
       FakeWeb.register_uri(
-        :post, EROI::Client::POST_API_URL,
+        :post, EROI::Request::Post::API_URL,
         :body => successful_post_response)
+      FakeWeb.register_uri(
+        :get, /#{EROI::Request::Get::API_URL}*/,
+        :body => successful_get_response)
+    end
+
+    context "when finding a contact" do
+      should "respond with a success" do
+        response = @client.contact('longbob@longbob.com', :mailing_lists => 'TestList')
+
+        assert_equal true, response.success?
+        assert_equal 'longbob@longbob.com', response.contact['Email']
+      end
     end
 
     context "when adding a contact" do
@@ -22,7 +36,7 @@ class TestClient < Test::Unit::TestCase
           :email => 'longbob@longbob.com',
           :firstname => 'Longbob',
           :lastname => 'Longson',
-          :mailing_lists => 'List1,List2')
+          :mailing_lists => 'TestList')
 
         assert_equal true, response.success?
         assert_equal 1, response.number_of_records
@@ -45,7 +59,7 @@ class TestClient < Test::Unit::TestCase
           :email => 'longbob@longbob.com',
           :firstname => 'Longbob',
           :lastname => 'Longson',
-          :mailing_lists => 'List1,List2')
+          :mailing_lists => 'TestList')
 
         assert_equal true, response.success?
         assert_equal 1, response.number_of_records
@@ -61,36 +75,62 @@ class TestClient < Test::Unit::TestCase
       end
     end
 
-    context "when retreiving user field definitions" do
-      setup do
-        FakeWeb.register_uri(
-          :get, /#{EROI::Client::GET_API_URL}*/,
-          :body => successful_get_response)
-      end
-
-      should "respond with a success" do
-        response, user_fields = @client.user_field_definitions
-
-        expected_fields = { 'State' => 'User1', 'City' => 'User2' }
-
-        assert_equal true, response.success?
-        assert_equal expected_fields, user_fields
-      end
-    end
-
     context "when there is an error" do
       setup do
         FakeWeb.register_uri(
-          :get, /#{EROI::Client::GET_API_URL}*/,
+          :get, /#{EROI::Request::Get::API_URL}*/,
           :body => unsuccessful_get_response(1))
       end
 
       should "respond with a failure" do
-        response, fields = @client.user_field_definitions
+        response, fields = @client.contact('longbob@longbob.com')
 
         assert_equal false, response.success?
-        assert /Invalid/ =~ response.error_message
       end
     end
   end
+
+  def successful_post_response
+    <<-EOF
+  <Compiled>Yes</Compiled>
+  <DBConnect>OK</DBConnect>
+  <EditionSuccess>MailingListName_someEditionName</EditionSuccess>
+  <ImportRecords>1</ImportRecords>
+  <ExistingRecords>1526</ExistingRecords>
+  <FinalCompleted>1</FinalCompleted>
+  <Duplicates>1</Duplicates>
+  <InvalidLists>0</InvalidLists>
+  <Triggers></Triggers>
+  <XMLUpload>Complete</XMLUpload>
+    EOF
+  end
+  
+  def successful_get_response
+    <<-EOF
+  <Retrieve>
+    <Record>
+      <rec>523</rec>
+      <Email>longbob@longbob.com</Email>
+      <Firstname>Joe</Firstname>
+      <Lastname>Somebody</Lastname>
+      <Company>Some Company</Company>
+      <User1>some data here</User1>
+      <User2>We'll put more data here</User2>
+      <Notes>And we'll put more notes here</Notes>
+      <Edition Name='SomeEdition'>
+        <Sent Format='YYYYMMDDhhmm'>20030913143010</Sent>
+        <Read>5</Read>
+        <Click URL='http://www.somelink.com'>3</Click>
+        <Click URL='http://www.anotherlink.com/page.htm'>1</Click>
+        <S2F>2</S2F>
+      </Edition>
+      <Event id='1' ListEdition='somelist_someedition' Date='2003-Nov-11'>Sent</Event>
+    </Record>
+  </Retrieve>
+    EOF
+  end
+  
+  def unsuccessful_get_response(code = 1)
+    "<xml><error>Unable to authorize supplied username and password</error></xml>"
+  end
 end

data/test/fixtures.yml.sample

@@ -0,0 +1,7 @@
+test:
+  user_token: testusertoken
+  api_password: testapipassword
+
+remote:
+  user_token: remoteusertoken
+  api_password: remoteapipassword

data/test/remote/client_test.rb

@@ -0,0 +1,110 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper.rb')
+
+class TestClient < Test::Unit::TestCase
+  context "using the eroi client" do
+    context "against a remote server" do
+      setup do
+        FakeWeb.allow_net_connect = true
+        credentials = fixture(:remote)
+        @client = EROI.new(credentials[:user_token], credentials[:api_password])
+      end
+
+      context "when finding a contact" do
+        should "respond with a success" do
+          @client.add_contact(
+            :email => 'longbob@longbob.com',
+            :firstname => 'Longbob',
+            :lastname => 'Longson',
+            :mailing_lists => 'MainList')
+
+          response = @client.contact('longbob@longbob.com', :mailing_lists => 'MainList')
+
+          assert_equal true, response.success?
+          assert_equal 'longbob@longbob.com', response.contact['Email']
+        end
+      end
+
+      context "when adding a contact" do
+        teardown do
+          @client.remove_contact('longbob@boblong.com')
+        end
+
+        should "respond with a success" do
+          response = @client.add_contact(
+            :email => 'longbob@longbob.com',
+            :firstname => 'Longbob',
+            :lastname => 'Longson',
+            :mailing_lists => 'MainList')
+
+          assert_equal true, response.success?
+          assert_equal 1, response.number_of_records
+        end
+      end
+
+      context "when changing a contact's email" do
+        teardown do
+          @client.remove_contact('longbob@longbob.com')
+          @client.remove_contact('longbob@boblong.com')
+        end
+
+        should "respond with a success" do
+          @client.add_contact(
+            :email => 'longbob@longbob.com',
+            :firstname => 'Longbob',
+            :lastname => 'Longson',
+            :mailing_lists => 'MainList')
+
+          response = @client.change_contact_email(
+            'longbob@longbob.com', 'longbob@boblong.com')
+
+          assert_equal true, response.success?
+          assert_equal 1, response.number_of_records
+        end
+      end
+
+      context "when updating a contact" do
+        teardown do
+          @client.remove_contact('longbob@longbob.com')
+        end
+
+        should "respond with a success" do
+          @client.add_contact(
+            :email => 'longbob@longbob.com',
+            :firstname => 'Longbob',
+            :lastname => 'Longson',
+            :mailing_lists => 'MainList')
+
+          response = @client.update_contact(
+            :email => 'longbob@longbob.com',
+            :firstname => 'Longbob',
+            :lastname => 'Longson',
+            :mailing_lists => 'MainList')
+
+          assert_equal true, response.success?
+          assert_equal 1, response.number_of_records
+        end
+      end
+
+      context "when removing a contact" do
+        should "respond with a success" do
+          response = @client.remove_contact('longbob@longbob.com')
+
+          assert_equal true, response.success?
+          assert_equal 1, response.number_of_records
+        end
+      end
+
+      context "when there is an error" do
+        setup do
+          @client = EROI.new('wrong', 'credentials')
+        end
+
+        should "respond with a failure" do
+          response, fields = @client.contact('longbob@longbob.com')
+
+          assert_equal false, response.success?
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -21,58 +21,14 @@ def stub_get(url, filename, status=nil)
   FakeWeb.register_uri(:get, url, options)
 end
 
-def user_token
-  'test_user_token'
+def fixture(key)
+  yaml_data = YAML.load(File.read(File.join(File.dirname(__FILE__), 'fixtures.yml')))
+  symbolize_keys(yaml_data)
+  yaml_data[key]
 end
 
-def api_password
-  'test_api_password'
-end
-
-def successful_post_response
-  <<-EOF
-<Compiled>Yes</Compiled>
-<DBConnect>OK</DBConnect>
-<EditionSuccess>MailingListName_someEditionName</EditionSuccess>
-<ImportRecords>1</ImportRecords>
-<ExistingRecords>1526</ExistingRecords>
-<FinalCompleted>1</FinalCompleted>
-<Duplicates>1</Duplicates>
-<InvalidLists>0</InvalidLists>
-<Triggers></Triggers>
-<XMLUpload>Complete</XMLUpload>
-  EOF
-end
-
-def successful_get_response
-  <<-EOF
-<Retrieve>
-  <Record>
-    <rec>523</rec>
-    <Email>someone@somecompany.com</Email>
-    <Firstname>Joe</Firstname>
-    <Lastname>Somebody</Lastname>
-    <Company>Some Company</Company>
-    <User1>some data here</User1>
-    <User2>We'll put more data here</User2>
-    <Notes>And we'll put more notes here</Notes>
-    <Edition Name="SomeEdition">
-      <Sent Format="YYYYMMDDhhmm">20030913143010</Sent>
-      <Read>5</Read>
-      <Click URL="http://www.somelink.com">3</Click>
-      <Click URL="http://www.anotherlink.com/page.htm">1</Click>
-      <S2F>2</S2F>
-    </Edition>
-    <Event id="1" ListEdition="somelist_someedition" Date="2003-Nov-11">Sent</Event>
-  </Record>
-  <UserFieldDefinitions>
-    <UserField Field="User1" Type="Text">State</UserField>
-    <UserField Field="User2" Type="Text">City</UserField>
-  </UserFieldDefinitions>
- </Retrieve>
-  EOF
-end
-
-def unsuccessful_get_response(code = 1)
-  "<Retrieve><ErrorCode>#{code}</ErrorCode></Retrieve>"
+def symbolize_keys(hash)
+  return unless hash.is_a?(Hash)
+  hash.symbolize_keys!
+  hash.each{|k,v| symbolize_keys(v)}
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: eroi
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - CardPlayer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-03 00:00:00 -08:00
+date: 2009-12-04 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -23,6 +23,7 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
+- .gitignore
 - LICENSE
 - Manifest
 - README.rdoc
@@ -31,9 +32,12 @@ files:
 - eroi.gemspec
 - lib/eroi.rb
 - lib/eroi/client.rb
+- lib/eroi/request.rb
 - lib/eroi/response.rb
 - lib/eroi/version.rb
 - test/eroi/client_test.rb
+- test/fixtures.yml.sample
+- test/remote/client_test.rb
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/cardplayer/eroi
@@ -65,4 +69,5 @@ specification_version: 3
 summary: API interface to eROI.
 test_files: 
 - test/eroi/client_test.rb
+- test/remote/client_test.rb
 - test/test_helper.rb