express_pigeon 1.0.4 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b3d1a3383fa183060358e85a5d33e8d207ee13f
+  data.tar.gz: 7b3f551bb3a794ab35b0751b68268a1c58f6e046
+SHA512:
+  metadata.gz: 4420cdbf8650d0ee8cf8d6f1b4c8c7a44fa50874906f724ef2dad4c0ccd551cf39c3c86cb739cec046df0256cb8fdfac4be985f6765d121e66fe278cb2b723ea
+  data.tar.gz: ad5968fce96f86ed1f53ff4e12e66e063488e2e302782f9472acebe49d5b6c47950ed8f84e1ea36ef4b4af63990d4a1449b8381292fa811d8f63b56ed8d73a07

data/.env.example

@@ -0,0 +1 @@
+EXPRESS_PIGEON_AUTH_KEY=yourauthkey

data/.gitignore

@@ -1,18 +1,21 @@
-*.gem
+**.orig
+*.a
+*.bundle
+*.iml
+*.o
 *.rbc
-.bundle
-.config
-.yardoc
+*.so
+.env
+/.idea/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/log/*
+/pkg/
+/spec/reports/
+/tmp/
 Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-.rbx/
+mkmf.log

data/.rspec

@@ -1,2 +1,3 @@
+--require spec_helper
 --color
 --format progress

data/.rubocop.yml

@@ -0,0 +1,17 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - '*.gemspec'
+    - 'Guardfile'
+    - 'bin/**/*'
+    - 'vendor/**/*'
+
+Style/LineLength:
+  Enabled: false
+
+Style/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,15 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-12-18 16:18:36 -0600 using RuboCop version 0.23.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 32
+Style/LineLength:
+  Max: 129
+
+# Offense count: 4
+# Configuration parameters: CountComments.
+Style/MethodLength:
+  Max: 18

data/.ruby-gemset

@@ -0,0 +1 @@
+express_pigeon

data/.ruby-version

@@ -0,0 +1 @@
+ruby

data/CONTRIBUTING.md

@@ -0,0 +1,21 @@
+# Hi!
+
+**DO _NOT_ RUN THE SPECS AGAINST YOUR PRODUCTION ACCOUNT. THEY ARE INTEGRATION TESTS AND WILL CREATE LISTS, CONTACTS, ETC INSIDE YOUR ACCOUNT.**
+
+- Create a "dummy" account on [https://expresspigeon.com](https://expresspigeon.com).
+- Create three custom_fields on the account.
+    - `my_custom_text_field` as `text` (no default)
+    - `my_custom_number_field` as `number` (no default)
+    - `my_custom_date_field` as `date` (no default)
+
+[![Steps to set up the custom fields](https://www.evernote.com/shard/s13/sh/f0eaefe9-5699-470e-8184-af03fa5cdd20/a000ef8eb5152edfe8f228f53aa71523/deep/0/ExpressPigeon---Custom-Fields-Settings.png)](https://expresspigeon.com/settings/custom_fields/)
+
+- Copy the `.env.example` to `.env`
+- Set the `EXPRESS_PIGEON_AUTH_KEY` to the *sandbox* auth key found in the integrations section of the ExpressPigeon account.
+
+[![Steps to find the Sandbox Authorization Key](https://www.evernote.com/shard/s13/sh/def4ff82-eefe-4303-82cc-964578a9595d/cba8f07aeb5cd2ab30e1114b477497fa/deep/0/ExpressPigeon---Integrations.png)](https://expresspigeon.com/settings/integrations/)
+
+- `bundle install ; bundle exec rspec` and you should be good.
+
+
+

data/Gemfile

@@ -3,16 +3,21 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in expresspigeon.gemspec
 gemspec
 
-group :development, :test do
-  gem 'awesome_print'
-  gem 'pry'
-  gem 'pry-nav'
+group :development do
+  gem 'byebug'
+  gem 'pry-byebug'
+
+  gem 'rubocop'
 
-  gem 'wirble'
+  gem 'colorize'
+end
+
+group :development, :test do
+  gem 'dotenv'
+  gem 'guard'
+  gem 'guard-rspec'
 end
 
 group :test do
-  gem 'rspec'
-  gem 'rspec-given'
-  gem 'activemodel-rspec', :git => "git://github.com/matthooks/activemodel-rspec.git"
+  gem 'simplecov', require: :false
 end

data/Guardfile

@@ -0,0 +1,56 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+directories %w(. lib spec)
+
+## Uncomment to clear the screen before every task
+clearing :on
+
+## Make Guard exit when config is changed so it can be restarted
+#
+## Note: if you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+#
+#  $ while bundle exec guard; do echo "Restarting Guard..."; done
+#
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), the you will want to move the Guardfile
+## to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+#
+watch ('Guardfile') do
+  UI.info 'Exiting because Guard must be restarted for changes to take effect'
+  exit 0
+end
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -1,4 +1,11 @@
-Copyright (c) 2012 Michael D. Hall
+The code for express_pigeon is Copyright (c) 2014 Mike Hall and is released
+under the MIT license below.  This code contains a modified version of
+expresspigeon-ruby. The 0.0.1 version of expresspigeon-ruby which was modified
+was obtained from: https://github.com/expresspigeon/expresspigeon-ruby. That
+code is covered by the following copyright and was also released under the MIT
+license below:
+
+Copyright (c) 2014 ExpressPigeon
 
 MIT License
 
@@ -19,4 +26,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,124 +1,4 @@
-# ExpressPigeon
-
-# ExpressPigeon [![TravisCI](https://secure.travis-ci.org/just3ws/express_pigeon-rb.png?branch=master)](http://travis-ci.org/just3ws/express_pigeon-rb) [![Gemnasium](https://gemnasium.com/just3ws/express_pigeon-rb.png)](https://gemnasium.com/just3ws/express_pigeon-rb)
-
-Library to interact with ExpressPigeon email service.
-
-## Pre-requisites
-
-1. Go to [Express Pigeon](http://expresspigeon.com)
-2. Sign up for a free account
-3. Create a Contact List
-4. Create a Web Form for the contact list
-5. Enable all the fields
-6. Take note of the guid generated for the web form.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'express_pigeon'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install express_pigeon
-
-## 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 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-
-# Email Fields
-
-    +---------------+--------------+
-    | Field         | Type         |
-    +---------------+--------------+
-    | address1      | varchar(255) |
-    | address2      | varchar(255) |
-    | city          | varchar(128) |
-    | company       | varchar(128) |
-    | country       | varchar(128) |
-    | date_of_birth | varchar(255) |
-    | email         | varchar(50)  | # likely upgraded to 100
-    | email_format  | varchar(20)  |
-    | first_name    | varchar(50)  |
-    | last_name     | varchar(50)  |
-    | phone         | varchar(30)  |
-    | state         | varchar(48)  |
-    | title         | varchar(30)  |
-    | zip           | varchar(24)  |
-    +---------------+--------------+
-
-
-## Form Data
-
-view-source:https://expresspigeon.com/subscription/form/51697971-48b4-45d3-ab80-3b23152999ed
-
-- submits to
-
-    <form action="/subscription/add_contact" method="post" id="subscribe_form" class="form-add clearer"
-
-- company name?
-
-    <title just3ws, llc - subscription</title
-
-- Web form name
-
-    <h2 express_pigeon.rb</h2
-
-- Web form title
-
-    <h2 Sign-up for our newsletters.</h2
-
-- Subtitle
-
-    <h4 This is optional text for the form. You may use it to further entice your audience to subscribe</h4
-
-- Form Fields
-
-    input type="hidden" name="guid" value="51697971-48b4-45d3-ab80-3b23152999ed"
-
-    input id="address1" name="address1"
-    input id="address2" name="address2"
-    input id="city" name="city"
-    input id="company" name="company"
-    input id="country" name="country"
-    input id="date_of_birth" name="date_of_birth"
-    input id="email" name="email"
-    input id="first_name" name="first_name"
-    input id="last_name" name="last_name"
-    input id="phone" name="phone"
-    input id="state" name="state"
-    input id="title" name="title"
-    input id="zip" name="zip"
-
-    label for="address1" Group Address 1
-    label for="address2" Group Address 2
-    label for="city" Group City
-    label for="company" Group Name
-    label for="country" Group Website
-    label for="date_of_birth" Group Twitter Name
-    label for="email" Your Email
-    label for="first_name" Your First Name
-    label for="last_name" Your Last Name
-    label for="phone" Group Management Site
-    label for="state" Group State
-    label for="title" Your Role In Group
-    label for="zip" Group Zip
-
-
-- Submit simple form via cURL
-
-    curl -v -d "guid=51697971-48b4-45d3-ab80-3b23152999ed&email=mdh@just3ws.com"
+This is a complete rewrite of the `expresspigeon-ruby` gem using an entirely
+different approach and effectively none of the original code. I've forked and
+created a derivative work from the original work by Igor Polevoy hence the new
+copyright on the license.

data/Rakefile

@@ -1,2 +1 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/express_pigeon.gemspec

@@ -1,21 +1,36 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/express_pigeon/version', __FILE__)
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'express_pigeon/version'
 
-Gem::Specification.new do |gem|
-  gem.authors       = ["Michael D. Hall"]
-  gem.email         = ["mdh@just3ws.com"]
-  gem.description   = %q{Light-weight wrapper around ExpressPigeon.}
-  gem.summary       = %q{API for interacting with ExpressPigeon service.}
-  gem.homepage      = "http://github.com/just3ws/express_pigeon-rb"
+Gem::Specification.new do |spec|
+  spec.name          = 'express_pigeon'
+  spec.version       = ExpressPigeon::VERSION
+  # Inspired by Igor Polevoy but a total re-write of the expresspigeon-ruby RubyGem
+  spec.authors       = %w(Mike Hall)
+  spec.email         = %w(mike@just3ws.com)
+  spec.description   = <<-EOS
+    (Another) ExpressPigeon Ruby API for sending transactional messages,
+    manipulating lists, contacts and more.
+  EOS
+  spec.summary       = 'ExpressPigeon API Ruby Wrapper'
+  spec.homepage      = 'https://github.com/just3ws/express_pigeon'
+  spec.license = 'MIT'
+  spec.extra_rdoc_files = %w(LICENSE README.md)
 
-  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.name          = "express_pigeon"
-  gem.require_paths = ["lib"]
-  gem.version       = ExpressPigeon::VERSION
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w(lib)
 
-  gem.add_runtime_dependency("activemodel")
-  gem.add_runtime_dependency("curb-fu")
-  gem.add_runtime_dependency("chronic")
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.1.0')
+
+  spec.add_dependency('httparty', '~> 0.13.3')
+  spec.add_runtime_dependency('httmultiparty', '~> 0.3', '>= 0.3.16')
+
+  spec.add_development_dependency('bundler', '~> 1.7')
+  spec.add_development_dependency('rake', '~> 10.0')
+  spec.add_development_dependency 'rspec', '~> 3.1', '>= 3.1.0'
+
+  spec.add_development_dependency('awesome_print', '~> 1.2', '>= 1.2.0')
 end

data/lib/express_pigeon/api/campaigns.rb

@@ -0,0 +1,62 @@
+# module ExpressPigeon
+#   module API
+#     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
+#   end
+# end

data/lib/express_pigeon/api/contacts.rb

@@ -0,0 +1,42 @@
+# module ExpressPigeon
+#   module API
+#     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
+#   end
+# end

data/lib/express_pigeon/api/lists.rb

@@ -0,0 +1,49 @@
+# module ExpressPigeon
+#   module API
+#     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
+#   end
+# end

data/lib/express_pigeon/api/messages.rb

@@ -0,0 +1,56 @@
+# module ExpressPigeon
+#   module API
+#     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
+#
+#       def reports(from_id, start_date = nil, end_date = nil)
+#         params = []
+#
+#         if from_id
+#           params << "from_id=#{from_id}"
+#         end
+#
+#         if start_date && !end_date
+#           fail 'must include both start_date and end_date'
+#         end
+#         if end_date && !start_date
+#           fail 'must include both start_date and end_date'
+#         end
+#
+#         if start_date && 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
+#   end
+# end