pushpop-twilio 0.1.0

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 'twilio-ruby'
+
+group :development, :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'mail'
+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,60 @@
+## pushpop-twilio
+
+Twilio plugin for [Pushpop](https://github.com/pushpop-project/pushpop).
+
+### Installation
+
+Add `pushpop-twilio` to your Gemfile:
+
+``` ruby
+gem 'pushpop-twilio'
+```
+
+or install it as a gem:
+
+``` shell
+$ gem install pushpop-twilio
+```
+
+### Usage
+
+The `twilio` plugin provides a DSL to specify SMS recipient information as well as the message itself.
+
+Here's an example:
+
+``` ruby
+job 'send a text' do
+
+  twilio do
+    to    '+18005555555'
+    body  'Quick, move your car!'
+  end
+
+end
+```
+
+The `twilio` plugin requires that the following environment variables are set:
+
++ `TWILIO_AUTH_TOKEN`
++ `TWILIO_SID`
++ `TWILIO_FROM`
+
+##### Non-DSL Methods
+
+If you need a lower level interface to Twilio functionality, use the `send_message` method exposed by the plugin directly. Here's an example:
+
+``` ruby
+job 'send a few texts' do
+
+  twilio do
+    ['+18005555555','+18005555556'].each do |to_number|
+      send_message(to_number, 'Quick, move your car!')
+    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-twilio.rb

@@ -0,0 +1,61 @@
+require 'pushpop'
+require 'twilio-ruby'
+
+TWILIO_SID = ENV['TWILIO_SID']
+TWILIO_AUTH_TOKEN = ENV['TWILIO_AUTH_TOKEN']
+TWILIO_FROM = ENV['TWILIO_FROM']
+
+module Pushpop
+
+  class Twilio < Step
+
+    PLUGIN_NAME = 'twilio'
+
+    Pushpop::Job.register_plugin(Twilio::PLUGIN_NAME, Twilio)
+
+    attr_accessor :_from
+    attr_accessor :_to
+    attr_accessor :_body
+
+    def run(last_response=nil, step_responses=nil)
+
+      self.configure(last_response, step_responses)
+
+      _to = self._to
+      _from = self._from || TWILIO_FROM
+      _body = self._body
+
+      if _to && _from && _body
+        send_message(_to, _from, _body)
+      else
+        raise 'Please configure to, from, and body to send an SMS'
+      end
+    end
+
+    def send_message(to, from, body)
+      client = ::Twilio::REST::Client.new(TWILIO_SID, TWILIO_AUTH_TOKEN)
+      client.account.messages.create(
+          from: from,
+          to: to,
+          body: body )
+    end
+
+    def from(from)
+      self._from = from
+    end
+
+    def to(to)
+      self._to = to
+    end
+
+    def body(body)
+      self._body = body
+    end
+
+    def configure(last_response=nil, step_responses=nil)
+      self.instance_exec(last_response, step_responses, &block)
+    end
+
+  end
+
+end

data/lib/pushpop-twilio/version.rb

@@ -0,0 +1,5 @@
+module Pushpop
+  class Twilio
+    VERSION = '0.1.0'
+  end
+end

data/pushpop-twilio.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'pushpop-twilio/version'
+
+Gem::Specification.new do |s|
+
+  s.name        = "pushpop-twilio"
+  s.version     = Pushpop::Twilio::VERSION
+  s.authors     = ["Josh Dzielak"]
+  s.email       = "josh@keen.io"
+  s.homepage    = "https://github.com/pushpop-project/pushpop-twilio"
+  s.summary     = "Twilio plugin for sending SMS messages from Pushpop"
+
+  s.add_dependency "pushpop"
+  s.add_dependency "twilio-ruby"
+
+  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-twilio_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe Pushpop::Twilio do
+
+  describe '#configure' do
+
+    it 'should set various params' do
+
+      step = Pushpop::Twilio.new do
+        to '+18555555555'
+        from '+18555555556'
+        body 'use code 3:16 for high leniency'
+      end
+
+      step.configure
+
+      step._to.should == '+18555555555'
+      step._from.should == '+18555555556'
+      step._body.should == 'use code 3:16 for high leniency'
+
+    end
+
+  end
+
+  describe '#run' do
+
+    it 'should send a message' do
+
+      step = Pushpop::Twilio.new do |response|
+        to '+18555555555'
+        from '+18555555556'
+        body "The response is #{response}"
+      end
+      step.configure
+      step.stub(:send_message).with('+18555555555', '+18555555556', 'The response is 365').and_return(5)
+      step.run(365).should == 5
+
+    end
+
+    it 'should not send a message if body not specified' do
+      step = Pushpop::Twilio.new do
+        to '+18555555555'
+        from '+18555555556'
+      end
+      step.configure
+      step.stub(:send_message).and_return(5)
+      expect {
+        step.run(365)
+      }.to raise_error /Please configure/
+    end
+
+    it 'should not send a message if to not specified' do
+      step = Pushpop::Twilio.new do |response|
+        from '+18555555556'
+        body "The response is #{response}"
+      end
+      step.configure
+      step.stub(:send_message).and_return(5)
+      expect {
+        step.run(365)
+      }.to raise_error /Please configure/
+
+    end
+
+    it 'should not send a message if from not specified' do
+      step = Pushpop::Twilio.new do |response|
+        to '+18555555556'
+        body "The response is #{response}"
+      end
+      step.configure
+      step.stub(:send_message).and_return(5)
+      expect {
+        step.run(365)
+      }.to raise_error /Please configure/
+    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-twilio'
+
+RSpec.configure do |config|
+  config.before :each do
+    Pushpop.jobs.clear
+  end
+end
+

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: pushpop-twilio
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  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: twilio-ruby
+  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-twilio.rb
+- lib/pushpop-twilio/version.rb
+- pushpop-twilio.gemspec
+- spec/pushpop-twilio_spec.rb
+- spec/spec.html.erb
+- spec/spec_helper.rb
+homepage: https://github.com/pushpop-project/pushpop-twilio
+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: Twilio plugin for sending SMS messages from Pushpop
+test_files:
+- spec/pushpop-twilio_spec.rb
+- spec/spec.html.erb
+- spec/spec_helper.rb