mindee 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5cdb0922b8ea540511c91a760d0b9d76dd5ba87f5e85b88b6008511077fe852b
+  data.tar.gz: 01a40229234d445a1838d71e945e7eacff7c8afdba2da09bb20fbf14670b21da
+SHA512:
+  metadata.gz: cfecb4fc1da99567aa086e2af214544b294e6be7525984fab2775ff19877116203b0739bd1d8b9c66ef23205dbe8dcd277e89a149884cffd8bd10e133d3f8e46
+  data.tar.gz: f5f389e634f5c8ec8637b9d3a051f44248500f7553bad550da0dc0f3d8e49a2f68c2d0251868f89b37f2d465efce92b55a4bdd65422f64a36cedf8e3e0932667

data/.gitattributes

@@ -0,0 +1,14 @@
+# Auto-detect text files, ensure they use LF.
+*       text=auto eol=lf
+
+# These files are always considered text and should use LF.
+# See core.whitespace @ https://git-scm.com/docs/git-config for whitespace flags.
+*.rb    text eol=lf whitespace=blank-at-eol,space-before-tab,tab-in-indent,tabwidth=2 diff=ruby
+*.sh    text eol=lf whitespace=blank-at-eol diff=bash
+*.md    text eol=lf whitespace=blank-at-eol diff=markdown
+
+# Exclude non-essential files from dist
+.gitattributes  export-ignore
+.gitignore      export-ignore
+tests/          export-ignore
+.github         export-ignore

data/.gitignore

@@ -0,0 +1,69 @@
+# IDE
+.vscode/
+.idea
+
+# Ruby
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/mindee-*/
+
+# Used by dotenv library to load environment variables.
+.env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+.rubocop-https?--*
+
+# Mac OS
+.DS_Store
+
+# Temp files
+*.swp
+*-swp

data/.rubocop.yml

@@ -0,0 +1,41 @@
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'vendor/**/*'
+    - 'spec/fixtures/**/*'
+    - 'tmp/**/*'
+    - '.git/**/*'
+    - 'bin/*'
+  TargetRubyVersion: 2.6
+  SuggestExtensions: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/WordArray:
+  EnforcedStyle: brackets
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - '**/*.gemspec'
+
+Metrics/MethodLength:
+  Max: 35
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/ParameterLists:
+  Max: 7
+
+Metrics/AbcSize:
+  Max: 50
+
+Style/RegexpLiteral:
+  EnforcedStyle: percent_r

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Mindee Ruby API Library Changelog
+
+## v1.0.0 (2022-07-28)
+* :tada: First release!

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,129 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mindee.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rubocop', require: false
+
+group :test do
+  gem 'rspec', '~> 3.10'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-Present Mindee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# Mindee API Helper Library for Ruby
+Quickly and easily connect to Mindee's API services using Ruby.
+
+## Quick Start
+Here's the TL;DR of getting started.
+
+First, get an [API Key](https://developers.mindee.com/docs/create-api-key)
+
+Install by adding this line to your application's Gemfile:
+
+```ruby
+gem 'mindee'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install mindee
+
+Finally, Ruby away!
+
+### Off-the-Shelf Document
+```ruby
+require 'mindee'
+
+# Init a new client and configure the Invoice API
+mindee_client = Mindee::Client.new(api_key: 'my-api-key').config_invoice
+
+# Load a file from disk and parse it
+api_response = mindee_client.doc_from_path("/path/to/the/invoice.pdf").parse("invoice")
+
+# Print a brief summary of the parsed data
+puts api_response.document
+```
+
+### Custom Document (API Builder)
+```ruby
+require 'mindee'
+
+# Init a new client and configure your custom document
+mindee_client = Mindee::Client.new(api_key: 'my-api-key').config_custom_doc(
+  'pokemon-card',
+  'pikachu'
+)
+
+# Load a file from disk and parse it
+api_response = mindee_client.doc_from_path("/path/to/the/card.jpg").parse("pokemon-card")
+
+# Print a brief summary of the parsed data
+puts api_response.document
+```
+
+## Further Reading
+There's more to it than that for those that need more features, or want to
+customize the experience.
+
+All the juicy details are described in the
+**[Official Documentation](https://developers.mindee.com/docs/ruby-getting-started)**.
+
+## License
+Copyright © Mindee
+
+Available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+task default: spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mindee'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/mindee.rb

@@ -0,0 +1,137 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'optparse'
+
+require 'mindee'
+
+DOCUMENTS = {
+  "invoice" => {
+    help: 'Invoice',
+    doc_type: Mindee::Client::DOC_TYPE_INVOICE,
+  },
+  "receipt" => {
+    help: "Expense Receipt",
+    doc_type: Mindee::Client::DOC_TYPE_RECEIPT,
+  },
+  "passport" => {
+    help: "Passport",
+    doc_type: Mindee::Client::DOC_TYPE_PASSPORT,
+  },
+  "financial" => {
+    help: "Financial Document (receipt or invoice)",
+    doc_type: Mindee::Client::DOC_TYPE_FINANCIAL,
+  },
+  "custom" => {
+    help: "Custom document type from API builder",
+  },
+}
+
+options = {}
+
+def ots_subcommand(command, options)
+  OptionParser.new do |opt|
+    opt.banner = "Usage: #{command} [options] FILE"
+    opt.on('-k [KEY]', '--key [KEY]', 'API key for the endpoint') do |v|
+      options[:api_key] = v
+    end
+    opt.on('-w', '--with-words', 'Include words in response') do |v|
+      options[:include_words] = v
+    end
+    opt.on('-C', '--no-cut-pages', "Don't cut document pages") do |v|
+      options[:include_words] = v
+    end
+  end
+end
+
+def custom_subcommand(options)
+  OptionParser.new do |opt|
+    opt.banner = "Usage: custom [options] DOC_TYPE FILE"
+    opt.on('-w', '--with-words', 'Include words in response') do |v|
+      options[:include_words] = v
+    end
+    opt.on('-C', '--no-cut-pages', "Don't cut document pages") do |v|
+      options[:include_words] = v
+    end
+    opt.on('-k [KEY]', '--key [KEY]', 'API key for the endpoint') do |v|
+      options[:api_key] = v
+    end
+    opt.on('-v [VERSION]', '--version [VERSION]', 'Model version for the API') do |v|
+      options[:version] = v
+    end
+    opt.on('-u USER', '--user USER', 'API account name for the endpoint') do |v|
+      options[:user] = v
+    end
+  end
+end
+
+def new_ots_client(options, command)
+  raise_on_error = options[:no_raise_errors].nil? ? true : false
+  mindee_client = Mindee::Client.new(
+    api_key: options[:api_key], raise_on_error: raise_on_error
+  )
+  info = DOCUMENTS[command]
+  mindee_client.send("config_#{info[:doc_type]}")
+end
+
+def new_custom_client(options, doc_type)
+  raise_on_error = options[:no_raise_errors].nil? ? true : false
+  mindee_client = Mindee::Client.new(
+    api_key: options[:api_key], raise_on_error: raise_on_error
+  )
+  mindee_client.config_custom_doc(
+    doc_type,
+    options[:user],
+    version: options[:version] || '1'
+  )
+end
+
+global_parser = OptionParser.new do |opt|
+  opt.banner = "Usage: #{$PROGRAM_NAME} [options] subcommand [options] FILE"
+  opt.separator('')
+  opt.separator("subcommands: #{DOCUMENTS.keys.join(', ')}")
+  opt.separator('')
+  opt.on('-E', '--no-raise-errors', "raise errors behavior") do |v|
+    options[:no_raise_errors] = true
+    end
+end
+
+subcommands = {
+  'invoice' => ots_subcommand('invoice', options),
+  'receipt' => ots_subcommand('receipt', options),
+  'passport' => ots_subcommand('passport', options),
+  'financial' => ots_subcommand('financial', options),
+  'custom' => custom_subcommand(options),
+}
+
+
+begin
+  global_parser.order!
+  command = ARGV.shift
+  subcommands[command].order!
+rescue NoMethodError => e
+  $stderr.puts global_parser
+  exit(1)
+end
+
+if command == 'custom'
+  if ARGV.length != 2
+    $stderr.puts "The 'custom' command requires both DOC_TYPE and FILE arguments."
+    exit(1)
+  end
+  doc_type = ARGV[0]
+  file_path = ARGV[1]
+  mindee_client = new_custom_client(options, doc_type)
+else
+  if ARGV.length != 1
+    $stderr.puts 'No file specified.'
+    exit(1)
+  end
+  mindee_client = new_ots_client(options, command)
+  doc_type = DOCUMENTS[command][:doc_type]
+  file_path = ARGV[0]
+end
+
+cut_pages = options[:no_cut_pages].nil? ? false : true
+doc = mindee_client.doc_from_path(file_path, cut_pages: cut_pages)
+puts doc.parse(doc_type).document