botkit 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 126b1d0a6961c78790abe15e3607474e0a2a61dc
-  data.tar.gz: fa8e1d968e252a674df3ffad99a8b4c50c9f2077
+SHA256:
+  metadata.gz: b12004b0814f182efafd158a86f5fef3abbaa00f77e3c62d38fda84c9dd7f6a5
+  data.tar.gz: 8c66a5e8c98ab503dd8dfb436fc7d23b525856773ae7c546d9d509472e34f3c6
 SHA512:
-  metadata.gz: c5f8cbbb4a6f76699393e2f247c117aa5c66a3f490f453d550e63d294c702df6d312cd2f79d21b28b4e55448c6c95646a85e6990082ff91b0be3c917be214d66
-  data.tar.gz: af27da77e98237b8d1861b44b53c379e264f8ba061f74cfb139b12715dfe56b3d16830cca631fcc6d006839f00d848f9b2ad24592aa18d78364aa4fc9d388aeb
+  metadata.gz: a8a1cd699b405cc96a6394be63e673ed6665425c5830672913cc5f6b6da981b1ab3d9c35a98d2578d5bfc4aee154b26a65b385c941c9a0673fd711c3523530e9
+  data.tar.gz: 0c2b8e81090040681b7282a31d184610f3e38c12c7c1fb8e0ff06a0ef27c13ed70aa8b79171aff3924ef5dff35b50e18542b3ddbb6f6c981dad86c1d3e458c19

data/.rubocop.yml

@@ -1,116 +1,9 @@
-AllCops:
-  TargetRubyVersion: 2.4
-
-Style/Alias:
-  EnforcedStyle: prefer_alias_method
-
-Style/FrozenStringLiteralComment:
-  EnforcedStyle: always
-
-Style/ClassCheck:
-  EnforcedStyle: kind_of?
-
-Metrics/LineLength:
-  Max: 80
-
-Style/BlockDelimiters:
-  Enabled: false
-
-Style/RegexpLiteral:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false
-
-Style/PerlBackrefs:
-  Enabled: false
-
-ClassLength:
-  Enabled: false
-
-CyclomaticComplexity:
-  Enabled: false
-
-Documentation:
-  Enabled: false
-
-Encoding:
-  Enabled: false
-
-FileName:
-  Enabled: false
-
-IfUnlessModifier:
-  Enabled: false
-
-MethodLength:
-  Enabled: false
+---
+inherit_gem:
+  rubocop-fnando: .rubocop.yml
 
-ModuleFunction:
-  Enabled: false
-
-OneLineConditional:
-  Enabled: false
-
-ParameterLists:
-  Enabled: false
-
-Proc:
-  Enabled: false
-
-SingleLineBlockParams:
-  Enabled: false
-
-VariableInterpolation:
-  Enabled: false
-
-Style/TrailingCommaInLiteral:
-  Enabled: false
-
-WhileUntilModifier:
-  Enabled: false
-
-PredicateName:
-  NamePrefixBlacklist:
-    - is_
-
-StringLiterals:
-  EnforcedStyle: double_quotes
-
-DotPosition:
-  EnforcedStyle: leading
-
-SpaceBeforeBlockBraces:
-  EnforcedStyle: space
-
-SpaceInsideBlockBraces:
-  EnforcedStyle: no_space
-
-DoubleNegation:
-  Enabled: false
-
-SpaceInsideBlockBraces:
-  SpaceBeforeBlockParameters: false
+AllCops:
+  TargetRubyVersion: 3.0
 
-SpaceInsideHashLiteralBraces:
+Metrics/ParameterLists:
   Enabled: false
-
-PercentLiteralDelimiters:
-  PreferredDelimiters:
-    '%':  '{}'
-    '%i': '{}'
-    '%q': '{}'
-    '%Q': '{}'
-    '%r': '{}'
-    '%s': '{}'
-    '%w': '{}'
-    '%W': '{}'
-    '%x': '{}'
-
-Style/CollectionMethods:
-  PreferredMethods:
-    collect: 'map'
-    collect!: 'map!'
-    inject: 'reduce'
-    detect: 'find'
-    find_all: 'select'

data/CODE_OF_CONDUCT.md

@@ -5,30 +5,30 @@
 In the interest of fostering an open and welcoming environment, we as
 contributors and maintainers pledge to making participation in our project and
 our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
+size, disability, ethnicity, gender identity and expression, level of
+experience, nationality, personal appearance, race, religion, or sexual identity
+and orientation.
 
 ## Our Standards
 
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
   address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Our Responsibilities
@@ -37,11 +37,11 @@ Project maintainers are responsible for clarifying the standards of acceptable
 behavior and are expected to take appropriate and fair corrective action in
 response to any instances of unacceptable behavior.
 
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening,
+offensive, or harmful.
 
 ## Scope
 
@@ -58,8 +58,9 @@ Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported by contacting the project team at fnando.vieira@gmail.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+obligated to maintain confidentiality with regard to the reporter of an
+incident. Further details of specific enforcement policies may be posted
+separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good
 faith may face temporary or permanent repercussions as determined by other
@@ -67,8 +68,8 @@ members of the project's leadership.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
 [version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }

data/Gemfile.lock

@@ -1,36 +1,66 @@
 PATH
   remote: .
   specs:
-    botkit (0.0.4)
+    botkit (0.0.6)
       aitch
-      signal
+      voltage
 
 GEM
   remote: https://rubygems.org/
   specs:
-    aitch (1.0.2)
-      nokogiri (>= 1.6.0)
-    docile (1.1.5)
-    json (2.1.0)
-    metaclass (0.0.4)
-    mini_portile2 (2.3.0)
-    minitest (5.10.3)
-    minitest-utils (0.4.0)
+    aitch (1.2.1)
+      nokogiri
+    ast (2.4.2)
+    docile (1.4.0)
+    json (2.6.3)
+    mini_portile2 (2.8.1)
+    minitest (5.16.3)
+    minitest-utils (0.4.8)
       minitest
-    mocha (1.3.0)
-      metaclass (~> 0.0.1)
-    nokogiri (1.8.1)
-      mini_portile2 (~> 2.3.0)
-    rake (12.2.1)
-    signal (1.1.0)
-    simplecov (0.15.1)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
+    mocha (2.0.2)
+      ruby2_keywords (>= 0.0.5)
+    nokogiri (1.13.10)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    racc (1.6.2)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rubocop (1.41.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-fnando (0.0.17)
+      rubocop
+      rubocop-performance
+    rubocop-performance (1.15.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.3.0)
+    voltage (0.1.0)
 
 PLATFORMS
-  ruby
+  arm64-darwin-22
 
 DEPENDENCIES
   botkit!
@@ -38,7 +68,8 @@ DEPENDENCIES
   minitest-utils
   mocha
   rake
+  rubocop-fnando
   simplecov
 
 BUNDLED WITH
-   1.16.0
+   2.4.1

data/README.md

@@ -1,15 +1,13 @@
 # Botkit
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/botkit`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Botkit is a framework for creating chatbots for different services.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'botkit'
+gem "botkit"
 ```
 
 And then execute:
@@ -22,22 +20,34 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To be written.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/botkit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at
+<https://github.com/fnando/botkit>. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the Botkit project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/botkit/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Botkit project’s codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/fnando/botkit/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -2,6 +2,7 @@
 
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rubocop/rake_task"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -9,4 +10,6 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task default: :test
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/botkit.gemspec

@@ -6,7 +6,9 @@ Gem::Specification.new do |spec|
   spec.name          = "botkit"
   spec.version       = Botkit::VERSION
   spec.authors       = ["Nando Vieira"]
-  spec.email         = ["fnando.vieira@gmail.com"]
+  spec.email         = ["me@fnando.com"]
+  spec.metadata      = {"rubygems_mfa_required" => "true"}
+  spec.required_ruby_version = ">= 3.0.0"
 
   spec.summary       = "A simple chatbot framework"
   spec.description   = spec.summary
@@ -21,11 +23,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "aitch"
-  spec.add_dependency "signal"
+  spec.add_dependency "voltage"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "minitest-utils"
   spec.add_development_dependency "mocha"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop-fnando"
   spec.add_development_dependency "simplecov"
 end

data/lib/botkit/bot.rb

@@ -2,12 +2,16 @@
 
 module Botkit
   class Bot
-    include Signal
+    include Voltage
 
     # When setting `bot.halt = true`, the bot will be halted
     # after the current loop.
     attr_writer :halt
 
+    def initialize
+      @halt = false
+    end
+
     # Detect if bot should halt himself from the loop.
     def halt?
       @halt
@@ -31,15 +35,14 @@ module Botkit
       end
     end
 
-    def parse_message(input, matcher = nil)
+    def parse_message(input)
       input = input.to_s
-      _, command, text = *input.match(%r{\A/([^ @]+)(?:@.*?bot)?(?:\s+(.*?))?\z}i)
-      matches = text.to_s.match(matcher) if matcher
+      _, command, text =
+        *input.match(%r{\A/([^ @]+)(?:@.*?bot)?(?:\s+(.*?))?\z}i)
 
       {
         command: command,
-        text: command ? text : input,
-        matches: matches&.named_captures
+        text: command ? text : input
       }
     end
 

data/lib/botkit/message.rb

@@ -2,15 +2,22 @@
 
 module Botkit
   class Message
-    attr_reader :text, :command, :matches, :raw, :options, :channel_id
+    attr_reader :text, :command, :raw, :options, :channel_id, :id
 
-    def initialize(text:, raw: {}, channel_id: nil, command: nil, matches: nil, options: {})
+    def initialize(
+      text:,
+      raw: {},
+      channel_id: nil,
+      command: nil,
+      options: {},
+      id: nil
+    )
       @text = text
       @command = command
       @raw = raw
       @channel_id = channel_id
       @options = options
-      @matches = matches
+      @id = id
     end
 
     def command?

data/lib/botkit/runner.rb

@@ -11,16 +11,18 @@ module Botkit
 
     def call
       loop do
-        next_tick
+        tick
+
         break if bot.halt?
+
         sleep(polling)
       end
     end
 
-    private def next_tick
+    private def tick
       bot.call
-    rescue StandardError => exception
-      bot.report_exception(exception)
+    rescue StandardError => error
+      bot.report_exception(error)
     end
   end
 end

data/lib/botkit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Botkit
-  VERSION = "0.0.4"
+  VERSION = "0.0.6"
 end

data/lib/botkit.rb

@@ -2,12 +2,12 @@
 
 module Botkit
   require "aitch"
-  require "signal"
+  require "voltage"
 
-  require "botkit/version"
-  require "botkit/runner"
-  require "botkit/message"
-  require "botkit/bot"
+  require_relative "botkit/version"
+  require_relative "botkit/runner"
+  require_relative "botkit/message"
+  require_relative "botkit/bot"
 
   def self.run(bot, **kwargs)
     Runner.new(bot, **kwargs).call

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: botkit
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Nando Vieira
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-11-12 00:00:00.000000000 Z
+date: 2022-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aitch
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: signal
+  name: voltage
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-fnando
+  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'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -110,14 +124,13 @@ dependencies:
         version: '0'
 description: A simple chatbot framework
 email:
-- fnando.vieira@gmail.com
+- me@fnando.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -135,8 +148,9 @@ files:
 homepage: https://rubygems.org/gems/botkit
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -144,16 +158,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.4.1
+signing_key:
 specification_version: 4
 summary: A simple chatbot framework
 test_files: []

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.2
-before_install: gem install bundler -v 1.16.0.pre.3