sms-spec 0.0.9

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in text_spec.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :cli => "--color", :notification => true do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.markdown

@@ -0,0 +1,55 @@
+# SMS Spec
+
+An RSpec DSL and Cucumber steps to test SMS interactions with your
+Ruby on Rails application.
+
+Currently this gem only supports testing SMS messageing using the
+[twilio-ruby](https://github.com/twilio/twilio-ruby) gem.
+
+##Setup
+Add the sms\_spec gem to your Gemfile:
+<pre>
+group :test do
+  gem 'sms_spec'
+end
+</pre>
+
+## RSpec
+In your spec\_helper.rb file add the following:
+<pre>
+require 'sms_spec'
+</pre>
+
+If you want to have the helpers available in all of your example groups,
+you can add the following to your spec_helper.rb:
+<pre>
+Spec::Runner.configure do |config|
+  config.include(SmsSpec::Helpers)
+  config.include(SmsSpec::Matchers)
+end
+</pre>
+
+Otherwise you will have to incliude the helpers and matchers in any
+example where you use them:
+
+<pre>
+describe "MyController" do
+  include SmsSpec::Helpers
+  include SmsSpec::Matchers
+end
+</pre>
+
+## Cucumber
+Add the folloing to you env.rb file:
+
+<pre>
+require 'sms_spec'
+require 'sms_spec/cucumber'
+</pre>
+
+This loads the sms\_spec RSpec helpers into your cucumber wold. Then,
+run the following to generate the text\_messsage\_steps.rb file:
+
+<pre>
+rails generate sms_spec:steps
+</pre>

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/generators/text_spec/steps/USAGE

@@ -0,0 +1,6 @@
+Description:
+    Creates text_message_steps.rb in your cucumber step_definitions.
+    
+Examples:
+    `script/rails generate text_spec:steps`
+

data/lib/generators/text_spec/steps/steps_generator.rb

@@ -0,0 +1,14 @@
+require 'rails/generators'
+
+module SmsSpec
+  class StepsGenerator < Rails::Generators::Base
+    def generate
+      copy_file 'text_message_steps.rb', 'features/step_definitions/text_message_steps.rb'
+    end
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates')
+    end
+  end
+end
+

data/lib/generators/text_spec/steps/templates/text_message_steps.rb

@@ -0,0 +1,44 @@
+# -------------------------------------------
+# Available methods
+# -------------------------------------------
+
+# messages
+# add_message
+# set_current_number
+# current_number
+# clear_messages
+# current_text_message
+# open_last_text_message_for
+
+
+Given /^no text messages have been sent$/ do
+  clear_messages
+end
+
+Given /^all text messages have been read$/ do
+  clear_messages
+end
+
+Then /^"([^"]*)" should receive a text message$/ do |phone_number|
+  messages_for(phone_number).should_not be_empty
+end
+
+Then /^"([^"]*)" should receive no text messages$/ do |phone_number|
+  messages_for(phone_number).should be_empty
+end
+
+When /^"([^"]*?)" opens? the text message$/ do |mobile_number|
+  open_last_text_message_for(mobile_number)
+end
+
+Then /^I should see "([^"]*)" in the text message body$/ do |content|
+  current_text_message.should have_body(content)
+end
+
+Then /^I should see "([^"]*)" in the text message body$/ do |content|
+  current_text_message.should have_body(content)
+end
+
+Then /^I should see the following in the text message body:$/ do |content|
+  current_text_message.should have_body(content)
+end

data/lib/sms-spec.rb

@@ -0,0 +1 @@
+require 'sms_spec'

data/lib/sms_spec.rb

@@ -0,0 +1,17 @@
+require 'rspec'
+require "sms_spec/version"
+require "sms_spec/helpers"
+require "sms_spec/data"
+require "sms_spec/message"
+require "sms_spec/util"
+require "sms_spec/mobile_device"
+require "sms_spec/matchers"
+#require "sms_spec/drivers/twilio-ruby"
+
+module SmsSpec
+  def self.driver=(driver_sym)
+    require "sms_spec/drivers/#{driver_sym.to_s}"
+  end
+
+  SmsSpec.driver = :"twilio-ruby"
+end

data/lib/sms_spec/cucumber.rb

@@ -0,0 +1,6 @@
+After do
+  SmsSpec::Data.clear_messages
+end
+
+World(SmsSpec::Helpers)
+World(SmsSpec::Matchers)

data/lib/sms_spec/data.rb

@@ -0,0 +1,43 @@
+require 'sms_spec/util'
+
+module SmsSpec
+  class Data
+    extend SmsSpec::Util
+
+    def self.add_message message
+      @@messages ||= []
+      @@messages << message
+    end
+
+    def self.clear_messages
+      @@messages = []
+      @@current_text_message = nil
+    end
+
+    def self.messages
+      @@messages ||= []
+    end
+
+    def self.set_current_number(number)
+      @@current_number = sanitize number
+    end
+
+    def self.current_number
+      @@current_number
+    end
+
+    def self.current_text_message
+      @@current_text_message ||= nil
+    end
+
+    def self.open_last_text_message_for(phone_number)
+      message = messages_for(phone_number).first
+      @@current_text_message = @@messages.delete(message)
+    end
+
+    def self.messages_for(phone_number)
+      @@messages.select {|m| m.number == sanitize(phone_number)}
+    end
+
+  end
+end

data/lib/sms_spec/drivers/twilio-ruby.rb

@@ -0,0 +1,31 @@
+class Twilio::REST::Client
+
+  def initialize(account_sid, auth_token)
+  end
+
+  class Messages
+    include SmsSpec::Helpers
+
+    def create(opts={})
+      to = opts[:to]
+      body = opts[:body]
+      add_message Message.new(:number => to, :body => body)
+    end
+  end
+
+  class Sms
+    def messages
+      return Messages.new
+    end
+  end
+
+  class Account
+    def sms
+      return Sms.new
+    end
+  end
+
+  def account
+    return Account.new
+  end
+end

data/lib/sms_spec/helpers.rb

@@ -0,0 +1,40 @@
+require 'forwardable'
+
+module SmsSpec
+  module Helpers
+    extend Forwardable
+    
+    def_delegators :"SmsSpec::Data", 
+      :messages,
+      :add_message,
+      :set_current_number,
+      :current_number,
+      :clear_messages,
+      :current_text_message,
+      :messages_for,
+      :open_last_text_message_for
+
+    def twiml_message(from, body, opts={})
+      base_options = {
+        "AccountSid"=>"1234567812345678",
+        "Body"=> body,
+        "ToZip"=>"94949",
+        "FromState"=>"MI",
+        "ToCity"=>"NOVATO",
+        "SmsSid"=>"1234567812345678",
+        "ToState"=>"CA",
+        "To"=>"8155552671",
+        "ToCountry"=>"US",
+        "FromCountry"=>"US",
+        "SmsMessageSid"=>"123456712345671234567",
+        "ApiVersion"=>"2008-08-01",
+        "FromCity"=>"GRAND RAPIDS",
+        "SmsStatus"=>"received",
+        "From"=> from,
+        "FromZip"=>"49507"
+      }
+
+      base_options.merge! opts
+    end
+  end
+end

data/lib/sms_spec/matchers.rb

@@ -0,0 +1,33 @@
+module SmsSpec
+  module Matchers
+
+    RSpec::Matchers.define :have_text_messages do
+      match do |mobile_device|
+        mobile_device.messages.count > 0
+      end
+
+      failure_message_for_should do |mobile_device|
+        "expected the mobile device '#{mobile_device.number}' to have text messages but it did not"
+      end
+
+      failure_message_for_should_not do |mobile_device|
+        "expected the mobile device '#{mobile_device.number}' to have no text messages but it did"
+      end
+    end
+
+    RSpec::Matchers.define :have_body do |expected_body|
+      match do |message|
+        message.body == expected_body
+      end
+
+      #failure_message_for_should do |mobile_device|
+        #"expected the mobile device '#{mobile_device.number}' to have text messages but it did not"
+      #end
+
+      #failure_message_for_should_not do |mobile_device|
+        #"expected the mobile device '#{mobile_device.number}' to have no text messages but it did"
+      #end
+    end
+
+  end
+end

data/lib/sms_spec/message.rb

@@ -0,0 +1,11 @@
+class Message
+  attr_accessor :number
+  attr_accessor :body
+
+  include SmsSpec::Util
+
+  def initialize(opts={})
+    @number = sanitize opts[:number]
+    @body = opts[:body]
+  end
+end

data/lib/sms_spec/mobile_device.rb

@@ -0,0 +1,10 @@
+class MobileDevice
+
+  def initialize(number)
+    @number = number
+  end
+
+  def messages
+    SmsSpec::Data.messages.select {|d| d.number == @number}
+  end
+end

data/lib/sms_spec/util.rb

@@ -0,0 +1,7 @@
+module SmsSpec
+  module Util
+    def sanitize number
+      number.gsub(/^\+*1/, "").gsub("-", "")
+    end
+  end
+end

data/lib/sms_spec/version.rb

@@ -0,0 +1,3 @@
+module SmsSpec
+  VERSION = "0.0.9"
+end

data/rails_generators/text_spec/templates/text_message_steps.rb

@@ -0,0 +1,36 @@
+# -------------------------------------------
+# Available methods
+# -------------------------------------------
+
+# messages
+# add_message
+# set_current_number
+# current_number
+# clear_messages
+# current_text_message
+# open_last_text_message_for
+
+
+Given /^no text messages have been sent$/ do
+  clear_messages
+end
+
+Given /^all text messages have been read$/ do
+  clear_messages
+end
+
+Then /^"([^"]*)" should receive a text message$/ do |phone_number|
+  messages_for(phone_number).should_not be_empty
+end
+
+Then /^"([^"]*)" should receive no text messages$/ do |phone_number|
+  messages_for(phone_number).should be_empty
+end
+
+When /^"([^"]*?)" opens? the text message$/ do |mobile_number|
+  open_last_text_message_for(mobile_number)
+end
+
+Then /^I should see "([^"]*)" in the text message body$/ do |content|
+  current_text_message.should have_body(content)
+end

data/rails_generators/text_spec_generator.rb

@@ -0,0 +1,14 @@
+base = defined?(Rails) ? Rails::Generator::Base : RubiGen::Base
+
+class SmsSpecGenerator < base
+  def manifest
+    m.directory 'features/step_definitions'
+    m.file 'text_message_steps.rb', 'features/step_definitions/text_message_steps.rb'
+  end
+
+  protected
+
+  def banner
+    "Usage: #{0} sms_spec"
+  end
+end

data/sms-spec.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sms_spec/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sms-spec"
+  s.version     = SmsSpec::VERSION
+  s.authors     = ["Chris Rittersdorf"]
+  s.email       = ["manlycode@gmail.com"]
+  s.homepage    = "https://github.com/mhs/sms_spec"
+  s.summary     = %q{Test SMS interactions with RSpec and Cucumber}
+  s.description = %q{Text Spec gives you an RSpec DSL and Cucumber steps to test SMS interactions.}
+
+  s.rubyforge_project = "sms_spec"
+
+  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"]
+
+  s.add_dependency 'rspec'
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "twilio-ruby"
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "pry"
+end

data/spec/drivers_spec.rb

@@ -0,0 +1,31 @@
+require 'twilio-ruby'
+require File.join(File.dirname(__FILE__), *%w[spec_helper])
+
+describe SmsSpec do
+  include SmsSpec::Helpers
+
+  before :each do
+    SmsSpec::Data.clear_messages
+  end
+
+  describe "the twilio-ruby driver" do
+    it "is assignable" do
+      SmsSpec.driver = :"twilio-ruby"
+    end
+
+    it "intercepts calls to twilio's sms client" do
+      account_sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+      auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
+
+      @client = Twilio::REST::Client.new account_sid, auth_token
+      @client.account.sms.messages.create(
+        :from => '+14159341234',
+        :to => '+16105557069',
+        :body => 'Hey there!'
+      )
+
+      open_last_text_message_for("+16105557069")
+      current_text_message.should_not be_nil
+    end
+  end
+end

data/spec/helpers_spec.rb

@@ -0,0 +1,124 @@
+require File.join(File.dirname(__FILE__), *%w[spec_helper])
+
+describe SmsSpec::Helpers do
+  include SmsSpec::Helpers
+
+  before :each do
+    SmsSpec::Data.clear_messages
+  end
+
+  describe ".messages" do
+    describe "before any messages have been sent" do
+      it "is empty" do
+        messages.should be_empty
+      end
+    end
+
+    describe "after a message has been sent" do
+      it "adds a message" do
+        lambda {
+          add_message Message.new :number => "5555555512", :body => "Hello there"
+        }.should change(messages, :count).by(1)
+      end
+    end
+  end
+
+  describe ".set_current_number" do
+    it "assigns the current number" do
+      set_current_number "555551234"
+      current_number.should == "555551234"
+    end
+
+    it "sanitizes phone nubmers" do
+      set_current_number "+1555551234"
+      current_number.should == "555551234"
+
+      set_current_number "1-616-555-2929"
+      current_number.should == "6165552929"
+    end
+  end
+
+  describe ".clear_sms_messages" do
+    it "removes all messages" do
+      add_message Message.new :number => "5555555512", :body => "Hello there"
+      add_message Message.new :number => "5555555512", :body => "Hello there"
+      add_message Message.new :number => "5555555512", :body => "Hello there"
+
+      messages.should have(3).messages
+    end
+  end
+
+  describe ".current_text_message" do
+    describe "when there are not text messages yet" do
+    before :each do
+      SmsSpec::Data.clear_messages
+    end
+
+      it "returns nil" do
+        current_text_message.should be_nil
+      end
+    end
+
+    describe "when there are messages" do
+      let(:message1) { Message.new :number => "5555555513", :body => "Hi" }
+      let(:message2) { Message.new :number => "5555555512", :body => "Hello there" }
+
+      before do
+        add_message message1
+        add_message message2
+      end 
+
+      describe "and no messages have been opened" do
+        it "should be nil" do
+          current_text_message.should be_nil
+        end
+      end
+
+      describe "and a message has been opened" do
+        before do
+          open_last_text_message_for("5555555513")
+        end
+
+        it "returns the last open text message" do
+          current_text_message.should == message1
+
+          open_last_text_message_for("5555555513")
+          current_text_message.should be_nil
+
+          open_last_text_message_for("5555555512")
+          current_text_message.should == message2
+        end
+      end
+    end
+  end
+
+  describe ".twiml_message" do
+    context "with defaults" do
+      let(:message) {
+        twiml_message("+16165559982", "Ahoy!")
+      }
+
+      it "modifies the From attribute" do
+        message["From"].should eql("+16165559982")
+      end
+
+      it "Modifies the Body attribute" do
+        message["Body"].should eql("Ahoy!")
+      end
+    end
+
+    describe "Overriding options" do
+      let(:message) {
+        twiml_message("+16165559982", "Ahoy!", "ToZip" => "49506", "ToCity" => "Detroit")
+      }
+
+      it "overrides the specified attributes" do
+        message["ToZip"].should eql("49506")
+        message["ToCity"].should eql("Detroit")
+        message["Body"].should eql("Ahoy!")
+        message["From"].should eql("+16165559982")
+      end
+    end
+  end
+
+end

data/spec/matchers_spec.rb

@@ -0,0 +1,70 @@
+require File.join(File.dirname(__FILE__), *%w[spec_helper])
+
+describe SmsSpec::Matchers do
+  include SmsSpec::Helpers
+  include SmsSpec::Matchers
+
+  let(:mobile_number) { "5555555512" }
+
+  class MatcherMatch
+    def initialize(object_to_test_match)
+      @object_to_test_match = object_to_test_match
+    end
+
+    def description
+      "match when provided #{@object_to_test_match.inspect}"
+    end
+
+    def matches?(matcher)
+      @matcher = matcher
+      matcher.matches?(@object_to_test_match)
+    end
+
+    def failure_message
+      "expected #{@matcher.inspect} to match when provided #{@object_to_test_match.inspect}, but it did not"
+    end
+
+    def negative_failure_message
+      "expected #{@matcher.inspect} not to match when provided #{@object_to_test_match.inspect}, but it did"
+    end
+  end
+
+  def match(object_to_test_match)
+    if object_to_test_match.is_a?(Regexp)
+      super # delegate to rspec's built in 'match' matcher
+    else
+      MatcherMatch.new(object_to_test_match)
+    end
+  end
+
+  describe ".have_text_messages" do
+    include SmsSpec::Matchers
+
+    describe "when the mobile device has no text messages" do
+      it "should not match" do
+        device = MobileDevice.new(:number => mobile_number)
+        have_text_messages.should_not match(device)
+      end
+    end
+
+    describe "when the mobile device has text messages" do
+      it "should match" do
+        add_message Message.new(:number => mobile_number, :body => "something")
+
+        device = MobileDevice.new(mobile_number)
+        have_text_messages.should match(device)
+      end
+    end
+  end
+
+  describe ".have_body" do
+    describe "when bodies match" do
+      it "matches" do
+        message = Message.new(:number => mobile_number, :body => "something")
+
+        have_body("something").should match(message)
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require File.join(File.dirname(__FILE__), *%w[.. lib sms-spec])
+
+require 'rubygems'
+require 'pry'

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: sms-spec
+version: !ruby/object:Gem::Version
+  version: 0.0.9
+  prerelease: 
+platform: ruby
+authors:
+- Chris Rittersdorf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2157261680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157261680
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2157260980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157260980
+- !ruby/object:Gem::Dependency
+  name: twilio-ruby
+  requirement: &2157260320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157260320
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &2157259700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157259700
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &2157259140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157259140
+description: Text Spec gives you an RSpec DSL and Cucumber steps to test SMS interactions.
+email:
+- manlycode@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- README.markdown
+- Rakefile
+- lib/generators/text_spec/steps/USAGE
+- lib/generators/text_spec/steps/steps_generator.rb
+- lib/generators/text_spec/steps/templates/text_message_steps.rb
+- lib/sms-spec.rb
+- lib/sms_spec.rb
+- lib/sms_spec/cucumber.rb
+- lib/sms_spec/data.rb
+- lib/sms_spec/drivers/twilio-ruby.rb
+- lib/sms_spec/helpers.rb
+- lib/sms_spec/matchers.rb
+- lib/sms_spec/message.rb
+- lib/sms_spec/mobile_device.rb
+- lib/sms_spec/util.rb
+- lib/sms_spec/version.rb
+- rails_generators/text_spec/templates/text_message_steps.rb
+- rails_generators/text_spec_generator.rb
+- sms-spec.gemspec
+- spec/drivers_spec.rb
+- spec/helpers_spec.rb
+- spec/matchers_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mhs/sms_spec
+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: sms_spec
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Test SMS interactions with RSpec and Cucumber
+test_files:
+- spec/drivers_spec.rb
+- spec/helpers_spec.rb
+- spec/matchers_spec.rb
+- spec/spec_helper.rb