banana_peels 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1256b534deb0dc6e3c0d9b47361b3d6cfb42347c
+  data.tar.gz: 95efea6d6d804b85d7a384f89cf2bba48a2586e4
+SHA512:
+  metadata.gz: 28b9e17db54a9722bff8c19beababc247683763c519677d03d24b8eb05b71db149c6f76a520966c5f70ed7d0bfa3740ff479db874d4a992325e80599093d09ac
+  data.tar.gz: 8176ca9afdf3bb786866d412cf7ab448cbf75bfcd4f8348feea7147a21b8f641dc4542fa811650ee5ede92e3ea5b2eff7471dcb8a71a81147a7fde7098b43dec

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Steven Bull
+
+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,89 @@
+# BananaPeels
+
+Interface for using MailChimp as a template repository for transactional emails. MailChimp campaigns define email content, using merge tags as placeholders for injectable content pieces.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'banana_peels'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install banana_peels
+
+## Usage
+
+### Campaign listing with ENV info (Rails)
+
+app/controllers/campaigns_controller.rb:
+
+```ruby
+class CampaignsController < ApplicationController
+
+  def index
+    @campaigns = Chimp.campaigns(ENV['MAILCHIMP_API_KEY'])
+    @env_vars = {}
+    by_id = @campaigns.index_by{ |c| c['id'] }
+    ENV.each do |k,v|
+      @env_vars[v] = k if by_id[v]
+    end
+  end
+
+end
+
+```
+
+app/views/campaigns/index.html.slim:
+```slim
+h1 MailChimp Campaigns
+table
+  thead
+    tr
+      th Campaign Title
+      th Mailchimp ID
+      th ENV
+  tbody
+    - @campaigns.each do |c|
+      tr
+        td = c['title']
+        td = c['id']
+        td = @env_vars[c['id']]
+```
+
+### Sending transactional emails using a MailChimp Campaign as a template
+
+app/mailers/user_mailer.rb:
+```ruby
+class UserMailer < ActionMailer::Base
+
+  def reset_password_instructions(record, token, opts={})
+    user = User.find(record.id)
+    mail_options = {
+      to: BananaPeels.email_with_name("#{user.first_name} #{user.last_name}", user.email),
+    }
+    merge_tags = {
+      'FIRST_NAME' => user.first_name,
+      'LAST_NAME' => user.last_name,
+      'RESET_PASSWORD_URL' => edit_user_password_url(reset_password_token: token),
+    }
+    BananaPeels.mail(self, ENV['RESET_PASSWORD_CAMPAIGN_ID'], mail_options, merge_tags, ENV['MAILCHIMP_API_KEY'])
+  end
+
+end
+```
+
+And then use the merge tags `*|FIRST_NAME|*`, `*|LAST_NAME|*`, `*|RESET_PASSWORD_URL|*` in your MailChimp Campaign.
+
+
+## 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/banana_peels.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'banana_peels/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "banana_peels"
+  spec.version       = BananaPeels::VERSION
+  spec.authors       = ["Steven Bull"]
+  spec.email         = ["steven@thebulls.us"]
+  spec.description   = "Interface for using MailChimp as a template repository for transactional emails. MailChimp campaigns define email content, using merge tags as placeholders for injectable content pieces."
+  spec.summary       = "Interface for using MailChimp as a template repository for transactional emails."
+  spec.homepage      = "https://github.com/sbull/banana_peels"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+
+  spec.add_runtime_dependency('mailchimp-api', '~> 2.0')
+end

data/lib/banana_peels.rb

@@ -0,0 +1,5 @@
+require 'mailchimp'
+
+require 'banana_peels/version'
+require 'banana_peels/api'
+require 'banana_peels/campaign'

data/lib/banana_peels/api.rb

@@ -0,0 +1,37 @@
+module BananaPeels
+
+  class << self
+
+    def api(api_key)
+      Mailchimp::API.new(api_key)
+    end
+
+    def campaigns(api_key)
+      api_data = api(api_key).campaigns.list([], 0, 1000) # TODO: presumes <= 1000 campaigns
+      api_data['data']
+    end
+
+    def campaign(campaign_id, merge_tags, api_key)
+      Campaign.new(campaign_id, merge_tags, api_key)
+    end
+
+    # Use this instead of #mail() in ActionMailer.
+    def mail(mailer, campaign_id, mail_options, merge_tags, api_key)
+      c = campaign(campaign_id, merge_tags, api_key)
+      mailer.mail(c.default_mail_options.merge(mail_options)) do |format|
+        format.text { mailer.render text: c.text_content }
+        format.html(content_transfer_encoding: 'quoted-printable') do
+          mailer.render text: [c.html_content].pack('M')
+        end
+      end
+    end
+
+    # Utility method.
+    def email_with_name(name, email)
+      name = name.gsub(/([\\"])/, '\\'=>'\\\\', '"'=>'\\"')
+      "\"#{name}\" <#{email}>"
+    end
+
+  end
+
+end

data/lib/banana_peels/campaign.rb

@@ -0,0 +1,91 @@
+class BananaPeels::Campaign
+
+  class << self
+
+    def replace_merge_tags(string, merge_tags)
+      string.gsub(/\*\|(\w+)\|\*/) do
+        merge_tags[$1.upcase]
+      end
+    end
+
+  end
+
+  # merge_tags: optional, nil for default
+  def initialize(campaign_id, merge_tags, api_key)
+    @campaign_id = campaign_id
+    @merge_tags = normalize_merge_tags(merge_tags || {})
+    @api = BananaPeels.api(api_key)
+  end
+
+  def mailchimp_meta
+    # TODO: Cache campaigns from mailchimp.
+    @mailchimp_meta ||= @api.campaigns.list({ campaign_id: @campaign_id })['data'].first
+  end
+
+  def mailchimp_content
+    # TODO: Cache.
+    @mailchimp_content ||= @api.campaigns.content(@campaign_id, { view: 'raw' })
+  end
+
+  def default_mail_options
+    {
+      from: from,
+      subject: subject,
+    }
+  end
+
+  def from
+    BananaPeels.email_with_name(from_name, from_email)
+  end
+
+  def from_name
+    mailchimp_meta['from_name']
+  end
+
+  def from_email
+    mailchimp_meta['from_email']
+  end
+
+  def subject
+    replace_merge_tags(mailchimp_meta['subject'])
+  end
+
+  def to_name
+    replace_merge_tags(mailchimp_meta['to_name'])
+  end
+
+  def text_content
+    content = mailchimp_content['text'].to_s
+    content = content.sub(/=*\s*Unsubscribe\s\*\|HTML:EMAIL\|\*.*\z/m,'') # Auto-replaced if deleted.
+    content = content.sub(/=*\s*This\semail\swas\ssent\sto\s\*\|EMAIL\|\*.*\z/m,'') # When generated from HTML version.
+    content = content.sub(/=*\s*[^\n]*\*\|UNSUB\|\*.*\z/m,'') # Original generation.
+    replace_merge_tags(content)
+  end
+
+  def html_content
+    content = mailchimp_content['html'].to_s
+    content = content.sub(/(.*)<center>.*?canspamBarWrapper.*?<\/center>/m,'\1')
+    merge_tags = @merge_tags.dup
+    merge_tags.each do |k,v|
+      merge_tags[k] = CGI.escapeHTML(v.to_s).gsub("\n","\n<br>")
+    end
+    replace_merge_tags(content, merge_tags)
+  end
+
+  def replace_merge_tags(string, merge_tags=nil)
+    self.class.replace_merge_tags(string, merge_tags || @merge_tags)
+  end
+
+  def normalize_merge_tags(merge_tags)
+    normalized = {}
+    if merge_tags
+      merge_tags.each do |k,v|
+        normalized[k.to_s.upcase] = v
+      end
+    end
+    normalized['FNAME'] ||= normalized['FIRST_NAME']
+    normalized['LNAME'] ||= normalized['LAST_NAME']
+    normalized
+  end
+
+end

data/lib/banana_peels/version.rb

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

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: banana_peels
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Steven Bull
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: mailchimp-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Interface for using MailChimp as a template repository for transactional
+  emails. MailChimp campaigns define email content, using merge tags as placeholders
+  for injectable content pieces.
+email:
+- steven@thebulls.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- banana_peels.gemspec
+- lib/banana_peels.rb
+- lib/banana_peels/api.rb
+- lib/banana_peels/campaign.rb
+- lib/banana_peels/version.rb
+homepage: https://github.com/sbull/banana_peels
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Interface for using MailChimp as a template repository for transactional
+  emails.
+test_files: []