elephrame 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 173e8777a79a860697a3d962421d877bc6727b6226c2dca06bb13c376b5c0311
-  data.tar.gz: fccda1de7a698076058388279abd6601db64eae181d55bcd83459290c7927ab3
+  metadata.gz: 99301911c71cb6fe44225ba4ae6071886359ae6c667471f8a9198daf4a202ef8
+  data.tar.gz: 98944310ca826e8d5432df0d699cb7eb7ed47c8997b19ef75331954e40b20e47
 SHA512:
-  metadata.gz: 972b0cf7fceef426ca71f056390872a7f50eb977f15ed4a459dd6a9ab49270a47bdfd76d42c7845f2d74bcc38069fd0c9d38218486367dd46bd0dd48fca23cd6
-  data.tar.gz: 469eb1582aaba3e29068ced5e8db564a908e3deed125bb2010d23dd6e187ce6959c697b8a3d0b8c5140d8e8bd41362a8ab737b94e5fcd5ffcd06ed02297f9bf5
+  metadata.gz: da91f48e6e1502a97fec68ada9d66e0b89c33e231fc884318549af623217468e0b0e393b466496ba19520435f6bcb8ba5bdbd20e111c3a2009c07b0c8606898b
+  data.tar.gz: fffdcd359ea544c6b7ff4bbe91b00c93f5629ffa51144df1ae10256499b7885d6a486e93e3e5bfbdcb26480a18fc6c5993ba99073f2f4e4e6ffe930e61d3a721

data/Gemfile.lock

@@ -1,22 +1,23 @@
 PATH
   remote: .
   specs:
-    elephrame (0.4.4)
-      moostodon (~> 0.2.0)
+    elephrame (0.4.5)
+      moostodon (~> 0.4.0)
       rufus-scheduler
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
+    addressable (2.6.0)
       public_suffix (>= 2.0.2, < 4.0)
     buftok (0.2.0)
+    concurrent-ruby (1.1.5)
     domain_name (0.5.20180417)
       unf (>= 0.0.5, < 1.0.0)
-    et-orbi (1.1.6)
+    et-orbi (1.1.7)
       tzinfo
-    fugit (1.1.6)
-      et-orbi (~> 1.1, >= 1.1.6)
+    fugit (1.1.8)
+      et-orbi (~> 1.1, >= 1.1.7)
       raabro (~> 1.1)
     http (3.3.0)
       addressable (~> 2.3)
@@ -28,20 +29,19 @@ GEM
     http-form_data (2.1.1)
     http_parser.rb (0.6.0)
     minitest (5.11.3)
-    moostodon (0.2.0)
+    moostodon (0.4.0)
       addressable (~> 2.5)
       buftok (~> 0)
       http (~> 3.0)
       oj (~> 3.3)
-    oj (3.7.4)
+    oj (3.7.9)
     public_suffix (3.0.3)
     raabro (1.1.6)
     rake (10.5.0)
     rufus-scheduler (3.5.2)
       fugit (~> 1.1, >= 1.1.5)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.0)
+      concurrent-ruby (~> 1.0)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.5)
@@ -56,4 +56,4 @@ DEPENDENCIES
   rake (~> 10.0)
 
 BUNDLED WITH
-   1.17.1
+   1.17.2

data/README.md

@@ -72,7 +72,8 @@ Exposed methods from bot object:
 - `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 
+- `no_bot?(account_id)` returns true if user with `account_id` has some form of "#NoBot" in their bio or their profile fields
+- `fetch_list_id(name)` return the id of a list with given name `name`
 
 (See RubyDocs for source code documentation)
 
@@ -82,6 +83,8 @@ Here's a list of bots that are currently using this framework. If you are using
 
 - [GameBot](https://github.com/theZacAttacks/GameBot)
 - [EnhanceBot](https://github.com/theZacAttacks/EnhanceBot)
+- [RemindMe Bot](https://github.com/theZacAttacks/RemindMeBot)
+- [InstanceEmoji Bot](https://github.com/theZacAttacks/InstanceEmojiBot)
 
 ## Development
 

data/elephrame.gemspec

@@ -41,5 +41,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest", "~> 5.0"
   
   spec.add_dependency 'rufus-scheduler'
-  spec.add_dependency 'moostodon', '~> 0.2.0'
+  spec.add_dependency 'moostodon', '~> 0.4.0'
 end

data/examples/notbot_check.rb

@@ -0,0 +1,14 @@
+require 'elephrame'
+
+# create a bot that watches the public timeline
+#  (this gives us the largest sample size)
+watcher = Elephrame::Bots::Watcher.new 'public'
+
+watcher.run do |bot, post|
+
+  # if the account's profile doesn't contain no bot
+  #  we print the account's handle and the post's content
+  if not bot.no_bot? post.account.id
+    puts "#{post.account.acct}: #{post.content}"
+  end
+end

data/examples/watcher.rb

@@ -0,0 +1,14 @@
+require 'elephrame'
+
+# here are various examples of how to create a new watcher bot
+#tag_watcher   = Elephrame::Bots::Watcher.new 'tag', 'CoolHash'
+#local_watcher = Elephrame::Bots::Watcher.new 'local'
+#ltag_watcher  = Elephrame::Bots::Watcher.new 'local hashtag', 'LocalTag'
+#list_watcher  = Elephrame::Bots::Watcher.new 'list', 'test list'
+#home_watcher  = Elephrame::Bots::Watcher.new 'home'
+
+fedi_watcher = Elephrame::Bots::Watcher.new 'public'
+
+fedi_watcher.run do |bot, post|
+  puts "#{post.account.acct}: #{post.content}"
+end

data/lib/elephrame/bot.rb

@@ -87,17 +87,32 @@ module Elephrame
       end
 
       ##
-      # Checks to see if a user has some form of "#NoBot" in their bio
-      # (so we can make making friendly bots easier!)
+      # Checks to see if a user has some form of "#NoBot" in their bio or in
+      # their profile fields (so we can make making friendly bots easier!)
       #
       # @param account_id [String] id of account to check bio
       #
       # @return [Bool]
 
       def no_bot? account_id
-        # TODO: check account fields for NoBot, too
-        #       right now, limited by moostodon
-        @client.account(account_id).note =~ /#?NoBot/i
+        acct = @client.account(account_id)
+        acct.note =~ NoBotRegex ||
+          acct.fields.any? {|f| f.name =~ NoBotRegex || f.value =~ NoBotRegex}
+      end
+
+      ##
+      # Gets the ID of a list given the name
+      #
+      # @param name [String] name of the list
+      #
+      # @return [Integer]
+      
+      def fetch_list_id(name)
+        lists = {}
+        @client.lists.collect do |l|
+          lists[l.title] = l.id
+        end
+        lists[name]
       end
 
       private

data/lib/elephrame/streaming/bots.rb

@@ -67,5 +67,30 @@ module Elephrame
       end
     end
 
+    ##
+    # A bot that watches timelines or lists
+    
+    class Watcher < BaseBot
+      include Elephrame::Streaming
+      include Elephrame::Reply
+      include Elephrame::TimelineWatcher
+
+      ##
+      # Creates a new Watcher bot
+      #
+      # @param tl [String] the timeline you want to watch. accepted values are:
+      #    'public', 'home', 'list', 'local', 'hashtag'/'tag', 'local hashtag'
+      # @param name [String] the name of the list or hashtag to watch
+      #
+      # @return [Elephrame::Bots::Watcher]
+ 
+      def initialize tl, name = nil
+        super()
+
+        setup_streaming
+        setup_watcher tl, name
+      end
+    end
+    
   end
 end

data/lib/elephrame/streaming/streaming.rb

@@ -1,6 +1,7 @@
 require_relative 'reply'
 require_relative 'command'
 require_relative 'interaction'
+require_relative 'watcher'
 
 module Elephrame
   module Streaming

data/lib/elephrame/streaming/watcher.rb

@@ -0,0 +1,47 @@
+module Elephrame
+  module TimelineWatcher
+    attr :endpoint, :endpoint_arg
+
+    def setup_watcher(timeline, arg = nil)
+
+      @endpoint = format_tl(timeline)
+
+      raise 'list or tag not supplied' if endpoint_needs_arg? and arg.nil?
+      @endpoint_arg = arg
+
+      # does some heavy lifting so the developer
+      #  doesn't need to know the ID of the list
+      @endpoint_arg = fetch_list_id(arg) if @endpoint == 'list'
+
+      # in case the the argument contains an actual hash symbol
+      @endpoint_arg.gsub!('#', '') if @endpoint =~ /tag/
+    end
+    
+    def run_watcher &block
+      @streamer.send(@endpoint,
+                     @endpoint_arg) do |post|
+        next if post.kind_of? Mastodon::Notification or
+                post.kind_of? Mastodon::Streaming::DeletedStatus
+        
+        # this makes it so .content calls strip instead 
+        post.class.module_eval { alias_method :content, :strip } if @strip_html
+        
+        block.call(self, post)
+      end
+    end
+
+    alias_method :run, :run_watcher
+
+    private
+    
+    def format_tl(tl)
+      tl.gsub('home', 'user').gsub('public', 'firehose')
+        .gsub(/(hash)?tag/, 'hashtag')
+        .gsub('local ', 'local_')
+    end
+
+    def endpoint_needs_arg?
+      @endpoint =~ /(list|hashtag)/
+    end
+  end
+end

data/lib/elephrame/util/status.rb

@@ -8,8 +8,11 @@ module Mastodon
     # @return [String]
     
     def strip
-      rcontent.gsub(/<\/p><p>/, "\n")
+      rcontent
+        .gsub(/<\/p><p>/, "\n")
         .gsub(/<("[^"]*"|'[^']*'|[^'">])*>/, '')
+        .gsub('&gt;', '>')
+        .gsub('&lt;', '<')
     end
   end
 end

data/lib/elephrame/version.rb

@@ -1,3 +1,3 @@
 module Elephrame
-  VERSION = "0.4.4"
+  VERSION = "0.4.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elephrame
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Zac
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-18 00:00:00.000000000 Z
+date: 2019-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.4.0
 description: 
 email:
 - thezacattacks@gmail.com
@@ -102,8 +102,10 @@ files:
 - examples/combined.rb
 - examples/command.rb
 - examples/interact.rb
+- examples/notbot_check.rb
 - examples/periodic.rb
 - examples/reply.rb
+- examples/watcher.rb
 - lib/elephrame.rb
 - lib/elephrame/bot.rb
 - lib/elephrame/mix/bots.rb
@@ -114,6 +116,7 @@ files:
 - lib/elephrame/streaming/interaction.rb
 - lib/elephrame/streaming/reply.rb
 - lib/elephrame/streaming/streaming.rb
+- lib/elephrame/streaming/watcher.rb
 - lib/elephrame/util/status.rb
 - lib/elephrame/version.rb
 homepage: https://github.com/theZacAttacks/elephrame
@@ -139,8 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: A framework for assisting in making mastodon/pleroma bots