sanger-jsonapi-resources 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50c28dfc8e5e642688539a7cd8e5dcfff388be6f0b6bfd52aac37efb8faa81b8
-  data.tar.gz: 4164c5253639dd7f04d3bd5f6ccc3a143fdc3f151ba45ef5d31d42c5a06a711e
+  metadata.gz: a55bda6cecda0ea196dec77943a8e2506af7bd15bd581cabcfbc996b3792aeb6
+  data.tar.gz: 84fe7e09db2944f6891037f838e751c7daf49ebd095bb08de43c1ab5a5010853
 SHA512:
-  metadata.gz: a46064d85e7f5e4e19425c3e2f815f6d509901181bddb2024a3551abd532a831ec7b3feadf6c62787afbc6a4cb9d5974cb3e080709bba8eb2b879357dc83940d
-  data.tar.gz: d302f0ca9f84734e207afd72d63101646bb1d5cf4380d5929483cdfa860728ccd26f00b30743a8ad744dfa20b3540186398f784f4a82cd0804dc6d4e9a6e3361
+  metadata.gz: '09651520c32728f3a6835aa77d83dc3b212426fc1154a7f49bc017f2f758aa8435c94954a6df5d3009fec99605fc8445ce4f636b6b2ce7f5b60d9758e061c1ed'
+  data.tar.gz: d7f53c0c0f23c6c1e6ec7e3f535e0e9481bf900682a93a5b1672ecfb5f53c642d74a4a754140b7daaf962a4cbe1c4eb2dc34e5b31763e0c631d0b7d0554c849c

data/README.md

@@ -1,6 +1,4 @@
-# JSONAPI::Resources [![Gem Version](https://badge.fury.io/rb/jsonapi-resources.svg)](https://badge.fury.io/rb/jsonapi-resources) [![Build Status](https://secure.travis-ci.org/cerebris/jsonapi-resources.svg?branch=beta)](http://travis-ci.org/cerebris/jsonapi-resources) [![Code Climate](https://codeclimate.com/github/cerebris/jsonapi-resources/badges/gpa.svg)](https://codeclimate.com/github/cerebris/jsonapi-resources)
-
-[![Join the chat at https://gitter.im/cerebris/jsonapi-resources](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/cerebris/jsonapi-resources?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+# JSONAPI::Resources (Sanger fork)
 
 `JSONAPI::Resources`, or "JR", provides a framework for developing an API server that complies with the
 [JSON:API](http://jsonapi.org/) specification.
@@ -8,12 +6,12 @@
 Like JSON:API itself, JR's design is focused on the resources served by an API. JR needs little more than a definition
 of your resources, including their attributes and relationships, to make your server compliant with JSON API.
 
-JR is designed to work with Rails 4.2+, and provides custom routes, controllers, and serializers. JR's resources may be
+JR is designed to work with Rails 5.1+, and provides custom routes, controllers, and serializers. JR's resources may be
 backed by ActiveRecord models or by custom objects.
 
 ## Documentation
 
-Full documentation can be found at [http://jsonapi-resources.com](http://jsonapi-resources.com), including the [v0.9 beta Guide](http://jsonapi-resources.com/v0.9/guide/) specific to this version. 
+Full documentation can be found at [http://jsonapi-resources.com](http://jsonapi-resources.com), including the [v0.10 alpha Guide](http://jsonapi-resources.com/v0.10/guide/) specific to this version.
 
 ## Demo App
 
@@ -22,32 +20,73 @@ We have a simple demo app, called [Peeps](https://github.com/cerebris/peeps), av
 ## Client Libraries
 
 JSON:API maintains a (non-verified) listing of [client libraries](http://jsonapi.org/implementations/#client-libraries)
-which *should* be compatible with JSON:API compliant server implementations such as JR.
+which _should_ be compatible with JSON:API compliant server implementations such as JR.
 
 ## Installation
 
 Add JR to your application's `Gemfile`:
 
-    gem 'sanger-jsonapi-resources'
+```
+gem 'jsonapi-resources'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install sanger-jsonapi-resources
+```bash
+gem install jsonapi-resources
+```
+
+**For further usage see the [v0.10 alpha Guide](http://jsonapi-resources.com/v0.10/guide/)**
+
+## Sanger-specific release process
+
+There are two versions of the gem which we use for production. The version 1 series has unique customisations and is used by Sequencescape. The version 2 series is a more generic version which is used by Traction.
+
+Check which versions we have published at https://rubygems.org/gems/sanger-jsonapi-resources
+
+### For version 1 series
+
+- Create a branch from **develop**, apply fixes.
+- Change version number in `lib/jsonapi/resources/version.rb` . This file is read by the gemspec during publication.
+- Test Sequencescape with the gem from the branch.
+- Merge the branch into develop.
+- Create a release from the develop branch with the new version number as the tag. Set Release label to _None_.
+<!-- list separator -->
+- Checkout the newly-created tag on develop.
+- Execute `bundle install` to ensure the gemspec is up to date.
+- Execute `gem build jsonapi-resources.gemspec` which builds sanger-jsonapi-resources-0.1.x.gem in this case.
+- Execute `gem push sanger-jsonapi-resources-0.1.x.gem` which publishes the gem.
+
+### For version 2 series
+
+- Create a branch from **master**, apply fixes.
+- Change version number in `lib/jsonapi/resources/version.rb` . This file is read by the gemspec during publication.
+- Test Traction with the gem from the branch.
+- Merge the branch into master.
+- Create a release from the master branch with the new version number as the tag. Set Release label to _Latest_.
+<!-- list separator -->
+- Checkout the newly-created tag on master.
+- Execute `bundle install` to ensure the gemspec is up to date.
+- Execute `gem build jsonapi-resources.gemspec` which builds sanger-jsonapi-resources-0.2.x.gem in this case.
+- Execute `gem push sanger-jsonapi-resources-0.2.x.gem` which publishes the gem.
+
+### Publication
+
+You will be notified by email for each. You will also receive one email for API key setup. The first push will ask email and password for the account, which are in KeePass (search for "gem").
 
-**For further usage see the [v0.9 beta Guide](http://jsonapi-resources.com/v0.9/guide/)**
+> [!NOTE]
+> The email and password for gem publication is a recent addition to the credentials database. Pull latest changes in the credentials repo.
 
 ## Contributing
 
-1. Fork it ( http://github.com/cerebris/jsonapi-resources/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+See CONTRIBUTING.md for details.
 
 ## License
 
-Copyright 2014-2016 Cerebris Corporation. MIT License (see LICENSE for details).
+Copyright 2014-2021 Cerebris Corporation. MIT License (see LICENSE for details).

data/lib/jsonapi/error.rb

@@ -15,7 +15,7 @@ module JSONAPI
       @source         = options[:source]
       @links          = options[:links]
 
-      @status         = Rack::Utils.status_code(options[:status]).to_s
+      @status         = status_code(options[:status]).to_s
       @meta           = options[:meta]
     end
 
@@ -24,6 +24,21 @@ module JSONAPI
       instance_variables.each {|var| hash[var.to_s.delete('@')] = instance_variable_get(var) unless instance_variable_get(var).nil? }
       hash
     end
+
+    private
+
+    # Extracted from Rack 2
+    def status_code(status)
+      if status.nil?
+        raise ArgumentError, "Status code is required"
+      end
+
+      if status.is_a?(Symbol)
+        Rack::Utils::SYMBOL_TO_STATUS_CODE.fetch(status) { raise ArgumentError, "Unrecognized status code #{status.inspect}" }
+      else
+        status.to_i
+      end
+    end
   end
 
   class Warning

data/lib/jsonapi/exceptions.rb

@@ -475,7 +475,7 @@ module JSONAPI
 
       def json_api_error(attr_key, message)
         create_error_object(code: JSONAPI::VALIDATION_ERROR,
-                            status: :unprocessable_entity,
+                            status: :unprocessable_content,
                             title: message,
                             detail: "#{format_key(attr_key)} - #{message}",
                             source: { pointer: pointer(attr_key) },
@@ -500,7 +500,7 @@ module JSONAPI
     class SaveFailed < Error
       def errors
         [create_error_object(code: JSONAPI::SAVE_FAILED,
-                             status: :unprocessable_entity,
+                             status: :unprocessable_content,
                              title: I18n.translate('jsonapi-resources.exceptions.save_failed.title',
                                                    default: 'Save failed or was cancelled'),
                              detail: I18n.translate('jsonapi-resources.exceptions.save_failed.detail',

data/lib/jsonapi/request_parser.rb

@@ -1,5 +1,6 @@
 require 'jsonapi/operation'
 require 'jsonapi/paginator'
+require 'cgi'
 
 module JSONAPI
   class RequestParser
@@ -272,7 +273,7 @@ module JSONAPI
 
       sorts = []
       begin
-        raw = URI.unescape(sort_criteria)
+        raw = CGI.unescape(sort_criteria)
         sorts += CSV.parse_line(raw)
       rescue CSV::MalformedCSVError
         fail JSONAPI::Exceptions::InvalidSortCriteria.new(format_key(@resource_klass._type), raw)

data/lib/jsonapi/resource.rb

@@ -511,7 +511,7 @@ module JSONAPI
         check_reserved_attribute_name(attr)
 
         if (attr.to_sym == :id) && (options[:format].nil?)
-          ActiveSupport::Deprecation.warn('Id without format is no longer supported. Please remove ids from attributes, or specify a format.')
+          ActiveSupport::Deprecation.new(nil, 'JSONAPI').warn('Id without format is no longer supported. Please remove ids from attributes, or specify a format.')
         end
 
         check_duplicate_attribute_name(attr) if options[:format].nil?

data/lib/jsonapi/resources/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Resources
-    VERSION = '0.1.2'
+    VERSION = '0.1.4'
   end
 end

data/lib/jsonapi/routing_ext.rb

@@ -38,28 +38,14 @@ module ActionDispatch
             options[:except] << :destroy unless options[:except].include?(:destroy) || options[:except].include?('destroy')
           end
 
-          resource @resource_type, options do
-            # :nocov:
-            if @scope.respond_to? :[]=
-              # Rails 4
-              @scope[:jsonapi_resource] = @resource_type
-
+          resource @resource_type, **options do
+            jsonapi_resource_scope(SingletonResource.new(@resource_type, api_only?, @scope[:shallow], **options), @resource_type) do
               if block_given?
                 yield
               else
                 jsonapi_relationships
               end
-            else
-              # Rails 5
-              jsonapi_resource_scope(SingletonResource.new(@resource_type, api_only?, @scope[:shallow], options), @resource_type) do
-                if block_given?
-                  yield
-                else
-                  jsonapi_relationships
-                end
-              end
             end
-            # :nocov:
           end
         end
 
@@ -107,27 +93,14 @@ module ActionDispatch
             options[:except] << :destroy unless options[:except].include?(:destroy) || options[:except].include?('destroy')
           end
 
-          resources @resource_type, options do
-            # :nocov:
-            if @scope.respond_to? :[]=
-              # Rails 4
-              @scope[:jsonapi_resource] = @resource_type
+          resources @resource_type, **options do
+            jsonapi_resource_scope(Resource.new(@resource_type, api_only?, @scope[:shallow], **options), @resource_type) do
               if block_given?
                 yield
               else
                 jsonapi_relationships
               end
-            else
-              # Rails 5
-              jsonapi_resource_scope(Resource.new(@resource_type, api_only?, @scope[:shallow], options), @resource_type) do
-                if block_given?
-                  yield
-                else
-                  jsonapi_relationships
-                end
-              end
             end
-            # :nocov:
           end
         end
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sanger-jsonapi-resources
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - PSD Team - Wellcome Trust Sanger Institute
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,6 +57,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-mock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest-spec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +85,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -120,28 +147,54 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '7.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '7.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '7.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '7.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -220,7 +273,6 @@ homepage: https://github.com/sanger/jsonapi-resources
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -228,15 +280,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Easily support JSON API in Rails.
 test_files: []