ponch 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.DS_Store
+*~
+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 'http://rubygems.org'
+
+# Specify your gem's dependencies in ponch.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011
+
+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,42 @@
+# Ponch
+
+Simple email analytics for your Rails app
+
+## Information
+
+**Ponch** lets you track opened emails if you're using your own sendmail server or Amazon SES.
+
+Only works on Rails 3.x
+
+It works by inserting an 1x1 tracking gif on your html emails and adding a controller that handles the request to that image.
+
+## Installation
+
+Simply add in your Gemfile
+
+``` ruby
+gem 'ponch'
+```
+
+and then set in your config/environment.rb (or in each environment file) the details for 
+
+``` ruby
+config.ponch.url_options = {host: "localhost", port: 3000}
+```
+
+And then Ponch takes care of the rest for you!
+
+## Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with Rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Licence
+
+Ponch is released under the MIT license.

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -rponch"
+end

data/TODO.md

@@ -0,0 +1,3 @@
+* Add tests
+* Add click tracking
+* Develop some simple frontend

data/app/controllers/ponch/tracking_controller.rb

@@ -0,0 +1,12 @@
+class Ponch::TrackingController < ActionController::Base
+
+  def pixel
+    ponch_delivery = Ponch::Delivery.find_by_code params[:code]
+
+    ponch_delivery.open!(request.remote_ip) if ponch_delivery
+
+    send_file File.expand_path('../../../../images/blank.gif', __FILE__),
+              type: "image/gif", disposition: 'inline', stream: false
+  end
+
+end

data/app/models/ponch/delivery.rb

@@ -0,0 +1,40 @@
+module Ponch
+  class Delivery < ActiveRecord::Base
+    set_table_name :ponch_deliveries
+
+    validates_presence_of :to, :from, :sent_at
+
+    scope :opened, where("opened_at is not null")
+
+    before_create :generate_code
+
+    def opened?
+      !opened_at.nil?
+    end
+
+    def open!(ip_address = nil)
+      unless opened?
+        self.opened_at = Time.now
+        self.opened_ip = ip_address
+        self.save! 
+      end
+    end
+
+    #class methods
+    def self.create_from_mail(mail)
+      self.create!  to: mail.to.first,
+                    from: mail.from.first,
+                    subject: mail.subject,
+                    sent_at: Time.now
+    end
+
+    private
+    def generate_code
+      self.code = loop do
+        code_attempt = SecureRandom.hex(20)
+        break code_attempt unless self.class.find_by_code(code_attempt)
+      end
+    end
+
+  end
+end

data/config/routes.rb

@@ -0,0 +1,6 @@
+Rails.application.routes.draw do
+
+  get "ponch/tracking/:code.gif" => "ponch/tracking#pixel", as: "ponch_pixel"
+
+end
+

data/lib/generators/ponch/deliveries_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators'
+require "rails/generators/migration"
+
+module Ponch
+  module Generators
+
+    class DeliveriesGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc "Creates a base migration for Ponch::Delivery model"
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_files
+        migration_template('create_deliveries.rb', 'db/migrate/create_ponch_deliveries.rb')
+      end
+
+      def self.next_migration_number(dirname) #:nodoc:
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/generators/ponch/templates/create_deliveries.rb

@@ -0,0 +1,25 @@
+class CreatePonchDeliveries < ActiveRecord::Migration
+
+  def self.up
+    create_table :ponch_deliveries do |t|
+      t.string   :to,           :null => false
+      t.string   :from,         :null => false
+      t.string   :subject
+
+      t.string   :code,         :null => false
+      t.datetime :sent_at,      :null => false
+
+      t.datetime :opened_at
+      t.string   :opened_ip
+
+      t.datetime :clicked_at
+      t.string   :clicked_ip
+    end
+    add_index :ponch_deliveries, :code, unique: true
+  end
+
+  def self.down
+    drop_table :ponch_deliveries
+  end
+
+end

data/lib/ponch.rb

@@ -0,0 +1,15 @@
+require "ponch/version"
+require 'ponch/config'
+require 'ponch/engine'
+
+module Ponch
+
+  class << self
+    def config
+      @config ||= Ponch::Config.new
+      yield(@config) if block_given?
+      @config
+    end
+  end
+
+end

data/lib/ponch/config.rb

@@ -0,0 +1,11 @@
+module Ponch
+  class Config
+
+    attr_writer :url_options
+
+    def url_options
+      @url_options || ActionMailer::Base.default_url_options
+    end
+
+  end
+end

data/lib/ponch/engine.rb

@@ -0,0 +1,20 @@
+require 'ponch/interceptor'
+
+module Ponch
+  class Engine < ::Rails::Engine#:nodoc:
+
+    config.ponch = ActiveSupport::OrderedOptions.new
+
+    config.to_prepare do
+      Ponch::Engine.config.ponch.each do |key, value|
+        Ponch.config.send "#{key}=".to_sym, value
+      end
+    end
+
+    #action mailer register_interceptor
+    ActiveSupport.on_load(:action_mailer) do
+      ActionMailer::Base.register_interceptor(Interceptor)
+    end
+
+  end
+end

data/lib/ponch/interceptor.rb

@@ -0,0 +1,25 @@
+require 'nokogiri'
+
+module Ponch
+  class Interceptor
+
+    def self.delivering_email(message)
+      if html_part = (message.html_part || (message.content_type =~ /text\/html/ && message))
+        delivery = Ponch::Delivery.create_from_mail message
+
+        message_body = html_part.body.to_s
+
+        html_doc = Nokogiri::HTML(message_body)
+
+        pixel_url = Rails.application.routes.url_helpers.ponch_pixel_url(delivery.code, Ponch.config.url_options)
+        tracking_pixel = "<img src=\"#{pixel_url}\" />"
+        html_doc.at("body").add_child(tracking_pixel)
+
+        #set the HTML part with tracking pixel at the end
+        html_part.body =  html_doc.to_s
+      end
+      message
+    end
+
+  end
+end

data/lib/ponch/version.rb

@@ -0,0 +1,3 @@
+module Ponch
+  VERSION = "0.0.1"
+end

data/ponch.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ponch/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Esteban Pastorino"]
+  gem.email         = ["ejpastorino@gmail.com"]
+  gem.description   = "Ponch lets you track opened emails if you're using your own sendmail server or Amazon SES. Only works on Rails 3.x. It works by inserting an 1x1 tracking gif on your html emails and adding a controller that handles the request to that image."
+  gem.summary       = "Simple email analytics for your Rails app"
+  gem.homepage      = "https://github.com/kitop/ponch"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "ponch"
+  gem.require_paths = ["lib"]
+  gem.version       = Ponch::VERSION
+
+  gem.add_dependency 'railties', ['>= 3.0.0']
+  gem.add_dependency 'nokogiri', ['>= 1.4.7']
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: ponch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Esteban Pastorino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: &19667820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *19667820
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &19683660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *19683660
+description: Ponch lets you track opened emails if you're using your own sendmail
+  server or Amazon SES. Only works on Rails 3.x. It works by inserting an 1x1 tracking
+  gif on your html emails and adding a controller that handles the request to that
+  image.
+email:
+- ejpastorino@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- TODO.md
+- app/controllers/ponch/tracking_controller.rb
+- app/models/ponch/delivery.rb
+- config/routes.rb
+- images/blank.gif
+- lib/generators/ponch/deliveries_generator.rb
+- lib/generators/ponch/templates/create_deliveries.rb
+- lib/ponch.rb
+- lib/ponch/config.rb
+- lib/ponch/engine.rb
+- lib/ponch/interceptor.rb
+- lib/ponch/version.rb
+- ponch.gemspec
+homepage: https://github.com/kitop/ponch
+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.10
+signing_key: 
+specification_version: 3
+summary: Simple email analytics for your Rails app
+test_files: []