ledger_sync 1.1.3 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e39d8dc0e6f3df94374cb5200d7062213327b06f470111c9d3baf4fe7407e76
-  data.tar.gz: 206ccec75be3d425dbaf6b3567af57536cab77851e8c815c31ee1642b81cb0ef
+  metadata.gz: 8aeb1fb1722b3457692a3a513ecd3dc419a3a489d00a24aa2839dfae6e5f203f
+  data.tar.gz: 66e5e8415a1c2bfb6c1c04f8210e046f3510390a0bf0768932d6120a1453bf8b
 SHA512:
-  metadata.gz: 1024346df20614497f7db8e000bacd9440efb24084e2675769295ef69dc2d1d6c1770d8c5f25258ad05ba1b7bdb6d9ae23440c8d56787c3980c572e65a2af52a
-  data.tar.gz: b5571c6836c32ade58704aae76ac4b1577c5f457240c5ce2ef121a27b9424eb46619366fe09650c4a6953e44d6dd5b9df1eba4e42d8d313e72b17433e26075cd
+  metadata.gz: 87bc80cc850ac858e3d448098d2acd8b1f7a502ec7e51126c1d9a52560aedc02dcd968069fbf9a9de0a86ebbc7b6c52f64ccf0a6c3cdc4fbe5bf390fdd4373af
+  data.tar.gz: 3b5e0d36361a0910acd74c4ae3de805c09ad14838cfc02eb458c8fc93069190f0633f4738fb549d1e3de0f92e1f6dd74110317f20d36c718d1352e3c1ba5f861

data/.env.template

@@ -0,0 +1,25 @@
+NETSUITE_QA=0 # Set to 1 to run NETSUITE tests
+NETSUITE_ACCOUNT_ID=
+NETSUITE_CONSUMER_KEY=
+NETSUITE_CONSUMER_SECRET=
+NETSUITE_TOKEN_ID=
+NETSUITE_TOKEN_SECRET=
+
+NETSUITE_SOAP_QA=0 # Set to 1 to run NETSUITE_SOAP tests
+NETSUITE_SOAP_ACCOUNT_ID=
+NETSUITE_SOAP_API_VERSION=
+NETSUITE_SOAP_APPLICATION_ID=
+NETSUITE_SOAP_CONSUMER_KEY=
+NETSUITE_SOAP_CONSUMER_SECRET=
+NETSUITE_SOAP_TOKEN_ID=
+NETSUITE_SOAP_TOKEN_SECRET=
+
+QUICKBOOKS_ONLINE_QA=0 # Set to 1 to run QUICKBOOKS_ONLINE tests
+QUICKBOOKS_ONLINE_ACCESS_TOKEN=
+QUICKBOOKS_ONLINE_CLIENT_ID=
+QUICKBOOKS_ONLINE_CLIENT_SECRET=
+QUICKBOOKS_ONLINE_REALM_ID=
+QUICKBOOKS_ONLINE_REFRESH_TOKEN=
+
+STRIPE_QA=0 # Set to 1 to run STRIPE tests
+STRIPE_API_KEY=

data/.gitignore

@@ -13,4 +13,6 @@
 .byebug_history
 .qa_config.yml
 
-.DS_Store
+.DS_Store
+
+.env

data/.rubocop_todo.yml

@@ -12,7 +12,7 @@ Metrics/AbcSize:
 Metrics/BlockLength:
   Enabled: False
 
-Style/Documentation:
+Metrics/ClassLength:
   Enabled: False
 
 Metrics/LineLength:
@@ -23,3 +23,6 @@ Metrics/MethodLength:
 
 Metrics/ParameterLists:
   Enabled: False
+
+Style/Documentation:
+  Enabled: False

data/.travis.yml

@@ -6,4 +6,4 @@ rvm:
   - 2.5.1
 before_install:
   - gem update --system
-  - gem install bundler
+  - gem install bundler:1.17.3

data/Gemfile.lock

@@ -1,36 +1,43 @@
 PATH
   remote: .
   specs:
-    ledger_sync (1.1.3)
+    ledger_sync (1.3.1)
       activemodel
       colorize
       coveralls
+      dotenv
       dry-schema
       dry-validation
       faraday
       faraday-detailed_logger
       faraday_middleware
       fingerprintable (>= 1.2.1)
+      netsuite
       nokogiri
       oauth2
       resonad
       simply_serializable (>= 1.3.0)
+      stripe
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.0)
-      activesupport (= 6.0.0)
-    activesupport (6.0.0)
+    activemodel (6.0.1)
+      activesupport (= 6.0.1)
+    activesupport (6.0.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
+      zeitwerk (~> 2.2)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
+    akami (1.3.1)
+      gyoku (>= 0.4.0)
+      nokogiri
     ast (2.4.0)
     awesome_print (1.8.0)
+    builder (3.2.4)
     bump (0.8.0)
     byebug (11.0.1)
     colorize (0.8.1)
@@ -45,7 +52,8 @@ GEM
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     docile (1.3.2)
-    dry-configurable (0.8.3)
+    dotenv (2.7.5)
+    dry-configurable (0.9.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.4, >= 0.4.7)
     dry-container (0.7.2)
@@ -53,14 +61,14 @@ GEM
       dry-configurable (~> 0.1, >= 0.1.3)
     dry-core (0.4.9)
       concurrent-ruby (~> 1.0)
-    dry-equalizer (0.2.2)
+    dry-equalizer (0.3.0)
     dry-inflector (0.2.0)
-    dry-initializer (3.0.1)
-    dry-logic (1.0.3)
+    dry-initializer (3.0.3)
+    dry-logic (1.0.5)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.2)
       dry-equalizer (~> 0.2)
-    dry-schema (1.4.1)
+    dry-schema (1.4.3)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.8, >= 0.8.3)
       dry-core (~> 0.4)
@@ -68,41 +76,51 @@ GEM
       dry-initializer (~> 3.0)
       dry-logic (~> 1.0)
       dry-types (~> 1.2)
-    dry-types (1.2.0)
+    dry-types (1.2.2)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.3)
       dry-core (~> 0.4, >= 0.4.4)
-      dry-equalizer (~> 0.2, >= 0.2.2)
+      dry-equalizer (~> 0.3)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    dry-validation (1.3.1)
+    dry-validation (1.4.2)
       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.0, >= 1.3.1)
-    faraday (0.17.0)
+      dry-schema (~> 1.4, >= 1.4.3)
+    factory_bot (4.11.1)
+      activesupport (>= 3.0.0)
+    faraday (0.17.3)
       multipart-post (>= 1.2, < 3)
-    faraday-detailed_logger (2.1.3)
-      faraday (~> 0.8)
-    faraday_middleware (0.13.1)
+    faraday-detailed_logger (2.2.0)
+      faraday (>= 0.8, < 2)
+    faraday_middleware (0.14.0)
       faraday (>= 0.7.4, < 1.0)
     fingerprintable (1.2.1)
       colorize
+    gyoku (1.3.1)
+      builder (>= 2.1.2)
     hashdiff (1.0.0)
+    httpi (2.4.4)
+      rack
+      socksify
     i18n (1.7.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.3)
-    json (2.2.0)
+    json (2.3.0)
     jwt (2.2.1)
     mini_portile2 (2.4.0)
-    minitest (5.12.2)
+    minitest (5.13.0)
     multi_json (1.14.1)
     multi_xml (0.6.0)
     multipart-post (2.1.1)
-    nokogiri (1.10.4)
+    netsuite (0.8.5)
+      savon (>= 2.3.0)
+    nokogiri (1.10.7)
       mini_portile2 (~> 2.4.0)
+    nori (2.6.0)
     oauth2 (1.4.2)
       faraday (>= 0.8, < 2.0)
       jwt (>= 1.0, < 3.0)
@@ -113,7 +131,7 @@ GEM
     parser (2.6.4.1)
       ast (~> 2.4.0)
     public_suffix (4.0.1)
-    rack (2.0.7)
+    rack (2.1.1)
     rainbow (3.0.0)
     rake (10.5.0)
     resonad (1.2.0)
@@ -139,6 +157,14 @@ GEM
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
+    savon (2.12.0)
+      akami (~> 1.2)
+      builder (>= 2.1.2)
+      gyoku (~> 1.2)
+      httpi (~> 2.3)
+      nokogiri (>= 1.8.1)
+      nori (~> 2.4)
+      wasabi (~> 3.4)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -146,20 +172,27 @@ GEM
     simplecov-html (0.10.2)
     simply_serializable (1.4.2)
       fingerprintable (>= 1.2.1)
+    socksify (1.7.1)
+    stripe (5.14.0)
+    sync (0.5.0)
     term-ansicolor (1.7.1)
       tins (~> 1.0)
-    thor (0.20.3)
+    thor (1.0.1)
     thread_safe (0.3.6)
-    tins (1.21.1)
+    tins (1.24.0)
+      sync
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
     unicode-display_width (1.6.0)
     vcr (5.0.0)
+    wasabi (3.5.0)
+      httpi (~> 2.0)
+      nokogiri (>= 1.4.2)
     webmock (3.7.5)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.2.0)
+    zeitwerk (2.2.2)
 
 PLATFORMS
   ruby
@@ -169,6 +202,7 @@ DEPENDENCIES
   bump
   bundler (~> 1.16)
   byebug
+  factory_bot
   ledger_sync!
   rake (~> 10.0)
   rspec (~> 3.2)

data/README.md

@@ -14,11 +14,15 @@ gem 'ledger_sync'
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install ledger_sync
+```bash
+$ gem install ledger_sync
+```
 
 ## Usage
 
@@ -138,13 +142,122 @@ 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
 
-https://developer.intuit.com/app/developer/qbo/docs/develop/troubleshooting/error-codes
+- [QuickBooks Online Error Documentation](https://developer.intuit.com/app/developer/qbo/docs/develop/troubleshooting/error-codes)
 
-## Tips and More!
+## Tips and More
 
 ### Keyword Arguments
 
@@ -217,7 +330,7 @@ The serialization of any object follows the same structure.  There is a `:root`
 }
 ```
 
-## Testing
+## Test Adaptor
 
 LedgerSync offers a test adaptor `LedgerSync::Adaptors::Test::Adaptor` that you can easily use and stub without requiring API requests.  For example:
 
@@ -239,11 +352,42 @@ expect { operation.perform }.to raise_error(PerformedOperationError)
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+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).
+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)
 
-Run `bundle console` to start and interactive console with the library already loaded.
+### 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
 
@@ -256,3 +400,11 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ### 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
+
+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