pandorified 0.8.0 → 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86625391ab1a874c65ff69bb838fdcb9cf5849b9
+  data.tar.gz: 60b899f6ac7405e7225e32eca029226125d17f1e
+SHA512:
+  metadata.gz: a4c51bab5d8f395558f4ecddf3bb8e6d5c70076831ecfbf4d0c865e6e4cc5971cd34fc9b1d98a9c4cd1c79442c5830ce459aa6e7eef2f8df6f60444c6fc6a1e1
+  data.tar.gz: af8ebc3a61fbfc2a2f219d483d073d3cf28441940bd8c475ed51a779fde6d17e5dbb26b079221569ba0e16725712386cc357896e9f2d4db3a9ea34631b9f86c3

data/Gemfile.lock

@@ -1,15 +1,15 @@
 PATH
   remote: .
   specs:
-    pandorified (0.7.0)
+    pandorified (0.8.0)
       nokogiri
       rest-client
 
 GEM
   remote: http://rubygems.org/
   specs:
-    mime-types (1.19)
-    nokogiri (1.5.5)
+    mime-types (1.22)
+    nokogiri (1.5.9)
     rest-client (1.6.7)
       mime-types (>= 1.16)
 

data/README.md

@@ -1,52 +1,59 @@
 Summary
 -------
 
-Pandorified makes it easy for your Ruby scripts to interact with chat bots hosted on Pandorabots.
+Pandorified is a simple Ruby wrapper for the Pandorabots API. Talk to chat bots in your Ruby scripts!
 
 Installation
 ------------
 
 	gem install pandorified
 
+Or add Pandorified to your project's Gemfile:
+
+	gem 'pandorified'
+
 Getting Started
 ---------------
 
-The easiest way to get started is by using the `Pandorified::Session` class:
+To interact with the Pandorabots, you need to know the BOTID of the bot you wish to talk to. If you have published your own bot, the BOTID will be listed on your Botmaster page.
+
+Here is a basic example:
 
 	require 'pandorified'
 	
-	my_bot_session = Pandorified::Session.new(MY_BOTID)
-	first_response = my_bot_session.talk('Hello World!')
-	puts(first_response)
+	CHOMSKY_BOTID = 'b0dafd24ee35a477'
+	
+	# Send a message to Chomsky and print the response
+	puts Pandorified.talk!("Hello, Bot!", CHOMSKY_BOTID)
 
-In the example above, replace `MY_BOTID` with the actual botid of the Pandorabots chat bot you want to talk to.
+If you want the bot to remember who you are, you can create a session object and re-use it.
 
-Documentation
--------------
+	bot = Pandorified::Session.new('b0dafd24ee35a477')
+	puts bot.talk!("Hello")
+	puts bot.talk!("Goodbye now!")
 
-Documentation is available [here](http://rubydoc.info/gems/pandorified/frames).
+Full documentation is available [here](http://rubydoc.info/gems/pandorified/frames). If anything in the documentation is not clear, please [report it as a bug][1].
 
 Contributing
 ------------
 
-### Want to help make Pandorified more awesome?
-
-If you've found a bug or have a feature suggestion, let me know on the [issue tracker](https://bitbucket.org/xtagon/pandorified/issues?status=new&status=open).
-
-I welcome all suggestions, questions, and other feedback. Feel free to [drop me a line](mailto:xtagon@gmail.com).
+If you've found a bug or have a feature suggestion, let me know on the [issue tracker][1] or [send me an e-mail][2]. I welcome all feedback, and I'd love to hear about what cool things you've made with this!
 
 Author
 ------
 
-[Justin Workman](mailto:xtagon@gmail.com)
+[Justin Workman][2]
 
 License
 -------
 
-Copyright © 2011-2012 Justin Workman
+Copyright © 2011-2013 Justin Workman
 
 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.
+
+[1]: https://bitbucket.org/xtagon/pandorified/issues?status=new&status=open
+[2]: mailto:xtagon@gmail.com

data/lib/pandorified.rb

@@ -1,2 +1,35 @@
 require 'pandorified/version'
+require 'pandorified/result'
 require 'pandorified/session'
+
+module Pandorified
+	# Send a message to a bot and receive a response.
+	#
+	# See {Pandorified::Result} for ways to handle the response, or use {.talk!} which raises an exception on errors.
+	# If you want to remember the {botid} and {custid} between multiple calls, you should use {Pandorabots::Session} instead of this method.
+	#
+	# @param [String] input Text to say to the bot.
+	# @param [String] botid A valid Pandorabots botid.
+	# @param [String] custid An itentifier used to keep track of this conversaion.
+	#
+	# @return [Pandorified::Result] The bot's response as a result object.
+	def self.talk(input, botid, custid = nil)
+		Pandorified::Session.new(botid, custid).talk(input)
+	end
+
+	# Send a message to a bot and receive a response (if successsful).
+	#
+	# If Pandorabots respondes with an error, {Pandorified::PandorabotsError} is raised.
+	# If you'd rather check for and handle the error yourself, use {.talk} instead of this method.
+	#
+	# If you want to remember the {botid} and {custid} between multiple calls, you should use {Pandorabots::Session} instead of this method.
+	#
+	# @param [String] input Text to say to the bot.
+	# @param [String] botid A valid Pandorabots botid.
+	# @param [String] custid An itentifier used to keep track of this conversaion.
+	#
+	# @return [String] The bot's response text.
+	def self.talk!(input, botid, custid = nil)
+		Pandorified::Session.new(botid, custid).talk!(input).to_s
+	end
+end

data/lib/pandorified/result.rb

@@ -9,6 +9,13 @@ module Pandorified
 			@xml = Nokogiri::XML(RestClient.post(API_URL, params))
 		end
 
+		# @return [String] The bot's response to the input.
+		def that
+			@that ||= @xml.xpath('/result/that').first.text.strip
+		end
+
+		alias_method :to_s, :that
+
 		# Check the status of this result. See {#success?} and {#error?}.
 		#
 		# @return [Number] A status number as returned by Pandorabots.
@@ -16,31 +23,6 @@ module Pandorified
 			@status ||= @xml.xpath('/result/@status').first.value.to_i
 		end
 
-		# @return [String] The botid of the bot this result is for.
-		def botid
-			@botid ||= @xml.xpath('/result/@botid').first.value
-		end
-
-		# @return [String] The custid for this session.
-		def custid
-			@custid ||= @xml.xpath('/result/@custid').first.value
-		end
-
-		# @return [String] The orginal input that triggered this response.
-		def input
-			@input ||= @xml.xpath('/result/input').first.text
-		end
-
-		# @return [String] The bot's response to the input.
-		def that
-			@that ||= @xml.xpath('/result/that').first.text
-		end
-
-		# @return [String] The error message as returned by Pandorabots, if an error occured.
-		def message
-			@message ||= @xml.xpath('/result/message').first.text
-		end
-
 		# @return `true` if this result was successful (no error was returned by Pandorabots), `false` otherwise.
 		def success?
 			self.status.zero?
@@ -56,6 +38,28 @@ module Pandorified
 			!self.success?
 		end
 
-		alias_method :to_s, :that
+		# @return [String] The error message as returned by Pandorabots, if an error occured.
+		def message
+			return nil if self.success?
+			@message ||= @xml.xpath('/result/message').first.text
+		end
+
+		alias_method :error, :message
+		alias_method :error_message, :message
+
+		# @return [String] The botid of the bot this result is for.
+		def botid
+			@botid ||= @xml.xpath('/result/@botid').first.value
+		end
+
+		# @return [String] The custid for this session.
+		def custid
+			@custid ||= @xml.xpath('/result/@custid').first.value
+		end
+
+		# @return [String] The orginal input that triggered this response.
+		def input
+			@input ||= @xml.xpath('/result/input').first.text
+		end
 	end
 end

data/lib/pandorified/session.rb

@@ -7,7 +7,7 @@ module Pandorified
 	class Session
 		# A new session for conversing with a bot.
 		#
-		# @note If you choose not to specify a {custid}, one will be chosen automatically and remembered throughout the session.
+		# @note If you choose not to specify a {custid}, one will be automatically chosen and remembered throughout the session.
 		#
 		# @param [String] botid A valid Pandorabots botid.
 		# @param [String] custid An identifier used to keep track of this conversation.
@@ -18,11 +18,12 @@ module Pandorified
 
 		# Send a message to this session's bot and receive a response.
 		#
-		# @note See {Pandorified::Result} for ways to handle the response, or use {#talk!} which raises an exception on errors.
+		# See {Pandorified::Result} for how to check for an error response and get the error message.
+		# Alternatively, you can use {#talk!} instead of this method, which raises an exception when Pandorabots API returns an error.
 		#
 		# @param [String] input Text to say to the bot.
 		#
-		# @return [String] The bot's response text.
+		# @return [Pandorified::Result] The bot's response as a result object.
 		def talk(input)
 			result = Pandorified::Result.new(botid: @botid, custid: @custid, input: input)
 			@custid ||= result.custid if result.success?
@@ -30,9 +31,9 @@ module Pandorified
 		end
 
 		# Send a message to this session's bot and receive a response (if successful).
-		# If Pandorabots responds with an error, {Pandorified::Exceptions::PandorabotsError} is raised.
 		#
-		# @note See {#talk} if you want to check the {Pandorabots::Result} object for success instead of an exception being raised on error.
+		# If Pandorabots API responds with an error, {Pandorified::PandorabotsError} is raised with the specific error message.
+		# If you'd like to check for and handle the error yourself, you can use {#talk} instead of this method.
 		#
 		# @param [String] input Text to say to the bot.
 		#
@@ -40,6 +41,7 @@ module Pandorified
 		def talk!(input)
 			result = self.talk(input)
 			raise Pandorified::PandorabotsError, "Pandorabots returned status #{result.status}: #{result.message}" if result.error?
+			result.that
 		end
 	end
 end

data/lib/pandorified/version.rb

@@ -1,3 +1,3 @@
 module Pandorified
-	VERSION = '0.8.0'
+	VERSION = '0.9.0'
 end

metadata

@@ -1,46 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: pandorified
 version: !ruby/object:Gem::Version
-  version: 0.8.0
-  prerelease: 
+  version: 0.9.0
 platform: ruby
 authors:
 - Justin Workman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-14 00:00:00.000000000 Z
+date: 2013-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   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: nokogiri
   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: Pandorified makes it easy for your Ruby scripts to interact with chat
@@ -62,26 +57,25 @@ files:
 - pandorified.gemspec
 homepage: 
 licenses: []
+metadata: {}
 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.24
+rubygems_version: 2.0.0.rc.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Ruby client for the Pandorabots API.
 test_files: []