boppers 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b39066d054834c66ba916b57228d1239a2cc4915b26f4d89d6d10c725ab9e8d
-  data.tar.gz: ade59801762cdd4c474a630c7875577b2ccba8811bc7e4f7b029398323a03a51
+  metadata.gz: 737a54c67e4b1622b880bac2d5019faae412a54847fa7d60993ce9aa3dc46f61
+  data.tar.gz: 9a0a2c78ff8fbfcdc00ec10c934dc735ec0b085a813798acc0f46272afdc3711
 SHA512:
-  metadata.gz: 7b8987fb52a03b5d5e3c61e6966f0c5eb6ca273d7da43cba81d16188059b07768c9cda5d74478cb36dded7216ac257c02dffec12cc2d7b1ccd9d90ddeb31f0be
-  data.tar.gz: ec1b3109599004b3363c0da994eb0372809bf3d7f2429e8dc134861f82fc46b86a515c7fe3bab41e5380fba2d9f612dd17f725ecb3283804a093acf28c3bd6ae
+  metadata.gz: c145e2386add5865634f5c059694decdc5d87b711a1bbf8ad95c4796280bb1ec99e1828f4bbedb4a9fa6a5190ca58c226bc055ffa5b8bcbfedbc61eea6c97a65
+  data.tar.gz: 772ab179bdc8a9771a4b1e67ab59856fe6374e6ba580f115649602a20c4b5c6093bb352c78fd9c7dc23fbf4aeb2332e0a89d4f8b749f4904cd27bbc4fdd11896

data/.rubocop.yml

@@ -1,116 +1,10 @@
-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
-
-ModuleFunction:
-  Enabled: false
+---
+inherit_gem:
+  rubocop-fnando: .rubocop.yml
 
-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
-
-SpaceInsideHashLiteralBraces:
-  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'
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  Exclude:
+    - vendor/**/*
+    - gemfiles/**/*

data/Gemfile.lock

@@ -0,0 +1,139 @@
+PATH
+  remote: .
+  specs:
+    boppers (0.0.11)
+      aitch
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    aitch (1.2.1)
+      nokogiri
+    awesome_print (1.9.2)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    buftok (0.2.0)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    date (3.3.3)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    docile (1.4.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    equalizer (0.0.11)
+    excon (0.95.0)
+    ffi (1.15.5)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    http (4.4.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http-parser (1.2.3)
+      ffi-compiler (>= 1.0, < 2.0)
+    http_parser.rb (0.6.0)
+    ice_nine (0.11.2)
+    mail (2.8.0)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    memoizable (0.4.2)
+      thread_safe (~> 0.3, >= 0.3.1)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.16.3)
+    minitest-utils (0.4.8)
+      minitest
+    multipart-post (2.2.3)
+    naught (1.1.0)
+    net-imap (0.3.4)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.3.3)
+      net-protocol
+    nokogiri (1.13.10-arm64-darwin)
+      racc (~> 1.4)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    pry-meta (0.0.10)
+      awesome_print
+      pry
+      pry-byebug
+      pry-remote
+    pry-remote (0.1.8)
+      pry (~> 0.9)
+      slop (~> 3.0)
+    public_suffix (5.0.1)
+    racc (1.6.2)
+    rake (13.0.6)
+    simple_oauth (0.3.1)
+    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)
+    slop (3.6.0)
+    telegram_bot (0.0.8)
+      excon (>= 0.30.0)
+      virtus (>= 1.0.0)
+    thor (1.2.1)
+    thread_safe (0.3.6)
+    timeout (0.3.1)
+    twitter (7.0.0)
+      addressable (~> 2.3)
+      buftok (~> 0.2.0)
+      equalizer (~> 0.0.11)
+      http (~> 4.0)
+      http-form_data (~> 2.0)
+      http_parser.rb (~> 0.6.0)
+      memoizable (~> 0.4.0)
+      multipart-post (~> 2.0)
+      naught (~> 1.0)
+      simple_oauth (~> 0.3.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+    virtus (2.0.0)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  boppers!
+  bundler
+  mail
+  minitest-utils
+  pry-meta
+  rake
+  simplecov
+  telegram_bot
+  twitter
+
+BUNDLED WITH
+   2.3.26

data/README.md

@@ -1,8 +1,5 @@
-![Boppers](https://github.com/fnando/boppers/raw/master/images/logo.png)
+![Boppers](https://github.com/fnando/boppers/raw/main/images/logo.png)
 
-[![Travis-CI](https://travis-ci.org/fnando/boppers.png)](https://travis-ci.org/fnando/boppers)
-[![GPA](https://codeclimate.com/github/fnando/boppers/badges/gpa.svg)](https://codeclimate.com/github/fnando/boppers)
-[![Test Coverage](https://codeclimate.com/github/fnando/boppers/badges/coverage.svg)](https://codeclimate.com/github/fnando/boppers)
 [![Gem](https://img.shields.io/gem/v/boppers.svg)](https://rubygems.org/gems/boppers)
 [![Gem](https://img.shields.io/gem/dt/boppers.svg)](https://rubygems.org/gems/boppers)
 
@@ -26,11 +23,13 @@ Or install it yourself as:
 
 ## Using the CLI
 
-To create a new app, use `boppers app [YOUR APP NAME]`. This will generate a structure so you can just configure your boppers and notifiers.
+To create a new app, use `boppers app [YOUR APP NAME]`. This will generate a
+structure so you can just configure your boppers and notifiers.
 
 ## Boppers
 
-A bopper is a bot. Basically is a class that responds to `#call`. For instance, a lambda.
+A bopper is a bot. Basically is a class that responds to `#call`. For instance,
+a lambda.
 
 ```ruby
 Boppers.configure do |config|
@@ -40,7 +39,9 @@ Boppers.configure do |config|
 end
 ```
 
-By default, boppers are executed every 60 seconds. If you create a class, you can define your custom interval by creating a method `#interval`. The following example changes the interval to `15 seconds`.
+By default, boppers are executed every 60 seconds. If you create a class, you
+can define your custom interval by creating a method `#interval`. The following
+example changes the interval to `15 seconds`.
 
 ```ruby
 class Clock
@@ -58,11 +59,15 @@ Boppers.configure do |config|
 end
 ```
 
-The `Boppers.notify` method expects a event name (the recommended value is the bot's name), a title, message and a hash of options (it's up to the notifier to use the options).
+The `Boppers.notify(event_name, title: message: options: {})` method expects a
+event name (the recommended value is the bot's name), a title, message and a
+hash of options (it's up to the notifier to use the options).
 
 ### Distributing boppers
 
-I encourage you to share your boppers. I even added a command to generate a common structure, so you don't have to think about how to organize it. Let's say you want to distribute the clock bopper above.
+I encourage you to share your boppers. I even added a command to generate a
+common structure, so you don't have to think about how to organize it. Let's say
+you want to distribute the clock bopper above.
 
 ```
 $ boppers plugin clock --type bopper
@@ -85,15 +90,21 @@ require "boppers/clock/version"
 module Boppers
   class Clock
     def call
-      Boppers.notify(:clock, title: "Clock", message: "Now is #{Time.now}")
+      Boppers.notify(
+        :clock,
+        title: "Clock",
+        message: "Now is #{Time.now}"
+      )
     end
   end
 end
 ```
 
-Change the `boppers-clock.gemspec` file accordingly (add a description, author name and email).
+Change the `boppers-clock.gemspec` file accordingly (add a description, author
+name and email).
 
-If you're writing tests, use `Boppers::Testing::BopperLinter` to lint your bopper (some basic validations will be made).
+If you're writing tests, use `Boppers::Testing::BopperLinter` to lint your
+bopper (some basic validations will be made).
 
 ```ruby
 # frozen_string_literal: true
@@ -108,11 +119,14 @@ class BoppersClockTest < Minitest::Test
 end
 ```
 
-Then make a commit and run `rake release` to distribute it (I'm assuming your Rubygems account is already configured).
+Then make a commit and run `rake release` to distribute it (I'm assuming your
+Rubygems account is already configured).
 
 ## Notifiers
 
-A notifier is basically a class that responds to `#call(title, message, options)`. The following example implements a `stderr` notifier.
+A notifier is basically a class that responds to
+`#call(title, message, options)`. The following example implements a `stderr`
+notifier.
 
 ```ruby
 class Stderr
@@ -134,7 +148,8 @@ Boppers.configure do |config|
 end
 ```
 
-You can specify which messages a notifier will receive by setting `subscribe:`, like the following:
+You can specify which messages a notifier will receive by setting `subscribe:`,
+like the following:
 
 ```ruby
 Boppers.configure do |config|
@@ -142,11 +157,15 @@ Boppers.configure do |config|
 end
 ```
 
-Now this notifier will only be triggered when `Boppers.notify(:clock, *args)` is called, ignoring other boppers.
+Now this notifier will only be triggered when `Boppers.notify(:clock, **kargs)`
+is called, ignoring other boppers.
 
 ### Distributing notifiers
 
-The idea is pretty much the same as creating a bopper. Use the command `boppers plugin [NAME] --type notifier` to generate a file structure. Then configure the plugin accordingly. There's a a linter for notifiers: `Boppers::Testing::NotifierLinter`.
+The idea is pretty much the same as creating a bopper. Use the command
+`boppers plugin [NAME] --type notifier` to generate a file structure. Then
+configure the plugin accordingly. There's a a linter for notifiers:
+`Boppers::Testing::NotifierLinter`.
 
 ### Available notifiers
 
@@ -162,7 +181,8 @@ By default, Boppers comes with the following notifiers.
 
 #### Hipchat
 
-1. Create a "Send Notification" room API token at `https://[SUBDOMAIN].hipchat.com/rooms`.
+1. Create a "Send Notification" room API token at
+   `https://[SUBDOMAIN].hipchat.com/rooms`.
 2. The room id is available at the "Summary" section as "API ID".
 
 ```ruby
@@ -223,10 +243,13 @@ end
 
 #### Telegram
 
-1. [Create a bot](https://core.telegram.org/bots#6-botfather). The returned API token must be defined as `api_token:`.
+1. [Create a bot](https://core.telegram.org/bots#6-botfather). The returned API
+   token must be defined as `api_token:`.
 2. Send a message to the bot.
-3. Run `ruby setup/telegram.rb` locally to get the channel id. You may need to install the dependencies with `bundle install` before doing it so.
-4. Set the channel  as `channel_id: <channel id>`. Sometimes id can be a negative number and this is important.
+3. Run `ruby setup/telegram.rb` locally to get the channel id. You may need to
+   install the dependencies with `bundle install` before doing it so.
+4. Set the channel as `channel_id: <channel id>`. Sometimes id can be a negative
+   number and this is important.
 
 ```ruby
 Boppers.configure do |config|
@@ -237,15 +260,18 @@ Boppers.configure do |config|
 end
 ```
 
-You can run `boppers setup telegram`, which will basically guide like those steps above. No tokens will be saved locally or remotely in any form.
+You can run `boppers setup telegram`, which will basically guide like those
+steps above. No tokens will be saved locally or remotely in any form.
 
 #### Twitter
 
 1. Create an user for your bot.
 2. Follow your bot, and make your bot follow you.
-3. Create a new Twitter application under your bot's account at https://apps.twitter.com/app/new
+3. Create a new Twitter application under your bot's account at
+   https://apps.twitter.com/app/new
 4. Go to "Keys and Access Tokens" and create a new access token.
-5. Set `consumer_key:`, `consumer_secret:`, `access_token:` and `access_secret:` named arguments, all available under "Keys and Access Token".
+5. Set `consumer_key:`, `consumer_secret:`, `access_token:` and `access_secret:`
+   named arguments, all available under "Keys and Access Token".
 6. Set the user that'll receive the notification as `user: <username>`.
 
 ```ruby
@@ -262,9 +288,13 @@ end
 
 ## Deploying to Heroku
 
-I'm assuming you installed the gem with `gem install boppers` and generated your app.
+I'm assuming you installed the gem with `gem install boppers` and generated your
+app.
 
-Add your configuration to `config/boppers.rb`. Also make sure you don't hardcode any sensitive value, like API tokens or passwords. Use [env_vars](https://rubygems.org/gems/env_vars) to manage access to your environment variables.
+Add your configuration to `config/boppers.rb`. Also make sure you don't hardcode
+any sensitive value, like API tokens or passwords. Use
+[superconfig](https://rubygems.org/gems/superconfig) to manage access to your
+environment variables.
 
 Now, configure Heroku. Create a new app for this.
 
@@ -289,7 +319,7 @@ Make a commit and deploy to your Heroku account.
 ```
 git add .
 git commit -m "Initial commit"
-git push heroku master
+git push heroku main
 ```
 
 Scale up the boppers worker:
@@ -306,18 +336,30 @@ heroku dyno:type worker=hobby
 
 ## 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/fnando/boppers. 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/boppers. 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 Boppers project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fnando/boppers/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Boppers project’s codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/fnando/boppers/blob/main/CODE_OF_CONDUCT.md).

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "boppers"

data/boppers.gemspec

@@ -6,29 +6,31 @@ Gem::Specification.new do |spec|
   spec.name          = "boppers"
   spec.version       = Boppers::VERSION
   spec.authors       = ["Nando Vieira"]
-  spec.email         = ["fnando.vieira@gmail.com"]
+  spec.email         = ["me@fnando.com"]
 
   spec.summary       = "A simple bot framework for individuals."
   spec.description   = spec.summary
   spec.homepage      = "https://rubygems.org/gems/boppers"
   spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+  spec.metadata = {"rubygems_mfa_required" => "true"}
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "thor"
   spec.add_dependency "aitch"
+  spec.add_dependency "thor"
 
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "mail"
   spec.add_development_dependency "minitest-utils"
-  spec.add_development_dependency "simplecov"
   spec.add_development_dependency "pry-meta"
-  spec.add_development_dependency "mail"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "simplecov"
   spec.add_development_dependency "telegram_bot"
   spec.add_development_dependency "twitter"
 end

data/lib/boppers/cli.rb

@@ -21,7 +21,7 @@ module Boppers
     end
 
     desc "version", "Prints the Boppers version information"
-    map %w{-v --version} => :version
+    map %w[-v --version] => :version
 
     def version
       say "Boppers v#{VERSION}"
@@ -36,7 +36,7 @@ module Boppers
     def plugin(name)
       require "boppers/generator/plugin"
 
-      unless %w{bopper notifier}.include?(options[:type])
+      unless %w[bopper notifier].include?(options[:type])
         message = "ERROR: --type needs to be either 'bopper' or 'notifier'"
         shell.error shell.set_color(message, :red)
         exit 1

data/lib/boppers/generator/app/Gemfile

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gem "boppers"
-gem "env_vars"
+gem "superconfig"
 
 # Search for plugins:
 # https://rubygems.org/search?query=boppers

data/lib/boppers/generator/app/config/boppers.rb

@@ -8,7 +8,7 @@ Bundler.require
 # information about notifiers.
 require "boppers/notifier/stdout"
 
-Config = Env::Vars.new do
+Config = SuperConfig.new do
   # mandatory :sendgrid_username, string
   # mandatory :sendgrid_password, string
   # mandatory :sendgrid_domain, string
@@ -50,7 +50,12 @@ Boppers.configure do |config|
   # A bopper is anything that responds to #call, like a lambda.
   # The following example returns the current time.
   config.boppers << lambda do
-    Boppers.notify("Current time", "Now is #{Time.now}")
+    $stdout.sync = true
+    Boppers.notify(
+      :time,
+      title: "Current time",
+      message: "Now is #{Time.now}"
+    )
   end
 
   # A bopper can also configure the polling interval by defining a
@@ -68,7 +73,11 @@ Boppers.configure do |config|
   #
   #   def call
   #     @count += 1
-  #     Boppers.notify("Counter", "[#{Time.now}] Current count is #{@count}")
+  #     Boppers.notify(
+  #       :counter,
+  #       title: "Counter",
+  #       message: "[#{Time.now}] Current count is #{@count}"
+  #     )
   #   end
   # end
   #

data/lib/boppers/generator/app.rb

@@ -12,10 +12,10 @@ module Boppers
       end
 
       def copy_files
-        copy_file "gems.rb"
+        copy_file "Gemfile"
         copy_file "Procfile"
         copy_file "config/boppers.rb"
-        copy_file ".gitgnore"
+        copy_file ".gitignore"
         copy_file ".env"
       end