pushpop-sendgrid 0.1.1

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+bundler_args: --without development
+
+rvm:
+  - 2.1.1
+
+script:
+  - bundle exec rake spec

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'pushpop'
+gem 'mail'
+
+group :development, :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'twilio-ruby'
+end

data/Gemfile.lock

@@ -0,0 +1,59 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.1)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    builder (3.2.2)
+    clockwork (0.7.5)
+      activesupport
+      tzinfo
+    diff-lcs (1.2.5)
+    i18n (0.6.9)
+    json (1.8.1)
+    jwt (1.0.0)
+    keen (0.8.2)
+      addressable (~> 2.3.5)
+      multi_json (~> 1.3)
+    mail (2.6.1)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.3)
+    minitest (5.3.4)
+    multi_json (1.10.1)
+    pushpop (0.1.0)
+      clockwork
+      keen
+    rake (10.3.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.1)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.1)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.0)
+    thread_safe (0.3.4)
+    twilio-ruby (3.11.5)
+      builder (>= 2.1.2)
+      jwt (>= 0.1.2)
+      multi_json (>= 1.3.0)
+    tzinfo (1.2.1)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mail
+  pushpop
+  rake
+  rspec
+  twilio-ruby

data/LICENSE

@@ -0,0 +1,21 @@
+Author Josh Dzielak
+Copyright (c) 2014 Keen Labs
+
+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,79 @@
+## pushpop-sendgrid
+
+Sendgrid plugin for [Pushpop](https://github.com/keenlabs/pushpop).
+
+### Installation
+
+Add `pushpop-sendgrid` to your Gemfile:
+
+``` ruby
+gem 'pushpop-sendgrid'
+```
+
+or install it as a gem:
+
+``` shell
+$ gem install pushpop-sendgrid
+```
+
+### Usage
+
+The `sendgrid` plugin gives you a DSL to specify typical email parameters.
+
+Here's an example:
+
+``` ruby
+job 'send an email' do
+
+  sendgrid do
+    to          'josh+pushpop@keen.io'
+    from        'pushpopapp+123@keen.io'
+    subject     'Is your inbox lonely?'
+    attachment  '/funny_images/sad_inbox.jpeg'
+    body        'This email was intentionally left blank.'
+    preview     false
+  end
+
+end
+```
+The `to`, `from`, and `subject` methods should be self-explanatory. All expect strings.
+
+The `body` method can take a string, or it can take the same parameters as the `template` method provided by the base step class. This example will use the rendered template contents as the body:
+
+``` ruby
+body 'pingpong_report.html.erb', response, step_responses
+```
+
+The `attachment` method is optional and takes a path to a file to be attached.
+
+The `preview` setting is optional and defaults to false. If you set it to true the email contents will print out
+to the console but the email will not be sent.
+
+The `sendgrid` plugin requires that the following environment variables are set: 
+
++ `SENDGRID_DOMAIN`
++ `SENDGRID_USERNAME`
++ `SENDGRID_PASSWORD`
+
+##### Non-DSL methods
+
+Need to send multiple emails in one step? Need more control over email sending? The DSL approach won't be sufficient for you.
+Instead, use the `send_email` method exposed by the plugin directly. Here's an example:
+
+``` ruby
+job 'send multiple emails' do
+
+  step 'send some emails' do
+
+    ['josh+1@keen.io', 'justin+1@keen.io'].each do |to_address|
+      send_email to_address, 'pushpop-app@keen.io', 'Nice subject', 'Nice body'
+    end
+
+  end
+
+end
+```
+
+### Contributing
+
+Code and documentation issues and pull requests are welcome.

data/Rakefile

@@ -0,0 +1,16 @@
+$stdout.sync = true
+
+$: << File.join(File.dirname(__FILE__), './lib')
+
+begin
+  require 'rspec/core/rake_task'
+  desc 'Run Rspec unit tests'
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = 'spec/**/*_spec.rb'
+  end
+
+  task default: :spec
+rescue LoadError
+end
+
+

data/lib/pushpop-sendgrid.rb

@@ -0,0 +1,108 @@
+require 'pushpop'
+require 'mail'
+
+Mail.defaults do
+  delivery_method :smtp, { address:   'smtp.sendgrid.net',
+                           port:      587,
+                           domain:    ENV['SENDGRID_DOMAIN'],
+                           user_name: ENV['SENDGRID_USERNAME'],
+                           password:  ENV['SENDGRID_PASSWORD'],
+                           authentication: 'plain',
+                           enable_starttls_auto: true }
+end
+
+module Pushpop
+
+  class Sendgrid < Step
+
+    PLUGIN_NAME = 'sendgrid'
+
+    Pushpop::Job.register_plugin(Sendgrid::PLUGIN_NAME, Sendgrid)
+
+    attr_accessor :_from
+    attr_accessor :_to
+    attr_accessor :_subject
+    attr_accessor :_body
+    attr_accessor :_preview
+    attr_accessor :_attachment 
+
+    def run(last_response=nil, step_responses=nil)
+
+      self.configure(last_response, step_responses)
+
+      # print the message if its just a preview
+      return print_preview if self._preview
+
+      _to = self._to
+      _from = self._from
+      _subject = self._subject
+      _body = self._body
+      _attachment = self._attachment
+
+      if _to && _from && _subject && _body
+        send_email(_to, _from, _subject, _body, _attachment)
+      end
+    end
+
+    def send_email(_to, _from, _subject, _body, _attachment)
+      Mail.deliver do
+        to _to
+        from _from
+        subject _subject
+        add_file _attachment if _attachment
+        text_part do
+          body _body
+        end
+        html_part do
+          content_type 'text/html; charset=UTF-8'
+          body _body
+        end
+      end
+    end
+
+    def configure(last_response=nil, step_responses=nil)
+      self.instance_exec(last_response, step_responses, &block)
+    end
+
+    def from(from)
+      self._from = from
+    end
+
+    def to(to)
+      self._to = to
+    end
+
+    def subject(subject)
+      self._subject = subject
+    end
+
+    def preview(preview)
+      self._preview = preview
+    end
+
+    def body(*args)
+      if args.length == 1
+        self._body = args.first
+      else
+        self._body = template(*args)
+      end
+    end
+
+    def attachment(_attachment)
+      self._attachment = _attachment
+    end
+
+    private
+
+    def print_preview
+      puts <<MESSAGE
+To: #{self._to}
+From: #{self._from}
+Subject: #{self._subject}
+
+      #{self._body}
+MESSAGE
+    end
+
+  end
+end

data/lib/pushpop-sendgrid/version.rb

@@ -0,0 +1,5 @@
+module Pushpop
+  class Sendgrid
+    VERSION = '0.1.1'
+  end
+end

data/pushpop-sendgrid.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'pushpop-sendgrid/version'
+
+Gem::Specification.new do |s|
+
+  s.name        = "pushpop-sendgrid"
+  s.version     = Pushpop::Sendgrid::VERSION
+  s.authors     = ["Josh Dzielak"]
+  s.email       = "josh@keen.io"
+  s.homepage    = "https://github.com/pushpop-project/pushpop-sendgrid"
+  s.summary     = "Sendgrid plugin for sending emails with Pushpop"
+
+  s.add_dependency "pushpop"
+  s.add_dependency "mail"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end
+

data/spec/pushpop-sendgrid_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+SPEC_TEMPLATES_DIRECTORY ||= File.expand_path('../', __FILE__)
+
+describe Pushpop::Sendgrid do
+
+  describe '#configure' do
+
+    it 'should set various params' do
+
+      step = Pushpop::Sendgrid.new do
+        to 'josh@keen.io'
+        from 'depths@hell.com'
+        subject 'time is up'
+        body 'use code 3:16 for high leniency'
+        preview true
+      end
+
+      step.configure
+
+      step._to.should == 'josh@keen.io'
+      step._from.should == 'depths@hell.com'
+      step._subject.should == 'time is up'
+      step._body.should == 'use code 3:16 for high leniency'
+      step._preview.should == true
+
+    end
+
+  end
+
+  describe '#run' do
+
+    it 'should send some email' do
+
+      Mail.stub(:deliver)
+
+      step = Pushpop::Sendgrid.new do |response|
+        to 'josh@keen.io'
+        from 'alerts+pushpop@keen.io'
+        subject "There were #{response} Pageviews Today!"
+        body 'hey wats up'
+      end
+
+      step.run(365)
+
+    end
+
+    it 'should not sent email if nothing is configured' do
+      Mail.stub(:deliver).never
+      step = Pushpop::Sendgrid.new do end
+      step.run(365)
+    end
+
+  end
+
+  describe '#body' do
+
+    it 'should use a string if given 1 arg' do
+      step = Pushpop::Sendgrid.new
+      step.body 'hello world'
+      step._body.should == 'hello world'
+    end
+
+    it 'should use a template if more than 1 arg is passed' do
+      step = Pushpop::Sendgrid.new
+      step.body('spec.html.erb', 500, {}, SPEC_TEMPLATES_DIRECTORY)
+      step._body.strip.should == '<pre>500</pre>'
+    end
+
+  end
+
+  describe '#attachment' do
+
+    it 'should attach a file to an email' do
+      step = Pushpop::Sendgrid.new
+      step.attachment 'huzzah.txt'
+      step._attachment.should == 'huzzah.txt'
+    end
+
+  end
+
+end

data/spec/spec.html.erb

@@ -0,0 +1,6 @@
+<% if response %>
+<pre><%= response %></pre>
+<% else %>
+<pre><%= step_responses[:test] %></pre>
+<% end %>
+

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$: << File.join(File.dirname(__FILE__), '../lib')
+
+require 'pushpop'
+require 'pushpop-sendgrid'
+
+RSpec.configure do |config|
+  config.before :each do
+    Pushpop.jobs.clear
+  end
+end
+

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: pushpop-sendgrid
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Josh Dzielak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pushpop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: josh@keen.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/pushpop-sendgrid.rb
+- lib/pushpop-sendgrid/version.rb
+- pushpop-sendgrid.gemspec
+- spec/pushpop-sendgrid_spec.rb
+- spec/spec.html.erb
+- spec/spec_helper.rb
+homepage: https://github.com/pushpop-project/pushpop-sendgrid
+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.23
+signing_key: 
+specification_version: 3
+summary: Sendgrid plugin for sending emails with Pushpop
+test_files:
+- spec/pushpop-sendgrid_spec.rb
+- spec/spec.html.erb
+- spec/spec_helper.rb