veryfi 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e76ca53e07b9d595cfb93471f80c3d50c30dbf825a70145455748da08360de06
-  data.tar.gz: 32c8da0659268914dbd9f8cc409ee99108ce6f06020fd7cfc35ad4186db4f83e
+  metadata.gz: d280de38639eaaeb484040824fcf42c349c6b6390d864c5724fed22aec5a77c3
+  data.tar.gz: cb1d308624e3f46e1fbc68df6aa6d638b498d633ccd1040f3528b171b89b1b30
 SHA512:
-  metadata.gz: 4d01d1effd328af56369a59d38b75189ce8e1627f3d20520e6f4306848dd33971745149c018708210702878aa48ffabaec156ebe1e170f154d6f5f6cde4c254d
-  data.tar.gz: 1c4d1f124435ebdce031cfccf1f9fafaa415f07ec981f5aa1807ebee561d9d5f332bda90e29e696de21d3c98c02df116e38bec545ca66bf5c0dfd177ba7e46e3
+  metadata.gz: d893497e1423f04858a3c5195659fa8a9d49195877ae41b4c64eff05d9ea529ac9b5c9719953d1353d283e6a70194f06a967e072b50ff0738f8ed77b4db57d01
+  data.tar.gz: 88302d51b112d6ecfff260d9fd1508bf09c02478b0c267cd168f8fdd3f8a68d6b60c68dc5a2f6d901eaa9bf34ad1debfb309226f427cd296d22709edf59383a5

data/.github/workflows/release.yml

@@ -1,14 +1,15 @@
 name: Release
 on:
-  release:
-    types: [created]
+  workflow_dispatch:
+    branches:
+      - main
 
 jobs:
   publish:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/Gemfile.lock

@@ -1,80 +1,76 @@
 PATH
   remote: .
   specs:
-    veryfi (1.0.1)
+    veryfi (2.0.0)
       base64 (~> 0.1)
-      faraday (~> 1.7)
+      faraday (>= 1.7, < 3.0)
       openssl (>= 2.2, < 3.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    activesupport (6.1.7.8)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
-    base64 (0.1.1)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
     bundler-audit (0.9.1)
       bundler (>= 1.2.0, < 3)
       thor (~> 1.0)
     coderay (1.1.3)
-    crack (0.4.5)
+    concurrent-ruby (1.3.3)
+    crack (1.0.0)
+      bigdecimal
       rexml
-    diff-lcs (1.5.0)
+    diff-lcs (1.5.1)
     docile (1.4.0)
-    faraday (1.10.1)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      faraday-retry (~> 1.0)
+    faraday (2.8.1)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.4)
-      multipart-post (~> 2)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday-retry (1.0.3)
-    hashdiff (1.0.1)
-    method_source (1.0.0)
-    multipart-post (2.2.3)
-    openssl (3.0.0)
-    parallel (1.22.1)
-    parser (3.1.2.1)
+    faraday-net_http (3.0.2)
+    hashdiff (1.1.0)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    method_source (1.1.0)
+    minitest (5.23.1)
+    openssl (3.0.2)
+    parallel (1.24.0)
+    parser (3.3.2.0)
       ast (~> 2.4.1)
-    pry (0.14.1)
+      racc
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.7)
+    public_suffix (5.0.5)
+    racc (1.8.0)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.5.0)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.2.9)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
+      rspec-support (~> 3.13.0)
     rspec-its (1.3.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.11.1)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
     rubocop (0.93.1)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
@@ -84,38 +80,45 @@ GEM
       rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.21.0)
-      parser (>= 3.1.1.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
     rubocop-rspec (1.44.1)
       rubocop (~> 0.87)
       rubocop-ast (>= 0.7.1)
-    ruby-progressbar (1.11.0)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
-    simplecov (0.21.2)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-badge (2.0.2)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    thor (1.2.1)
+    strscan (3.1.0)
+    thor (1.3.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (1.8.0)
     vcr (6.1.0)
-    webmock (3.17.1)
+    webmock (3.23.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.6.15)
 
 PLATFORMS
+  arm64-darwin-23
   ruby
   x86_64-darwin-19
   x86_64-linux
 
 DEPENDENCIES
+  activesupport (~> 6.0)
   bundler (~> 2.2)
   bundler-audit (~> 0.9)
   pry (~> 0.14)
   rake (~> 13.0)
+  rexml (~> 3.2.7)
   rspec (~> 3.9)
   rspec-its (~> 1.3)
   rubocop (~> 0.82)
@@ -127,4 +130,4 @@ DEPENDENCIES
   webmock (~> 3.14)
 
 BUNDLED WITH
-   2.2.33
+   2.2.26

data/README.md

@@ -1,15 +1,19 @@
 # Veryfi SDK for Ruby
 
-![Veryfi Logo](https://cdn.veryfi.com/logos/veryfi-logo-wide-github.png)
+<img src="https://user-images.githubusercontent.com/30125790/212157461-58bdc714-2f89-44c2-8e4d-d42bee74854e.png#gh-dark-mode-only" width="200">
+<img src="https://user-images.githubusercontent.com/30125790/212157486-bfd08c5d-9337-4b78-be6f-230dc63838ba.png#gh-light-mode-only" width="200">
 
 [![Version](https://img.shields.io/gem/v/veryfi)](https://rubygems.org/gems/veryfi)
 [![Test](https://github.com/veryfi/veryfi-ruby/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/veryfi/veryfi-ruby/actions/workflows/test.yml)
-
 [![Coverage](https://raw.githubusercontent.com/veryfi/veryfi-ruby/main/coverage/coverage-badge.png)](https://raw.githubusercontent.com/veryfi/veryfi-ruby/main/coverage/coverage-badge.png)
 
+**veryfi-ruby** is a Ruby gem for communicating with the [Veryfi OCR API](https://veryfi.com/api/)
+
+[Documentation](https://veryfi.github.io/veryfi-ruby/)
+
 ## Table of Contents
 
-- [Veryfi SDK for Ruby](#veryfi-sdk-for-ruby)
+- [Top](#veryfi-sdk-for-ruby)
   - [Table of Contents](#table-of-contents)
   - [Example](#example)
   - [Installation](#installation)
@@ -22,7 +26,6 @@
   - [Quality tools](#quality-tools)
   - [Develop](#develop)
 
-**veryfi-ruby** is a Ruby gem for communicating with the [Veryfi OCR API](https://veryfi.com/api/)
 
 ## Example
 
@@ -267,7 +270,7 @@ bin/setup
 ## Release
 
 1. Change version in `lib/veryfi/version.rb`
-2. Run bundle - this should update `Gemfile.lock`
-3. Commit changes and push to Github
-4. On Github go to `Actions` -> `Release` -> and click `Run workflow` to trigger release
-5. Workflow will publish gem to [Rubygems](https://rubygems.org/gems/veryfi) and also create a new tag in repository
+2. Run `bundle` - this should update `Gemfile.lock`
+3. Commit changes, push to a new Github branch, and merge
+4. On Github go to `Actions` -> `Release` -> and click `Run workflow` to trigger a new release
+5. Release workflow will publish gem to [Rubygems](https://rubygems.org/gems/veryfi)

data/lib/veryfi/error.rb

@@ -1,63 +1,32 @@
 # frozen_string_literal: true
 
+require "json"
+
 module Veryfi
   class Error
     def self.from_response(status, response)
       if response.empty?
         VeryfiError.new(format("%<code>d", code: status))
       else
-        get_error(status, response)
-      end
-    end
-
-    def self.get_error(status, response)
-      case status
-      when 400 then BadRequest
-      when 401 then UnauthorizedAccessToken
-      when 404 then ResourceNotFound
-      when 405 then UnexpectedHTTPMethod
-      when 409 then AccessLimitReached
-      when 500 then InternalError
-      else VeryfiError.new(format("%<code>d, %<message>s", code: status, message: response["error"]))
-      end
-    end
-    class BadRequest < StandardError
-      def to_s
-        "400, Bad Request"
-      end
-    end
-
-    class UnauthorizedAccessToken < StandardError
-      def to_s
-        "401, Unauthorized Access Token"
-      end
-    end
-
-    class ResourceNotFound < StandardError
-      def to_s
-        "404, Resource not found"
+        VeryfiError.new(format("%<code>d, %<message>s", code: status, message: response["error"]), response)
       end
     end
 
-    class UnexpectedHTTPMethod < StandardError
-      def to_s
-        "405, Unexpected HTTP Method"
-      end
-    end
+    class VeryfiError < StandardError
+      attr_reader :message
 
-    class AccessLimitReached < StandardError
-      def to_s
-        "409, Access Limit Reached"
+      def initialize(message = "An error occurred", response = {})
+        @message = if response.empty?
+          message
+        else
+          JSON.pretty_generate(response)
+        end
+        super(message)
       end
-    end
 
-    class InternalError < StandardError
       def to_s
-        "500, Internal Server Error"
+        message
       end
     end
-
-    class VeryfiError < StandardError
-    end
   end
 end

data/lib/veryfi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Veryfi
-  VERSION = "1.0.1"
+  VERSION = "2.0.0"
 end

data/veryfi.gemspec

@@ -14,9 +14,52 @@ Gem::Specification.new do |spec|
 
   spec.homepage      = "https://rubygems.org/gems/veryfi"
 
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
+  # Affected by git permissions issue
+  # spec.files = `git ls-files -z`.split("\x0").reject do |f|
+  #   f.match(%r{^(test|spec|features)/})
+  # end
+
+  spec.files = [
+    ".github/workflows/release.yml",
+    ".github/workflows/test.yml",
+    ".gitignore",
+    ".rspec",
+    ".rubocop.yml",
+    ".ruby-version",
+    ".semaphore/semaphore.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "README.md",
+    "bin/autospec",
+    "bin/bundle-audit",
+    "bin/ci",
+    "bin/console",
+    "bin/quality",
+    "bin/release",
+    "bin/rspec",
+    "bin/rubocop",
+    "bin/setup",
+    "coverage/coverage-badge.png",
+    "docs/.gitignore",
+    "docs/404.html",
+    "docs/_config.yml",
+    "docs/_includes/footer.html",
+    "docs/_includes/header.html",
+    "docs/index.markdown",
+    "lib/.keep",
+    "lib/veryfi.rb",
+    "lib/veryfi/api/document.rb",
+    "lib/veryfi/api/document_tag.rb",
+    "lib/veryfi/api/line_item.rb",
+    "lib/veryfi/api/tag.rb",
+    "lib/veryfi/client.rb",
+    "lib/veryfi/error.rb",
+    "lib/veryfi/request.rb",
+    "lib/veryfi/signature.rb",
+    "lib/veryfi/version.rb",
+    "veryfi.gemspec"
+  ]
+  
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
@@ -25,7 +68,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "base64", "~> 0.1"
   spec.add_dependency "openssl", ">= 2.2", "< 3.1"
 
-  spec.add_dependency "faraday", "~> 1.7"
+  spec.add_dependency "faraday", ">= 1.7", "< 3.0"
 
   spec.add_development_dependency "bundler", "~> 2.2"
   spec.add_development_dependency "bundler-audit", "~> 0.9"
@@ -39,4 +82,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov-badge", "~> 2.0"
   spec.add_development_dependency "vcr", "~> 6.0"
   spec.add_development_dependency "webmock", "~> 3.14"
+  spec.add_development_dependency "rexml", "~> 3.2.7"
+  spec.add_development_dependency "activesupport", "~> 6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: veryfi
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Veryfi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-18 00:00:00.000000000 Z
+date: 2024-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -48,16 +48,22 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -226,6 +232,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.14'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.7
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 description: 
 email:
 - support@veryfi.com