Qrfy

A really simple wrapper around https://qrfy.com/ API. Documentation of the API is here https://qrfy.com/docs/QR. To use that API you have to setup your API key first.

Install the gem and add to the application's Gemfile by executing:

$ bundle add qrfy

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install qrfy

First setup the API key in the rails initializers

# config/initializers/qrfy.rb
Qrfy.configure do |config|
    config.api_key = ENV["QRFY_API_KEY"]
end

You could setup the API key during the client initialization as well (if you set it up in the initializer, then it'll be used by default):

client = Qrfy::Client.new(api_key: ENV["QRFY_API_KEY"])

Create a new QR code:

id = client.qrs.create(qr_params)

Create many QR codes at once:

ids = client.qrs.create([qr_params1, qr_params2])

You can also attach global style for your qr images and folder in which it should be saved.

id = client.qrs.create(qr_params, style: { shape: { style: :sparkle } }, folder_id: 1)

You can list folders by following that code:

client.folders.list.each do |folder|
    puts "Folder ##{folder.id} with name: #{folder.name} was created at: #{folder.created_at} and has #{folder.qrs} images attached."
end

And create new folders using:

folder_id = client.folders.create({ name: "My first folder" })

This gem follows the exception error handling. All errors raised by this gem inherits from Qrfy::Errors::Base class and belong to the following categories:

* Qrfy::Errors::RecordInvalid
* Qrfy::Errors::Unauthorized
* Qrfy::Errors::RecordNotFound
* Qrfy::Errors::TooManyRequests
* Qrfy::Errors::InternalServerError

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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. 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 the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/w-zygmuntowicz/qrfy.

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