vtikit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf70a197b77dd2c05f728e8a086e6daf4f7e5a0efde541ab9f0e31abaab10ab0
+  data.tar.gz: 05323e7300e9cdba5cce31a24540568ad2c6d8a7d620fa6474cd3b6e7d31be53
+SHA512:
+  metadata.gz: 9e124c6f10928d50e72c750ad93b9ada420fea5a7c421b5c741dbf80400e4ef02bdb20dd0173ef128b51b11d326471d3227945704336dcc67112f7e59dbb47c7
+  data.tar.gz: 3258502248c7ae1183c4723375818965d1a03029e0e14fee8b434a5958e753a4cd5006fd8e826750431540ab61d04afd18a0a35e4b4c63e7c762a78b09be19b1

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-12-09
+
+- Initial 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 vtikit.gemspec
+gemspec
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem 'irb', '~> 1.3', '>= 1.3.5', require: false
+gem 'dotenv', '~> 2.7', '>= 2.7.6'

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,110 @@
+#+TITLE: Vtikit
+#+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
+
+Vtikit is the official Ruby library for Vertilux's API. It supports everything the API can do with simple interface written in Ruby.
+
+[[https://badge.fury.io/rb/vtikit.svg]]
+
+
+** Installation
+Add this line to your application's Gemfile:
+
+#+begin_src ruby
+gem 'vtikit'
+#+end_src
+
+And then execute:
+
+#+begin_src bash
+$ bundle install
+#+end_src
+
+Or install it yourself as:
+
+#+begin_src bash
+$ gem install vtikit
+#+end_src
+
+** Usage
+You'll need to generate an access key in Vertilux's application. If you already have an account in Vertilux's app you can get your key by simply visit =https://erp.vertilux.com/api_key.json= or run from your terminal:
+#+begin_src bash
+curl --request GET \
+  --url https://erp.vertilux.com/api_key \
+  --header 'Content-Type: application/json' \
+  --user 'YOUR_EMAIL_ADDRESS'
+#+end_src
+
+*Output*
+#+begin_example
+{
+    "first_name": "Jose",
+    "last_name": "Perez",
+    "email": "jose.perez@example.com",
+    "api_key": "YOUR_API_KEY",
+    "your_ip_addr": "127.0.0.1"
+}
+#+end_example
+
+
+** Resources and actions
+
+*** Inventory
+#+begin_src ruby
+client.inventory.catalog
+client.inventory.uoms
+client.inventory.uom(item)
+#+end_src
+
+*** Items
+#+begin_src ruby
+client.items.list
+client.items.retreive(id)
+client.items.label(barcode)
+#+end_src
+
+*** Orders
+#+begin_src ruby
+client.orders.create()
+#+end_src
+
+*Payload*
+#+begin_example
+{
+    "name": "Jose Perez",
+    "address": "7290 NW 35th Terrace , Miami, Florida 33122",
+    "shipvia": "Delivery",
+    "description": "Your order description",
+    "po_number": "PO666",
+    "line_items_attributes": [
+        {
+            "itemno": "00053900100",
+            "quantity": 5,
+            "uom": "ROLL"
+        },
+        {
+            "itemno": "00053900200",
+            "quantity": 5,
+            "uom": "ROLL"
+        }
+    ]
+}
+#+end_example
+
+*** Sales
+#+begin_src ruby
+client.sales.history
+#+end_src
+
+** Contributing
+
+Everyone is encouraged to help improve this project. Bug reports and pull requests are welcome at [[https://github.com/vertilux/vtikit/pulls]].
+Feel free to open an [[https://github.com/vertilux/vtikit/issues][issues]] 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,19 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "vtikit"
+require 'dotenv/load'
+Dotenv.load
+
+# 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
+
+client = Vtikit::Client.new(api_key: ENV['API_KEY'])
+
+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

data/docs/index.html

@@ -0,0 +1,394 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
+<head>
+<!-- 2021-12-10 Fri 11:16 -->
+<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+<meta name="viewport" content="width=device-width, initial-scale=1" />
+<title>Vtikit</title>
+<meta name="author" content="Jose Perez" />
+<meta name="generator" content="Org Mode" />
+<style>
+  #content { max-width: 60em; margin: auto; }
+  .title  { text-align: center;
+             margin-bottom: .2em; }
+  .subtitle { text-align: center;
+              font-size: medium;
+              font-weight: bold;
+              margin-top:0; }
+  .todo   { font-family: monospace; color: red; }
+  .done   { font-family: monospace; color: green; }
+  .priority { font-family: monospace; color: orange; }
+  .tag    { background-color: #eee; font-family: monospace;
+            padding: 2px; font-size: 80%; font-weight: normal; }
+  .timestamp { color: #bebebe; }
+  .timestamp-kwd { color: #5f9ea0; }
+  .org-right  { margin-left: auto; margin-right: 0px;  text-align: right; }
+  .org-left   { margin-left: 0px;  margin-right: auto; text-align: left; }
+  .org-center { margin-left: auto; margin-right: auto; text-align: center; }
+  .underline { text-decoration: underline; }
+  #postamble p, #preamble p { font-size: 90%; margin: .2em; }
+  p.verse { margin-left: 3%; }
+  pre {
+    border: 1px solid #e6e6e6;
+    border-radius: 3px;
+    background-color: #f2f2f2;
+    padding: 8pt;
+    font-family: monospace;
+    overflow: auto;
+    margin: 1.2em;
+  }
+  pre.src {
+    position: relative;
+    overflow: auto;
+  }
+  pre.src:before {
+    display: none;
+    position: absolute;
+    top: -8px;
+    right: 12px;
+    padding: 3px;
+    color: #555;
+    background-color: #f2f2f299;
+  }
+  pre.src:hover:before { display: inline; margin-top: 14px;}
+  /* Languages per Org manual */
+  pre.src-asymptote:before { content: 'Asymptote'; }
+  pre.src-awk:before { content: 'Awk'; }
+  pre.src-authinfo::before { content: 'Authinfo'; }
+  pre.src-C:before { content: 'C'; }
+  /* pre.src-C++ doesn't work in CSS */
+  pre.src-clojure:before { content: 'Clojure'; }
+  pre.src-css:before { content: 'CSS'; }
+  pre.src-D:before { content: 'D'; }
+  pre.src-ditaa:before { content: 'ditaa'; }
+  pre.src-dot:before { content: 'Graphviz'; }
+  pre.src-calc:before { content: 'Emacs Calc'; }
+  pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
+  pre.src-fortran:before { content: 'Fortran'; }
+  pre.src-gnuplot:before { content: 'gnuplot'; }
+  pre.src-haskell:before { content: 'Haskell'; }
+  pre.src-hledger:before { content: 'hledger'; }
+  pre.src-java:before { content: 'Java'; }
+  pre.src-js:before { content: 'Javascript'; }
+  pre.src-latex:before { content: 'LaTeX'; }
+  pre.src-ledger:before { content: 'Ledger'; }
+  pre.src-lisp:before { content: 'Lisp'; }
+  pre.src-lilypond:before { content: 'Lilypond'; }
+  pre.src-lua:before { content: 'Lua'; }
+  pre.src-matlab:before { content: 'MATLAB'; }
+  pre.src-mscgen:before { content: 'Mscgen'; }
+  pre.src-ocaml:before { content: 'Objective Caml'; }
+  pre.src-octave:before { content: 'Octave'; }
+  pre.src-org:before { content: 'Org mode'; }
+  pre.src-oz:before { content: 'OZ'; }
+  pre.src-plantuml:before { content: 'Plantuml'; }
+  pre.src-processing:before { content: 'Processing.js'; }
+  pre.src-python:before { content: 'Python'; }
+  pre.src-R:before { content: 'R'; }
+  pre.src-ruby:before { content: 'Ruby'; }
+  pre.src-sass:before { content: 'Sass'; }
+  pre.src-scheme:before { content: 'Scheme'; }
+  pre.src-screen:before { content: 'Gnu Screen'; }
+  pre.src-sed:before { content: 'Sed'; }
+  pre.src-sh:before { content: 'shell'; }
+  pre.src-sql:before { content: 'SQL'; }
+  pre.src-sqlite:before { content: 'SQLite'; }
+  /* additional languages in org.el's org-babel-load-languages alist */
+  pre.src-forth:before { content: 'Forth'; }
+  pre.src-io:before { content: 'IO'; }
+  pre.src-J:before { content: 'J'; }
+  pre.src-makefile:before { content: 'Makefile'; }
+  pre.src-maxima:before { content: 'Maxima'; }
+  pre.src-perl:before { content: 'Perl'; }
+  pre.src-picolisp:before { content: 'Pico Lisp'; }
+  pre.src-scala:before { content: 'Scala'; }
+  pre.src-shell:before { content: 'Shell Script'; }
+  pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
+  /* additional language identifiers per "defun org-babel-execute"
+       in ob-*.el */
+  pre.src-cpp:before  { content: 'C++'; }
+  pre.src-abc:before  { content: 'ABC'; }
+  pre.src-coq:before  { content: 'Coq'; }
+  pre.src-groovy:before  { content: 'Groovy'; }
+  /* additional language identifiers from org-babel-shell-names in
+     ob-shell.el: ob-shell is the only babel language using a lambda to put
+     the execution function name together. */
+  pre.src-bash:before  { content: 'bash'; }
+  pre.src-csh:before  { content: 'csh'; }
+  pre.src-ash:before  { content: 'ash'; }
+  pre.src-dash:before  { content: 'dash'; }
+  pre.src-ksh:before  { content: 'ksh'; }
+  pre.src-mksh:before  { content: 'mksh'; }
+  pre.src-posh:before  { content: 'posh'; }
+  /* Additional Emacs modes also supported by the LaTeX listings package */
+  pre.src-ada:before { content: 'Ada'; }
+  pre.src-asm:before { content: 'Assembler'; }
+  pre.src-caml:before { content: 'Caml'; }
+  pre.src-delphi:before { content: 'Delphi'; }
+  pre.src-html:before { content: 'HTML'; }
+  pre.src-idl:before { content: 'IDL'; }
+  pre.src-mercury:before { content: 'Mercury'; }
+  pre.src-metapost:before { content: 'MetaPost'; }
+  pre.src-modula-2:before { content: 'Modula-2'; }
+  pre.src-pascal:before { content: 'Pascal'; }
+  pre.src-ps:before { content: 'PostScript'; }
+  pre.src-prolog:before { content: 'Prolog'; }
+  pre.src-simula:before { content: 'Simula'; }
+  pre.src-tcl:before { content: 'tcl'; }
+  pre.src-tex:before { content: 'TeX'; }
+  pre.src-plain-tex:before { content: 'Plain TeX'; }
+  pre.src-verilog:before { content: 'Verilog'; }
+  pre.src-vhdl:before { content: 'VHDL'; }
+  pre.src-xml:before { content: 'XML'; }
+  pre.src-nxml:before { content: 'XML'; }
+  /* add a generic configuration mode; LaTeX export needs an additional
+     (add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
+  pre.src-conf:before { content: 'Configuration File'; }
+
+  table { border-collapse:collapse; }
+  caption.t-above { caption-side: top; }
+  caption.t-bottom { caption-side: bottom; }
+  td, th { vertical-align:top;  }
+  th.org-right  { text-align: center;  }
+  th.org-left   { text-align: center;   }
+  th.org-center { text-align: center; }
+  td.org-right  { text-align: right;  }
+  td.org-left   { text-align: left;   }
+  td.org-center { text-align: center; }
+  dt { font-weight: bold; }
+  .footpara { display: inline; }
+  .footdef  { margin-bottom: 1em; }
+  .figure { padding: 1em; }
+  .figure p { text-align: center; }
+  .equation-container {
+    display: table;
+    text-align: center;
+    width: 100%;
+  }
+  .equation {
+    vertical-align: middle;
+  }
+  .equation-label {
+    display: table-cell;
+    text-align: right;
+    vertical-align: middle;
+  }
+  .inlinetask {
+    padding: 10px;
+    border: 2px solid gray;
+    margin: 10px;
+    background: #ffffcc;
+  }
+  #org-div-home-and-up
+   { text-align: right; font-size: 70%; white-space: nowrap; }
+  textarea { overflow-x: auto; }
+  .linenr { font-size: smaller }
+  .code-highlighted { background-color: #ffff00; }
+  .org-info-js_info-navigation { border-style: none; }
+  #org-info-js_console-label
+    { font-size: 10px; font-weight: bold; white-space: nowrap; }
+  .org-info-js_search-highlight
+    { background-color: #ffff00; color: #000000; font-weight: bold; }
+  .org-svg { width: 90%; }
+</style>
+<link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/css/htmlize.css"/>
+<link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/css/readtheorg.css"/>
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
+<script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/lib/js/jquery.stickytableheaders.min.js"></script>
+<script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/js/readtheorg.js"></script>
+<link rel="stylesheet" type="text/css" href="style.css">
+</head>
+<body>
+<div id="content" class="content">
+<h1 class="title">Vtikit</h1>
+<div id="table-of-contents" role="doc-toc">
+<h2>Table of Contents</h2>
+<div id="text-table-of-contents" role="doc-toc">
+<ul>
+<li><a href="#org2f73898">Installation</a></li>
+<li><a href="#org3594377">Usage</a></li>
+<li><a href="#org30f275b">Resources and actions</a>
+<ul>
+<li><a href="#orgef516b6">Inventory</a></li>
+<li><a href="#org29c450a">Items</a></li>
+<li><a href="#org9405619">Orders</a></li>
+<li><a href="#orgdc54a23">Sales</a></li>
+</ul>
+</li>
+<li><a href="#org99a48b3">Contributing</a></li>
+<li><a href="#orgf7f2d32">License</a></li>
+</ul>
+</div>
+</div>
+<p>
+Vtikit is the official Ruby library for Vertilux&rsquo;s API. It supports everything the API can do with simple interface written in Ruby.
+</p>
+
+
+<div id="org64df933" class="figure">
+<p><img src="https://badge.fury.io/rb/vtikit.svg" alt="vtikit.svg" />
+</p>
+</div>
+
+
+<div id="outline-container-org2f73898" class="outline-2">
+<h2 id="org2f73898">Installation</h2>
+<div class="outline-text-2" id="text-org2f73898">
+<p>
+Add this line to your application&rsquo;s Gemfile:
+</p>
+<div class="org-src-container">
+<pre class="src src-ruby">gem <span style="color: #f1fa8c;">'vtikit'</span>
+</pre>
+</div>
+
+<p>
+And then execute:
+</p>
+<div class="org-src-container">
+<pre class="src src-bash">$ bundle install
+</pre>
+</div>
+
+<p>
+Or install it yourself as:
+</p>
+<div class="org-src-container">
+<pre class="src src-bash">$ gem install vtikit
+</pre>
+</div>
+</div>
+</div>
+
+<div id="outline-container-org3594377" class="outline-2">
+<h2 id="org3594377">Usage</h2>
+<div class="outline-text-2" id="text-org3594377">
+<p>
+You&rsquo;ll need to generate an access key in Vertilux&rsquo;s application. If you already have an account in Vertilux&rsquo;s app you can get your key by simply visit <code>https://erp.vertilux.com/api_key.json</code> or run from your terminal:
+</p>
+<div class="org-src-container">
+<pre class="src src-bash"><span style="color: #bd93f9;">curl</span> --request GET <span style="color: #f1fa8c;">\</span>
+  --url https://erp.vertilux.com/api_key <span style="color: #f1fa8c;">\</span>
+  --header <span style="color: #f1fa8c;">'Content-Type: application/json'</span> <span style="color: #f1fa8c;">\</span>
+  --user <span style="color: #f1fa8c;">'YOUR_EMAIL_ADDRESS'</span>
+</pre>
+</div>
+
+<p>
+<b>Output</b>
+</p>
+<pre class="example" id="org311f8c7">
+{
+    "first_name": "Jose",
+    "last_name": "Perez",
+    "email": "jose.perez@example.com",
+    "api_key": "YOUR_API_KEY",
+    "your_ip_addr": "127.0.0.1"
+}
+</pre>
+</div>
+</div>
+
+
+<div id="outline-container-org30f275b" class="outline-2">
+<h2 id="org30f275b">Resources and actions</h2>
+<div class="outline-text-2" id="text-org30f275b">
+</div>
+<div id="outline-container-orgef516b6" class="outline-3">
+<h3 id="orgef516b6">Inventory</h3>
+<div class="outline-text-3" id="text-orgef516b6">
+<div class="org-src-container">
+<pre class="src src-ruby">client.inventory.catalog
+client.inventory.uoms
+client.inventory.uom(item)
+</pre>
+</div>
+</div>
+</div>
+
+<div id="outline-container-org29c450a" class="outline-3">
+<h3 id="org29c450a">Items</h3>
+<div class="outline-text-3" id="text-org29c450a">
+<div class="org-src-container">
+<pre class="src src-ruby">client.items.list
+client.items.retreive(id)
+client.items.label(barcode)
+</pre>
+</div>
+</div>
+</div>
+
+<div id="outline-container-org9405619" class="outline-3">
+<h3 id="org9405619">Orders</h3>
+<div class="outline-text-3" id="text-org9405619">
+<div class="org-src-container">
+<pre class="src src-ruby">client.orders.create()
+</pre>
+</div>
+
+<p>
+<b>Payload</b>
+</p>
+<pre class="example" id="org0b274e8">
+{
+    "name": "Jose Perez",
+    "address": "7290 NW 35th Terrace , Miami, Florida 33122",
+    "shipvia": "Delivery",
+    "description": "Your order description",
+    "po_number": "PO666",
+    "line_items_attributes": [
+        {
+            "itemno": "00053900100",
+            "quantity": 5,
+            "uom": "ROLL"
+        },
+        {
+            "itemno": "00053900200",
+            "quantity": 5,
+            "uom": "ROLL"
+        }
+    ]
+}
+</pre>
+</div>
+</div>
+
+<div id="outline-container-orgdc54a23" class="outline-3">
+<h3 id="orgdc54a23">Sales</h3>
+<div class="outline-text-3" id="text-orgdc54a23">
+<div class="org-src-container">
+<pre class="src src-ruby">client.sales.history
+</pre>
+</div>
+</div>
+</div>
+</div>
+
+<div id="outline-container-org99a48b3" class="outline-2">
+<h2 id="org99a48b3">Contributing</h2>
+<div class="outline-text-2" id="text-org99a48b3">
+<p>
+Everyone is encouraged to help improve this project. Bug reports and pull requests are welcome at <a href="https://github.com/vertilux/vtikit/pulls">https://github.com/vertilux/vtikit/pulls</a>.
+Feel free to open an <a href="https://github.com/vertilux/vtikit/issues">issues</a> to get feedback on your idea before spending too much time on it.
+</p>
+</div>
+</div>
+
+<div id="outline-container-orgf7f2d32" class="outline-2">
+<h2 id="orgf7f2d32">License</h2>
+<div class="outline-text-2" id="text-orgf7f2d32">
+<p>
+The gem is available as open source under the terms of the <a href="https://opensource.org/licenses/MIT">MIT License</a>.
+</p>
+</div>
+</div>
+</div>
+<div id="postamble" class="status">
+<p class="author">Author: Jose Perez</p>
+<p class="date">Created: 2021-12-10 Fri 11:16</p>
+</div>
+</body>
+</html>

data/docs/style.css

@@ -0,0 +1,92 @@
+
+/* Read the Org custom CSS */
+
+/* Body andHeaders */
+h4,h5,h6 {
+    color:#6272a4;
+    font-weight:300;
+}
+
+body{
+    background:#282A36;
+    color:#404040;
+    font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;
+    font-weight:normal;
+    margin:0;
+    min-height:100%;
+    overflow-x:hidden;
+}
+
+/* Code block */
+.codeblock,pre.src,#content .literal-block{
+    border:1px solid #e1e4e5;
+    padding:12px;
+    overflow-x:auto;
+    background:#282A36;
+    margin:1px 0 24px 0;
+    color: #F8F8F2;
+}
+
+/* Links */
+a{
+    color:#6272a4;
+    text-decoration:none;
+    cursor:pointer}
+
+a:hover,a:active{
+    outline:0;
+}
+
+a:hover{
+    color:#bd93f9}
+
+a:visited{
+    color:#9B59B6}
+
+/* Table of Content */
+#table-of-contents{
+    position:fixed;
+    top:0;
+    left:0;
+    width:300px;
+    overflow-x:hidden;
+    overflow-y:scroll;
+    height:100%;
+    background:#44475A;
+    z-index:200;
+    scrollbar-base-color: #1F1D1D;
+    scrollbar-arrow-color: #b3b3b3;
+    scrollbar-shadow-color: #1F1D1D;
+    scrollbar-track-color : #343131;
+}
+
+#table-of-contents h2{
+    z-index:200;
+    background-color:#282A36;
+    text-align:center;
+    padding:0.809em;
+    display:block;
+    color:#fcfcfc;
+    font-size: 100%;
+    margin-bottom:0.809em}
+
+/* Footer */
+#postamble .author {
+    font-size: 100%;
+    margin-bottom: 0px;
+}
+
+#postamble .date {
+    font-size: 90%;
+    margin-bottom: 0px;
+    color: #00f769;
+}
+
+.figure {
+    padding: 0;
+}
+
+.figure p {
+    text-align: left;
+    padding: 0;
+}

data/lib/vtikit/client.rb

@@ -0,0 +1,43 @@
+require "faraday"
+require "faraday_middleware"
+
+module Vtikit
+  class Client
+
+    DEFAULT_TIMEOUT = 120
+    BASE_URL = "https://api.vertilux.com/api/v1"
+
+    attr_reader :api_key, :adapter
+
+    def initialize(api_key:, adapter: Faraday.default_adapter)
+      @api_key = api_key
+      @adapter = adapter
+    end
+
+    def inventory
+      InventoryResource.new(self)
+    end
+
+    def items
+      ItemsResource.new(self)
+    end
+
+    def orders
+      OrdersResource.new(self)
+    end
+
+    def sales
+      SalesResource.new(self)
+    end
+
+    def connection
+      @connection ||= Faraday.new do |con|
+        con.url_prefix = BASE_URL
+        con.request :json
+        con.response :json, content_type: "application/json"
+        con.adapter adapter
+      end
+    end
+
+  end
+end

data/lib/vtikit/collection.rb

@@ -0,0 +1,16 @@
+module Vtikit
+  class Collection
+    attr_reader :data
+
+    def self.from_response(response, type:)
+      body = response.body
+      new(
+        data: body.map{ |attrs| type.new(attrs) }
+      )
+    end
+
+    def initialize(data:)
+      @data = data
+    end
+  end
+end

data/lib/vtikit/error.rb

@@ -0,0 +1,3 @@
+module Vtikit
+  class Error < StandardError; end
+end

data/lib/vtikit/object.rb

@@ -0,0 +1,18 @@
+require "ostruct"
+
+module Vtikit
+  class Object
+    def initialize(attributes)
+      @attributes = OpenStruct.new(attributes)
+    end
+
+    def method_missing(method, *args, &block)
+      attribute = @attributes.send(method, *args, &block)
+      attribute.is_a?(Hash) ? Object.new(attribute) : attribute
+    end
+
+    def respond_to_missing?(method, inlcude_private = false)
+      true
+    end
+  end
+end

data/lib/vtikit/objects/inventory.rb

@@ -0,0 +1,4 @@
+module Vtikit
+  class Inventory < Object
+  end
+end

data/lib/vtikit/objects/item.rb

@@ -0,0 +1,4 @@
+module Vtikit
+  class Item < Object
+  end
+end

data/lib/vtikit/objects/order.rb

@@ -0,0 +1,4 @@
+module Vtikit
+  class Order < Object
+  end
+end

data/lib/vtikit/objects/sales.rb

@@ -0,0 +1,4 @@
+module Vtikit
+  class Sales < Object
+  end
+end

data/lib/vtikit/resource.rb

@@ -0,0 +1,51 @@
+module Vtikit
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def get_request(url, params: {}, headers: {})
+      handle_response client.connection.get(url, params, default_headers.merge(headers))
+    end
+
+    def post_request(url, body:, headers: {})
+      handle_response client.connection.post(url, body, default_headers.merge(headers))
+    end
+
+    def patch_request(url, body:, headers: {})
+      handle_response client.connection.patch(url, body, default_headers.merge(headers))
+    end
+
+    def put_request(url, body:, headers: {})
+      handle_response client.connection.put(url, body, default_headers.merge(headers))
+    end
+
+    def delete_request(url, params: {}, headers: {})
+      handle_response client.connection.delete(url, params, default_headers.merge(headers))
+    end
+
+    def default_headers
+      { "X-Api-Key": client.api_key }
+    end
+
+    def handle_response(response)
+      #message = response.body["message"]
+
+      case response.status
+        when 401
+            raise Error, "#{response.body}"
+        when 404
+            raise Error, "#{response.body}"
+        when 429
+            raise Error, "#{response.body}"
+        when 500
+            raise Error, "#{response.body}"
+      end
+
+      response
+    end
+
+  end
+end

data/lib/vtikit/resources/inventory.rb

@@ -0,0 +1,17 @@
+module Vtikit
+  class InventoryResource < Resource
+
+    def catalog(**params)
+      Collection.from_response get_request("inventory/catalog", params: params), type: Inventory
+    end
+
+    def uoms(**params)
+      Collection.from_response get_request("inventory/uom", params: params), type: Inventory
+    end
+
+    def uom(item, **params)
+      Inventory.new get_request("inventory/uom/#{item}", params: params).body
+    end
+
+  end
+end

data/lib/vtikit/resources/items.rb

@@ -0,0 +1,17 @@
+module Vtikit
+  class ItemsResource < Resource
+
+    def list(**params)
+      Collection.from_response get_request("customers/items", params: params), type: Item
+    end
+
+    def retreive(id, **params)
+      Item.new get_request("customers/items/#{id}", params: params).body
+    end
+
+    def label(tracking, **params)
+      Item.new get_request("customers/labels/#{tracking}", params: params).body
+    end
+
+  end
+end

data/lib/vtikit/resources/orders.rb

@@ -0,0 +1,29 @@
+module Vtikit
+  class OrdersResource < Resource
+
+    # New order payload
+    #{
+    #    "name": "Jose Perez",
+    #    "address": "7290 NW 35th Terrace , Miami, Florida 33122",
+    #    "shipvia": "Delivery",
+    #    "description": "Your order description",
+    #    "po_number": "PO666",
+    #    "line_items_attributes": [
+    #        {
+    #            "itemno": "00053900100",
+    #            "quantity": 5,
+    #            "uom": "ROLL"
+    #        },
+    #        {
+    #            "itemno": "00053900200",
+    #            "quantity": 5,
+    #            "uom": "ROLL"
+    #        }
+    #    ]
+    #}
+    def create(**attributed)
+      Order.new post_request("customers/orders", body: attributes).body
+    end
+
+  end
+end

data/lib/vtikit/resources/sales.rb

@@ -0,0 +1,9 @@
+module Vtikit
+  class SalesResource < Resource
+
+    def history(**params)
+      Collection.from_response get_request("customers/sales_history", params: params)
+    end
+
+  end
+end

data/lib/vtikit/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Vtikit
+  VERSION = "0.1.0"
+end

data/lib/vtikit.rb

@@ -0,0 +1,20 @@
+module Vtikit
+  autoload :Client, "vtikit/client"
+
+  autoload :Error, "vtikit/error"
+  autoload :Object, "vtikit/object"
+  autoload :Resource, "vtikit/resource"
+  autoload :Collection, "vtikit/collection"
+
+  # Recources
+  autoload :InventoryResource, "vtikit/resources/inventory"
+  autoload :ItemsResource, "vtikit/resources/items"
+  autoload :OrdersResource, "vtikit/resources/orders"
+  autoload :SalesResource, "vtikit/resources/sales"
+
+  # Objects
+  autoload :Inventory, "vtikit/objects/inventory.rb"
+  autoload :Item, "vtikit/objects/item.rb"
+  autoload :Order, "vtikit/objects/order.rb"
+  autoload :Sales, "vtikit/objects/sales.rb"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: vtikit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jose Perez
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: Official Ruby library for Vertilux's API
+email:
+- jose.perez@vertilux.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.org
+- Rakefile
+- bin/console
+- bin/setup
+- docs/index.html
+- docs/style.css
+- lib/vtikit.rb
+- lib/vtikit/client.rb
+- lib/vtikit/collection.rb
+- lib/vtikit/error.rb
+- lib/vtikit/object.rb
+- lib/vtikit/objects/inventory.rb
+- lib/vtikit/objects/item.rb
+- lib/vtikit/objects/order.rb
+- lib/vtikit/objects/sales.rb
+- lib/vtikit/resource.rb
+- lib/vtikit/resources/inventory.rb
+- lib/vtikit/resources/items.rb
+- lib/vtikit/resources/orders.rb
+- lib/vtikit/resources/sales.rb
+- lib/vtikit/version.rb
+homepage: https://vertilux.github.io/vtikit
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://vertilux.github.io/vtikit
+  source_code_uri: https://github.com/vertilux/vtikit
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.29
+signing_key:
+specification_version: 4
+summary: Official Ruby library for Vertilux's API
+test_files: []