ahoy_email 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 099588e69bfa92fd90438816b1a5ef6857fb2f23
+  data.tar.gz: b9c49ef5f702558434df01c199c8eacd93d80bb3
+SHA512:
+  metadata.gz: 27f621400f1b6c2f85408f4e68c43a7cdd420b8b1496ba27b6715190a60c792a105762b1e6e1daa1ea04e31c12ca301618a9d93c4b483ce3eff820f4d7f0e350
+  data.tar.gz: df563aa16ce94a7197248a449de900f3501349d9b77450a294ed2e2b038e74702e040c7ee49f22e920ba8e9cb95e14b4865a08c7a0ceee6a07a163b0fd26c050

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrew Kane
+
+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,47 @@
+# Ahoy Email
+
+:construction: Coming soon - May 1, 2014
+
+:envelope: Simple, powerful email tracking for Rails
+
+Keep track of emails:
+
+- sent
+- opened
+- clicked
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'ahoy_email'
+```
+
+And run the generator. This creates a model to store messages.
+
+```sh
+rails generate ahoy_email:install
+rake db:migrate
+```
+
+## How It Works
+
+Ahoy creates an `Ahoy::Message` record when an email is sent. It also adds:
+
+- open tracking
+- click tracking
+- UTM parameters
+
+## TODO
+
+- Subscription management (lists, opt-outs)
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/ahoy_email/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/ahoy_email/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/ahoy_email.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ahoy_email/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ahoy_email"
+  spec.version       = AhoyEmail::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@chartkick.com"]
+  spec.summary       = %q{Simple, powerful email tracking for Rails}
+  spec.description   = %q{Simple, powerful email tracking for Rails}
+  spec.homepage      = "https://github.com/ankane/ahoy_email"
+  spec.license       = "MIT"
+
+  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 = ["lib"]
+
+  spec.add_dependency "actionmailer"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/app/controllers/ahoy/messages_controller.rb

@@ -0,0 +1,9 @@
+module Ahoy
+  class MessagesController < ActionController::Base
+
+    def open
+      puts "OPENED!"
+    end
+
+  end
+end

data/app/models/ahoy/message.rb

@@ -0,0 +1,4 @@
+module Ahoy
+  class Message < ActiveRecord::Base
+  end
+end

data/config/routes.rb

@@ -0,0 +1,9 @@
+Rails.application.routes.draw do
+  mount AhoyEmail::Engine => "/ahoy"
+end
+
+AhoyEmail::Engine.routes.draw do
+  resources :messages, only: [] do
+    get :open, on: :collection
+  end
+end

data/lib/ahoy_email/engine.rb

@@ -0,0 +1,5 @@
+module AhoyEmail
+  class Engine < ::Rails::Engine
+    isolate_namespace AhoyEmail
+  end
+end

data/lib/ahoy_email/interceptor.rb

@@ -0,0 +1,24 @@
+module AhoyEmail
+  class Interceptor
+    # include ActionView::Helpers::AssetTagHelper
+
+    def self.delivering_email(message)
+      # body = (message.html_part || message).body.raw_source
+      # p AhoyEmail::Engine.routes
+      # if body
+      #   regex = /<\/body>/i
+      #   pixel = image_tag(AhoyEmail::Engine.routes.url_helpers.url_for(controller: "messages", action: "open"))
+      #   if body.match(regex)
+      #     body.gsub!(regex, "#{pixel}\\0")
+      #   else
+      #     body << pixel
+      #   end
+      # end
+      Ahoy::Message.create!(
+        subject: message.subject,
+        content: message.to_s
+      )
+    end
+
+  end
+end

data/lib/ahoy_email/version.rb

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

data/lib/ahoy_email.rb

@@ -0,0 +1,6 @@
+require "ahoy_email/version"
+require "action_mailer"
+require "ahoy_email/interceptor"
+require "ahoy_email/engine"
+
+ActionMailer::Base.register_interceptor AhoyEmail::Interceptor

data/lib/generators/ahoy_email/install_generator.rb

@@ -0,0 +1,30 @@
+# taken from https://github.com/collectiveidea/audited/blob/master/lib/generators/audited/install_generator.rb
+require "rails/generators"
+require "rails/generators/migration"
+require "active_record"
+require "rails/generators/active_record"
+
+module AhoyEmail
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      # Implement the required interface for Rails::Generators::Migration.
+      def self.next_migration_number(dirname) #:nodoc:
+        next_migration_number = current_migration_number(dirname) + 1
+        if ActiveRecord::Base.timestamped_migrations
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+
+      def copy_migration
+        migration_template "install.rb", "db/migrate/create_ahoy_messages.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/ahoy_email/templates/install.rb

@@ -0,0 +1,20 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    create_table :ahoy_messages do |t|
+      # user
+      t.integer :user_id
+      t.string :user_type
+
+      # message
+      t.text :subject
+      t.text :content
+
+      # timestamps
+      t.timestamp :sent_at
+      t.timestamp :opened_at
+      t.timestamp :clicked_at
+    end
+
+    add_index :ahoy_messages, [:user_id, :user_type]
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: ahoy_email
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple, powerful email tracking for Rails
+email:
+- andrew@chartkick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ahoy_email.gemspec
+- app/controllers/ahoy/messages_controller.rb
+- app/models/ahoy/message.rb
+- config/routes.rb
+- lib/ahoy_email.rb
+- lib/ahoy_email/engine.rb
+- lib/ahoy_email/interceptor.rb
+- lib/ahoy_email/version.rb
+- lib/generators/ahoy_email/install_generator.rb
+- lib/generators/ahoy_email/templates/install.rb
+homepage: https://github.com/ankane/ahoy_email
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Simple, powerful email tracking for Rails
+test_files: []