elephrame 0.3.4 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3aa8e7f20012b5d9316bc25a617408517f13047b9e3b0bda0e3315bb87f9a548
-  data.tar.gz: c67ff2d3adc7b4f52da5443c02d0029686165383ffd44b62c2f6a1acefe55b71
+  metadata.gz: b5debc85f1a59e0bbb4d562dd2685cbe15bd086c005e16cc0f56054109d62c2b
+  data.tar.gz: 3d090af83e6d1200b936aeedc86003fa80fbb63edb2b46aec19f5fee4855b111
 SHA512:
-  metadata.gz: 6267827dbfcda7ea3abf38f7f8e94faca3fff3007fec3de355a92d8e8b0621793b2f7f55d8ca9425f83d35bb3126f03757a8129401b8a19c46de693789b62ab8
-  data.tar.gz: acd997ed3205534a494080426157342374552d099930b9eaf5863570490bb9ec1ef005ab6906b1af87c333ae944d396458438cac106de6038c78d611585a4b25
+  metadata.gz: aec1f7cc1644c9ee00dc6ef77ef3db692f72c46ffa378be2314caae97a7e93e06e285e62681dd3d9ccbe0020ed6e9b4de17f953d3e2b917c931e07f19d98b5e0
+  data.tar.gz: b0c09dd1c87aad6261d59c04aa77b75430a5b0c0ceb29b29840c02827e83bf5dd245c87dcb4c5ca4de2c819d404fc49e058e7d93709a9ac0c4a4c4e024587db9

data/Gemfile.lock

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

data/README.md

@@ -65,8 +65,10 @@ Exposed methods from bot object:
 - `client` this is the underlying mastodon rest client we use in the backend. use this to make custom calls to the api for which we don't provide a helper
 - `username` the name of the bot as fetched by verify_credentials
 - `strip_html` (defaults to true) if set, the framework will automatically strip all html symbols from the post content
+- `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)` 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: doesn't automatically @ the other user/s)
 - `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/lib/elephrame/bot.rb

@@ -1,3 +1,6 @@
+require 'time'
+require 'net/http'
+
 module Elephrame  
   module Bots
 
@@ -6,12 +9,12 @@ module Elephrame
     # holds common functions and variables
     
     class BaseBot
-      attr_reader :client, :username
-      attr_accessor :strip_html
+      attr_reader :client, :username, :failed
+      attr_accessor :strip_html, :max_retries
 
       ##
-      # Sets up our REST client, gets and saves our username, sets default
-      # value for strip_html (true)
+      # Sets up our REST +client+, gets and saves our +username+, sets default
+      # value for +strip_html+ (true), and +max_retries+ (5), +failed+
       #
       # @return [Elephrame::Bots::BaseBot]
       
@@ -20,6 +23,8 @@ module Elephrame
                                              bearer_token: ENV['TOKEN'])
         @username = @client.verify_credentials().acct
         @strip_html = true
+        @max_retries = 5
+        @failed = { media: false, post: false }
       end
 
       ##
@@ -35,9 +40,12 @@ module Elephrame
       def post(text, visibility: 'unlisted', spoiler: '',
                reply_id: '', hide_media: false, media: [])
         
+        uploaded_ids = []
         unless media.size.zero?
-          media.collect! {|m|
-            @client.upload_media(m).id
+          @failed[:media] = retry_if_needed {
+            uploaded_ids = media.collect {|m|
+              @client.upload_media(m).id
+            }
           }
         end
         
@@ -45,11 +53,13 @@ module Elephrame
           visibility: visibility,
           spoiler_text: spoiler,
           in_reply_to_id: reply_id,
-          media_ids: media,
+          media_ids: @failed[:media] ? [] : uploaded_ids,
           sensitive: hide_media,
         }
-        
-        @client.create_status text, options
+
+        @failed[:post] = retry_if_needed {
+          @client.create_status text, options
+        }
       end
 
       
@@ -86,6 +96,28 @@ module Elephrame
       def no_bot? account_id
         @client.account(account_id).note =~ /#?NoBot/i
       end
+
+      private
+
+      ##
+      # An internal function that ensures our HTTP requests go through
+      #
+      # @param block [Proc] accepts a block, ensures all code inside
+      #   that block gets executed even if there was an HTTP error.
+      #
+      # @return [Bool] true on hitting the retry limit, false on success
+      
+      def retry_if_needed &block
+        @max_retries.times do |i|
+          begin
+            block.call
+            return false
+          rescue HTTP::TimeoutError
+            puts "caught HTTP Timeout error at #{Time.now} retrying #{@max_retries-i} more times"
+          end
+        end
+        return true
+      end
       
     end
   end

data/lib/elephrame/streaming/streaming.rb

@@ -30,27 +30,14 @@ module Elephrame
     # *DOES NOT AUTOMATICALLY INCLUDE @'S*
     #
     # @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)
-
+    def reply(text, *options)
+      options = Hash[*options]
+      
       # maybe also @ everyone from the mention? idk that seems like a bad idea tbh
-      post(text, @mention_data[:vis], @mention_data[:spoiler],
-           @mention_data[:id], @mention_data[:sensitive])
-    end
-
-    ##
-    # 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 = {
-        id: mention.id,
-        vis: mention.visibility,
-        spoiler: mention.spoiler_text,
-        mentions: mention.mentions,
-        sensitive: mention.sensitive?
-      }
+      post(text, **@mention_data.merge(options).reject { |k| k == :mentions })
     end
 
     ##
@@ -75,6 +62,23 @@ module Elephrame
     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,
+        mentions: mention.mentions,
+        hide_media: mention.sensitive?
+      }
+    end
   end
   
 

data/lib/elephrame/version.rb

@@ -1,3 +1,3 @@
 module Elephrame
-  VERSION = "0.3.4"
+  VERSION = "0.3.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elephrame
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.6
 platform: ruby
 authors:
 - Zac
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-30 00:00:00.000000000 Z
+date: 2018-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler