responsable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 89f9a11c6cabcab46760327a3b00c0ea696c2218d19a001c0efa1100855f8311
+  data.tar.gz: 845c953d19e8fba04cdb2fe1f13d80e7d93b1cdf7c58ca76908a6f4231f40ad6
+SHA512:
+  metadata.gz: 4784e9232b0fc5ac2ad23539624510685a15cb18a83184576beb6f5fb42411d083a1413e1a4b85e8cc1d8f52933bf3b00073471d372a4980e3d366b361799d31
+  data.tar.gz: 4538867170df252c6b063733f5ba17c011f4fb97ca8c683cedb424dbc8a02e5ac5018ddc5dc3d0fc2397a58f272a4d89c3ca3240f9adbebef9209ac0fb2e1fc4

data/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_gem:
+  ruboguide:
+    - styles/rubocop-rails.yml

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in responsable.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+
+gem 'ruboguide', '~> 1.0'

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    responsable (0.1.0)
+      dry-configurable (~> 0.16)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
+    dry-configurable (0.16.1)
+      dry-core (~> 0.6)
+      zeitwerk (~> 2.6)
+    dry-core (0.9.1)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.18.0)
+    parallel (1.22.1)
+    parser (3.2.1.1)
+      ast (~> 2.4.1)
+    rack (2.2.6.4)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.12.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.12.4)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.7.0, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
+    ruboguide (1.0.0)
+      rubocop (= 1.23.0)
+      rubocop-performance (= 1.12.0)
+      rubocop-rails (= 2.12.4)
+      rubocop-rake (= 0.6.0)
+      rubocop-rspec (= 2.6.0)
+    ruby-progressbar (1.13.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    zeitwerk (2.6.7)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  responsable!
+  rspec (~> 3.0)
+  ruboguide (~> 1.0)
+
+BUNDLED WITH
+   2.4.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Mario Rios
+
+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,40 @@
+# Responsable
+
+Responsable is a gem to standardize response objects and messages accross all Researchable's services.
+
+## Installation
+
+
+Add this to your Gemfile:
+```ruby
+gem 'responsable', '~> 1.0'
+```
+
+Then execute:
+```bash
+$ bundle install
+```
+
+## Usage
+
+In your application controller, include the `Responsable` module:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include Responsable
+  
+  # rest of the controller
+end
+```
+
+Then, in your controller actions, you can use any of the available response methods in lib/responsable.rb 
+
+## 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).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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/responsable/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Responsable
+  VERSION = '1.0.0'
+end

data/lib/responsable.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require_relative 'responsable/version'
+require 'dry-configurable'
+
+# The {#Responsable} module provides a consistent way to render json responses across all Researchable's services
+module Responsable
+  extend Dry::Configurable
+  setting :serializer, default: proc { |resource| resource.as_json }
+
+  # Method to render a resource in a consistent way. If the resource is not valid it will render a validation error
+  # @param resource the resource to render
+  def render_resource(resource)
+    if resource.errors.empty?
+      render json: resource
+    else
+      validation_error(resource.errors)
+    end
+  end
+
+  # Method to render validation errors in a consistent way
+  # @param resource_errors the errors to render
+  def validation_error(resource_errors)
+    render json: {
+      errors: [
+        {
+          status: '400',
+          title: 'Bad Request',
+          detail: resource_errors,
+          code: '100'
+        }
+      ]
+    }, status: :bad_request
+  end
+
+  # Method to render access denied errors in a consistent way
+  # @param resource_errors the errors to render
+  def access_denied(resource_errors)
+    render json: {
+      errors: [
+        {
+          status: '403',
+          title: 'Access Denied',
+          detail: resource_errors,
+          code: '100'
+        }
+      ]
+    }, status: :forbidden
+  end
+
+  # Method to render not found errors in a consistent way
+  # @param resource_errors the errors to render
+  def not_found(resource_errors)
+    render json: {
+      errors: [
+        {
+          status: '404',
+          title: 'Not Found',
+          detail: resource_errors,
+          code: '100'
+        }
+      ]
+    }, status: :not_found
+  end
+
+  # Method to render created status in a consistent way
+  # @param resource the resource to render
+  def created(resource = nil)
+    render json: {
+      result: [
+        {
+          status: '201',
+          title: 'created',
+          detail: 'resource created',
+          code: '100',
+          instance: Responsable.config.serializer.call(resource)
+        }
+      ]
+    }, status: :created
+  end
+
+  # Method to render success status in a consistent way
+  # @param resource the resource to render
+  def render_success_resource(resource)
+    render json: {
+      result: [
+        {
+          status: '200',
+          title: 'Success',
+          detail: resource,
+          code: '100'
+        }
+      ]
+    }, status: :ok
+  end
+
+  # Method to render destroyed status in a consistent way
+  def destroyed
+    render json: {
+      result: [
+        {
+          status: '200',
+          title: 'destroyed',
+          detail: 'resource destroyed',
+          code: '100'
+        }
+      ]
+    }, status: :ok
+  end
+
+  # Method to render unprocessable entity errors in a consistent way
+  # @param resource_errors the errors to render
+  def unprocessable_entity(resource_errors)
+    render json: {
+      errors: [
+        {
+          status: '422',
+          title: 'unprocessable',
+          detail: resource_errors,
+          code: '100'
+        }
+      ]
+    }, status: :unprocessable_entity
+  end
+
+  # Method to render no content in a consistent way
+  def no_content
+    render json: {
+      result: [
+        {
+          status: '204',
+          title: 'no content',
+          detail: 'no content provided',
+          code: '100'
+        }
+      ]
+    }, status:  :no_content
+  end
+end

data/responsable.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'lib/responsable/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'responsable'
+  spec.version = Responsable::VERSION
+  spec.authors = ['Researchable']
+  spec.email = ['info@researchable.nl']
+
+  spec.summary = "Researchable's gem to standardize http REST responses"
+  spec.description = "Researchable's gem to standardize http REST responses"
+  spec.homepage = "https://gitlab.com/researchable/general/gems/responsable/-/blob/v#{Responsable::VERSION}/README.md"
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://gitlab.com/researchable/general/gems/responsable'
+  spec.metadata['changelog_uri'] = "https://gitlab.com/researchable/general/gems/responsable/-/blob/v#{Responsable::VERSION}/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Register gem dependencies here
+  spec.add_dependency 'dry-configurable', '~> 0.16'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
+end

data/sig/responsable.rbs

@@ -0,0 +1,4 @@
+module Responsable
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: responsable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Researchable
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: Researchable's gem to standardize http REST responses
+email:
+- info@researchable.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/responsable.rb
+- lib/responsable/version.rb
+- responsable.gemspec
+- sig/responsable.rbs
+homepage: https://gitlab.com/researchable/general/gems/responsable/-/blob/v1.0.0/README.md
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Researchable's gem to standardize http REST responses
+test_files: []