elephrame 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99301911c71cb6fe44225ba4ae6071886359ae6c667471f8a9198daf4a202ef8
-  data.tar.gz: 98944310ca826e8d5432df0d699cb7eb7ed47c8997b19ef75331954e40b20e47
+  metadata.gz: 1c1ed54678e256a816845886696ca58289d035a7351deb2ec8180915a36f2471
+  data.tar.gz: 15cf11fd775bf2ec0716aa524af6a35ff7996ad724b311cccac89a087039eb5f
 SHA512:
-  metadata.gz: da91f48e6e1502a97fec68ada9d66e0b89c33e231fc884318549af623217468e0b0e393b466496ba19520435f6bcb8ba5bdbd20e111c3a2009c07b0c8606898b
-  data.tar.gz: fffdcd359ea544c6b7ff4bbe91b00c93f5629ffa51144df1ae10256499b7885d6a486e93e3e5bfbdcb26480a18fc6c5993ba99073f2f4e4e6ffe930e61d3a721
+  metadata.gz: 3664bc68bad91273c4b99084729f01f21e2a7ab77f1e98397eb4f32b7c3906522c0105b049954d64bce0e4b5d1b83af7be548bf3ad1659f597e31dfe496c418e
+  data.tar.gz: 57063548c113a5819ad8c73a94f07082fd2071ac7acc3ffaa70b09eaf0cd9a72caf163911f03ec9cdf6358a9e478fc5b54c5d8d0e384ad055006525bc024859d

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    elephrame (0.4.5)
+    elephrame (0.4.6)
       moostodon (~> 0.4.0)
       rufus-scheduler
+      tracery (~> 0.7)
 
 GEM
   remote: https://rubygems.org/
@@ -34,12 +35,13 @@ GEM
       buftok (~> 0)
       http (~> 3.0)
       oj (~> 3.3)
-    oj (3.7.9)
+    oj (3.7.10)
     public_suffix (3.0.3)
     raabro (1.1.6)
     rake (10.5.0)
     rufus-scheduler (3.5.2)
       fugit (~> 1.1, >= 1.1.5)
+    tracery (0.7.7)
     tzinfo (2.0.0)
       concurrent-ruby (~> 1.0)
     unf (0.1.4)

data/README.md

@@ -45,13 +45,15 @@ Check the [examples](https://github.com/theZacAttacks/elephrame/tree/master/exam
 
 ### Bot Types
 
-So far the framework support 5 bot types: Periodic, Interact, PeroidInteract, Reply, Command
+So far the framework support 6 bot types: Periodic, Interact, PeroidInteract, Reply, Command, Watcher
 
 - `Periodic` supports posting on a set schedule
 - `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
+- `Watcher` supports watching streaming timelines (including lists, hashtags, public timeline, local timeline, and user timeline)
+- `TraceryBot` supports automatically loading tracery rules. Overloads post method to automatically expand any text passed through it. This bot type provides certain options that ease the use of tracery grammar rules, please see examples and/or documentation for more explanation.
 
 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 +76,7 @@ Exposed methods from bot object:
 - `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 or their profile fields
 - `fetch_list_id(name)` return the id of a list with given name `name`
+- `fetch_account_id(account_name)` return the id of an account with given handle `account_name`
 
 (See RubyDocs for source code documentation)
 

data/elephrame.gemspec

@@ -42,4 +42,5 @@ Gem::Specification.new do |spec|
   
   spec.add_dependency 'rufus-scheduler'
   spec.add_dependency 'moostodon', '~> 0.4.0'
+  spec.add_dependency 'tracery', '~> 0.7'
 end

data/examples/tracery_adv.rb

@@ -0,0 +1,38 @@
+require 'elephrame'
+require 'time'
+
+bot = Elephrame::Bots::TraceryBot.new('1h', 'tracery_files2')
+
+# this overrides the default behavior for responding to mentions
+bot.on_reply do |bot, post|
+    bot.reply_with_mentions("#greeting#, the current hour is #{Time.now}",
+                            rules: 'reply')
+end
+
+bot.run do |bot|
+  # get the current hour
+  hour = Time.now.hour
+  
+  case hour
+
+  when (20..23)
+  when (0..5)
+    bot.post("The moon is #phase#! It's so spooky :O",
+             rules: 'moon')
+
+  when (6..9)
+    bot.post("Gotta get up and #activity#!",
+             rules: 'morning')
+
+  when (10..16)
+    bot.post("Can't wait to #activity# when I get home",
+             rules: 'afternoon')
+
+  when (17..19)
+    bot.post("Time to start getting ready for #activity#",
+             rules: 'night')
+
+  else
+    next
+  end
+end

data/examples/tracery_files/default.json

@@ -0,0 +1,11 @@
+{
+    "origin": "#greeting#, World! I'm #sexuality#!",
+    "greeting": [ "Hello",
+		  "Greetings",
+		  "Salutations" ],
+    "sexuality": [ "gay",
+		   "pan",
+		   "bi",
+		   "ace",
+		   "aro"]
+}

data/examples/tracery_files/reply.json

@@ -0,0 +1,4 @@
+{
+    "default": "#greeting#",
+    "greeting": ["Salutations", "Hello", "How's it going", "Yo"]
+}

data/examples/tracery_files2/afternoon.json

@@ -0,0 +1,3 @@
+{
+  "activity": [ "put on PJs", "REET lOUDLY", "pet my cat", "sleeep" ]
+}

data/examples/tracery_files2/moon.json

@@ -0,0 +1,3 @@
+{
+  "phase": [ "waning", "waxing", "new", "full", "half", "gibbous" ]
+}

data/examples/tracery_files2/morning.json

@@ -0,0 +1,4 @@
+{
+ "activity": [ "brush my teeth", "eat breakfast", "get dressed",
+               "blow up balloons" ]
+}

data/examples/tracery_files2/night.json

@@ -0,0 +1,4 @@
+{
+ "activity": ["bed", "sleeeeeeeeeeeEEEEEP", "curling up",
+              "building a blanket fort", "playing some videO jaMES"]
+}

data/examples/tracery_files2/reply.json

@@ -0,0 +1,3 @@
+{
+  "greeting": ["Salutations", "Hello", "How's it going", "Yo"]
+}

data/examples/tracery_simple.rb

@@ -0,0 +1,18 @@
+require 'elephrame'
+
+bot = Elephrame::Bots::TraceryBot.new('10s', 'tracery_files')
+
+#  this code happens automatically in the framework
+#   when there's a rule file for 'reply'
+#bot.on_reply do |bot|
+#  bot.reply_with_mentions("#default#", rules: 'reply')
+#end
+
+
+# because there's a tracery file named "default" the framework loads
+#  it automatically! TraceryBot overloads the default 'post' method
+#  and makes sure it automatically expands our tracery text using our
+#  loaded grammar
+bot.run do |bot|
+  bot.post('#greeting#, World! I\'m #sexuality#', visibility: 'unlisted')
+end

data/lib/elephrame/bot.rb

@@ -115,6 +115,37 @@ module Elephrame
         lists[name]
       end
 
+      ##
+      # Gets the ID of an account given the user's handle or username
+      #
+      # @param account_name [String] either the user's full handle or
+      #    their username. E.g., zac@computerfox.xyz, zac
+      # @return [String] ID of account
+      
+      def fetch_account_id(account_name)
+        name = account_name.reverse.chomp('@').reverse
+        search = @client.search("@#{name}")
+
+        accounts = {}
+        search.accounts.each do |acct|
+          accounts[acct.acct] = acct.id
+          accounts[acct.username] = acct.id
+        end
+
+        accounts[name]
+      end
+
+      ##
+      # A helper method that is a wrapper around alias_method
+      # (just to make some code easier to read)
+      #
+      # @param method [Symbol] symbol with the name of a method
+      # @param new_name [Symbol] symbol with the new name for the method
+        
+      def self.backup_method(method, new_name)
+        alias_method new_name, method
+      end
+      
       private
 
       ##
@@ -137,7 +168,6 @@ module Elephrame
         end
         return true
       end
-      
     end
   end
 end

data/lib/elephrame/mix/bots.rb

@@ -1,5 +1,6 @@
 require_relative '../rest/rest'
 require_relative '../streaming/streaming'
+require_relative './tracery'
 require_relative '../bot'
 
 module Elephrame
@@ -41,5 +42,53 @@ module Elephrame
         run_interact
       end
     end
+
+    ##
+    # a bot that posts things on an interval but can also respond
+    # to interactions, providing a grammer object and a few helper 
+    # methods to easily create bots with tracery.
+    #
+    # set on_reply before running, otherwise the bot
+    # won't react to mentions
+    
+    class TraceryBot < BaseBot
+      backup_method :post, :actually_post
+      
+      include Elephrame::Streaming
+      include Elephrame::Scheduler
+      include Elephrame::Reply
+      include Elephrame::Trace
+
+      ##
+      # create a new TraceryBot
+      # @param interval [String] a string representing the interval to post
+      # @param tracery_dir [String] a string with the path to the directory
+      #    containing all of the tracery grammer rules.
+      # @return [Elephrame::Bots::TraceryBot]
+      
+      def initialize interval, tracery_dir
+        super()
+
+        # set up our bot stuff
+        setup_scheduler interval
+        setup_streaming
+        setup_tracery tracery_dir
+      end
+
+      ##
+      # Runs the bot. requires a block for periodic post logic, but relies on
+      # on_* functions for interaction logic. See Elephrame::AllInteractions
+      # for more details.
+      
+      def run
+        run_scheduled &Proc.new
+        
+        unless @on_reply.nil?
+          run_reply
+        else
+          @scheduler.join
+        end
+      end
+    end
   end
 end

data/lib/elephrame/mix/tracery.rb

@@ -0,0 +1,65 @@
+require 'tracery'
+require 'json'
+
+module Elephrame
+  module Trace
+    include Tracery
+
+    # grammar is a hash { FILENAME => TRACERY RULES }
+    attr_accessor :grammar
+
+    ##
+    # loads all of our tracery files into our +files+ hash
+    # if a file is named 'default' then we load that into +grammar+
+    #
+    # @param dir [String] path to the directory containing the tracery rules
+    
+    def setup_tracery dir_path
+      raise "Provided path not a directory" unless Dir.exist?(dir_path)
+
+      @grammar = {}
+      Dir.open(dir_path) do |dir|
+        dir.each do |file|
+          # skip our current and parent dir
+          next if file =~ /^\.\.?$/
+
+          # read the rule file into the files hash
+          @grammar[file.split('.').first] =
+            createGrammar(JSON.parse(File.read("#{dir_path}/#{file}")))
+        end
+      end
+
+      # go ahead and makes a default mention-handler
+      #  if we have a reply rule file
+      unless @grammar['reply'].nil?
+        on_reply { |bot|
+          bot.reply_with_mentions('#default#', rules: 'reply')
+        }
+      end
+    end
+
+    
+    ##
+    # a shortcut fuction for expanding text with tracery before posting
+    #
+    # @param text [String] the tracery text to expand before posting
+    # @param options [Hash] a hash of arguments to pass to post
+    # @option options rules [String] the grammar rules to load
+    # @option options visibility [String] visibility level
+    # @option options spoiler [String] text to use as content warning
+    # @option options reply_id [String] id of post to reply to
+    # @option options hide_media [Bool] should we hide media?
+    # @option options media [Array<String>] array of file paths
+    
+    def expand_and_post(text, *options)
+      opts = Hash[*options]
+      rules = opts.fetch(:rules, 'default')
+      actually_post(@grammar[rules].flatten(text),
+                    **opts.reject {|k|
+                      k == :rules
+                    })
+    end
+
+    alias_method :post, :expand_and_post
+  end
+end

data/lib/elephrame/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elephrame
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Zac
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-18 00:00:00.000000000 Z
+date: 2019-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: tracery
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 description: 
 email:
 - thezacattacks@gmail.com
@@ -105,10 +119,20 @@ files:
 - examples/notbot_check.rb
 - examples/periodic.rb
 - examples/reply.rb
+- examples/tracery_adv.rb
+- examples/tracery_files/default.json
+- examples/tracery_files/reply.json
+- examples/tracery_files2/afternoon.json
+- examples/tracery_files2/moon.json
+- examples/tracery_files2/morning.json
+- examples/tracery_files2/night.json
+- examples/tracery_files2/reply.json
+- examples/tracery_simple.rb
 - examples/watcher.rb
 - lib/elephrame.rb
 - lib/elephrame/bot.rb
 - lib/elephrame/mix/bots.rb
+- lib/elephrame/mix/tracery.rb
 - lib/elephrame/rest/bots.rb
 - lib/elephrame/rest/rest.rb
 - lib/elephrame/streaming/bots.rb