Project

moostodon

0.0
No commit activity in last 3 years
No release in over 3 years
A ruby interface to the Mastodon API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.0

Runtime

~> 0
~> 3.0
~> 3.3
 Project Readme

Mastodon API Ruby Gem

Gem Version Build Status Github Release Date

A ruby interface for the Mastodon API.

Installation

gem install moostodon

or

gem 'moostodon', require: 'moostodon'

Documentation

All the documentation is available on RubyDoc.

This gem is meant as a plug-and-play replacement for mastodon-api.

Usage

Assuming that you already have an access token for a user on a given Mastodon instance:

client = Mastodon::REST::Client.new(base_url: 'https://mastodon.social', bearer_token: 'your_access_token')

If you need to get an access token, you must first ensure that you have the client ID and client secret for your app on the given Mastodon instance (you should save those for future calls):

client.create_app('My Ruby App', 'http://mywebsite.com/callback')

You can then use the client ID and secret in a standard OAuth 2 authorization flow.

Semantic Versioning

This project uses Semantic Versioning v2.0. This means the best to integrate it into your project, is via pessimistic version control '~> 1.0'.