express_pigeon 1.0.4 → 2.0.0

data/spec/express_pigeon/api/contacts_spec.rb

@@ -0,0 +1,146 @@
+# RSpec.describe 'contacts integration test', skip: true 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/express_pigeon/api/lists_spec.rb

@@ -0,0 +1,23 @@
+# RSpec.describe 'contacts integration test', skip: true do
+#   include PigeonSpecHelper
+#
+#   it 'test_create_and_delete_new_list(self):' do
+#     contact_list = PIGEON.lists.create 'Active customers', 'Bob', 'bob@acmetools.com'
+#
+#     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
+#
+#     res = PIGEON.lists.delete(contact_list.list.id)
+#     validate_response res, 200, 'success', /list=#{contact_list.list.id} deleted successfully/
+#   end
+#
+#   it 'should update existing list' do
+#     existing_list = PIGEON.lists.create('Update', 'Bob', 'bob@acmetools.com')
+#   end
+#
+#   list_name = "Upload_#{Kernel.rand(9999)}"
+#   existing_list = PIGEON.lists.create(list_name, 'Bob', 'bob@acmetools.com')
+# end

data/spec/express_pigeon/api/messages_spec.rb

@@ -0,0 +1,36 @@
+# RSpec.describe 'transactional messages integration test', skip: true do
+#   include PigeonSpecHelper
+#
+#   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
+#
+#   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
+# end

data/spec/express_pigeon/contacts_spec.rb

@@ -0,0 +1,111 @@
+RSpec.describe ExpressPigeon::Contacts do
+  # WARN: These tests are assuming that the test
+  #       account has three custom fields already
+  #       defined on the account.
+  #
+  #       - my_custom_text_field (no default)
+  #       - my_custom_number_field (no default)
+  #       - my_custom_date_field (no default)
+  #
+  #       There isn't a way as of this commit to
+  #       specify custom fields via the API. You'll
+  #       have to configure them manually via the UI.
+
+  let(:auth_key) { ENV['EXPRESS_PIGEON_AUTH_KEY'] }
+  let(:name) { 'TEST List Name' }
+  let(:from_name) { 'Mike Hall' }
+  let(:reply_to) { 'mike@just3ws.com' }
+
+  let(:client) { ExpressPigeon::Contacts.new(auth_key) }
+
+  let(:contacts) do
+    [
+      {
+        'email' => 'mike@just3ws.com',
+        'first_name' => 'Mike',
+        'last_name' => 'Hall',
+        'my_custom_text_field' => 'some text value'
+      }
+    ]
+  end
+
+  before do
+    @list_a = ExpressPigeon::Lists.new(auth_key).create(
+      name: 'TEST List A',
+      from_name: 'Mike Hall',
+      reply_to: 'mike@just3ws.com'
+    )
+    @list_a_id = @list_a['list']['id']
+
+    @list_b = ExpressPigeon::Lists.new(auth_key).create(
+      name: 'TEST List B',
+      from_name: 'Mike Hall',
+      reply_to: 'mike@just3ws.com'
+    )
+    @list_b_id = @list_b['list']['id']
+  end
+
+  after do
+    ExpressPigeon::Lists.new(auth_key).index.select do |list|
+      list['name'] =~ /^TEST\s/i
+    end.map do |list|
+      list['id']
+    end.each do |list_id|
+      ExpressPigeon::Lists.new(auth_key).delete(list_id)
+    end
+  end
+
+  describe '#create' do
+    it 'creates a contact' do
+      response = client.create(@list_a_id, contacts)
+
+      expect(response['code']).to eq(200)
+      expect(response['contacts']).to eq(contacts.map { |contact| contact['email'] })
+    end
+  end
+
+  describe '#update' do
+    before do
+      client.create(@list_a_id, contacts)
+    end
+
+    it 'updates a contact' do
+      contacts.first['email'] = 'mike@ugtastic.com'
+
+      response = client.update(@list_a_id, contacts)
+
+      expect(response['code']).to eq(200)
+      expect(response['contacts']).to eq(contacts.map { |contact| contact['email'] })
+    end
+  end
+
+  describe '#move' do
+    let(:email_addresses) { ['mike@just3ws.com'] }
+
+    before do
+      client.create(@list_a_id, contacts)
+    end
+
+    it 'updates a contact' do
+      response = client.move(@list_a_id, @list_b_id, contacts)
+
+      expect(response['code']).to eq(200)
+      expect(response['message']).to eq("contacts moved from list=#{@list_a_id} to list=#{@list_b_id}")
+    end
+  end
+
+  describe '#find' do
+    before do
+      client.create(@list_a_id, contacts)
+    end
+
+    it 'finds an existing contact' do
+      response = client.find(contacts.first['email'])
+
+      expect(response.code).to eq(200)
+      expect(response['lists'].map { |list| list['id'] }).to include(@list_a_id)
+      expect(response['email']).to eq(contacts.first['email'])
+      expect(response['custom_fields']['my_custom_text_field']).to eq('some text value')
+    end
+  end
+end

data/spec/express_pigeon/lists_spec.rb

@@ -0,0 +1,131 @@
+RSpec.describe ExpressPigeon::Lists do
+  let(:auth_key) { ENV['EXPRESS_PIGEON_AUTH_KEY'] }
+  let(:name) { 'TEST List Name' }
+  let(:from_name) { 'Mike Hall' }
+  let(:reply_to) { 'mike@just3ws.com' }
+
+  let(:client) { ExpressPigeon::Lists.new(auth_key) }
+
+  after do
+    ExpressPigeon::Lists.new(auth_key).index.select do |list|
+      list['name'] =~ /^TEST\s/i
+    end.map do |list|
+      list['id']
+    end.each do |list_id|
+      ExpressPigeon::Lists.new(auth_key).delete(list_id)
+    end
+  end
+
+  it '#index' do
+    response = client.index
+    expect(response.code).to eq(200)
+  end
+
+  it '#create' do
+    response = client.create(name: name, from_name: from_name, reply_to: reply_to)
+
+    expect(response['list']['id']).to be_a(Fixnum)
+
+    expect(response['code']).to eq(200)
+    expect(response['message']).to eq("list=#{response['list']['id']} created/updated successfully")
+    expect(response['list']['name']).to eq(name)
+    expect(response['list']['from_name']).to eq(from_name)
+    expect(response['list']['reply_to']).to eq(reply_to)
+  end
+
+  context 'existing list' do
+    before do
+      @created = client.create(name: name, from_name: from_name, reply_to: reply_to)
+      expect(@created['code']).to eq(200)
+
+      @list_id = @created['list']['id']
+      expect(@list_id).to be_a(Fixnum)
+    end
+
+    describe '#update(list_id, name, from_name, reply_to)' do
+      it 'modifies the list' do
+        name = 'TEST updated'
+        from_name = 'Changed'
+        reply_to = 'different@email.com'
+
+        response = client.update(
+          @list_id,
+          name: name,
+          from_name: from_name,
+          reply_to: reply_to
+        )
+
+        expect(response['code']).to eq(200)
+        expect(response['message']).to eq("list=#{@list_id} created/updated successfully")
+        expect(response['list']['name']).to eq(name)
+        expect(response['list']['from_name']).to eq(from_name)
+        expect(response['list']['reply_to']).to eq(reply_to)
+      end
+    end
+
+    describe '#upload(list_id, path)' do
+      it 'fails if file does not exist' do
+        path = 'thisisaninvalidfilepath'
+
+        expect { client.upload(@list_id, path) }.to raise_error("No file found at '#{path}'.")
+      end
+
+      it 'uploads a csv file' do
+        path = File.join(Dir.pwd, 'spec', 'fixtures', 'contacts.csv')
+        response =  client.upload(@list_id, path)
+
+        expect(response['upload_id']).to be_a(Fixnum)
+        expect(response['code']).to eq(200)
+        expect(response['message']).to eq('file uploaded successfully')
+      end
+
+      it 'uploads a zipped csv' do
+        path = File.join(Dir.pwd, 'spec', 'fixtures', 'contacts.csv.zip')
+        response =  client.upload(@list_id, path)
+
+        expect(response['upload_id']).to be_a(Fixnum)
+        expect(response['code']).to eq(200)
+        expect(response['message']).to eq('file uploaded successfully')
+      end
+
+      describe '#upload_status(list_id)' do
+        context 'already uploaded file' do
+          before do
+            path = File.join(Dir.pwd, 'spec', 'fixtures', 'contacts.csv')
+            @uploaded =  client.upload(@list_id, path)
+            @upload_id = @uploaded['upload_id']
+          end
+
+          it 'has a status' do
+            response = client.upload_status(@upload_id)
+            expect(response['code']).to eq(200)
+            expect(response['report']['list_id']).to eq(@list_id)
+          end
+        end
+      end
+
+      describe '#download_csv(list_id, path)' do
+        context 'already uploaded file' do
+          before do
+            path = File.join(Dir.pwd, 'spec', 'fixtures', 'contacts.csv')
+            @uploaded =  client.upload(@list_id, path)
+          end
+
+          it 'downloads a csv file' do
+            download_path = File.join(Dir.pwd, 'tmp', 'contacts.csv')
+            File.delete(download_path) if File.exist?(download_path)
+            response = client.download_csv(@list_id, download_path)
+
+            expect(response.code).to eq(200)
+            expect(File.exist?(download_path)).to eq(true)
+
+            # TODO: Parse the response.
+            #       Right now the response is "valid" but the
+            #       Ruby CSV parser is failing to handle the quotes.
+            # csv = CSV.read(download_path, headers: :first_row, quote_char: '"')
+          end
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/contacts.csv

@@ -0,0 +1,2 @@
+Email, First name, Last name, City, Phone, Company, Title, Address 1, Address 2, State, Zip, Country, Date of birth
+"john@doe.com","John","Doe","Flagstaff",,"Acme Tools","Director","123 Pine St.",,"AZ","86001",,"04/03/1969"

data/spec/spec_helper.rb

@@ -1,20 +1,108 @@
+require 'dotenv'
+Dotenv.load
+
+require 'express_pigeon'
+
+# 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
+
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper.rb"` to ensure that it is only
-# loaded once.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
 
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
 
-$LOAD_PATH.unshift '.'
-$LOAD_PATH.unshift File.dirname(__FILE__) + "/../lib"
-require 'activemodel-rspec'
-require 'rspec/given'
-
-RSpec.configure do |config|
-  config.include ActiveModelMatchers
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.run_all_when_everything_filtered                = true
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
   config.filter_run :focus
-  config.filter_run_excluding :live => true
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  # config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'progress'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
 end