responsable 1.0.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89f9a11c6cabcab46760327a3b00c0ea696c2218d19a001c0efa1100855f8311
-  data.tar.gz: 845c953d19e8fba04cdb2fe1f13d80e7d93b1cdf7c58ca76908a6f4231f40ad6
+  metadata.gz: 52e320e39a904bc3e39051f56e9ca53cb819eb79fc3105f8f09b26330fd82ae1
+  data.tar.gz: 5669065bc46f866cc0459c4a7fd422fbdcfdb88ffec709b672ec3872301c0d70
 SHA512:
-  metadata.gz: 4784e9232b0fc5ac2ad23539624510685a15cb18a83184576beb6f5fb42411d083a1413e1a4b85e8cc1d8f52933bf3b00073471d372a4980e3d366b361799d31
-  data.tar.gz: 4538867170df252c6b063733f5ba17c011f4fb97ca8c683cedb424dbc8a02e5ac5018ddc5dc3d0fc2397a58f272a4d89c3ca3240f9adbebef9209ac0fb2e1fc4
+  metadata.gz: 1cb6adf94d115ebda7802e6293a231e3e8ebde61889405a2247112b8c2b154410e76ad470acaf4e4f387d5c9ff7ce34879c8120d6252ef4b5ba0d93db06dd708
+  data.tar.gz: 1b1222f41bc7e17423423b1a448b6de976d50b0684af16493cb4d36d6d4a6236f9f1d6c23397f991b7740ee10fcc538ccacc6db50d141f918627ea9eb312ddab

data/CHANGELOG.md

@@ -0,0 +1,37 @@
+# [1.4.0](https://gitlab.com/researchable/general/gems/responsable/compare/v1.3.0...v1.4.0) (2023-12-6)
+
+
+### Features
+
+* disable MFA requirement because otherwise it breaks the automated pipeline ([0c3bf8d](https://gitlab.com/researchable/general/gems/responsable/commit/0c3bf8dbb67cb23b9913063b5dc484d1dd46f74f))
+* rubocop + version bump ([e179223](https://gitlab.com/researchable/general/gems/responsable/commit/e17922334afd7dc3a882a38118a5379899a03c36))
+
+# [1.3.0](https://gitlab.com/researchable/general/gems/responsable/compare/v1.2.0...v1.3.0) (2023-12-6)
+
+
+### Features
+
+* Bump version number again ([e9ca8fb](https://gitlab.com/researchable/general/gems/responsable/commit/e9ca8fb70fca220898fba071f6dd9288e7c4bec4))
+
+# [1.2.0](https://gitlab.com/researchable/general/gems/responsable/compare/v1.1.0...v1.2.0) (2023-12-6)
+
+
+### Features
+
+* version bump ([15f9cb6](https://gitlab.com/researchable/general/gems/responsable/commit/15f9cb6a5579cbfecdf200946209248d87a4cb6e))
+
+# [1.1.0](https://gitlab.com/researchable/general/gems/responsable/compare/v1.0.0...v1.1.0) (2023-12-5)
+
+
+### Features
+
+* add #not_implemented ([deda9b2](https://gitlab.com/researchable/general/gems/responsable/commit/deda9b22a196372d5da474ad817311ddb34f5ee6))
+* add #render_page method ([a666152](https://gitlab.com/researchable/general/gems/responsable/commit/a66615252855d554558c56640ccc924068a3e3bb))
+
+# 1.0.0 (2023-04-20)
+
+
+### Features
+
+* first implementation ([3a3635c](https://gitlab.com/researchable/general/gems/responsable/commit/3a3635c3565d266ae00b324ec7fa97266fc01f93))
+* make serializer configurable ([29600cf](https://gitlab.com/researchable/general/gems/responsable/commit/29600cfecb942c8c9d6ecd5393845b45e7ef6abf))

data/README.md

@@ -1,6 +1,6 @@
 # Responsable
 
-Responsable is a gem to standardize response objects and messages accross all Researchable's services.
+Responsable is a gem to standardize response objects and messages across all Researchable's services.
 
 ## Installation
 
@@ -27,7 +27,7 @@ class ApplicationController < ActionController::Base
 end
 ```
 
-Then, in your controller actions, you can use any of the available response methods in lib/responsable.rb 
+Then, in your controller actions, you can use any of the available response methods in `lib/responsable.rb`.
 
 ## Development
 

data/lib/responsable/version.rb

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

data/lib/responsable.rb

@@ -136,4 +136,40 @@ module Responsable
       ]
     }, status:  :no_content
   end
+
+  # Method to render not implemented in a consistent way
+  # @param detail the description of the functionality that is not supported
+  def not_implemented(detail)
+    render json: {
+      result: [
+        {
+          status: '501',
+          title: 'Not Implemented',
+          detail: detail,
+          code: '100'
+        }
+      ]
+    }, status: :not_implemented
+  end
+
+  # Method to render paginated resources in a consistent way
+  # @param paginated_query the query that has been paginated with Kaminari
+  # @param serialized_data the serialized resource (should not be a hash `{data: ...}` to prevent double nesting)
+  def render_page(paginated_query, serialized_data)
+    if paginated_query.respond_to? :current_page
+      render json: {
+        data: serialized_data,
+        page: {
+          current_page: paginated_query.current_page,
+          next_page: paginated_query.next_page,
+          prev_page: paginated_query.prev_page,
+          total_count: paginated_query.total_count,
+          total_pages: paginated_query.total_pages,
+          has_next: !paginated_query.last_page? && paginated_query.size.positive?
+        }
+      }
+    else
+      not_implemented('a pagination gem that implements #current_page is needed')
+    end
+  end
 end

data/node_modules/semantic-release-rubygem/src/__tests__/fixtures/invalid-version-file/lib/test-gem/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TestGem
+  SOME_CONST = '1.1.2'
+end

data/node_modules/semantic-release-rubygem/src/__tests__/fixtures/prerelease/lib/test-gem/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TestGem
+  VERSION = '0.1.0.alpha.1'
+end

data/node_modules/semantic-release-rubygem/src/__tests__/fixtures/valid/lib/test-gem/version.rb

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

data/responsable.gemspec

@@ -34,7 +34,12 @@ Gem::Specification.new do |spec|
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html
+
+  # We have to disable MFA for pushing gems because otherwise we can't automate
+  # this process as we have the OTP code in 1pw somewhere.
+  # rubocop:disable Gemspec/RequireMFA
   spec.metadata = {
-    'rubygems_mfa_required' => 'true'
+    'rubygems_mfa_required' => 'false'
   }
+  # rubocop:enable Gemspec/RequireMFA
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: responsable
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Researchable
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-20 00:00:00.000000000 Z
+date: 2023-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -34,6 +34,7 @@ files:
 - ".editorconfig"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -41,13 +42,16 @@ files:
 - Rakefile
 - lib/responsable.rb
 - lib/responsable/version.rb
+- node_modules/semantic-release-rubygem/src/__tests__/fixtures/invalid-version-file/lib/test-gem/version.rb
+- node_modules/semantic-release-rubygem/src/__tests__/fixtures/prerelease/lib/test-gem/version.rb
+- node_modules/semantic-release-rubygem/src/__tests__/fixtures/valid/lib/test-gem/version.rb
 - responsable.gemspec
 - sig/responsable.rbs
-homepage: https://gitlab.com/researchable/general/gems/responsable/-/blob/v1.0.0/README.md
+homepage: https://gitlab.com/researchable/general/gems/responsable/-/blob/v1.4.0/README.md
 licenses:
 - MIT
 metadata:
-  rubygems_mfa_required: 'true'
+  rubygems_mfa_required: 'false'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -63,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Researchable's gem to standardize http REST responses