tropo_message 0.0.4 → 0.0.5

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/lib/tropo_message.rb

@@ -8,94 +8,164 @@ module Tropo
       @tropo_session = tropo_session
     end
 
-    def parse(tropo_session)
-      self.tropo_session = tropo_session
+    # Interesting methods
+
+    # Determines whether a message is meant for sending by checking
+    # if it has session parameters. This is useful for example if you have the same
+    # handler url for incoming and outgoing messages
+    #
+    # Example:
+    #   tropo_object = Tropo::Generator.parse(raw_json)
+    #   tropo_message = Tropo::Message.new(tropo_object)
+    #   tropo_message.outgoing?
+    #
+    def outgoing?
+      tropo_session["session"] && tropo_session["session"]["parameters"]
     end
 
-    def token
-      params["token"] || tropo_parameters["token"]
+    # An alternative to the constructor
+    #
+    # Example:
+    #   tropo_object = Tropo::Generator.parse(raw_json)
+    #   tropo_message = Tropo::Message.new
+    #   tropo_message.parse(tropo_object)
+    #
+    def parse(tropo_session)
+      self.tropo_session = tropo_session
     end
 
-    def token=(value)
-      params["token"] = value
+    # Generates xml suitable for an XML POST request to Tropo
+    #
+    # Example:
+    #   tropo_message = Tropo::Message.new
+    #   tropo_message.to = "44122782474"
+    #   tropo_message.text = "Hi John, how r u today?"
+    #   tropo_message.token = "1234512345"
+    #
+    #   tropo_message.request_xml # =>
+    #   # <sessions>
+    #   #   <token>1234512345</token>
+    #   #   <var name="to" value="44122782474"/>
+    #   #   <var name="text" value="Hi+John%2C+how+r+u+today%3F"/>
+    #   #  </sessions>"
+    #
+    def request_xml
+      request_params = @params.dup
+      token = request_params.delete("token")
+      xml = ""
+      request_params.each do |key, value|
+        xml << "<var name=\"#{escape(key)}\" value=\"#{escape(value)}\"/>"
+      end
+      "<sessions><token>#{token}</token>#{xml}</sessions>"
+    end
+
+    # Generates a hash suitable for using to as input to:
+    # Tropo::Generator#message (see: http://github.com/voxeo/tropo-webapi-ruby)
+    #
+    # By default, "channel" => "TEXT" and "network" => "SMS"
+    # You can override these values and any other optional parameters by setting
+    # their values e.g. tropo_message.channel = "VOICE"
+    #
+    # Example:
+    #   tropo_object = Tropo::Generator.parse(raw_json)
+    #
+    #   tropo_object # => {
+    #   #  "session" => {
+    #   #    ...
+    #   #    "parameters" => {
+    #   #      "to" => "44122782474",
+    #   #      "text" => "Hi+John%2C+how+r+u+today%3F",
+    #   #      "my_favourite_food" => "Pizza"
+    #   #    }
+    #   #  }
+    #   #}
+    #
+    #   tropo_message = Tropo::Message.new(tropo_object)
+    #   response_params = tropo_message.response_params # => {
+    #   #  "to" => "44122782474",
+    #   #  "channel" => "TEXT",
+    #   #  "network" => "SMS"
+    #   #}
+    #
+    #   text = tropo_message.text
+    #
+    #   Tropo::Generator.new.message(response_params) do
+    #     say :value => text
+    #   end
+    #
+    def response_params
+      params = {
+        "to" => to,
+        "channel" => channel,
+        "network" => network
+      }
+      params.merge!("from" => from) if from
+      params.merge!("timeout" => timeout) if timeout
+      params.merge!("answer_on_media" => answer_on_media) if answer_on_media
+      params.merge!("headers" => headers) if headers
+      params.merge!("recording" => recording) if recording
+      params
     end
 
-    def to
-      params["to"] || tropo_parameters["to"]
+    # Getter/Setter methods
+    def action
+      params["action"] || tropo_parameters["action"]
     end
 
-    def to=(value)
-      params["to"] = value
+    def answer_on_media
+      params["answer_on_media"] || tropo_parameters["answer_on_media"]
     end
 
     def channel
-      params["channel"] || tropo_parameters["channel"] || 'TEXT'
+      params["channel"] || tropo_parameters["channel"] || "TEXT"
     end
 
-    def network
-      params["network"] || tropo_parameters["network"] || 'SMS'
+    def from
+      params["from"] || tropo_parameters["from"]
     end
 
-    def text
-      params["text"] || tropo_parameters["msg"]
+    def from=(value)
+      params["from"] = value
     end
-    alias :msg :text
 
-    def text=(value)
-      params["text"] = value
+    def headers
+      params["headers"] || tropo_parameters["headers"]
     end
-    alias :msg= :text=
 
-    def from
-      params["from"] || tropo_parameters["from"]
+    def network
+      params["network"] || tropo_parameters["network"] || "SMS"
     end
 
-    def from=(value)
-      params["from"] = value
+    def recording
+      params["recording"] || tropo_parameters["recording"]
     end
 
-    def timeout
-      params["timeout"] || tropo_parameters["timeout"]
+    def text
+      params["text"] || tropo_parameters["text"]
     end
 
-    def answer_on_media
-      params["answer_on_media"] || tropo_parameters["answer_on_media"]
+    def text=(value)
+      params["text"] = value
     end
 
-    def headers
-      params["headers"] || tropo_parameters["headers"]
+    def timeout
+      params["timeout"] || tropo_parameters["timeout"]
     end
 
-    def recording
-      params["recording"] || tropo_parameters["recording"]
+    def to
+      params["to"] || tropo_parameters["to"]
     end
 
-    def outgoing?
-      tropo_session["session"] && tropo_session["session"]["parameters"]
+    def to=(value)
+      params["to"] = value
     end
 
-    def response_params
-      params = {
-        "to" => to,
-        "channel" => channel,
-        "network" => network
-      }
-      params.merge!("from" => from) if from
-      params.merge!("timeout" => timeout) if timeout
-      params.merge!("answer_on_media" => answer_on_media) if answer_on_media
-      params.merge!("headers" => headers) if headers
-      params.merge!("recording" => recording) if recording
-      params
+    def token
+      params["token"] || tropo_parameters["token"]
     end
 
-    def request_xml
-      request_params = @params.dup
-      token = request_params.delete("token")
-      xml = ""
-      request_params.each do |key, value|
-        xml << "<var name=\"#{key}\" value=\"#{value}\"/>"
-      end
-      "<sessions><token>#{token}</token>#{xml.to_s}</sessions>"
+    def token=(value)
+      params["token"] = value
     end
 
     private
@@ -104,6 +174,27 @@ module Tropo
         parameters = session["parameters"] if session
         parameters || {}
       end
+
+      # Performs URI escaping so that you can construct proper
+      # query strings faster. Use this rather than the cgi.rb
+      # version since it's faster. (Stolen from Camping).
+      def escape(s)
+        s.to_s.gsub(/([^ a-zA-Z0-9_.-]+)/n) {
+          '%'+$1.unpack('H2'*bytesize($1)).join('%').upcase
+        }.tr(' ', '+')
+      end
+
+      # Return the bytesize of String; uses String#length under Ruby 1.8 and
+      # String#bytesize under 1.9.
+      if ''.respond_to?(:bytesize)
+        def bytesize(string)
+          string.bytesize
+        end
+      else
+        def bytesize(string)
+          string.size
+        end
+      end
   end
 end
 

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'tropo_message'
+require 'rspec'
+require 'rspec/autorun'
+

data/spec/tropo_messsage_spec.rb

@@ -0,0 +1,361 @@
+require 'spec_helper'
+
+describe Tropo::Message do
+  let(:tropo_message) { Tropo::Message.new }
+  let(:tropo_session) {
+    {
+      "session" => {
+        "id"=>"703c4f12c46dd3a7ae07c95ee68f8b79",
+        "account_id"=>"12345",
+        "timestamp"=>Time.now,
+        "user_type"=>"NONE",
+        "initial_text"=>nil,
+        "call_id"=>nil,
+        "parameters"=>{
+          "token" => "123451234512345123451234512345123451234512345",
+          "text"=>"Hi%2C+how+r+u+today+%3A+my+friend+%3Cyour+name",
+          "to"=>"612382211234",
+          "from" => "661213433198",
+          "channel" => "SomeChannel",
+          "network" => "SomeNetwork",
+          "action" => "SomeAction",
+          "timeout" => "SomeTimeout",
+          "answer_on_media" => "Phone",
+          "headers" => "MyCustomHeaders",
+          "recording" => "MyRecording"
+        }
+      }
+    }
+  }
+
+  # Interesting methods
+  describe "#request_xml" do
+    it "should generate xml that includes all the message parameter keys and values" do
+      tropo_message.params = {"my_favourite_food" => "pho"}
+      tropo_message.request_xml.should include("my_favourite_food")
+      tropo_message.request_xml.should include("pho")
+    end
+    it "should generate xml that includes the session token" do
+      tropo_message.token = "23932349191932432"
+      tropo_message.request_xml.should include("token")
+      tropo_message.request_xml.should include("23932349191932432")
+    end
+    it "should escape all message parameters" do
+      tropo_message.text = "<hello/>+$#%"
+      tropo_message.request_xml.should include("%3Chello%2F%3E%2B%24%23%25")
+    end
+  end
+
+  describe "#parse" do
+    it "should set the @tropo_session instance variable" do
+      tropo_message.parse(tropo_session)
+      tropo_message.tropo_session.should == tropo_session
+    end
+  end
+
+  describe "#outgoing?" do
+    context "setting up a message for sending" do
+      it "should be false" do
+        tropo_message.should_not be_outgoing
+      end
+    end
+    context "responding to tropo" do
+      context "the session has a 'parameters' hash" do
+        it "should be true" do
+          tropo_message.parse(tropo_session)
+          tropo_message.should be_outgoing
+        end
+      end
+      context "the session does not have a 'parameters' hash" do
+        before do
+          tropo_session["session"].delete("parameters")
+        end
+        it "should be false" do
+          tropo_message.parse(tropo_session)
+          tropo_message.should_not be_outgoing
+        end
+      end
+    end
+  end
+
+  describe "#response_params" do
+    # see also: http://github.com/voxeo/tropo-webapi-ruby
+    context "the tropo session parameters include all the required and optional parameters for Tropo::Generator#message" do
+      it "should include all the required and optional parameters" do
+        tropo_message.parse(tropo_session)
+        tropo_message.response_params.should == {
+          "to" => "612382211234",
+          "channel" => "SomeChannel",
+          "network" => "SomeNetwork",
+          "from" => "661213433198",
+          "timeout" => "SomeTimeout",
+          "answer_on_media" => "Phone",
+          "headers" => "MyCustomHeaders",
+          "recording" => "MyRecording"
+        }
+      end
+    end
+    context "the tropo session parameters only includes 'to'" do
+      before do
+        parameters = tropo_session["session"].delete("parameters")
+        tropo_session["session"]["parameters"] = { "to" => parameters["to"] }
+      end
+      it "should include all the required parameters" do
+        tropo_message.parse(tropo_session)
+        tropo_message.response_params.should == {
+          "to" => "612382211234",
+          "channel" => "TEXT",
+          "network" => "SMS",
+        }
+      end
+    end
+  end
+
+  # Less interesting methods
+  # Methods with setters
+  describe "#token" do
+    context "setting up a message for sending" do
+      it "should set the token" do
+        tropo_message.token = "my token"
+        tropo_message.token.should == "my token"
+      end
+    end
+    context "responding to tropo" do
+      it "should return the token from the session parameters" do
+        tropo_message.parse(tropo_session)
+        tropo_message.token.should == "123451234512345123451234512345123451234512345"
+      end
+    end
+  end
+
+  describe "#to" do
+    context "setting up a message for sending" do
+      it "should set the receiver" do
+        tropo_message.to = "841232312342"
+        tropo_message.to.should == "841232312342"
+      end
+    end
+    context "responding to tropo" do
+      it "should return the receiver from the session parameters" do
+        tropo_message.parse(tropo_session)
+        tropo_message.to.should == "612382211234"
+      end
+    end
+  end
+
+  describe "#from" do
+    context "setting up a message for sending" do
+      it "should set the sender" do
+        tropo_message.from = "1331485573"
+        tropo_message.from.should == "1331485573"
+      end
+    end
+    context "responding to tropo" do
+      it "should return the sender from the session parameters" do
+        tropo_message.parse(tropo_session)
+        tropo_message.from.should == "661213433198"
+      end
+    end
+  end
+
+  describe "#text" do
+    context "setting up a message for sending" do
+      it "should set the text" do
+        tropo_message.text = "hello johnny (whats happening?)"
+        tropo_message.text.should == "hello johnny (whats happening?)"
+      end
+    end
+    context "responding to tropo" do
+      it "should return the text from the session parameters" do
+        tropo_message.parse(tropo_session)
+        tropo_message.text.should == "Hi%2C+how+r+u+today+%3A+my+friend+%3Cyour+name"
+      end
+    end
+  end
+
+  # Methods without setters
+  # Methods with default return values
+  describe "#channel" do
+    context "setting up a message for sending" do
+      it "should set the channel" do
+        tropo_message.params = {"channel" => "Channel 8"}
+        tropo_message.channel.should == "Channel 8"
+      end
+    end
+    context "responding to tropo" do
+      context "'channel' is in the session parameters" do
+        it "should return the channel from the session parameters" do
+          tropo_message.parse(tropo_session)
+          tropo_message.channel.should == "SomeChannel"
+        end
+      end
+      context "'channel' is not in the session parameters" do
+        before do
+          tropo_session["session"]["parameters"].delete("channel")
+        end
+        it "should return 'TEXT'" do
+          tropo_message.parse(tropo_session)
+          tropo_message.channel.should == "TEXT"
+        end
+      end
+    end
+  end
+
+  describe "#network" do
+    context "setting up a message for sending" do
+      it "should set the network" do
+        tropo_message.params = {"network" => "Network 10"}
+        tropo_message.network.should == "Network 10"
+      end
+    end
+    context "responding to tropo" do
+      context "'network' is in the session parameters" do
+        it "should return the network from the session parameters" do
+          tropo_message.parse(tropo_session)
+          tropo_message.network.should == "SomeNetwork"
+        end
+      end
+      context "'network' is not in the session parameters" do
+        before do
+          tropo_session["session"]["parameters"].delete("network")
+        end
+        it "should return 'SMS'" do
+          tropo_message.parse(tropo_session)
+          tropo_message.network.should == "SMS"
+        end
+      end
+    end
+  end
+
+  # Methods without default return values
+  describe "#action" do
+    context "setting up a message for sending" do
+      it "should set the action" do
+        tropo_message.params = {"action" => "my action"}
+        tropo_message.action.should == "my action"
+      end
+    end
+    context "responding to tropo" do
+      context "'action' is in the session parameters" do
+        it "should return the action from the session parameters" do
+          tropo_message.parse(tropo_session)
+          tropo_message.action.should == "SomeAction"
+        end
+      end
+      context "'action' is not in the session parameters" do
+        before do
+          tropo_session["session"]["parameters"].delete("action")
+        end
+        it "should return nil" do
+          tropo_message.parse(tropo_session)
+          tropo_message.action.should be_nil
+        end
+      end
+    end
+  end
+
+  describe "#timeout" do
+    context "setting up a message for sending" do
+      it "should set the timeout" do
+        tropo_message.params = {"timeout" => "5 seconds"}
+        tropo_message.timeout.should == "5 seconds"
+      end
+    end
+    context "responding to tropo" do
+      context "'timeout' is in the session parameters" do
+        it "should return the timeout from the session parameters" do
+          tropo_message.parse(tropo_session)
+          tropo_message.timeout.should == "SomeTimeout"
+        end
+      end
+      context "'timeout' is not in the session parameters" do
+        before do
+          tropo_session["session"]["parameters"].delete("timeout")
+        end
+        it "should return nil" do
+          tropo_message.parse(tropo_session)
+          tropo_message.timeout.should be_nil
+        end
+      end
+    end
+  end
+
+  describe "#answer_on_media" do
+    context "setting up a message for sending" do
+      it "should set answer_on_media" do
+        tropo_message.params = {"answer_on_media" => "yes"}
+        tropo_message.answer_on_media.should == "yes"
+      end
+    end
+    context "responding to tropo" do
+      context "'answer_on_media' is in the session parameters" do
+        it "should return 'answer_on_media' from the session parameters" do
+          tropo_message.parse(tropo_session)
+          tropo_message.answer_on_media.should == "Phone"
+        end
+      end
+      context "'answer_on_media' is not in the session parameters" do
+        before do
+          tropo_session["session"]["parameters"].delete("answer_on_media")
+        end
+        it "should return nil" do
+          tropo_message.parse(tropo_session)
+          tropo_message.answer_on_media.should be_nil
+        end
+      end
+    end
+  end
+
+  describe "#headers" do
+    context "setting up a message for sending" do
+      it "should set the headers" do
+        tropo_message.params = {"headers" => "some custom headers"}
+        tropo_message.headers.should == "some custom headers"
+      end
+    end
+    context "responding to tropo" do
+      context "'headers' is in the session parameters" do
+        it "should return the headers from the session parameters" do
+          tropo_message.parse(tropo_session)
+          tropo_message.headers.should == "MyCustomHeaders"
+        end
+      end
+      context "'headers' is not in the session parameters" do
+        before do
+          tropo_session["session"]["parameters"].delete("headers")
+        end
+        it "should return nil" do
+          tropo_message.parse(tropo_session)
+          tropo_message.headers.should be_nil
+        end
+      end
+    end
+  end
+
+  describe "#recording" do
+    context "setting up a message for sending" do
+      it "should set the recording" do
+        tropo_message.params = {"recording" => "my recording"}
+        tropo_message.recording.should == "my recording"
+      end
+    end
+    context "responding to tropo" do
+      context "'recording' is in the session parameters" do
+        it "should return the recording from the session parameters" do
+          tropo_message.parse(tropo_session)
+          tropo_message.recording.should == "MyRecording"
+        end
+      end
+      context "'recording' is not in the session parameters" do
+        before do
+          tropo_session["session"]["parameters"].delete("recording")
+        end
+        it "should return nil" do
+          tropo_message.parse(tropo_session)
+          tropo_message.recording.should be_nil
+        end
+      end
+    end
+  end
+end
+

data/tropo_message.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tropo_message}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Wilkie"]
-  s.date = %q{2010-10-14}
+  s.date = %q{2010-10-15}
   s.description = %q{A tiny wrapper for creating a Tropo message}
   s.email = %q{dwilkie@gmail.com}
   s.extra_rdoc_files = [
@@ -24,6 +24,8 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "lib/tropo_message.rb",
+     "spec/spec_helper.rb",
+     "spec/tropo_messsage_spec.rb",
      "tropo_message.gemspec"
   ]
   s.homepage = %q{http://github.com/dwilkie/tropo_message}
@@ -31,6 +33,10 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{A tiny wrapper for creating a Tropo message}
+  s.test_files = [
+    "spec/tropo_messsage_spec.rb",
+     "spec/spec_helper.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - David Wilkie
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-14 00:00:00 +07:00
+date: 2010-10-15 00:00:00 +07:00
 default_executable: 
 dependencies: []
 
@@ -35,6 +35,8 @@ files:
 - Rakefile
 - VERSION
 - lib/tropo_message.rb
+- spec/spec_helper.rb
+- spec/tropo_messsage_spec.rb
 - tropo_message.gemspec
 has_rdoc: true
 homepage: http://github.com/dwilkie/tropo_message
@@ -68,5 +70,6 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A tiny wrapper for creating a Tropo message
-test_files: []
-
+test_files: 
+- spec/tropo_messsage_spec.rb
+- spec/spec_helper.rb