cleverbot 0.0.1 → 0.1.0

data/Gemfile

@@ -1,5 +1,7 @@
 source :rubygems
 
+gem 'httparty', '~> 0.8.0'
+
 group :development do
   gem 'bundler', '~> 1.0'
   gem 'jeweler', '~> 1.6'

data/Gemfile.lock

@@ -3,10 +3,15 @@ GEM
   specs:
     diff-lcs (1.1.3)
     git (1.2.5)
+    httparty (0.8.0)
+      multi_json
+      multi_xml
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
+    multi_json (1.0.3)
+    multi_xml (0.4.0)
     rake (0.9.2)
     rcov (0.9.10)
     rdoc (3.9.4)
@@ -24,6 +29,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.0)
+  httparty (~> 0.8.0)
   jeweler (~> 1.6)
   rcov (~> 0.9)
   rdoc (~> 3.9)

data/README.rdoc

@@ -2,6 +2,28 @@
 
 Ruby wrapper for Cleverbot.
 
+== Examples
+
+=== Talk to Cleverbot with Cleverbot::Client.write
+
+  @params = Cleverbot::Client.write 'Hi.'
+  @params['message'] # => "How are you?"
+  @params['sessionid'] # => "ABC01234567"
+
+  @params.keep_if { |key, value| Cleverbot::Client::DEFAULT_PARAMS.keys.include? key }
+  @params['message'] # => nil
+  @params['sessionid'] # => "ABC01234567"
+
+  @params = Cleverbot::Client.write 'Good, you?', @params
+  @params['message'] # => "Good."
+  @params['sessionid'] # => "ABC01234567"
+
+=== Talk to Cleverbot with Cleverbot::Client#write to manage parameters.
+
+  @client = Cleverbot::Client.new
+  @client.write 'Hi.' # => "How are you?"
+  @client.write 'Good, you?' # => "Good."
+
 == Contributing to cleverbot
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/cleverbot.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cleverbot}
-  s.version = "0.0.1"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Benjamin Manns"]
-  s.date = %q{2011-09-14}
+  s.date = %q{2011-09-16}
   s.description = %q{Ruby wrapper for Cleverbot.}
   s.email = %q{benmanns@gmail.com}
   s.extra_rdoc_files = [
@@ -28,6 +28,10 @@ Gem::Specification.new do |s|
     "VERSION",
     "cleverbot.gemspec",
     "lib/cleverbot.rb",
+    "lib/cleverbot/client.rb",
+    "lib/cleverbot/parser.rb",
+    "spec/cleverbot/client_spec.rb",
+    "spec/cleverbot/parser_spec.rb",
     "spec/cleverbot_spec.rb",
     "spec/spec_helper.rb"
   ]
@@ -41,12 +45,14 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, ["~> 0.8.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6"])
       s.add_development_dependency(%q<rcov>, ["~> 0.9"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.9"])
       s.add_development_dependency(%q<rspec>, ["~> 2.3"])
     else
+      s.add_dependency(%q<httparty>, ["~> 0.8.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6"])
       s.add_dependency(%q<rcov>, ["~> 0.9"])
@@ -54,6 +60,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rspec>, ["~> 2.3"])
     end
   else
+    s.add_dependency(%q<httparty>, ["~> 0.8.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6"])
     s.add_dependency(%q<rcov>, ["~> 0.9"])

data/lib/cleverbot.rb

@@ -1,2 +1,5 @@
+require 'cleverbot/client'
+
+# Module enclosing all Cleverbot related classes.
 module Cleverbot
 end

data/lib/cleverbot/client.rb

@@ -0,0 +1,91 @@
+require 'cleverbot/parser'
+
+module Cleverbot
+  # Ruby wrapper for Cleverbot.com.
+  class Client
+    include HTTParty
+
+    # The default form variables for POSTing to Cleverbot.com
+    DEFAULT_PARAMS = {
+      'stimulus' => '',
+      'start' => 'y',
+      'sessionid' => '',
+      'vText8' => '',
+      'vText7' => '',
+      'vText6' => '',
+      'vText5' => '',
+      'vText4' => '',
+      'vText3' => '',
+      'vText2' => '',
+      'icognoid' => 'wsf',
+      'icognocheck' => '',
+      'fno' => '0',
+      'prevref' => '',
+      'emotionaloutput' => '',
+      'emotionalhistory' => '',
+      'asbotname' => '',
+      'ttsvoice' => '',
+      'typing' => '',
+      'lineref' => '',
+      'sub' => 'Say',
+      'islearning' => '1',
+      'cleanslate' => 'false',
+    }
+
+    # The path to the form endpoint on Cleverbot.com.
+    PATH = '/webservicemin'
+
+    base_uri 'http://www.cleverbot.com'
+
+    parser Parser
+
+    # Holds the parameters for an instantiated Cleverbot::Base.
+    attr_reader :params
+
+    # Creates a digest from the form parameters.
+    #
+    # ==== Parameters
+    #
+    # [<tt>body</tt>] <tt>String</tt> to be digested.
+    def self.digest body
+      Digest::MD5.hexdigest body[9...29]
+    end
+
+    # Sends a message to Cleverbot.com and returns a <tt>Hash</tt> containing the parameters received.
+    #
+    # ==== Parameters
+    #
+    # [<tt>message</tt>] Optional <tt>String</tt> holding the message to be sent. Defaults to <tt>''</tt>.
+    # [<tt>params</tt>] Optional <tt>Hash</tt> with form parameters. Merged with DEFAULT_PARAMS. Defaults to <tt>{}</tt>.
+    def self.write message='', params={}
+      body = DEFAULT_PARAMS.merge params
+      body['stimulus'] = message
+      body['icognocheck'] = digest HashConversions.to_params(body)
+
+      post(PATH, :body => body).parsed_response
+    end
+
+    # Initializes a Cleverbot::Base with given parameters.
+    #
+    # ==== Parameters
+    #
+    # [<tt>params</tt>] Optional <tt>Hash</tt> holding the initial parameters. Defaults to <tt>{}</tt>.
+    def initialize params={}
+      @params = params
+    end
+
+    # Sends a message and returns a <tt>String</tt> with the message received. Updates #params to maintain state.
+    #
+    # ==== Parameters
+    #
+    # [<tt>message</tt>] Optional <tt>String</tt> holding the message to be sent. Defaults to <tt>''</tt>.
+    def write message=''
+      response = self.class.write message, @params
+      message = response['message']
+      response.keep_if { |key, value| DEFAULT_PARAMS.keys.include? key }
+      @params.merge! response
+      @params.delete_if { |key, value| DEFAULT_PARAMS[key] == value }
+      message
+    end
+  end
+end

data/lib/cleverbot/parser.rb

@@ -0,0 +1,44 @@
+require 'httparty'
+
+module Cleverbot
+  # Used in Cleverbot::Client to parse responses from Cleverbot.com.
+  class Parser < HTTParty::Parser
+    # Keys that correspond to the <tt>Array</tt> that Cleverbot.com returns.
+    # They are combined with the <tt>Array</tt> to form a response <tt>Hash</tt>.
+    KEYS = [
+      'message',
+      'sessionid',
+      'logurl',
+      'vText8',
+      'vText7',
+      'vText6',
+      'vText5',
+      'vText4',
+      'vText3',
+      'vText2',
+      'prevref',
+      nil,
+      'emotionalhistory',
+      'ttsLocMP3',
+      'ttsLocTXT',
+      'ttsLocTXT3',
+      'ttsText',
+      'lineref',
+      'lineURL',
+      'linePOST',
+      'lineChoices',
+      'lineChoicesAbbrev',
+      'typingData',
+      'divert',
+    ]
+
+    # Formats supported by the parser.
+    # Parser handles <tt>text/html</tt> responses only with #html.
+    SupportedFormats = { 'text/html' => :html }
+
+    # Splits the body on <tt>"\\r"</tt> and zips the result with KEYS, which is then formed into a <tt>Hash</tt>.
+    def html
+      Hash[KEYS.zip(body.split("\r"))]
+    end
+  end
+end

data/spec/cleverbot/client_spec.rb

@@ -0,0 +1,181 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe Cleverbot::Client do
+  subject { Cleverbot::Client }
+
+  it { should <= HTTParty }
+
+  describe '::DEFAULT_PARAMS' do
+    subject { Cleverbot::Client::DEFAULT_PARAMS }
+
+    it do
+      should == {
+        'stimulus' => '',
+        'start' => 'y',
+        'sessionid' => '',
+        'vText8' => '',
+        'vText7' => '',
+        'vText6' => '',
+        'vText5' => '',
+        'vText4' => '',
+        'vText3' => '',
+        'vText2' => '',
+        'icognoid' => 'wsf',
+        'icognocheck' => '',
+        'fno' => '0',
+        'prevref' => '',
+        'emotionaloutput' => '',
+        'emotionalhistory' => '',
+        'asbotname' => '',
+        'ttsvoice' => '',
+        'typing' => '',
+        'lineref' => '',
+        'sub' => 'Say',
+        'islearning' => '1',
+        'cleanslate' => 'false',
+      }
+    end
+  end
+
+  describe '::PATH' do
+    subject { Cleverbot::Client::PATH }
+
+    it { should == '/webservicemin' }
+  end
+
+  describe '.base_uri' do
+    subject { Cleverbot::Client.base_uri }
+
+    it { should == 'http://www.cleverbot.com' }
+  end
+
+  describe '.parser' do
+    subject { Cleverbot::Client.parser }
+
+    it { should == Cleverbot::Parser }
+  end
+
+  describe '.digest' do
+    subject { Cleverbot::Client.digest @body }
+    context 'given a body of 0123456789abcdefghijklmnopqrstuvwxyz' do
+      before :each do
+        @body = '0123456789abcdefghijklmnopqrstuvwxyz'
+      end
+
+      it 'should call Digest::MD5.hexdigest with 9abcdefghijklmnopqrs' do
+        Digest::MD5.should_receive(:hexdigest).with @body[9..28]
+        subject
+      end
+
+      context 'when Digest::MD5.hexdigest returns abcd' do
+        before :each do
+          Digest::MD5.stub!(:hexdigest).and_return 'abcd'
+        end
+
+        it { should == 'abcd' }
+      end
+    end
+  end
+
+  describe '.write' do
+    subject { Cleverbot::Client.write @message, @params }
+
+    context 'with params {}' do
+      before :each do
+        @params = {}
+      end
+
+      context 'with an empty message' do
+        before :each do
+          @message = ''
+        end
+
+        it 'should post to PATH' do
+          Cleverbot::Client.should_receive(:post).with(Cleverbot::Client::PATH, hash_including).and_return mock(:parsed_response => {})
+          subject
+        end
+
+        Cleverbot::Client::DEFAULT_PARAMS.each do |key, value|
+          next if ['stimulus', 'icognocheck'].include? key
+          it "should add #{key} => #{value.inspect} to the post body" do
+            Cleverbot::Client.should_receive(:post).with(Cleverbot::Client::PATH, :body => hash_including(key => value)).and_return mock(:parsed_response => {})
+            subject
+          end
+        end
+
+        it 'should add stimulus => "" to the post body' do
+          Cleverbot::Client.should_receive(:post).with(Cleverbot::Client::PATH, :body => hash_including('stimulus' => '')).and_return mock(:parsed_response => {})
+          subject
+        end
+
+        context 'when digest returns abcd' do
+          before :each do
+            Digest::MD5.stub!(:hexdigest).and_return 'abcd'
+          end
+
+          it 'should add icognocheck => "abcd" to the post body' do
+            Cleverbot::Client.should_receive(:post).with(Cleverbot::Client::PATH, :body => hash_including('icognocheck' => 'abcd')).and_return mock(:parsed_response => {})
+            subject
+          end
+        end
+
+        context 'when the parsed response is {}' do
+          before :each do
+            Cleverbot::Client.stub!(:post).and_return mock(:parsed_response => {})
+          end
+
+          it { should == {} }
+        end
+      end
+    end
+  end
+
+  describe '#initialize' do
+    subject { Cleverbot::Client.new @params }
+
+    context 'with params { "a" => "b" }' do
+      before :each do
+        @params = { 'a' => 'b' }
+      end
+
+      it 'sets #params to { "a" => "b" }' do
+        subject.params.should == { 'a' => 'b' }
+      end
+    end
+  end
+
+  describe '#write' do
+    before :each do
+      @client = Cleverbot::Client.new
+    end
+
+    subject { @client.write @message }
+
+    context 'with an empty message' do
+      before :each do
+        @message = ''
+      end
+
+      it 'should call .write with "" and #params' do
+        Cleverbot::Client.should_receive(:write).with(@message, @client.params).and_return({})
+        subject
+      end
+
+      context 'when .write returns { "message" => "Hi.", "sessionid" => "abcd" }' do
+        before :each do
+          Cleverbot::Client.stub!(:write).and_return 'message' => 'Hi.', 'sessionid' => 'abcd'
+        end
+
+        it 'should set #params[sessionid] to abcd' do
+          subject
+          @client.params['sessionid'].should == 'abcd'
+        end
+
+        it 'should not set #params[message] to Hi.' do
+          subject
+          @client.params['message'].should_not == 'abcd'
+        end
+      end
+    end
+  end
+end

data/spec/cleverbot/parser_spec.rb

@@ -0,0 +1,84 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe Cleverbot::Parser do
+  subject { Cleverbot::Parser }
+
+  it { should <= HTTParty::Parser }
+
+  it { should be_supports_format :html }
+
+  describe '::KEYS' do
+    subject { Cleverbot::Parser::KEYS }
+
+    it do
+      should == [
+        'message',
+        'sessionid',
+        'logurl',
+        'vText8',
+        'vText7',
+        'vText6',
+        'vText5',
+        'vText4',
+        'vText3',
+        'vText2',
+        'prevref',
+        nil,
+        'emotionalhistory',
+        'ttsLocMP3',
+        'ttsLocTXT',
+        'ttsLocTXT3',
+        'ttsText',
+        'lineref',
+        'lineURL',
+        'linePOST',
+        'lineChoices',
+        'lineChoicesAbbrev',
+        'typingData',
+        'divert',
+      ]
+    end
+  end
+
+  describe '#call' do
+    subject { Cleverbot::Parser.call @body, @format }
+
+    context 'with a format of :html' do
+      before :each do
+        @format = :html
+      end
+
+      context 'with an empty body' do
+        before :each do
+          @body = ''
+        end
+
+        it { should be_nil }
+      end
+
+      context 'with an body of 0\r1\r2' do
+        before :each do
+          @body = (0..2).to_a.join "\r"
+        end
+
+        (0..2).each do |key|
+          it { should include({ Cleverbot::Parser::KEYS[key] => key.to_s }) }
+        end
+        (3..(Cleverbot::Parser::KEYS.length - 1)).each do |key|
+          it { should include({ Cleverbot::Parser::KEYS[key] => nil }) }
+        end
+      end
+
+      context 'with a body of length greater than KEYS.length' do
+        before :each do
+          @body = (0..Cleverbot::Parser::KEYS.length).to_a.join "\r"
+        end
+
+        (0..(Cleverbot::Parser::KEYS.length - 1)).each do |key|
+          it { should include({ Cleverbot::Parser::KEYS[key] => key.to_s }) }
+        end
+        it { should_not have_key Cleverbot::Parser::KEYS.length }
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cleverbot
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,23 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-14 00:00:00.000000000 -04:00
+date: 2011-09-16 00:00:00.000000000 -04:00
 default_executable: 
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &17723180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *17723180
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &20490020 !ruby/object:Gem::Requirement
+  requirement: &17722640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +33,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *20490020
+  version_requirements: *17722640
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &20488940 !ruby/object:Gem::Requirement
+  requirement: &17722040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +44,10 @@ dependencies:
         version: '1.6'
   type: :development
   prerelease: false
-  version_requirements: *20488940
+  version_requirements: *17722040
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &20487100 !ruby/object:Gem::Requirement
+  requirement: &17719820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +55,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *20487100
+  version_requirements: *17719820
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &20485800 !ruby/object:Gem::Requirement
+  requirement: &17719320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +66,10 @@ dependencies:
         version: '3.9'
   type: :development
   prerelease: false
-  version_requirements: *20485800
+  version_requirements: *17719320
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &20484600 !ruby/object:Gem::Requirement
+  requirement: &17718800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,7 +77,7 @@ dependencies:
         version: '2.3'
   type: :development
   prerelease: false
-  version_requirements: *20484600
+  version_requirements: *17718800
 description: Ruby wrapper for Cleverbot.
 email: benmanns@gmail.com
 executables: []
@@ -86,6 +97,10 @@ files:
 - VERSION
 - cleverbot.gemspec
 - lib/cleverbot.rb
+- lib/cleverbot/client.rb
+- lib/cleverbot/parser.rb
+- spec/cleverbot/client_spec.rb
+- spec/cleverbot/parser_spec.rb
 - spec/cleverbot_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -104,7 +119,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2178588374968580678
+      hash: 1100025997213852890
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: