elephrame 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 925f58429ac0d48573209e51c2ad09fbc030d9b3ab3eb138f49219ed672aaac6
-  data.tar.gz: efff93a265abf97c14c8e37a02676bacd2b02967a61d0d422233ddfe097a85f3
+  metadata.gz: 443a61168b9ae56b414840dc0390ede87a9f8c5ea8b6a1c2cdac99ee6d69801e
+  data.tar.gz: 174eca80ecec2f12d20de89963bc1ae7db831fa58912d202e730d5c7717011e9
 SHA512:
-  metadata.gz: 1e5dfe1f3bfc1ded1c5f79dfe8d9f9b498fe916e0276e6b8aaeebd954526447155b7f8430b9ae1ef50666e869d1ca0dbcb28e3d2c454ac43c2a1b26d71521b24
-  data.tar.gz: 3dc7ba9f4161d0dbccb83925c13094e24756b49db9c466511cca1ab27de73fbe3864fe295b91ccf6df9a18e60d79dc744165d4fd378cd37cc17f1aa4ba4bf39d
+  metadata.gz: 6e5d3401b5b81ea38c65f568bea40e95717db38d3fc228cebbd6aec97281341300945ede38bcacacd26b5dcbd049478f4c2515a8da7d51eefbff04da658de84c
+  data.tar.gz: 81c1877dd775d094ff19497d17f770f2eac003f39980557062d9a664c2ba62a5f600625108ba214bc4187207fdbaf0a0d3cbe39575aea968921ef10f6127c4b1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    elephrame (0.4.1)
+    elephrame (0.4.2)
       moostodon (~> 0.2.0)
       rufus-scheduler
 
@@ -33,7 +33,7 @@ GEM
       buftok (~> 0)
       http (~> 3.0)
       oj (~> 3.3)
-    oj (3.7.4)
+    oj (3.6.7)
     public_suffix (3.0.3)
     raabro (1.1.6)
     rake (10.5.0)

data/README.md

@@ -69,7 +69,8 @@ Exposed methods from bot object:
 - `max_retries` (defaults to 5) the maximum amount of times the framework will retry a mastodon request
 - `failed` a hash that represents the status of the last post or media upload. `failed[:post]` and `failed[:media]`; returns true if it failed, false if it succeeded 
 - `post(content, visibility: 'unlisted', spoiler: '', reply_id: '', hide_media: false, media: [])` this provides an easy way to post statuses from inside code blocks
-- `reply(content, *options)` a shorthand method to reply to the last mention (Note: doesn't automatically @ the other user/s)
+- `reply(content, *options)` a shorthand method to reply to the last mention (Note: only include the @ for the user who @ed the bot)
+- `reply_with_mentions(content, *options)` similar to `reply` but includes all @s (respects #NoBot)
 - `find_ancestor(id, depth = 10, stop_at = 1)` looks backwards through reply chains for the most recent post the bot made starting at post `id` until it hits `depth` number of posts, or finds `stop_at` number of it's own posts
 - `no_bot?(account_id)` returns true if user with `account_id` has some form of "#NoBot" in their bio 
 

data/elephrame.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
     spec.metadata["homepage_uri"] = spec.homepage
     spec.metadata["source_code_uri"] = spec.homepage
+    spec.metadata["changelog_uri"] = "https://github.com/theZacAttacks/elephrame/releases"
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
       "public gem pushes."
@@ -34,13 +35,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '~> 2.0'
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   
   spec.add_dependency 'rufus-scheduler'
   spec.add_dependency 'moostodon', '~> 0.2.0'
-  
-  # until mastodon-api gets a bump this stays commented out
-  #spec.add_dependency 'mastodon-api', '> 1.1.0'
 end

data/lib/elephrame/bot.rb

@@ -1,4 +1,3 @@
-require 'time'
 require 'net/http'
 
 module Elephrame  
@@ -6,7 +5,7 @@ module Elephrame
 
     ##
     # a superclass for other bots
-    # holds common functions and variables
+    # holds common methods and variables
     
     class BaseBot
       attr_reader :client, :username, :failed
@@ -115,7 +114,8 @@ module Elephrame
             block.call
             return false
           rescue HTTP::TimeoutError
-            puts "caught HTTP Timeout error at #{Time.now} retrying #{@max_retries-i} more times"
+            puts "caught HTTP Timeout error; retrying #{@max_retries-i} more times"
+            sleep 5
           end
         end
         return true

data/lib/elephrame/streaming/bots.rb

@@ -61,13 +61,9 @@ module Elephrame
       
       def initialize prefix = '!', usage = nil
         super()
-
-        @commands = []
-        @cmd_hash = {}
         
         setup_streaming
-        set_prefix prefix
-        set_help usage unless usage.nil?
+        setup_command prefix, usage
       end
     end
 

data/lib/elephrame/streaming/command.rb

@@ -0,0 +1,108 @@
+module Elephrame
+  module Command
+    include Elephrame::Reply
+    
+    attr_reader :commands, :prefix
+    attr :cmd_hash, :cmd_regex, :not_found
+
+    ##
+    # Initializes the +commands+ array, +cmd_hash+ 
+    #
+    # @param prefix [String] sets the command prefix, defaults to '!'
+    # @param usage [String] the response to the help command
+    # 
+    
+    def setup_command(prefix = '!', usage = nil)
+        @commands = []
+        @cmd_hash = {}
+        
+        set_prefix prefix
+        set_help usage unless usage.nil?
+    end
+
+    ##
+    # 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("#{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
+    #
+    # If a block is passed to this function it gets ran when no commands
+    # get matched. Otherwise the framework checks if +not_found+ exists
+    # and runs it
+    
+    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
+          
+          if block_given?
+            yield(self, update.status)
+          else
+            @not_found.call(self, update.status) unless @not_found.nil?
+          end
+          
+        end
+      end
+    end
+
+    alias_method :run, :run_commands
+  end
+end

data/lib/elephrame/streaming/interaction.rb

@@ -0,0 +1,61 @@
+module Elephrame
+  module AllInteractions
+    include Elephrame::Reply
+    attr :on_fave, :on_boost, :on_follow
+
+    ##
+    # Sets on_fave equal to +block+
+    
+    def on_fave &block
+      @on_fave = block
+    end
+
+    ##
+    # Sets on_boost to +block+
+    
+    def on_boost &block
+      @on_boost = block
+    end
+
+    ##
+    # Sets on_follow to +block+
+    
+    def on_follow &block
+      @on_follow = block
+    end
+
+    ##
+    # Starts a loop that checks for any notifications for the authenticated
+    # user, running the appropriate stored proc when needed
+    
+    def run_interact
+      @streamer.user do |update|
+        if update.kind_of? Mastodon::Notification
+          
+          case update.type
+              
+          when 'mention'
+
+            # this makes it so .content calls strip instead 
+            update.status.class.module_eval { alias_method :content, :strip } if @strip_html
+            store_mention_data update.status
+            @on_reply.call(self, update.status) unless @on_reply.nil?
+            
+          when 'reblog'
+            @on_boost.call(self, update) unless @on_boost.nil?
+            
+          when 'favourite'
+            @on_fave.call(self, update) unless @on_fave.nil?
+            
+          when 'follow'
+            @on_follow.call(self, update) unless @on_follow.nil?
+            
+          end
+        end
+      end
+    end
+
+    
+    alias_method :run, :run_interact
+  end
+end

data/lib/elephrame/streaming/reply.rb

@@ -0,0 +1,93 @@
+module Elephrame
+  module Reply
+    attr :on_reply, :mention_data
+
+    ##
+    # Sets on_reply equal to +block+
+    
+    def on_reply &block
+      @on_reply = block
+    end
+
+    ##
+    # Replies to the last mention the bot recieved using the mention's
+    #   visibility and spoiler with +text+
+    #
+    # Automatically includes an @ for the account that mentioned the bot.
+    #   Does not include any other @. See +reply_with_mentions+ if you want
+    #   to automatically include all mentions
+    #
+    # @param text [String] text to post as a reply
+    # @param options [Hash] a hash of arguments to pass to post, overrides
+    #   duplicating settings from last mention 
+    
+    def reply(text, *options)
+      options = Hash[*options]
+      
+      post("@#{@mention_data[:account].acct} #{text}",
+           **@mention_data.merge(options).reject { |k|
+             k == :mentions or k == :account
+           })
+    end
+
+    ##
+    # Replies to the last post and tags everyone who was mentioned
+    #  (this function respects #NoBot)
+    #
+    # @param text [String] text to post as a reply
+    # @param options [Hash] arguments to pass to post, overrides settings from
+    #  last mention
+
+    def reply_with_mentions(text, *options)
+      # build up a string of all accounts mentioned in the post
+      #  unless that account is our own, or the tagged account
+      #  has #NoBot
+      mentions = @mention_data[:mentions].collect do |m|
+        "@#{m.acct}" unless m.acct == @username or no_bot? m.id
+      end.join ' '
+      
+      reply("#{mentions.strip} #{text}", *options)
+    end
+
+    ##
+    # Starts a loop that checks for mentions from the authenticated user account
+    # running a supplied block or, if a block is not provided, on_reply
+    
+    def run_reply
+      @streamer.user do |update|
+        next unless update.kind_of? Mastodon::Notification and update.type == 'mention'
+
+        # this makes it so .content calls strip instead 
+        update.status.class.module_eval { alias_method :content, :strip } if @strip_html
+
+        store_mention_data update.status
+        
+        if block_given?
+          yield(self, update.status)
+        else
+          @on_reply.call(self, update.status)
+        end
+      end
+    end
+
+    alias_method :run, :run_reply
+
+    private
+    
+    ##
+    # Stores select data about a post into a hash for later use
+    #
+    # @param mention [Mastodon::Status] the most recent mention the bot received
+
+    def store_mention_data(mention)
+      @mention_data = {
+        reply_id: mention.id,
+        visibility: mention.visibility,
+        spoiler: mention.spoiler_text,
+        hide_media: mention.sensitive?,
+        mentions: mention.mentions,
+        account: mention.account
+      }
+    end
+  end
+end

data/lib/elephrame/streaming/streaming.rb

@@ -1,3 +1,7 @@
+require_relative 'reply'
+require_relative 'command'
+require_relative 'interaction'
+
 module Elephrame
   module Streaming
     attr :streamer
@@ -11,241 +15,4 @@ module Elephrame
     end
 
   end
-
-  
-  module Reply
-    attr :on_reply, :mention_data
-
-    ##
-    # Sets on_reply equal to +block+
-    
-    def on_reply &block
-      @on_reply = block
-    end
-
-    ##
-    # Replies to the last mention the bot recieved using the mention's
-    #   visibility and spoiler with +text+
-    #
-    # Automatically includes an @ for the account that mentioned the bot.
-    #   Does not include any other @. See +reply_with_mentions+ if you want
-    #   to automatically include all mentions
-    #
-    # @param text [String] text to post as a reply
-    # @param options [Hash] a hash of arguments to pass to post, overrides
-    #   duplicating settings from last mention 
-    
-    def reply(text, *options)
-      options = Hash[*options]
-      
-      post("@#{@mention_data[:account].acct} #{text}",
-           **@mention_data.merge(options).reject { |k|
-             k == :mentions or k == :account
-           })
-    end
-
-    ##
-    # Replies to the last post and tags everyone who was mentioned
-    #  (this function respects #NoBot)
-    #
-    # @param text [String] text to post as a reply
-    # @param options [Hash] arguments to pass to post, overrides settings from
-    #  last mention
-
-    def reply_with_mentions(text, *options)
-      # build up a string of all accounts mentioned in the post
-      #  unless that account is our own, or the tagged account
-      #  has #NoBot
-      mentions = @mention_data[:mentions].collect do |m|
-        "@#{m.acct}" unless m.acct == @username or no_bot? m.id
-      end.join ' '
-      
-      reply("#{mentions.strip} #{text}", *options)
-    end
-
-    ##
-    # Starts a loop that checks for mentions from the authenticated user account
-    # running a supplied block or, if a block is not provided, on_reply
-    
-    def run_reply
-      @streamer.user do |update|
-        next unless update.kind_of? Mastodon::Notification and update.type == 'mention'
-
-        # this makes it so .content calls strip instead 
-        update.status.class.module_eval { alias_method :content, :strip } if @strip_html
-
-        store_mention_data update.status
-        
-        if block_given?
-          yield(self, update.status)
-        else
-          @on_reply.call(self, update.status)
-        end
-      end
-    end
-
-    alias_method :run, :run_reply
-
-    private
-    
-    ##
-    # Stores select data about a post into a hash for later use
-    #
-    # @param mention [Mastodon::Status] the most recent mention the bot received
-
-    def store_mention_data(mention)
-      @mention_data = {
-        reply_id: mention.id,
-        visibility: mention.visibility,
-        spoiler: mention.spoiler_text,
-        hide_media: mention.sensitive?,
-        mentions: mention.mentions,
-        account: mention.account
-      }
-    end
-  end
-  
-
-  module AllInteractions
-    include Elephrame::Reply
-    attr :on_fave, :on_boost, :on_follow
-
-    ##
-    # Sets on_fave equal to +block+
-    
-    def on_fave &block
-      @on_fave = block
-    end
-
-    ##
-    # Sets on_boost to +block+
-    
-    def on_boost &block
-      @on_boost = block
-    end
-
-    ##
-    # Sets on_follow to +block+
-    
-    def on_follow &block
-      @on_follow = block
-    end
-
-    ##
-    # Starts a loop that checks for any notifications for the authenticated
-    # user, running the appropriate stored proc when needed
-    
-    def run_interact
-      @streamer.user do |update|
-        if update.kind_of? Mastodon::Notification
-          
-          case update.type
-              
-          when 'mention'
-
-            # this makes it so .content calls strip instead 
-            update.status.class.module_eval { alias_method :content, :strip } if @strip_html
-            store_mention_data update.status
-            @on_reply.call(self, update.status) unless @on_reply.nil?
-            
-          when 'reblog'
-            @on_boost.call(self, update) unless @on_boost.nil?
-            
-          when 'favourite'
-            @on_fave.call(self, update) unless @on_fave.nil?
-            
-          when 'follow'
-            @on_follow.call(self, update) unless @on_follow.nil?
-            
-          end
-        end
-      end
-    end
-
-    
-    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("#{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.4.1"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elephrame
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Zac
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-13 00:00:00.000000000 Z
+date: 2018-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,6 +110,9 @@ files:
 - lib/elephrame/rest/bots.rb
 - lib/elephrame/rest/rest.rb
 - lib/elephrame/streaming/bots.rb
+- lib/elephrame/streaming/command.rb
+- lib/elephrame/streaming/interaction.rb
+- lib/elephrame/streaming/reply.rb
 - lib/elephrame/streaming/streaming.rb
 - lib/elephrame/util/status.rb
 - lib/elephrame/version.rb
@@ -120,15 +123,16 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/theZacAttacks/elephrame
   source_code_uri: https://github.com/theZacAttacks/elephrame
+  changelog_uri: https://github.com/theZacAttacks/elephrame/releases
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="