CLI for all SendGrid v3 endpoints
Ruby Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
exe
lib
spec
.gitignore
.rspec
.rubocop.yml
.travis.yml
CODE_OF_CONDUCT.md
Gemfile
LICENSE.txt
README.md
Rakefile
sg.gemspec

README.md

sg

Build Status Gem Version

sg gem allows you to access SendGrid API v3 endpoints from command line interface.

Installation

You can install the sg via gem command:

$ gem install sg

Usage

Setup

sg loads your SendGrid API Key from SENDGRID_API_KEY environment variable if you do not specify. So set your API Key to your environment variable.

$ env | grep SENDGRID_API_KEY
SENDGRID_API_KEY=SG...

Basic Usage

See help.

$ sg help client

Example

GET https://api.sendgrid.com/v3/api_keys HTTP/1.1

should be:

$ sg client api_keys get
GET https://api.sendgrid.com/v3/api_keys/YOUR_API_KEY_ID HTTP/1.1

should be:

$ sg client api_keys YOUR_API_KEY_ID get
GET https://api.sendgrid.com/v3/suppression/bounces?start_time=14324566&end_time=14324566 HTTP/1.1

should be:

$ sg client suppression bounces get -q='{"start_time": 14324566, "end_time": 14324566}'
POST https://api.sendgrid.com/v3/api_keys HTTP/1.1
{"name": "My API Key", "scopes": ["mail.send"]}

should be:

$ sg client api_keys post -b='{"name": "My API Key", "scopes": ["mail.send"]}'

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment. Run bundle exec sg to use the gem in this directory, ignoring other installed copies of this gem.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sg. 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.

License

The gem is available as open source under the terms of the MIT License.