mindee 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18fa830bcd060b512becc4d9b3f09a211a050bae76657d061a1052e834339785
-  data.tar.gz: 61a42fa172220704e73a54e4c6579a05a5524a4cec7c7b4dc66cbd863bba5db6
+  metadata.gz: c0b76bde0354208269f645114e453b15ce48569ae3ce01fd194582f67a2ef6a4
+  data.tar.gz: 96a22bf367165b1c06d93bc90f91ef4c71f16781dd43cb954852ca0343e583df
 SHA512:
-  metadata.gz: 5fc179ca03cf6104262a0dece7cd1ab1637c2491d851caf961136721fa762adbf2d480241e28a679ce76f589ba9c059332fc20525795479614f0fa0fd33765f9
-  data.tar.gz: 9a51991288ae8478567fd1b0edd1967fe08ed5fcb66cf159ad3e64dbf66d9937013747612a5c9343a736d076c9c8c51d63e8bea74924340b54c6f5f705347337
+  metadata.gz: 00060a15fad08a14dccbde8d29a482ae54af57458e742893cf2ac2b61a66201e7dc098a92cee4c1b6a47877fc2b9db05a391bb50fb448b49aadeeb478ce03047
+  data.tar.gz: 81192f06c2e143162675eb1da1caf93481be8a483d8b1dd4dd6d0f6e0eb8869a27163404f260700d5d1e936bdc6523828f8279c820a424da0d96df4a77f467da

data/.gitignore

@@ -1,6 +1,7 @@
 # IDE
 .vscode/
-.idea
+.idea/
+*.iml
 
 # Ruby
 *.gem

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "spec/data"]
+	path = spec/data
+	url = git@github.com:mindee/client-lib-test-data.git

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Mindee Ruby API Library Changelog
 
+## v1.2.0 - 2022-12-26
+### Changes
+* :arrow_up: switch to origamindee => adds support for Ruby 3
+
+## v1.1.2 - 2022-12-23
+### Changes
+* :recycle: use of `append_page` is better for adding pages to a new PDF
+
 ## v1.1.1 - 2022-08-08
 ### Fixes
 * :bug: Fix for missing attribute accessor

data/CONTRIBUTING.md

@@ -0,0 +1,90 @@
+# Contributing to mindee-api-ruby
+
+:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
+
+The following is a set of guidelines for contributing to mindee-api-ruby which are hosted on GitHub.
+These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the following [Code of Conduct](CODE_OF_CONDUCT.md).
+By participating, you are expected to uphold this code.
+Please report unacceptable behavior to [contact@mindee.com](mailto:contact@mindee.com).
+
+## How Can I Contribute
+
+### Reporting Bugs
+
+Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/).
+
+To help maintainers and the community to be efficient, follow these guidelines:
+
+* **Use a clear and descriptive title** for the issue to identify the problem.
+* **Describe the exact steps which reproduce the problem** in as many details as possible.
+    When listing steps, **don't just say what you did, but explain how you did it**.
+    For example, with canvas related problem, explain if you used the mouse or a keyboard shortcut, what kind of image input it is etc...
+* **Provide specific examples to demonstrate the steps**.
+    Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples.
+    If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
+* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
+* **Explain which behavior you expected to see instead and why.**
+* **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.
+* **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
+
+> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
+
+Include details about your configuration and environment:
+
+* **Which version of  mindee-api-ruby are you using?**
+* **What's the name and version of the browser you're using, on which OS**?
+
+### Suggesting Enhancements
+
+Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/).
+
+Make sure to provide the following information:
+
+* **Use a clear and descriptive title** for the issue to identify the suggestion.
+* **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
+* **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
+* **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
+* **Include screenshots and animated GIFs** which help you demonstrate the steps or point out the part of the sdk which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
+* **Specify which version of  mindee-api-ruby you're using.**
+* **Specify the name and version of the browser and OS you're using.**
+
+### Pull Requests
+
+The process described here has several goals:
+
+- Maintain mindee SDK quality
+- Fix problems that are important to users
+- Engage the community in working toward the best possible SDK
+- Enable a sustainable system for mindee's maintainers to review contributions
+
+Please follow these steps to have your contribution considered by the maintainers:
+
+1. Follow all instructions in [the template](.github/PULL_REQUEST_TEMPLATE.md)
+2. Follow the [styleguides](#styleguides)
+
+While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
+
+## Styleguides
+
+### Git Commit Messages
+
+* Use the present tense ("Add feature" not "Added feature")
+* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+* Limit the first line to 72 characters or less
+* Reference issues and pull requests liberally after the first line
+* Consider starting the commit message with an applicable emoji, see [gitmoji](https://gitmoji.carloscuesta.me/) as a reference.
+
+Examples:
+
+* :memo: Add usage section in README
+* :sparkles: Add CONTRIBUTING file in repository
+* :bug: MyComponent - Prevent MouseEvent from firing unexpectedly
+
+### Code Styleguide
+
+We keep our code base consistent and expect Ruby code to adhere to our Rubocop styleguide,
+see the `.rubocop` file.

data/Gemfile

@@ -4,10 +4,3 @@ 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/README.md

@@ -1,6 +1,14 @@
+[![License: MIT](https://img.shields.io/github/license/mindee/mindee-api-ruby)](https://opensource.org/licenses/MIT)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/mindee/mindee-api-ruby/test.yml)](https://github.com/mindee/mindee-api-ruby)
+[![Gem Version](https://img.shields.io/gem/v/mindee)](https://rubygems.org/gems/mindee)
+[![Downloads](https://img.shields.io/gem/dt/mindee.svg)](https://rubygems.org/gems/mindee)
+
 # Mindee API Helper Library for Ruby
 Quickly and easily connect to Mindee's API services using Ruby.
 
+## Requirements
+The following Ruby versions are tested and supported: 2.6, 2.7, 3.0, 3.1
+
 ## Quick Start
 Here's the TL;DR of getting started.
 
@@ -30,7 +38,8 @@ require 'mindee'
 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")
+api_response = mindee_client.doc_from_path('/path/to/the/file.ext')
+  .parse('invoice')
 
 # Print a brief summary of the parsed data
 puts api_response.document
@@ -42,12 +51,13 @@ 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'
+  'john',
+  'wnine'
 )
 
 # Load a file from disk and parse it
-api_response = mindee_client.doc_from_path("/path/to/the/card.jpg").parse("pokemon-card")
+api_response = mindee_client.doc_from_path('/path/to/the/file.ext')
+  .parse('wnine')
 
 # Print a brief summary of the parsed data
 puts api_response.document
@@ -61,6 +71,6 @@ All the juicy details are described in the
 **[Official Documentation](https://developers.mindee.com/docs/ruby-getting-started)**.
 
 ## License
-Copyright © Mindee
+Copyright © Mindee, SA
 
 Available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,5 +1,15 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
+require 'rake'
 
-task default: spec
+begin
+  require 'bundler/setup'
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  puts 'although not required, bundler is recommended for running the tests'
+end
+
+task default: :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/lib/mindee/documents/invoice.rb

@@ -85,7 +85,7 @@ module Mindee
       company_registration = @company_registration.map(&:to_s).join('; ')
       taxes = @taxes.join("\n       ")
       out_str = String.new
-      out_str << '-----Invoice data-----'
+      out_str << '----- Invoice V3 -----'
       out_str << "\nFilename: #{@filename}".rstrip
       out_str << "\nInvoice number: #{@invoice_number}".rstrip
       out_str << "\nTotal amount including taxes: #{@total_incl}".rstrip

data/lib/mindee/inputs.rb

@@ -98,8 +98,8 @@ module Mindee
       new_pdf = Origami::PDF.new
 
       to_insert = [current_pdf.pages[0], current_pdf.pages[-2], current_pdf.pages[-1]].take(max_pages)
-      to_insert.each_with_index do |page, idx|
-        new_pdf.insert_page(idx, page)
+      to_insert.each do |page|
+        new_pdf.append_page(page)
       end
       @io_stream = new_pdf.to_io_stream
     end

data/lib/mindee/version.rb

@@ -2,7 +2,7 @@
 
 # Mindee
 module Mindee
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 
   def self.find_platform
     host = RbConfig::CONFIG['host_os']

data/mindee.gemspec

@@ -5,14 +5,13 @@ require_relative 'lib/mindee/version'
 Gem::Specification.new do |spec|
   spec.name          = 'mindee'
   spec.version       = Mindee::VERSION
-  spec.authors       = ['Mindee']
+  spec.authors       = ['Mindee, SA']
   spec.email         = ['devrel@mindee.co']
 
   spec.summary       = 'Mindee API Helper Library for Ruby'
-  #   spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.description   = "Quickly and easily connect to Mindee's API services using Ruby."
   spec.homepage      = 'https://github.com/mindee/mindee-api-ruby'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
 
   spec.metadata['homepage_uri'] = 'https://mindee.com/'
   spec.metadata['source_code_uri'] = 'https://github.com/mindee/mindee-api-ruby'
@@ -28,7 +27,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6')
+
   spec.add_runtime_dependency 'marcel', '~> 1.0.2'
-  spec.add_runtime_dependency 'mrz', '~> 0.2.0'
-  spec.add_runtime_dependency 'origami', '~> 2.1.0'
+  spec.add_runtime_dependency 'mrz', '~> 0.2'
+  spec.add_runtime_dependency 'origamindee', '~> 3.0'
+
+  spec.add_development_dependency 'rake', '~> 12.3.1'
+  spec.add_development_dependency 'rspec', '~> 3.11'
+  spec.add_development_dependency 'rubocop', '~> 1.41'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
-- Mindee
+- Mindee, SA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-08 00:00:00.000000000 Z
+date: 2022-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marcel
@@ -30,29 +30,71 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: origami
+  name: origamindee
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
-description: 
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.41'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.41'
+description: Quickly and easily connect to Mindee's API services using Ruby.
 email:
 - devrel@mindee.co
 executables:
@@ -63,9 +105,11 @@ extra_rdoc_files: []
 files:
 - ".gitattributes"
 - ".gitignore"
+- ".gitmodules"
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
@@ -114,14 +158,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Mindee API Helper Library for Ruby