A ruby interface for the Mastodon API

Luiz Picolo ツ 60b0ed09c3 Added new instruction to usage (#48) 4 tahun lalu
.github 526accca5c Update gempush.yml 4 tahun lalu
lib aed7ae9b43 Fix update media method, add spec (#47) 4 tahun lalu
spec aed7ae9b43 Fix update media method, add spec (#47) 4 tahun lalu
.codeclimate.yml 6e40f2ce0e Bump to 1.0 8 tahun lalu
.gitignore b29141f258 Fix build by removing lockfile and updating gemspec. 5 tahun lalu
.rspec de2216e8fe Initial commit 8 tahun lalu
.rubocop.yml 0e9725187d Group the cops by department in configuration files 7 tahun lalu
.travis.yml 3b6463cb0d Allow failures on ruby-head 5 tahun lalu
CHANGELOG.md 4e75becc83 Bring API support up to date 5 tahun lalu
Gemfile 6e40f2ce0e Bump to 1.0 8 tahun lalu
README.md 60b0ed09c3 Added new instruction to usage (#48) 4 tahun lalu
Rakefile 6e40f2ce0e Bump to 1.0 8 tahun lalu
mastodon.gemspec b29141f258 Fix build by removing lockfile and updating gemspec. 5 tahun lalu

README.md

Mastodon API Ruby Gem

Gem Version Build Status

A ruby interface for the Mastodon API.

Installation

gem 'mastodon-api', require: 'mastodon'

Documentation

All the documentation is available on RubyDoc.

Usage

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

require 'mastodon'

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.