Skip to content

maxine-red/moostodon

 
 

Repository files navigation

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'.

About

A ruby interface for the Mastodon API

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 100.0%