ledger_sync 1.3.2 → 1.4.1

data/documentation/site/README.md

@@ -0,0 +1,8 @@
+# LedgerSync Documentation
+
+## Run locally
+
+```
+bundle install
+bundle exec jekyll serve
+```

data/documentation/site/_config.yml

@@ -0,0 +1,119 @@
+---
+title: LedgerSync
+baseurl: "/"
+permalink: "/:title/"
+github_url: https://www.github.com/LedgerSync/ledger_sync
+slack_url: https://join.slack.com/t/ledger-sync/shared_invite/zt-e5nbl8qc-eOA~5k7bg3p16_l3J7OS~Q
+modern_treasury_url: https://www.moderntreasury.com
+collections:
+  posts:
+    permalink: "/posts/:title/"
+description: An open-source library for easily syncing with accounting software, general
+  ledgers, ERPs, and other ledgers.
+palette: green
+palettes:
+  blue:
+    sass:
+      accent1: "#00c6ff"
+      accent2: "#0072ff"
+  green:
+    sass:
+      accent1: "#12db5d"
+      accent2: "#11998e"
+  navy:
+    sass:
+      accent1: "#004e92"
+      accent2: "#000428"
+  violet:
+    sass:
+      accent1: "#8e2de2"
+      accent2: "#4a00e0"
+header:
+  title: LedgerSync
+  logo_img: images/logo.svg
+  has_nav: true
+  nav_links:
+  - label: Home
+    url: "/"
+    type: link
+    has_subnav: false
+  - label: Guides
+    url: "/guides/"
+    type: link
+    has_subnav: false
+  - label: Reference
+    url: "/reference"
+    type: link
+    has_subnav: true
+    subnav_links:
+    - label: NetSuite REST
+      url: reference/netsuite
+      type: link
+    - label: NetSuite SOAP
+      url: reference/netsuite_soap
+      type: link
+    - label: QuickBooks Online
+      url: reference/quickbooks_online
+      type: link
+    - label: Stripe
+      url: reference/stripe
+      type: link
+  - label: Blog
+    url: "/blog"
+    type: link
+    has_subnav: false
+  - label: Contribute
+    url: "/guides/contribute"
+    type: link
+    has_subnav: false
+  - label: GitHub
+    url: https://github.com/LedgerSync/ledger_sync
+    type: primary
+    has_subnav: false
+footer:
+  content: "© Modern Treasury Inc. All rights reserved."
+  links:
+  - label: Maintained with ❤️ in San Francisco, CA by Modern Treasury
+    url: https://www.moderntreasury.com
+    type: link
+    new_window: true
+  has_social: true
+  social_links:
+  - label: Netlify
+    url: https://www.netlify.com
+    type: svg
+    svg_url: https://www.netlify.com/img/global/badges/netlify-dark.svg
+    svg_alt: Deploys by Netlify
+    new_window: true
+  - label: Twitter
+    url: https://twitter.com/ModernTreasury
+    type: icon
+    icon_class: fa-twitter
+    new_window: true
+  - label: LinkedIn
+    url: https://www.linkedin.com/company/modern-treasury
+    type: icon
+    icon_class: fa-linkedin
+    new_window: true
+  - label: GitHub
+    url: https://github.com/LedgerSync/ledger_sync
+    type: icon
+    icon_class: fa-github
+    new_window: true
+sass:
+  indentWidth: 4
+  style: nested
+  precision: 10
+plugins:
+- jekyll-menus
+exclude:
+- Gemfile
+- Gemfile.lock
+- node_modules
+- vendor/bundle/
+- vendor/cache/
+- vendor/gems/
+- vendor/ruby/
+- ssg-build.sh
+- LICENSE.md
+- README.md

data/documentation/site/_data/guides_sections.yml

@@ -0,0 +1,10 @@
+root_folder: /guides/
+sections:
+  - getting-started
+  - architecture
+  - ledgers
+  - customization
+  - tips_and_more
+  - contribute
+  - community
+  - modern-treasury

data/documentation/site/_data/reference_sections.yml

@@ -0,0 +1,5 @@
+root_folder: /reference/
+sections:
+  - authentication
+  - helpers
+  - resources

data/documentation/site/_includes/action_link.html

@@ -0,0 +1,11 @@
+{% assign action = include.action %}
+<a class="{% if action.type != 'link' and action.type != 'svg' %}button{% endif %}{% if action.type == 'secondary' %} button-secondary{% endif %}{% if action.type == 'icon' %} button-icon{% endif %}" href="{{ action.url | relative_url }}" {% assign new_window_is_not_empty=action.new_window
+    | is_not_empty %}{% if new_window_is_not_empty %} target="_blank" rel="noopener" {% endif %}>
+  {% if action.type == 'icon' and action.icon_class %}
+  <span class="icon fab {{ action.icon_class }}" aria-hidden="true"></span><span class="screen-reader-text">{{ action.label }}</span>
+  {% elsif action.type == 'svg' and action.svg_url %}
+    <img src="{{ action.svg_url }}" alt="{{ action.svg_alt }}" />
+  {% else %}
+  {{ action.label }}
+  {% endif %}
+</a>

data/documentation/site/_includes/alerts/base.html

@@ -0,0 +1,3 @@
+<div class="alert {{ include.type }}">
+    <strong>{{ include.title }}</strong> {{ include.content }}
+</div>

data/documentation/site/_includes/alerts/danger.html

@@ -0,0 +1 @@
+{% include alerts/base.html content=include.content type="danger" title=include.title %}

data/documentation/site/_includes/alerts/info.html

@@ -0,0 +1 @@
+{% include alerts/base.html content=include.content type="info" title=include.title %}

data/documentation/site/_includes/alerts/success.html

@@ -0,0 +1 @@
+{% include alerts/base.html content=include.content type="success" title=include.title %}

data/documentation/site/_includes/alerts/warning.html

@@ -0,0 +1 @@
+{% include alerts/base.html content=include.content type="warning" title=include.title %}

data/documentation/site/_includes/cta_buttons.html

@@ -0,0 +1,4 @@
+{% assign actions = include.actions %}
+{% for action in actions %}
+<a class="{% if action.type == 'primary' or action.type == 'secondary' %}button{% endif %}{% if action.type == 'secondary' %} button-secondary{% endif %}" href="{{ action.url | relative_url }}" {% assign new_window_is_not_empty = action.new_window | is_not_empty %}{% if new_window_is_not_empty %}target="_blank" rel="noopener"{% endif %}>{{ action.label }}</a>
+{% endfor %}

data/documentation/site/_includes/example.md

@@ -0,0 +1,8 @@
+{::options parse_block_html="true" /}
+<div class="example-container">
+  <div class="content">{{ include.content }}</div>
+  {% if include.result %}
+    {{ include.result }}
+  {% endif %}
+</div>
+{::options parse_block_html="false" /}

data/documentation/site/_includes/footer.html

@@ -0,0 +1,20 @@
+<footer id="colophon" class="site-footer outer">
+    <div class="inner">
+        <div class="site-footer-inside">
+            <p class="site-info">
+                {% assign content_is_not_empty = site.footer.content | is_not_empty %} {% if content_is_not_empty %}
+                <span class="copyright">{{ site.footer.content }}</span> {% endif %} {% for action in site.footer.links %} {% include action_link.html action=action %} {% endfor %}
+            </p>
+            <!-- .site-info -->
+            {% assign has_social_is_not_empty = site.footer.has_social | is_not_empty %} {% if has_social_is_not_empty %}
+            <div class="social-links">
+                {% for action in site.footer.social_links %} {% include action_link.html action=action %} {% endfor %}
+            </div>
+            <!-- .social-links -->
+            {% endif %}
+        </div>
+        <!-- .site-footer-inside -->
+    </div>
+    <!-- .inner -->
+</footer>
+<!-- .site-footer -->

data/documentation/site/_includes/getting_help.md

@@ -0,0 +1,8 @@
+There is a group of passionate maintainers happy to help you get started with LedgerSync.  There are two main
+channels for discussing LedgerSync: [Github]({{ site.github_url }}) and
+[Slack]({{ site.slack_url }}).
+
+## Report a bug
+
+Please [open an issue on Github]({{ site.github_url }}/issues/new) to report any bugs.  Please check if the bug
+has previously been reported and comment on the open issue with your use case.

data/documentation/site/_includes/guides_menu.html

@@ -0,0 +1,29 @@
+<nav id="guides-nav" class="guides-nav">
+    <div id="guides-nav-inside" class="guides-nav-inside sticky">
+        <button id="guides-nav-toggle" class="guides-nav-toggle">Navigate<span class="icon-angle-right" aria-hidden="true"></span></button>
+        <div class="guides-toc-wrap">
+            <ul id="guides-toc" class="guides-toc">
+                {% assign site = include.site %} {% assign page = include.page %} {% assign root_page_path = include.root_folder | append: 'index.md' %} {% assign root_page = root_page_path | get_page %}
+                <li class="toc-item{% if page.path == root_page.path %} current{% endif %}">
+                    <a href="{{ root_page.url | relative_url }}">{{ root_page.title }}</a>
+                </li>
+
+                {% for section in include.sections %} {% assign section_folder = include.root_folder | append: section %} {% assign section_page_path = section_folder | append: '/index.md' %} {% assign section_page = section_page_path | get_page %} {% assign child_pages
+                = section_folder | get_pages | where_exp: "item", "item.basename != 'index.md'" | sort: 'weight' %} {% assign child_count = child_pages | size %} {% if child_count > 0 %} {% assign has_children = true %}{% else %} {% assign has_children
+                = false %}{% endif %} {% if page.path == section_page.path %} {% assign is_current_page = true %}{% else %} {% assign is_current_page = false %}{% endif %} {% if page.rel_dir == section_page.rel_dir or page.path == section_page.path %}
+                {% assign is_active = true %}{% else %} {% assign is_active = false %}{% endif %}
+                <li class="toc-item{% assign has_children_is_not_empty = has_children | is_not_empty %}{% if has_children_is_not_empty %} has-children{% endif %}{% assign is_current_page_is_not_empty = is_current_page | is_not_empty %}{% if is_current_page_is_not_empty %} current{% endif %}{% assign is_active_is_not_empty = is_active | is_not_empty %}{% if is_active_is_not_empty %} active{% endif %}">
+                    <a href="{{ section_page.url | relative_url }}">{{ section_page.title }}</a> {% assign has_children_is_not_empty = has_children | is_not_empty %} {% if has_children_is_not_empty %}
+                    <button class="submenu-toggle"><span class="screen-reader-text">Submenu</span><span class="icon-angle-right" aria-hidden="true"></span></button> {% include guides_submenu.html child_pages=child_pages page=page site=site %} {% endif
+                    %}
+                </li>
+                {% endfor %}
+
+            </ul>
+            <!-- .guides-toc -->
+        </div>
+        <!-- .guides-toc-wrap -->
+    </div>
+    <!-- .guides-nav-inside -->
+</nav>
+<!-- .guides-nav -->

data/documentation/site/_includes/guides_submenu.html

@@ -0,0 +1,7 @@
+<ul class="toc-submenu">
+{% for child_page in include.child_pages %}
+  <li class="toc-item{% if include.page.path == child_page.path %} current{% endif %}">
+    <a href="{{ child_page.url | relative_url }}">{{ child_page.title }}</a>
+  </li>
+{% endfor %}
+</ul>

data/documentation/site/_includes/header.html

@@ -0,0 +1,35 @@
+<header id="masthead" class="site-header outer">
+  <div class="inner">
+    <div class="site-header-inside">
+      <div class="site-branding">
+        {% assign logo_img_is_not_empty = site.header.logo_img | is_not_empty %}
+        {% if logo_img_is_not_empty %}
+        <p class="site-logo"><a href="{{ site.header.url | default: '/' | relative_url }}"><img src="{{ site.header.logo_img | relative_url }}" alt="{{ site.header.title }}" /></a></p>
+        {% else %}
+        <p class="site-title"><a href="{{ site.header.url | default: '/' | relative_url }}">{{ site.header.title }}</a></p>
+        {% endif %}
+      </div><!-- .site-branding -->
+      {% assign has_nav_is_not_empty = site.header.has_nav | is_not_empty %}
+      {% if has_nav_is_not_empty %}
+      <nav id="main-navigation" class="site-navigation" aria-label="Main Navigation">
+        <div class="site-nav-inside">
+          <button id="menu-close" class="menu-toggle"><span class="screen-reader-text">Open Menu</span><span class="icon-close" aria-hidden="true"></span></button>
+          <ul class="menu">
+            {% for action in site.header.nav_links %}
+            <li class="menu-item{% if action.has_subnav and action.subnav_links %} has-children{% endif %}{% if page.url == action.url %} current{% endif %}{% if action.type != 'link' %} menu-button{% endif %}">
+              
+              {% include action_link.html action=action %}
+              {% if action.has_subnav and action.subnav_links %}
+                
+                {% include submenu.html submenu=action.subnav_links menu_class='submenu' page=page %}
+              {% endif %}
+            </li>
+            {% endfor %}
+          </ul>
+        </div><!-- .site-nav-inside -->
+      </nav><!-- .site-navigation -->
+      <button id="menu-open" class="menu-toggle"><span class="screen-reader-text">Close Menu</span><span class="icon-menu" aria-hidden="true"></span></button>
+      {% endif %}
+    </div><!-- .site-header-inside -->
+  </div><!-- .inner -->
+</header><!-- .site-header -->

data/documentation/site/_includes/installation_instructions.md

@@ -0,0 +1,17 @@
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ledger_sync'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install ledger_sync
+```

data/documentation/site/_includes/ledgers/Stripe_summary.md

@@ -0,0 +1 @@
+QuickBooks Online

data/documentation/site/_includes/ledgers/netsuite_soap_summary.md

@@ -0,0 +1 @@
+{% include ledgers/netsuite_summary_shared.md page=page site=site %}

data/documentation/site/_includes/ledgers/netsuite_summary.md

@@ -0,0 +1 @@
+{% include ledgers/netsuite_summary_shared.md page=page site=site %}

data/documentation/site/_includes/ledgers/netsuite_summary_shared.md

@@ -0,0 +1 @@
+NetSuite is an enterprise ERP, providing highly scalable and felxible bookkeeping and accounting software.

data/documentation/site/_includes/ledgers/quickbooks_online_summary.md

@@ -0,0 +1 @@
+QuickBooks Online

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

@@ -0,0 +1,99 @@
+## Overview
+
+In order to authenticate to NetSuite, you need the following:
+
+- `account_id`
+- `consumer_key`
+- `consumer_secret`
+- `token_id`
+- `token_secret`
+
+We will walk through how to get each value in the following sections.
+
+<div class="note"><strong>Note:</strong>
+You need to have sufficient permissions to set up your account for API authentication.
+</div>
+
+## Prerequisites
+
+### REST Web Services feature
+
+Enable the feature at Setup > Company > Setup Tasks > Enable Features, in the SuiteTalk (Web Services) section, on the SuiteCloud subtab. To use the feature, you must accept the SuiteCloud Terms of Service.
+
+### SuiteAnalytics Workbook feature
+
+Enable the feature at Setup > Company > Setup Tasks > Enable Features, on the Analytics subtab.
+
+### Permissions
+
+You will require the following permissions:
+
+- REST Web Services
+- Log in using Access Tokens
+- SuiteAnalytics Workbook
+
+Your permissions vary based on which role you are assigned.  You can edit roles in Setup > Users/Roles > User Management > Manage Roles.  Ensure your user is assigned a role with the aforementioned permissions in order to complete the setup.
+
+<div class="note"><strong>Note:</strong>
+<p>
+  There are two different sets of permissions you will need:
+</p>
+<p>
+  <ul>
+    <li>The permissions mentioned above are to <strong>set up</strong> your integration.</li>
+    <li>Later when creating a token, you will need to assign a user with a role that has the necessary permissions to <strong>access records</strong> (e.g. payments, invoices, bills, etc.)</li>
+  </ul>
+</p>
+
+<p>
+These can be the same or different roles.  They can be assigned to one or many users.
+</p>
+</div>
+
+## Account ID
+
+The `account_id` can be found in the URL when you are logged into the NetSuite dashboard in your browser.  It will look
+something like the following:
+
+```
+https://<account_id>.app.netsuite.com/app/center/card.nl?sc=-29&whence=
+```
+
+Example:
+
+```
+https://123456.app.netsuite.com/app/center/card.nl?sc=-29&whence=
+```
+
+The Account ID precedes `.app.netsuite.com`, which in this case is `123456`.  Note that your ID may include `-sb1`
+(representing "Sandbox 1").  Be sure to include the entire ID as it appears in the URL, including any letters, numbers,
+and hyphens.
+
+## Consumer Keys
+
+The consumer keys are retrieved when you [create an Integration record](https://system.netsuite.com/app/help/helpcenter.nl?fid=bridgehead_4249032125.html&whence=).  You can view [the NetSuite documentation](https://system.netsuite.com/app/help/helpcenter.nl?fid=bridgehead_4249032125.html&whence=) for the official documentation.
+
+At the last step of creating an Integration record, save the consumer key and consumer secret.  They will not be shown again once you navigate away from the page.
+
+## Token
+
+To obtain your `token_key` and `token_secret`, you will need to [create a Token](https://system.netsuite.com/app/help/helpcenter.nl?fid=bridgehead_4254081947.html).  View [the NetSuite documentation](https://system.netsuite.com/app/help/helpcenter.nl?fid=bridgehead_4254081947.html) for the official documentation.
+
+You will use the integration record you created along with your user (or the user who has the necessary permissions to access records).
+
+At the last step, save the token key and token secret.
+
+## Conclusion
+
+Now with these values, you can successfully authenticate to NetSuite.  Simply pass the values into the client:
+
+{% highlight ruby linenos %}
+client = LedgerSync::Ledgers::QuickBooksOnline::Client.new(
+  account_id: account_id,
+  consumer_key: consumer_key,
+  consumer_secret: consumer_secret,
+  token_id: token_id,
+  token_secret: token_secret
+)
+{% endhighlight %}
+

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.