sagekit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf9a2ad3103e00fb5a7c70db398b14b693da3458a3dd826f01ca453d37753cc2
+  data.tar.gz: 8bc67fc26a566568542d8675741a4593942014f3e2872e4f34f79cf2bb3bce7d
+SHA512:
+  metadata.gz: adf9a8f1aed9563904da68f88238e9349ffe712b60d767661701e10206795037db32060d8c0e3784816c1bf6326549a9c871a53f3dab8babf4e75fa4e72dbf3a
+  data.tar.gz: 9fb19570edd2aacbd78189a4f62589c357bd0afa70ed7ef955eb6dcf2955752d4c57cb23813dd5d48c7ea2adb1c64846779e6b1534be014029c7da27ebdfb879

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 (2021-09-30)
+
+- First release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at jose.perez@vertilux.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sagekit.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "irb"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Jose Perez
+
+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.

data/README.org

@@ -0,0 +1,346 @@
+#+TITLE: Sagekit
+#+AUTHOR: Jose Perez
+#+EMAIL: jose.perez@vertilux.com
+#+EXPORT_FILE_NAME: ./docs/index.html
+#+SETUPFILE: https://fniessen.github.io/org-html-themes/org/theme-readtheorg.setup
+#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style.css">
+#+OPTIONS: num:nil
+
+Sagekit is a ruby gem client library to talk with Sage300 API.
+
+The gem maps as closely as possible to the Sage300 API so you can easily convert API examples to gem code.
+Responses are created as objects like. They're built using OpenStruct so you can easily access data in a Ruby-ish way.
+
+The Sage 300 Web API makes it easier to create services that integrate with Sage 300 data and business logic. The Web API improves on existing tools for third-party integrations without requiring in-depth understanding of the Sage 300 View protocol and components.
+
+** Installation
+
+Add this line to your application's Gemfile:
+
+#+begin_src ruby
+gem 'sagekit'
+#+end_src
+
+And then execute:
+
+#+begin_src bash
+$ bundle install
+#+end_src
+
+Or install it yourself as:
+
+#+begin_src bash
+$ gem install sagekit
+#+end_src
+
+** Usage
+
+Make sure you have Sage300 web services up and runing. Web service is an easy way to communicate with 3rd party application without hampering the existing system & this is the reason we will always suggest to go for web service integration, whenever any customer requires integration.
+
+Initialize client to make requets:
+
+#+begin_src ruby
+require 'sagekit'
+client = Sagekit::Client.new(URL, AUTH)
+client.sales_orders.list(COMPANY, '$top':10)
+#+end_src
+
+Make sure to change:
+- URL with the web serive url
+  Example: ~http://localhost/Sage300WebApi/v1.0/-/SAMLTD/AR/ARCustomers~
+
+  | Component  | Description                                   | Example                 |
+  |------------+-----------------------------------------------+-------------------------|
+  | {protocol} | The application protocol enabled in IIS setup | http, https             |
+  | {host}     | The path to the Web API                       | localhost/Sage300WebApi |
+  | {version}  | The API version                               | v1.0                    |
+  | {company}  | The org ID of the company being requested     | SAMLTD                  |
+  | {module}   | SAge300 application module                    | AR, AP, GL, IC          |
+  | {resource} | The resource entity being requested           | APVendors, ARCustomers  |
+
+  ~{company}~ needs to be pass by the request, ~module~ and ~resource~ the gem will take car of.
+
+- AUTH with the Basic authentication key, Example:
+#+begin_src
+Authorization: Basic QURNSU46QURNSU4=
+(constructed for user "ADMIN" and password "ADMIN")
+#+end_src
+
+- COMPANY with teh company id
+
+** Resources
+
+The simplest way to retrieve records of a particular resource is to call a GET (list object).
+
+#+begin_src ruby
+client.sales_orders.list('COMPANY')
+#+end_src
+
+Currently the maximum number of records that can be returned for a single GET request is 100. In order to retrieve records beyond the first 100 or find records based on a given set of criteria, the use of query options is required.
+
+To reduce the number of requests necessary for transferring large datasets, the maximum page size can be adjusted from the default value of 100 records per request.
+
+*** Query options
+
+| Component       | Example                             |
+|-----------------+-------------------------------------|
+| {query-options} | $skip:100                           |
+|                 | $filer:"CustomerNumber eq 'LEPEPE'" |
+|                 | $select                             |
+|                 | $top:5                              |
+|                 | $count:true                         |
+
+- ~$skip~
+
+    The =$skip= query option must be a positive integer N that specifies the records beyond which the response feed should start with, effectively skipping N records. This is typically used to retrieve records beyond the top 100, the default maximum limit of a single response page.
+
+   #+begin_src ruby
+    client.sales_orders.list('COMPANY', '$skip':5)
+   #+end_src
+
+- ~$top~
+
+    The =$top= query option must a positive integer N that specifies the maximum number of records the response feed could contain, effectively selecting the first N records.
+
+   #+begin_src ruby
+    client.sales_orders.list('COMPANY', '$top':2)
+   #+end_src
+
+- ~$count~
+
+    The =$count= query option specifies whether a count of all records will be returned as part of the response feed, regardless of how many records are actually returned in the response.
+
+- ~$filter~
+
+    The =$filter= query option specifies a set of criteria that records must satisfy before being returned, effectively allowing the caller to retrieve a subset of the resource collection based on a specified filter.
+    Expressions can reference properties as well as literals. Literal values can be strings enclosed in single quotes, dates, numbers, and boolean values.
+    The following is a list of the operators that are supported in the Sage 300 Web API:
+
+   | Operator | Description           | Example                                                      |
+   |----------+-----------------------+--------------------------------------------------------------|
+   | eq       | equal                 | '$filter':"City eq 'Miami'"                                  |
+   | ne       | not equal             | '$filter':"City ne 'Miami'"                                  |
+   | gt       | greater than          | '$filter':"NumberOfDaysToPay" gt 30"                         |
+   | lt       | less than             | '$filter':"AccountPastDue" lt 90"                            |
+   | le       | less than or equal to | '$filter':"DateLastMaintained le datetime'2015-12-31T12:00'" |
+   | and      | and                   | '$filter':"GroupCode eq 'EXPORT' and OnHold eq 'No’"         |
+   | or       | or                    | '$filter':"City eq 'Los Angeles' or City eq 'Miami'"         |
+
+*Combining query options*
+
+#+begin_src ruby
+client.customers.list('COMPANY', '$filter':"CustomerNumber eq '112321' and OrderType eq 'Active'", '$skip':5, '$top':2)
+#+end_src
+
+*** Account Receivable (AR)
+
+**** Customers
+
+#+begin_src ruby
+client.customers.list('COMPANY')
+client.customers.retreive('COMPANY', 'IDCUST')
+client.customers.create('COMPANY', {})
+client.customers.update('COMPANY', {})
+client.customers.delete('COMPANY', 'IDCUST')
+#+end_src
+
+**** Customer Groups
+
+#+begin_src ruby
+client.customer_groups.list('COMPANY')
+client.customer_groups.retreive('COMPANY', 'GROUPCODE')
+client.customer_groups.create('COMPANY', {})
+client.customer_groups.update('COMPANY', {})
+client.customer_groups.delete('COMPANY', 'GROUPCODE')
+#+end_src
+
+**** Customer Terms
+
+#+begin_src ruby
+client.customer_terms.list('COMPANY')
+client.customer_terms.retreive('COMPANY', 'TERMSCODE')
+client.customer_terms.create('COMPANY', {})
+client.customer_terms.update('COMPANY', {})
+client.customer_terms.delete('COMPANY', 'TERMSCODE')
+#+end_src
+
+**** Sales Persons
+
+#+begin_src ruby
+client.sales_persons.list('COMPANY')
+client.sales_persons.retreive('COMPANY', 'KEY')
+client.sales_persons.create('COMPANY', {})
+client.sales_persons.update('COMPANY', {})
+client.sales_persons.delete('COMPANY', 'KEY')
+client.sales_persons.statistics('COMPANY')
+client.sales_persons.filter_stats('COMPANY', 'SALESPERSON', 'YEAR', 'PERIDO')
+#+end_src
+
+**** Account Sets
+
+#+begin_src ruby
+client.account_sets.list('COMPANY')
+client.account_sets.retreive('COMPANY', 'KEY')
+client.account_sets.create('COMPANY', {})
+client.account_sets.update('COMPANY', {})
+client.account_sets.delete('COMPANY', 'KEY')
+#+end_src
+
+*** Account Payable (AP)
+
+**** Vendors
+
+#+begin_src ruby
+client.vendors.list('COMPANY')
+client.vendors.retreive('COMPANY', 'VENDCODE')
+client.vendors.create('COMPANY', {})
+client.vendors.update('COMPANY', {})
+client.vendors.delete('COMPANY', 'NUMBER')
+client.vendors.statistics('COMPANY', 'VENDCODE')
+#+end_src
+
+**** Vendor Groups
+
+#+begin_src ruby
+client.vendor_groups.list('COMPANY')
+client.vendor_groups.retreive('COMPANY', 'GROUPCODE')
+client.vendor_groups.create('COMPANY', {})
+client.vendor_groups.update('COMPANY', {})
+client.vendor_groups.delete('COMPANY', 'GROUPCODE')
+#+end_src
+
+**** Vendor Terms
+
+#+begin_src ruby
+client.vendor_terms.list('COMPANY')
+client.vendor_terms.retreive('COMPANY', 'TERMSCODE')
+client.vendor_terms.create('COMPANY', {})
+client.vendor_terms.update('COMPANY', {})
+client.vendor_terms.delete('COMPANY', 'TERMSCODE')
+#+end_src
+
+*** Invenotry Control (IC)
+
+**** Items
+
+#+begin_src ruby
+client.items.list('COMPANY')
+client.items.retreive('COMPANY', 'ITEMNO')
+client.items.create('COMPANY', {})
+client.items.update('COMPANY', {})
+client.items.delete('COMPANY', 'ITEMNO')
+#+end_src
+
+**** Categories
+
+#+begin_src ruby
+client.categories.list('COMPANY')
+client.categories.retreive('COMPANY', 'CATEGORYCODE')
+client.categories.create('COMPANY', {})
+client.categories.update('COMPANY', {})
+client.categories.delete('COMPANY', 'CATEGORYCODE')
+#+end_src
+
+**** Locations
+
+#+begin_src ruby
+client.locations.list('COMPANY')
+client.locations.retreive('COMPANY', 'LOCATION')
+client.locations.create('COMPANY', {})
+client.locations.update('COMPANY', {})
+client.locations.delete('COMPANY', 'LOCATION')
+#+end_src
+
+*** Order Entry (OE)
+
+**** Sales Orders
+
+#+begin_src ruby
+client.sales_orders.list('COMPANY')
+client.sales_orders.retreive('COMPANY', 'ORDERID')
+client.sales_orders.create('COMPANY', {})
+#+end_src
+
+**** Invoices
+
+#+begin_src ruby
+client.invoices.list('COMPANY')
+client.invoices.retreive('COMPANY', 'INVUNIQ')
+#+end_src
+
+**** Sales History
+
+#+begin_src ruby
+client.sales_history.list('COMPANY', {})
+client.sales_history.details('COMPANY', {})
+client.sales_history.stats('COMPANY', {})
+#+end_src
+
+**** Credit Notes
+
+#+begin_src ruby
+client.credit_notes.list('COMPANY', {})
+client.credit_notes.retreive('COMPANY', 'CNUNIQ')
+client.credit_notes.create('COMPANY', {})
+#+end_src
+
+*** Purchase Orders (PO)
+
+**** Purchase Orders
+
+#+begin_src ruby
+client.purchase_orders.list('COMPANY')
+client.purchase_orders.retreive('COMPANY', 'SECUENCEID')
+client.purchase_orders.create('COMPANY', {})
+#+end_src
+
+**** Receipts
+
+#+begin_src ruby
+client.receipts.list('COMPANY')
+client.receipts.retreive('COMPANY', 'SECUENCEID')
+client.receipts.create('COMPANY', {})
+#+end_src
+
+**** Vendor Contract Costs
+
+#+begin_src ruby
+client.vendor_contract_costs.list('COMPANY')
+client.vendor_contract_costs.retreive('COMPANY', 'ITEMNO', 'VENDCODE')
+client.vendor_contract_costs.create('COMPANY', {})
+client.vendor_contract_costs.update('COMPANY', 'ITEMNO', 'VENDCODE', {})
+client.vendor_contract_costs.delete('COMPANY', 'ITEMNO', 'VENDCODE')
+#+end_src
+
+** Performance tips
+It is possible to adjust the performance of Sage 300 Web API if improvements are required for integration purposes.
+
+*** Increase page size for requets
+When large amounts of records need to be retrieved through Sage 300 Web API, the page size setting can be increased to reduce the number of GET requests and thus reduce the overall time for the entire process.
+
+In order to increase the page size setting, you can use a text editor to open the =Web.config= file located in the =Online\WebApi= folder under your Sage 300 installation folder. Search for the line in this file that contains the following text:
+
+#+begin_src xml
+<add key="PageSize" value="100" />
+#+end_src
+
+Increase the value to the required page size. The recommended setting for large numbers of records is 1000.
+
+*** Change IIS idle time
+By default, IIS terminates a web application after 20 minutes of inactivity. This means that if Sage 300 Web API requests are not made within 20 minutes of one another, a request will take longer than usual to process. To curb this behavior, the IIS application pool Idle Time-out setting can be adjusted.
+
+To increase the Time-out time and Time-out Action:
+1. Open IIS Manager
+2. In Application Pools, select Sage300 Pool.
+3. In the Actions pane, click Advanced Settings.
+4. In the Process Model section, change the Idle Time-out Action from Terminate to Suspend.
+5. The Idle Time-out time should be increased to a more reasonable amount. 1447 minutes is the recommended value, as it is greater than a single day.
+
+** Contributing
+
+Everyone is encouraged to help improve this project. Bug reports and pull requests are welcome at [[https://github.com/lepepe/sagekit/pulls]].
+Feel free to open an [[https://github.com/lepepe/sagekit/issues][issue]] to get feedback on your idea before spending too much time on it.
+
+** License
+
+The gem is available as open source under the terms of the [[https://opensource.org/licenses/MIT][MIT License]].

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "sagekit"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+# Only for test purpose!
+client = Sagekit::Client.new(base_url: 'http://10.255.6.60/Sage300WebApi/v1.0/vertilux', auth: 'Basic QURNSU46Vlg2ODUwTUlBTUk=')
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here