intacct 0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 577eb2b6dd021730af938235fd3093b00542c7d469e269099ec4c9b722ce6fdc
-  data.tar.gz: aa8dd3866340623ad87fb5f4f8b32294d82417dd5e4f406bec8c46f6e0bb3a0b
+  metadata.gz: 3da8dce2d382735a59912c753d460edbc9021d45edf3542f3ede11b44cf9c16a
+  data.tar.gz: 3a0e07e077cbc8d130ce62a0271810010d12609bf56d4c659165d85ad2e59e7a
 SHA512:
-  metadata.gz: b478a96bbebf5d2303ad7106dbcbb3d1ea456bad832c1cc34aced9237c1b006c670140676f717aec183916a3bbb1b55a258d8befbdf3f6e86f4c8338faf66522
-  data.tar.gz: a7e14e8edcb6cef4f8ff8bf0d5b4afac4c8aa5ed66182a91bac6857ffa2e23b64df10c15a83eabf459b2b7c7067e5ce336972bf674de6760e575fb6e1946c202
+  metadata.gz: cdf889a9dea9bc2a7736fc09e802bf1d3ba9eecab1fd0fa1f11e5d74c3202f3a2b442232bda9852e69f8fc662d9b0464503354d7b2f76dc8f1f36a4b7a3f03a1
+  data.tar.gz: 1a20e4e45387551c434a122d6f9cf9b8a0ed3fcc86e25760e2a04a908912cb0d89ac6e20121645651b4db4c38bd107c0931fe43a6907d0ad4a74d481c7a450ce

data/.yardopts

@@ -0,0 +1,6 @@
+--markup markdown
+--no-private
+lib/**/*.rb
+- README.md
+- CHANGELOG.md
+- LICENSE.txt

data/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2025-11-13
+
+### Changed
+- **BREAKING**: Minimum Ruby version raised to 3.2.0
+- Migrated from RSpec to Minitest
+- Modernized gemspec with comprehensive metadata
+- Replaced Juwelier with standard Bundler gem tasks
+- Updated RuboCop configuration for Ruby 3.2
+- Added frozen string literal pragma to all files
+
+### Added
+- YARD documentation with comprehensive examples
+- Complete test coverage with Minitest
+- CHANGELOG.md (this file)
+- Enhanced README with usage examples and badges
+- RuboCop to default rake task
+
+### Removed
+- Support for Ruby < 3.2
+- RSpec test framework
+- Juwelier gem management
+- Legacy coverage tools (CodeClimate, Coveralls)
+
+## [0.0.15] - Previous Release
+
+Historical changes before 1.0.0 modernization.

data/README.md

@@ -1,39 +1,281 @@
-# Intacct Sage Ruby wrapper
+# Intacct Ruby Gem
 
-This is Ruby wrapper to [Intacct Sage API](https://developer.intacct.com/api/)
+[![Gem Version](https://badge.fury.io/rb/intacct.svg)](https://badge.fury.io/rb/intacct)
+[![Documentation](https://img.shields.io/badge/docs-rubydoc.info-blue.svg)](https://rubydoc.info/gems/intacct)
+[![CI](https://github.com/dpaluy/intacct/workflows/CI/badge.svg)](https://github.com/dpaluy/intacct/actions)
 
-## Status
-
-TBD
+A Ruby gem for interacting with the [Sage Intacct API](https://developer.intacct.com/api/).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-`gem 'intacct'`
+```ruby
+gem "intacct"
+```
+
+**Requirements:** Ruby 3.2 or higher.
 
 ## Usage
 
-```
+### Configuration
+
+Configure the gem with your Intacct credentials:
+
+```ruby
 Intacct.configure do |config|
-  config.sender_id = 'SENDER-ID-FROM-SAGE'
-  config.sender_password = 'SENDER-PASSWORD-FROM-SAGE'
+  config.sender_id = ENV["INTACCT_SENDER_ID"]
+  config.sender_password = ENV["INTACCT_SENDER_PASSWORD"]
+end
+```
+
+**Security Note:** Never commit credentials to version control. Use environment variables or a secrets management system.
+
+### Making Requests
+
+#### Query Records
+
+Query Intacct objects with filters and sorting:
+
+```ruby
+query = Intacct::Functions::Query.new(
+  object: "CUSTOMER",
+  select: ["CUSTOMERID", "NAME", "EMAIL", "STATUS"],
+  filter: { "STATUS" => "active" },
+  order: { "NAME" => "asc" }
+)
+
+request = Intacct::Request.new
+request.use_credentials_authentication(
+  user_id: ENV["INTACCT_USER_ID"],
+  company_id: ENV["INTACCT_COMPANY_ID"],
+  user_password: ENV["INTACCT_USER_PASSWORD"]
+)
+request.add_function(query, "query-001")
+
+response = Intacct::Gateway.new.send_request(request)
+
+if response.successful?
+  result = response.get_function_result("query-001")
+  if result.successful?
+    customers = result.data
+    customers.each do |customer|
+      puts "#{customer['CUSTOMERID']}: #{customer['NAME']}"
+    end
+  else
+    puts "Function error: #{result.errors.join(', ')}"
+  end
+else
+  puts "Request failed"
 end
 ```
 
-TBD
+#### Create Records
+
+Create new records in Intacct:
+
+```ruby
+create = Intacct::Functions::Create.new(
+  object: "CUSTOMER",
+  fields: {
+    "CUSTOMERID" => "C-001",
+    "NAME" => "Acme Corporation",
+    "EMAIL" => "contact@acme.com",
+    "STATUS" => "active"
+  }
+)
+
+request = Intacct::Request.new
+request.use_credentials_authentication(
+  user_id: ENV["INTACCT_USER_ID"],
+  company_id: ENV["INTACCT_COMPANY_ID"],
+  user_password: ENV["INTACCT_USER_PASSWORD"]
+)
+request.add_function(create, "create-001")
+
+response = Intacct::Gateway.new.send_request(request)
+
+if response.successful?
+  result = response.get_function_result("create-001")
+  puts "Customer created!" if result.successful?
+end
+```
+
+#### Update Records
+
+Update existing records:
+
+```ruby
+update = Intacct::Functions::Update.new(
+  object: "CUSTOMER",
+  keys: { "CUSTOMERID" => "C-001" },
+  fields: {
+    "EMAIL" => "newemail@acme.com",
+    "STATUS" => "inactive"
+  }
+)
+
+request = Intacct::Request.new
+request.use_credentials_authentication(
+  user_id: ENV["INTACCT_USER_ID"],
+  company_id: ENV["INTACCT_COMPANY_ID"],
+  user_password: ENV["INTACCT_USER_PASSWORD"]
+)
+request.add_function(update, "update-001")
+
+response = Intacct::Gateway.new.send_request(request)
+```
+
+#### Read by ID
+
+Read a specific record by ID:
+
+```ruby
+read = Intacct::Functions::Read.new(
+  object: "CUSTOMER",
+  keys: "C-001",
+  fields: ["CUSTOMERID", "NAME", "EMAIL"]
+)
+
+request = Intacct::Request.new
+request.use_credentials_authentication(
+  user_id: ENV["INTACCT_USER_ID"],
+  company_id: ENV["INTACCT_COMPANY_ID"],
+  user_password: ENV["INTACCT_USER_PASSWORD"]
+)
+request.add_function(read, "read-001")
+
+response = Intacct::Gateway.new.send_request(request)
+```
+
+#### Case-Insensitive Queries
+
+Perform case-insensitive queries:
+
+```ruby
+query = Intacct::Functions::Query.new(
+  object: "CUSTOMER",
+  select: ["CUSTOMERID", "NAME"],
+  filter: { "NAME" => "acme" },
+  case_insensitive: true
+)
+```
+
+### Error Handling
+
+Always check response status and handle errors:
+
+```ruby
+response = Intacct::Gateway.new.send_request(request)
+
+if response.successful?
+  result = response.get_function_result("my-control-id")
+  if result.successful?
+    puts "Success: #{result.data}"
+  else
+    puts "Function error: #{result.errors.join(', ')}"
+  end
+else
+  puts "Request failed"
+end
+```
+
+### Session Authentication
+
+Get an API session for subsequent requests:
+
+```ruby
+get_session = Intacct::Functions::GetApiSession.new(location_id: "US")
+
+request = Intacct::Request.new
+request.use_credentials_authentication(
+  user_id: ENV["INTACCT_USER_ID"],
+  company_id: ENV["INTACCT_COMPANY_ID"],
+  user_password: ENV["INTACCT_USER_PASSWORD"]
+)
+request.add_function(get_session, "session-001")
+
+response = Intacct::Gateway.new.send_request(request)
+
+if response.successful?
+  result = response.get_function_result("session-001")
+  if result.successful?
+    session_id = result.data["sessionid"]
+    # Use session_id for subsequent requests
+  end
+end
+```
+
+## Available Functions
+
+- **Query** - Execute read queries with filters and sorting
+- **Create** - Create new records
+- **Read** - Read specific records by ID
+- **Update** - Update existing records
+- **CreateArAdjustment** - Create AR adjustments
+- **GetApiSession** - Get API session for authentication
+- **RetrievePdf** - Retrieve PDF documents
+- **ReversePayment** - Reverse payments
+
+For detailed API documentation, see [RubyDoc](https://rubydoc.info/gems/intacct).
+
+## Development
+
+After checking out the repo, run:
+
+```bash
+bundle install
+```
+
+Run tests:
+
+```bash
+bundle exec rake test
+```
+
+Run linter:
+
+```bash
+bundle exec rubocop
+```
+
+Generate documentation:
+
+```bash
+bundle exec yard doc
+bundle exec yard server  # View docs at http://localhost:8808
+```
+
+To install this gem onto your local machine:
+
+```bash
+bundle exec rake install
+```
+
+To release a new version:
+
+1. Update version in `lib/intacct/version.rb`
+2. Update `CHANGELOG.md`
+3. Commit changes
+4. Run `bundle exec rake release` (creates tag and pushes to RubyGems)
+
+## Contributing
+
+1. Fork it (https://github.com/dpaluy/intacct/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+Please ensure:
+- Tests pass (`bundle exec rake test`)
+- Code follows style guide (`bundle exec rubocop`)
+- New features include tests and documentation
 
-## Contributing to intacct gem
+## License
 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
 
 ## Copyright
 
-Copyright (c) 2022 David Paluy. See LICENSE.txt for
-further details.
+Copyright (c) 2022-2025 David Paluy. See LICENSE.txt for further details.

data/Rakefile

@@ -1,57 +1,21 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-require 'juwelier'
-Juwelier::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
-  gem.name = "intacct"
-  gem.homepage = "http://github.com/dpaluy/intacct"
-  gem.license = "MIT"
-  gem.summary = %Q{Sage Intacct API wrapper}
-  gem.description = %Q{Sage Intacct API wrapper}
-  gem.email = "dpaluy@users.noreply.github.com"
-  gem.authors = ["David Paluy", "Yaroslav Konovets"]
+require "bundler/gem_tasks"
+require "minitest/test_task"
 
-  # dependencies defined in Gemfile
-end
-Juwelier::RubygemsDotOrgTasks.new
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
+Minitest::TestTask.create
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
 
-desc 'Code coverage detail'
-task :simplecov do
-  ENV['COVERAGE'] = 'true'
-  Rake::Task['spec'].execute
+begin
+  require "yard"
+  YARD::Rake::YardocTask.new do |t|
+    t.files = ["lib/**/*.rb"]
+    t.options = ["--markup", "markdown", "--no-private"]
+  end
+rescue LoadError
+  # YARD not available
 end
 
-task default: :spec
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ''
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "intacct #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+task default: %i[test rubocop]

data/lib/intacct/authentication_methods/credentials.rb

@@ -1,4 +1,6 @@
-require 'builder'
+# frozen_string_literal: true
+
+require "builder"
 
 module Intacct
   module AuthenticationMethods

data/lib/intacct/authentication_methods/session.rb

@@ -1,4 +1,6 @@
-require 'builder'
+# frozen_string_literal: true
+
+require "builder"
 
 module Intacct
   module AuthenticationMethods

data/lib/intacct/authentication_result.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 module Intacct
   class AuthenticationResult
     attr_reader :status, :xml_data
 
     def initialize(xml_entry)
-      @status = xml_entry.xpath('status').text
+      @status = xml_entry.xpath("status").text
       @xml_data = xml_entry
     end
 
     def successful?
-      @status == 'success'
+      @status == "success"
     end
 
     def parsed_data

data/lib/intacct/config.rb

@@ -1,20 +1,30 @@
-require 'logger'
+# frozen_string_literal: true
+
+require "logger"
 
 module Intacct
+  # Configuration object for Intacct API credentials and settings.
+  #
+  # @attr sender_id [String] Intacct Web Services sender ID
+  # @attr sender_password [String] Intacct Web Services sender password
+  # @attr url [String] Custom API endpoint URL (optional)
+  # @attr raise_exceptions [Boolean] Whether to raise exceptions on API errors (default: true)
+  # @attr logger [Logger] Logger instance for debugging (default: ERROR level stdout logger)
+  #
+  # @example Basic configuration
+  #   config = Intacct::Config.new
+  #   config.sender_id = "my-sender-id"
+  #   config.sender_password = "my-sender-password"
+  #   config.raise_exceptions = false
   class Config
     attr_accessor :sender_id, :sender_password, :url, :raise_exceptions, :logger
 
+    # Initialize a new configuration with default logger and exception handling
+    #
+    # @return [Config] a new configuration instance
     def initialize
       @logger = Logger.new($stdout, level: Logger::Severity::ERROR)
       @raise_exceptions = true
     end
   end
-
-  def self.configure
-    yield config
-  end
-
-  def self.config
-    @config ||= Config.new
-  end
 end

data/lib/intacct/exceptions/client_exception.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Intacct
   module Exceptions
     class ClientException < StandardError; end

data/lib/intacct/exceptions/function_failure_exception.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Intacct
   module Exceptions
     class FunctionFailureException < StandardError; end

data/lib/intacct/exceptions/missing_authentication_exception.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Intacct
   module Exceptions
     class MissingAuthenticationException < StandardError; end

data/lib/intacct/function_result.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
+
 module Intacct
   class FunctionResult
     attr_reader :status, :control_id, :xml_data
 
     def initialize(xml_entry)
-      @status = xml_entry.xpath('status').text
-      @control_id = xml_entry.xpath('controlid').text
+      @status = xml_entry.xpath("status").text
+      @control_id = xml_entry.xpath("controlid").text
       @xml_data = xml_entry
     end
 
     def successful?
-      @status == 'success'
+      @status == "success"
     end
 
     def parsed_data
       hash = Crack::XML.parse(@xml_data.to_s).with_indifferent_access
-      successful? ? hash.fetch('result') : hash
+      successful? ? hash.fetch("result") : hash
     end
 
     def push_error_messages
@@ -23,7 +25,7 @@ module Intacct
       error_details = [error_details] unless error_details.is_a?(Array)
 
       error_details.compact.map do |error_data|
-        [error_data[:description2], error_data[:correction]].compact.join(' ')
+        [error_data[:description2], error_data[:correction]].compact.join(" ")
       end
     end
   end

data/lib/intacct/functions/create.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Intacct
   module Functions
     class Create

data/lib/intacct/functions/create_ar_adjustment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Intacct
   module Functions
     class CreateArAdjustment

data/lib/intacct/functions/get_api_session.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Intacct
   module Functions
     class GetApiSession

data/lib/intacct/functions/query.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Intacct
   module Functions
     class Query
@@ -57,9 +59,9 @@ module Intacct
       def to_direction(direction)
         case direction
         when :asc
-          'ascending'
+          "ascending"
         when :desc
-          'descending'
+          "descending"
         else
           raise ArgumentError, "Invalid direction: #{direction}"
         end

data/lib/intacct/functions/read.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Intacct
   module Functions
     class Read
@@ -14,8 +16,8 @@ module Intacct
         builder = Builder::XmlMarkup.new
         builder.read do
           builder.object @object
-          builder.keys keys.join(',')
-          fields_value = @fields.any? ? @fields.join(',') : '*'
+          builder.keys keys.join(",")
+          fields_value = @fields.any? ? @fields.join(",") : "*"
           builder.fields fields_value
           args.each do |key, value|
             builder.tag!(key, value)

data/lib/intacct/functions/retrieve_pdf.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Intacct
   module Functions
     class RetrievePdf

data/lib/intacct/functions/reverse_payment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Intacct
   module Functions
     class ReversePayment

data/lib/intacct/functions/update.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Intacct
   module Functions
     class Update
@@ -18,4 +20,3 @@ module Intacct
     end
   end
 end
-

data/lib/intacct/gateway.rb

@@ -1,8 +1,10 @@
-require 'intacct/response'
+# frozen_string_literal: true
+
+require "intacct/response"
 
 module Intacct
   class Gateway
-    URI_STRING = 'https://api.intacct.com/ia/xml/xmlgw.phtml'.freeze
+    URI_STRING = "https://api.intacct.com/ia/xml/xmlgw.phtml"
 
     def initialize(control_config)
       @control_config = control_config
@@ -12,7 +14,7 @@ module Intacct
 
     def execute_request(api_request)
       post_request ||= Net::HTTP::Post.new(uri.request_uri)
-      post_request['Content-Type'] = 'x-intacct-xml-request'
+      post_request["Content-Type"] = "x-intacct-xml-request"
       post_request.body = api_request.to_xml(@control_config)
       Intacct.logger.debug("Request Body: #{post_request.body}")
       http_response = @http_gateway.request(post_request)

data/lib/intacct/request.rb

@@ -1,6 +1,8 @@
-require 'builder'
-require 'intacct/authentication_methods/credentials'
-require 'intacct/authentication_methods/session'
+# frozen_string_literal: true
+
+require "builder"
+require "intacct/authentication_methods/credentials"
+require "intacct/authentication_methods/session"
 
 module Intacct
   class Request