expresspigeon-ruby 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html
+doc/structures.csv
+*.iml
+.idea/

data/.rvmrc

@@ -0,0 +1,8 @@
+USER_RVMRC='.rvmrc.local'
+
+if [ -f $USER_RVMRC ]; then
+  source $USER_RVMRC
+else
+  rvm use 1.9.3@expresspigeon-ruby --create
+fi
+

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    expresspigeon-ruby (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  expresspigeon-ruby!
+  rspec (~> 2.6)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 ExpressPigeon
+
+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 @@
+# Expresspigeon::Ruby
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'expresspigeon-ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install expresspigeon-ruby
+
+## 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/expresspigeon-ruby.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'expresspigeon-ruby/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "expresspigeon-ruby"
+  gem.version       = Expresspigeon::API::VERSION
+  gem.authors       = ["ipolevoy"]
+  gem.email         = ["ipolevoy@groupon.com"]
+  gem.description   = %q{ExpressPigeon Ruby API for sending transactional messages, manipulating lists, contacts nad more}
+  gem.summary       = %q{ExpressPigeon API Ruby Wrapper}
+  gem.homepage      = "https://github.com/expresspigeon/expresspigeon-ruby"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_development_dependency "rspec", "~> 2.6"
+end

data/lib/expresspigeon-ruby/version.rb

@@ -0,0 +1,5 @@
+module Expresspigeon
+  module API
+    VERSION = "0.0.1"
+  end
+end

data/lib/expresspigeon-ruby.rb

@@ -0,0 +1,306 @@
+require "expresspigeon-ruby/version"
+
+require 'net/http'
+require 'json'
+require 'uri'
+
+AUTH_KEY = ENV['EXPRESSPIGEON_AUTH_KEY']
+ROOT = 'https://api.expresspigeon.com/'
+#ROOT = 'http://localhost:8888/api/'
+USE_SSL = true
+
+module ExpressPigeon
+  module API
+    unless AUTH_KEY
+      raise 'Provide EXPRESSPIGEON_AUTH_KEY environment variable'
+    end
+
+    def http(path, method, params = {})
+      uri = URI.parse "#{ROOT}#{path}"
+      req = Net::HTTP.const_get("#{method}").new "#{ROOT}#{path}"
+      req['X-auth-key'] = AUTH_KEY
+      if params
+        req.body = params.to_json
+        req['Content-type'] = 'application/json'
+      end
+
+      if block_given?
+        Net::HTTP.start(uri.host, uri.port, :use_ssl => USE_SSL) do |http|
+          http.request req do |res|
+            res.read_body do |seg|
+              yield seg
+            end
+          end
+        end
+      else
+        resp = Net::HTTP.start(uri.host, uri.port, :use_ssl => USE_SSL) do |http|
+          http.request req
+        end
+        parsed = JSON.parse(resp.body)
+        if parsed.kind_of? Hash
+          MetaHash.new parsed
+        else
+          parsed
+        end
+      end
+    end
+
+    def get(path, &block)
+      http path, 'Get', nil, &block
+    end
+
+    def post(path, params = {})
+      http path, 'Post', params
+    end
+
+    def del(path, params = {})
+      http path, 'Delete', params
+    end
+
+    def self.campaigns
+      Campaigns.new
+    end
+
+    def self.lists
+      Lists.new
+    end
+
+    def self.contacts
+      Contacts.new
+    end
+
+    def self.messages
+      Messages.new
+    end
+  end
+
+end
+
+class MetaHash < Hash
+
+  def initialize(delegate)
+    super
+    @delegate = delegate
+    @delegate.each_key do |k|
+      v = @delegate[k] # lets go only one level down for now
+      if v.kind_of? Hash
+        @delegate[k] = MetaHash.new(v)
+      end
+    end
+  end
+
+  def method_missing(m, *args, &block)
+    @delegate[m.to_s]
+  end
+
+  def to_s
+    @delegate.to_s
+  end
+
+end
+
+class Lists
+
+  include ExpressPigeon::API
+
+  def initialize
+    @endpoint = 'lists'
+  end
+
+  def create(list_name, from_name, reply_to)
+    post @endpoint, {:name => list_name, :from_name => from_name, :reply_to => reply_to}
+  end
+
+
+  # Query all lists.
+  # returns: array of hashes each representing a list for this user
+  def all
+    get @endpoint
+  end
+
+
+  #Updates existing list
+  #
+  #:param list_id: Id of list to be updated
+  #:type list_id: int
+  #
+  #:param params: JSON object represents a list to be updated
+
+  #
+  #:returns: EpResponse with status, code, message, and updated list
+  #:rtype: EpResponse
+  #TODO: resolve API on Python side, then implement this
+  #def update(list_id, params = {})
+  #    params['id'] = list_id
+  #    return self.ep.put(self.endpoint, params=params)
+  #end
+
+
+  # Removes a list with a given id. A list must be enabled and has no dependent subscriptions and/or scheduled campaigns.
+  #
+  #  param list_id: Id of list to be removed.
+  #  returns response hash with status, code, and message
+  def delete(list_id)
+    del "#{@endpoint}/#{list_id}"
+  end
+
+  def csv(list_id, &block)
+    get "#{@endpoint}/#{list_id}/csv", &block
+  end
+
+
+end
+
+class Campaigns
+  include ExpressPigeon::API
+
+  def initialize
+    @endpoint = 'campaigns'
+  end
+
+  def all
+    get @endpoint
+  end
+
+  def report(campaign_id)
+    get "#{@endpoint}/#{campaign_id}"
+  end
+
+  def bounced(campaign_id)
+    get "#{@endpoint}/#{campaign_id}/bounced"
+  end
+
+  def unsubscribed(campaign_id)
+    get "#{@endpoint}/#{campaign_id}/unsubscribed"
+  end
+
+  def spam(campaign_id)
+    get "#{@endpoint}/#{campaign_id}/spam"
+  end
+
+  #
+  # Schedules a new campaign to be sent.
+  # Parameters:
+  # * *list_id* - id of list to send to
+  # * *template_id* - id of template to send
+  # * *name* - name of a newly created campaign
+  # * *from_name* - from name
+  # * *reply_to* - reply to
+  # * *subject* - subject of campaign
+  # * *google_analytics* - true to turn Google Analytics on
+  def send(params = {})
+    post @endpoint, params
+  end
+
+  #
+  # Schedules a new campaign to be sent.
+  # Parameters:
+  # * *list_id* - id of list to send to
+  # * *template_id* - id of template to send
+  # * *name* - name of a newly created campaign
+  # * *from_name* - from name
+  # * *reply_to* - reply to
+  # * *subject* - subject of campaign
+  # * *google_analytics* - true to turn Google Analytics on
+  # * *schedule_for* - Specifies what time a campaign should be sent. If it is provided the campaign will
+  #                     be scheduled to this time, otherwise campaign is sent immediately. The schedule_for
+  #                     must be in ISO date format and should be in the future.
+  def schedule(params = {})
+    post @endpoint, params
+  end
+end
+
+
+class Contacts
+  include ExpressPigeon::API
+
+  def initialize
+    @endpoint = 'contacts'
+  end
+
+  def find_by_email(email)
+    get "#{@endpoint}?email=#{email}"
+  end
+
+
+  # JSON document represents a contact to be created or updated.
+  # The email field is required.
+  # When updating a contact, list_id is optional,
+  # since the contact is uniquely identified by email across all lists.
+  #
+  # :param list_id: Contact list ID (Fixnum) the contact will be added to
+  #
+  # :param contact: Hash describes new contact. The "email" field is required.
+  #
+  # :returns: representation of a contact
+  #
+  def upsert(list_id, contact)
+    post @endpoint, params = {:list_id => list_id, :contact => contact}
+  end
+
+  # Delete single contact. If list_id is not provided, contact will be deleted from system.
+  # :param email: contact email to be deleted.
+  # :param list_id: list id to remove contact from, if not provided, contact will be deleted from system.
+  def delete(email, list_id = nil)
+    if list_id
+      query = "email=#{email}&list_id=#{list_id}"
+    else
+      query = "email=#{email}"
+    end
+    del "#{@endpoint}?#{query}", nil
+  end
+
+
+end
+class Messages
+
+  include ExpressPigeon::API
+
+  def initialize
+    @endpoint = 'messages'
+  end
+
+  def send_message(template_id, to, reply_to, from_name, subject, merge_fields = nil, view_online = false, click_tracking = true)
+    post @endpoint, params = {template_id: template_id, :to => to, reply_to: reply_to, :from => from_name, :subject => subject,
+                              :merge_fields => merge_fields, :view_online => view_online, :click_tracking => click_tracking}
+  end
+
+  def report(message_id)
+    get "#{@endpoint}/#{message_id}"
+  end
+
+  #
+  #
+  # start_date is instance of Time
+  # end_date is instance of Time
+  def reports(from_id, start_date = nil, end_date = nil)
+    params = []
+
+    if from_id
+      params << "from_id=#{from_id}"
+    end
+
+    if start_date and not end_date
+      raise 'must include both start_date and end_date'
+    end
+    if end_date and not start_date
+      raise 'must include both start_date and end_date'
+    end
+
+    if start_date and end_date
+      params << "start_date=#{start_date.strftime('%FT%T.%L%z')}"
+      params << "end_date=#{end_date.strftime('%FT%T.%L%z')}"
+    end
+
+    query = "#{@endpoint}?"
+
+    if params.size > 0
+      query << params.join('&')
+    end
+
+    puts "calling: #{query}"
+    get query
+
+  end
+
+end

data/spec/campaigns_spec.rb

@@ -0,0 +1,109 @@
+require './lib/expresspigeon-ruby'
+require 'pigeon_helper'
+
+describe 'campaigns integration test' do
+
+  include PigeonSpecHelper
+  it 'should return more than 0 campaign ids' do
+    res = PIGEON.campaigns.all
+    res.class.should == Array
+    res.size.should > 0
+  end
+
+  it 'cannot send with missing parameters' do
+    res = PIGEON.campaigns.send(:template_id => 15233, :name => 'API Test campaign',
+                                :from_name => 'Igor Polevoy', :reply_to => 'igor@polevoy.org',
+                                :subject => 'API test', :google_analytics => true)
+    validate_response res, 400, 'error', /required parameters: list_id, template_id, name, from_name, reply_to, subject, google_analytics/
+  end
+
+  it 'cannot send with bad reply_to' do
+    res = PIGEON.campaigns.send(:list_id => -1, :template_id => -1, :name => 'My Campaign', :from_name => 'John', :reply_to => 'j',
+                                :subject => 'Hi', :google_analytics => false)
+    validate_response res, 400, 'error', /reply_to should be valid email address/
+  end
+
+  it 'cannot send with non-existing template' do
+    res = PIGEON.campaigns.send(:list_id => -1, :template_id => -1, :name => 'My Campaign', :from_name => 'John',
+                                :reply_to => 'j@j.j',
+                                :subject => 'Hi', :google_analytics => false)
+    validate_response res, 400, 'error', /template=-1 is not found/
+  end
+
+  it 'cannot send to non-existing list' do
+
+    res = PIGEON.campaigns.send(:list_id => -1, :template_id => TEMPLATE_ID, :name => 'My Campaign', :from_name => 'John',
+                                :reply_to => 'j@j.j',
+                                :subject => 'Hi', :google_analytics => false)
+    validate_response res, 400, 'error', /list=-1 is not found/
+  end
+
+  it 'cannot send to disabled list' do
+    res = PIGEON.campaigns.send(:list_id => LIST_ID, :template_id => TEMPLATE_ID, :name => 'My Campaign', :from_name => 'John',
+                                :reply_to => 'j@j.j',
+                                :subject => 'Hi', :google_analytics => false)
+    validate_response res, 400, 'error', /list=#{DISABLED_LIST} is disabled/
+  end
+
+  it 'should create new list, add contact and send successful campaign' do
+
+    list_resp = PIGEON.lists.create('My list', 'John', API_USER)
+    list_id = list_resp.list.id
+    PIGEON.contacts.upsert(list_id, {:email => API_USER})
+    resp = PIGEON.campaigns.send(:list_id => list_id, :template_id => TEMPLATE_ID, :name => 'My Campaign', :from_name => 'John',
+                                 :reply_to => API_USER,
+                                 :subject => 'Hi', :google_analytics => false)
+    validate_response resp, 200, 'success', /new campaign created successfully/
+    report = PIGEON.campaigns.report(resp.campaign_id)
+    (report.delivered == 0 or report.delivered == 1).should be_true
+    report.clicked.should eq 0
+    report.opened.should eq 0
+    report.spam.should eq 0
+    (report.in_transit == 0 or report.in_transit == 1).should be_true
+    report.unsubscribed.should eq 0
+    report.bounced.should eq 0
+    bounced = PIGEON.campaigns.bounced(resp.campaign_id)
+    unsubscribed = PIGEON.campaigns.unsubscribed(resp.campaign_id)
+    spam = PIGEON.campaigns.spam(resp.campaign_id)
+
+    bounced.size.should eq 0
+    unsubscribed.size.should eq 0
+    spam.size.should eq 0
+
+    resp = PIGEON.contacts.delete(API_USER)
+    validate_response resp, 200, 'success', /contact=non@non.non deleted successfully/
+
+    resp = PIGEON.contacts.find_by_email(API_USER)
+    validate_response resp, 404, 'error', /contact=non@non.non not found/
+
+    resp = PIGEON.lists.delete(list_id)
+    validate_response resp, 200, 'success', /deleted successfully/
+  end
+
+
+  it 'cannot send campaign if scheduling with bad date' do
+
+    list_resp = PIGEON.lists.create "My list", "John", API_USER
+    resp = PIGEON.campaigns.schedule :list_id => list_resp.list.id, :template_id => TEMPLATE_ID, :name => 'My Campaign',
+
+                                     :from_name => 'John',
+                                     :reply_to => API_USER, :subject => 'Hi',
+                                     :google_analytics => false, :schedule_for => "2013-05-28"
+
+    validate_response resp, 400, 'error', /schedule_for is not in ISO date format, example: 2013-05-28T17:19:50.779/
+    resp = PIGEON.lists.delete(list_resp.list.id)
+    validate_response resp, 200, 'success', /deleted successfully/
+  end
+
+  it 'should not schedule campaign with date in the past' do
+    list_resp = PIGEON.lists.create('My list', 'John', API_USER)
+    resp = PIGEON.campaigns.schedule :list_id => list_resp.list.id, :template_id => TEMPLATE_ID, :name => 'My Campaign',
+                                     :from_name => 'John',
+                                     :reply_to => API_USER, :subject => 'Hi',
+                                     :google_analytics => false, :schedule_for => '2010-05-28T17:19:50.779+0300'
+
+    validate_response resp, 400, 'error', /schedule_for should be in the future/
+  end
+
+end
+

data/spec/contacts_spec.rb

@@ -0,0 +1,152 @@
+require './lib/expresspigeon-ruby'
+require 'pigeon_helper'
+
+describe 'contacts integration test' do
+
+  include PigeonSpecHelper
+
+  it 'should not create contact without contact data' do
+    resp = PIGEON.contacts.upsert(-1, {})
+    validate_response resp, 400, 'error', /contact and contact.email are required/
+  end
+  it 'should not create contact without email' do
+    resp = PIGEON.contacts.upsert -1, :email => '', :first_name => 'Marylin', :last_name => 'Monroe'
+    validate_response resp, 400, 'error', /contact and contact.email are required/
+  end
+
+  it 'should not add contact with too many custom fields' do
+    custom_fields = {}
+    (1..25).each { |n| custom_fields["custom_field_#{n}"] = n }
+    resp = PIGEON.contacts.upsert -1,  :email => "mary@e.e", :custom_fields => custom_fields
+    validate_response resp, 400, 'error', /You cannot create more than 20 custom fields. Use one of the 'custom_fields'./
+  end
+
+  it 'should not create new contact without list_id' do
+    resp = PIGEON.contacts.upsert '', :email => 'ee@e.e', :first_name => 'Marylin', :last_name => 'Monroe'
+    validate_response resp, 404, 'error', /contact=ee@e.e not found/
+  end
+
+  it 'test_create_with_suppressed_contact' do
+    resp = PIGEON.contacts.upsert -1,  :email => 'suppressed@e.e'
+    validate_response resp, 400, 'error', /contact=suppressed@e.e is in suppress list/
+  end
+
+  it 'cannot create with non-existent_list' do
+    resp = PIGEON.contacts.upsert -1, :email => "e@e.e"
+    validate_response resp, 404, 'error', /list=-1 not found/
+  end
+
+  it 'creates list with contacts' do
+    list_response = PIGEON.lists.create 'My List', 'John Doe', 'john@doe.com'
+    list_id = list_response.list.id
+    resp = PIGEON.contacts.upsert list_id, email: "mary@e.e",
+                                  :custom_fields => {:custom_field_1 => "custom_value_1", }
+    validate_response resp, 200, 'success', /contact=mary@e.e created\/updated successfully/
+    resp.contact.custom_fields.custom_field_1.should eq 'custom_value_1'
+    resp.contact.email.should eq 'mary@e.e'
+    resp.contact.email_format.should eq 'html'
+    resp.contact.status.should eq 'ACTIVE'
+    PIGEON.lists.delete(list_id)
+  end
+
+  it 'creates list non-existent custom field' do
+    list_response = PIGEON.lists.create 'My List', 'John Doe', 'a@a.a'
+    list_id = list_response.list.id
+    resp = PIGEON.contacts.upsert(list_id, {:email => "mary@e.e", :custom_fields => {:c => "c", }})
+    validate_response resp, 200, 'success', nil
+    PIGEON.lists.delete(list_id)
+  end
+
+  it 'cannot export contacts from list without list_id' do
+    content = ''
+    PIGEON.lists.csv "-1" do |c|
+      content << c
+    end
+    resp = JSON.parse(content)
+    validate_response MetaHash.new(resp), 404, 'error', /list=-1 not found/
+  end
+
+  it 'should get contacts from suppressed list' do
+    content =''
+    PIGEON.lists.csv "suppress_list" do |c|
+      content += c
+    end
+    resp = content.split /\n/
+    resp.size.should eq 2
+    resp[1].should =~ /"suppressed@e.e","Suppressed","Doe"/
+  end
+
+  it 'should get single contact' do
+    resp = PIGEON.contacts.find_by_email 'suppressed@e.e'
+    resp.email.should eq 'suppressed@e.e'
+  end
+
+  it 'should not find non existent contact' do
+    resp = PIGEON.contacts.find_by_email 'a@a.a'
+    validate_response resp, 404, 'error', /contact=a@a.a not found/
+  end
+
+  it 'should update contact' do
+
+    list_response = PIGEON.lists.create('My List', 'John Doe', "a@a.a")
+    resp = PIGEON.contacts.upsert list_response.list.id,
+                                  :email => "mary@e.e", :first_name => "Mary", :last_name => "Doe"
+    validate_response resp, 200, 'success', /contact=mary@e.e created\/updated successfully/
+    PIGEON.contacts.find_by_email("mary@e.e").last_name.should eq 'Doe'
+
+    resp = PIGEON.contacts.upsert list_response.list.id,
+                                  :email => 'mary@e.e', :first_name => 'Mary', :last_name => 'Johns'
+    validate_response resp, 200, 'success', /contact=mary@e.e created\/updated successfully/
+    PIGEON.contacts.find_by_email("mary@e.e").last_name.should eq 'Johns'
+  end
+
+  it 'cannot delete contact with non-existent email' do
+    res = PIGEON.contacts.delete("g@g.g")
+    validate_response res, 404, 'error', /contact=g@g.g not found/
+  end
+
+  it 'should not delete suppressed contact' do
+    res = PIGEON.contacts.delete("suppressed@e.e")
+    validate_response res, 400, 'error', /contact=suppressed@e.e is in suppress list/
+  end
+
+  it 'should delete single contact from all lists' do
+    list_response = PIGEON.lists.create 'My List', 'Jane Doe', 'a@a.a'
+    PIGEON.contacts.upsert list_response.list.id, :email => 'mary@e.e'
+    res = PIGEON.contacts.delete 'mary@e.e'
+    validate_response res, 200, 'success', /contact=mary@e.e deleted successfully/
+    PIGEON.lists.delete list_response.list.id
+  end
+
+  it 'deletes single contact from single list' do
+    list_response = PIGEON.lists.create 'My List', 'John D.', 'a@a.a'
+    list_response_2 = PIGEON.lists.create('My List2', "Jane D.", 'a@a.a')
+    PIGEON.contacts.upsert(list_response.list.id, {:email => 'mary@e.e'})
+    PIGEON.contacts.upsert(list_response_2.list.id, {:email => 'mary@e.e'})
+
+    res = PIGEON.contacts.delete 'mary@e.e', list_response.list.id
+
+    validate_response res, 200, 'success', /contact=mary@e.e deleted successfully/
+
+    contacts_exported = ''
+    PIGEON.lists.csv list_response.list.id do |c|
+      contacts_exported << c
+    end
+    contacts_exported = contacts_exported.split /\n/
+    contacts_exported.size.should eq 1
+
+    contacts_exported_2 = ''
+    PIGEON.lists.csv list_response_2.list.id do |c|
+      contacts_exported_2 << c
+    end
+
+    contacts_exported_2 = contacts_exported_2.split /\n/
+    contacts_exported_2.size.should eq 2
+    contacts_exported_2[1].should =~ /"mary@e.e"/
+
+    PIGEON.lists.delete(list_response.list.id)
+    PIGEON.lists.delete(list_response_2.list.id)
+    PIGEON.contacts.delete('mary@e.e')
+  end
+end
+

data/spec/lists_spec.rb

@@ -0,0 +1,149 @@
+require './lib/expresspigeon-ruby'
+require 'pigeon_helper'
+
+describe 'contacts integration test' do
+
+  include PigeonSpecHelper
+
+  it 'test_create_and_delete_new_list(self):' do
+    contact_list = PIGEON.lists.create 'Active customers', 'Bob', 'bob@acmetools.com'
+
+    puts "*****************************"
+    puts contact_list
+
+    validate_response contact_list, 200, 'success', /list=#{contact_list.list.id} created\/updated successfully/
+    contact_list.list.name.should eq "Active customers"
+    contact_list.list.from_name.should eq "Bob"
+    contact_list.list.reply_to.should eq "bob@acmetools.com"
+    contact_list.list.contact_count.should eq 0
+
+    #TODO: uncomment when running against real test env
+    #contact_list.list.zip.should eq '220000'
+    #contact_list.list.state.should eq "AL"
+    #contact_list.list.address1.should eq "Coolman 11"
+    #contact_list.list.city.should eq "Minsk"
+    #contact_list.list.country.should eq "Belarus"
+    #contact_list.list.organization.should eq "ExpressPigeon"
+
+    res = PIGEON.lists.delete(contact_list.list.id)
+    validate_response res, 200, 'success', /list=#{contact_list.list.id} deleted successfully/
+  end
+
+  #TODO: implement Lists.update method
+  it 'should update existing list' do
+
+    existing_list = PIGEON.lists.create("Update", "Bob", "bob@acmetools.com")
+    #res = PIGEON.lists.update existing_list.list.id, :name => 'Updated Name', :from_name => 'Bill'
+    #
+    #validate_response res, 200, 'success', /list=#{res.list.id} created\/updated successfully/
+    #res.list.name.should eq "Updated Name"
+    #res.list.from_name.should eq 'Bill'
+    #PIGEON.lists.delete res.list.id
+  end
+
+
+      it 'should upload contacts'
+
+          list_name = "Upload_#{Kernel.rand(9999).to_s}"
+          existing_list = PIGEON.lists.create(list_name, 'Bob', 'bob@acmetools.com')
+
+          #res = PIGEON.lists.upload(existing_list.list.id, self.file_to_upload)
+
+
+          #self.assertEqual(res.status, "success")
+          #self.assertEqual(res.code, 200)
+          #self.assertEquals(res.message, "file uploaded successfully")
+          #self.assertTrue(res.upload_id is not None)
+          #
+          #sleep(5)
+          #
+          #res = self.api.lists.upload_status(res.upload_id)
+          #self.assertEqual(res.message, "file upload completed")
+          #self.assertEqual(res.status, "success")
+          #self.assertEqual(res.code, 200)
+          #report = res.report
+          #self.assertTrue(report.completed)
+          #self.assertFalse(report.failed)
+          #self.assertEqual(report.suppressed, 0)
+          #self.assertEqual(report.skipped, 0)
+          #self.assertEqual(report.list_name, list_name)
+          #self.assertEqual(report.imported, 2)
+
+  #    def test_upsert_list_with_non_existent_id(self):
+  #        res = self.api.lists.update(-1, {"name": "Updated Name", "from_name": "Bill"})
+  #        self.assertEqual(res.status, "error")
+  #        self.assertEqual(res.code, 404)
+  #        self.assertEqual(res.message, "list=-1 not found")
+  #
+  #    def test_delete_list_with_non_existent_id(self):
+  #        res = self.api.lists.delete(-1)
+  #        self.assertEqual(res.status, "error")
+  #        self.assertEqual(res.code, 404)
+  #        self.assertEqual(res.message, "list=-1 not found")
+  #
+  #    def test_remove_disabled_list(self):
+  #        res = self.api.lists.delete(130)
+  #        self.assertEqual(res.code, 400)
+  #        self.assertEqual(res.status, "error")
+  #        self.assertEqual(res.message, "could not delete disabled list=130")
+  #
+  #    def test_upload_without_id(self):
+  #        res = self.api.lists.upload("", self.file_to_upload)
+  #        self.assertEqual(res.code, 400)
+  #        self.assertEqual(res.status, "error")
+  #        self.assertEqual(res.message, "you must provide list_id in URL")
+  #
+  #    def test_upload_with_non_existent_id(self):
+  #        res = self.api.lists.upload(-1, self.file_to_upload)
+  #        self.assertEqual(res.code, 404)
+  #        self.assertEqual(res.message, "list=-1 not found")
+  #
+  #    def test_upload_status_without_upload_id(self):
+  #        res = self.api.lists.upload_status("")
+  #        self.assertEqual(res.code, 400)
+  #        self.assertEqual(res.status, "error")
+  #        self.assertEqual(res.message, "you must provide upload id")
+  #
+  #    def test_enabled_list_removal(self):
+  #        list_resp = self.api.lists.create("My list", "John", os.environ['EXPRESSPIGEON_API_USER'])
+  #        self.api.contacts.upsert(list_resp.list.id, {"email": os.environ['EXPRESSPIGEON_API_USER']})
+  #
+  #        now = datetime.datetime.now(pytz.UTC)
+  #        schedule = self.format_date(now + datetime.timedelta(hours=1))
+  #
+  #        res = self.api.campaigns.schedule(list_id=list_resp.list.id, template_id=self.template_id, name="My Campaign",
+  #                                          from_name="John",
+  #                                          reply_to=os.environ['EXPRESSPIGEON_API_USER'], subject="Hi",
+  #                                          google_analytics=False,
+  #                                          schedule_for=schedule)
+  #        self.assertEqual(res.code, 200)
+  #        self.assertEqual(res.status, "success")
+  #        self.assertEqual(res.message, "new campaign created successfully")
+  #        self.assertTrue(res.campaign_id is not None)
+  #
+  #        res = self.api.lists.delete(list_resp.list.id)
+  #        self.assertEqual(res.code, 400)
+  #        self.assertEqual(res.status, "error")
+  #        self.assertEqual(res.message,
+  #                         "could not delete list={0}, it has dependent subscriptions and/or scheduled campaigns".format(
+  #                             list_resp.list.id))
+  #
+  #    def test_export_csv(self):
+  #        list_response = self.api.lists.create("My List", "a@a.a", "a@a.a")
+  #        self.api.contacts.upsert(list_response.list.id, {"email": "mary@a.a"})
+  #
+  #        res = self.api.lists.csv(list_response.list.id).split("\n")
+  #        self.assertEquals(len(res), 2)
+  #        headers = '"Email", "First name", "Last name", "City", "Phone", "Company", "Title", "Address 1", "Address 2", ' \
+  #                  '"State", "Zip", "Country", "Date of birth", "custom_field_1", "custom_field_10", "custom_field_11", ' \
+  #                  '"custom_field_12", "custom_field_13", "custom_field_18", "custom_field_19", "custom_field_2", ' \
+  #                  '"custom_field_20", "custom_field_21", "custom_field_22", "custom_field_23", "custom_field_24", ' \
+  #                  '"custom_field_3", "custom_field_4", "custom_field_5", "custom_field_6", "custom_field_7", ' \
+  #                  '"custom_field_8", "custom_field_9"'
+  #        self.assertEquals(res[0], headers)
+  #        self.assertEquals(res[1], '"mary@a.a",,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,')
+  #
+  #        self.api.lists.delete(list_response.list.id)
+  #        self.api.contacts.delete("mary@a.a")
+
+end

data/spec/messages_spec.rb

@@ -0,0 +1,127 @@
+require './lib/expresspigeon-ruby'
+require 'pigeon_helper'
+
+describe 'transactional messages integration test' do
+
+  include PigeonSpecHelper
+
+  #def test_sending_message_and_report_without_params(self):
+  #    res = self.api.messages.send_message(template_id=-1, to="", reply_to="", from_name="", subject="")
+  #    self.assertEqual(res.code, 400)
+  #    self.assertEqual(res.status, "error")
+  #    self.assertEqual(res.message, "Required fields: template_id, reply_to, from, to, and subject")
+  #
+  #def test_sending_message_and_report_with_wrong_email_in_to(self):
+  #    res = self.api.messages.send_message(template_id=-1, to="e", reply_to="a@a.a", from_name="me", subject="Hi")
+  #    self.assertEqual(res.code, 400)
+  #    self.assertEqual(res.status, "error")
+  #    self.assertEqual(res.message, "Email in the 'to' field is not valid")
+  #
+  #def test_sending_message_and_report_with_wrong_email_in_reply_to(self):
+  #    res = self.api.messages.send_message(template_id=-1, to="e@e.e", reply_to="a", from_name="me", subject="Hi")
+  #    self.assertEqual(res.code, 400)
+  #    self.assertEqual(res.status, "error")
+  #    self.assertEqual(res.message, "Email in the 'reply_to' field is not valid")
+  #
+  #def test_sending_message_and_report_with_wrong_template_id(self):
+  #    res = self.api.messages.send_message(template_id=-1, to="e@e.e", reply_to="a@a.a", from_name="me", subject="Hi")
+  #    self.assertEqual(res.code, 400)
+  #    self.assertEqual(res.status, "error")
+  #    self.assertEqual(res.message, "template=-1 not found")
+
+
+  #TODO: complete the spec
+  it 'sends a single transactional message' do
+    message_response = PIGEON.messages.send_message 4905, ENV['TARGET_EMAIL'], ENV['TARGET_EMAIL'], "Team ExpressPigeon", "Hi there!",
+                                                    :first_name => "Igor"
+    validate_response message_response, 200, 'success', /email queued/
+    report = PIGEON.messages.report(message_response.id)
+    report.id.should eq message_response.id
+  end
+
+
+  #
+  #def test_reports_with_bad_dates(self):
+  #    res = self.api.messages.reports("abc", "")
+  #    self.assertEquals(res.code, 400)
+  #    self.assertEquals(res.status, "error")
+  #    self.assertEquals(res.message, "invalid 'start_date' or 'end_date'")
+  #
+  #def test_reports_with_start_date_only(self):
+  #    res = self.api.messages.reports("2013-03-16T11:22:23.210+0000", "")
+  #    self.assertEquals(res.code, 400)
+  #    self.assertEquals(res.status, "error")
+  #    self.assertEquals(res.message, "'start_date' and 'end_date' should be provided together")
+  #
+  #def test_reports_with_end_date_only(self):
+  #    res = self.api.messages.reports("", "2013-03-16T11:22:23.210+0000")
+  #    self.assertEquals(res.code, 400)
+  #    self.assertEquals(res.status, "error")
+  #    self.assertEquals(res.message, "'start_date' and 'end_date' should be provided together")
+  #
+  #def test_sending_multiple_messages_and_get_reports(self):
+  #    message_response = self.api.messages.send_message(template_id=self.template_id,
+  #                                                      to=os.environ['EXPRESSPIGEON_API_USER'],
+  #                                                      reply_to="a@a.a", from_name="me", subject="Hi",
+  #                                                      merge_fields={"first_name": "Gleb"})
+  #    self.assertEqual(message_response.code, 200)
+  #    self.assertEqual(message_response.status, "success")
+  #    self.assertEqual(message_response.message, "email queued")
+  #    self.assertTrue(message_response.id is not None and message_response.id != "")
+  #
+  #    message_response_2 = self.api.messages.send_message(template_id=self.template_id,
+  #                                                        to=os.environ['EXPRESSPIGEON_API_USER'],
+  #                                                        reply_to="a@a.a", from_name="me", subject="Hi 2",
+  #                                                        merge_fields={"first_name": "Gleb"})
+  #    self.assertEqual(message_response_2.code, 200)
+  #    self.assertEqual(message_response_2.status, "success")
+  #    self.assertEqual(message_response_2.message, "email queued")
+  #    self.assertTrue(message_response_2.id is not None and message_response.id != "")
+  #
+  #    report = self.__get_report_by_id__(message_response.id)
+  #
+  #    self.assertEquals(report.id, message_response.id)
+  #    self.assertEquals(report.email, os.environ['EXPRESSPIGEON_API_USER'])
+  #    self.assertTrue(report.in_transit is not None)
+  #
+  #    report2 = self.__get_report_by_id__(message_response_2.id)
+  #
+  #    self.assertEquals(report2.id, message_response_2.id)
+  #    self.assertEquals(report2.email, os.environ['EXPRESSPIGEON_API_USER'])
+  #    self.assertTrue(report2.in_transit is not None)
+  #
+  it 'test_sending_multiple_messages_and_get_reports_for_today(self):' do
+
+    start = Time.now.utc - 60 # one minute ago
+
+    message_response = PIGEON.messages.send_message 4905, ENV['TARGET_EMAIL'], ENV['TARGET_EMAIL'],
+                                                    'Team EP', "Hi, there!", :first_name => "Bob"
+
+    validate_response message_response, 200, 'success', /email queued/
+    message_response.id should_not be_nil
+
+    message_response2 = PIGEON.messages.send_message 4905, ENV['TARGET_EMAIL'], ENV['TARGET_EMAIL'],
+                                                     'Team EP', "Hi, there!", :first_name => "Bob"
+    validate_response message_response2, 200, 'success', /email queued/
+    message_response2.id should_not be_nil
+
+    finish = start + 120 # two minutes after start
+    reports = PIGEON.messages.reports (message_response.id - 1), start, finish
+
+    reports.size.should eq 2
+    reports[0]['id'].should eq message_response.id
+    reports[1]['id'].should eq message_response2.id
+
+    reports[0]['email'].should eq ENV['TARGET_EMAIL']
+    reports[1]['email'].should eq ENV['TARGET_EMAIL']
+  end
+  #
+  #def __get_report_by_id__(self, message_id, start_date=None, end_date=None):
+  #    reports = self.api.messages.reports() if start_date is None and end_date is None else \
+  #        self.api.messages.reports(start_date, end_date)
+  #    report = [r for r in reports if r.id == message_id]
+  #    self.assertEquals(len(report), 1)
+  #    return report[0]
+
+
+end

data/spec/pigeon_helper.rb

@@ -0,0 +1,16 @@
+PIGEON ||= ExpressPigeon::API
+TEMPLATE_ID ||= 1
+LIST_ID ||= 12
+API_USER ||= "non@non.non"
+DISABLED_LIST ||= 12
+
+module PigeonSpecHelper
+  def validate_response res, code, status, message
+    res.code.should eq code
+    res.status.should eq status
+    if message
+      (res.message =~ message).should_not be_nil
+    end
+
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: expresspigeon-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- ipolevoy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: ExpressPigeon Ruby API for sending transactional messages, manipulating
+  lists, contacts nad more
+email:
+- ipolevoy@groupon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- expresspigeon-ruby.gemspec
+- lib/expresspigeon-ruby.rb
+- lib/expresspigeon-ruby/version.rb
+- spec/campaigns_spec.rb
+- spec/contacts_spec.rb
+- spec/lists_spec.rb
+- spec/messages_spec.rb
+- spec/pigeon_helper.rb
+homepage: https://github.com/expresspigeon/expresspigeon-ruby
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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.8.25
+signing_key: 
+specification_version: 3
+summary: ExpressPigeon API Ruby Wrapper
+test_files:
+- spec/campaigns_spec.rb
+- spec/contacts_spec.rb
+- spec/lists_spec.rb
+- spec/messages_spec.rb
+- spec/pigeon_helper.rb