veryfi 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0b98174bc21d552218a407a17a0801218b4a93c76adbd6676d081e6c98eb9c7
-  data.tar.gz: edf7a6c1f283eb3d2f4369554c72dd6fb627674b2dc752f1040f145537197946
+  metadata.gz: 6a8a7ef98c7b70d163aa1913799e26981c1a3297e510cf561c1ad7295791c037
+  data.tar.gz: 2fadf010651b719a5849c229f0db4ade66332dc93fc789e28ca7c76c4f53952a
 SHA512:
-  metadata.gz: 21251717fe8fe9e0c424700ff1d1b0776f089cabe764fb55c3abf5509eb94014021bdaf64cbe8fbe1571f2840049b0c02367a655d5fa6f6887cd924cfdbb4363
-  data.tar.gz: 603f846c3eb5376b2c21380c7b47a2544203fde58beb88a310e582643b58e38589c785551710b4d992feaf38625d55c77d3a95efd3f00751276f84382021d6b1
+  metadata.gz: a1c27daa4725f3e8c112fbbb49aee4f0b724aede5135152c5879ae4bcfd6c2747764dbf891a02e0199a64511b99ca0499d70315a64dfa1859153c53617f780e3
+  data.tar.gz: e600661fdde8df1cfa89c7d804cb7a32a215a53e3d59522eeea8ed012a654c4f693ad85207efa532e5fc6d3f80efa32eda450d49c96fbd8510a8430027ef21a9

data/.github/workflows/release.yml

@@ -1,9 +1,7 @@
 name: Release
-
 on:
-  workflow_dispatch:
-    branches:
-      - main
+  release:
+    types: [created]
 
 jobs:
   publish:
@@ -22,5 +20,5 @@ jobs:
         env:
           RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
           RELEASE_COMMAND: bin/release
-          GIT_EMAIL: slava@skdev.info
+          GIT_EMAIL: support@veryfi.com
           GIT_NAME: Github Action

data/.github/workflows/test.yml

@@ -1,6 +1,8 @@
 name: Test
 
-on: [push, pull_request]
+on:
+  pull_request:
+    branches: [ main ]
 
 jobs:
   build:

data/.gitignore

@@ -18,3 +18,4 @@ _yardoc
 doc/
 
 .env
+.idea/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    veryfi (0.1.2)
+    veryfi (1.0.0)
       base64 (~> 0.1)
       faraday (~> 1.7)
       openssl (~> 2.2)
@@ -12,7 +12,7 @@ GEM
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
-    base64 (0.1.0)
+    base64 (0.1.1)
     bundler-audit (0.9.0)
       bundler (>= 1.2.0, < 3)
       thor (~> 1.0)
@@ -21,29 +21,35 @@ GEM
       rexml
     diff-lcs (1.4.4)
     docile (1.4.0)
-    faraday (1.7.1)
+    faraday (1.10.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
       faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
+      faraday-net_http_persistent (~> 1.0)
       faraday-patron (~> 1.0)
       faraday-rack (~> 1.0)
-      multipart-post (>= 1.2, < 3)
+      faraday-retry (~> 1.0)
       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.3)
+      multipart-post (>= 1.2, < 3)
     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)
+    ipaddr (1.2.4)
     method_source (1.0.0)
     multipart-post (2.1.1)
-    openssl (2.2.0)
+    openssl (2.2.1)
+      ipaddr
     parallel (1.20.1)
     parser (3.0.2.0)
       ast (~> 2.4.1)
@@ -103,6 +109,7 @@ GEM
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  ruby
   x86_64-darwin-19
   x86_64-linux
 

data/README.md

@@ -3,14 +3,15 @@
 ![Veryfi Logo](https://cdn.veryfi.com/logos/veryfi-logo-wide-github.png)
 
 [![Version](https://img.shields.io/gem/v/veryfi)](https://rubygems.org/gems/veryfi)
-[![Test](https://github.com/slavakisel/veryfi-ruby/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/slavakisel/veryfi-ruby/actions/workflows/test.yml)
+[![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/slavakisel/veryfi-ruby/main/coverage/coverage-badge.png)](https://raw.githubusercontent.com/slavakisel/veryfi-ruby/main/coverage/coverage-badge.png)
+[![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)
 
 ## Table of Contents
 
 - [Veryfi SDK for Ruby](#veryfi-sdk-for-ruby)
   - [Table of Contents](#table-of-contents)
+  - [Example](#example)
   - [Installation](#installation)
   - [Getting Started](#getting-started)
     - [Obtaining Client ID and user keys](#obtaining-client-id-and-user-keys)
@@ -23,6 +24,202 @@
 
 **veryfi-ruby** is a Ruby gem for communicating with the [Veryfi OCR API](https://veryfi.com/api/)
 
+## Example
+
+Below is a sample script using <a href="https://www.veryfi.com" target="_blank">**Veryfi**</a> for OCR and extracting data from a document:
+
+```ruby
+require 'veryfi'
+
+veryfi_client = Veryfi::Client.new(
+  client_id: 'your_client_id',
+  client_secret: 'your_client_secret',
+  username: 'your_username',
+  api_key: 'your_password'
+)
+```
+
+This submits a document for processing (3-5 seconds for a response)
+
+```ruby
+params = {
+  file_path: './test/receipt.jpg',
+  auto_delete: true,
+  boost_mode: false,
+  async: false,
+  external_id: '123456789',
+  max_pages_to_process: 10,
+  tags: ['tag1'],
+  categories: [
+    'Advertising & Marketing',
+    'Automotive'
+  ]
+}
+
+response = veryfi_client.document.process(params)
+
+puts response
+```
+
+...or with a URL
+
+```ruby
+params = {
+  file_url: 'https://raw.githubusercontent.com/veryfi/veryfi-python/master/tests/assets/receipt_public.jpg',
+  auto_delete: true,
+  boost_mode: false,
+  async: false,
+  external_id: '123456789',
+  max_pages_to_process: 10,
+  tags: ['tag1'],
+  categories: [
+    'Advertising & Marketing',
+    'Automotive'
+  ]
+}
+
+response = veryfi_client.document.process_url(params)
+
+puts response
+```
+
+This will produce the following response:
+
+```json
+{
+  "abn_number": "",
+  "account_number": "",
+  "bill_to_address": "2 Court Square\nNew York, NY 12210",
+  "bill_to_name": "John Smith",
+  "bill_to_vat_number": "",
+  "card_number": "",
+  "cashback": 0,
+  "category": "Repairs & Maintenance",
+  "created": "2021-06-28 19:20:02",
+  "currency_code": "USD",
+  "date": "2019-02-11 00:00:00",
+  "delivery_date": "",
+  "discount": 0,
+  "document_reference_number": "",
+  "document_title": "",
+  "document_type": "invoice",
+  "due_date": "2019-02-26",
+  "duplicate_of": 37055375,
+  "external_id": "",
+  "id": 37187909,
+  "img_file_name": "receipt.png",
+  "img_thumbnail_url": "https://scdn.veryfi.com/receipts/thumbnail.png",
+  "img_url": "https://scdn.veryfi.com/receipts/receipt.png",
+  "insurance": "",
+  "invoice_number": "US-001",
+  "is_duplicate": 1,
+  "line_items": [
+    {
+      "date": "",
+      "description": "Front and rear brake cables",
+      "discount": 0,
+      "id": 68004313,
+      "order": 0,
+      "price": 100,
+      "quantity": 1,
+      "reference": "",
+      "section": "",
+      "sku": "",
+      "tax": 0,
+      "tax_rate": 0,
+      "total": 100,
+      "type": "product",
+      "unit_of_measure": ""
+    },
+    {
+      "date": "",
+      "description": "New set of pedal arms",
+      "discount": 0,
+      "id": 68004315,
+      "order": 1,
+      "price": 15,
+      "quantity": 2,
+      "reference": "",
+      "section": "",
+      "sku": "",
+      "tax": 0,
+      "tax_rate": 0,
+      "total": 30,
+      "type": "product",
+      "unit_of_measure": ""
+    },
+    {
+      "date": "",
+      "description": "Labor 3hrs",
+      "discount": 0,
+      "id": 68004316,
+      "order": 2,
+      "price": 5,
+      "quantity": 3,
+      "reference": "",
+      "section": "",
+      "sku": "",
+      "tax": 0,
+      "tax_rate": 0,
+      "total": 15,
+      "type": "service",
+      "unit_of_measure": ""
+    }
+  ],
+  "notes": "",
+  "ocr_text": "\n\fEast Repair Inc.\n1912 Harvest Lane\nNew York, NY 12210\n\nBILL TO\t\tSHIP TO\tRECEIPT #\tUS-001\nJohn Smith\t\tJohn Smith\tRECEIPT DATE\t11/02/2019\n2 Court Square\t3787 Pineview Drive\n\tP.O.#\t2312/2019\nNew York, NY 12210\tCambridge, MA 12210\n\tDUE DATE\t26/02/2019\nReceipt Total\t\t\t$154.06\n\nQTY DESCRIPTION\t\t\tUNIT PRICE\tAMOUNT\n1\tFront and rear brake cables\t\t100.00\t100.00\n2\tNew set of pedal arms\t\t\t15.00\t30.00\n3\tLabor 3hrs\t\t\t\t5.00\t15.00\n\n\tSubtotal\t145.00\n\tSales Tax 6.25%\t9.06\n\nTERMS & CONDITIONS\nPayment is due within 15 days\nPlease make checks payable to: East Repair\n\tJohn Smith\n\tInc.\n",
+  "order_date": "",
+  "payment_display_name": "",
+  "payment_terms": "15 days",
+  "payment_type": "",
+  "phone_number": "",
+  "purchase_order_number": "2312/2019",
+  "rounding": 0,
+  "service_end_date": "",
+  "service_start_date": "",
+  "ship_date": "",
+  "ship_to_address": "3787 Pineview Drive\nCambridge, MA 12210",
+  "ship_to_name": "John Smith",
+  "shipping": 0,
+  "store_number": "",
+  "subtotal": 145,
+  "tax": 9.06,
+  "tax_lines": [
+    {
+      "base": 0,
+      "name": "Sales",
+      "order": 0,
+      "rate": 6.25,
+      "total": 9.06
+    }
+  ],
+  "tip": 0,
+  "total": 154.06,
+  "total_weight": "",
+  "tracking_number": "",
+  "updated": "2021-06-28 19:20:03",
+  "vat_number": "",
+  "vendor": {
+    "address": "1912 Harvest Lane\nNew York, NY 12210",
+    "category": "Car Repair",
+    "email": "",
+    "fax_number": "",
+    "name": "East Repair",
+    "phone_number": "",
+    "raw_name": "East Repair Inc.",
+    "vendor_logo": "https://cdn.veryfi.com/logos/tmp/560806841.png",
+    "vendor_reg_number": "",
+    "vendor_type": "Car Repair",
+    "web": ""
+  },
+  "vendor_account_number": "",
+  "vendor_bank_name": "",
+  "vendor_bank_number": "",
+  "vendor_bank_swift": "",
+  "vendor_iban": ""
+}
+```
+
 ## Installation
 
 ```bash
@@ -42,7 +239,7 @@ If you don't have an account with Veryfi, please go ahead and register here: [ht
 
 ### Ruby API Client Library
 
-The **veryfi-ruby** gem can be used to communicate with Veryfi API. All available functionality is described [in docs](https://skdev.info/veryfi-ruby/)
+The **veryfi-ruby** gem can be used to communicate with Veryfi API. All available functionality is described [in docs](https://veryfi.github.io/veryfi-ruby/)
 
 ## Need help?
 
@@ -66,3 +263,11 @@ bin/setup
 ## Develop
 
 `bin/ci` checks your specs and runs quality tools
+
+## 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

data/bin/release

@@ -7,3 +7,6 @@ gem build veryfi.gemspec
 gem_version=$(ruby -r rubygems -e "puts Gem::Specification::load('$(ls *.gemspec)').version")
 
 gem push veryfi-$gem_version.gem
+
+git tag v$gem_version
+git push --tags

data/docs/_config.yml

@@ -23,7 +23,7 @@ email: support@veryfi.com
 description: >- # this means to ignore newlines until "baseurl:"
   Veryfi is a Ruby gem for communicating with the Veryfi OCR API
 baseurl: "/veryfi-ruby" # the subpath of your site, e.g. /blog
-url: "https://skdev.info" # the base hostname & protocol for your site, e.g. http://example.com
+url: "https://veryfi.github.io" # the base hostname & protocol for your site, e.g. http://example.com
 github_username:  veryfi
 markdown: kramdown
 # Build settings

data/docs/index.markdown

@@ -30,9 +30,9 @@ This submits a document for processing (3-5 seconds for a response)
 ```ruby
 params = {
   file_path: './test/receipt.jpg',
-  auto_delete: 1,
-  boost_mode: 1,
-  async: 1,
+  auto_delete: true,
+  boost_mode: false,
+  async: false,
   external_id: '123456789',
   max_pages_to_process: 10,
   tags: ['tag1'],
@@ -52,9 +52,9 @@ puts response
 ```ruby
 params = {
   file_url: "https://raw.githubusercontent.com/veryfi/veryfi-python/master/tests/assets/receipt_public.jpg",
-  auto_delete: 1,
-  boost_mode: 1,
-  async: 1,
+  auto_delete: true,
+  boost_mode: false,
+  async: false,
   external_id: "123456789",
   max_pages_to_process: 10,
   tags: ["tag1"],

data/lib/veryfi/api/document.rb

@@ -30,17 +30,15 @@ module Veryfi
       end
 
       def all(params = {})
-        response = request.get("/partner/documents/", params)
-
-        response.is_a?(Hash) ? [response] : response
+        request.get("/partner/documents/", params)
       end
 
       def process(raw_params)
         params = setup_create_params(raw_params)
 
         file_content = File.read(params[:file_path])
-        file_name = File.basename(params[:file_path], ".*")
         file_data = Base64.encode64(file_content).gsub("\n", "")
+        file_name = params[:file_name] || File.basename(params[:file_path], ".*")
 
         payload = params.reject { |k| k == :file_path }.merge(
           file_name: file_name,

data/lib/veryfi/api/line_item.rb

@@ -11,7 +11,6 @@ module Veryfi
 
       def all(document_id, params = {})
         response = request.get("/partner/documents/#{document_id}/line-items/", params)
-
         response["line_items"]
       end
 

data/lib/veryfi/client.rb

@@ -10,7 +10,7 @@ module Veryfi
       username:,
       api_key:,
       base_url: "https://api.veryfi.com/api/",
-      api_version: "v7",
+      api_version: "v8",
       timeout: 20
     )
       @request = Veryfi::Request.new(client_id, client_secret, username, api_key, base_url, api_version, timeout)

data/lib/veryfi/request.rb

@@ -90,7 +90,7 @@ module Veryfi
 
     def default_headers
       {
-        "User-Agent": "Ruby Veryfi-Ruby/0.1.0",
+        "User-Agent": "Ruby Veryfi-Ruby/#{Veryfi::VERSION}",
         "Accept": "application/json",
         "Content-Type": "application/json",
         "Client-Id": client_id,

data/lib/veryfi/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: veryfi
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Veryfi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-01 00:00:00.000000000 Z
+date: 2022-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64