glia-errors 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 23c0be62fe5b91fe4914d5b6812cfd678a11497e9591291a0664823e6ef1938b
+  data.tar.gz: 51680c69eaf02641ecc47857d67679fb3e64208f2e008471dffbe64d422d41d1
+SHA512:
+  metadata.gz: 3600850fc2f82f50c3608cbba041ef6af9bc9f15a387a64250e465b284ae26316532386443848a8718e4008b37a651c0c876bfb7ddac3e279990b2e11d9e49a7
+  data.tar.gz: 46a878503202ae5bdb3ba9f8df49c76fd1d122ca76aa9456f0d477753f6f312cd6f01514d59d1babd5a0259b72e2b9f383dc5e0442e7c446a0c9a869350ffc3d

data/.gitignore

@@ -0,0 +1,58 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+gemfiles/*gemfile.lock

data/.prettierignore

@@ -0,0 +1,2 @@
+vendor
+gemfiles

data/.prettierrc

@@ -0,0 +1 @@
+printWidth: 100

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+  Exclude:
+  - 'gemfiles/**/*'
+  - 'vendor/bundle/**/*'
+
+Metrics/MethodLength:
+  Max: 80
+
+Metrics/ModuleLength:
+  Max: 200
+
+Metrics/BlockLength:
+  Exclude:
+  - 'spec/**/*'

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+dist: trusty
+rvm:
+  - 2.5.0
+before_install:
+  - gem install bundler:2.2.0
+before_script:
+  - nvm install 12
+  - nvm use 12
+  - bundle
+gemfile:
+  - gemfiles/dry_validation_v1.gemfile
+script: bundle exec rake

data/Appraisals

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+appraise 'dry_validation_v0' do
+  gem 'dry-validation', '~> 0.13.0'
+end
+
+appraise 'dry_validation_v1' do
+  gem 'dry-validation', '~> 1.6'
+end

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'prettier', '~> 0.21'
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.10'
+gem 'rubocop', '~> 1.5'
+gem 'rubocop-rake', '~> 0.5'
+gem 'rubocop-rspec', '~> 2.0'
+gem 'super_diff'
+
+group :test do
+  gem 'appraisal'
+end

data/Gemfile.lock

@@ -0,0 +1,73 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    appraisal (2.3.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.1)
+    attr_extras (6.2.4)
+    diff-lcs (1.4.4)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    patience_diff (1.1.0)
+      trollop (~> 1.16)
+    prettier (0.21.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (2.0.0)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.5.2)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.0.1)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.10.1)
+    super_diff (0.5.2)
+      attr_extras (>= 6.2.4)
+      diff-lcs
+      patience_diff
+    thor (1.0.1)
+    trollop (1.16.2)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  prettier (~> 0.21)
+  rake (~> 13.0)
+  rspec (~> 3.10)
+  rubocop (~> 1.5)
+  rubocop-rake (~> 0.5)
+  rubocop-rspec (~> 2.0)
+  super_diff
+
+BUNDLED WITH
+   2.2.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Glia Inc.
+
+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,123 @@
+# glia-errors-ruby
+Glia REST API errors (WIP)
+
+[![Build Status](https://travis-ci.org/salemove/glia-errors-ruby.svg?branch=master)](https://travis-ci.org/salemove/glia-errors-ruby)
+
+The library provides a list of errors that are used in Glia REST API and utilities to easily construct them.
+
+It is used by Glia developers to map application specific errors to one of standardized Glia errors.
+Glia REST API integrators can use the library as a collection of constants to match Glia error response with the error
+type, see the example below.
+
+# Usage
+
+## Require library
+
+```ruby
+require 'glia/errors'
+```
+
+## For Glia developers
+
+### Map from `dry-validation` result
+
+Currently 2 `dry-validation` versions are supported:
+* `v0` up to `0.13`
+* `v1` up to `1.6`
+
+```ruby
+schema = Dry::Validation.Schema do
+  # ...
+end
+result = schema.(input)
+error = Glia::Errors.from_dry_validation_result(result)
+response = error.to_h
+```
+
+#### Specifying mapping for custom error message
+
+If you have custom `dry-validation` predicates and error messages you can specify a custom error map.
+Custom error map takes priority over standard error mapping.
+
+When custom error appears to be quite common consider adding it to this library instead.
+
+```ruby
+ERROR_MAP = {
+  'must be custom format' => lambda do |field, value, error_message|
+    Glia::Errors::InvalidFormatError.new(field: field)
+  end
+}
+error = Glia::Errors.from_dry_validation_result(result, ERROR_MAP)
+response = error.to_h
+```
+
+## For REST API integrators
+
+```ruby
+require 'uri'
+require 'net/http'
+require 'openssl'
+require 'json'
+
+url = URI('https://api.glia.com/engagement_requests')
+
+http = Net::HTTP.new(url.host, url.port)
+http.use_ssl = true
+http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+request = Net::HTTP::Post.new(url)
+request["Accept"] = 'application/json'
+request["Content-Type"] = 'application/json'
+request.body = '{}'
+
+response = http.request(request)
+code = response.code.to_i
+
+if code >= 200 || code <= 299
+  # Success
+elsif response.header['Content-Type'] == 'application/json'
+  # Glia error
+  error = JSON.parse(response.read_body)
+  case error['type']
+    when Glia::Errors::INPUT_VALIDATION_ERROR
+      # ...
+    when Glia::Errors::UNKNOWN_ERROR
+      # ...
+    else
+      # ...
+    end
+  end
+else
+  # Other error
+end
+```
+
+# Contributing
+
+## Testing
+
+Glia errors support multiple versions of `dry-validation` and tests are run against each supported major version.
+Under the hood we use `Appraisal` gem which generals additional gemfiles for each of the versions.
+
+To run all tests use:
+
+```
+bundle exec rake test
+```
+
+To run tests only for `dry-validation` v1:
+
+```
+bundle exec rake test_dry_validation_v1
+```
+
+To run tests only for `dry-validation` v0:
+
+```
+bundle exec rake test_dry_validation_v0
+```
+
+## Formatting
+
+```
+bundle exec rake format
+```

data/Rakefile

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new(:rubocop)
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-rspec'
+end
+
+task default: %i[lint test]
+
+task :lint do
+  sh "rubocop && rbprettier --check '**/*.rb'"
+end
+
+task :format do
+  sh "rbprettier --write '**/*.rb'"
+end
+
+task :install_test_deps do
+  sh 'bundle exec appraisal install'
+end
+
+task test: %i[test_dry_validation_v1 test_dry_validation_v0]
+
+task test_dry_validation_v1: :install_test_deps do
+  sh 'bundle exec appraisal dry_validation_v1 rspec'
+end
+
+task test_dry_validation_v0: :install_test_deps do
+  sh 'bundle exec appraisal dry_validation_v0 rspec --tag dry_validation_v0'
+end

data/gemfiles/dry_validation_v0.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "prettier", "~> 0.21"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.10"
+gem "rubocop", "~> 1.5"
+gem "rubocop-rake", "~> 0.5"
+gem "rubocop-rspec", "~> 2.0"
+gem "super_diff"
+gem "dry-validation", "~> 0.13.0"
+
+group :test do
+  gem "appraisal"
+end

data/gemfiles/dry_validation_v1.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "prettier", "~> 0.21"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.10"
+gem "rubocop", "~> 1.5"
+gem "rubocop-rake", "~> 0.5"
+gem "rubocop-rspec", "~> 2.0"
+gem "super_diff"
+gem "dry-validation", "~> 1.6"
+
+group :test do
+  gem "appraisal"
+end

data/glia-errors.gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'glia-errors'
+  spec.version       = '0.0.0'
+  spec.authors       = ['Glia TechMovers']
+  spec.email         = ['techmovers@glia.com']
+
+  spec.summary       = 'Glia REST API errors'
+  spec.description   = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '~> 2.5'
+end