erp_integration 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b73b17b72afec2d03e59213c35db31b1260f304907a9686af94a6bc0123b19c2
+  data.tar.gz: e2f42a3b2c313c6aa91efdcd5663b3c070a04221416799f0b4ee8753fc29df43
+SHA512:
+  metadata.gz: e951c654c3293e5e169b212c5b0dc5ecc1b742750155520edb68302b2452e7f5637caa2e36ec75e37363e76626efe667186bd45e58e38cfe0c08c92709cd9f9a
+  data.tar.gz: ff1d1e69793589517db55c30ad56be8e7a484d77ef5cba846d00805aad46e3123d90343b38854a6b2323eb7607835fe9ab4a6d491d769d6d78a66b2657e1c4c0

data/.flayignore

@@ -0,0 +1,10 @@
+spec/**/*.rb
+bin/*
+
+# The `.vendor` and `.bundle` folder is used by Github Actions to install
+# the ruby gems for this gem.
+.bundle/
+.vendor/
+
+# The GitHub workflows don't have to be inspected by Flay.
+.github

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10

data/.github/pull_request_template.md

@@ -0,0 +1,7 @@
+### What problem is the code solving?
+
+### How does this change address the problem?
+
+### Why is this the best solution?
+
+### Share the knowledge

data/.github/workflows/code_quality.yml

@@ -0,0 +1,27 @@
+name: Code Quality
+
+on: [push]
+
+jobs:
+  linters:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+
+    - name: Install all dependencies
+      run: bundle install
+
+    - name: Check code styles with Rubocop
+      run: bin/rubocop
+
+    - name: Look for code smells with Reek
+      run: bin/reek
+
+    - name: Analyze code for structural similarities with Flay
+      run: bin/flay

data/.github/workflows/main.yml

@@ -0,0 +1,26 @@
+name: Verify
+
+on: [push]
+
+jobs:
+  verify:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ['3.0', '2.7', '2.6', '2.5', '2.4', '2.3']
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+        ruby-version: ${{ matrix.ruby-version }}
+
+    - name: Install all dependencies
+      run: bundle install
+
+    - name: Run the tests
+      run: bin/rspec

data/.github/workflows/pull_requests.yml

@@ -0,0 +1,18 @@
+name: PR Validations
+
+on:
+  pull_request:
+    types:
+      - opened
+      - edited
+      - reopened
+      - synchronize
+
+jobs:
+  pr-lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: seferov/pr-lint-action@master
+        with:
+          title-regex: '^\[RELEASE|NO-TICKET|DL|AD|DU|AR|IN|MT-\d*\](\ )'

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# "Do not check your Gemfile.lock into version control, since it enforces precision
+# that does not exist in the gem command, which is used to install gems in practice."
+#  - https://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/
+Gemfile.lock
+.byebug_history
+*.gem

data/.reek.yml

@@ -0,0 +1,136 @@
+---
+detectors:
+  Attribute:
+    enabled: false
+    exclude: []
+  BooleanParameter:
+    enabled: false
+    exclude: []
+  ClassVariable:
+    enabled: true
+    exclude: []
+  ControlParameter:
+    enabled: false
+    exclude: []
+  DataClump:
+    enabled: true
+    exclude: []
+    max_copies: 3
+    min_clump_size: 4
+  DuplicateMethodCall:
+    enabled: true
+    allow_calls:
+      - 'self.class'
+      - 'self.class.name'
+    exclude: []
+    max_calls: 1
+  FeatureEnvy:
+    enabled: false
+    exclude: []
+  InstanceVariableAssumption:
+    enabled: false
+  IrresponsibleModule:
+    enabled: false
+    exclude: []
+  LongParameterList:
+    enabled: true
+    exclude: []
+    max_params: 5
+    overrides:
+      initialize:
+        max_params: 5
+  LongYieldList:
+    enabled: true
+    exclude: []
+    max_params: 3
+  ManualDispatch:
+    enabled: true
+    exclude:
+      # Acceptable code smell as we don't know the full extend of our configuration
+      # interface for the gem yet.
+      - ErpIntegration::Configuration
+      - ErpIntegration::Resource#initialize
+  MissingSafeMethod:
+    enabled: true
+    exclude: []
+  ModuleInitialize:
+    enabled: true
+    exclude: []
+  NestedIterators:
+    enabled: true
+    exclude: []
+  NilCheck:
+    enabled: false
+    exclude: []
+  RepeatedConditional:
+    enabled: true
+    exclude: []
+    max_ifs: 2
+  SubclassedFromCoreClass:
+    enabled: true
+    exclude: []
+  TooManyConstants:
+    enabled: true
+    exclude: []
+    max_constants: 5
+  TooManyInstanceVariables:
+    enabled: true
+    exclude: []
+    max_instance_variables: 4
+  TooManyMethods:
+    enabled: true
+    exclude: []
+    max_methods: 15
+  TooManyStatements:
+    enabled: true
+    exclude:
+      - initialize
+    max_statements: 25
+  UncommunicativeMethodName:
+    enabled: true
+    exclude: []
+    reject:
+      - "/[0-9]$/"
+      - "/[A-Z]/"
+    accept: []
+  UncommunicativeModuleName:
+    enabled: true
+    exclude: []
+    reject:
+      - "/^.$/"
+      - "/[0-9]$/"
+    accept: ["V1", "V2"]
+  UncommunicativeParameterName:
+    enabled: true
+    exclude: []
+    reject:
+      - "/^.$/"
+      - "/[0-9]$/"
+      - "/[A-Z]/"
+      - "/^_/"
+    accept: []
+  UncommunicativeVariableName:
+    enabled: true
+    exclude: ["e"]
+    reject:
+      - "/^.$/"
+      - "/[0-9]$/"
+      - "/[A-Z]/"
+    accept:
+      - "/^_$/"
+  UnusedParameters:
+    enabled: true
+    exclude: []
+  UnusedPrivateMethod:
+    enabled: false
+    exclude: []
+  UtilityFunction:
+    enabled: false
+
+# Directories and files below will not be scanned at all
+exclude_paths:
+  - spec
+  - bin
+  - .bundle
+  - .vendor
+  - .github

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,88 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Layout/HashAlignment:
+  EnforcedColonStyle: key
+  EnforcedHashRocketStyle: key
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - Rakefile
+    - erp_integration.gemspec
+    # Reasons to disable for the specs:
+    # 1. Specs tend to include big blocks (e.g. `RSpec.describe` or `it`).
+    # 2. `mejuri-web` also has disabled the `Metrics/BlockLength` for specs.
+    - spec/**/*
+  ExcludedMethods: ['class_eval']
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: true
+  EnforcedStyle: comparison
+
+Style/RedundantSelf:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Layout/CaseIndentation:
+  Enabled: true
+  EnforcedStyle: case
+  IndentOneStep: true
+
+Style/GuardClause:
+  Enabled: true
+
+# https://github.com/rubocop-hq/ruby-style-guide/issues/522
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+
+Metrics/MethodLength:
+  Max: 15
+  Enabled: true
+
+Metrics/AbcSize:
+  Max: 20
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Metrics/CyclomaticComplexity:
+  Enabled: true
+
+Metrics/PerceivedComplexity:
+  Enabled: true
+
+Naming/PredicateName:
+  Enabled: true
+
+Metrics/ClassLength:
+  Enabled: true
+
+Style/AndOr:
+  EnforcedStyle: conditionals

data/.ruby-version

@@ -0,0 +1 @@
+3.0.2

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+## [v.0.1.0](https://github.com/mejuri-inc/erp-integration/tree/v.0.1.0) (2021-07-28)
+
+[Full Changelog](https://github.com/mejuri-inc/erp-integration/compare/a411f1240265c1e67ed4f07275cb357ffbbdb681...v.0.1.0)
+
+**Merged pull requests:**
+
+- \[NO-TICKET\] Added pull-request-template [\#11](https://github.com/mejuri-inc/erp-integration/pull/11) ([germansvriz](https://github.com/germansvriz))
+- \[NO-TICKET\] Updates ruby to v3.0.2 [\#9](https://github.com/mejuri-inc/erp-integration/pull/9) ([stefanvermaas](https://github.com/stefanvermaas))
+- \[DU-81\] Create ERPIntegrationOrder  [\#8](https://github.com/mejuri-inc/erp-integration/pull/8) ([germansvriz](https://github.com/germansvriz))
+- \[NO-TICKET\] Configure Reek and Flay [\#7](https://github.com/mejuri-inc/erp-integration/pull/7) ([stefanvermaas](https://github.com/stefanvermaas))
+- \[DU-80\] Add a HTTP client for communication to Fulfil [\#6](https://github.com/mejuri-inc/erp-integration/pull/6) ([stefanvermaas](https://github.com/stefanvermaas))
+- \[DU-79\] Replace generic welcome for actionable todos. [\#3](https://github.com/mejuri-inc/erp-integration/pull/3) ([stefanvermaas](https://github.com/stefanvermaas))
+- \[DU-79\] Adds Github's Dependabot [\#2](https://github.com/mejuri-inc/erp-integration/pull/2) ([stefanvermaas](https://github.com/stefanvermaas))
+- \[DU-79\] Add GitHub actions [\#1](https://github.com/mejuri-inc/erp-integration/pull/1) ([stefanvermaas](https://github.com/stefanvermaas))
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

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 stefanvermaas@me.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,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Stefan Vermaas
+
+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,81 @@
+# Mejuri's ERP integration
+
+TODO: Add a accurate description for the gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+  gem 'erp_integration'
+```
+
+Or run the following command to add `ErpIntegration` to your Gemfile:
+
+```shell
+  $ bundle add erp_integration
+```
+
+TODO: Write installation instructions here for the Github package registry.
+
+## Usage
+
+### Configuration
+
+To configure the gem, create an initializer and add the following lines:
+
+```erb
+# config/initializers/erp_integration.rb
+ErpIntegration.configure do |config|
+  config.fulfil_api_key = '<your-api-key>'
+  config.fulfil_merchant_id = '<your-merchant-id>'
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+TODO: Write instructions for publishing the gem to the Github package registry.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mejuri-inc/erp_integration. 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/mejuri-inc/erp_integration/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 ErpIntegration project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mejuri-inc/erp_integration/blob/main/CODE_OF_CONDUCT.md).
+
+## Releasing
+
+### Prerequisites
+
+To be able to publish a new release, you'll need to set up a Rubygems account.
+
+> To begin, you’ll need to create an account on RubyGems.org. Visit the sign up page and supply an email address that you control, a handle (username) and a password.
+>
+> After creating the account, use your email and password when pushing the gem. (RubyGems saves the credentials in ~/.gem/credentials for you so you only need to log in once.)
+> - [Publishing to RubyGems.org](https://guides.rubygems.org/publishing/)
+
+It's important to note that you'll need the right privileges to publish the gem. Ask @germansvriz to add you as a gem owner.
+
+### Publish a new version
+
+1 - Run the prerelease script
+```shell
+$ bin/prerelease 0.0.1
+```
+2 - Create Pull Request
+3 - Merge it to main
+4 - Run Release script
+```shell
+$ bin/release 0.0.1
+```
+
+We're following [semver](https://semver.org/) for the release process of this gem. Make sure to apply the correct semver version for a new release.
+
+> **NOTE**: You don't have to add a `v` to the version you want to release. The release script will handle that for you.

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'flay_task'
+require 'reek/rake/task'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+FlayTask.new
+Reek::Rake::Task.new
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop flay reek]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'erp_integration'
+
+# 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
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/flay

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'flay' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('flay', 'flay')

data/bin/prerelease

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+VERSION=$1
+
+# Use the latest dependencies for the new gem version.
+bundle
+
+# Run all the rake task to ensure we're publishing a publishable gem.
+rake
+
+# Update the gem version.
+printf "module ErpIntegration\n  VERSION = \"$VERSION\".freeze\nend\n" > ./lib/erp_integration/version.rb
+git add lib/erp_integration/version.rb
+git checkout -b "release_v.$VERSION"
+git commit -m "[RELEASE] Bump version for v$VERSION"
+git push origin "release_v.$VERSION"
+
+# Tag the new gem version.
+git tag v$VERSION
+git push --tags