pandorified 0.9.3 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30b32026852ac65301471074c3d52e1e8b3ea6c32731ca9c98f06535675e79f8
-  data.tar.gz: dc22aad0edcf2df8a6ca5701f8a024ea5da5a5e85968b7d2fa1e5974fa6c682a
+  metadata.gz: da54a7eef98fa56bd4cbee2127471117c4d1e2f2817f0795b536ebd97eba103e
+  data.tar.gz: a24ce88afa82ffb4028963c1a6b90563db943b3a1cccacf0e208c6514bde8fa6
 SHA512:
-  metadata.gz: 7cb1a25a3fdf8870d6f88ba15d75fde4b6d26ee1e402bd6cd8c8df44b324b7a3cec286df8cf66aab66ce0d682cf210d89bd3227f4801556c95e173b0362823d7
-  data.tar.gz: fa7cffd1e5d0262a038c621ea05b4dd968c55900d9f838766329948a0b4c13934edd3f93b77784502167d4ef4c73e3d8252eed8cf35a8b7e63c4c2c88cb4c69d
+  metadata.gz: 073e357c7c05429957e73ddf61dc7d3e6b96d41015415b85be656d189ffefce48e9d8d36d910e0b07c0008c4eb29ead92afd5b1c337f25f79c4a28fe868c7e2c
+  data.tar.gz: 7defa51b36a8e15415c2ae221d549bb08571ecaf5eb17a824d109dd957211d336d9b0f390f6fa8f41b05620fe4c81495eb76d987a6fc526434062c6561620457

data/.gitignore

@@ -3,3 +3,4 @@
 .yardoc
 Gemfile.lock
 pkg/*
+doc/*

data/.rubocop.yml

@@ -0,0 +1,12 @@
+Metrics/BlockLength:
+  ExcludedMethods:
+    - describe
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
@@ -7,5 +9,5 @@ task default: :spec
 
 desc 'Open an irb session preloaded with this library'
 task :console do
-  sh "irb -rubygems -I lib -r pandorified.rb"
+  sh 'irb -rubygems -I lib -r pandorified.rb'
 end

data/lib/pandorified.rb

@@ -1,12 +1,21 @@
+# frozen_string_literal: true
+
 require 'pandorified/version'
 require 'pandorified/result'
 require 'pandorified/session'
 
+# This is the top-level module for interacting with the Pandorabots API.
+#
+# There are some sugar methods which delegate to {Pandorified::Session} under
+# the hood.
 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.
+  # 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.
@@ -19,10 +28,14 @@ module Pandorified
 
   # Send a message to a bot and receive a response (if successsful).
   #
-  # If Pandorabots responds 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 Pandorabots responds 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.
+  # 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.

data/lib/pandorified/result.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
+
 require 'rest_client'
 require 'nokogiri'
 
 module Pandorified
   API_URL = 'https://www.pandorabots.com/pandora/talk-xml'
 
+  # The result of sending a message to a bot, including the response message if
+  # successful.
   class Result
     def initialize(params)
       @xml = Nokogiri::XML(RestClient.post(API_URL, params))
@@ -14,7 +18,7 @@ module Pandorified
       @that ||= @xml.xpath('/result/that').first.text.strip
     end
 
-    alias_method :to_s, :that
+    alias to_s that
 
     # Check the status of this result. See {#success?} and {#error?}.
     #
@@ -23,29 +27,33 @@ module Pandorified
       @status ||= @xml.xpath('/result/@status').first.value.to_i
     end
 
-    # @return `true` if this result was successful (no error was returned by Pandorabots), `false` otherwise.
+    # @return `true` if this result was successful (no error was returned by
+    #   Pandorabots), `false` otherwise.
     def success?
-      self.status.zero?
+      status.zero?
     end
 
-    alias_method :ok?, :success?
-    alias_method :successful?, :success?
+    alias ok? success?
+    alias successful? success?
 
-    # @note After checking if there is an error, you can read the error message with {#message}.
+    # @note After checking if there is an error, you can read the error message
+    #   with {#message}.
     #
     # @return `true` if Pandorabots returned an error.
     def error?
-      !self.success?
+      !success?
     end
 
-    # @return [String] The error message as returned by Pandorabots, if an error occured.
+    # @return [String] The error message as returned by Pandorabots, if an
+    #   error occured.
     def message
-      return nil if self.success?
+      return nil if success?
+
       @message ||= @xml.xpath('/result/message').first.text
     end
 
-    alias_method :error, :message
-    alias_method :error_message, :message
+    alias error message
+    alias error_message message
 
     # @return [String] The botid of the bot this result is for.
     def botid

data/lib/pandorified/session.rb

@@ -1,16 +1,21 @@
+# frozen_string_literal: true
+
 require 'pandorified/result'
 
 module Pandorified
   # Raised when Pandorabots returns an API result with a non-zero status.
   class PandorabotsError < StandardError; end
 
+  # Represents a session (or conversation) for interacting with a bot.
   class Session
     # A new session for conversing with a bot.
     #
-    # @note If you choose not to specify a {custid}, one will be automatically chosen 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.
+    # @param [String] custid An identifier used to keep track of this
+    #   conversation.
     def initialize(botid, custid = nil)
       @botid = botid
       @custid = custid
@@ -18,29 +23,48 @@ module Pandorified
 
     # Send a message to this session's bot and receive a response.
     #
-    # 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.
+    # 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 [Pandorified::Result] The bot's response as a result object.
     def talk(input)
-      result = Pandorified::Result.new(botid: @botid, custid: @custid, input: input)
+      result = Pandorified::Result.new(
+        botid: @botid,
+        custid: @custid,
+        input: input
+      )
+
       @custid ||= result.custid if result.success?
+
       result
     end
 
-    # Send a message to this session's bot and receive a response (if successful).
+    # Send a message to this session's bot and receive a response (if
+    # successful).
     #
-    # 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.
+    # 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.
     #
     # @return [String] The bot's response text.
     def talk!(input)
-      result = self.talk(input)
-      raise Pandorified::PandorabotsError, "Pandorabots returned status #{result.status}: #{result.message}" if result.error?
+      result = talk(input)
+
+      if result.error?
+        msg = "Pandorabots returned status #{result.status}: #{result.message}"
+        raise Pandorified::PandorabotsError, msg
+      end
+
       result.that
     end
   end

data/lib/pandorified/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pandorified
-  VERSION = '0.9.3'
+  VERSION = '0.9.4'
 end

data/pandorified.gemspec

@@ -1,4 +1,6 @@
-$:.push File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 
 require 'pandorified/version'
 
@@ -8,16 +10,24 @@ Gem::Specification.new do |spec|
   spec.authors     = 'Justin Workman'
   spec.email       = 'xtagon@gmail.com'
   spec.summary     = 'A Ruby client for the Pandorabots API.'
-  spec.description = 'Pandorified makes it easy for your Ruby scripts to interact with chat bots hosted on Pandorabots.'
 
-  spec.files         = `git ls-files`.split("\n")
-  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.description = <<~DOC.chomp
+    Pandorified makes it easy for your Ruby scripts to interact with chat bots hosted on Pandorabots.
+  DOC
+
+  spec.files = `git ls-files`.split("\n")
+  spec.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  spec.executables =
+    `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rest-client', '>= 1.7.3'
   spec.add_runtime_dependency 'nokogiri', '>= 1.10.8'
+  spec.add_runtime_dependency 'rest-client', '>= 1.7.3'
 
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'yard'
 end

data/spec/lib/pandorified_spec.rb

@@ -1,44 +1,50 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-RSpec.describe Pandorified do
-  describe "#talk!" do
-    let(:input) { "Are you a robot?" }
-    let(:botid) { "np218q9s7r346nqo" }
+describe Pandorified do
+  describe '#talk!' do
+    let(:input) { 'Are you a robot?' }
+    let(:botid) { 'np218q9s7r346nqo' }
     let(:custid) { nil }
 
     let(:request_body) do
       {
-        "botid" => botid,
-        "custid" => nil,
-        "input" => input
+        'botid' => botid,
+        'custid' => nil,
+        'input' => input
       }
     end
 
-    context "when successful" do
+    context 'when successful' do
       subject { described_class.talk!(input, botid, custid) }
 
-      let(:that) { "Of course not!" }
+      let(:that) { 'Of course not!' }
 
       let(:response_body) do
         <<~XML
-        <result status="0" botid="#{botid}" custid="fec7cfc40e5b751a"><input>#{input}</input><that>#{that}</that></result>"
+          <result status="0" botid="#{botid}" custid="fec7cfc40e5b751a"><input>#{input}</input><that>#{that}</that></result>"
         XML
       end
 
       let(:response_headers) do
-        {content_type: "text/xml"}
+        { content_type: 'text/xml' }
       end
 
       before :each do
-        stub_request(:post, "https://www.pandorabots.com/pandora/talk-xml").
-          with(body: request_body).
-          to_return(status: 200, body: response_body, headers: response_headers)
+        stub_request(:post, 'https://www.pandorabots.com/pandora/talk-xml')
+          .with(body: request_body)
+          .to_return(
+            status: 200,
+            body: response_body,
+            headers: response_headers
+          )
       end
 
       it { is_expected.to eq(that) }
     end
 
-    context "when unsuccessful" do
+    context 'when unsuccessful' do
       pending { is_expected.to raise_error(described_class::PandorabotsError) }
     end
   end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pandorified'
 
 require 'webmock/rspec'
@@ -48,57 +50,64 @@ RSpec.configure do |config|
   # triggering implicit auto-inclusion in groups with matching metadata.
   config.shared_context_metadata_behavior = :apply_to_host_groups
 
-# The settings below are suggested to provide a good initial experience
-# with RSpec, but feel free to customize to your heart's content.
-=begin
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+
   # This allows you to limit a spec run to individual examples or groups
   # you care about by tagging them with `:focus` metadata. When nothing
   # is tagged with `:focus`, all examples get run. RSpec also provides
   # aliases for `it`, `describe`, and `context` that include `:focus`
   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
-  config.filter_run_when_matching :focus
+  #
+  #   config.filter_run_when_matching :focus
 
   # Allows RSpec to persist some state between runs in order to support
   # the `--only-failures` and `--next-failure` CLI options. We recommend
   # you configure your source control system to ignore this file.
-  config.example_status_persistence_file_path = "spec/examples.txt"
+  #
+  #   config.example_status_persistence_file_path = "spec/examples.txt"
 
   # Limits the available syntax to the non-monkey patched syntax that is
   # recommended. For more details, see:
   #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
   #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
   #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
-  config.disable_monkey_patching!
+  #
+  #   config.disable_monkey_patching!
 
   # This setting enables warnings. It's recommended, but in some cases may
   # be too noisy due to issues in dependencies.
-  config.warnings = true
+  #
+  #   config.warnings = true
 
   # Many RSpec users commonly either run the entire suite or an individual
   # file, and it's useful to allow more verbose output when running an
   # individual spec file.
-  if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
-    config.default_formatter = "doc"
-  end
+  #
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = "doc"
+  #   end
 
   # Print the 10 slowest examples and example groups at the
   # end of the spec run, to help surface which specs are running
   # particularly slow.
-  config.profile_examples = 10
+  #
+  #   config.profile_examples = 10
 
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing
   # the seed, which is printed after each run.
   #     --seed 1234
-  config.order = :random
+  #
+  #   config.order = :random
 
   # Seed global randomization in this process using the `--seed` CLI option.
   # Setting this allows you to use `--seed` to deterministically reproduce
   # test failures related to randomization by passing the same `--seed` value
   # as the one that triggered the failure.
-  Kernel.srand config.seed
-=end
+  #
+  #   Kernel.srand config.seed
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pandorified
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors:
 - Justin Workman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2020-03-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.8
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -25,21 +39,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.7.3
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.10.8
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.10.8
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Pandorified makes it easy for your Ruby scripts to interact with chat
   bots hosted on Pandorabots.
 email: xtagon@gmail.com
@@ -75,6 +103,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - Gemfile
 - README.md
 - Rakefile