veryfi 3.0.0 → 4.0.1

data/lib/veryfi/resource.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Veryfi
+  # A lightweight, dependency-free wrapper around an API response payload.
+  #
+  # `Resource` inherits from `Hash`, so anything that already treats the
+  # response as a hash keeps working unchanged:
+  #
+  #   response["id"]            # => 44691518
+  #   response.dig("vendor", "name")
+  #   response.is_a?(Hash)      # => true
+  #   JSON.pretty_generate(response)
+  #
+  # In addition, every key is also accessible as a method, recursively:
+  #
+  #   response.id               # => 44691518
+  #   response.vendor.name      # => "East Repair"
+  #   response.line_items.first.description
+  #   response.is_duplicate?    # => truthiness of self["is_duplicate"]
+  #
+  # Nested hashes are wrapped into Resources, and arrays of hashes become
+  # arrays of Resources. Other values (strings, numbers, booleans, nil)
+  # pass through untouched. Both string (`"id"`) and symbol (`:id`) keys
+  # work transparently.
+  class Resource < ::Hash
+    # Wrap any value coming back from the API. Hashes become Resources,
+    # arrays are mapped recursively, and everything else passes through.
+    #
+    # @param value [Object] raw value from `JSON.parse`
+    # @return [Object] wrapped value
+    def self.wrap(value)
+      return value if value.is_a?(Resource)
+
+      case value
+      when ::Hash  then new(value)
+      when ::Array then value.map { |v| wrap(v) }
+      else              value
+      end
+    end
+
+    def initialize(hash = {})
+      super()
+      hash.each_pair { |key, value| self[key.to_s] = Resource.wrap(value) }
+    end
+
+    def [](key)
+      super(key.to_s)
+    end
+
+    # rubocop:disable Style/ArgumentsForwarding -- keep explicit forwarding for clarity and Ruby 3.0 portability
+    def fetch(key, *args, &block)
+      super(key.to_s, *args, &block)
+    end
+    # rubocop:enable Style/ArgumentsForwarding
+
+    def key?(key)
+      super(key.to_s)
+    end
+    alias has_key? key?
+    alias include? key?
+    alias member? key?
+
+    # Returns a plain (unwrapped) `Hash` representation, recursively.
+    # Useful when you need to hand the data off to something that explicitly
+    # expects a plain Hash (e.g. some serializers).
+    #
+    # @return [Hash]
+    def to_h
+      each_with_object({}) do |(key, value), memo|
+        memo[key] = unwrap(value)
+      end
+    end
+    alias to_hash to_h
+
+    def respond_to_missing?(name, include_private = false)
+      string_name = name.to_s.chomp("?")
+      key?(string_name) || super
+    end
+
+    def method_missing(name, *args, &block)
+      string_name = name.to_s
+      bare_name = string_name.chomp("?")
+
+      if args.empty? && block.nil? && key?(bare_name)
+        value = self[bare_name]
+        string_name.end_with?("?") ? !value.nil? && value != false : value
+      else
+        super
+      end
+    end
+
+    private
+
+    def unwrap(value)
+      case value
+      when Resource then value.to_h
+      when ::Array  then value.map { |v| v.is_a?(Resource) ? v.to_h : v }
+      else               value
+      end
+    end
+  end
+end

data/lib/veryfi/version.rb

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

data/lib/veryfi.rb

@@ -4,14 +4,78 @@ module Veryfi
   autoload :VERSION, "veryfi/version"
   autoload :Signature, "veryfi/signature"
   autoload :Request, "veryfi/request"
+  autoload :Resource, "veryfi/resource"
   autoload :Error, "veryfi/error"
+  autoload :Configuration, "veryfi/configuration"
 
   module Api
+    autoload :FilePayload, "veryfi/api/file_payload"
+    autoload :TagOperations, "veryfi/api/tag_operations"
+
     autoload :Document, "veryfi/api/document"
     autoload :LineItem, "veryfi/api/line_item"
+    autoload :TaxLine, "veryfi/api/tax_line"
     autoload :Tag, "veryfi/api/tag"
     autoload :DocumentTag, "veryfi/api/document_tag"
+
+    autoload :AnyDocument, "veryfi/api/any_document"
+    autoload :BankStatement, "veryfi/api/bank_statement"
+    autoload :BankStatementSplit, "veryfi/api/bank_statement_split"
+    autoload :BusinessCard, "veryfi/api/business_card"
+    autoload :Check, "veryfi/api/check"
+    autoload :Classify, "veryfi/api/classify"
+    autoload :PdfSplit, "veryfi/api/pdf_split"
+    autoload :W2, "veryfi/api/w2"
+    autoload :W2Split, "veryfi/api/w2_split"
+    autoload :W8, "veryfi/api/w8"
+    autoload :W9, "veryfi/api/w9"
   end
 
   autoload :Client, "veryfi/client"
+
+  class << self
+    # Process-wide configuration, used by {Veryfi.client} as defaults when
+    # constructing the shared client. You can still call
+    # `Veryfi::Client.new(...)` directly to bypass this entirely.
+    #
+    # @example
+    #   Veryfi.configure do |c|
+    #     c.client_id     = ENV.fetch("VERYFI_CLIENT_ID")
+    #     c.client_secret = ENV.fetch("VERYFI_CLIENT_SECRET")
+    #     c.username      = ENV.fetch("VERYFI_USERNAME")
+    #     c.api_key       = ENV.fetch("VERYFI_API_KEY")
+    #   end
+    #
+    #   Veryfi.client.document.process(file_path: "./receipt.jpg")
+    #
+    # @yieldparam config [Veryfi::Configuration]
+    # @return [Veryfi::Configuration]
+    def configure
+      yield(configuration) if block_given?
+      configuration
+    end
+
+    # @return [Veryfi::Configuration] the global configuration object.
+    def configuration
+      @_configuration ||= Veryfi::Configuration.new
+    end
+
+    # Process-wide memoized {Veryfi::Client} built from {.configuration}.
+    # Resets if you re-{.configure} the SDK after first use.
+    #
+    # @return [Veryfi::Client]
+    def client
+      @_client = nil if @_last_configuration_hash && @_last_configuration_hash != configuration.to_h
+      @_last_configuration_hash = configuration.to_h
+      @_client ||= Veryfi::Client.new(**configuration.to_h.compact)
+    end
+
+    # Drop the memoized {.client} and {.configuration}. Mostly useful in tests.
+    # @return [void]
+    def reset!
+      @_configuration = nil
+      @_client = nil
+      @_last_configuration_hash = nil
+    end
+  end
 end

data/veryfi.gemspec

@@ -27,9 +27,11 @@ Gem::Specification.new do |spec|
     ".rubocop.yml",
     ".ruby-version",
     ".semaphore/semaphore.yml",
+    ".yardopts",
     "Gemfile",
     "Gemfile.lock",
     "README.md",
+    "Rakefile",
     "bin/autospec",
     "bin/bundle-audit",
     "bin/ci",
@@ -48,13 +50,29 @@ Gem::Specification.new do |spec|
     "docs/index.markdown",
     "lib/.keep",
     "lib/veryfi.rb",
+    "lib/veryfi/api/any_document.rb",
+    "lib/veryfi/api/bank_statement.rb",
+    "lib/veryfi/api/bank_statement_split.rb",
+    "lib/veryfi/api/business_card.rb",
+    "lib/veryfi/api/check.rb",
+    "lib/veryfi/api/classify.rb",
     "lib/veryfi/api/document.rb",
     "lib/veryfi/api/document_tag.rb",
+    "lib/veryfi/api/file_payload.rb",
     "lib/veryfi/api/line_item.rb",
+    "lib/veryfi/api/pdf_split.rb",
     "lib/veryfi/api/tag.rb",
+    "lib/veryfi/api/tag_operations.rb",
+    "lib/veryfi/api/tax_line.rb",
+    "lib/veryfi/api/w2.rb",
+    "lib/veryfi/api/w2_split.rb",
+    "lib/veryfi/api/w8.rb",
+    "lib/veryfi/api/w9.rb",
     "lib/veryfi/client.rb",
+    "lib/veryfi/configuration.rb",
     "lib/veryfi/error.rb",
     "lib/veryfi/request.rb",
+    "lib/veryfi/resource.rb",
     "lib/veryfi/signature.rb",
     "lib/veryfi/version.rb",
     "veryfi.gemspec"
@@ -65,10 +83,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.license = "MIT"
 
+  spec.required_ruby_version = ">= 3.0"
+
   spec.add_dependency "base64", "~> 0.1"
   spec.add_dependency "openssl", ">= 2.2", "< 4.1"
 
-  spec.add_dependency "faraday", ">= 1.7", "< 3.0"
+  # Faraday 2.14.1 is the floor of the CVE-2026-25765-fixed 2.x line.
+  spec.add_dependency "faraday", ">= 2.14.1", "< 3.0"
 
   spec.add_development_dependency "bundler", "~> 2.4"
   spec.add_development_dependency "bundler-audit", "~> 0.9"
@@ -77,11 +98,12 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.9"
   spec.add_development_dependency "rspec-its", "~> 1.3"
   spec.add_development_dependency "rubocop", "~> 1.65"
+  spec.add_development_dependency "rubocop-rake", "~> 0.6"
   spec.add_development_dependency "rubocop-rspec", "~> 3.0"
   spec.add_development_dependency "simplecov", "~> 0.21"
   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.4.4"
-  spec.add_development_dependency "activesupport", "~> 6.0"
+  spec.add_development_dependency "yard", "~> 0.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: veryfi
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Veryfi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2026-01-26 00:00:00.000000000 Z
+date: 2026-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 2.14.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
@@ -60,7 +60,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 2.14.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
@@ -162,6 +162,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.65'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -247,19 +261,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.4.4
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '0.9'
 description: 
 email:
 - support@veryfi.com
@@ -274,9 +288,11 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".semaphore/semaphore.yml"
+- ".yardopts"
 - Gemfile
 - Gemfile.lock
 - README.md
+- Rakefile
 - bin/autospec
 - bin/bundle-audit
 - bin/ci
@@ -295,13 +311,29 @@ files:
 - docs/index.markdown
 - lib/.keep
 - lib/veryfi.rb
+- lib/veryfi/api/any_document.rb
+- lib/veryfi/api/bank_statement.rb
+- lib/veryfi/api/bank_statement_split.rb
+- lib/veryfi/api/business_card.rb
+- lib/veryfi/api/check.rb
+- lib/veryfi/api/classify.rb
 - lib/veryfi/api/document.rb
 - lib/veryfi/api/document_tag.rb
+- lib/veryfi/api/file_payload.rb
 - lib/veryfi/api/line_item.rb
+- lib/veryfi/api/pdf_split.rb
 - lib/veryfi/api/tag.rb
+- lib/veryfi/api/tag_operations.rb
+- lib/veryfi/api/tax_line.rb
+- lib/veryfi/api/w2.rb
+- lib/veryfi/api/w2_split.rb
+- lib/veryfi/api/w8.rb
+- lib/veryfi/api/w9.rb
 - lib/veryfi/client.rb
+- lib/veryfi/configuration.rb
 - lib/veryfi/error.rb
 - lib/veryfi/request.rb
+- lib/veryfi/resource.rb
 - lib/veryfi/signature.rb
 - lib/veryfi/version.rb
 - veryfi.gemspec
@@ -317,7 +349,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="