tropo-webapi-ruby 0.1.5 → 0.1.6

data/HISTORY.rdoc

@@ -1,5 +1,10 @@
 = Tropo Release History
 
-== Version 0.1.0
+== Version 0.1.5
 
-- Alpha release
+- First public release
+
+== 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.

data/README.rdoc

@@ -1,6 +1,6 @@
 = Tropo Web API Ruby Library
 
-A Ruby library for interaction with the Tropo Web API using JSON.
+A Ruby library for interaction with the Tropo Web API (http://tropo.com) using JSON.
 
 == Tropo Web API Overview
 
@@ -12,6 +12,8 @@ your own web servers.
 * Ruby v1.8.6+ or JRuby v1.4.0+
 * RubyGems
 
+Note: If using with ActiveSupport, v2.3.5 or better of ActiveSupport is required.
+
 == Installation
 
   $ sudo gem install tropo-webapi-ruby
@@ -187,6 +189,22 @@ Using the great RESTful Web Services framework Sinatra for Ruby.
 
 May be found by checking out the project from Github, and then looking in $PROJECT_HOME/examples and $PROJECT_HOME/spec/tropo-webapi-ruby_spec.rb.
 
+=== Documentation
+
+* API Documentation:
+
+http://voxeo.github.com/tropo-webapi-ruby
+
+* Tropo Web API Documentation
+
+http://docs.tropo.com/webapi/2.0/home.htm
+
+== Notes
+
+In order to maintain compatibility between Ruby MRI and JRuby the gem requires 'json_pure'. If you are using the Ruby MRI and would prefer to use the C version of 'json', simply install the 'json' gem as follows:
+
+  sudo gem install json
+
 == Copyright
 
 Copyright (c) 2010 Voxeo, Corporation. See LICENSE for details.

data/Rakefile

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'rake'
+require 'yard'
 
 begin
   require 'jeweler'
@@ -12,7 +13,10 @@ begin
     gem.authors = ["Jason Goecke"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.files.include %w(lib/tropo-webapi-ruby.rb lib/tropo-webapi-ruby/tropo-webapi-ruby.rb lib/tropo-webapi-ruby/tropo-webapi-ruby-helpers.rb LICENSE VERSION README.markdown)
-    gem.add_dependency('json', '>= 1.2.0')
+    #gem.add_dependency('json', '>= 1.2.0')
+    gem.add_dependency('json_pure', '>= 1.2.0')
+    gem.add_dependency('hashie', '>= 0.2.0')
+    gem.required_ruby_version = '>= 1.8.6'
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
@@ -46,8 +50,6 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-# require 'yardoc'
-# YARD::Rake::YardocTask.new do |t|
-#   t.files   = ['lib/**/*.rb', OTHER_PATHS]   # optional
-#   t.options = ['--any', '--extra', '--opts'] # optional
-# end
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/tropo-webapi-ruby/*.rb', 'lib/*.rb', 'README']
+end

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.1.6

data/lib/tropo-webapi-ruby.rb

@@ -1,6 +1,2 @@
 $: << File.expand_path(File.dirname(__FILE__))
-require 'uri'
-require 'json'
-require 'time'
-require 'tropo-webapi-ruby/tropo-webapi-ruby-helpers'
-require 'tropo-webapi-ruby/tropo-webapi-ruby'
+%w(uri json hashie time tropo-webapi-ruby/tropo-webapi-ruby-helpers tropo-webapi-ruby/tropo-webapi-ruby).each { |lib| require lib }

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

@@ -161,8 +161,8 @@ module Tropo
 
         array.each_with_index do |ele, i|
           # Set the key to the value of the respresentative key
-          key = ele['key'].to_sym if ele['key']
-          key = ele['name'].to_sym if ele['name']
+          key = ele['key'] if ele['key']
+          key = ele['name'] if ele['name']
         
           # Merge this new key into the hash
           transformed_to_hash.merge!({ key => Hash.new })
@@ -196,16 +196,16 @@ module Tropo
       # @param[String] the key to be decamelized and symobolized
       # @param[Hash] the newly created hash that contins the properly formatted key
       def transform_pair(key, value)
-        hash = { decamelize(key).to_sym => value }
-        hash[:timestamp] = Time.parse(value) if hash[:timestamp]
-        if hash[:actions]
-          if hash[:actions][:name]
-            key_name = hash[:actions][:name]
-            hash[:actions].delete(:name)
-            hash[:actions] = { key_name.to_sym => hash[:actions] }
+        hash = { decamelize(key) => value }
+        hash['timestamp'] = Time.parse(value) if hash['timestamp']
+        if hash['actions']
+          if hash['actions']['name']
+            key_name = hash['actions']['name']
+            hash['actions'].delete('name')
+            hash['actions'] = { key_name => hash['actions'] }
           end
         end
-        set_session_type(hash) if hash[:channel]
+        set_session_type(hash) if hash['channel']
         hash
       end
       
@@ -215,7 +215,7 @@ module Tropo
       # @param[Hash] the key, value pair of the channel 
       # @return nil
       def set_session_type(hash)
-        case hash[:channel]
+        case hash['channel']
         when "VOICE"
           @voice_session = true
           @text_session = false

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

@@ -186,28 +186,28 @@ module Tropo
     # @param [String] a JSON string
     # @return [Hash] a Hash representing the response from Tropo
     def parse(json_string)
-      response = JSON.parse json_string
-      
+      response = JSON.parse(json_string)
+
       # Check to see what type of response we are working with
       if response['session']
-        transformed_response = { :session => { } }
+        transformed_response = { 'session' => { } }
         
         response['session'].each_pair do |key, value|
           value = transform_hash value if value.kind_of? Hash
-          transformed_response[:session].merge!(transform_pair(key, value))
+          transformed_response['session'].merge!(transform_pair(key, value))
         end
         
       elsif response['result']
-        transformed_response = { :result => { :actions => { } } }
+        transformed_response = { 'result' => { } }
 
         response['result'].each_pair do |key, value|
           value = transform_hash value if value.kind_of? Hash
           value = transform_array value  if value.kind_of? Array
-          transformed_response[:result].merge!(transform_pair(key, value))
+          transformed_response['result'].merge!(transform_pair(key, value))
         end
       end
-      
-      transformed_response
+
+      transformed_response = Hashie::Mash.new(transformed_response)
     end
     
     ##

data/spec/spec_helper.rb

@@ -1,9 +1,6 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'rubygems'
-require 'tropo-webapi-ruby'
-require 'spec'
-require 'spec/autorun'
+%w(rubygems tropo-webapi-ruby hashie spec spec/autorun).each { |lib| require lib }
 
 Spec::Runner.configure do |config|
   

data/spec/tropo-webapi-ruby_spec.rb

@@ -212,7 +212,7 @@ describe "Tropo" do
   it "should accept a valid email address when a 'record' action is called" do
     response = Tropo::Generator.record({ :name => 'bar',
                                          :url  => 'foo@bar.com' })
-    response.should == "{\"tropo\":[{\"record\":{\"url\":\"foo@bar.com\",\"name\":\"bar\"}}]}"
+    JSON.parse(response).should == JSON.parse("{\"tropo\":[{\"record\":{\"url\":\"foo@bar.com\",\"name\":\"bar\"}}]}")
   end
   
   # Redirect action tests
@@ -334,12 +334,12 @@ describe "Tropo" do
   
   it "should build a Ruby hash object when a result arrives in JSON" do
     json_result = "{\"result\":{\"sessionId\":\"sessionId\",\"callState\":\"ANSWERED\",\"sessionDuration\":10,\"sequence\":1,\"complete\":true,\"error\":\"error\",\"properties\":[{\"key\":\"foo\",\"value\":\"bar\"},{\"key\":\"charlie\",\"value\":\"foxtrot\"}],\"actions\":{\"name\":\"pin\",\"attempts\":1,\"disposition\":\"SUCCESS\",\"confidence\":100,\"interpretation\":\"12345\",\"utterance\":\"1 2 3 4 5\"}}}"
-    Tropo::Generator.parse(json_result).should == {:result=>{:session_id=>"sessionId", :properties=>{:foo=>{:value=>"bar"}, :charlie=>{:value=>"foxtrot"}}, :complete=>true, :call_state=>"ANSWERED", :actions=>{:pin=>{:disposition=>"SUCCESS", :utterance=>"1 2 3 4 5", :attempts=>1, :interpretation=>"12345", :confidence=>100}}, :session_duration=>10, :error=>"error", :sequence=>1}}
+    Tropo::Generator.parse(json_result).should == Hashie::Mash.new({:result=>{:session_id=>"sessionId", :properties=>{:foo=>{:value=>"bar"}, :charlie=>{:value=>"foxtrot"}}, :complete=>true, :call_state=>"ANSWERED", :actions=>{:pin=>{:disposition=>"SUCCESS", :utterance=>"1 2 3 4 5", :attempts=>1, :interpretation=>"12345", :confidence=>100}}, :session_duration=>10, :error=>"error", :sequence=>1}})
   end
   
   it "should build a ruby hash object when a realworld JSON string arrives" do
     json_result = "{\"result\":{\"sessionId\":\"CCFD9C86-1DD1-11B2-B76D-B9B253E4B7FB@161.253.55.20\",\"callState\":\"ANSWERED\",\"sessionDuration\":2,\"sequence\":1,\"complete\":true,\"error\":null,\"actions\":[{\"name\":\"zip\",\"attempts\":1,\"disposition\":\"SUCCESS\",\"confidence\":100,\"interpretation\":\"12345\",\"utterance\":\"1 2 3 4 5\"},{\"name\":\"days\",\"attempts\":1,\"disposition\":\"SUCCESS\",\"confidence\":100,\"interpretation\":\"1\",\"utterance\":\"1\"}]}}"
-    Tropo::Generator.parse(json_result).should == {:result=>{:call_state=>"ANSWERED", :complete=>true, :actions=>{:zip=>{:disposition=>"SUCCESS", :utterance=>"1 2 3 4 5", :attempts=>1, :interpretation=>"12345", :confidence=>100}, :days=>{:disposition=>"SUCCESS", :utterance=>"1", :attempts=>1, :interpretation=>"1", :confidence=>100}}, :session_duration=>2, :sequence=>1, :session_id=>"CCFD9C86-1DD1-11B2-B76D-B9B253E4B7FB@161.253.55.20", :error=>nil}}
+    Tropo::Generator.parse(json_result).should == Hashie::Mash.new({:result=>{:call_state=>"ANSWERED", :complete=>true, :actions=>{:zip=>{:disposition=>"SUCCESS", :utterance=>"1 2 3 4 5", :attempts=>1, :interpretation=>"12345", :confidence=>100}, :days=>{:disposition=>"SUCCESS", :utterance=>"1", :attempts=>1, :interpretation=>"1", :confidence=>100}}, :session_duration=>2, :sequence=>1, :session_id=>"CCFD9C86-1DD1-11B2-B76D-B9B253E4B7FB@161.253.55.20", :error=>nil}})
   end
   
   it "should see an object delcared outside of a block" do
@@ -409,7 +409,15 @@ describe "Tropo" do
   it "should build a Ruby hash object when a result arrives in JSON with one action returned in an array" do
     json_result = "{\"result\":{\"sessionId\":\"CCFD9C86-1DD1-11B2-B76D-B9B253E4B7FB@161.253.55.20\",\"callState\":\"ANSWERED\",\"sessionDuration\":2,\"sequence\":1,\"complete\":true,\"error\":null,\"actions\":{\"name\":\"zip\",\"attempts\":1,\"disposition\":\"SUCCESS\",\"confidence\":100,\"interpretation\":\"12345\",\"utterance\":\"1 2 3 4 5\"}}}"
     hash = Tropo::Generator.parse(json_result)
-    hash.should == {:result=>{:call_state=>"ANSWERED", :complete=>true, :actions=>{:zip=>{:utterance=>"1 2 3 4 5", :attempts=>1, :interpretation=>"12345", :confidence=>100, :disposition=>"SUCCESS"}}, :session_id=>"CCFD9C86-1DD1-11B2-B76D-B9B253E4B7FB@161.253.55.20", :session_duration=>2, :error=>nil, :sequence=>1}}
+    hash.should == Hashie::Mash.new({:result=>{:call_state=>"ANSWERED", :complete=>true, :actions=>{:zip=>{:utterance=>"1 2 3 4 5", :attempts=>1, :interpretation=>"12345", :confidence=>100, :disposition=>"SUCCESS"}}, :session_id=>"CCFD9C86-1DD1-11B2-B76D-B9B253E4B7FB@161.253.55.20", :session_duration=>2, :error=>nil, :sequence=>1}})
+  end
+  
+  it "should build a Hashie object when a result arrives in JSON" do
+    json_result = "{\"result\":{\"sessionId\":\"CCFD9C86-1DD1-11B2-B76D-B9B253E4B7FB@161.253.55.20\",\"callState\":\"ANSWERED\",\"sessionDuration\":2,\"sequence\":1,\"complete\":true,\"error\":null,\"actions\":{\"name\":\"zip\",\"attempts\":1,\"disposition\":\"SUCCESS\",\"confidence\":100,\"interpretation\":\"12345\",\"utterance\":\"1 2 3 4 5\"}}}"
+    hash = Tropo::Generator.parse(json_result)
+    hash.result.call_state.should == 'ANSWERED'
+    hash[:result][:call_state].should == 'ANSWERED'
+    hash['result']['call_state'].should == 'ANSWERED'
   end
   
   it "should generate valid JSON when a startRecording is used" do

data/tropo-webapi-ruby.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tropo-webapi-ruby}
-  s.version = "0.1.5"
+  s.version = "0.1.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jason Goecke"]
-  s.date = %q{2010-01-20}
+  s.date = %q{2010-04-26}
   s.description = %q{Ruby library for interacting with the Tropo Web API via REST & JSON}
   s.email = %q{jsgoecke@voxeo.com}
   s.extra_rdoc_files = [
@@ -19,7 +19,6 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
-     ".yardoc",
      "HISTORY.rdoc",
      "LICENSE",
      "README.rdoc",
@@ -37,6 +36,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://tropo.com}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.8.6")
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Tropo Web API Ruby Gem}
   s.test_files = [
@@ -51,14 +51,17 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
-      s.add_runtime_dependency(%q<json>, [">= 1.2.0"])
+      s.add_runtime_dependency(%q<json_pure>, [">= 1.2.0"])
+      s.add_runtime_dependency(%q<hashie>, [">= 0.2.0"])
     else
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
-      s.add_dependency(%q<json>, [">= 1.2.0"])
+      s.add_dependency(%q<json_pure>, [">= 1.2.0"])
+      s.add_dependency(%q<hashie>, [">= 0.2.0"])
     end
   else
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
-    s.add_dependency(%q<json>, [">= 1.2.0"])
+    s.add_dependency(%q<json_pure>, [">= 1.2.0"])
+    s.add_dependency(%q<hashie>, [">= 0.2.0"])
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tropo-webapi-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors: 
 - Jason Goecke
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-20 00:00:00 -05:00
+date: 2010-04-26 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -23,7 +23,7 @@ dependencies:
         version: 1.2.9
     version: 
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: json_pure
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -32,6 +32,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.2.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+    version: 
 description: Ruby library for interacting with the Tropo Web API via REST & JSON
 email: jsgoecke@voxeo.com
 executables: []
@@ -44,7 +54,6 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
-- .yardoc
 - HISTORY.rdoc
 - LICENSE
 - README.rdoc
@@ -71,7 +80,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: 1.8.6
   version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: