toolong-dontread 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3927d48fa7ed1bc2ffaa5b949fcc5e537ab8b1b9
+  data.tar.gz: 009a5e9ab421831e0b301dd0c0680507959d255a
+SHA512:
+  metadata.gz: 54245e42ae469a77d759074aa612d1a75d070721a812d00d333140d8e080e36de10a8370205b502e90bff3240e3a415556b6a17f16411070e56fa1023e551257
+  data.tar.gz: 160b82c6df46aa3eb5fcbcfe6315fe86482a45d03196f393fb3e25f48e591e357e5cb97213b3adc7cf25290f51b035d09bce1957aa99e000e5174714c6ea10f1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    tldr (0.0.1)
+      activerecord
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.0.2)
+      activesupport (= 4.0.2)
+      builder (~> 3.1.0)
+    activerecord (4.0.2)
+      activemodel (= 4.0.2)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.2)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.1)
+    atomic (1.1.14)
+    builder (3.1.4)
+    i18n (0.6.9)
+    metaclass (0.0.1)
+    minitest (4.7.5)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.8.2)
+    rake (10.1.1)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha
+  tldr!

data/README.md

@@ -0,0 +1,68 @@
+tl;dr
+====
+
+Enable unsubscribe links within your emails
+
+# Description
+
+Some of your users don't want to hear from you or your shitty application. You can add unsubscribe links to your mail views so that your users can relieve themselves of the pain you have endured on them.
+
+# Installation
+
+```rb
+# Gemfile
+gem 'toolong-dontread'
+```
+
+```sh
+rails g tldr:install
+
+rake db:migrate
+```
+
+# Usage
+
+Inside your mailer you can generate an uninstall url.
+
+```rb
+class AccountMailer < ActionMailer::Base
+  def new_follower_notification(user, follower)
+    ...
+    token = Tldr::TokenGenerator.new(user, :new_follower_notification).token
+    @unsubscribe_url = unsubscribe_url(token)
+    ...
+  end
+end
+```
+
+Inside your model to test if someone is subscribed
+
+```rb
+  class User < ActiveRecord::Base
+    include Tldr::Subscriber
+  end
+
+  # elsewhere
+  user = User.find params[:id]
+  user.subscribed_to? :new_follower_notification
+```
+
+Inside your controller if you are using Rails
+
+```rb
+class AccountsController < ApplicationController
+  def unsubscribe
+    subscription = Tldr.unsubscribe params[:token]
+    redirect_to dashboard_path(subscription.values[:user]), notice: 'You have successfully been unsubscribed from that stupid ass email'
+  end
+end
+```
+
+# Contributing
+
+1. Clone the repository `git clone https://github.com/brilliantfantastic/tldr`
+1. Create a feature branch `git checkout -b my-awesome-feature`
+1. Codez!
+1. Commit your changes (small commits please)
+1. Push your new branch `git push origin my-awesome-feature`
+1. Create a pull request `hub pull-request -b brilliantfantastic:master -h brilliantfantastic:my-awesome-feature`

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+
+task :default => :test
+
+desc "Run tests"
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['spec/*_spec.rb']
+  t.verbose = true
+end

data/lib/generators/tldr/USAGE

@@ -0,0 +1,5 @@
+Description:
+  Generates the necessary files to get you up and running with tl;dr gem
+
+Examples:
+  rails generate tldr:install

data/lib/generators/tldr/install_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+
+module Tldr
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_migrations
+        migration_template "migration/create_cancelled_subscriptions_table.rb", "db/migrate/create_cancelled_subscriptions_table.rb"
+      end
+
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          sleep 1 # make sure each time we get a different timestamp
+          Time.new.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+    end
+  end
+end

data/lib/generators/tldr/templates/migration/create_cancelled_subscriptions_table.rb

@@ -0,0 +1,12 @@
+class CreateCancelledSubscriptionsTable < ActiveRecord::Migration
+  def change
+    create_table :cancelled_subscriptions do |t|
+      t.integer :subscriber_id, null: false
+      t.string :email_name, null: false
+
+      t.timestamps
+    end
+
+    add_index :cancelled_subscriptions, [:subscriber_id, :email_name]
+  end
+end

data/lib/tldr/cancelled_subscription.rb

@@ -0,0 +1,6 @@
+require 'active_record'
+
+module Tldr
+  class CancelledSubscription < ActiveRecord::Base
+  end
+end

data/lib/tldr/subscriber.rb

@@ -0,0 +1,15 @@
+module Tldr
+  module Subscriber
+    def self.included(klass)
+      klass.class_eval do
+        include InstanceMethods
+      end
+    end
+
+    module InstanceMethods
+      def subscribed_to?(email)
+        !Tldr::CancelledSubscription.exists?(subscriber_id: id, email_name: email)
+      end
+    end
+  end
+end

data/lib/tldr/token_generator.rb

@@ -0,0 +1,25 @@
+require 'base64'
+
+module Tldr
+  class TokenGenerator
+    attr_reader :token
+
+    def initialize(subscriber_id, email_name)
+      @subscriber_id = subscriber_id
+      @email_name = email_name
+      generate
+    end
+
+    def self.decode(token)
+      result = Base64.urlsafe_decode64 token
+      values = result.split '|'
+      {subscriber_id: values[0], email_name: values[1].to_sym} if values.length == 2
+    end
+
+    private
+
+    def generate
+      @token = Base64.urlsafe_encode64 "#{@subscriber_id}|#{@email_name}"
+    end
+  end
+end

data/lib/tldr/version.rb

@@ -0,0 +1,3 @@
+module Tldr
+  VERSION = "0.0.2"
+end

data/lib/tldr.rb

@@ -0,0 +1,17 @@
+require_relative 'tldr/version'
+require_relative 'tldr/subscriber'
+require_relative 'tldr/cancelled_subscription'
+require_relative 'tldr/token_generator'
+
+module Tldr
+  def self.unsubscribe(token)
+    values = Tldr::TokenGenerator.decode(token)
+    if values
+      conditions = {subscriber_id: values[:subscriber_id],
+                       email_name: values[:email_name]}
+      unless Tldr::CancelledSubscription.exists? conditions
+        Tldr::CancelledSubscription.create! conditions
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'mocha/setup'
+
+require_relative '../lib/tldr'

data/spec/subscriber_spec.rb

@@ -0,0 +1,26 @@
+require_relative 'spec_helper'
+
+describe Tldr::Subscriber do
+  class User
+    include Tldr::Subscriber
+    attr_reader :id
+
+    def initialize(attrs={})
+      @id = attrs[:id]
+    end
+  end
+
+  describe '#subscribed_to?' do
+    it 'returns true if the subscription exists for the subscriber' do
+      Tldr::CancelledSubscription.expects(:exists?).with(subscriber_id: 123, email_name: :some_email).returns false
+      user = User.new(id: 123)
+      user.subscribed_to?(:some_email).must_equal true
+    end
+
+    it 'returns false if the subscriber has cancelled' do
+      Tldr::CancelledSubscription.expects(:exists?).with(subscriber_id: 123, email_name: :some_other_email).returns 1
+      user = User.new(id: 123)
+      user.subscribed_to?(:some_other_email).must_equal false
+    end
+  end
+end

data/spec/token_generator_spec.rb

@@ -0,0 +1,31 @@
+require_relative 'spec_helper'
+
+describe Tldr::TokenGenerator do
+  it 'generates a url safe token for a given user and email' do
+    token = Tldr::TokenGenerator.new(123, :some_email).token
+    token.wont_be_nil
+    token.wont_match /^\s*$/
+  end
+
+  it 'generates the same token for the same user and email' do
+    token1 = Tldr::TokenGenerator.new(123, :some_email).token
+    token2 = Tldr::TokenGenerator.new(123, :some_email).token
+    token1.must_equal token2
+  end
+
+  describe '.decode' do
+    it 'returns a hash of values based on the token' do
+      subscriber_id = 123
+      email_name = :some_email
+      token = Tldr::TokenGenerator.new(subscriber_id, email_name).token
+      values = Tldr::TokenGenerator.decode(token)
+      values[:subscriber_id].must_equal subscriber_id.to_s
+      values[:email_name].must_equal email_name
+    end
+
+    it 'handles a non base 64 token' do
+      values = Tldr::TokenGenerator.decode 'blah'
+      values.must_be_nil
+    end
+  end
+end

data/spec/unsubscribe_spec.rb

@@ -0,0 +1,29 @@
+require_relative 'spec_helper'
+
+describe 'unsubscribe a user' do
+  let(:subscriber_id) { 123 }
+  let(:email_name) { :some_email }
+
+  before(:all) do
+    @token = Tldr::TokenGenerator.new(subscriber_id, email_name).token
+  end
+
+  it 'adds the subscriber to the CancelledSubscribers' do
+    Tldr::CancelledSubscription.expects(:exists?).returns(false)
+    Tldr::CancelledSubscription.expects(:create!).with({subscriber_id: subscriber_id.to_s, email_name: email_name})
+    Tldr.unsubscribe @token
+  end
+
+  it 'does not try to insert an invalid token' do
+    Tldr::CancelledSubscription.expects(:create!).never
+    Tldr.unsubscribe 'blah'
+  end
+
+  it 'does not unsubscribe twice' do
+    Tldr::CancelledSubscription.expects(:exists?).returns(false)
+    Tldr::CancelledSubscription.expects(:create!).with({subscriber_id: subscriber_id.to_s, email_name: email_name}).once
+    Tldr.unsubscribe @token
+    Tldr::CancelledSubscription.expects(:exists?).returns(true)
+    Tldr.unsubscribe @token
+  end
+end

data/tldr.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tldr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "toolong-dontread"
+  spec.version       = Tldr::VERSION
+
+  spec.authors       = ["Jamie Wright"]
+  spec.email         = ["jamie@brilliantfantastic.com"]
+
+  spec.summary       = "Enable unsubscribe links in your email"
+  spec.description   = %q{
+                        Some of your users don't want to hear from you or your shitty application. 
+                        You can add unsubscribe links to your mail views so that your users can relieve themselves of the pain you have endured on them.
+                       }
+
+  spec.homepage      = "http://github.com/brilliantfantastic/tldr"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rake"
+  spec.add_dependency "activerecord"
+  spec.add_development_dependency "mocha"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: toolong-dontread
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jamie Wright
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: activerecord
+  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: mocha
+  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: "\n                        Some of your users don't want to hear from
+  you or your shitty application. \n                        You can add unsubscribe
+  links to your mail views so that your users can relieve themselves of the pain you
+  have endured on them.\n                       "
+email:
+- jamie@brilliantfantastic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/generators/tldr/USAGE
+- lib/generators/tldr/install_generator.rb
+- lib/generators/tldr/templates/migration/create_cancelled_subscriptions_table.rb
+- lib/tldr.rb
+- lib/tldr/cancelled_subscription.rb
+- lib/tldr/subscriber.rb
+- lib/tldr/token_generator.rb
+- lib/tldr/version.rb
+- spec/spec_helper.rb
+- spec/subscriber_spec.rb
+- spec/token_generator_spec.rb
+- spec/unsubscribe_spec.rb
+- tldr.gemspec
+homepage: http://github.com/brilliantfantastic/tldr
+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: Enable unsubscribe links in your email
+test_files:
+- spec/spec_helper.rb
+- spec/subscriber_spec.rb
+- spec/token_generator_spec.rb
+- spec/unsubscribe_spec.rb