mark_as_read 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b514a65b8ece9190711d84ccb55e27c003060cc5
+  data.tar.gz: 4f3d62466c62f14f02f0a626993f0feb0e1ac7a4
+SHA512:
+  metadata.gz: d553dd7a81c42ba80e3ffaa4704564863ef63fe6954f88d346c20c922d46df8849bc2ccab5038590abf3a872ab528ac34c0d5301ee2a1c98e751feb0060420c2
+  data.tar.gz: 831bfab4e936aa4de2d7a0f6179c01ae9434678c8e672731b3d9c4ae86b60260d004555087f0f95db8d52274f2d8722bed0695fd1aa3d50063d86e22f418d3fa

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/.rspec

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

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.0"
+gemfile:
+  - gemfiles/Gemfile.rails-3.2.x
+  - gemfiles/Gemfile.rails-4.0.x
+  - gemfiles/Gemfile.rails-edge
+matrix:
+  allow_failures:
+    - gemfile: gemfiles/Gemfile.rails-edge

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '4.0.2'
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Intrepidd
+
+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,54 @@
+# mark_as_read [![Build Status](https://travis-ci.org/Intrepidd/mark_as_read.png?branch=master)](https://travis-ci.org/Intrepidd/mark_as_read) [![Code Climate](https://codeclimate.com/github/Intrepidd/mark_as_read.png)](https://codeclimate.com/github/Intrepidd/mark_as_read)
+
+This gem allows you to be notified when one of your users reads an e-mail you sent to him via a tracking gif.
+It's compatible with ruby on rails and any ORM that implements ``find`` and has an ``id`` field for its models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mark_as_read'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mark_as_read
+
+## Usage
+
+Let's say you have a ``Message`` class, simply add the following to describe the behavior to execute when a message is read:
+
+    class Message < ActiveRecord::Base
+
+      include MarkAsRead::Readable
+
+      mark_as_read do |message|
+        message.update_attributes(:read => true)
+      end
+
+    end
+
+The read message is yielded to the ``mark_as_read`` function so you can do anything you want on it.
+
+
+Then, in your mailer view, you just have to add the tracking image, let's assume you have the message in the ``@message`` variable :
+
+    <%= mark_as_read_img(@message) %>
+    
+## Disclaimer
+
+Tracking email openings with an image is not an exact science, depending on the client, the image may not been displayed unless the user asks for it.
+
+Many clients will cache the image after its first load so it won't be loaded again, this gem is useful for knowing IF an e-mail has been opened, not really for knowing how many times.
+
+
+## Contributing
+
+1. Fork it ( http://github.com/Intrepidd/mark_as_read/fork )
+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,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/controllers/mark_as_read/mark_as_read_controller.rb

@@ -0,0 +1,17 @@
+module MarkAsRead
+  class MarkAsReadController < ActionController::Base
+
+    def read
+      verifier = ActiveSupport::MessageVerifier.new(Rails.application.config.secret_key_base)
+      type = params[:type].constantize rescue nil
+      raise UnknownType.new("No such type: #{type}") unless type
+      raise InvalidType.new("Type #{type} is not a valid model type") unless type.respond_to?(:find)
+
+      model = type.find(verifier.verify(params[:id]))
+      raise InvalidType.new("Type #{type} does not include mark_as_read") unless model.respond_to?(:mark_as_read!)
+      model.mark_as_read!
+      send_data(Base64.decode64("R0lGODlhAQABAPAAAAAAAAAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="), :type => "image/gif", :disposition => "inline")
+    end
+
+  end
+end

data/app/helpers/mark_as_read/mailer_helper.rb

@@ -0,0 +1,12 @@
+module MarkAsRead
+
+  module MailerHelper
+
+    def mark_as_read_img(model)
+      verifier = ActiveSupport::MessageVerifier.new(Rails.application.config.secret_key_base)
+      image_tag(mark_as_read_url(:type => model.class, :id => verifier.generate(model.id)))
+    end
+
+  end
+
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  get '/mark_as_read/:type/:id.gif' => 'mark_as_read/mark_as_read#read', :as => 'mark_as_read'
+end

data/gemfiles/Gemfile.rails-3.2.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec :path => '..'
+
+gem 'rails', '~> 3.2.0'

data/gemfiles/Gemfile.rails-4.0.x

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec :path => '..'
+
+gem 'rails', '~> 4.0.0'
+

data/gemfiles/Gemfile.rails-edge

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec :path => '..'
+
+gem 'rails', :github => 'rails/rails'

data/lib/mark_as_read.rb

@@ -0,0 +1,10 @@
+require "mark_as_read/version"
+require "mark_as_read/engine"
+require "mark_as_read/readable"
+
+module MarkAsRead
+
+  class UnknownType < StandardError; end
+  class InvalidType < StandardError; end
+
+end

data/lib/mark_as_read/engine.rb

@@ -0,0 +1,12 @@
+require 'rails'
+require 'active_record'
+
+module MarkAsRead
+  class Engine < Rails::Engine
+
+    initializer "Add helper to ActionMailer" do
+      ActionMailer::Base.helper MarkAsRead::MailerHelper
+    end
+
+  end
+end

data/lib/mark_as_read/readable.rb

@@ -0,0 +1,25 @@
+require 'active_support/concern'
+
+module MarkAsRead
+  module Readable
+
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_accessor :mark_as_read_proc
+    end
+
+    module ClassMethods
+      def mark_as_read(&block)
+        self.mark_as_read_proc = block
+      end
+    end
+
+    def mark_as_read!
+      if self.mark_as_read_proc
+        self.mark_as_read_proc.call(self)
+      end
+    end
+
+  end
+end

data/lib/mark_as_read/version.rb

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

data/mark_as_read.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mark_as_read/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mark_as_read"
+  spec.version       = MarkAsRead::VERSION
+  spec.authors       = ["Adrien Siami"]
+  spec.email         = ["adrien@siami.fr"]
+  spec.summary       = "Allows to easily track when an e-mail has been opened"
+  spec.homepage      = ""
+  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.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec-rails"
+
+  spec.add_dependency("rails", ">= 3.2.6", "< 5")
+end

data/spec/controllers/mark_as_read/mark_as_read_controller_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'fixtures/foo_model'
+require 'fixtures/bar_model'
+
+describe MarkAsRead::MarkAsReadController do
+
+  before do
+    verifier = ActiveSupport::MessageVerifier.new(Rails.application.config.secret_key_base)
+    @id = verifier.generate(42)
+  end
+
+  it 'should raise if invalid type is provided' do
+    expect {
+      get :read, :type => 'notatype', :id => @id
+    }.to raise_error(MarkAsRead::UnknownType)
+  end
+
+  it 'should raise if not model type is provided' do
+    expect {
+      get :read, :type => 'Fixnum', :id => @id
+    }.to raise_error(MarkAsRead::InvalidType)
+  end
+
+  it 'should raise if not mark as read model type is provided' do
+    BarModel.stub(:find).and_return(BarModel.new)
+    expect {
+      get :read, :type => 'BarModel', :id => @id
+    }.to raise_error(MarkAsRead::InvalidType)
+  end
+
+  it 'should mark the model as read if everything is alright' do
+    model = FooModel.new
+    model.id = 42
+
+    FooModel.should_receive(:find).with(42).and_return(model)
+    proc = lambda { |model| }
+    FooModel.class_eval do
+      mark_as_read(&proc)
+    end
+
+    proc.should_receive(:call).with(model)
+
+
+    get :read, :type => 'FooModel', :id => @id
+
+  end
+
+  it 'should raise ActiveSupport::MessageVerifier::InvalidSignature if bad message' do
+    FooModel.stub(:find).and_return(nil)
+    expect {
+      get :read, :type => 'FooModel', :id => 'foobar'
+      }.to raise_error(ActiveSupport::MessageVerifier::InvalidSignature)
+  end
+
+end

data/spec/fixtures/bar_model.rb

@@ -0,0 +1,5 @@
+class BarModel
+  extend ActiveModel::Naming
+
+  attr_accessor :id
+end

data/spec/fixtures/foo_model.rb

@@ -0,0 +1,6 @@
+class FooModel
+  include MarkAsRead::Readable
+  extend ActiveModel::Naming
+
+  attr_accessor :id
+end

data/spec/mailers/mailer_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'fixtures/foo_model'
+
+describe FooMailer do
+  it 'should include a link to the image' do
+    model = FooModel.new
+    model.id = 42
+    FooModel.stub(:first).and_return model
+    verifier = ActiveSupport::MessageVerifier.new(Rails.application.config.secret_key_base)
+    FooMailer.foo.body.to_s.should include("example.com/mark_as_read/FooModel/#{verifier.generate(model.id)}.gif")
+  end
+end

data/spec/models/readable_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'fixtures/foo_model'
+
+describe MarkAsRead::Readable do
+
+  describe '#mark_as_read' do
+    it 'should store the proc' do
+      proc = lambda { puts "Hello world" }
+      FooModel.class_eval do
+        mark_as_read(&proc)
+      end
+
+      FooModel.mark_as_read_proc.should == proc
+    end
+  end
+
+  describe '#mark_as_read!' do
+    it 'should call the proc' do
+      proc = lambda { puts "Hello world" }
+      FooModel.class_eval do
+        mark_as_read(&proc)
+      end
+
+      instance = FooModel.new
+      proc.should_receive(:call).with(instance)
+      instance.mark_as_read!
+    end
+  end
+
+end

data/spec/rails_app/.gitignore

@@ -0,0 +1,16 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/rails_app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+RailsApp::Application.load_tasks

data/spec/rails_app/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require_tree .