tropo-webapi-ruby 0.1.8 → 0.1.9

data/HISTORY.rdoc

@@ -7,4 +7,13 @@
 == Version 0.1.6
 
 - Added the appropriate ActiveSupport dependency for 'instance_exec' for Ruby 1.8.6 support.
-- Added a dependency and support for Hashie.
+- Added a dependency and support for Hashie.
+
+== Version 0.1.9
+
+- Fixed the start_recording so it does not require a 'name' parameter
+- Aliased start_call_recording -> start_recording
+- Aliased stop_call_recording -> stop_recording
+- Fixes to the README
+- Fixed the yardoc install
+- The Tropo::Generator.parse method will now take a JSON string or a Ruby hash.

data/README.rdoc

@@ -30,7 +30,7 @@ Optional, if you would like to use with Sinatra:
 
 === Project Developer
 
-  $ sudo gem install yardoc
+  $ sudo gem install yard
 
 From within the project:
 
@@ -125,7 +125,7 @@ Using the great RESTful Web Services framework Sinatra for Ruby.
               on :event => 'hangup', :next => '/hangup.json'
               on :event => 'continue', :next => '/answer.json'
               ask({ :name    => 'account_number', 
-                    :bargein => 'true', 
+                    :bargein => true, 
                     :timeout => 30,
                     :require => 'true' }) do
                       say     :value => 'Please say your account number'
@@ -203,7 +203,7 @@ Using the great RESTful Web Services framework Sinatra for Ruby.
   post '/ask.json' do
     t = Tropo::Generator.new(:recognizer => 'fr-fr')
     t.ask({ :name    => 'account_number', # Will now use the French speech recognition engine
-            :bargein => 'true', 
+            :bargein => true, 
             :timeout => 30,
             :require => 'true' }) do
               say     :value => "S'il vous plaît dire votre numéro de compte", :voice => 'florence'
@@ -215,7 +215,7 @@ Using the great RESTful Web Services framework Sinatra for Ruby.
     t = Tropo::Generator.new
     t.recognizer = 'fr-fr'
     t.ask({ :name    => 'account_number', # Will now use the French speech recognition engine
-            :bargein => 'true', 
+            :bargein => true, 
             :timeout => 30,
             :require => 'true' }) do
               say     :value => "S'il vous plaît dire votre numéro de compte", :voice => 'florence'

data/VERSION

@@ -1 +1 @@
-0.1.8
+0.1.9

data/lib/tropo-webapi-ruby/object_patch.rb

@@ -0,0 +1,13 @@
+# Borrowed from here: http://eigenclass.org/hiki.rb?instance_exec
+class Object
+  def instance_exec(*args, &block)
+    mname = "__instance_exec_#{Thread.current.object_id.abs}"
+    class << self; self end.class_eval{ define_method(mname, &block) }
+    begin
+      ret = send(mname, *args)
+    ensure
+      class << self; self end.class_eval{ undef_method(mname) } rescue nil
+    end
+    ret
+  end
+end

data/lib/tropo-webapi-ruby/tropo-webapi-ruby-helpers.rb

@@ -27,7 +27,7 @@ module Tropo
         when 'record'
           has_params?(params, 'record', ['name', 'url'])
         when 'start_recording'
-          has_params?(params, 'start_recording', ['name', 'url'])
+          has_params?(params, 'start_recording', ['url'])
           
           # Camelcase this one to be Java friendly
           action = 'startRecording'

data/lib/tropo-webapi-ruby/tropo-webapi-ruby.rb

@@ -266,12 +266,14 @@ module Tropo
     end
 
     ##
-    # Parses the JSON string recieved from Tropo into a Ruby Hash
+    # Parses the JSON string recieved from Tropo into a Ruby Hash, or 
+    # if already a Ruby Hash parses it with the nicities provided by
+    # the gem
     #
-    # @param [String] a JSON string
-    # @return [Hash] a Hash representing the response from Tropo
-    def parse(json_string)
-      response = JSON.parse(json_string)
+    # @param [String or Hash] a JSON string or a Ruby Hash
+    # @return [Hash] a Hash representing the formatted response from Tropo
+    def parse(response)
+      response = JSON.parse(response) if response.class == String
 
       # Check to see what type of response we are working with
       if response['session']
@@ -473,7 +475,8 @@ module Tropo
       end
       render_response if @building.nil?
     end
-    
+    alias :start_call_recording :start_recording
+
     ##
     # Stops the recording of the current session after startCallRecording has been called
     #
@@ -483,6 +486,7 @@ module Tropo
       @response[:tropo] << { :stopRecording => nil }
       render_response if @building.nil?
     end
+    alias :stop_call_recording :stop_recording
     
     ##
     # Transfers an already answered call to another destination / phone number. 
@@ -531,6 +535,14 @@ module Tropo
       render_response if @building.nil?
     end
     
+    ##
+    # Returns the current hash object of the response, as opposed to JSON
+    #
+    # @return [Hash] the current hash of the response
+    def to_hash
+      @response
+    end
+    
     ##
     # Sets the default voice for the object
     #

data/spec/tropo-webapi-ruby_spec.rb

@@ -285,10 +285,20 @@ describe "Tropo" do
   
   # Start & Stop Recording actions tests
   it "should generate a JSON document with a 'start_recording' action" do
-    response = Tropo::Generator.start_recording(:name => 'recording', :url => 'http://postrecording.com/tropo')
-    JSON.parse(response).should == {"tropo"=>[{"startRecording"=>{"name"=>"recording", "url"=>"http://postrecording.com/tropo"}}]}
+    response = Tropo::Generator.start_recording(:url => 'http://postrecording.com/tropo')
+    JSON.parse(response).should == {"tropo"=>[{"startRecording"=>{"url"=>"http://postrecording.com/tropo"}}]}
   end
   
+  it "should generate a JSON document with a 'start_call_recording' action" do
+    response = Tropo::Generator.start_call_recording(:url => 'http://postrecording.com/tropo')
+    JSON.parse(response).should == {"tropo"=>[{"startRecording"=>{"url"=>"http://postrecording.com/tropo"}}]}
+  end
+
+  it "should generate a JSON document with a 'stopRecording' action" do
+    response = Tropo::Generator.stop_call_recording
+    JSON.parse(response).should == {"tropo"=>[{"stopRecording"=>nil}]}
+  end
+    
   it "should generate a JSON document with a 'stoprecording' action" do
     response = Tropo::Generator.stop_recording
     JSON.parse(response).should == {"tropo"=>[{"stopRecording"=>nil}]}
@@ -426,13 +436,13 @@ describe "Tropo" do
     t.on :event => 'hangup', :next => '/hangup.json' # When a user hangs or call is done. We will want to log some details.
     t.on :event => 'continue', :next => '/next.json'
     t.say "Hello"
-    t.start_recording(:name => 'recording', :url => "http://heroku-voip.marksilver.net/post_audio_to_s3?filename=foo.wav&unique_id=bar")
+    t.start_recording(:url => "http://heroku-voip.marksilver.net/post_audio_to_s3?filename=foo.wav&unique_id=bar")
     # [From this point, until stop_recording(), we will record what the caller *and* the IVR say]
     t.say "You are now on the record."
     # Prompt the user to incriminate themselve on-the-record
     t.say "Go ahead, sing-along."
     t.say "http://denalidomain.com/music/keepers/HappyHappyBirthdaytoYou-Disney.mp3"
-    JSON.parse(t.response).should == {"tropo"=>[{"on"=>{"event"=>"error", "next"=>"/error.json"}}, {"on"=>{"event"=>"hangup", "next"=>"/hangup.json"}}, {"on"=>{"event"=>"continue", "next"=>"/next.json"}}, {"say"=>[{"value"=>"Hello"}]}, {"startRecording"=>{"name"=>"recording", "url"=>"http://heroku-voip.marksilver.net/post_audio_to_s3?filename=foo.wav&unique_id=bar"}}, {"say"=>[{"value"=>"You are now on the record."}]}, {"say"=>[{"value"=>"Go ahead, sing-along."}]}, {"say"=>[{"value"=>"http://denalidomain.com/music/keepers/HappyHappyBirthdaytoYou-Disney.mp3"}]}]}
+    JSON.parse(t.response).should == {"tropo"=>[{"on"=>{"event"=>"error", "next"=>"/error.json"}}, {"on"=>{"event"=>"hangup", "next"=>"/hangup.json"}}, {"on"=>{"event"=>"continue", "next"=>"/next.json"}}, {"say"=>[{"value"=>"Hello"}]}, {"startRecording"=>{"url"=>"http://heroku-voip.marksilver.net/post_audio_to_s3?filename=foo.wav&unique_id=bar"}}, {"say"=>[{"value"=>"You are now on the record."}]}, {"say"=>[{"value"=>"Go ahead, sing-along."}]}, {"say"=>[{"value"=>"http://denalidomain.com/music/keepers/HappyHappyBirthdaytoYou-Disney.mp3"}]}]}
   end
   
   it "should generate a voice_session true if a JSON session is received that is a channel of 'VOICE'" do
@@ -610,4 +620,24 @@ describe "Tropo" do
     JSON.parse(t.response)['tropo'][0]['ask']['recognizer'].should == 'fr-fr'
     JSON.parse(t.response)['tropo'][1]['ask']['recognizer'].should == 'de-de'
   end
+  
+  it "should parse a JSON string or a Ruby Hash the same" do
+    json_session = "{\"session\":{\"id\":\"dih06n\",\"accountId\":\"33932\",\"timestamp\":\"2010-01-19T23:18:48.562Z\",\"userType\":\"HUMAN\",\"to\":{\"id\":\"tropomessaging@bot.im\",\"name\":\"unknown\",\"channel\":\"TEXT\",\"network\":\"JABBER\"},\"from\":{\"id\":\"john_doe@gmail.com\",\"name\":\"unknown\",\"channel\":\"TEXT\",\"network\":\"JABBER\"}}}"
+    tropo = Tropo::Generator.parse json_session
+    tropo.session.user_type.should == 'HUMAN'
+    
+    tropo = Tropo::Generator.parse(JSON.parse(json_session))
+    tropo.session.user_type.should == 'HUMAN'
+  end
+  
+  it "should return a hash of the response object" do
+    result = Tropo::Generator.new do
+      say [{ :value => '1234' }, { :value => 'abcd', :event => "nomatch:1" }]
+      say [{ :value => '0987' }, { :value => 'zyxw', :event => "nomatch:2" }]
+    end
+    result.to_hash.should == { :tropo => [{ :say => [{ :value => "1234" }, 
+                                                     { :event => "nomatch:1", :value => "abcd" }] }, 
+                                          { :say => [{ :value => "0987" }, 
+                                                     { :event => "nomatch:2", :value => "zyxw" }] }] }
+  end
 end

data/tropo-webapi-ruby.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tropo-webapi-ruby}
-  s.version = "0.1.8"
+  s.version = "0.1.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jason Goecke"]
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
      "VERSION",
      "examples/sinatra_server.rb",
      "lib/tropo-webapi-ruby.rb",
+     "lib/tropo-webapi-ruby/object_patch.rb",
      "lib/tropo-webapi-ruby/tropo-webapi-ruby-helpers.rb",
      "lib/tropo-webapi-ruby/tropo-webapi-ruby.rb",
      "spec/spec.opts",

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tropo-webapi-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.1.8
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 9
+  version: 0.1.9
 platform: ruby
 authors: 
 - Jason Goecke
@@ -14,34 +20,52 @@ default_executable:
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
         version: 1.2.9
-    version: 
+  type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: json_pure
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 2
+        - 0
         version: 1.2.0
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: hashie
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 2
+        - 0
         version: 0.2.0
-    version: 
+  type: :runtime
+  version_requirements: *id003
 description: Ruby library for interacting with the Tropo Web API via REST & JSON
 email: jsgoecke@voxeo.com
 executables: []
@@ -61,6 +85,7 @@ files:
 - VERSION
 - examples/sinatra_server.rb
 - lib/tropo-webapi-ruby.rb
+- lib/tropo-webapi-ruby/object_patch.rb
 - lib/tropo-webapi-ruby/tropo-webapi-ruby-helpers.rb
 - lib/tropo-webapi-ruby/tropo-webapi-ruby.rb
 - spec/spec.opts
@@ -77,21 +102,29 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 59
+      segments: 
+      - 1
+      - 8
+      - 6
       version: 1.8.6
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Tropo Web API Ruby Gem