eroi 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Russ Smith
+
+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/Manifest

@@ -0,0 +1,8 @@
+Manifest
+Rakefile
+lib/eroi.rb
+lib/eroi/client.rb
+lib/eroi/response.rb
+lib/eroi/version.rb
+test/eroi/client_test.rb
+test/test_helper.rb

data/README.rdoc

@@ -0,0 +1,17 @@
+= eroi
+
+API interface to eROI.
+
+== 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 CardPlayer. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "eroi"
+    gem.summary = "API interface to eROI."
+    gem.description = "API interface to eROI."
+    gem.email = "techteam@cardplayer.com"
+    gem.homepage = "http://github.com/cardplayer/eroi"
+    gem.authors = ["CardPlayer"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'eroi'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'eroi'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "eroi #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/eroi.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{eroi}
+  s.version = "0.0.1"
+
+  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.description = %q{API interface to eROI.}
+  s.email = %q{techteam@cardplayer.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    "LICENSE",
+     "Manifest",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "eroi.gemspec",
+     "lib/eroi.rb",
+     "lib/eroi/client.rb",
+     "lib/eroi/response.rb",
+     "lib/eroi/version.rb",
+     "test/eroi/client_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/cardplayer/eroi}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{API interface to eROI.}
+  s.test_files = [
+    "test/eroi/client_test.rb",
+     "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
+    else
+    end
+  else
+  end
+end
+

data/lib/eroi/client.rb

@@ -0,0 +1,74 @@
+module EROI
+  def self.new(user_token, api_password)
+    EROI::Client.new(user_token, api_password)
+  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'
+
+    def initialize(user_token, api_password)
+      @user_token = user_token
+      @api_password = api_password
+    end
+
+    def add_contact(fields)
+      send_post(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))
+    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
+    end
+
+  private
+
+    def build_contact_record(fields)
+      xml = Builder::XmlMarkup.new
+      xml.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/response.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+
+module EROI
+  module Response
+    class Base
+      attr_reader :data
+
+      def initialize(data)
+        @data = data
+      end
+    end
+
+    class Get < Base
+      def success?
+        !@data['ErrorCode']
+      end
+
+      def error_message
+        case @data['ErrorCode'].to_i
+        when 1
+          'Invalid username/password was provided.'
+        when 2
+          'Invalid mailing list was provided.'
+        when 3
+          'Invalid edition was provided.'
+        end
+      end
+    end
+
+    class Post < Base
+      def success?
+        @data['Compiled'] == 'Yes' &&
+        @data['DBConnect'] == 'OK' &&
+        @data['XMLUpload'] == 'Complete'
+      end
+
+      def number_of_records
+        @data['ImportRecords'].to_i
+      end
+    end
+  end
+end

data/lib/eroi/version.rb

@@ -0,0 +1,3 @@
+module EROI
+  VERSION = '0.0.1'
+end

data/lib/eroi.rb

@@ -0,0 +1,12 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'rubygems'
+require 'net/http'
+require 'uri'
+require 'crack'
+require 'builder'
+require 'activesupport'
+
+require 'eroi/version'
+require 'eroi/response'
+require 'eroi/client'

data/test/eroi/client_test.rb

@@ -0,0 +1,96 @@
+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)
+      assert_equal EROI::Client, client.class
+    end
+  end
+
+  context "using the eroi client" do
+    setup do
+      @client = EROI.new(user_token, api_password)
+      FakeWeb.register_uri(
+        :post, EROI::Client::POST_API_URL,
+        :body => successful_post_response)
+    end
+
+    context "when adding a contact" do
+      should "respond with a success" do
+        response = @client.add_contact(
+          :email => 'longbob@longbob.com',
+          :firstname => 'Longbob',
+          :lastname => 'Longson',
+          :mailing_lists => 'List1,List2')
+
+        assert_equal true, response.success?
+        assert_equal 1, response.number_of_records
+      end
+    end
+
+    context "when changing a contact's email" do
+      should "respond with a success" do
+        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
+      should "respond with a success" do
+        response = @client.update_contact(
+          :email => 'longbob@longbob.com',
+          :firstname => 'Longbob',
+          :lastname => 'Longson',
+          :mailing_lists => 'List1,List2')
+
+        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 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}*/,
+          :body => unsuccessful_get_response(1))
+      end
+
+      should "respond with a failure" do
+        response, fields = @client.user_field_definitions
+
+        assert_equal false, response.success?
+        assert /Invalid/ =~ response.error_message
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,78 @@
+require 'test/unit'
+require 'rubygems'
+require 'shoulda'
+require 'mocha'
+require 'fakeweb'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'eroi')
+
+FakeWeb.allow_net_connect = false
+
+def fixture_file(filename)
+  return '' if filename == ''
+  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/' + filename)
+  File.read(file_path)
+end
+
+def stub_get(url, filename, status=nil)
+  options = { :body => fixture_file(filename) }
+  options.merge!({ :status => status }) unless status.nil?
+  
+  FakeWeb.register_uri(:get, url, options)
+end
+
+def user_token
+  'test_user_token'
+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>"
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: eroi
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- CardPlayer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-03 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: API interface to eROI.
+email: techteam@cardplayer.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- Manifest
+- README.rdoc
+- Rakefile
+- VERSION
+- eroi.gemspec
+- lib/eroi.rb
+- lib/eroi/client.rb
+- lib/eroi/response.rb
+- lib/eroi/version.rb
+- test/eroi/client_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/cardplayer/eroi
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: API interface to eROI.
+test_files: 
+- test/eroi/client_test.rb
+- test/test_helper.rb