devise-vero 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d28d275a1f7ccfb1c2e28a71d76ef26b3be90856
+  data.tar.gz: 4787b8c509eee0cf7d81049593085a953e692792
+SHA512:
+  metadata.gz: 6500af0f868ba1eac81eb4dd27094b1bde33ce35c780d93b99c912b0ffb7929f3d27a31c9c31c5b72c8e1622c462984302570720224d683faafe914ff5e77dfb
+  data.tar.gz: 749d244440057bdf0fd6859799299b27a7d7956f94dacfcb17bef787d3927ee36f777cb221a884b6f14308eac92e5ab405316e0aa23e03f5b6feda29514d4f5a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+cache: bundler
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - ruby-head
+git:
+  depth: 1
+script:
+  - bundle exec rspec
+  - bundle exec rubocop
+addons:
+  code_climate:
+    repo_token: 51a6e0e84ef782cfb3ebebcdab36d9caeec07af803477d948f9c23efbf058c43

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Love Mondays Ltda
+
+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,36 @@
+# devise-vero
+
+[![Build Status](https://travis-ci.org/LoveMondays/devise-vero.svg)](https://travis-ci.org/LoveMondays/devise-vero)
+[![Code Climate](https://codeclimate.com/github/LoveMondays/devise-vero/badges/gpa.svg)](https://codeclimate.com/github/LoveMondays/devise-vero)
+[![Test Coverage](https://codeclimate.com/github/LoveMondays/devise-vero/badges/coverage.svg)](https://codeclimate.com/github/LoveMondays/devise-vero)
+[![Dependency Status](https://gemnasium.com/LoveMondays/devise-vero.svg)](https://gemnasium.com/LoveMondays/devise-vero)
+
+Replace transaction emails sent by [Devise](https://github.com/plataformatec/devise) with [Vero](http://www.getvero.com) events.
+
+Tested with devise ~3.4
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'devise-vero'
+```
+
+Run `bundle install`, and then run:
+
+    rails generate devise:vero:install
+
+To copy the default configuration file to your initializers directory.
+
+## Usage
+
+That's it
+
+## Contributing
+
+1. Fork it ( https://github.com/LoveMondays/devise-vero/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,25 @@
+# encoding: utf-8
+require 'rubygems'
+require 'bundler'
+require 'bundler/gem_tasks'
+
+begin
+  Bundler.setup(:default, :development)
+  Bundler::GemHelper.install_tasks
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+require 'rake'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run RuboCop'
+RuboCop::RakeTask.new(:style)
+
+task default: [:spec, :style]

data/devise-vero.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'devise/vero/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'devise-vero'
+  spec.version       = Devise::Vero::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = [
+    'Estevão Mascarenhas',
+    'Vinicius Negrisolo',
+    "Shane O'Grady"
+  ]
+  spec.email         = [
+    'estevao.am@gmail.com',
+    'vinicius.negrisolo@gmail.com',
+    'shane@ogrady.ie'
+  ]
+  spec.summary       = 'Replace Devise transactional emails with Vero events.'
+  spec.description   = 'Replace Devise transactional emails with Vero events.'
+  spec.homepage      = 'https://github.com/LoveMondays/devise-vero'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin/) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)/)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rails', '~> 4.1'
+  spec.add_dependency 'devise', '~> 3.2'
+  spec.add_dependency 'vero'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+end

data/lib/devise/vero/model.rb

@@ -0,0 +1,45 @@
+module Devise
+  module Models
+    # VeroNotification module
+    module Vero
+      extend ActiveSupport::Concern
+
+      protected
+
+      # This method overwrites devise's own `send_devise_notification`
+      # to capture all email notifications and send the
+      # event to Vero instead
+      def send_devise_notification(notification, *args)
+        super if Devise::Vero.send_transactional_email
+
+        return if Devise::Vero.disabled
+
+        # If the record is dirty
+        # we keep pending notifications to be enqueued
+        # by the callback and avoid before commit
+        if changed?
+          devise_pending_notifications << [notification, args]
+        else
+          send_to_vero(notification, *args)
+        end
+      end
+
+      # Send all pending notifications.
+      def send_devise_pending_notifications
+        devise_pending_notifications.each do |notification, args|
+          send_to_vero(notification, *args)
+        end
+
+        @devise_pending_notifications = []
+      end
+
+      def devise_pending_notifications
+        @devise_pending_notifications ||= []
+      end
+
+      def send_to_vero(notification, *args)
+        Devise::Vero::Sender.new(notification, self, *args).deliver
+      end
+    end
+  end
+end

data/lib/devise/vero/sender.rb

@@ -0,0 +1,20 @@
+module Devise
+  module Vero
+    # Sender class
+    class Sender
+      attr_reader :notification, :instance, :token, :args
+
+      def initialize(notification, instance, *args)
+        @notification = notification
+        @instance = instance
+        @token = args[0] if args.any?
+        @args = args
+      end
+
+      # Actually send the event to Vero
+      def deliver
+        instance.track!(notification, token: token, data: args)
+      end
+    end
+  end
+end

data/lib/devise/vero/version.rb

@@ -0,0 +1,6 @@
+module Devise
+  # Vero module to define VERSION
+  module Vero
+    VERSION = '0.1.1'
+  end
+end

data/lib/devise/vero.rb

@@ -0,0 +1,25 @@
+require 'active_support/dependencies'
+require 'active_support/concern'
+
+module Devise
+  # Models module
+  module Models
+    autoload :Vero, 'devise/vero/model'
+  end
+
+  # Vero module for sending Devise emails through Vero
+  module Vero
+    autoload :Sender, 'devise/vero/sender'
+
+    mattr_accessor :send_transactional_email, :disabled
+
+    @disabled = false
+
+    def self.config
+      yield self
+    end
+  end
+end
+
+# Register devise-async model in Devise
+Devise.add_module(:vero, model: 'devise/vero/model')

data/lib/devise_vero.rb

@@ -0,0 +1 @@
+require 'devise/vero'

data/lib/generators/devise/vero/install_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators/base'
+
+module Devise
+  module Vero
+    module Generators
+      # InstallGenerator create the conf to Devise integration with Vero
+      class InstallGenerator < Rails::Generators::Base
+        source_root File.expand_path('../templates', __FILE__)
+
+        desc 'Creates the default configuration file for Devise::Vero'
+        def copy_initializer
+          template 'devise_vero.rb', 'config/initializers/devise_vero.rb'
+        end
+      end
+    end
+  end
+end

data/lib/generators/devise/vero/templates/devise_vero.rb

@@ -0,0 +1,7 @@
+Devise::Vero.config do |c|
+  # Send email beside sending the Vero event tracking?
+  c.send_transactional_email = false
+
+  # Disable it on test environment
+  c.disabled = Rails.env.test?
+end

data/spec/devise/vero/model_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'pry'
+
+describe Devise::Models::Vero do
+  let(:klass) do
+    Class.new do
+      include ActiveModel::Dirty
+      include Devise::Models::Vero
+    end
+  end
+
+  subject { klass.new }
+
+  context '#send_devise_notification' do
+    context 'Devise::Vero is disabled' do
+      it "doesn't send to vero if config is disabled" do
+        allow(Devise::Vero).to receive(:disabled).and_return(true)
+        allow(subject).to receive(:send_to_vero)
+
+        expect(subject.send(:send_devise_notification, nil)).to be_nil
+        expect(subject).to_not have_received(:send_to_vero)
+      end
+    end
+
+    context 'Devise::Vero is enabled' do
+      it 'does send to vero if config is disabled' do
+        allow(Devise::Vero).to receive(:disabled).and_return(false)
+        allow(subject).to receive(:send_to_vero)
+
+        expect(subject.send(:send_devise_notification, nil)).to be_nil
+        expect(subject).to have_received(:send_to_vero)
+      end
+
+      context 'valid call' do
+        let(:token) { SecureRandom.hex }
+
+        before do
+          allow(subject).to receive(:changed?).and_return(false)
+          allow(Devise::Vero).to receive(:disabled).and_return(false)
+        end
+
+        it 'calls `send_to_vero` method' do
+          allow(subject).to receive(:send_to_vero)
+
+          subject.send(:send_devise_notification, :test, token)
+
+          expect(subject).to have_received(:send_to_vero).with(:test, token)
+        end
+      end
+    end
+  end
+end

data/spec/devise/vero/sender_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Devise::Vero::Sender do
+  context 'initializing' do
+    it 'populate the token attribute with the first arg' do
+      instance = described_class.new(:test, nil, 2, 3, 4)
+      expect(instance.token).to eq(2)
+    end
+  end
+
+  describe '#deliver' do
+    let(:instance) { (Class.new).new }
+    let(:token) { SecureRandom.hex }
+    let(:notification) { :confirmation_instructions }
+
+    subject { described_class.new(:confirmation_instructions, instance, token) }
+
+    it 'calls the track method' do
+      allow(instance).to receive(:track!)
+      subject.deliver
+      expect(instance).to have_received(:track!)
+        .with(notification, token: token, data: [token])
+    end
+  end
+end

data/spec/devise/vero_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Devise::Vero do
+  context '.config' do
+    it 'sets the accessor for an attribute' do
+      described_class.config do |c|
+        c.disabled = false
+      end
+
+      expect(described_class.disabled).to be_falsy
+    end
+  end
+
+  context '.disabled' do
+    it 'is false by default' do
+      expect(described_class.disabled).to be_falsy
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'rails/all'
+require 'devise'
+require 'devise/vero'
+
+require 'securerandom'

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: devise-vero
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Estevão Mascarenhas
+- Vinicius Negrisolo
+- Shane O'Grady
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: vero
+  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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: Replace Devise transactional emails with Vero events.
+email:
+- estevao.am@gmail.com
+- vinicius.negrisolo@gmail.com
+- shane@ogrady.ie
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- devise-vero.gemspec
+- lib/devise/vero.rb
+- lib/devise/vero/model.rb
+- lib/devise/vero/sender.rb
+- lib/devise/vero/version.rb
+- lib/devise_vero.rb
+- lib/generators/devise/vero/install_generator.rb
+- lib/generators/devise/vero/templates/devise_vero.rb
+- spec/devise/vero/model_spec.rb
+- spec/devise/vero/sender_spec.rb
+- spec/devise/vero_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/LoveMondays/devise-vero
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Replace Devise transactional emails with Vero events.
+test_files:
+- spec/devise/vero/model_spec.rb
+- spec/devise/vero/sender_spec.rb
+- spec/devise/vero_spec.rb
+- spec/spec_helper.rb