cbot 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f2284e0ce375daa686449df11bb3b42d1e98c4c
+  data.tar.gz: c472c0c65a239321704bcf365836f81c1faf135d
+SHA512:
+  metadata.gz: f4e276e3d5f6faa8caf2d57522902861f9a765d5a54da4e802cf20bc18a169bc5ea660b45812812f794518776ea659a63f31a0105b0e39a0d3ccb23ef865d9da
+  data.tar.gz: 755418c33ec2807561e31f191a20abd302a57d38b53fb804feb6bace59df93eca57474775aa87d7329d071097feb4ccab59c8728f5698204123b45b4376cf3dd

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    cbot (1.0.0)
+      json (~> 1.8, >= 1.8.6)
+      rest-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    json (1.8.6)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    netrc (0.11.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cbot!
+
+BUNDLED WITH
+   1.15.3

data/LICENSE.md

@@ -0,0 +1,25 @@
+# The MIT License (MIT)
+
+Copyright © 2016 Eli Foster
+
+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.
+

data/README.md

@@ -0,0 +1,33 @@
+# cleverbot
+
+A Ruby wrapper for the cleverbot.com API.
+Adapted from cleverbot.io API for cleverbot.com
+
+## Installation
+### Bundler
+Add this line to your Gemfile:
+```ruby
+gem 'cleverbot_rb', git: 'git@github.com:Reaver01/cleverbot_rb.git',
+                    branch: 'master'
+```
+
+And then execute:
+```shell
+$ bundle install
+```
+
+## Usage
+Be sure to look at the actual documentation for the cleverbot.com API when you are not sure about something. Or ask for documentation clarification in the issue tracker here.
+
+Before using this module, please get your API keys at http://www.cleverbot.com/api/.
+
+```ruby
+require 'cleverbot'
+
+# Create a new Cleverbot instance, with an optional reference nick set.
+CLEVER = Cleverbot.new('api_key')
+
+# Talk with your pal, Cleverbot.
+CLEVER.say('Why am I still talking to you?')
+# => 'Because you have a beautiful soul.'
+```

data/cleverbot.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cleverbot/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'cbot'
+  spec.version = Cleverbot::VERSION
+  spec.authors = ['Reaver01']
+  spec.email = ['jawmac@gmail.com']
+  
+  spec.summary = 'A Ruby wrapper for the Cleverbot.com web API.'
+  spec.description = 'A fully featured wrapper to the Cleverbot.com web API.'
+  spec.homepage = 'https://github.com/elieltavares/cleverbot'
+  spec.license = 'MIT'
+  
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test)/}) }
+  spec.require_paths = ['lib']
+
+
+  spec.add_dependency('rest-client')
+  spec.add_dependency('json', '~> 1.8', '>= 1.8.6')
+end

data/lib/cleverbot.rb

@@ -0,0 +1,10 @@
+require 'cleverbot/version'
+require 'json'
+
+# Cleverbot
+module Cleverbot
+  require 'cleverbot/api'
+  require 'cleverbot/client'
+  require 'cleverbot/conversation'
+  extend self
+end

data/lib/cleverbot/api.rb

@@ -0,0 +1,51 @@
+require 'rest-client'
+require 'json'
+
+module Cleverbot
+  # Wrapper for Cleverbot's REST API
+  module API
+    # Base API url
+    API_URL = 'http://cleverbot.com'.freeze
+
+    # Name of the library
+    WRAPPER = 'cleverbot'.freeze
+
+    # The most time to wait to retry for a response
+    # from the API in seconds. This is because, at the time of
+    # writing, the API will sometimes return an empty response
+    # and you must retry your request.
+    MAX_BACKOFF = 60
+
+    module_function
+
+    # Executre a GET request.
+    # @param route [String] the route to request
+    # @param params [Hash] the params to query
+    def get_request(route = '', params = {})
+      params[:wrapper] = WRAPPER
+      response = RestClient.get "#{API_URL}/#{route}", params: params
+      JSON.parse response
+    end
+
+    # @param key [String] API key
+    # @param input [String] the phrase to pass to the conversation
+    # @param conversation [String] the conversation ID to pass input to
+    # @param retry_empty [true, false] whether to retry if we get an empty response
+    # @param backoff [Integer] how long to wait before retrying if retry_empty
+    # @return [String] the reply
+    def get_reply(key, input, conversation = nil, retry_empty: true, backoff: 1)
+      return if backoff > MAX_BACKOFF
+
+      reply = get_request(
+        'getreply',
+        key: key, input: input, cs: conversation
+      )
+
+      return reply unless retry_empty && reply['output'].nil?
+      puts "Reponse empty! Retrying after #{backoff} seconds."
+      sleep backoff
+
+      get_reply(key, input, conversation, retry_empty: true, backoff: backoff * 2)
+    end
+  end
+end

data/lib/cleverbot/client.rb

@@ -0,0 +1,62 @@
+require 'cleverbot/conversation'
+
+module Cleverbot
+  # A client that wraps basic API functionality and can maintain
+  # multiple conversations associated with an identifier
+  # @example Basic conversing
+  #   client = Cleverbot::Client.new 'your api key'
+  #   puts client.say 'hello' #=> *witty response*
+  #   puts client.say 'okay' #=> *another witty response*
+  # @example Multiple conversations
+  #   client = Cleverbot::Client.new 'your api key'
+  #
+  #   # Client#say takes an arbitray identifier as a second arguement
+  #   # that will start a new conversation with each unique object
+  #   # given, and continue that conversation when passed the same identifier.
+  #
+  #   # Start a new conversation with Mike the symbol
+  #   puts client.say('hello', :mike) #=> 'hello'
+  #   puts client.say('my name is mike', :mike) #=> 'ok'
+  #
+  #   # Start a new conversation with Zac the string.
+  #   puts client.say('hello', 'Zac') #=> 'hello'
+  #   puts client.say('my name is mike', 'Zac') #=> 'no it is zac'
+  class Client
+    # @return [String] API key used to make requests with this Client
+    attr_reader :key
+
+    # @return [Hash<thing, Conversation>] the conversations initiated by this client
+    attr_reader :conversations
+
+    # Create a new Client
+    # @param key [String] API key
+    def initialize(key)
+      @key = key
+      @conversations = {}
+    end
+
+    # @param identifier [thing] identifier to search for
+    # @return [Conversation] the conversation associated with this identifier
+    def conversation(identifier = :default)
+      @conversations[identifier]
+    end
+
+    # Say something to the API
+    # @param message [String] what to say
+    # @param identifier [thing] identifier to associate this converation with
+    # @return [String] the response
+    def say(message, identifier = :default)
+      convo = conversation(identifier) || Conversation.new(key)
+      @conversations[identifier] = convo
+
+      convo.reply message
+    end
+
+    # Deletes a conversation
+    # @param identifier [thing] identifier associated with the conversation
+    # @return [Conversation] the removed conversation
+    def delete(identifier = :default)
+      @conversations.delete identifier
+    end
+  end
+end

data/lib/cleverbot/conversation.rb

@@ -0,0 +1,86 @@
+require 'cleverbot/api'
+
+module Cleverbot
+  # A conversation with the API
+  class Conversation
+    # @return [String] this conversation's hash, assigned by cleverbot
+    attr_reader :cs
+
+    # @return [String] the input given to this interaction
+    attr_reader :input
+
+    # @return [String] the output to this interaction
+    attr_reader :output
+    alias response output
+
+    # @return [Time] timestamp of this interaction
+    attr_reader :timestamp
+
+    # @return [Array<Hash>] interaction history in this conversation
+    attr_reader :interactions
+
+    # @return [Integer] number of interactions
+    attr_reader :interaction_count
+
+    # The API returns a lot of other arbitray information that may or may not
+    # be useful. The most common pieces of data have direct instance methods ;
+    # for anything else, look inside this hash.
+    # @return [Hash] all raw data about this conversation
+    attr_reader :data
+
+    # Start a new conversation with the API
+    # @param key [String] the API key used for this conversation
+    def initialize(key)
+      @key = key
+    end
+
+    # Replies to this conversation thread.
+    # @param message [String] the message to send
+    # @raise [ArgumentError] if message is empty
+    def reply(message)
+      raise ArgumentError, 'message cannot be empty' if message.empty?
+      update_data API.get_reply @key, message, cs
+      output
+    end
+
+    # Internally updates this conversation's data
+    # @param data [Hash] an API response hash to update from
+    private def update_data(data)
+      @data = data
+
+      @cs = data['cs']
+
+      @input = data['input']
+
+      @output = data['output']
+
+      @timestamp = Time.new(
+        data['time_year'],
+        data['time_month'],
+        data['time_day'],
+        data['time_hour'],
+        data['time_minute'],
+        data['time_second'],
+        0
+      )
+
+      @interactions = []
+
+      data.select { |k, _| k.start_with? 'interaction_' }.each do |k, v|
+        next if v.empty? || k == 'interaction_count'
+
+        index = k[/\d+/].to_i - 1
+
+        @interactions[index] ||= {}
+
+        if k =~ (/interaction_\d+$/)
+          @interactions[index][:input] = v
+        elsif k =~ (/interaction_\d+_other$/)
+          @interactions[index][:output] = v
+        end
+      end
+
+      @interaction_count = data['interaction_count'].to_i
+    end
+  end
+end

data/lib/cleverbot/version.rb

@@ -0,0 +1,3 @@
+module Cleverbot
+  VERSION = '1.0.1'
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: cbot
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Reaver01
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.6
+description: A fully featured wrapper to the Cleverbot.com web API.
+email:
+- jawmac@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- cleverbot.gemspec
+- lib/cleverbot.rb
+- lib/cleverbot/api.rb
+- lib/cleverbot/client.rb
+- lib/cleverbot/conversation.rb
+- lib/cleverbot/version.rb
+homepage: https://github.com/elieltavares/cleverbot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the Cleverbot.com web API.
+test_files: []