Elephrame

Gem Version RubyDoc

Elephant-Framework

A framework that helps simplify the creation of bots for mastodon/pleroma

Uses rufus-scheduler in the backend

Installation

Add this line to your application's Gemfile:

gem 'elephrame'

And then execute:

$ bundle

Or install it yourself as:

$ gem install elephrame

Quickstart

bot that posts "i'm gay" every three hours:

require 'elephrame'

my_bot = Elephrame::Bots::Periodic.new '3h'

my_bot.run { |bot|
  bot.post("i'm gay")
}
$ INSTANCE="https://mastodon.social" TOKEN="your_access_token" ruby bot.rb

Check the examples directory for more example bots

Bot Types

So far the framework support 4 bot types: Periodic, Interact, PeroidInteract, Reply

  • 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

The string passed to Periodic and PeroidInteract must be either a 'Duration' string or a 'Cron' string, as parsable by fugit

Usage

All the documentation is over at RubyDoc!

Every place that accepts a block provides access to the bot object. This allows for easy access to some provided helper methods, as well as the actual mastodon access object.

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, *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

(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!

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.

To install this gem onto your local machine, run bundle exec rake install.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/theZacAttacks/elephrame. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Code of Conduct

Everyone interacting in the Elephrame project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.