veryfi 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71ed0e3845f85312d16f9821240b9e04bb86bbeb0637a25970251543472d9edc
-  data.tar.gz: 5daffbc243cc62df5bfbb4d18d72a5741850ddc59be6ba970f3f2f098db03f56
+  metadata.gz: 972fb13315f5c1012a72fbfe8d2c9647c6bf84cd4f5647df3d520d28aed07e28
+  data.tar.gz: a61e364851843f93804116308577155722ec30b6366e946eb4057025a4cc5b4d
 SHA512:
-  metadata.gz: ee64c026cd35bde32a2d116c5d2bfc9ee5e3581b3d096540b3c98688e6e94e161b2c7cf7cb342e862de7785dcb311864822e7563cebf4f6b0114535da2248d32
-  data.tar.gz: fe14f1092b352c8b20a64fc61d92f5c450d9189abeeb0d325ab1acf1069732fb1a1d34eb6bb12ed54536eef1c1dd7eeec0922c13dcae8d09d8939b6fe93375d3
+  metadata.gz: 397640a0588d132fcd069665a32252653f57518fbc55d7e49c520ad61bede0a3f19c56594e3c5f33df9cd5ac313f0eaf16c540a60f26a993b7f660eba2f1adb2
+  data.tar.gz: 15defaabd5b76bdc06ad95eb20c6336d26736a986e8c6a4d136f46a6406076aa49a9d2ed278f805d415db8482a8697bdfe0b72e8636216bb31e784265c242901

data/.rubocop.yml

@@ -60,6 +60,24 @@ Metrics/BlockLength:
 Naming/MemoizedInstanceVariableName:
   EnforcedStyleForLeadingUnderscores: required
 
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/DescribeClass:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 5
+
+RSpec/SharedExamples:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
 Style/HashEachMethods:
   Enabled: true
 

data/Gemfile.lock

@@ -92,17 +92,17 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler
-  bundler-audit
-  pry
-  rake
-  rspec
-  rspec-its
-  rubocop
-  rubocop-rspec
-  vcr
+  bundler (~> 1.17)
+  bundler-audit (~> 0.6)
+  pry (~> 0.14)
+  rake (~> 13.0)
+  rspec (~> 3.9)
+  rspec-its (~> 1.3)
+  rubocop (~> 0.82)
+  rubocop-rspec (~> 1.38)
+  vcr (~> 6.0)
   veryfi!
-  webmock
+  webmock (~> 3.14)
 
 BUNDLED WITH
    1.17.2

data/README.md

@@ -11,8 +11,8 @@
     - [Obtaining Client ID and user keys](#obtaining-client-id-and-user-keys)
     - [Ruby API Client Library](#ruby-api-client-library)
     - [Extracting Data](#extracting-data)
-    - [Response](#response)
-    - [Updating a document](#updating-a-document)
+    - [Document Response Example](#document-response-example)
+    - [Other methods](#other-methods)
   - [Need help?](#need-help)
     - [Learn more at our blog](#learn-more-at-our-blog)
   - [Tutorial Video](#tutorial-video)
@@ -31,7 +31,7 @@ gem install veryfi
 
 Or add to your Gemfile:
 ```ruby
-gem 'veryfi'
+gem 'veryfi', '>= 0.1.0'
 ```
 
 ## Getting Started
@@ -57,15 +57,26 @@ veryfi_client = Veryfi::Client.new(
   username: 'your_username',
   api_key: 'your_password'
 )
-
-categories = ['Grocery', 'Utilities', 'Travel'];
-file_path = './test/receipt.png';
 ```
 
 This submits a document for processing (3-5 seconds for a response)
 
 ```ruby
-response = veryfi_client.process_document(file_path, categories)
+params = {
+  file_path: './test/receipt.jpg',
+  auto_delete: 1,
+  boost_mode: 1,
+  async: 1,
+  external_id: '123456789',
+  max_pages_to_process: 10,
+  tags: ['tag1'],
+  categories: [
+    'Advertising & Marketing',
+    'Automotive'
+  ]
+}
+
+response = veryfi_client.document.process(params)
 
 puts response
 ```
@@ -73,12 +84,26 @@ puts response
 ...or with a URL
 
 ```ruby
-response = veryfi_client.process_document_url(url, external_id)
+params = {
+  file_url: "https://raw.githubusercontent.com/veryfi/veryfi-python/master/tests/assets/receipt_public.jpg",
+  auto_delete: 1,
+  boost_mode: 1,
+  async: 1,
+  external_id: "123456789",
+  max_pages_to_process: 10,
+  tags: ["tag1"],
+  categories: [
+    "Advertising & Marketing",
+    "Automotive"
+  ]
+}
+
+response = veryfi_client.document.process_url(params)
 
 puts response
 ```
 
-### Response
+### Document Response Example
 
 ```json
 {
@@ -215,9 +240,50 @@ puts response
 }
 ```
 
-### Updating a document
+### Other methods
 
 ```ruby
+# Update document
+veryfi_client.document.update(document_id, params)
+
+# Delete document by ID
+veryfi_client.document.delete(document_id)
+
+# Get document by ID
+veryfi_client.document.get(document_id)
+
+# List all documents
+veryfi_client.document.all
+
+# Get document line items
+veryfi_client.line_items.all(document_id)
+
+# Get line item by document id and line item id
+veryfi_client.line_items.get(document_id, id)
+
+# Create/update/delete document line item
+veryfi_client.line_items.create(document_id, params)
+veryfi_client.line_items.update(document_id, params)
+veryfi_client.line_items.delete(document_id, params)
+
+# Tags
+# List all tags
+veryfi_client.tag.all
+
+# Delete a tag by ID
+veryfi_client.tag.delete(id)
+
+# List all document tags
+veryfi_client.document_tag.all(document_id)
+
+# Add tag to document
+veryfi_client.document_tag.add(document_id, name: "tag_name")
+
+# Delete tag by document id and tag id
+veryfi_client.document_tag.delete(document_id, id)
+
+# Delete all document tags
+veryfi_client.document_tag.delete_all(document_id)
 ```
 
 ## Need help?
@@ -225,7 +291,6 @@ puts response
 If you run into any issue or need help installing or using the library, please contact support@veryfi.com.
 
 If you found a bug in this library or would like new features added, then open an issue or pull requests against this repo!
-
 ### [Learn more at our blog](https://www.veryfi.com/ruby/)
 
 ## Tutorial Video

data/lib/veryfi/api/document.rb

@@ -1,8 +1,28 @@
 # frozen_string_literal: true
 
+require "Base64"
+
 module Veryfi
   module Api
     class Document
+      CATEGORIES = [
+        "Advertising & Marketing",
+        "Automotive",
+        "Bank Charges & Fees",
+        "Legal & Professional Services",
+        "Insurance",
+        "Meals & Entertainment",
+        "Office Supplies & Software",
+        "Taxes & Licenses",
+        "Travel",
+        "Rent & Lease",
+        "Repairs & Maintenance",
+        "Payroll",
+        "Utilities",
+        "Job Supplies",
+        "Grocery"
+      ].freeze
+
       attr_reader :request
 
       def initialize(request)
@@ -12,12 +32,51 @@ module Veryfi
       def all(params = {})
         response = request.get("/partner/documents/", params)
 
-        Array(response)
+        response.is_a?(Hash) ? [response] : response
+      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", "")
+
+        payload = params.reject { |k| k == :file_path }.merge(
+          file_name: file_name,
+          file_data: file_data
+        )
+
+        request.post("/partner/documents/", payload)
+      end
+
+      def process_url(raw_params)
+        params = setup_create_params(raw_params)
+
+        request.post("/partner/documents/", params)
       end
 
       def get(id, params = {})
         request.get("/partner/documents/#{id}", params)
       end
+
+      def update(id, params)
+        request.put("/partner/documents/#{id}", params)
+      end
+
+      def delete(id)
+        request.delete("/partner/documents/#{id}")
+      end
+
+      private
+
+      def setup_create_params(raw_params)
+        params = raw_params.transform_keys(&:to_sym)
+
+        params[:categories] = CATEGORIES if params[:categories].to_a.empty?
+
+        params
+      end
     end
   end
 end

data/lib/veryfi/api/document_tag.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Veryfi
+  module Api
+    class DocumentTag
+      attr_reader :request
+
+      def initialize(request)
+        @request = request
+      end
+
+      def all(document_id, params = {})
+        response = request.get("/partner/documents/#{document_id}/tags/", params)
+
+        response["tags"]
+      end
+
+      def add(document_id, params)
+        request.put("/partner/documents/#{document_id}/tags/", params)
+      end
+
+      def delete_all(document_id)
+        request.delete("/partner/documents/#{document_id}/tags/")
+      end
+
+      def delete(document_id, id)
+        request.delete("/partner/documents/#{document_id}/tags/#{id}")
+      end
+    end
+  end
+end

data/lib/veryfi/api/line_item.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Veryfi
+  module Api
+    class LineItem
+      attr_reader :request
+
+      def initialize(request)
+        @request = request
+      end
+
+      def all(document_id, params = {})
+        response = request.get("/partner/documents/#{document_id}/line-items/", params)
+
+        response["line_items"]
+      end
+
+      def create(document_id, params)
+        request.post("/partner/documents/#{document_id}/line-items/", params)
+      end
+
+      def get(document_id, id, params = {})
+        request.get("/partner/documents/#{document_id}/line-items/#{id}", params)
+      end
+
+      def update(document_id, id, params)
+        request.put("/partner/documents/#{document_id}/line-items/#{id}", params)
+      end
+
+      def delete(document_id, id)
+        request.delete("/partner/documents/#{document_id}/line-items/#{id}")
+      end
+    end
+  end
+end

data/lib/veryfi/api/tag.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Veryfi
+  module Api
+    class Tag
+      attr_reader :request
+
+      def initialize(request)
+        @request = request
+      end
+
+      def all(params = {})
+        response = request.get("/partner/tags/", params)
+
+        response["tags"]
+      end
+
+      def delete(id)
+        request.delete("/partner/tags/#{id}")
+      end
+    end
+  end
+end

data/lib/veryfi/client.rb

@@ -2,24 +2,6 @@
 
 module Veryfi
   class Client
-    CATEGORIES = [
-      "Advertising & Marketing",
-      "Automotive",
-      "Bank Charges & Fees",
-      "Legal & Professional Services",
-      "Insurance",
-      "Meals & Entertainment",
-      "Office Supplies & Software",
-      "Taxes & Licenses",
-      "Travel",
-      "Rent & Lease",
-      "Repairs & Maintenance",
-      "Payroll",
-      "Utilities",
-      "Job Supplies",
-      "Grocery"
-    ].freeze
-
     attr_reader :request
 
     def initialize(
@@ -29,7 +11,7 @@ module Veryfi
       api_key:,
       base_url: "https://api.veryfi.com/api/",
       api_version: "v7",
-      timeout: 120
+      timeout: 20
     )
       @request = Veryfi::Request.new(client_id, client_secret, username, api_key, base_url, api_version, timeout)
     end
@@ -38,6 +20,18 @@ module Veryfi
       @_document ||= Veryfi::Api::Document.new(request)
     end
 
+    def line_item
+      @_line_item ||= Veryfi::Api::LineItem.new(request)
+    end
+
+    def tag
+      @_tag ||= Veryfi::Api::Tag.new(request)
+    end
+
+    def document_tag
+      @_document_tag ||= Veryfi::Api::DocumentTag.new(request)
+    end
+
     def api_url
       request.api_url
     end

data/lib/veryfi/error.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Veryfi
+  class Error
+    def self.from_response(response)
+      case response.status
+      when 400 then BadRequest
+      when 401 then UnauthorizedAccessToken
+      when 405 then UnexpectedHTTPMethod
+      when 409 then AccessLimitReached
+      else InternalError
+      end
+    end
+
+    class BadRequest < StandardError
+      def to_s
+        "Bad Request"
+      end
+    end
+
+    class UnauthorizedAccessToken < StandardError
+      def to_s
+        "Unauthorized Access Token"
+      end
+    end
+
+    class UnexpectedHTTPMethod < StandardError
+      def to_s
+        "Unexpected HTTP Method"
+      end
+    end
+
+    class AccessLimitReached < StandardError
+      def to_s
+        "Access Limit Reached"
+      end
+    end
+
+    class InternalError < StandardError
+      def to_s
+        "Internal Server Error"
+      end
+    end
+  end
+end

data/lib/veryfi/request.rb

@@ -8,6 +8,8 @@ module Veryfi
   class Request
     attr_reader :client_id, :client_secret, :username, :api_key, :base_url, :api_version, :timeout
 
+    VERBS_WITH_BODIES = %i[post put].freeze
+
     def initialize(
       client_id,
       client_secret,
@@ -26,11 +28,20 @@ module Veryfi
       @timeout = timeout
     end
 
-    def get(path, params)
-      url = [api_url, path].join
-      headers = generate_headers(params)
-      response = Faraday.get(url, params, headers)
-      JSON.parse(response.body)
+    def get(path, params = {})
+      make_request(:get, path, params)
+    end
+
+    def put(path, params)
+      make_request(:put, path, params)
+    end
+
+    def post(path, params)
+      make_request(:post, path, params)
+    end
+
+    def delete(path)
+      make_request(:delete, path)
     end
 
     def api_url
@@ -39,6 +50,32 @@ module Veryfi
 
     private
 
+    def make_request(http_verb, path, params = {})
+      url = [api_url, path].join
+      body = generate_body(http_verb, params)
+      headers = generate_headers(params)
+
+      response = conn.public_send(http_verb, url, body, headers)
+
+      if response.success?
+        process_response(http_verb, response)
+      else
+        raise Veryfi::Error.from_response(response)
+      end
+    end
+
+    def conn
+      @_conn ||= Faraday.new do |conn|
+        conn.options.timeout = timeout
+      end
+    end
+
+    def generate_body(http_verb, params)
+      return params unless VERBS_WITH_BODIES.include?(http_verb)
+
+      params.to_json
+    end
+
     def generate_headers(params = {})
       return default_headers if client_secret.nil?
 
@@ -64,5 +101,11 @@ module Veryfi
     def generate_signature(params, timestamp)
       Veryfi::Signature.new(client_secret, params, timestamp).to_base64
     end
+
+    def process_response(_http_verb, response)
+      # return response if http_verb == :delete
+
+      JSON.parse(response.body)
+    end
   end
 end

data/lib/veryfi/version.rb

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

data/lib/veryfi.rb

@@ -4,9 +4,13 @@ module Veryfi
   autoload :VERSION, "veryfi/version"
   autoload :Signature, "veryfi/signature"
   autoload :Request, "veryfi/request"
+  autoload :Error, "veryfi/error"
 
   module Api
     autoload :Document, "veryfi/api/document"
+    autoload :LineItem, "veryfi/api/line_item"
+    autoload :Tag, "veryfi/api/tag"
+    autoload :DocumentTag, "veryfi/api/document_tag"
   end
 
   autoload :Client, "veryfi/client"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: veryfi
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Veryfi
@@ -205,7 +205,11 @@ files:
 - 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