https://github.com/sypht-team/sypht-ruby-client
A Ruby client for the Sypht API
https://github.com/sypht-team/sypht-ruby-client
api-client data-extraction document-capture extract extract-data-from-pdf extract-fields information-retrieval invoice invoice-parser pdf-parser receipt-capture receipt-reader receipt-scanner receipt-scanning ruby ruby-gem ruby-library sypht sypht-api sypht-ruby-client
Last synced: 7 months ago
JSON representation
A Ruby client for the Sypht API
- Host: GitHub
- URL: https://github.com/sypht-team/sypht-ruby-client
- Owner: sypht-team
- License: apache-2.0
- Created: 2019-09-22T10:01:53.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-10-03T07:01:30.000Z (about 6 years ago)
- Last Synced: 2025-01-16T07:22:26.637Z (9 months ago)
- Topics: api-client, data-extraction, document-capture, extract, extract-data-from-pdf, extract-fields, information-retrieval, invoice, invoice-parser, pdf-parser, receipt-capture, receipt-reader, receipt-scanner, receipt-scanning, ruby, ruby-gem, ruby-library, sypht, sypht-api, sypht-ruby-client
- Language: Ruby
- Homepage:
- Size: 53.7 KB
- Stars: 4
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://travis-ci.com/sypht-team/sypht-ruby-client.svg?branch=master)
# Sypht Ruby Client
This repository is a Ruby reference client implementation for working with the Sypht API at https://api.sypht.com.
## About Sypht
[Sypht](https://sypht.com) is a SaaS [API]((https://docs.sypht.com/)) which extracts key fields from documents. For
example, you can upload an image or pdf of a bill or invoice and extract the amount due, due date, invoice number
and biller information.
## Getting started
To get started you'll need API credentials, i.e. a `` and ``, which can be obtained by registering
for an [account](https://www.sypht.com/signup/developer)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'sypht'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install sypht
## Usage
```ruby
require 'sypht'
# API_KEY is stored as env variable in the format client_id:client_secret
client_id, client_secret = ENV['SYPHT_API_KEY'].split(":")
# Create new Sypht Client
@client = Sypht::Client.new(client_id, client_secret)
# Submit a file for upload, along with a list of fieldsets
fid = @client.upload("samples/sample_invoice.pdf", ['sypht.invoice'])
# get results of the file based on fid
results = @client.fetch_results fid
```
or run it in the command line:
```
$ sypht extract --fieldset sypht.document --fieldset sypht.invoice path/to/your/document.pdf
```
## Development
You need to install Ruby (2.5+), which can be installed using [RVM](https://rvm.io/rvm/install)
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 build and test the gem locally, run `rake install`, which will package the gem to "pkg/sypht-.gem", and install it in the current ruby.
You can then run `irb` and use the gem as mentioned in the usage section.
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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/sypht-team/sypht-ruby-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The software in this repository is available as open source under the terms of the [Apache License](https://github.com/sypht-team/sypht-ruby-client/blob/master/LICENSE).
## Code of Conduct
Everyone interacting in the Sypht Ruby Client project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sypht-team/sypht-ruby-client/blob/master/CODE_OF_CONDUCT.md).