ledger_sync 1.3.4 → 1.4.4

data/documentation/site/reference/stripe/resources/index.md

@@ -0,0 +1,8 @@
+---
+title: Resources
+weight: 0
+layout: reference_stripe
+---
+
+- [resource](/reference/stripe/resources/resource)
+- [customer](/reference/stripe/resources/customer)

data/documentation/site/reference/stripe/resources/resource.md

@@ -0,0 +1,22 @@
+---
+title: resource
+weight: 2
+layout: reference_stripe
+---
+
+## LedgerSync::Ledgers::Stripe::Resource
+
+## Attributes
+
+| Name | Type |
+| ---- | ---- |
+| external_id | LedgerSync::Type::ID |
+| ledger_id | LedgerSync::Type::ID |
+
+
+## Operations
+
+
+## Searchers
+
+There are no searchers for this resource.

data/documentation/site/style-guide.md

@@ -0,0 +1,137 @@
+---
+title: Style Guide
+subtitle: The style guide provides you with a blueprint of default post and page styles.
+image: images/5.jpg
+layout: page
+---
+
+**This is a paragraph**. Pellentesque habitant morbi *tristique senectus et netus et malesuada* fames ac turpis egestas. Vestibulum [tortor quam](https://www.google.com), feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo. Quisque sit <mark>amet est et sapien ullamcorper</mark> pharetra. Vestibulum erat wisi, condimentum sed, commodo vitae, ornare sit amet, wisi.
+
+# This is an H1
+
+Quisque facilisis erat a dui. Nam malesuada ornare dolor. Cras gravida, this is marked text ornare, erat elit consectetuer erat, id egestas pede nibh eget odio. Proin tincidunt, velit vel porta elementum, magna diam molestie sapien, non aliquet massa pede eu diam. Aliquam iaculis. Fusce et ipsum et nulla tristique facilisis.
+
+## This is an H2
+
+Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Morbi commodo, ipsum sed pharetra gravida, orci magna rhoncus neque, id pulvinar odio lorem non turpis. Nullam sit amet enim. Suspendisse id velit vitae ligula volutpat condimentum. Aliquam erat volutpat. Sed quis velit. Nulla facilisi. Nulla libero.
+
+### This is an H3
+
+Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Morbi commodo, ipsum sed pharetra gravida, orci magna rhoncus neque, id pulvinar odio lorem non turpis. Nullam sit amet enim. Suspendisse id velit vitae ligula volutpat condimentum. Aliquam erat volutpat. Sed quis velit. Nulla facilisi. Nulla libero.
+
+#### This is an H4
+
+Quisque facilisis erat a dui. Nam malesuada ornare dolor. Cras gravida, diam sit amet rhoncus ornare, erat elit consectetuer erat, id egestas pede nibh eget odio. Proin tincidunt, velit vel porta elementum, magna diam molestie sapien, non aliquet massa pede eu diam. Aliquam iaculis.
+
+## Quoting
+
+Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
+
+>Creativity is allowing yourself to make mistakes. Design is knowing which ones to keep. - Scott Adams
+
+Morbi commodo, ipsum sed pharetra gravida, orci magna rhoncus neque, id pulvinar odio lorem non turpis. Nullam sit amet enim. Suspendisse id velit vitae ligula volutpat condimentum. Aliquam erat volutpat. Sed quis velit. Nulla facilisi. Nulla libero.
+
+<hr />
+
+## Unordered Lists
+
++ Donec non tortor in arcu mollis feugiat
++ Lorem ipsum dolor sit amet, consectetuer adipiscing elit
++ Donec id eros eget quam aliquam gravida
++ Vivamus convallis urna id felis
++ Nulla porta tempus sapien
+
+## Ordered Lists
+
+1. Donec non tortor in arcu mollis feugiat
+2. Lorem ipsum dolor sit amet, consectetuer adipiscing elit
+3. Donec id eros eget quam aliquam gravida
+4. Vivamus convallis urna id felis
+5. Nulla porta tempus sapien
+
+## Video Embeds
+
+<iframe src="https://player.vimeo.com/video/335879257" width="640" height="338" frameborder="0" allow="autoplay; fullscreen" allowfullscreen></iframe>
+
+## Code Blocks
+
+Blocks of code are either fenced by `lines with three back-ticks`, or are indented with four spaces.
+
+```
+<!-- Some example CSS code -->
+body {
+  color:red;
+}
+```
+
+```javascript
+window.$guidesify = {
+  coverpage: true,
+
+  // Custom file name
+  coverpage: 'cover.md',
+
+  // mutiple covers
+  coverpage: ['/', '/zh-cn/'],
+
+  // mutiple covers and custom file name
+  coverpage: {
+    '/': 'cover.md',
+    '/zh-cn/': 'cover.md'
+  }
+};
+```
+
+## Tables
+
+<div class="responsive-table">
+  <table>
+      <caption>Table with thead, tfoot, and tbody</caption>
+    <thead>
+      <tr>
+        <th>Header content 1</th>
+        <th>Header content 2</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td>Body content 1</td>
+        <td>Body content 2</td>
+      </tr>
+    </tbody>
+    <tfoot>
+      <tr>
+        <td>Footer content 1</td>
+        <td>Footer content 2</td>
+      </tr>
+    </tfoot>
+  </table>
+</div>
+
+<div class="alert note">
+  <strong>Note:</strong>
+  Both of the features you used above are parts of the Document Object Model (DOM) API, which allows you to manipulate documents.
+</div>
+
+<div class="alert danger"><strong>Important:</strong> In this article, try entering the example code lines into your JavaScript console to see what happens. For more details on JavaScript consoles, see Discover browser developer tools.</div>
+
+<div class="alert info"><strong>Info:</strong> In this article, try entering the example code lines into your JavaScript console to see what happens. For more details on JavaScript consoles, see Discover browser developer tools.</div>
+
+
+{% capture example_content %}
+```ruby
+token = LedgerSync::Ledgers::NetSuite::Token.new(
+  method: method,
+  consumer_key: consumer_key,
+  consumer_secret: consumer_secret,
+  realm: realm,
+  token_id: token_id,
+  token_secret: token_secret,
+  url: url
+)
+
+puts token.signature_data_string
+```
+{% endcapture %}
+
+{% include example.md content=example_content %}

data/ledger_sync.gemspec

@@ -11,7 +11,8 @@ Gem::Specification.new do |spec|
   # spec.required_rubygems_version = Gem::Requirement.new('>= 0') if spec.respond_to? :required_rubygems_version=
   spec.authors = ['Ryan Jackson']
   spec.date = '2019-05-21'
-  spec.description = 'LedgerSync is a simple library that allows you to sync common objects to popular accounting software like QuickBooks Online, Xero, NetSuite, etc.'
+  spec.description = 'LedgerSync is a simple library that allows you to sync common objects to popular accounting '\
+                     'software like QuickBooks Online, Xero, NetSuite, etc.'
   spec.email = ['ryanwjackson@gmail.com']
   spec.homepage = 'https://github.com/LedgerSync/ledger_sync'
   spec.licenses = ['MIT']
@@ -32,6 +33,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency('bundler', '~> 1.16')
   spec.add_development_dependency('byebug', '>= 0')
   spec.add_development_dependency('factory_bot')
+  spec.add_development_dependency('jekyll', '~> 3.8.4')
+  spec.add_development_dependency('jekyll-menus', '~> 0.6.0')
+  spec.add_development_dependency('jekyll-paginate', '~> 1.1')
+  spec.add_development_dependency('jekyll-paginate-v2', '~> 1.9')
+  spec.add_development_dependency('overcommit')
   spec.add_development_dependency('rake', '~> 13.0')
   spec.add_development_dependency('rspec', '~> 3.2')
   spec.add_development_dependency('rubocop', '>= 0')
@@ -52,6 +58,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency('oauth2', '>= 0')
   spec.add_runtime_dependency('pd_ruby', '>= 0')
   spec.add_runtime_dependency('resonad', '>= 0')
-  spec.add_runtime_dependency('simply_serializable', '>= 1.3.0')
+  spec.add_runtime_dependency('simply_serializable', '>= 1.5.1')
   spec.add_runtime_dependency('stripe')
 end

data/lib/ledger_sync.rb

@@ -35,34 +35,44 @@ Gem.find_files('ledger_sync/error/**/*.rb').each { |path| require path }
 
 # Support Classes
 require 'ledger_sync/util/resonad'
+require 'ledger_sync/util/url_helpers'
 require 'ledger_sync/util/signer'
 require 'ledger_sync/util/hash_helpers'
 require 'ledger_sync/util/read_only_object'
 require 'ledger_sync/util/resources_builder'
-require 'ledger_sync/adaptor_configuration'
-require 'ledger_sync/adaptor_configuration_store'
+require 'ledger_sync/ledger_configuration'
+require 'ledger_sync/ledger_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/resource_registerable_mixin'
+require 'ledger_sync/util/mixins/dupable_mixin'
 require 'ledger_sync/result'
-
-# Adaptors
-Gem.find_files('ledger_sync/adaptors/mixins/**/*.rb').each { |path| require path }
-require 'ledger_sync/adaptors/adaptor'
-require 'ledger_sync/adaptors/searcher'
-require 'ledger_sync/adaptors/ledger_serializer'
-require 'ledger_sync/adaptors/operation'
-require 'ledger_sync/adaptors/contract'
-require 'ledger_sync/adaptors/response'
-require 'ledger_sync/adaptors/request'
-
-# Resources (resources are registerd below)
+require 'ledger_sync/operation'
+require 'ledger_sync/resource_adaptor'
+
+Gem.find_files('ledger_sync/type/**/*.rb').each { |path| require path }
+Gem.find_files('ledger_sync/serialization/type/**/*.rb').each { |path| require path }
+require 'ledger_sync/serializer'
+require 'ledger_sync/deserializer'
+
+# Ledgers
+Gem.find_files('ledger_sync/ledgers/mixins/**/*.rb').each { |path| require path }
+require 'ledger_sync/ledgers/client'
+require 'ledger_sync/ledgers/dashboard_url_helper'
+require 'ledger_sync/ledgers/searcher'
+require 'ledger_sync/ledgers/operation'
+require 'ledger_sync/ledgers/contract'
+require 'ledger_sync/ledgers/response'
+require 'ledger_sync/ledgers/request'
+
+# Resources (resources are registered below)
 require 'ledger_sync/resource' # Template class
-Gem.find_files('ledger_sync/resources/**/*.rb').each { |path| require path }
-
-Gem.find_files('ledger_sync/adaptors/quickbooks_online/resources/**/*.rb').each { |path| require path }
 
 module LedgerSync
+  include Util::Mixins::ResourceRegisterableMixin
+
   @log_level = nil
   @logger = nil
 
@@ -72,7 +82,7 @@ module LedgerSync
   LEVEL_INFO = Logger::INFO
 
   class << self
-    attr_accessor :adaptors, :resources
+    attr_accessor :ledgers
   end
 
   def self.log_level
@@ -80,7 +90,9 @@ module LedgerSync
   end
 
   def self.log_level=(val)
-    raise ArgumentError, 'log_level should only be set to `nil`, `debug` or `info`' if !val.nil? && ![LEVEL_DEBUG, LEVEL_ERROR, LEVEL_INFO].include?(val)
+    if !val.nil? && ![LEVEL_DEBUG, LEVEL_ERROR, LEVEL_INFO].include?(val)
+      raise ArgumentError, 'log_level should only be set to `nil`, `debug` or `info`'
+    end
 
     @log_level = val
   end
@@ -93,58 +105,31 @@ module LedgerSync
     @logger = val
   end
 
-  def self.register_adaptor(adaptor_key, module_string: nil)
-    adaptor_root_path = "ledger_sync/adaptors/#{adaptor_key}"
-    require "#{adaptor_root_path}/adaptor"
-    self.adaptors ||= LedgerSync::AdaptorConfigurationStore.new
-    adaptor_config = LedgerSync::AdaptorConfiguration.new(adaptor_key, module_string: module_string)
-    yield(adaptor_config)
-    self.adaptors.register_adaptor(adaptor_config: adaptor_config)
-
-    adaptor_files = Gem.find_files("#{adaptor_root_path}/**/*.rb")
+  def self.register_ledger(ledger_key, module_string: nil)
+    ledger_root_path = "ledger_sync/ledgers/#{ledger_key}"
+    require "#{ledger_root_path}/client"
+    self.ledgers ||= LedgerSync::LedgerConfigurationStore.new
+    ledger_config = LedgerSync::LedgerConfiguration.new(ledger_key, module_string: module_string)
+    yield(ledger_config)
+    self.ledgers.register_ledger(ledger_config: ledger_config)
+
+    client_files = Gem.find_files("#{ledger_root_path}/resource.rb")
+    client_files |= Gem.find_files("#{ledger_root_path}/resources/**/*.rb")
+    client_files |= Gem.find_files("#{ledger_root_path}/serialization/**/*.rb")
     # Sort the files to include BFS-style as most dependencies are in parent folders
-    adaptor_files.sort { |a, b| a.count('/') <=> b.count('/') }.each do |path|
+    client_files |= Gem.find_files("#{ledger_root_path}/**/*.rb").sort { |a, b| a.count('/') <=> b.count('/') }
+
+    client_files.each do |path|
       next if path.include?('config.rb')
 
       require path
     end
   end
 
-  def self.register_resource(resource:)
-    self.resources ||= {}
-    raise "Resource key #{resource.resource_type} already exists." if resources.key?(resource.resource_type)
-
-    self.resources[resource.resource_type] = resource
-  end
-
   def self.root
     File.dirname __dir__
   end
 end
 
-# Load Adaptors
-Gem.find_files('ledger_sync/adaptors/**/config.rb').each { |path| require path }
-
-# Register Resources
-LedgerSync.register_resource(resource: LedgerSync::Account)
-LedgerSync.register_resource(resource: LedgerSync::Bill)
-LedgerSync.register_resource(resource: LedgerSync::BillLineItem)
-LedgerSync.register_resource(resource: LedgerSync::Currency)
-LedgerSync.register_resource(resource: LedgerSync::Customer)
-LedgerSync.register_resource(resource: LedgerSync::Department)
-LedgerSync.register_resource(resource: LedgerSync::Deposit)
-LedgerSync.register_resource(resource: LedgerSync::DepositLineItem)
-LedgerSync.register_resource(resource: LedgerSync::Expense)
-LedgerSync.register_resource(resource: LedgerSync::ExpenseLineItem)
-LedgerSync.register_resource(resource: LedgerSync::Invoice)
-LedgerSync.register_resource(resource: LedgerSync::InvoiceSalesLineItem)
-LedgerSync.register_resource(resource: LedgerSync::Item)
-LedgerSync.register_resource(resource: LedgerSync::JournalEntry)
-LedgerSync.register_resource(resource: LedgerSync::JournalEntryLineItem)
-LedgerSync.register_resource(resource: LedgerSync::LedgerClass)
-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::Adaptors::QuickBooksOnline::Preferences)
+# Load Ledgers
+Gem.find_files('ledger_sync/ledgers/**/config.rb').each { |path| require path }

data/lib/ledger_sync/concerns/validatable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LedgerSync
   module Validatable
     def valid?

data/lib/ledger_sync/core_ext/resonad.rb

@@ -6,10 +6,10 @@ class Resonad
   include SimplySerializable::Mixin
 
   class Success < Resonad
-    serialize only: %i[value]
+    simply_serialize only: %i[value]
   end
 
   class Failure < Resonad
-    serialize only: %i[error]
+    simply_serialize only: %i[error]
   end
 end

data/lib/ledger_sync/deserializer.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require_relative 'serialization/mixin'
+require_relative 'serialization/deserializer_attribute_set'
+require_relative 'serialization/deserializer_attribute'
+
+module LedgerSync
+  class Deserializer
+    include Serialization::Mixin
+
+    class Delegator
+      def deserialize(args = {})
+        deserializer_for(args).new.deserialize(args)
+      end
+
+      private
+
+      def deserializer_for(_args = {})
+        raise NotImplementedError
+      end
+    end
+
+    def attribute_value_from_ledger(hash:, deserializer_attribute:, resource:)
+      deserializer_attribute.value_from_hash(
+        hash: hash,
+        resource: resource
+      )
+    end
+
+    def deserialize(args = {})
+      hash     = args.fetch(:hash)
+      resource = args.fetch(:resource)
+
+      deserialize_into = resource.dup # Do not overwrite values in the resource
+      hash = Util::HashHelpers.deep_stringify_keys(hash)
+
+      self.class.attributes.each_value do |deserializer_attribute|
+        value = attribute_value_from_ledger(
+          hash: hash,
+          deserializer_attribute: deserializer_attribute,
+          resource: deserialize_into
+        )
+
+        deserialize_into.assign_attribute(
+          deserializer_attribute.resource_attribute_dot_parts.first,
+          value
+        )
+      end
+
+      deserialize_into
+    end
+
+    def self.attribute(resource_attribute, args = {}, &block)
+      if args.key?(:resource_attribute)
+        raise 'You cannot provide resource_attribute in args.  Pass the value as the first argument.'
+      end
+
+      _attribute(
+        args.merge(
+          block: (block if block_given?),
+          resource_attribute: resource_attribute
+        )
+      )
+    end
+
+    def self.attribute_class
+      Serialization::DeserializerAttribute
+    end
+
+    def self.attributes
+      @attributes ||= Serialization::DeserializerAttributeSet.new(serializer_class: self)
+    end
+
+    def self.references_one(resource_attribute, args = {}, &block)
+      attribute(
+        resource_attribute,
+        {
+          type: Serialization::Type::DeserializerReferencesOneType.new(
+            deserializer: deserializer_from(resource_attribute, args)
+          )
+        }.merge(args),
+        &block
+      )
+    end
+
+    def self.references_many(resource_attribute, args = {}, &block)
+      attribute(
+        resource_attribute,
+        {
+          type: Serialization::Type::DeserializerReferencesManyType.new(
+            deserializer: deserializer_from(resource_attribute, args)
+          )
+        }.merge(args),
+        &block
+      )
+    end
+
+    def self.deserializer_from(resource_attribute, args = {})
+      if args.key?(:deserializer)
+        args.fetch(:deserializer)
+      else
+        resource_key = inferred_resource_class.resource_attributes[resource_attribute].type.resource_class.resource_type
+        require "ledger_sync/ledgers/#{inferred_client_class.root_key}/#{resource_key}/deserializer"
+        inferred_client_class.resources[resource_key]::Deserializer
+      end
+    end
+  end
+end