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.

sharemeowclient's Issues

What's the recommended way to pre-generate an image when using a CDN?

Generating images on-the-fly is great, but can be a little bit slow at times. Using a CDN helps, but not for the initial request.

Is there a recommended way to 'ping' the ShareMeow app through the CDN (e.g. a simple GET request) so it starts generating the image and can be loaded from the CDN cache the next request?

A simple open(url) would work, but for large images it seems wasteful waiting for the full response.

Setting config to nil produces cryptic error message

When setting the config variables to nil you'll receive the following error when calling .image_url:

!! #<TypeError: no implicit conversion of nil into String>

I ran into this problem, because I'm using ENV variables in my initializer and accidentally forgot to set a value. This results in the ShareMeow config variables being set no nil, overriding the defaults and .image_url producing the cryptic error above.

Fortunately there's a limited codebase here so debugging this is rather painless, but I still think a more descriptive error message when calling .image_url or using nil as a configuration value would be handy.