Skip to content

A Ruby wrapper for GroupMe REST API (v3)

License

Notifications You must be signed in to change notification settings

kinnell/groupme-ruby-gem

Repository files navigation

GroupMe Ruby Gem (BETA)

Build Status Coverage Status Known Vulnerabilities

A Ruby wrapper for GroupMe REST API (v3).

Installation

Add this line to your application's Gemfile:

gem 'groupme-api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install groupme-api

Configuration

Get a developer access token at: https://dev.groupme.com/

require 'groupme'

client = GroupMe::Client.new(
  access_token: 'ax7snqkoRiJ0yGPsbKSgeBnBEtqeSkALMC2qJPrT'
)

Usage

Get All Groups

response, status = client.get('groups')
puts response

Create A Group

response, status = client.post('groups', name: 'New Group')
puts response

Deployment

  1. Update lib/groupme/version.rb & run bundle update
  2. Commit files ("Bump version to ")
  3. Run rake build
  4. Run rake release
  5. Run gem push pkg/groupme-api-<VERSION>.gem and enter MFA OTP code
  6. Run gem push --key github --host https://rubygems.pkg.github.com/kinnell pkg/groupme-api-<VERSION>.gem for GitHub Packages