QNE 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e736ef116778ab163c7298a8a72427ae9a2e58f8c514a0492aded610184f6c1
+  data.tar.gz: 1eed37e03d9b6018d4f95778646c03f5e77de0b291693bf94eb7821aab4580c9
+SHA512:
+  metadata.gz: b6b1325ebbe6e0d884a2257809ab3aa29396163462a78daa2f5360da0249b31bdaa6be5dc21103037c300f6b548af6b5d84f09dd3084624da62c676036a934dd
+  data.tar.gz: c84ef9d444f393f6a762244da354a29d6429669708229a231a04c5cc1cc9aa62074c19adf9eb21eb2ba74c78677f04a668cc395bc68699e087b385e3a07137da

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-06-08
+
+- 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 denmarkmeralpis@gmail.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,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in QNE.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"
+gem "faraday-retry", '~> 2.3'
+gem "faraday-net_http_persistent", "~> 2.3"
+gem "net-http-persistent", "~> 4.0"

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    QNE (0.2.0)
+      faraday-net_http_persistent (~> 2.3)
+      faraday-retry (~> 2.3)
+      net-http-persistent (~> 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    bigdecimal (3.1.6)
+    connection_pool (2.5.3)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    diff-lcs (1.5.1)
+    faraday (2.13.1)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-net_http (3.4.1)
+      net-http (>= 0.5.0)
+    faraday-net_http_persistent (2.3.1)
+      faraday (~> 2.5)
+      net-http-persistent (>= 4.0.4, < 5)
+    faraday-retry (2.3.2)
+      faraday (~> 2.0)
+    hashdiff (1.1.0)
+    json (2.12.2)
+    logger (1.7.0)
+    net-http (0.6.0)
+      uri
+    net-http-persistent (4.0.6)
+      connection_pool (~> 2.2, >= 2.2.4)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    public_suffix (4.0.7)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.0)
+    rubocop (1.28.2)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.5.0)
+    uri (1.0.3)
+    webmock (3.20.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  QNE!
+  faraday-net_http_persistent (~> 2.3)
+  faraday-retry (~> 2.3)
+  net-http-persistent (~> 4.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  webmock (~> 3.4)
+
+BUNDLED WITH
+   2.6.9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Nujian Den Mark Meralpis
+
+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.md

@@ -0,0 +1,411 @@
+# QNE
+
+A ruby wrapper for QNE APIs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'QNE'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install QNE
+
+## Usage
+
+Authorize your request by initializing your `db_code`:
+
+```ruby
+conn = QNE::Connection.new(db_code: 'YouDbCodeHere')
+```
+
+then you can use it to perform desired operation
+
+```ruby
+conn.customers.all(top: 10) # returns top 10 customers
+
+# if you want to have a custom retry_block
+# the retry block will be executed before retry happens
+# for example i have a block for creating logs
+def create_logs
+  puts 'Error Occurred'.
+end
+
+def retry_block
+  proc { create_logs }
+end
+
+# so now when you establish the connection you will
+# pass the block in the qne_connection argument
+# # when farday occur and it reached the first retry
+# the block will be executed
+conn = @integration.qne_connection(retry_block)
+```
+
+you can also check if the `db_code` is valid:
+
+```ruby
+conn.authenticated?
+```
+
+1. [Filters](#filters)
+2. List of available APIs:
+   - [Customers](#Customers)
+   - [Customer Categories](#Customer-Cetegories)
+   - [Default Tax Code](#Default-Tax-Code)
+   - [Sales Invoices](#Sales-Invoice)
+   - [Sales Orders](#Sales-Orders)
+   - [Stocks](#stocks)
+   - [Stock Locations](#stock-location)
+   - [Terms](#terms)
+
+### Filters
+
+You can filter the dataset by using `.where` method.
+
+| Name | Description           |
+| ---- | --------------------- |
+| `eq` | equal                 |
+| `ne` | not equal             |
+| `gt` | greater than          |
+| `lt` | less than             |
+| `ge` | greater than or equal |
+| `le` | less than or equal    |
+
+Example:
+
+```ruby
+conn.sales_orders.where(status: { eq: 'ACTIVE' })
+```
+
+You may also use other api queries such as:
+
+| Name      | Description                                                                                                                                  |
+| --------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| `top`     | Returns the top `X` results of the query.                                                                                                    |
+| `skip`    | Skips `X` results of the query.                                                                                                              |
+| `orderby` | Allows you to define the ordering of the returned dataset.                                                                                   |
+| `select`  | Allows you to define a subset of properties to return from that Resource. Performance wise, you should define the properties set explicitly. |
+
+##### Example:
+
+```ruby
+conn.customers.where(id: { ne: 1 }).all(top: 10, skip: 0)
+```
+
+### Customers
+
+**1. Fetch all customers**
+
+```ruby
+conn.customers.all
+```
+
+**2. Get a customer by attribute(s):**
+
+```ruby
+conn.customers.find_by(phoneNo1: '09123456789', status: 'ACTIVE')
+```
+
+**3. Create a customer:**
+
+```ruby
+# hash
+customer_hash = {
+    companyName: "DEN - (ABELLA NAGA CITY)",
+    companyName2: "DEN IBARRA",
+    controlAccount: "xxx-xxx-xxx",
+    category: "CATEGORY A",
+    address1: "AL3 ABELLA NAGA CITY CAMARINES SUR",
+    address2: "ABELLA",
+    address3: "NAGA CITY/CAMARINES SUR",
+    contactPerson: "DEN IBARRA",
+    email: "",
+    phoneNo1: "09123456789",
+    businessNature: "Something",
+    area: "NAGA CITY",
+    defaultTaxCode: "Something",
+    status: "ACTIVE"
+}
+
+# creates customer
+conn.customers.create(customer_hash)
+```
+
+**4. View specific customer**
+
+```ruby
+conn.customers.show('id-of-the-customer')
+```
+
+you can also do:
+
+```ruby
+customer = conn.customers.find('id-of-the customer')
+customer.show
+```
+
+**5. Update customer details**
+
+```ruby
+customer_hash = {
+    id: "2e2041e9-e963-4ae6-86a5-b9e3c5b808ce",
+    companyCode: "xxxx-xxxxx",
+    companyName: "DEN - (ABELLA NAGA CITY)",
+    companyName2: "DEN IBARRA"
+}
+
+conn.customers.update(customer_hash)
+```
+
+### Customer Categories
+
+**1. Fetch all customer categories**
+
+```ruby
+conn.customer_categories.all
+```
+
+### Default Tax Code
+
+```ruby
+conn.default_tax_code
+```
+
+### Sales Invoices
+
+**1. Fetch all sales invoices**
+
+```ruby
+conn.sales_invoices.all
+```
+
+**2. View a specific sales invoice:**
+
+```ruby
+conn.sales_invoices.show('xxx-xxx-xxx')
+```
+
+**3. Create a sales invoice:**
+
+```ruby
+sales_invoice_hash = {
+  address1: "Zone 2, San Antonio, MILAOR, CAMARINES SUR",
+  address2: "San Antonio/MILAOR",
+  address3: "CAMARINES SUR",
+  attention: "John Doe",
+  customer: "xxxxxxxxxx",
+  details: [
+    {
+      dateRef1: "2023-06-07T01:19:37.167Z",
+      description: "Product X",
+      numbering: "1",
+      project: "PROJECT A",
+      qty: 5,
+      stock: "9999",
+      stockLocation: "LOCATION_CODE",
+      unitPrice: "17.5",
+      uom: "piece"
+    }
+  ],
+  doAddress1: "Zone 2, San Antonio, MILAOR, CAMARINES SUR",
+  doAddress2: "San Antonio/MILAOR",
+  doAddress3: "CAMARINES SUR",
+  doContact: "John Doe",
+  doPhone: "09999999999",
+  invoiceDate: "2023-06-07T01:19:37.167Z",
+  invoiceTo: "Doe Store",
+  phone: "09999999999",
+  project: "PROJECT A",
+  referenceNo: "R9999-9-9",
+  remark1: "PM1",
+  stockLocation: "LOCATION CODE",
+  title: "PICKER NAME",
+  title2: "CHECKER NAME"
+}
+
+conn.sales_invoices.create(sales_invoice_hash)
+```
+
+**4. Update a sales invoice:**
+
+```ruby
+sales_invoice_hash = {
+  id: "xxxxxxxxx",
+  address1: "Updated address",
+  address2: "Updated address2",
+  address3: "CAMARINES SUR",
+  attention: "John Doe",
+  customer: "xxxxxxxxxx",
+  details: [
+    {
+      dateRef1: "2023-06-07T01:19:37.167Z",
+      description: "Product X",
+      numbering: "1",
+      project: "PROJECT A",
+      qty: 5,
+      stock: "9999",
+      stockLocation: "LOCATION_CODE",
+      unitPrice: "17.5",
+      uom: "piece"
+    }
+  ],
+  doAddress1: "Updated address",
+  doAddress2: "San Antonio/MILAOR",
+  doAddress3: "CAMARINES SUR",
+  doContact: "John Doe",
+  doPhone: "09999999999",
+  invoiceDate: "2023-06-07T01:19:37.167Z",
+  invoiceTo: "Doe Store",
+  phone: "09999999999",
+  project: "PROJECT A",
+  referenceNo: "R9999-9-9",
+  remark1: "PM1",
+  stockLocation: "LOCATION CODE",
+  title: "PICKER NAME",
+  title2: "CHECKER NAME"
+}
+
+conn.sales_invoices.update(sales_invoice_hash)
+```
+
+**5. Generate sales invoice download link**
+
+There are two types of downloadable links:
+1. `tax_invoice`
+2. `sales_invoice` (default)
+
+```ruby
+conn.sales_invoices.download('id-of-sales-invoice', 'tax_invoice')
+```
+
+### Sales Orders
+
+**1. Fetch all sales orders**
+
+```ruby
+conn.sales_orders.all
+```
+
+**2. View a specific sales order:**
+
+```ruby
+conn.sales_orders.show('xxx-xxx-xxx')
+```
+
+**3. Create a sales order:**
+
+```ruby
+sales_order_hash = {
+  address1: "Zone 9, San Antonio, MILAOR, CAMARINES SUR",
+  address2: "San Antonio/MILAOR",
+  address3: "CAMARINES SUR",
+  attention: "John Doe",
+  customer: "customer-id-123",
+  customerName: "Doe Store",
+  details: [
+    {
+      description: "Product Name",
+      qty: "5",
+      stock: "1495992",
+      unitPrice: "17.5",
+      uom: "piece"
+    }
+  ],
+  doAddress1: "Zone 9, San Antonio, MILAOR, CAMARINES SUR",
+  doAddress2: "San Antonio/MILAOR",
+  doAddress3: "CAMARINES SUR",
+  doContact: "John Doe",
+  doPhone: "09999999999",
+  isApproved: true,
+  isCancelled: false,
+  isTaxInclusive: true,
+  orderDate: "2023-06-01T01:19:37.167Z",
+  phone: "09999999999",
+  referenceNo: "R99999-9-9",
+  remark1: "",
+  project: "PROJECT NAME",
+  stockLocation: "STOCK CODE"
+}
+
+conn.sales_orders.create(sales_order_hash)
+```
+
+### Stocks
+
+**1. Fetch all stocks**
+
+```ruby
+conn.stocks.all
+```
+
+**2. Fetch all UOMs of a specific stock**
+
+```ruby
+stock = conn.stocks.find('stock-id')
+stock.uoms
+```
+
+or
+
+```ruby
+conn.stocks.find_uoms_by_id('stock-id')
+```
+
+**3. View specific stock**
+
+```ruby
+stock = conn.stocks.find('stock-id')
+stock.show
+```
+
+### Stock Locations
+
+**1. Fetch all stock locations**
+
+```ruby
+conn.stock_locations.all
+```
+
+_Note: `filters` and `queries` won't work for this specific action._
+
+### Terms
+
+**1. Fetch all terms**
+
+```ruby
+conn.terms.all
+```
+
+**2. Get a term by attribute(s):**
+
+```ruby
+conn.terms.show('id')
+```
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/QNE. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/QNE/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the QNE project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/QNE/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/QNE/agent/all.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module QNE
+  module Agent
+    class All
+      PATH = '/api/Agents'
+
+      def initialize(conn, params: {})
+        @conn = conn
+        @params = params
+      end
+
+      def call
+        @conn.get(PATH) do |req|
+          @params.each do |key, val|
+            req.params[key] = val
+          end
+        end
+      end
+    end
+  end
+end