cleverbot_io 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44eeeb0cce1a6763a31117f2e1ce22c7544d69b0
-  data.tar.gz: 010a3e52ff6cd191a9104719a45a543dfd5a80c7
+  metadata.gz: 03197bf5c92655289d8320102d13abd48b41a07d
+  data.tar.gz: 9da8d662b7a9df22882ded1098260816f1359b2d
 SHA512:
-  metadata.gz: cf1a687301292fa6607ddf15fcc6a9ff37353453ea8f77ccafd4762f01d599bcb13a1f49bdf50018bad37e2beacf34ffe772c0e7e4a03b843291480eab3fc146
-  data.tar.gz: a37bf1e647a12fe59afea55ea75af16ff41940e26d35d8c4917946727358f153a426f95e3cec24a8992672dbe738fd344cd8fce3e0b2b0336c600dbcb9cadebd
+  metadata.gz: e800d378043b80a3bf506dd785c22f4f9b73ac80f9728877e962260a50d005ade78a574b18fc2a45571c2b89ee6c776fc3e8ab0e428e44fd207c6db891cb107a
+  data.tar.gz: 84fef4a0be0f20dc04cae4c4c75179f8cd37c2fbcece3eb7317348c55187080b85d317212a8150ed97ca84aed6b96ec0a1bc74c88f7f4ef7d9d35074fee33746

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 ## Version 1
+### 1.2.0
+* Improve performance by using optimized JSON instead of stdlib JSON
+* Implement proper error handling for both of Cleverbot's errors, as well as a fallback error which complains about being unrecognized (#3).
+
 ### 1.1.0
 * Merge `#create` into `#initialize`.
 * `api_user` and `api_key` are no longer accessors, but readers.

data/lib/cleverbot.rb

@@ -1,9 +1,15 @@
 require 'httpclient'
-require 'json'
+require 'oj'
+require_relative 'cleverbot_errors'
 
 class Cleverbot
+  # @return [String] The API User for the instance.
   attr_reader :api_user
+
+  # @return [String] The API Key for the instance.
   attr_reader :api_key
+
+  # @return [String] The reference nick for the session.
   attr_accessor :nick
 
   # Creates a new instance of the Cleverbot.
@@ -21,14 +27,14 @@ class Cleverbot
       key: @api_key
     }
     params[:nick] = @nick unless @nick.nil?
-    response = JSON.parse(@client.post('https://cleverbot.io/1.0/create', params).body)
-    @nick = response['nick'] if response['status'] == 'success'
+    response = Oj.load(@client.post('https://cleverbot.io/1.0/create', params).body)
+    try_throw(response['status'])
+    @nick = response['nick']
   end
 
-  # Sends the bot a message and returns its response. If the nick has not been set, it will call #{create}.
+  # Sends the bot a message and returns its response.
   # @param str [String] The message to send to the bot.
   # @return [String] The bot's response, or its error message.
-  # @todo Error handling.
   def say(str)
     params = {
       user: @api_user,
@@ -36,11 +42,24 @@ class Cleverbot
       text: str,
       nick: @nick
     }
-    response = JSON.parse(@client.post('https://cleverbot.io/1.0/ask', params).body)
-    if response['status'] == 'success'
-      response['response']
-    else
-      response['status']
+    response = Oj.load(@client.post('https://cleverbot.io/1.0/ask', params).body)
+    try_throw(response['status'])
+
+    response['response']
+  end
+
+  private
+
+  # Throws the relevant errors if possible.
+  # @param status [String] The status value from the API
+  # @raise [IncorrectCredentialsError] If the api_user and api_key are incorrect.
+  # @raise [DuplicatedReferenceNamesError] If the reference name is already in use by the instance.
+  def try_throw(status)
+    case status
+    when 'Error: API credentials incorrect' then fail Cleverbot::Errors::IncorrectCredentialsError
+    when 'Error: reference name already exists' then fail Cleverbot::Errors::DuplicatedReferenceNamesError
+    when 'success' then return
+    else fail "#{response['status']} UNRECOGNIZED ERROR! PLEASE REPORT TO CLEVERBOT RUBY ISSUE TRACKER."
     end
   end
 end

data/lib/cleverbot_errors.rb

@@ -0,0 +1,15 @@
+class Cleverbot
+  class Errors
+    class IncorrectCredentialsError < StandardError
+      def message
+        'Incorrect API credentials.'
+      end
+    end
+
+    class DuplicatedReferenceNamesError < StandardError
+      def message
+        'Reference name already exists.'
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cleverbot_io
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Eli Foster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-27 00:00:00.000000000 Z
+date: 2016-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -24,6 +24,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.7.1
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.6
 description: A fully featured wrapper to the Cleverbot.io web API.
 email: elifosterwy@gmail.com
 executables: []
@@ -32,6 +46,7 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - lib/cleverbot.rb
+- lib/cleverbot_errors.rb
 homepage: https://github.com/CleverbotIO/ruby-cleverbot.io
 licenses:
 - CC-BY-NC-ND-4.0