elephrame 0.3.7 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a102472e567d49830d7440751ed69fe4eeffc08dbb155d39b792c56660653a91
-  data.tar.gz: 36c68839714a2edce6d370a005c6fddd33e85d3cf9ce7b736c7fbf16a142018b
+  metadata.gz: 041bac1a80ecb71d3a0da5c2af2f24ec9302457c8663efe0acad6cfaabbb57f4
+  data.tar.gz: fdf9594ab59e48986b3e8c92f22c3da7c8f696e2b014197b42ea7897bc368f7d
 SHA512:
-  metadata.gz: 64ca939df0ef20b7727bfcbe799dee62f4614c7e955e8830035b4829640f80d6c12169e66038739deab3faa0c6c4fbaf9556790d7c5d4f6af1b3cabb66f4e732
-  data.tar.gz: 60971b59d7df12a7318ae2c03021b5cef2f4421af0d70678cb9696ecc3fc84beba0a7879e60fbf3333f9911b748063550b58d81549ce25d46c841334fe13d83c
+  metadata.gz: 55ea90d7f5b18997aa31d5662b2261728a2a6a407ff2d5ebec9f78796d3df0a7f45fff54a7686adde3768db011f89425dbaae81da5e9e0e3180887732fd16611
+  data.tar.gz: 4ebfbcdbfafddfd91b1da93bf71f265d6b499a2f43d58abe3af4a45cad948f2e7063b463da74a47048d5fc810bb34f9f6efbc77f49c93667628c2655c5bdb988

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    elephrame (0.3.7)
+    elephrame (0.4.0)
       moostodon (~> 0.2.0)
       rufus-scheduler
 

data/README.md

@@ -51,6 +51,7 @@ So far the framework support 4 bot types: Periodic, Interact, PeroidInteract, Re
 - `Interact` supports callbacks for each type of interaction (favorites, boosts, replies, follows)
 - `PeriodInteract` supports both of the above (I know, this isn't a good name)
 - `Reply` only supports replying to mentions
+- `Command` supports running code when mentioned with commands it recognizes
 
 The string passed to `Periodic` and `PeroidInteract` must be either a 'Duration' string or a 'Cron' string, as parsable by [fugit](https://github.com/floraison/fugit)
 
@@ -74,6 +75,13 @@ Exposed methods from bot object:
 
 (See RubyDocs for source code documentation)
 
+## In the Wild!
+
+Here's a list of bots that are currently using this framework. If you are using it, add yourself to this list and submit a pull request!
+
+- [GameBot](https://github.com/theZacAttacks/GameBot)
+- [EnhanceBot](https://github.com/theZacAttacks/EnhanceBot)
+
 ## 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.

data/examples/command.rb

@@ -0,0 +1,28 @@
+require 'elephrame'
+
+Candy = [ 'M&Ms', 'Skittles', 'Twix', 'Candycorn' ]
+Genders   = [ 'sweet', 'sour', 'bitter', 'creamy', 'umami' ]
+
+# set the prefix and usage string for our bot
+cmd_bot = Elephrame::Bots::Command.new '!', 'mention me with !candy to get candy, or !gender to get a gender'
+
+# add in the candy command
+cmd_bot.add_command 'candy' do |bot, data, status|
+  bot.reply("@#{status.account.acct} here's some candy!
+*gives you a #{Candy.sample}*",
+            spoiler: 'candy')
+end
+
+# add in the gender command
+cmd_bot.add_command 'gender' do |bot, data, status|
+  bot.reply("@#{status.account.acct} here's a spare gender!
+*gives you a #{Genders.sample} gender*",
+            spoiler: 'gender shitpost')
+end
+
+# if the command is not found
+cmd_bot.if_not_found do |bot, status|
+  bot.reply("@#{status.account.acct} I didn't recognize that! Respond with !help to get usage info")
+end
+
+cmd_bot.run

data/lib/elephrame/streaming/bots.rb

@@ -39,5 +39,37 @@ module Elephrame
       end
     end
 
+
+    ##
+    # A bot that responds to commands, 
+    #
+    # after creation make sure to call add_command or else your bot won't
+    # know what to respond to! (See [Elephrame::Command] for more details
+    
+    class Command < BaseBot
+      include Elephrame::Streaming
+      include Elephrame::Command
+
+      ##
+      # Create a new Command bot, sets +commands+ and +cmd_hash+ to empty
+      # defaults
+      #
+      # @param prefix [String] sets the command prefix, defaults to '!'
+      # @param usage [String] the response to the help command
+      #
+      # @return [Elephrame::Bots::Command]
+      
+      def initialize prefix = '!', usage = nil
+        super()
+
+        @commands = []
+        @cmd_hash = {}
+        
+        setup_streaming
+        set_prefix prefix
+        set_help usage unless usage.nil?
+      end
+    end
+
   end
 end

data/lib/elephrame/streaming/streaming.rb

@@ -141,4 +141,87 @@ module Elephrame
     
     alias_method :run, :run_interact
   end
+
+  
+  module Command
+    include Elephrame::Reply
+    
+    attr_reader :commands, :prefix
+    attr :cmd_hash, :cmd_regex, :not_found
+
+    ##
+    # sets the prefix for commands
+    #
+    # @param pf [String] the prefix
+
+    def set_prefix pf
+      @prefix = pf
+    end
+
+    ##
+    # Shortcut method to provide usage docs in response to help command
+    #
+    # @param usage [String] 
+    
+    def set_help usage
+      add_command 'help' do |bot, content, status|
+        bot.reply("@#{status.account.acct} #{usage}")
+      end
+    end
+
+    ##
+    # Adds the command and block into the bot to process later
+    # also sets up the command regex
+    #
+    # @param cmd [String] a command to add
+    # @param block [Proc] the code to execute when +cmd+ is recieved
+    
+    def add_command cmd, &block
+      @commands.append cmd unless @commands.include? cmd
+      @cmd_hash[cmd.to_sym] = block
+
+      # build up our regex (this regex should be fine, i guess :shrug:)
+      @cmd_regex = /\A#{@prefix}(?<cmd>#{@commands.join('|')})\b(?<data>.*)/m
+    end
+
+    ##
+    # What to do if we don't match anything
+    #
+    # @param block [Proc] a block to run when we don't match a command
+    
+    def if_not_found &block
+      @not_found = block
+    end
+
+    ##
+    # Starts loop to process any mentions, running command procs set up earlier
+    
+    def run_commands
+      @streamer.user do |update|
+        next unless update.kind_of? Mastodon::Notification and update.type == 'mention'
+
+        # set up the status to strip html, if needed
+        update.status.class
+          .module_eval { alias_method :content, :strip } if @strip_html
+        store_mention_data update.status
+
+        # strip our username out of the status
+        post = update.status.content.gsub(/@#{@username} /, '')
+
+        # see if the post matches our regex, running the stored proc if it does
+        matches = @cmd_regex.match(post)
+
+        unless matches.nil?
+          @cmd_hash[matches[:cmd].to_sym]
+            .call(self,
+                  matches[:data].strip,
+                  update.status)
+        else
+          @not_found.call(self, update.status)
+        end
+      end
+    end
+
+    alias_method :run, :run_commands
+  end
 end

data/lib/elephrame/version.rb

@@ -1,3 +1,3 @@
 module Elephrame
-  VERSION = "0.3.7"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elephrame
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.0
 platform: ruby
 authors:
 - Zac
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-06 00:00:00.000000000 Z
+date: 2018-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,6 +100,7 @@ files:
 - elephrame.gemspec
 - examples/README.md
 - examples/combined.rb
+- examples/command.rb
 - examples/interact.rb
 - examples/periodic.rb
 - examples/reply.rb