ledger_sync 1.3.4 → 1.4.4

data/documentation/site/_includes/reference/netsuite/authentication/index.md

@@ -0,0 +1,15 @@
+---
+title: Authentication
+layout: reference_netsuite
+ledger: netsuite
+---
+
+For the REST API, NetSuite offers two types of authentication:
+
+- Token Based Authentication (TBA)
+- Oauth 2.0
+
+This client currently uses TBA.  While Oauth 2.0 may be available in the future, TBA was chosen for the following reasons:
+
+1. The SOAP API only supports TBA.
+2. NetSuite users will still need to go through a manual setup (e.g. Integration record and Role) regardless of the method.

data/documentation/site/_includes/reference/netsuite/authentication/token_based_authentication.md

@@ -0,0 +1,6 @@
+---
+title: Token Based Authentication
+layout: reference_netsuite
+---
+
+{% include reference/netsuite/authentication/_token_based_authentication.md %}

data/documentation/site/_includes/reference/netsuite/index.md

@@ -0,0 +1,25 @@
+---
+title: NetSuite
+layout: reference_netsuite
+ledger: netsuite
+---
+
+### 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::Ledgers::NetSuite::Record::Metadata.new(
+  client: netsuite_client, # Assuming this is previous defined
+  record: :customer
+)
+
+puts metadata.http_methods # Returns a list of LedgerSync::Ledgers::NetSuite::Record::HTTPMethod objects
+puts metadata.properties # Returns a list of LedgerSync::Ledgers::NetSuite::Record::Property objects
+```
+
+### Reference
+
+- [NetSuite REST API Documentation](https://docs.oracle.com/cloud/latest/netsuitecs_gs/NSTRW/NSTRW.pdf)

data/documentation/site/_includes/reference/netsuite_soap/index.md

@@ -0,0 +1,11 @@
+---
+title: NetSuite SOAP
+layout: reference_netsuite_soap
+ledger: netsuite_soap
+---
+
+LedgerSync supports the NetSuite SOAP client, leveraging [the NetSuite gem](https://github.com/NetSweet/netsuite).  The client and sample operations are provided, though the main NetSuite client uses the REST API.
+
+### Reference
+
+- [NetSuite SOAP API Documentation](https://docs.oracle.com/cloud/latest/netsuitecs_gs/NSTWR/NSTWR.pdf)

data/documentation/site/_includes/reference/quickbooks_online/authentication/index.md

@@ -0,0 +1,55 @@
+---
+title: Authentication
+layout: reference_quickbooks_online
+ledger: quickbooks_online
+---
+
+### OAuth
+
+QuickBooks Online utilizes OAuth 2.0, which requires frequent refreshing of the access token.  The client will handle this automatically, attempting a single token refresh on any single request authentication failure.  Depending on how you use the library, every client has implements a class method `ledger_attributes_to_save`, which is an array of attributes that may change as the client 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`
+
+#### Ledger Helper Methods
+
+The client also implements some helper methods for getting tokens.  For example, you can set up an client 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::Ledgers::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'
+
+client = LedgerSync::Ledgers::QuickBooksOnline::Client.new_from_oauth_client_uri(
+  oauth_client: oauth_client,
+  uri: uri
+)
+
+# You can test that the auth works:
+
+client.refresh!
+```
+
+**Note: If you have a `.env` file storing your secrets, the client will automatically update the variables and record previous values whenever values change**

data/documentation/site/_includes/reference/quickbooks_online/errors/index.md

@@ -0,0 +1,9 @@
+---
+title: Errors
+layout: reference_quickbooks_online
+ledger: quickbooks_online
+---
+
+While LedgerSync tries to catch and translate errors, not all errors will be caught.  In these cases, you can resque a generic `LedgerSync::OperationError` and determine what to do based on the response body.
+
+[QuickBooks Online Error Documentation](https://developer.intuit.com/app/developer/qbo/docs/develop/troubleshooting/error-codes)

data/documentation/site/_includes/reference/quickbooks_online/index.md

@@ -0,0 +1,6 @@
+---
+title: QuickBooks Online
+layout: reference_quickbooks_online
+ledger: quickbooks_online
+---
+

data/documentation/site/_includes/reference/quickbooks_online/webhooks/index.md

@@ -0,0 +1,42 @@
+---
+title: Webhooks
+layout: reference_quickbooks_online
+ledger: quickbooks_online
+---
+
+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::Ledgers::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(client: your_quickbooks_client_instance) # The respective Find class
+    notification.find_operation(client: your_quickbooks_client_instance) # The initialized respective Find operation
+    notification.find(client: your_quickbooks_client_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
+```

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

@@ -0,0 +1,6 @@
+---
+title: Stripe
+layout: reference_stripe
+ledger: stripe
+---
+

data/documentation/site/_includes/section_content.html

@@ -0,0 +1,29 @@
+{% assign section = include.section %}
+<section id="{{ section.section_id }}" class="block block-text outer">
+    <div class="inner">
+        <div class="grid grid-middle grid-center{% if section.image and section.image_position == 'right' %} grid-swap{% endif %}">
+            {% assign image_is_not_empty = section.image | is_not_empty %} {% if image_is_not_empty %}
+            <div class="grid-item block-image">
+                <img src="{{ section.image | relative_url }}" alt="{{ section.title }}" />
+            </div>
+            {% endif %}
+            <div class="grid-item block-body">
+                {% assign title_is_not_empty = section.title | is_not_empty %} {% if title_is_not_empty %}
+                <div class="block-header">
+                    <h2 class="block-title">{{ section.title }}</h2>
+                </div>
+                {% endif %} {% assign content_is_not_empty = section.content | is_not_empty %} {% if content_is_not_empty %}
+                <div class="block-content">
+                    {{ section.content | markdownify }}
+                </div>
+                {% endif %} {% assign actions_is_not_empty = section.actions | is_not_empty %} {% if actions_is_not_empty %}
+                <div class="block-buttons">
+
+                    {% include cta_buttons.html actions=section.actions %}
+                </div>
+                {% endif %}
+            </div>
+        </div>
+    </div>
+</section>
+<!-- .block -->

data/documentation/site/_includes/section_cta.html

@@ -0,0 +1,24 @@
+{% assign section = include.section %}
+<section id="{{ section.section_id }}" class="block block-cta outer">
+    <div class="inner">
+        <div class="has-gradient">
+            <div class="grid grid-middle grid-center">
+                {% if section.title or section.subtitle %}
+                <div class="grid-item block-header">
+                    {% assign title_is_not_empty = section.title | is_not_empty %} {% if title_is_not_empty %}
+                    <h2 class="block-title">{{ section.title }}</h2>
+                    {% endif %} {% assign subtitle_is_not_empty = section.subtitle | is_not_empty %} {% if subtitle_is_not_empty %}
+                    <p class="block-subtitle">{{ section.subtitle }}</p>
+                    {% endif %}
+                </div>
+                {% endif %} {% assign actions_is_not_empty = section.actions | is_not_empty %} {% if actions_is_not_empty %}
+                <div class="grid-item block-buttons">
+
+                    {% include cta_buttons.html actions=section.actions %}
+                </div>
+                {% endif %}
+            </div>
+        </div>
+    </div>
+</section>
+<!-- .block -->

data/documentation/site/_includes/section_grid.html

@@ -0,0 +1,45 @@
+{% assign section = include.section %}
+<section id="{{ section.section_id }}" class="block block-grid outer{% if section.title or section.subtitle %} has-header{% endif %}">
+    <div class="inner">
+        {% if section.title or section.subtitle %}
+        <div class="block-header inner-sm">
+            {% assign title_is_not_empty = section.title | is_not_empty %} {% if title_is_not_empty %}
+            <h2 class="block-title">{{ section.title }}</h2>
+            {% endif %} {% assign subtitle_is_not_empty = section.subtitle | is_not_empty %} {% if subtitle_is_not_empty %}
+            <p class="block-subtitle">{{ section.subtitle }}</p>
+            {% endif %}
+        </div>
+        {% endif %} {% assign grid_items_is_not_empty = section.grid_items | is_not_empty %} {% if grid_items_is_not_empty %}
+        <div class="block-content">
+            <div class="grid{% if section.col_number == 'two' %} grid-col-2{% endif %}{% if section.col_number == 'three' %} grid-col-3{% endif %}">
+                {% for item in section.grid_items %}
+                <div class="grid-item">
+                    <div class="grid-item-inside">
+                        {% assign image_is_not_empty = item.image | is_not_empty %} {% if image_is_not_empty %}
+                        <div class="grid-item-image">
+                            <img src="{{ item.image | relative_url }}" alt="{{ item.title }}" />
+                        </div>
+                        {% endif %} {% assign title_is_not_empty = item.title | is_not_empty %} {% if title_is_not_empty %}
+                        <h3 class="grid-item-title line-left">
+                            {% assign title_url_is_not_empty = item.title_url | is_not_empty %} {% if title_url_is_not_empty %}
+                            <a href="{{ item.title_url | relative_url }}">{{ item.title }}</a> {% else %} {{ item.title }} {% endif %}
+                        </h3>
+                        {% endif %} {% assign content_is_not_empty = item.content | is_not_empty %} {% if content_is_not_empty %}
+                        <div class="grid-item-content">
+                            {{ item.content | markdownify }}
+                        </div>
+                        {% endif %} {% assign actions_is_not_empty = item.actions | is_not_empty %} {% if actions_is_not_empty %}
+                        <div class="grid-item-buttons">
+
+                            {% include cta_buttons.html actions=item.actions %}
+                        </div>
+                        {% endif %}
+                    </div>
+                </div>
+                {% endfor %}
+            </div>
+        </div>
+        {% endif %}
+    </div>
+</section>
+<!-- .block -->

data/documentation/site/_includes/section_guides.html

@@ -0,0 +1,35 @@
+{% assign section = include.section %}
+<section id="{{ section.section_id }}" class="block block-grid outer{% if section.title or section.subtitle %} has-header{% endif %}">
+    <div class="inner">
+        {% if section.title or section.subtitle %}
+        <div class="block-header inner-sm">
+            {% assign title_is_not_empty = section.title | is_not_empty %} {% if title_is_not_empty %}
+            <h2 class="block-title">{{ section.title }}</h2>
+            {% endif %} {% assign subtitle_is_not_empty = section.subtitle | is_not_empty %} {% if subtitle_is_not_empty %}
+            <p class="block-subtitle">{{ section.subtitle }}</p>
+            {% endif %}
+        </div>
+        {% endif %}
+        <div class="block-content">
+            <div class="grid{% if section.col_number == 'two' %} grid-col-2{% endif %}{% if section.col_number == 'three' %} grid-col-3{% endif %}">
+                {% for doc_section in site.data.guides_sections.sections %} {% assign doc_section_folder = site.data.guides_sections.root_folder | append: doc_section %} {% assign doc_section_page_path = doc_section_folder | append: '/index.md' %} {% assign doc_section_page
+                = doc_section_page_path | get_page %}
+                <div class="grid-item">
+                    <div class="grid-item-inside">
+                        <h3 class="grid-item-title line-left"><a href="{{ doc_section_page.url | relative_url }}">{{ doc_section_page.title }}</a></h3>
+                        {% assign excerpt_is_not_empty = doc_section_page.excerpt | is_not_empty %} {% if excerpt_is_not_empty %}
+                        <div class="grid-item-content">
+                            <p>{{ doc_section_page.excerpt }}</p>
+                        </div>
+                        {% endif %}
+                        <div class="grid-item-buttons">
+                            <a href="{{ doc_section_page.url | relative_url }}">Learn More</a>
+                        </div>
+                    </div>
+                </div>
+                {% endfor %}
+            </div>
+        </div>
+    </div>
+</section>
+<!-- .block -->

data/documentation/site/_includes/section_hero.html

@@ -0,0 +1,23 @@
+{% assign section = include.section %}
+<section id="{{ section.section_id }}" class="block block-hero has-gradient outer">
+    {% assign image_is_not_empty = section.image | is_not_empty %} {% if image_is_not_empty %}
+    <div class="bg-img" style="background-image: url('{{ section.image | relative_url }}')"></div>
+    {% endif %}
+    <div class="inner-sm">
+        {% assign title_is_not_empty = section.title | is_not_empty %} {% if title_is_not_empty %}
+        <div class="block-header">
+            <h1 class="block-title">{{ section.title }}</h1>
+        </div>
+        {% endif %} {% assign content_is_not_empty = section.content | is_not_empty %} {% if content_is_not_empty %}
+        <div class="block-content">
+            {{ section.content | markdownify }}
+        </div>
+        {% endif %} {% assign actions_is_not_empty = section.actions | is_not_empty %} {% if actions_is_not_empty %}
+        <div class="block-buttons">
+
+            {% include cta_buttons.html actions=section.actions %}
+        </div>
+        {% endif %}
+    </div>
+</section>
+<!-- .block -->

data/documentation/site/_includes/submenu.html

@@ -0,0 +1,7 @@
+<ul class="{{ include.menu_class }}">
+    {% for action in include.submenu %}
+    <li class="menu-item{% if include.page.url == action.url %} current{% endif %}{% if action.type != 'link' %} menu-button{% endif %}">
+        {% include action_link.html action=action %}
+    </li>
+    {% endfor %}
+</ul>

data/documentation/site/_layouts/advanced.html

@@ -0,0 +1,8 @@
+---
+layout: body
+---
+
+{% for section in page.sections %}
+  {% assign component = section.type | append: ".html" %}
+  {% include {{ component }} section=section site=site %}
+{% endfor %}

data/documentation/site/_layouts/base.html

@@ -0,0 +1,34 @@
+<!doctype html>
+<html lang="en">
+
+<head>
+
+    <title>LedgerSync - {% assign title_is_not_empty = page.title | is_not_empty %}{% if title_is_not_empty %}{{ page.title }} - {% endif %}{{ site.title }}</title>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <meta name="description" content="{{ page.excerpt | default: site.description }}" />
+    <link href="https://fonts.googleapis.com/css?family=Lato:400,400i,700,700i%26display=swap" rel="stylesheet">
+    <link rel="stylesheet" href="{{ 'assets/css/main.css' | relative_url }}">
+
+    <!-- Global site tag (gtag.js) - Google Analytics -->
+    <script async src="https://www.googletagmanager.com/gtag/js?id=UA-152343827-1"></script>
+    <script>
+        window.dataLayer = window.dataLayer || [];
+        function gtag(){dataLayer.push(arguments);}
+        gtag('js', new Date());
+
+        gtag('config', 'UA-152343827-1');
+    </script>
+
+</head>
+
+<body>
+
+    {{ content }}
+    <!-- Scripts -->
+    <script src="{{ 'assets/js/plugins.js' | relative_url }}"></script>
+    <script src="{{ 'assets/js/prism.js' | relative_url }}" data-manual></script>
+    <script src="{{ 'assets/js/main.js' | relative_url }}"></script>
+</body>
+
+</html>

data/documentation/site/_layouts/blog.html

@@ -0,0 +1,51 @@
+---
+layout: body
+---
+
+  <header class="page-header has-gradient outer">
+    {% assign image_is_not_empty = page.image | is_not_empty %}
+    {% if image_is_not_empty %}
+    <div class="bg-img" style="background-image: url('{{ page.image | relative_url }}')"></div>
+    {% endif %}
+    <div class="inner-sm">
+      <h1 class="page-title">{{ page.title }}</h1>
+      {% assign subtitle_is_not_empty = page.subtitle | is_not_empty %}
+      {% if subtitle_is_not_empty %}
+      <p class="page-subtitle">{{ page.subtitle }}</p>
+      {% endif %}
+    </div>
+  </header><!--.page-header -->
+
+  <div class="inner-md outer">
+    <div class="post-feed">
+      {% assign display_posts = '/posts' | get_pages | sort: 'date' | reverse %}
+      {% for post in display_posts %}
+      <article class="post">
+        {% assign thumb_image_is_not_empty = post.thumb_image | is_not_empty %}
+        {% if thumb_image_is_not_empty %}
+        <a class="post-thumbnail" href="{{ post.url | relative_url }}"><img src="{{ post.thumb_image | relative_url }}" alt="{{ post.title }}" /></a>
+        {% endif %}
+        <header class="post-header">
+          <div class="post-meta">
+            <time class="published" datetime="{{ post.date | date: '%Y-%m-%d %H:%M' }}">{{ post.date | date: '%B %d, %Y' }}</time>
+          </div>
+          <h2 class="post-title line-left"><a href="{{ post.url | relative_url }}" rel="bookmark">{{ post.title }}</a></h2>
+        </header>
+        {% assign excerpt_is_not_empty = post.excerpt | is_not_empty %}
+        {% if excerpt_is_not_empty %}
+        <p class="post-excerpt">{{ post.excerpt }}</p>
+        <p class="read-more"><a href="{{ post.url | relative_url }}" class="read-more-link">Read More</a></p>
+        {% endif %}
+      </article><!-- .post -->
+    {% endfor %}
+    </div><!-- .post-feed -->
+
+    <!-- Pagination TBD -->
+    <!--
+    <nav class="pagination">
+      <a class="newer-posts" href="#">Newer</a>
+      <a class="older-posts" href="#">Older</a>
+    </nav>
+    -->
+
+  </div><!-- .inner-md -->