ledger_sync 1.3.4 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a9ac9abd02e87286bdff439fc491e286bb1d4d175f109f892061e7485cec2fd
-  data.tar.gz: ef25734c3e806d530e9b50b9cec78bc93de4c11ec87dc8c9be5f004650113487
+  metadata.gz: 88373f5810a2313413c6d0a51ac42ff1fd80c7a58661ae37e04a0bad1d9d5e77
+  data.tar.gz: 626de0eb9096dc719354afee2e82fefdb392595869c07a22b8cfe2a89c502d0a
 SHA512:
-  metadata.gz: 34d67c0a951e721b66b61fd686cdb9258d11aa7270a61fe32e5aa2c0d66a1b614643b0f14d99c8c5d49f19a631cddc742b9afb3ad5035be164d903d77a3b727b
-  data.tar.gz: e21b60479be3bd1ed92ff65907b250e6286b0d37c9dc44ff2d3300d0aefdb6fe47d4d20359366a1be9133cb08fe3d6d2b1ee363c3c5eb2f5a44499a82827406f
+  metadata.gz: 489544c4dfb222723cf76a439d22b8e12624b0862de85ae5c49d419d3d1dac9b4120de88157fc9c8f0cd310924e23f776558c0a5a3663d727a90b289f1d52023
+  data.tar.gz: 81bf1d1a74339ad6d8ad664d9e79f07c738ef19b18e0bfb3bd9ba99c9bfe96c446133426ad582a4bed16a3ab08779efa59f9c5a7cdd3926e5b1ef19f9437bb0c

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/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/.travis.yml

@@ -1,9 +1,10 @@
 ---
-sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.5.1
+  - 2.6.6
 before_install:
   - gem update --system
   - gem install bundler:1.17.3
+script:
+  - bundle exec rspec --order rand

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.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ledger_sync (1.3.4)
+    ledger_sync (1.3.5)
       activemodel
       colorize
       coveralls
@@ -54,7 +54,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 +70,14 @@ GEM
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.2)
       dry-equalizer (~> 0.2)
-    dry-schema (1.4.3)
+    dry-schema (1.5.0)
       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,21 +85,21 @@ 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.0)
       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)
+      dry-schema (~> 1.5)
     factory_bot (5.1.1)
       activesupport (>= 4.2.0)
-    faraday (0.17.3)
+    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)
     fingerprintable (1.2.1)
       colorize
     gyoku (1.3.1)
@@ -132,7 +132,7 @@ GEM
     parallel (1.19.1)
     parser (2.7.0.3)
       ast (~> 2.4.0)
-    pd_ruby (0.2.0)
+    pd_ruby (0.2.3)
       colorize
     public_suffix (4.0.3)
     rack (2.2.2)
@@ -179,7 +179,7 @@ GEM
     simply_serializable (1.4.2)
       fingerprintable (>= 1.2.1)
     socksify (1.7.1)
-    stripe (5.17.0)
+    stripe (5.21.0)
     sync (0.5.0)
     term-ansicolor (1.7.1)
       tins (~> 1.0)

data/LICENSE.txt

@@ -1,21 +1,97 @@
-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.
+Business Source License 1.1
+
+Parameters
+
+Licensor:               Modern Treasury Corp.
+Licensed Work:          LedgerSync
+                        The Licensed Work is (c) 2020 Modern Treasury Corp.
+Additional Use Grant:   You may make use of the Licensed Work, provided that you
+                        may not use the Licensed Work for a Connector Service.
+
+                        A “Connector Service” is a commercial offering that
+                        allows third parties (other than your employees and
+                        contractors) to access the functionality of the Licensed
+                        Work by connecting to and exchanging information with
+                        general ledgers, accounting software, or other adaptors
+                        defined in the library that are controlled by such
+                        third parties.
+
+Notice
+
+The Business Source License (this document, or the “License”) is not an Open
+Source license. However, the Licensed Work will eventually be made available
+under an Open Source License, as stated in this License.
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
+“Business Source License” is a trademark of MariaDB Corporation Ab.
+
+-----------------------------------------------------------------------------
+
+Business Source License 1.1
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative
+works, redistribute, and make non-production use of the Licensed Work. The
+Licensor may make an Additional Use Grant, above, permitting limited
+production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly
+available distribution of a specific version of the Licensed Work under this
+License, whichever comes first, the Licensor hereby grants you rights under
+the terms of the Change License, and the rights granted in the paragraph
+above terminate.
+
+If your use of the Licensed Work does not comply with the requirements
+currently in effect as described in this License, you must purchase a
+commercial license from the Licensor, its affiliated entities, or authorized
+resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works
+of the Licensed Work, are subject to this License. This License applies
+separately for each version of the Licensed Work and the Change Date may vary
+for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy
+of the Licensed Work. If you receive the Licensed Work in original or
+modified form from a third party, the terms and conditions set forth in this
+License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically
+terminate your rights under this License for the current and all other
+versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of
+Licensor or its affiliates (provided that you may use a trademark or logo of
+Licensor as expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+TITLE.
+
+MariaDB hereby grants you permission to use this License’s text to license
+your works, and to refer to it using the trademark “Business Source License”,
+as long as you comply with the Covenants of Licensor below.
+
+Covenants of Licensor
+
+In consideration of the right to use this License’s text and the “Business
+Source License” name and trademark, Licensor covenants to MariaDB, and to all
+other recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 2.0 or any later version,
+   or a license that is compatible with GPL Version 2.0 or a later version,
+   where “compatible” means that software provided under the Change License can
+   be included in a program with software provided under GPL Version 2.0 or a
+   later version. Licensor may specify additional Change Licenses without
+   limitation.
+
+2. To either: (a) specify an additional grant of rights to use that does not
+   impose any additional restriction on the right granted in this License, as
+   the Additional Use Grant; or (b) insert the text “None”.
+
+3. To specify a Change Date.
+
+4. Not to modify this License in any other way.

data/README.md

@@ -4,6 +4,10 @@
 [![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)
 
+## Join the Conversation
+
+[Click here](https://join.slack.com/t/ledger-sync/shared_invite/zt-cn4qfhb8-~6BrVy8v7~upxQk6Pfo7oQ) to join our public Slack group.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -118,25 +122,25 @@ custom_attributes_for_customers = [
 ]
 
 custom_customer_classes = custom_attributes_for_customers.map do |attributes|
-  klass = Class.new(LedgerSync::Customer)
+  customer_class = Class.new(LedgerSync::Customer)
   attributes.each do |name, type|
-    klass.attribute name, type: type
+    customer_class.attribute name, type: type
   end
-  klass
+  customer_class
 end
 
-klass1, klass2 = custom_customer_classes
+customer_class_1, customer_class_2 = 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
+customer_class_1.resource_attributes.include?(:foo) # => true
+customer_class_1.resource_attributes[:foo].type # => #<LedgerSync::Type::String:0x00007fe04e9529b0 @precision=nil, @scale=nil, @limit=nil>
+customer_class_1.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>
+customer_class_2.resource_attributes.include?(:foo) # => true
+customer_class_2.resource_attributes[:foo].type # => #<LedgerSync::Type::Integer:0x00007fe04e2c7898 @precision=nil, @scale=nil, @limit=nil, @range=-2147483648...2147483648>
+customer_class_2.resource_attributes.include?(:bar) # => true
+customer_class_2.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.
@@ -297,6 +301,19 @@ LedgerSync supports the NetSuite SOAP adaptor, leveraging [the NetSuite gem](htt
 
 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.
 
+#### Retrieve Access Token
+
+The library contains a lightweight script that is helpful in retrieving and refreshing access tokens.  To use, do the following:
+
+1. Create a `.env` file in the library root.
+2. Add values for `QUICKBOOKS_ONLINE_CLIENT_ID` and `QUICKBOOKS_ONLINE_CLIENT_SECRET` (you can copy `.env.template`).
+3. Ensure your developer application in [the QuickBooks Online developer portal](https://developer.intuit.com) contains this redirect URI: `http://localhost:5678` (note: no trailing slash and port configurable with `PORT` environment variable)
+4. Run `ruby bin/quickbooks_online_oauth_server.rb` from the library root (note: it must run from the root in order to update `.env`).
+5. Visit the URL output in the terminal.
+6. Upon redirect back to your `localhost`, the new values will be printed to the console and saved back to your `.env`
+
+#### Adaptor Helper Methods
+
 The adaptor also implements some helper methods for getting tokens.  For example, you can set up an adaptor using the following:
 
 ```ruby

data/bin/quickbooks_online_oauth_server.rb

@@ -0,0 +1,101 @@
+# Setup
+#
+# gem install bundler
+# Ensure you have http://localhost:5678 (or PORT) as a Redirect URI in QBO.
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  gem 'dotenv'
+  gem 'ledger_sync'
+  gem 'rack'
+  gem 'pd_ruby', '0.2.2', require: true
+end
+
+puts 'Gems installed and loaded!'
+
+require 'socket'
+require 'dotenv'
+require 'rack'
+require 'ledger_sync'
+require 'rack/lobster'
+
+Dotenv.load
+
+port = ENV.fetch('PORT', 5678)
+app = Rack::Lobster.new
+server = TCPServer.new port
+
+base_url = "http://localhost:#{port}"
+
+puts "Listening at #{base_url}"
+
+client_id = ENV.fetch('QUICKBOOKS_ONLINE_CLIENT_ID')
+
+raise 'QUICKBOOKS_ONLINE_CLIENT_ID not set in ../.env' if client_id.blank?
+
+adaptor = LedgerSync::Adaptors::QuickBooksOnline::Adaptor.new_from_env(test: true)
+
+puts 'Go to the following URL:'
+puts adaptor.authorization_url(redirect_uri: base_url)
+
+while session = server.accept
+  request = session.gets
+
+  puts request
+
+  # 1
+  method, full_path = request.split(' ')
+
+  # 2
+  path, query = full_path.split('?')
+
+  params = Hash[query.split('&').map { |e| e.split('=') }] if query.present?
+
+  adaptor.set_credentials_from_oauth_code(
+    code: params.fetch('code'),
+    realm_id: params.fetch('realmId'),
+    redirect_uri: base_url
+  )
+
+  puts "\n"
+
+  puts 'access_token:'
+  puts adaptor.access_token
+  puts "\n"
+  puts 'client_id:'
+  puts adaptor.client_id
+  puts "\n"
+  puts 'client_secret:'
+  puts adaptor.client_secret
+  puts "\n"
+  puts 'realm_id:'
+  puts adaptor.realm_id
+  puts "\n"
+  puts 'refresh_token:'
+  puts adaptor.refresh_token
+  puts "\n"
+
+  puts 'Done!'
+
+  status = 200
+  body = 'Done'
+  headers = {
+    'Content-Length' => body.size
+  }
+
+  session.print "HTTP/1.1 #{status}\r\n"
+
+  headers.each do |key, value|
+    session.print "#{key}: #{value}\r\n"
+  end
+
+  session.print "\r\n"
+
+  session.print body
+
+  session.close
+
+  break
+end

data/lib/ledger_sync.rb

@@ -44,11 +44,18 @@ require 'ledger_sync/adaptor_configuration_store'
 require 'ledger_sync/util/performer'
 require 'ledger_sync/util/validator'
 require 'ledger_sync/util/string_helpers'
+require 'ledger_sync/util/mixins/delegate_iterable_methods_mixin'
+require 'ledger_sync/util/mixins/dupable_mixin'
 require 'ledger_sync/result'
+require 'ledger_sync/serializer'
+require 'ledger_sync/deserializer'
+require 'ledger_sync/serialization/deserializer_delegator'
+require 'ledger_sync/serialization/serializer_delegator'
 
 # Adaptors
 Gem.find_files('ledger_sync/adaptors/mixins/**/*.rb').each { |path| require path }
 require 'ledger_sync/adaptors/adaptor'
+require 'ledger_sync/adaptors/dashboard_url_helper'
 require 'ledger_sync/adaptors/searcher'
 require 'ledger_sync/adaptors/ledger_serializer'
 require 'ledger_sync/adaptors/operation'
@@ -146,5 +153,6 @@ LedgerSync.register_resource(resource: LedgerSync::Payment)
 LedgerSync.register_resource(resource: LedgerSync::PaymentLineItem)
 LedgerSync.register_resource(resource: LedgerSync::Transfer)
 LedgerSync.register_resource(resource: LedgerSync::Vendor)
+LedgerSync.register_resource(resource: LedgerSync::Location)
 
 LedgerSync.register_resource(resource: LedgerSync::Adaptors::QuickBooksOnline::Preferences)