intacct 0 → 1.0.0

data/lib/intacct/response.rb

@@ -1,10 +1,28 @@
-require 'intacct/function_result'
-require 'intacct/authentication_result'
+# frozen_string_literal: true
+
+require "intacct/function_result"
+require "intacct/authentication_result"
 
 module Intacct
+  # Parses and provides access to Intacct API XML responses.
+  #
+  # Wraps the HTTP response from Intacct and provides convenient methods
+  # to check status and extract function results.
+  #
+  # @example Parse a response
+  #   response = Intacct::Response.new(http_response)
+  #   if response.successful?
+  #     result = response.get_function_result("my-control-id")
+  #     puts result.data
+  #   end
   class Response
+    # @return [Nokogiri::XML::Document] the parsed XML response body
     attr_reader :response_body
 
+    # Initialize a new Response from an HTTP response
+    #
+    # @param http_response [Net::HTTPResponse] the HTTP response from Intacct API
+    # @raise [Net::HTTPError] if the response status is not 2xx
     def initialize(http_response)
       @response_body = Nokogiri::XML(http_response.body)
 
@@ -12,27 +30,37 @@ module Intacct
       http_response.value
     end
 
+    # Check if the overall response was successful
+    #
+    # @return [Boolean] true if the response control status is "success"
     def successful?
-      @response_body.xpath('//response/control/status').text == 'success'
+      @response_body.xpath("//response/control/status").text == "success"
     end
 
+    # Get the function result for a specific control ID
+    #
+    # @param control_id [String, Symbol] the control ID of the function
+    # @return [FunctionResult, nil] the function result or nil if not found
     def get_function_result(control_id)
       @function_results ||= build_function_results
       @function_results[control_id.to_s]
     end
 
+    # Get the authentication result from the response
+    #
+    # @return [AuthenticationResult] the authentication result
     def get_authentication_result
-      Intacct::AuthenticationResult.new(@response_body.xpath('//response/operation/authentication'))
+      Intacct::AuthenticationResult.new(@response_body.xpath("//response/operation/authentication"))
     end
 
     private
 
     def build_function_results
-      @response_body.xpath("//result").map do |xml_entry|
+      @response_body.xpath("//result").to_h do |xml_entry|
         function_result = Intacct::FunctionResult.new(xml_entry)
 
         [function_result.control_id, function_result]
-      end.to_h
+      end
     end
   end
 end

data/lib/intacct/utils.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Intacct
   module Utils
-    YEAR_FORMAT = "%Y".freeze
-    MONTH_FORMAT = "%m".freeze
-    DAY_FORMAT = "%d".freeze
+    YEAR_FORMAT = "%Y"
+    MONTH_FORMAT = "%m"
+    DAY_FORMAT = "%d"
     DATE_FORMAT = "#{MONTH_FORMAT}/#{DAY_FORMAT}/#{YEAR_FORMAT}".freeze
     DATETIME_FORMAT = "#{MONTH_FORMAT}/#{DAY_FORMAT}/#{YEAR_FORMAT} %H:%M:%S".freeze
 

data/lib/intacct/version.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
 module Intacct
-  VERSION = "0.0.15"
+  # Current version of the Intacct gem
+  VERSION = "1.0.0"
 end

data/lib/intacct.rb

@@ -1,18 +1,57 @@
-require_relative 'intacct/utils'
-require_relative 'intacct/config'
-require_relative 'intacct/gateway'
-require_relative 'intacct/request'
-require_relative 'intacct/functions/create'
-require_relative 'intacct/functions/create_ar_adjustment'
-require_relative 'intacct/functions/update'
-require_relative 'intacct/functions/get_api_session'
-require_relative 'intacct/functions/query'
-require_relative 'intacct/functions/read'
-require_relative 'intacct/functions/retrieve_pdf'
-require_relative 'intacct/functions/reverse_payment'
+# frozen_string_literal: true
+
+require_relative "intacct/version"
+require_relative "intacct/utils"
+require_relative "intacct/config"
+require_relative "intacct/gateway"
+require_relative "intacct/request"
+require_relative "intacct/functions/create"
+require_relative "intacct/functions/create_ar_adjustment"
+require_relative "intacct/functions/update"
+require_relative "intacct/functions/get_api_session"
+require_relative "intacct/functions/query"
+require_relative "intacct/functions/read"
+require_relative "intacct/functions/retrieve_pdf"
+require_relative "intacct/functions/reverse_payment"
 
 module Intacct
-  def self.logger
-    config.logger
+  class << self
+    # Returns the global configuration instance.
+    #
+    # @return [Config] the current configuration object
+    def config
+      @config ||= Config.new
+    end
+
+    # Configures the Intacct client globally.
+    #
+    # @example Configure with credentials
+    #   Intacct.configure do |config|
+    #     config.sender_id = ENV["INTACCT_SENDER_ID"]
+    #     config.sender_password = ENV["INTACCT_SENDER_PASSWORD"]
+    #     config.user_id = ENV["INTACCT_USER_ID"]
+    #     config.user_password = ENV["INTACCT_USER_PASSWORD"]
+    #     config.company_id = ENV["INTACCT_COMPANY_ID"]
+    #   end
+    #
+    # @yield [config] Gives the configuration object to the block
+    # @yieldparam config [Config] the configuration instance to modify
+    # @return [void]
+    def configure
+      yield(config)
+    end
+
+    # Resets the global configuration to nil.
+    #
+    # Primarily used for testing to ensure a clean configuration state.
+    #
+    # @return [void]
+    def reset_configuration!
+      @config = nil
+    end
+
+    def logger
+      config.logger
+    end
   end
 end

metadata

@@ -1,228 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: intacct
 version: !ruby/object:Gem::Version
-  version: '0'
+  version: 1.0.0
 platform: ruby
 authors:
 - David Paluy
 - Yaroslav Konovets
-bindir: bin
+bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-- !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: juwelier
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.4.9
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.9
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
-  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: rdoc
-  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'
-- !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '1.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '1.21'
 - !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.21.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.21.0
-- !ruby/object:Gem::Dependency
-  name: timecop
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '3.23'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '3.23'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.18.0
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.18.0
-- !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
-  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: coveralls
-  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: rubocop
-  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: Sage Intacct API wrapper
-email: dpaluy@users.noreply.github.com
+        version: '0.9'
 executables: []
 extensions: []
 extra_rdoc_files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 files:
-- ".document"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- Gemfile
+- ".yardopts"
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - Rakefile
-- intacct.gemspec
 - lib/intacct.rb
 - lib/intacct/authentication_methods/credentials.rb
 - lib/intacct/authentication_methods/session.rb
@@ -245,13 +128,16 @@ files:
 - lib/intacct/response.rb
 - lib/intacct/utils.rb
 - lib/intacct/version.rb
-- spec/intacct/client_spec.rb
-- spec/intacct_spec.rb
-- spec/spec_helper.rb
-homepage: http://github.com/dpaluy/intacct
+homepage: https://github.com/dpaluy/intacct
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/dpaluy/intacct
+  documentation_uri: https://rubydoc.info/gems/intacct
+  source_code_uri: https://github.com/dpaluy/intacct
+  changelog_uri: https://github.com/dpaluy/intacct/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/dpaluy/intacct/issues
 rdoc_options: []
 require_paths:
 - lib
@@ -259,14 +145,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 3.6.9
 specification_version: 4
-summary: Sage Intacct API wrapper
+summary: A Ruby wrapper for the Intacct API
 test_files: []

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/.rspec

@@ -1 +0,0 @@
---color

data/.rubocop.yml

@@ -1,19 +0,0 @@
-AllCops:
-  NewCops: enable
-  SuggestExtensions: false
-  Exclude:
-    - '*.gemspec'
-    - 'Rakefile'
-    - 'spec/spec_helper.rb'
-
-Metrics/MethodLength:
-  Max: 20
-
-Style/Documentation:
-  Enabled: false
-
-Style/StringConcatenation:
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  Enabled: false

data/.travis.yml

@@ -1,8 +0,0 @@
-
-language: ruby
-rvm:
-  - 3.1.1
-  - 3.0.0
-  - 2.2.3
-
-script: bundle exec rspec spec

data/Gemfile

@@ -1,20 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'faraday', '~> 1.10.0'
-gem 'json', '~> 2.7'
-
-group :development do
-  gem 'bundler'
-  gem 'juwelier', '~> 2.4.9'
-  gem 'pry-byebug'
-  gem 'rdoc', '~> 6.0'
-  gem 'rspec', '~> 3.11.0'
-  gem 'shoulda', '~> 4.0.0'
-  gem 'simplecov', '>= 0.21.0'
-  gem 'timecop', '~> 0.9.0'
-  gem 'webmock', '~> 3.18.0'
-
-  gem 'codeclimate-test-reporter', require: false
-  gem 'coveralls', require: false
-  gem 'rubocop', require: false
-end

data/intacct.gemspec

@@ -1,79 +0,0 @@
-# Generated by juwelier
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: intacct 0 ruby lib
-
-Gem::Specification.new do |s|
-  s.name = "intacct".freeze
-  s.version = "0".freeze
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib".freeze]
-  s.authors = ["David Paluy".freeze, "Yaroslav Konovets".freeze]
-  s.date = "1980-01-02"
-  s.description = "Sage Intacct API wrapper".freeze
-  s.email = "dpaluy@users.noreply.github.com".freeze
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.md"
-  ]
-  s.files = [
-    ".document",
-    ".rspec",
-    ".rubocop.yml",
-    ".travis.yml",
-    "Gemfile",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "intacct.gemspec",
-    "lib/intacct.rb",
-    "lib/intacct/authentication_methods/credentials.rb",
-    "lib/intacct/authentication_methods/session.rb",
-    "lib/intacct/authentication_result.rb",
-    "lib/intacct/config.rb",
-    "lib/intacct/exceptions/client_exception.rb",
-    "lib/intacct/exceptions/function_failure_exception.rb",
-    "lib/intacct/exceptions/missing_authentication_exception.rb",
-    "lib/intacct/function_result.rb",
-    "lib/intacct/functions/create.rb",
-    "lib/intacct/functions/create_ar_adjustment.rb",
-    "lib/intacct/functions/get_api_session.rb",
-    "lib/intacct/functions/query.rb",
-    "lib/intacct/functions/read.rb",
-    "lib/intacct/functions/retrieve_pdf.rb",
-    "lib/intacct/functions/reverse_payment.rb",
-    "lib/intacct/functions/update.rb",
-    "lib/intacct/gateway.rb",
-    "lib/intacct/request.rb",
-    "lib/intacct/response.rb",
-    "lib/intacct/utils.rb",
-    "lib/intacct/version.rb",
-    "spec/intacct/client_spec.rb",
-    "spec/intacct_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = "http://github.com/dpaluy/intacct".freeze
-  s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.7.2".freeze
-  s.summary = "Sage Intacct API wrapper".freeze
-
-  s.specification_version = 4
-
-  s.add_runtime_dependency(%q<faraday>.freeze, ["~> 1.10.0".freeze])
-  s.add_runtime_dependency(%q<json>.freeze, ["~> 2.7".freeze])
-  s.add_development_dependency(%q<bundler>.freeze, [">= 0".freeze])
-  s.add_development_dependency(%q<juwelier>.freeze, ["~> 2.4.9".freeze])
-  s.add_development_dependency(%q<pry-byebug>.freeze, [">= 0".freeze])
-  s.add_development_dependency(%q<rdoc>.freeze, ["~> 6.0".freeze])
-  s.add_development_dependency(%q<rspec>.freeze, ["~> 3.11.0".freeze])
-  s.add_development_dependency(%q<shoulda>.freeze, ["~> 4.0.0".freeze])
-  s.add_development_dependency(%q<simplecov>.freeze, [">= 0.21.0".freeze])
-  s.add_development_dependency(%q<timecop>.freeze, ["~> 0.9.0".freeze])
-  s.add_development_dependency(%q<webmock>.freeze, ["~> 3.18.0".freeze])
-  s.add_development_dependency(%q<codeclimate-test-reporter>.freeze, [">= 0".freeze])
-  s.add_development_dependency(%q<coveralls>.freeze, [">= 0".freeze])
-  s.add_development_dependency(%q<rubocop>.freeze, [">= 0".freeze])
-end
-

data/spec/intacct/client_spec.rb

@@ -1,5 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-xdescribe 'Intacct::Client' do
-  # TODO
-end

data/spec/intacct_spec.rb

@@ -1,7 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe 'Intacct' do
-  it 'has a version' do
-    expect(Intacct::VERSION).not_to be_nil
-  end
-end

data/spec/spec_helper.rb

@@ -1,34 +0,0 @@
-require 'codeclimate-test-reporter'
-require 'simplecov'
-require 'coveralls'
-
-require 'webmock/rspec'
-
-if ENV['COVERAGE']
-  WebMock.disable_net_connect!(allow: 'codeclimate.com')
-
-  Coveralls.wear!
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-    SimpleCov::Formatter::HTMLFormatter,
-    Coveralls::SimpleCov::Formatter
-  ]
-
-  # SimpleCov.start
-  CodeClimate::TestReporter.start
-end
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-
-require 'intacct'
-require 'byebug'
-require 'timecop'
-require 'rspec'
-
-# Requires supporting files with custom matchers and macros, etc,
-# in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
-
-RSpec.configure do |config|
-  config.order = 'random'
-end