lobstersbot 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69f8315be206c88998ff12791d13b5fcce6a947b51eed928be0811f14a65700b
-  data.tar.gz: afae0e599f4a71512dc750baad1a84c7fb9c17807a10a680bdaaf7e86eb3f3f7
+  metadata.gz: 68c53d90cc65d235b50060bdf775931f8e72048c7a38e5ea26b1e91431126b6c
+  data.tar.gz: 2cdda10f35bf5692f5941926473737e1fccf69db756c32307cbb5ac0b9873253
 SHA512:
-  metadata.gz: 70d84d584628b2a6a6d37218a77b0ac95a5a072f17fe5f911a4ac6a485b897d7e14e25600f4ddbd4668a2e7967260ddb389ce6d53a16166ca5d216ca7889aad8
-  data.tar.gz: 2491273ecb1a31c4950cf6852b45c94ca4cb0b9570242e2502f7b7aac1c2bf546e17cf08a607e8d5f2908d528475c49e7ff3b0d7625cc92ef84fb9705893e4d4
+  metadata.gz: ce6a93ce8dae08db804359901291248207428ad74c5c66555cf49f62281427e235cd24431b609265446a75965e35942d07e52af67abcd52ff3c02759a3844016
+  data.tar.gz: 500edebf6ce3e758fe2e0a53d1ab501de5319952b8dfa107cbe96b0f19e8c8535ef7f6e5958ec809e5bbe202c0b3cacfbc2cad38f7d3414998ab69a2234d6b67

data/.github/workflows/gem.yml

@@ -0,0 +1,37 @@
+---
+name: Gem
+on: push
+
+jobs:
+  rspec:
+    name: Rspec
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+      - name: Run Suite
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rspec
+  rubocop:
+    name: Rubocop
+    runs-on: ubuntu-latest
+  
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+      - name: Run Rubocop
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rubocop          

data/.rubocop.yml

@@ -0,0 +1,253 @@
+# Please do not 'fix' style issues without a compelling, metrics-driven
+# argument that a style change will materially improve cod equality.
+# https://github.com/lobsters/lobsters/pull/460
+
+# Project setup:
+require:
+  - rubocop-rspec
+AllCops:
+  Include:
+    - '**/*.rb'
+    - '**/Rakefile'
+    - '**/config.ru'
+    - '**/*.rake'
+  Exclude:
+    - Gemfile
+    - 'bin/**/*'
+    - 'db/**/*'
+    - 'vendor/**/*'
+
+# Cop configuration:
+
+# Bundler
+
+# Gemspec
+
+# Layout
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+Layout/ArrayAlignment:
+  Enabled: false
+Layout/CaseIndentation:
+  EnforcedStyle: end
+Layout/ElseAlignment:
+  Enabled: false
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+Layout/EmptyLinesAroundExceptionHandlingKeywords:
+  Enabled: false
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+Layout/HashAlignment:
+  Enabled: false
+Layout/LineLength:
+  Max: 100
+Layout/MultilineMethodCallBraceLayout:
+  Enabled: false
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+Layout/SpaceAroundOperators:
+  Enabled: false
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+  SpaceBeforeBlockParameters: false
+Layout/SpaceInsideRangeLiteral:
+  Enabled: false
+
+# Lint
+Lint/SuppressedException:
+  Enabled: false
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+
+# Metrics
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/BlockNesting:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+# Naming
+Naming/AccessorMethodName:
+  Enabled: false
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+Naming/PredicateName:
+  Enabled: false
+# disabled until class vaiables in extras become constants
+Naming/MethodParameterName:
+  Enabled: false
+Naming/VariableName:
+  Enabled: false
+
+# Performance
+
+# RSpec
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/DescribedClass:
+  Enabled: false
+RSpec/MessageSpies:
+  Enabled: false
+RSpec/VerifiedDoubles:
+  Enabled: false
+RSpec/NotToNot:
+  Enabled: false
+RSpec/ContextWording:
+  Enabled: false
+RSpec/ExpectChange:
+  Enabled: false
+RSpec/HookArgument:
+  Enabled: false
+RSpec/ExampleWording:
+  Enabled: false
+RSpec/NamedSubject:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: false
+RSpec/AnyInstance:
+  Enabled: false
+RSpec/UnspecifiedException:
+  Enabled: false
+RSpec/InstanceVariable:
+  Enabled: false
+RSpec/BeforeAfterAll:
+  Enabled: false
+RSpec/DescribeClass:
+  Enabled: false
+Capybara/FeatureMethods:
+  Enabled: false
+
+# Security
+
+# Style
+Style/AndOr:
+  EnforcedStyle: conditionals
+Style/BlockDelimiters:
+  Enabled: false
+Style/BlockComments:
+  Enabled: false
+Style/CommentedKeyword:
+  Enabled: false
+Style/ClassVars:
+  Enabled: false
+Style/ConditionalAssignment:
+  Enabled: false
+# It would be nice to have this on, but I'm not up for writing 66 of these in
+# the process of addressing the initial 4,489 cop warnings.
+Style/Documentation:
+  Enabled: false
+  Exclude: [db/migrate/**/*, spec/**/*, test/**/*]
+Style/DoubleNegation:
+  Enabled: false
+Style/EachWithObject:
+  Enabled: false
+Style/ExpandPathArguments:
+  Enabled: false
+Style/FormatString:
+  Enabled: false
+Style/FormatStringToken:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+Style/GuardClause:
+  Enabled: false
+Style/HashEachMethods:
+  Enabled: true
+Style/HashSyntax:
+  EnforcedStyle: no_mixed_keys
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/IfInsideElse:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
+Style/InverseMethods:
+  Enabled: false
+Style/Lambda:
+  Enabled: false
+Style/LineEndConcatenation:
+  Enabled: false
+Style/MethodDefParentheses:
+  Enabled: false
+Style/MultilineBlockChain:
+  Enabled: false
+Style/MultilineTernaryOperator:
+  Enabled: false
+Style/NegatedIf:
+  EnforcedStyle: postfix
+Style/NegatedWhile:
+  Enabled: false
+Style/Next:
+  Enabled: false
+Style/NonNilCheck:
+  Enabled: false
+Style/NumericPredicate:
+  Enabled: false
+Style/ParallelAssignment:
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  Enabled: false
+Style/PerlBackrefs:
+  Enabled: false
+Style/RaiseArgs:
+  EnforcedStyle: compact
+Style/RedundantBegin:
+  Enabled: false
+Style/RedundantParentheses:
+  Enabled: false
+Style/RedundantReturn:
+  Enabled: false
+Style/RedundantSelf:
+  Enabled: false
+Style/RescueModifier:
+  Enabled: false
+Style/RescueStandardError:
+  EnforcedStyle: implicit
+Style/RegexpLiteral:
+  AllowInnerSlashes: true
+Style/SafeNavigation:
+  Enabled: false
+Style/SignalException:
+  Enabled: false
+Style/StringLiterals:
+  Enabled: false
+Style/SymbolArray:
+  EnforcedStyle: brackets
+Style/TrailingCommaInArguments:
+  Enabled: false
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/WhileUntilDo:
+  Enabled: false
+Style/WhileUntilModifier:
+  Enabled: false
+Style/WordArray:
+  Enabled: false
+Style/YodaCondition:
+  Enabled: false
+Style/ZeroLengthPredicate:
+  Enabled: false

data/exe/lobstersbot

@@ -1,12 +1,14 @@
-#!/usr/local/bin/ruby -w
+#!/usr/bin/env -S ruby -w
 
 require 'lobstersbot'
 
 class Bot < Summer::Connection
+  include Lobstersbot::SummerPatches
   include Lobstersbot::PluggableConnection
-  
+
   include Lobstersbot::Tell
   include Lobstersbot::Rss
+  include Lobstersbot::Salute
 end
 
 Bot.new("irc.freenode.net")

data/lib/lobstersbot.rb

@@ -7,10 +7,12 @@ require 'timers'
 
 require 'lobstersbot/version'
 require 'lobstersbot/rss_reader'
+require 'lobstersbot/summer_patches'
 require 'lobstersbot/pluggable_connection'
 
 require 'lobstersbot/plugins/tell'
 require 'lobstersbot/plugins/rss'
+require 'lobstersbot/plugins/salute'
 
 module Lobstersbot
   class Error < StandardError; end

data/lib/lobstersbot/pluggable_connection.rb

@@ -1,45 +1,73 @@
 module Lobstersbot
   module PluggableConnection
-    def config_dir(file)
-      File.join(ARGV[0], file)
+    @@triggers = [
+      # The default command handler.
+      [
+        0,
+        /\A\.(?<command>[a-z]+)\s(?<message>.+)\z/i,
+        lambda do |bot, channel, nick, match|
+          bot.evaluate(:"on_#{match[:command]}", channel, nick, match[:message])
+        end,
+      ],
+    ]
+
+    def self.triggers
+      @@triggers
     end
-  
-    def load_config
-      @config = HashWithIndifferentAccess.new(YAML.load_file(config_dir('lobstersbot.yml')))
+
+    def self.included(mod)
+      mod.extend(ClassMethods)
     end
-    
+
+    module ClassMethods
+      def add_trigger(priority, regex, handler)
+        PluggableConnection.triggers << [priority, regex, handler]
+      end
+    end
+
+    def respond(channel, nick, msg)
+      privmsg("#{nick}: #{msg}", channel)
+    end
+
     def did_start_up
       pp ARGV
       @timers = Timers::Group.new
       @memory = PStore.new(config_dir('memory.pstore'), true)
-      
+
+      # Sort the triggers by priority.
+      @@triggers.sort! {|a, b| b[0] <=> a[0] }
+
       @timers.every(60) { evaluate(:frequently) }
       Thread.new { loop { @timers.wait } }
     end
-    
+
     def channel_message(sender, channel, message)
-      request = message.match(/\A\.(?<command>[a-z]+)\s(?<message>.+)\z/i)
-      return unless request
-      response_proc = ->(msg) { privmsg("#{sender[:nick]}: #{msg}", channel) }
-      
-      evaluate(:"on_#{request[:command]}", sender[:nick], request[:message], response_proc)
+      match = nil
+
+      _, _, handler = @@triggers.find do |trigger|
+        match = message.match(trigger[1])
+        !match.nil?
+      end
+      return unless match
+
+      handler.call(self, channel, sender[:nick], match)
     end
-    
+
     def join_event(sender, channel)
       response_proc = ->(msg) { privmsg("#{sender[:nick]}: #{msg}", channel) }
       evaluate(:seen, sender[:nick], response_proc)
     end
-    
+
     def evaluate(group, *args)
-      matching = public_methods.select { |m| m.to_s.start_with?(group.to_s) }
-      
+      matching = public_methods.select {|m| m.to_s.start_with?(group.to_s) }
+
       matching.each do |match|
         slice_name = match.to_s.sub("#{group}_", '').to_sym
         @memory.transaction do
-          slice = @memory[slice_name] ||= Hash.new
+          slice = @memory[slice_name] ||= {}
           method(match).call(slice, *args)
         end
       end
     end
   end
-end
+end

data/lib/lobstersbot/plugins/rss.rb

@@ -1,13 +1,13 @@
 module Lobstersbot
   module Rss
     def frequently_post_stories(
-      memory, 
+      memory,
       reader = RssReader.new('https://lobste.rs/newest.rss')
     )
       reader.call(memory[:last_run]).each do |story|
-        @config[:channels].each { |c| privmsg(story, c) }
+        @config[:channels].each {|c| privmsg(story, c) }
       end
       memory[:last_run] = Time.now.to_i
     end
   end
-end
+end

data/lib/lobstersbot/plugins/salute.rb

@@ -0,0 +1,18 @@
+module Lobstersbot
+  module Salute
+    @@claws = ['(V)', '(\\/)', '(\\_/)', 'V', 'v', '(v)']
+    @@faces = ['_!_!_', '.v.', '_00_']
+
+    def salute_user(channel)
+      claws = @@claws.sample 2
+      face = @@faces.sample
+      lobster = claws[0] + face + claws[1]
+      privmsg(lobster, channel)
+    end
+
+    def self.included(mod)
+      handler = ->(bot, channel, _nick, _match) { bot.salute_user channel }
+      mod.add_trigger(100, /\AV.v.V\z/i, handler)
+    end
+  end
+end

data/lib/lobstersbot/plugins/tell.rb

@@ -1,19 +1,19 @@
 module Lobstersbot
   module Tell
-    def on_tell(memory, nick, message, response)
+    def on_tell(memory, channel, nick, message)
       parsed = message.match(/(?<target>[^\s]+)\s(?<message>.+)/)
       return unless parsed
-      
+
       target = parsed[:target]
-      memory[target] ||= Array.new
+      memory[target] ||= []
       memory[target] << "#{nick}: #{parsed[:message]}"
-      
-      response.call("I'll pass that along when #{target} is around.")
+
+      respond(channel, nick, "I'll pass that along when #{target} is around.")
     end
-    
+
     def seen_tell(memory, nick, response)
       return unless memory[nick].is_a? Array
-      memory[nick].each { |msg| response.call(msg) }
+      memory[nick].each {|msg| response.call(msg) }
     end
   end
-end
+end

data/lib/lobstersbot/rss_reader.rb

@@ -3,31 +3,31 @@ require 'rss'
 
 module Lobstersbot
   class RssReader
-    FORMAT = '%s %s (%s) - %s'
-    USERNAME_REGXP = /\((?<username>.+)\)/i
-    
+    FORMAT = '%s %s (%s) - %s'.freeze
+    USERNAME_REGXP = /\((?<username>.+)\)/i # rubocop:disable Style/MutableConstant
+
     def initialize(endpoint, open_proc = URI.method(:open))
       @endpoint = endpoint
       @open = open_proc
     end
-    
+
     def call(not_before)
       feed = @open.call(@endpoint)
       rss =  RSS::Parser.parse(feed)
-      
+
       rss.items.map do |item|
         item.pubDate.to_i > not_before ? format_item(item) : nil
       end.compact
     end
-    
-    private 
-    
+
+  private
+
     def format_item(item)
       id = item.guid.content
-      categories = item.categories.map(&:content).map { |n| "[%s]" % n}
+      categories = item.categories.map(&:content).map {|n| "[%s]" % n }
       username = item.author.match(USERNAME_REGXP)[:username]
-      
+
       FORMAT % [item.title, categories.join(' '), username, id]
     end
   end
-end
+end

data/lib/lobstersbot/summer_patches.rb

@@ -0,0 +1,27 @@
+module Lobstersbot
+  module SummerPatches
+    def config_dir(file)
+      File.join(ARGV[0], file)
+    end
+
+    def load_config
+      @config = HashWithIndifferentAccess.new(YAML.load_file(config_dir('lobstersbot.yml')))
+    end
+
+    def connect!
+      @connection = TCPSocket.open(server, port)
+
+      if config[:use_ssl]
+        cert_file = File.read(config_dir('client.pem'))
+        context = OpenSSL::SSL::SSLContext.new
+        context.key = OpenSSL::PKey.read(cert_file)
+        context.crt = OpenSSL::X509::Certificate.new(cert_file)
+
+        @connection = OpenSSL::SSL::SSLSocket.new(@connection, context).connect
+      end
+
+      response("USER #{config[:nick]} #{config[:nick]} #{config[:nick]} #{config[:nick]}")
+      response("NICK #{config[:nick]}")
+    end
+  end
+end

data/lib/lobstersbot/version.rb

@@ -1,3 +1,3 @@
 module Lobstersbot
-  VERSION = "0.1.0"
+  VERSION = "0.2.0".freeze
 end

data/lobstersbot.gemspec

@@ -27,6 +27,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   
+  spec.add_development_dependency "rubocop", "~> 1.8"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.1.0"
+
   spec.add_runtime_dependency 'summer', '~> 1.0'
   spec.add_runtime_dependency 'timers', '~> 4.1'
   spec.add_runtime_dependency 'rss', '~> 0.2.9'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lobstersbot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Hunter Madison
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-17 00:00:00.000000000 Z
+date: 2021-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: summer
   requirement: !ruby/object:Gem::Requirement
@@ -102,8 +130,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/gem.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -115,8 +145,10 @@ files:
 - lib/lobstersbot.rb
 - lib/lobstersbot/pluggable_connection.rb
 - lib/lobstersbot/plugins/rss.rb
+- lib/lobstersbot/plugins/salute.rb
 - lib/lobstersbot/plugins/tell.rb
 - lib/lobstersbot/rss_reader.rb
+- lib/lobstersbot/summer_patches.rb
 - lib/lobstersbot/version.rb
 - lobstersbot.gemspec
 homepage: https://github.com/lobsters/lobstersbot