intacct-rest 1.0.0

data/lib/intacct_rest/result/success.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module IntacctRest
+  module Result
+    class Success < Base
+      def success? = true
+      def failed? = false
+
+      # The record reference Intacct returns, e.g.
+      # {"key"=>"111","href"=>"/objects/accounts-payable/vendor/111"}
+      def result
+        @result ||= body['ia::result'] || {}
+      end
+
+      # "Functional object" access: success.key, success.href, success.id
+      def method_missing(name, *args, &block)
+        return super unless args.empty? && !block && result.key?(name.to_s)
+
+        result[name.to_s]
+      end
+
+      def respond_to_missing?(name, include_private = false)
+        result.key?(name.to_s) || super
+      end
+    end
+  end
+end

data/lib/intacct_rest/schema_generator.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module IntacctRest
+  # Discovers a resource's available fields by sampling ONE real record
+  # (via Objects#find) and flattening its keys — nested Hashes are
+  # dot-joined ("paymentInformation.fullyPaidDate"), nested Arrays are
+  # sampled from their first element only ("lines.glAccount").
+  #
+  # This is a LOWER BOUND, not a guarantee of completeness: any field that
+  # is nil/empty on the sampled record won't appear. A nil value at a
+  # Hash-typed position (e.g. an unpaid invoice's null `paymentInformation`)
+  # collapses that whole subtree to a single bare leaf instead of its
+  # nested fields — inherent to single-record sampling. Treat generated
+  # output as a starting point to hand-review and merge, not as ground
+  # truth to commit blindly.
+  class SchemaGenerator
+    def initialize(objects: IntacctRest::Objects.new)
+      @objects = objects
+    end
+
+    # key: overrides the auto-picked sample record — useful when the
+    # auto-picked one turns out sparse/partial.
+    def generate(resource, key: nil)
+      key ||= sample_key(resource)
+      flatten(objects.find(resource, key))
+    end
+
+    def generate_all(resources)
+      resources.transform_values { |resource| generate(resource) }
+    end
+
+    # Overwrites path unconditionally — no backup, no merge with any
+    # existing content. Review the diff before committing the result.
+    def write(path, resources)
+      data = generate_all(resources).transform_keys(&:to_s)
+      File.write(path, data.to_yaml)
+      data
+    end
+
+    private
+
+    attr_reader :objects
+
+    # Intacct's /objects/{resource} list endpoint has no documented sort
+    # order (unconfirmed against real docs) — this is an arbitrary
+    # representative record from the first page, not "the latest."
+    def sample_key(resource)
+      items = objects.list(resource)
+      key = items.last && items.last['key']
+      key || raise(IntacctRest::SchemaGenerationError, "No records found for #{resource} to sample a schema from")
+    end
+
+    # NOTE: do not add a `return if value.nil?` guard here — a nil leaf
+    # value still has a field name (prefix) worth recording; only a Hash
+    # or Array value collapses instead of terminating, and only Array
+    # samples its first element.
+    def flatten(value, prefix = nil, fields = [])
+      case value
+      when Hash
+        value.each { |k, v| flatten(v, [prefix, k].compact.join('.'), fields) }
+      when Array
+        flatten(value.first, prefix, fields)
+      else
+        fields << prefix if prefix
+      end
+      fields
+    end
+  end
+end

data/lib/intacct_rest/schema_source.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module IntacctRest
+  # Resolves Configuration#schema — a Hash, a YAML file path (String or
+  # Pathname), or nil — into field arrays for a given resource type.
+  #
+  #   IntacctRest::SchemaSource.new({invoices: %w[key state]}).for(:invoices)
+  #   IntacctRest::SchemaSource.new("config/intacct_schema.yml").for(:invoices)
+  class SchemaSource
+    include ErrorReporting
+
+    def initialize(source, config: IntacctRest.configuration)
+      @source = source
+      @config = config
+    end
+
+    def for(resource_type)
+      Array(data[resource_type.to_s]).map(&:to_s)
+    end
+
+    private
+
+    attr_reader :source, :config
+
+    def data
+      @data ||= normalize(source)
+    end
+
+    def normalize(source)
+      case source
+      when Hash
+        source.transform_keys(&:to_s)
+      when String, Pathname
+        load_yaml(source)
+      when nil
+        {}
+      else
+        raise ArgumentError, "Unsupported schema source: #{source.class}"
+      end
+    end
+
+    def load_yaml(path)
+      YAML.safe_load_file(path.to_s) || {}
+    rescue Errno::ENOENT, Psych::Exception => e
+      raise_reported IntacctRest::SchemaLoadError.new("Failed to load schema from #{path}: #{e.message}"),
+                     operation: :schema_load, path: path.to_s
+    end
+  end
+end

data/lib/intacct_rest/token_store/memory.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module IntacctRest
+  module TokenStore
+    # Default token store: thread-safe, self-expiring, process-local.
+    # Any object responding to #read/#write(ttl:)/#delete can be used instead
+    # (see IntacctRest::Configuration#token_store) — e.g. a Redis-backed store.
+    class Memory
+      def initialize
+        @values = {}
+        @mutex = Mutex.new
+      end
+
+      def read(key)
+        @mutex.synchronize do
+          value, expires_at = @values[key]
+          next nil if value.nil?
+          next nil if expires_at && expires_at <= Time.now
+
+          value
+        end
+      end
+
+      def write(key, value, ttl: nil)
+        @mutex.synchronize do
+          expires_at = ttl ? Time.now + ttl : nil
+          @values[key] = [value, expires_at]
+        end
+      end
+
+      def delete(key)
+        @mutex.synchronize { @values.delete(key) }
+      end
+    end
+  end
+end

data/lib/intacct_rest/validators/custom.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module IntacctRest
+  module Validators
+    module Custom
+      def self.call(record, attribute, method_name)
+        value = record.public_send(attribute)
+        return [] if value.nil?
+        return [] if record.send(method_name, value)
+
+        ["#{attribute} is invalid"]
+      end
+    end
+
+    register(:custom, Custom)
+  end
+end

data/lib/intacct_rest/validators/inclusion.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module IntacctRest
+  module Validators
+    module Inclusion
+      def self.call(record, attribute, list)
+        value = record.public_send(attribute)
+        return [] if value.nil? || Array(list).include?(value)
+
+        ["#{attribute} must be one of #{Array(list).join(', ')} or nil"]
+      end
+    end
+
+    register(:inclusion, Inclusion)
+  end
+end

data/lib/intacct_rest/validators/kind_of.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module IntacctRest
+  module Validators
+    module KindOf
+      TYPE_MAP = {
+        string: String, integer: Integer, numeric: Numeric, float: Float,
+        boolean: [TrueClass, FalseClass], hash: Hash, array: Array, date: Date, time: Time
+      }.freeze
+
+      def self.call(record, attribute, kind)
+        value = record.public_send(attribute)
+        return [] if value.nil?
+
+        expected = TYPE_MAP.fetch(kind) { raise ArgumentError, "Unknown kind_of type: #{kind.inspect}" }
+        return [] if Array(expected).any? { |klass| value.is_a?(klass) }
+
+        ["#{attribute} must be a #{kind}"]
+      end
+    end
+
+    register(:kind_of, KindOf)
+  end
+end

data/lib/intacct_rest/validators/presence.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module IntacctRest
+  module Validators
+    module Presence
+      def self.call(record, attribute, *)
+        record.public_send(attribute).nil? ? ["#{attribute} is required"] : []
+      end
+    end
+
+    register(:presence, Presence)
+  end
+end

data/lib/intacct_rest/validators.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module IntacctRest
+  # Registry of validator modules, keyed by kind (:presence, :kind_of,
+  # :inclusion, ...). Knows nothing about which validators exist itself —
+  # each validators/*.rb file registers its own kind when required, so
+  # adding a new validator kind never means editing this file.
+  module Validators
+    class << self
+      def register(kind, validator)
+        registry[kind] = validator
+      end
+
+      def fetch(kind)
+        registry.fetch(kind) do
+          known = []
+          each_validator { |name, _| known << name }
+          raise ArgumentError, "Unknown validator: #{kind.inspect} (known: #{known.join(', ')})"
+        end
+      end
+
+      def each_validator(&block)
+        registry.each(&block)
+      end
+
+      private
+
+      def registry
+        @registry ||= {}
+      end
+    end
+  end
+end

data/lib/intacct_rest/version.rb

@@ -0,0 +1,3 @@
+module IntacctRest
+  VERSION = '1.0.0'
+end

data/lib/intacct_rest.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require "yaml"
+require "pathname"
+require "date"
+
+module IntacctRest
+  API_URI = 'https://api.intacct.com/ia/api'
+  API_VERSION = 'v1'
+end
+
+require 'intacct_rest/version'
+require 'intacct_rest/errors'
+require 'intacct_rest/token_store/memory'
+require 'intacct_rest/configuration'
+require 'intacct_rest/client'
+require 'intacct_rest/filter'
+require 'intacct_rest/page'
+require 'intacct_rest/error_reporting'
+require 'intacct_rest/authenticated_request'
+require 'intacct_rest/oauth_client'
+require 'intacct_rest/custom_field'
+require 'intacct_rest/validators'
+require 'intacct_rest/validators/presence'
+require 'intacct_rest/validators/kind_of'
+require 'intacct_rest/validators/inclusion'
+require 'intacct_rest/validators/custom'
+require 'intacct_rest/model/base'
+require 'intacct_rest/model/vendor'
+require 'intacct_rest/model/invoice'
+require 'intacct_rest/model/term'
+require 'intacct_rest/model/invoice_line'
+require 'intacct_rest/model/currency'
+require 'intacct_rest/model/customer'
+require 'intacct_rest/model/contact'
+require 'intacct_rest/model/bill'
+require 'intacct_rest/model/bill_line'
+require 'intacct_rest/result/base'
+require 'intacct_rest/result/success'
+require 'intacct_rest/result/error'
+require 'intacct_rest/post'
+require 'intacct_rest/patch'
+require 'intacct_rest/endpoints/create_vendor'
+require 'intacct_rest/endpoints/update_vendor'
+require 'intacct_rest/endpoints/create_invoice'
+require 'intacct_rest/endpoints/create_term'
+require 'intacct_rest/endpoints/create_invoice_line'
+require 'intacct_rest/endpoints/create_customer'
+require 'intacct_rest/endpoints/create_bill'
+require 'intacct_rest/endpoints/create_bill_line'
+require 'intacct_rest/query'
+require 'intacct_rest/objects'
+require 'intacct_rest/schema_generator'
+require 'intacct_rest/schema_source'
+
+module IntacctRest
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.reset
+    @configuration = nil
+  end
+
+  def self.configuration
+    @configuration ||= IntacctRest::Configuration.new
+  end
+
+  def self.configure
+    yield configuration if block_given?
+  end
+end
+

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: intacct-rest
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bernardo Espinoza
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows to use SAGE Rest API for read, create and update SAGE's clients
+  data
+email:
+- bernardo466@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/intacct_rest.rb
+- lib/intacct_rest/authenticated_request.rb
+- lib/intacct_rest/client.rb
+- lib/intacct_rest/configuration.rb
+- lib/intacct_rest/custom_field.rb
+- lib/intacct_rest/endpoints/create_bill.rb
+- lib/intacct_rest/endpoints/create_bill_line.rb
+- lib/intacct_rest/endpoints/create_customer.rb
+- lib/intacct_rest/endpoints/create_invoice.rb
+- lib/intacct_rest/endpoints/create_invoice_line.rb
+- lib/intacct_rest/endpoints/create_term.rb
+- lib/intacct_rest/endpoints/create_vendor.rb
+- lib/intacct_rest/endpoints/update_vendor.rb
+- lib/intacct_rest/error_reporting.rb
+- lib/intacct_rest/errors.rb
+- lib/intacct_rest/filter.rb
+- lib/intacct_rest/model/base.rb
+- lib/intacct_rest/model/bill.rb
+- lib/intacct_rest/model/bill_line.rb
+- lib/intacct_rest/model/contact.rb
+- lib/intacct_rest/model/currency.rb
+- lib/intacct_rest/model/customer.rb
+- lib/intacct_rest/model/invoice.rb
+- lib/intacct_rest/model/invoice_line.rb
+- lib/intacct_rest/model/term.rb
+- lib/intacct_rest/model/vendor.rb
+- lib/intacct_rest/oauth_client.rb
+- lib/intacct_rest/objects.rb
+- lib/intacct_rest/page.rb
+- lib/intacct_rest/patch.rb
+- lib/intacct_rest/post.rb
+- lib/intacct_rest/query.rb
+- lib/intacct_rest/result/base.rb
+- lib/intacct_rest/result/error.rb
+- lib/intacct_rest/result/success.rb
+- lib/intacct_rest/schema_generator.rb
+- lib/intacct_rest/schema_source.rb
+- lib/intacct_rest/token_store/memory.rb
+- lib/intacct_rest/validators.rb
+- lib/intacct_rest/validators/custom.rb
+- lib/intacct_rest/validators/inclusion.rb
+- lib/intacct_rest/validators/kind_of.rb
+- lib/intacct_rest/validators/presence.rb
+- lib/intacct_rest/version.rb
+homepage: https://github.com/bernespinoza/intacct-rest
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/bernespinoza/intacct-rest
+  bug_tracker_uri: https://github.com/bernespinoza/intacct-rest/issues
+  changelog_uri: https://github.com/bernespinoza/intacct-rest/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: A Ruby wrapper for Intacct SAGE Rest API
+test_files: []