producthunt / ShareMeowClient

A Ruby client for ShareMeow :heart_eyes_cat:

ShareMeowClient 😻

Ruby client for easily generating ShareMeow URL's. ⭐

Learn more about ShareMeow.

Installation

Add this line to your application's Gemfile:

gem 'share_meow_client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install share_meow_client

Usage

First, you'll need to set the configuration variables in an initializer.

# config/initializers/share_meow_client.rb
ShareMeowClient.configuration do |config|
  config.base_url = 'https://your-share-meow.example.com'
  config.secret_key = 'a_very_long_secret_key'
end

Then, to generate a URL.

image_url = ShareMeowClient.image_url(template: 'HelloWorld', options: { message: 'Hi' })
# => "https://your-share-meow.herokuapp.com/v1/eyJ0ZW1wbGF0ZSI6IkhlbGxvV29ybGQiLCJtZXNzYWdlIjoiSGVsbG8ifQ==/-lgitNQmEs9NaiWyOCHeV137D80=/image.jpg"

Template is the name of your ShareMeow template. And then options are the required options for your template.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rspec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install.

Contributing

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