/taggun-rb

ruby gem for the Taggun receipt OCR-Engine.

Primary LanguageHTMLMIT LicenseMIT

Taggun

This is a ruby gem for the Taggun receipt OCR-Engine.

Currently we support the following scan types:

  • URL
  • encoded
  • file
  • storage

Installation

Add this line to your application's Gemfile:

gem 'taggun'

And then execute:

$ bundle

Or install it yourself as:

$ gem install taggun

Usage

First you have to set your API key provided by Taggun.

Create an initializer taggun.rb with

Taggun.configure do |config|
  config.api_key = 'your_api_key'
end

Then you can just call the Parser with

taggun = Taggun::Parser.new

taggun.from_url(Taggun::SIMPLE, 'url_to_image')

The form_xxx methods return the Taggun responses. See https://api.taggun.io for details.

TODOs

  • Implement more scan types
  • Documentation
  • Add tests

Contributing

TODO

License

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