express_pigeon 1.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rbx/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p194-perf@express_pigeon"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.13.6 (master)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+  if [[ $- == *i* ]] # check for interactive shells
+  then echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+  else echo "Using: $GEM_HOME" # don't use colors in non-interactive shells
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - ree
+script: bundle exec rspec spec
+before_install:
+  - gem update --system
+  - gem --version

data/Gemfile

@@ -0,0 +1,18 @@
+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'
+
+  gem 'wirble'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'rspec-given'
+  gem 'activemodel-rspec', :git => "git://github.com/matthooks/activemodel-rspec.git"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Michael D. Hall
+
+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,124 @@
+# 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"

data/Rakefile

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

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby -w
+# encoding: utf-8
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + "/../lib"
+
+require 'express_pigeon'
+require 'irb'
+require 'irb/completion'
+
+include ExpressPigeon
+
+IRB.start

data/express_pigeon.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/express_pigeon/version', __FILE__)
+
+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.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
+
+  gem.add_runtime_dependency("activemodel")
+  gem.add_runtime_dependency("curb-fu")
+end

data/lib/express_pigeon/version.rb

@@ -0,0 +1,3 @@
+module ExpressPigeon
+  VERSION = "1.0.1"
+end

data/lib/express_pigeon.rb

@@ -0,0 +1,137 @@
+require "express_pigeon/version"
+require 'active_support'
+require 'time'
+require 'active_model'
+require 'awesome_print'
+
+module ExpressPigeon
+  class WebForm
+    include ActiveModel::Validations
+    include ActiveModel::Dirty
+
+    define_attribute_methods [
+      :address1,
+      :address2,
+      :city,
+      :company,
+      :country,
+      :date_of_birth,
+      :email,
+      :first_name,
+      :guid,
+      :last_name,
+      :phone,
+      :state,
+      :title,
+      :zip,
+    ]
+
+    # TODO after submitting the form try to capture the response for errors?
+
+    validates :guid,  :presence => true
+    validates :email, :presence => true, :length => 3..50, :allow_blank => false
+
+    # TODO check the actual form to see whether a field is required.
+    #
+    # The functionality to check whether a field is actually required
+    # hasn't been implemented yet. Go ahead and just assume they're not
+    # required and just check bounds.
+    validates :address1, :length => 0..255, :allow_blank => true
+    validates :address2, :length => 0..255, :allow_blank => true
+    validates :city, :length => 0..128, :allow_blank => true
+    validates :company, :length => 0..128, :allow_blank => true
+    validates :country, :length => 0..128, :allow_blank => true
+
+    # now sure why we can put 255 chars into date of birth but that's what it is.
+    # TODO validate and require date format, submit as MM/DD/YYYY
+    validates :date_of_birth, :length => 0..255, :allow_blank => true
+
+    # will email_form be a submittable field?
+
+    validates :first_name, :length => 0..50, :allow_blank => true
+    validates :last_name, :length => 0..50, :allow_blank => true
+
+    validates :phone, :length => 0..30, :allow_blank => true
+
+    # state is 48?
+    validates :state, :length => 0..48, :allow_blank => true
+
+    validates :title, :length => 0..30, :allow_blank => true
+
+    # zip is 24?
+    validates :zip, :length => 0..24, :allow_blank => true
+
+
+    # TODO validate date format MM/DD/YYYY
+    # TODO validate state
+    # TODO validate field sizes
+
+    def address1      ; @address1      ; end
+    def address2      ; @address2      ; end
+    def city          ; @city          ; end
+    def company       ; @company       ; end
+    def country       ; @country       ; end
+    def date_of_birth ; @date_of_birth ; end
+    def email         ; @email         ; end
+    def first_name    ; @first_name    ; end
+    def guid          ; @guid          ; end
+    def last_name     ; @last_name     ; end
+    def phone         ; @phone         ; end
+    def state         ; @state         ; end
+    def title         ; @title         ; end
+    def zip           ; @zip           ; end
+
+    def address1=(val)      ; address1_will_change! unless val == @address1           ; @address1 = val      ; end
+    def address2=(val)      ; address2_will_change! unless val == @address2           ; @address2 = val      ; end
+    def city=(val)          ; city_will_change! unless val == @city                   ; @city = val          ; end
+    def company=(val)       ; company_will_change! unless val == @company             ; @company = val       ; end
+    def country=(val)       ; country_will_change! unless val == @country             ; @country = val       ; end
+    def date_of_birth=(val) ; date_of_birth_will_change! unless val == @date_of_birth ; @date_of_birth = val ; end
+    def email=(val)         ; email_will_change! unless val == @email                 ; @email = val         ; end
+    def first_name=(val)    ; first_name_will_change! unless val == @first_name       ; @first_name = val    ; end
+    def guid=(val)          ; guid_will_change! unless val == @guid                   ; @guid = val          ; end
+    def last_name=(val)     ; last_name_will_change! unless val == @last_name         ; @last_name = val     ; end
+    def phone=(val)         ; phone_will_change! unless val == @phone                 ; @phone = val         ; end
+    def state=(val)         ; state_will_change! unless val == @state                 ; @state = val         ; end
+    def title=(val)         ; title_will_change! unless val == @title                 ; @title = val         ; end
+    def zip=(val)           ; zip_will_change! unless val == @zip                     ; @zip = val           ; end
+
+    def save
+      return false unless self.valid?
+      response = push_to_express_pigeon!
+      if response
+        @previously_changed = changes
+        @changed_attributes.clear
+      end
+    end
+
+    private
+
+    def push_to_express_pigeon!
+      url = "https://expresspigeon.com/subscription/add_contact"
+
+      params = {
+        :address1      => self.address1,
+        :address2      => self.address2,
+        :city          => self.city,
+        :company       => self.company,
+        :country       => self.country,
+        :date_of_birth => self.date_of_birth,
+        :email         => self.email,
+        :first_name    => self.first_name,
+        :guid          => self.guid,
+        :last_name     => self.last_name,
+        :phone         => self.phone,
+        :state         => self.state,
+        :title         => self.title,
+        :zip           => self.zip,
+      }
+
+      require 'curb-fu'
+
+      response = CurbFu.post({:url => url}, params)
+
+      response
+    end
+  end
+end

data/script/lint

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+clear
+
+export RBXOPT="-X19 -Xrbc.db"
+rvm rbx@express_pigeon exec pelusa lib/*.rb

data/script/multispec

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+
+clear
+
+export RBXOPT="-X19 -Xrbc.db"
+
+echo; echo "---------"  
+echo "  ree"
+echo "---------"; echo
+rvm ree@express_pigeon exec bundle &> /dev/null
+rvm ree@express_pigeon exec bundle exec rspec spec/
+
+echo; echo "---------"  
+echo "  rbx"
+echo "---------"; echo
+rvm rbx@express_pigeon exec bundle &> /dev/null
+rvm rbx@express_pigeon exec bundle exec rspec spec/
+
+echo; echo "---------"  
+echo "  1.9.3"
+echo "---------"; echo
+rvm 1.9.3@express_pigeon exec bundle &> /dev/null
+rvm 1.9.3@express_pigeon exec bundle exec rspec spec/

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# 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.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+
+$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
+  config.filter_run :focus
+  config.filter_run_excluding :live => true
+end

data/spec/web_forms_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+require 'express_pigeon'
+
+describe ExpressPigeon::WebForm do
+
+  describe "Validations" do
+    it { should_not be_valid }
+    it { should validate_presence_of :email }
+    it { should validate_presence_of :guid }
+
+    describe "specific validations" do
+      # TODO add the matchers to activemodel-rspec
+      #      that will make this section easier
+      let(:form) do
+        f = ExpressPigeon::WebForm.new
+        f.guid = "51697971-48b4-45d3-ab80-3b23152999ed"
+        f.email = "valid@just3ws.com"
+        f.should be_valid
+        f
+      end
+
+      it "checks email field" do
+        # minimum - valid
+        form.email = "x@y"
+        form.should be_valid
+
+        # maximum - valid
+        form.email = "#{'x'*48}@y"
+        form.should be_valid
+
+        # too long - invalid
+        form.email = "is.too.long.#{'x'*50}@just3ws.com"
+        form.should_not be_valid
+      end
+
+
+      {"address1" => 255,
+       "address2" => 255,
+       "city" => 128,
+       "company" => 128,
+       "country" => 128,
+       "date_of_birth" => 255,
+       "first_name" => 50,
+       "last_name" => 50,
+       "phone" => 30,
+       "state" => 48,
+       "title" => 30,
+       "zip" => 24}.each_pair do |name, length|
+         it "checks #{name} max length" do
+           # maximum - valid
+           form.send("#{name}=".to_sym, "x"*length)
+           form.should be_valid
+
+           # too long invalid
+           form.send("#{name}=".to_sym, "x"*(length+1))
+           form.should_not be_valid
+         end
+       end
+    end
+  end
+
+  describe "Pushing data to ExpressPigeon.com" do
+    it { subject.save.should be_false }
+  end
+
+  describe "Dirty Tracking" do
+    it { should_not be_changed }
+
+    context "changed email" do
+      before { subject.email = "foo@bar.com" }
+
+      it { should be_changed }
+      it { should be_email_changed }
+    end
+
+    it "resets changed after successfully saving" do
+      wf = ExpressPigeon::WebForm.new
+      wf.email = "doesnt@matter.com"
+      wf.guid = "doesn't matter"
+      wf.stub(:push_to_express_pigeon!).and_return(true)
+      wf.save
+      wf.should_not be_changed
+    end
+
+    it "remains changed when save fails" do
+      wf = ExpressPigeon::WebForm.new
+      wf.email = "doesnt@matter.com"
+      wf.guid = "doesn't matter"
+      wf.stub(:push_to_express_pigeon!).and_return(false)
+      wf.save
+      wf.should be_changed
+    end
+  end
+
+  it "pushes to expresspigeon.com", :live => true do
+    wf = ExpressPigeon::WebForm.new
+    wf.guid = "51697971-48b4-45d3-ab80-3b23152999ed"
+
+    wf.first_name = "Michael"
+    wf.last_name = "Hall"
+
+    wf.email = "mdh+rspec@just3ws.com"
+
+    wf.address1 = "1 Way Street"
+    wf.address1 = "Suite #0"
+
+    wf.city = "Springfield"
+    wf.state = "Illinois"
+    wf.zip = "60606"
+    wf.country = "United States"
+
+    wf.date_of_birth = "1/1/1900"
+
+    wf.phone = "888-555-1212"
+
+    wf.title = "Emperor of Mankind"
+    wf.company = "Imperium of Man"
+
+
+    #wf.should_receive(:push_to_express_pigeon!)
+
+    wf.save
+    pending "need to get the actual push to EP working first"
+    wf.should be_changed
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: express_pigeon
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael D. Hall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: curb-fu
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Light-weight wrapper around ExpressPigeon.
+email:
+- mdh@just3ws.com
+executables:
+- console
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- express_pigeon.gemspec
+- lib/express_pigeon.rb
+- lib/express_pigeon/version.rb
+- script/lint
+- script/multispec
+- spec/spec_helper.rb
+- spec/web_forms_spec.rb
+homepage: http://github.com/just3ws/express_pigeon-rb
+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.24
+signing_key: 
+specification_version: 3
+summary: API for interacting with ExpressPigeon service.
+test_files:
+- spec/spec_helper.rb
+- spec/web_forms_spec.rb