ledger_sync 1.3.4 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a9ac9abd02e87286bdff439fc491e286bb1d4d175f109f892061e7485cec2fd
-  data.tar.gz: ef25734c3e806d530e9b50b9cec78bc93de4c11ec87dc8c9be5f004650113487
+  metadata.gz: fd6a2c51848e4e1e51a7c0870956a23b7e6d81c6eff754554340fd48d350a6a9
+  data.tar.gz: d632009d62b0f7cfa59edceee5d9e2df57caa27a437197dc324e978dfc71d44c
 SHA512:
-  metadata.gz: 34d67c0a951e721b66b61fd686cdb9258d11aa7270a61fe32e5aa2c0d66a1b614643b0f14d99c8c5d49f19a631cddc742b9afb3ad5035be164d903d77a3b727b
-  data.tar.gz: e21b60479be3bd1ed92ff65907b250e6286b0d37c9dc44ff2d3300d0aefdb6fe47d4d20359366a1be9133cb08fe3d6d2b1ee363c3c5eb2f5a44499a82827406f
+  metadata.gz: 8b09d33912d3bd337a3d84cf05093193dc1a80b1bdc3137f903131d386bb5a38355da76856b72cb55cfa2cdd190ef98c88ba87aeb62b5851beae05bc7aeb1fb9
+  data.tar.gz: bdc088c4b18661ee9ead64d5877c1e4104a1d9a6f1d39aec8e7d24cfd45f35ca00c3953783f2bfec22f62a7d56cc6cebf8a9e50f09596c272274b61e149cecf1

data/.gitignore

@@ -10,11 +10,20 @@
 # rspec failure tracking
 .rspec_status
 
+### Jekyll ###
+_site/
+.sass-cache/
+.jekyll-cache/
+.jekyll-metadata
+
+# byebug
 .byebug_history
-.qa_config.yml
 
+# Mac
 .DS_Store
 
+# dotenv
 .env
 
-.tool-versions
+.tool-versions
+.ruby-version

data/.overcommit.yml

@@ -0,0 +1,30 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/sds/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/sds/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/sds/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+gemfile: Gemfile
+
+PreCommit:
+  ALL:
+    exclude:
+      - 'documentation/site/assets/webfonts/**/*.svg'
+
+  RuboCop:
+    command: ['bundle', 'exec', 'rubocop']
+    enabled: true
+    on_warn: fail # Treat all warnings as failures
+
+  TrailingWhitespace:
+    enabled: true

data/.rubocop.yml

@@ -1,4 +1,17 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.6
+
+Layout/LineLength:
+  Enabled: True
+  Max: 120
+
+Style/HashEachMethods:
+  Enabled: True
+
+Style/HashTransformKeys:
+  Enabled: True
+
+Style/HashTransformValues:
+  Enabled: True

data/.travis.yml

@@ -1,9 +1,19 @@
 ---
-sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.5.1
+  - 2.5.8
+  - 2.6.6
+  - 2.6.3
+  - 2.7.1
+  - ruby-head
 before_install:
   - gem update --system
   - gem install bundler:1.17.3
+  - gem install overcommit
+script:
+  - bundle exec rspec --order rand
+  - overcommit --sign && overcommit --run
+jobs:
+  allow_failures:
+    - rvm: ruby-head

data/Dockerfile

@@ -1,8 +1,8 @@
-FROM ruby:2.5.1
+FROM ruby:2.6.6
 
 WORKDIR /lib
 
 COPY . .
 RUN bundle install
 
-CMD ["bundle", "exec", "rspec"]
+CMD ["bundle", "exec", "rspec", "--order rand"]

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ledger_sync (1.3.4)
+    ledger_sync (1.4.4)
       activemodel
       colorize
       coveralls
@@ -17,20 +17,20 @@ PATH
       oauth2
       pd_ruby
       resonad
-      simply_serializable (>= 1.3.0)
+      simply_serializable (>= 1.5.1)
       stripe
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.2.1)
-      activesupport (= 6.0.2.1)
-    activesupport (6.0.2.1)
+    activemodel (6.0.3.1)
+      activesupport (= 6.0.3.1)
+    activesupport (6.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      zeitwerk (~> 2.2, >= 2.2.2)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     akami (1.3.1)
@@ -40,7 +40,9 @@ GEM
     awesome_print (1.8.0)
     builder (3.2.4)
     bump (0.9.0)
-    byebug (11.1.1)
+    byebug (11.1.3)
+    childprocess (3.0.0)
+    colorator (1.1.0)
     colorize (0.8.1)
     concurrent-ruby (1.1.6)
     coveralls (0.8.23)
@@ -54,7 +56,7 @@ GEM
     diff-lcs (1.3)
     docile (1.3.2)
     dotenv (2.7.5)
-    dry-configurable (0.11.3)
+    dry-configurable (0.11.5)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.4, >= 0.4.7)
       dry-equalizer (~> 0.2)
@@ -70,14 +72,14 @@ GEM
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.2)
       dry-equalizer (~> 0.2)
-    dry-schema (1.4.3)
+    dry-schema (1.5.1)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.8, >= 0.8.3)
       dry-core (~> 0.4)
       dry-equalizer (~> 0.2)
       dry-initializer (~> 3.0)
       dry-logic (~> 1.0)
-      dry-types (~> 1.2)
+      dry-types (~> 1.4)
     dry-types (1.4.0)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.3)
@@ -85,36 +87,71 @@ GEM
       dry-equalizer (~> 0.3)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    dry-validation (1.4.2)
+    dry-validation (1.5.1)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.7, >= 0.7.1)
       dry-core (~> 0.4)
       dry-equalizer (~> 0.2)
       dry-initializer (~> 3.0)
-      dry-schema (~> 1.4, >= 1.4.3)
-    factory_bot (5.1.1)
-      activesupport (>= 4.2.0)
-    faraday (0.17.3)
+      dry-schema (~> 1.5)
+    em-websocket (0.5.1)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    eventmachine (1.2.7)
+    factory_bot (6.0.1)
+      activesupport (>= 5.0.0)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
     faraday-detailed_logger (2.3.0)
       faraday (>= 0.8, < 2)
-    faraday_middleware (0.14.0)
-      faraday (>= 0.7.4, < 1.0)
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    ffi (1.13.0)
     fingerprintable (1.2.1)
       colorize
+    forwardable-extended (2.6.0)
     gyoku (1.3.1)
       builder (>= 2.1.2)
     hashdiff (1.0.1)
+    http_parser.rb (0.6.0)
     httpi (2.4.4)
       rack
       socksify
-    i18n (1.8.2)
+    i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
+    iniparse (1.5.0)
+    jekyll (3.8.7)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 0.7)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 1.14)
+      liquid (~> 4.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (>= 1.7, < 4)
+      safe_yaml (~> 1.0)
+    jekyll-menus (0.6.1)
+      jekyll (>= 3.6, < 5.0)
+    jekyll-paginate (1.1.0)
+    jekyll-paginate-v2 (1.9.4)
+      jekyll (~> 3.0)
+    jekyll-sass-converter (1.5.2)
+      sass (~> 3.4)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
     json (2.3.0)
     jwt (2.2.1)
+    kramdown (1.17.0)
+    liquid (4.0.3)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.3.6)
     mini_portile2 (2.4.0)
-    minitest (5.14.0)
+    minitest (5.14.1)
     multi_json (1.14.1)
     multi_xml (0.6.0)
     multipart-post (2.1.1)
@@ -129,40 +166,58 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
+    overcommit (0.53.0)
+      childprocess (>= 0.6.3, < 4)
+      iniparse (~> 1.4)
     parallel (1.19.1)
-    parser (2.7.0.3)
+    parser (2.7.1.3)
       ast (~> 2.4.0)
-    pd_ruby (0.2.0)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    pd_ruby (0.2.3)
       colorize
-    public_suffix (4.0.3)
-    rack (2.2.2)
+    public_suffix (4.0.5)
+    rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.1)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (1.7.1)
     resonad (1.2.0)
     rexml (3.2.4)
+    rouge (3.19.0)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.80.0)
-      jaro_winkler (~> 1.5.1)
+    rspec-support (3.9.3)
+    rubocop (0.85.1)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
       rexml
+      rubocop-ast (>= 0.0.3)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
+    sass (3.7.4)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
     savon (2.12.0)
       akami (~> 1.2)
       builder (>= 2.1.2)
@@ -176,29 +231,29 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    simply_serializable (1.4.2)
+    simply_serializable (1.5.1)
       fingerprintable (>= 1.2.1)
     socksify (1.7.1)
-    stripe (5.17.0)
+    stripe (5.22.0)
     sync (0.5.0)
     term-ansicolor (1.7.1)
       tins (~> 1.0)
     thor (1.0.1)
     thread_safe (0.3.6)
-    tins (1.24.1)
+    tins (1.25.0)
       sync
-    tzinfo (1.2.6)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    unicode-display_width (1.6.1)
-    vcr (5.1.0)
+    unicode-display_width (1.7.0)
+    vcr (6.0.0)
     wasabi (3.5.0)
       httpi (~> 2.0)
       nokogiri (>= 1.4.2)
-    webmock (3.8.2)
+    webmock (3.8.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.2.2)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
@@ -209,7 +264,12 @@ DEPENDENCIES
   bundler (~> 1.16)
   byebug
   factory_bot
+  jekyll (~> 3.8.4)
+  jekyll-menus (~> 0.6.0)
+  jekyll-paginate (~> 1.1)
+  jekyll-paginate-v2 (~> 1.9)
   ledger_sync!
+  overcommit
   rake (~> 13.0)
   rspec (~> 3.2)
   rubocop

data/LICENSE.txt

@@ -1,21 +1,5 @@
-The MIT License (MIT)
-
-Copyright (c) 2019 Ryan Jackson
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+Source code in this repository is variously licensed under the Business Source
+License 1.1 (BSL) and other licenses. A copy of each license can be found in the licenses
+directory or the relative directories. Source code in a given file is licensed under the BSL and the
+copyright belongs to Modern Treasury Inc. unless otherwise noted at the
+beginning of the file or in a specific license file.

data/README.md

@@ -4,503 +4,23 @@
 [![Gem Version](https://badge.fury.io/rb/ledger_sync.svg)](https://badge.fury.io/rb/ledger_sync)
 [![Coverage Status](https://coveralls.io/repos/github/LedgerSync/ledger_sync/badge.svg?branch=master)](https://coveralls.io/github/LedgerSync/ledger_sync?branch=master)
 
-## Installation
+## Join the Conversation
 
-Add this line to your application's Gemfile:
+[Click here](https://join.slack.com/t/ledger-sync/shared_invite/zt-e5nbl8qc-eOA~5k7bg3p16_l3J7OS~Q) to join our public Slack group.
 
-```ruby
-gem 'ledger_sync'
-```
+## Documentation
 
-And then execute:
+The most up-to-date documentation can be found at [www.ledgersync.dev](http://www.ledgersync.dev)
 
-```bash
-$ bundle
-```
+## License
 
-Or install it yourself as:
+The gem is available as open source under the terms of the licenses detailed in `LICENSE.txt`.
 
-```bash
-$ gem install ledger_sync
-```
-
-## Usage
-
-To use LedgerSync, you must create an `Operation`.  The operation will be ledger-specific and will require the following:
-
-1. Adaptor
-2. Resource(s)
-
-The code may look like the following:
-
-```ruby
-# First we create an adaptor, which is our connection to a ledger.
-# Each ledger may require different keys, so check the
-# documentation below for specifics.
-adaptor = LedgerSync::Adaptors::QuickBooksOnline::Adaptor.new(
-  access_token: access_token, # assuming this is defined
-  client_id: ENV['QUICKBOOKS_ONLINE_CLIENT_ID'],
-  client_secret: ENV['QUICKBOOKS_ONLINE_CLIENT_SECRET'],
-  realm_id: ENV['QUICKBOOKS_ONLINE_REALM_ID'],
-  refresh_token: refresh_token, # assuming this is defined
-)
-
-# Create a resource on which to operate.  Some resources have
-# relationships with other resources.  You can use
-# `Util::ResourcesBuilder` to create resources and relationships from
-# a structured hash.
-resource = LedgerSync::Customer.new(
-  name: 'Sample Customer',
-  email: 'test@example.com'
-)
-
-# Create the operation we want to perform.
-operation = LedgerSync::Adaptors::QuickBooksOnline::Customer::Operations::Create.new(
-  adaptor: adaptor,
-  resource: resource
-)
-
-result = operation.perform # Returns a LedgerSync::OperationResult
-
-if result.success?
-  resource = result.operation.resource
-  # Do something with resource
-else # result.failure?
-  raise result.error
-end
-
-# Because QuickBooks Online uses Oauth 2, you must always be sure to
-# save the access_token, refresh_token, and expirations as they can
-# change with any API call.
-result.operation.adaptor.ledger_attributes_to_save.each do |key, value|
-  # save values
-end
-```
-
-## How it Works
-
-This library consists of two important layers:
-
-1. Resources
-2. Adaptors
-
-### Resources
-
-Resources are named ruby objects (e.g. `Customer`, `Payment`, etc.) with strict attributes (e.g. `name`, `amount`, etc.).  They are a layer between your application and an adaptor.  They can be validated using an adaptor.  You can create and use the resources, and an adaptor will update resources as needed based on the intention and outcome of that operation.
-
-You can find supported resources by calling `LedgerSync.resources`.
-
-Resources have defined attributes.  Attributes are explicitly defined.  An error is thrown if an unknown attribute is passed to it.  You can retrieve the attributes of a resource by calling `LedgerSync::Customer.attributes`.
-
-A subset of these `attributes` may be a `reference`, which is simply a special type of attribute that references another resource.  You can retrieve the references of a resource by calling `LedgerSync::Customer.references`.
-
-#### Custom Attributes
-
-Some ledgers (e.g. NetSuite) allow for custom attributes (or "fields"), which can vary by account and user.  To allow for custom attributes, you can create new resources, ledger serializers (see below), and validation contracts (see below).  Assuming your ledger supports the string attribute `foo` for customers, you could do the following:
-
-```ruby
-class CustomCustomer < LedgerSync::Customer
-  attribute :foo, type: LedgerSync::Type::String
-end
-```
-
-Depending on your use of LedgerSync, you may need to define resources dynamically with different custom attributes.  You could do so using something like the following:
-
-```ruby
-custom_attributes_for_customers = [
-  [
-    [:foo, LedgerSync::Type::String]
-  ],
-  [
-    [:foo, LedgerSync::Type::Integer],
-    [:bar, LedgerSync::Type::Boolean]
-  ]
-]
-
-custom_customer_classes = custom_attributes_for_customers.map do |attributes|
-  klass = Class.new(LedgerSync::Customer)
-  attributes.each do |name, type|
-    klass.attribute name, type: type
-  end
-  klass
-end
-
-klass1, klass2 = custom_customer_classes
-
-# First Custom Customer Class
-klass1.resource_attributes.include?(:foo) # => true
-klass1.resource_attributes[:foo].type # => #<LedgerSync::Type::String:0x00007fe04e9529b0 @precision=nil, @scale=nil, @limit=nil>
-klass1.resource_attributes.include?(:bar) # => false
-
-# Second Custom Customer Class
-klass2.resource_attributes.include?(:foo) # => true
-klass2.resource_attributes[:foo].type # => #<LedgerSync::Type::Integer:0x00007fe04e2c7898 @precision=nil, @scale=nil, @limit=nil, @range=-2147483648...2147483648>
-klass2.resource_attributes.include?(:bar) # => true
-klass2.resource_attributes[:bar].type # => #<LedgerSync::Type::Boolean:0x00007fe04e2e4f10 @precision=nil, @scale=nil, @limit=nil>
-```
-
-You can now use these custom resources in operations that require custom attributes.
-
-### Adaptors
-
-Adaptors are ledger-specific ruby objects that contain all the logic to authenticate to a ledger, perform ledger-specific operations, and validate resources based on the requirements of the ledger.  Adaptors contain a number of useful objects:
-
-- adaptor
-- serializers
-- operations
-- searchers
-
-#### Adaptor
-
-The adaptor handles authentication and requests to the ledger.  Each adaptors initializer will vary based on the needs of that ledger.
-
-#### Serializers
-
-Operations depend on `LedgerSync::Adaptor::LedgerSerializer`s to serialize and deserialize objects.  Most resources have a default serializer per adaptor which may acts as both a serializer and deserializer.  You can provide custom serializers, which is necessary when working with custom attributes.  For example, given the following:
-- `custom_resource` that is a `LedgerSync::Customer` (see above)
-- the attribute `foo` is used in both the request and response bodies
-- using the `NetSuite` adaptor
-
-you could implement custom serializers using the following code:
-
-```ruby
-class CustomSerializer < LedgerSync::Adaptors::NetSuite::Customer::LedgerSerializer
-  attribute ledger_attribute: :foo,
-            resource_attribute: :foo,
-            deserialize: true, # optional, default: true
-            serialize: true # optional, default: true
-end
-
-# Serializing
-custom_resource = CustomCustomer.new(foo: 'asdf') # See above under Resources -> Custom Attributes
-serializer = CustomSerializer.new(resource: custom_resource)
-serializer.to_ledger_hash # => {"foo"=>"asdf"}
-
-# Deserializing
-deserialized_resource = serializer.deserialize(hash: { foo: 'qwerty' })
-deserialized_resource.foo # => 'qwerty'
-custom_resource.foo # => 'asdf'
-
-op = LedgerSync::Adaptors::NetSuite::Customer::Operations::Create.new(
-  adaptor: adaptor,
-  ledger_deserializer_class: CustomSerializer, # You must specify, though you could use a separate class
-  ledger_serializer_class: CustomSerializer,
-  resource: custom_resource
-)
-```
-
-Note that in the above example, we extend an existing customer serializer in the NetSuite adaptor.  In most cases, serializers have the following inheritance pattern: `LedgerSync::Adaptors::[ADAPTOR]::[RESOURCE]::LedgerSerializer <  LedgerSync::Adaptors::[ADAPTOR]::LedgerSerializer <  LedgerSync::Adaptors::LedgerSerializer`
-
-So in this example, it would be `LedgerSync::Adaptors::NetSuite::Customer::LedgerSerializer <  LedgerSync::Adaptors::NetSuite::LedgerSerializer <  LedgerSync::Adaptors::LedgerSerializer`.  The more specific the serializer, the more helper methods are available that are adaptor and/or resource specific.
-
-#### Operation
-
-Each adaptor defines operations that can be performed on specific resources (e.g. `Customer::Operations::Update`, `Payment::Operations::Create`).  The operation defines two key things:
-
-- a `Contract` class which is used to validate the resource using the `dry-validation` gem
-- a `perform` instance method, which handles the actual API requests and response/error handling.
-
-Note: Adaptors may support different operations for each resource type.
-
-##### Contracts
-
-Contracts are dry-validation schemas, which determine if an operation can be performed.  You can create custom schemas and pass them to operations.  Assuming you have an `operation_class` variable and `foo` is an attribute of a `custom_resource` (see above) that is required to be a string, you can implement it with the following:
-
-```ruby
-class CustomContract < LedgerSync::Adaptors::Contract
-  params do
-    required(:foo).filled(:string)
-  end
-end
-
-# A valid case
-custom_resource = CustomResource.new(foo: 'asdf')
-op = operation_class.new(
-  adaptor: adaptor,
-  resource: resource,
-  validation_contract: CustomContract
-)
-op.valid? # => true
-
-# An invalid case
-custom_resource = CustomResource.new(foo: nil)
-operation_class.new(
-  adaptor: adaptor,
-  resource: resource,
-  validation_contract: CustomContract
-)
-op.valid? # => false
-
-```
-
-#### Searcher
-
-Searchers are used to search objects in the ledger.  A searcher takes an `adaptor`, `query` string and optional `pagination` hash.  For example, to search customer's by name:
-
-```ruby
-searcher = LedgerSync::Adaptors::QuickBooksOnline::Customer::Searcher.new(
-  adaptor: adaptor # assuming this is defined,
-  query: 'test'
-)
-
-result = searcher.search # returns a LedgerSync::SearchResult
-
-if result.success?
-  resources = result.resources
-  # Do something with found resources
-else # result.failure?
-  raise result.error
-end
-
-# Different ledgers may use different pagination strategies.  In order
-# to get the next and previous set of results, you can use the following:
-next_searcher = searcher.next_searcher
-previous_searcher = searcher.previous_searcher
-```
-
-## NetSuite
-
-The NetSuite adaptor leverages NetSuite's REST API.
-
-### Resource Metadata and Schemas
-
-Due to NetSuites granular user permissions and custom attributes, resources and methods for those resources can vary from one user (a.k.a. token) to another.  Because of this variance, there are some helper classes that allow you to retrieve NetSuite records, allowed methods, attributes/parameters, etc.
-
-To retrieve the metadata for a record:
-
-```ruby
-metadata = LedgerSync::Adaptors::NetSuite::Record::Metadata.new(
-  adaptor: netsuite_adaptor, # Assuming this is previous defined
-  record: :customer
-)
-
-puts metadata.http_methods # Returns a list of LedgerSync::Adaptors::NetSuite::Record::HTTPMethod objects
-puts metadata.properties # Returns a list of LedgerSync::Adaptors::NetSuite::Record::Property objects
-```
-
-### Reference
-
-- [NetSuite REST API Documentation](https://docs.oracle.com/cloud/latest/netsuitecs_gs/NSTRW/NSTRW.pdf)
-
-## NetSuite SOAP
-
-LedgerSync supports the NetSuite SOAP adaptor, leveraging [the NetSuite gem](https://github.com/NetSweet/netsuite).  The adaptor and sample operations are provided, though the main NetSuite adaptor uses the REST API.
-
-### Reference
-
-- [NetSuite SOAP API Documentation](https://docs.oracle.com/cloud/latest/netsuitecs_gs/NSTWR/NSTWR.pdf)
-
-
-## QuickBooks Online
-
-### OAuth
-
-QuickBooks Online utilizes OAuth 2.0, which requires frequent refreshing of the access token.  The adaptor will handle this automatically, attempting a single token refresh on any single request authentication failure.  Depending on how you use the library, every adaptor has implements a class method `ledger_attributes_to_save`, which is an array of attributes that may change as the adaptor is used.  You can also call the instance method `ledger_attributes_to_save` which will be a hash of these values.  It is a good practice to always store these attributes if you are saving access tokens in your database.
-
-The adaptor also implements some helper methods for getting tokens.  For example, you can set up an adaptor using the following:
-
-```ruby
-# Retrieve the following values from Intuit app settings
-client_id     = 'ID'
-client_secret = 'SECRET'
-redirect_uri  = 'http://localhost:3000'
-
-oauth_client = LedgerSync::Adaptors::QuickBooksOnline::OAuthClientHelper.new(
-  client_id: client_id,
-  client_secret: client_secret
-)
-
-puts oauth_client.authorization_url(redirect_uri: redirect_uri)
-
-# Visit on the output URL and authorize a company.
-# You will be redirected back to the redirect_uri.
-# Copy the full url from your browser:
-
-uri = 'https://localhost:3000/?code=FOO&state=BAR&realm_id=BAZ'
-
-adaptor = LedgerSync::Adaptors::QuickBooksOnline::Adaptor.new_from_oauth_client_uri(
-  oauth_client: oauth_client,
-  uri: uri
-)
-
-# You can test that the auth works:
-
-adaptor.refresh!
-```
-
-**Note: If you have a `.env` file storing your secrets, the adaptor will automatically update the variables and record previous values whenever values change**
-
-### Webhooks
-
-Reference: [QuickBooks Online Webhook Documentation](https://developer.intuit.com/app/developer/qbo/docs/develop/webhooks/managing-webhooks-notifications#validating-the-notification)
-
-LedgerSync offers an easy way to validate and parse webhook payloads.  It also allows you to easily fetch the resources referenced.  You can create and use a webhook with the following:
-
-```ruby
-# Assuming `request` is the webhook request received from Quickbooks Online
-webhook = LedgerSync::Adaptors::QuickBooksOnline::Webhook.new(
-  payload: request.body.read # It accepts a JSON string or hash
-)
-
-verification_token = WEBHOOK_VERIFICATION_TOKEN # You get this token when you create webhooks in the QuickBooks Online dashboard
-signature = request.headers['intuit-signature']
-raise 'Not valid' unless webhook.valid?(signature: signature, verification_token: verification_token)
-
-# Although not yet used, webhooks may include notifications for multiple realms
-webhook.notifications.each do |notification|
-  puts notification.realm_id
-
-  # Multiple events may be referenced.
-  notification.events.each do |event|
-    puts event.resource # Returns a LedgerSync resource with the `ledger_id` set
-
-    # Other helpful methods
-    notification.find_operation_class(adaptor: your_quickbooks_adaptor_instance) # The respective Find class
-    notification.find_operation(adaptor: your_quickbooks_adaptor_instance) # The initialized respective Find operation
-    notification.find(adaptor: your_quickbooks_adaptor_instance) # Performs a Find operation for the resource retrieving the latest version from QuickBooks Online
-  end
-
-  # Other helpful methods
-  notification.resources # All resources for a given webhook across all events
-end
-
-# Other helpful methods
-webhook.events # All events for a given webhook across all realms
-webhook.resources # All events for a given webhook across all realms and events
-```
-
-### Errors
-
-- [QuickBooks Online Error Documentation](https://developer.intuit.com/app/developer/qbo/docs/develop/troubleshooting/error-codes)
-
-## Tips and More
-
-### Keyword Arguments
-
-LedgerSync heavily uses ruby keyword arguments so as to make it clear what values are being passed and which attributes are required.  When this README says something like "the `fun_function` function takes the argument `foo`" that translates to `fun_function(foo: :some_value)`.
-
-### Fingerprints
-
-Most objects in LedgerSync can be fingerprinted by calling the instance method `fingerprint`.  For example:
-
-```ruby
-puts LedgerSync::Customer.new.fingerprint # "b3eab7ec00431a4ae0468fee72e5ba8f"
-
-puts LedgerSync::Customer.new.fingerprint == LedgerSync::Customer.new.fingerprint # true
-puts LedgerSync::Customer.new.fingerprint == LedgerSync::Customer.new(name: :foo).fingerprint # false
-puts LedgerSync::Customer.new.fingerprint == LedgerSync::Payment.new.fingerprint # false
-```
-
-Fingerprints are used to compare objects.  This method is used in de-duping objects, as it only considers the data inside and not the instance itself (as shown above).
-
-### Serialization
-
-Most objects in LedgerSync can be serialized by calling the instance method `serialize`.  For example:
-
-```ruby
-puts LedgerSync::Payment.new(
-  customer: LedgerSync::Customer.new
-)
-
-{
-  root: "LedgerSync::Payment/8eed81c0177801a001f2544f0c85e21d",
-  objects: {
-    "LedgerSync::Payment/8eed81c0177801a001f2544f0c85e21d": {
-      id: "LedgerSync::Payment/8eed81c0177801a001f2544f0c85e21d",
-      object: "LedgerSync::Payment",
-      fingeprint: "8eed81c0177801a001f2544f0c85e21d",
-      data: {
-        currency: nil,
-        amount: nil,
-        customer: {
-          object: "reference",
-          id: "LedgerSync::Customer/b3eab7ec00431a4ae0468fee72e5ba8f"
-        },
-        external_id: "",
-        ledger_id: nil,
-
-      }
-    },
-    "LedgerSync::Customer/b3eab7ec00431a4ae0468fee72e5ba8f": {
-      id: "LedgerSync::Customer/b3eab7ec00431a4ae0468fee72e5ba8f",
-      object: "LedgerSync::Customer",
-      fingeprint: "b3eab7ec00431a4ae0468fee72e5ba8f",
-      data: {
-        name: nil,
-        email: nil,
-        phone_number: nil,
-        external_id: "",
-        ledger_id: nil
-      }
-    }
-  }
-}
-```
-
-The serialization of any object follows the same structure.  There is a `:root` key that holds the ID of the root object.  There is also an `:objects` hash that contains all of the objects for this serialization.  As you can see, unique nested objects listed in the `:objects` hash and referenced using a "reference object", in this case:
-
-```ruby
-{
-  object: "reference",
-  id: "LedgerSync::Customer/b3eab7ec00431a4ae0468fee72e5ba8f"
-}
-```
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org)
-
-### Testing
-
-Run `bundle exec rspec` to run all unit, feature, and integration tests.  Unlike QA Tests, all external HTTP requests and responses are stubbed.
-
-### QA Testing
-
-**BE SURE TO USE A TEST ENVIRONMENT ON YOUR LEDGER.**
-
-To fully test the library against the actual ledgers, you can run `bin/qa` which will run all tests in the `qa/` directory.  QA Tests are written in RSpec.  Unlike tests in the `spec/` directory, QA tests allow external HTTP requests.
-
-As these interact with real ledgers, you will need to provide secrets.  You can do so in a `.env` file in the root directory.  Copy the `.env.template` file to get started.
-
-**WARNINGS:**
-
-- **BE SURE TO USE A TEST ENVIRONMENT ON YOUR LEDGER.**
-- **NEVER CHECK IN YOUR SECRETS (e.g. the `.env` file).**
-- Because these tests actually create and modify resources, they attempt to do "cleanup" by deleting any newly created resources.  This process could fail, and you may need to delete these resources manually.
-
-### Console
-
-Run `bundle console` to start and interactive console with the library already loaded. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-## Deployment
-
-To deploy a new version of the gem to RubyGems, you can use the `release.sh` script in the root.  The script takes advantage of [the bump gem](https://github.com/gregorym/bump).  So you may call the script using any of the following:
-
-```bash
-# Version Format: MAJOR.MINOR.PATCH
-./release.sh patch # to bump X in 1.1.X
-./release.sh minor # to bump X in 1.X.1
-./release.sh major # to bump X in X.1.1
-```
-
-### Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/LedgerSync/ledger_sync. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-### License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-### Code of Conduct
-
-Everyone interacting in the LedgerSync project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/LedgerSync/ledger_sync/blob/master/CODE_OF_CONDUCT.md).
-
-# Maintainers
+## Maintainers
 
 A big thank you to our maintainers:
 
 - [@ryanwjackson](https://github.com/ryanwjackson)
 - [@jozefvaclavik](https://github.com/jozefvaclavik)
-- And the whole [Modern Treasury](https://www.moderntreasury.com) team
+- [@SeanBolt](https://github.com/SeanBolt)
+- And the whole [Modern Treasury](https://www.moderntreasury.com) team