sanger-jsonapi-resources 0.1.0

data/lib/jsonapi/routing_ext.rb

@@ -0,0 +1,262 @@
+module ActionDispatch
+  module Routing
+    class Mapper
+      Resource.class_eval do
+        def unformat_route(route)
+          JSONAPI.configuration.route_formatter.unformat(route.to_s)
+        end
+
+        def nested_param
+          :"#{unformat_route(singular)}_#{param}"
+        end
+      end
+
+      Resources.class_eval do
+        def format_route(route)
+          JSONAPI.configuration.route_formatter.format(route.to_s)
+        end
+
+        def jsonapi_resource(*resources, &_block)
+          @resource_type = resources.first
+          res = JSONAPI::Resource.resource_for(resource_type_with_module_prefix(@resource_type))
+
+          options = resources.extract_options!.dup
+          options[:controller] ||= @resource_type
+          options.merge!(res.routing_resource_options)
+          options[:path] = format_route(@resource_type)
+
+          if options[:except]
+            options[:except] << :new unless options[:except].include?(:new) || options[:except].include?('new')
+            options[:except] << :edit unless options[:except].include?(:edit) || options[:except].include?('edit')
+          else
+            options[:except] = [:new, :edit]
+          end
+
+          if res._immutable
+            options[:except] << :create  unless options[:except].include?(:create)  || options[:except].include?('create')
+            options[:except] << :update  unless options[:except].include?(:update)  || options[:except].include?('update')
+            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
+
+              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
+
+        def jsonapi_relationships(options = {})
+          res = JSONAPI::Resource.resource_for(resource_type_with_module_prefix(@resource_type))
+          res._relationships.each do |relationship_name, relationship|
+            if relationship.is_a?(JSONAPI::Relationship::ToMany)
+              jsonapi_links(relationship_name, options)
+              jsonapi_related_resources(relationship_name, options)
+            else
+              jsonapi_link(relationship_name, options)
+              jsonapi_related_resource(relationship_name, options)
+            end
+          end
+        end
+
+        def jsonapi_resources(*resources, &_block)
+          @resource_type = resources.first
+          res = JSONAPI::Resource.resource_for(resource_type_with_module_prefix(@resource_type))
+
+          options = resources.extract_options!.dup
+          options[:controller] ||= @resource_type
+          options.merge!(res.routing_resource_options)
+
+          options[:param] = :id
+
+          options[:path] = format_route(@resource_type)
+
+          if res.resource_key_type == :uuid
+            options[:constraints] ||= {}
+            options[:constraints][:id] ||= /[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}/
+          end
+
+          if options[:except]
+            options[:except] = Array(options[:except])
+            options[:except] << :new unless options[:except].include?(:new) || options[:except].include?('new')
+            options[:except] << :edit unless options[:except].include?(:edit) || options[:except].include?('edit')
+          else
+            options[:except] = [:new, :edit]
+          end
+
+          if res._immutable
+            options[:except] << :create  unless options[:except].include?(:create)  || options[:except].include?('create')
+            options[:except] << :update  unless options[:except].include?(:update)  || options[:except].include?('update')
+            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
+              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
+
+        def links_methods(options)
+          default_methods = [:show, :create, :destroy, :update]
+          if only = options[:only]
+            Array(only).map(&:to_sym)
+          elsif except = options[:except]
+            default_methods - Array(except)
+          else
+            default_methods
+          end
+        end
+
+        def jsonapi_link(*links)
+          link_type = links.first
+          formatted_relationship_name = format_route(link_type)
+          options = links.extract_options!.dup
+
+          res = JSONAPI::Resource.resource_for(resource_type_with_module_prefix)
+          options[:controller] ||= res._type.to_s
+
+          methods = links_methods(options)
+
+          if methods.include?(:show)
+            match "relationships/#{formatted_relationship_name}", controller: options[:controller],
+                                                                  action: 'show_relationship', relationship: link_type.to_s, via: [:get]
+          end
+
+          if res.mutable?
+            if methods.include?(:update)
+              match "relationships/#{formatted_relationship_name}", controller: options[:controller],
+                                                                    action: 'update_relationship', relationship: link_type.to_s, via: [:put, :patch]
+            end
+
+            if methods.include?(:destroy)
+              match "relationships/#{formatted_relationship_name}", controller: options[:controller],
+                                                                    action: 'destroy_relationship', relationship: link_type.to_s, via: [:delete]
+            end
+          end
+        end
+
+        def jsonapi_links(*links)
+          link_type = links.first
+          formatted_relationship_name = format_route(link_type)
+          options = links.extract_options!.dup
+
+          res = JSONAPI::Resource.resource_for(resource_type_with_module_prefix)
+          options[:controller] ||= res._type.to_s
+
+          methods = links_methods(options)
+
+          if methods.include?(:show)
+            match "relationships/#{formatted_relationship_name}", controller: options[:controller],
+                                                                  action: 'show_relationship', relationship: link_type.to_s, via: [:get]
+          end
+
+          if res.mutable?
+            if methods.include?(:create)
+              match "relationships/#{formatted_relationship_name}", controller: options[:controller],
+                                                                    action: 'create_relationship', relationship: link_type.to_s, via: [:post]
+            end
+
+            if methods.include?(:update)
+              match "relationships/#{formatted_relationship_name}", controller: options[:controller],
+                                                                    action: 'update_relationship', relationship: link_type.to_s, via: [:put, :patch]
+            end
+
+            if methods.include?(:destroy)
+              match "relationships/#{formatted_relationship_name}", controller: options[:controller],
+                                                                          action: 'destroy_relationship', relationship: link_type.to_s, via: [:delete]
+            end
+          end
+        end
+
+        def jsonapi_related_resource(*relationship)
+          source = JSONAPI::Resource.resource_for(resource_type_with_module_prefix)
+          options = relationship.extract_options!.dup
+
+          relationship_name = relationship.first
+          relationship = source._relationships[relationship_name]
+
+          formatted_relationship_name = format_route(relationship.name)
+
+          if relationship.polymorphic?
+            options[:controller] ||= relationship.class_name.underscore.pluralize
+          else
+            related_resource = JSONAPI::Resource.resource_for(resource_type_with_module_prefix(relationship.class_name.underscore.pluralize))
+            options[:controller] ||= related_resource._type.to_s
+          end
+
+          match "#{formatted_relationship_name}", controller: options[:controller],
+                                                  relationship: relationship.name, source: resource_type_with_module_prefix(source._type),
+                                                  action: 'get_related_resource', via: [:get]
+        end
+
+        def jsonapi_related_resources(*relationship)
+          source = JSONAPI::Resource.resource_for(resource_type_with_module_prefix)
+          options = relationship.extract_options!.dup
+
+          relationship_name = relationship.first
+          relationship = source._relationships[relationship_name]
+
+          formatted_relationship_name = format_route(relationship.name)
+          related_resource = JSONAPI::Resource.resource_for(resource_type_with_module_prefix(relationship.class_name.underscore))
+          options[:controller] ||= related_resource._type.to_s
+
+          match "#{formatted_relationship_name}", controller: options[:controller],
+                                                  relationship: relationship.name, source: resource_type_with_module_prefix(source._type),
+                                                  action: 'get_related_resources', via: [:get]
+        end
+
+        protected
+        # :nocov:
+        def jsonapi_resource_scope(resource, resource_type) #:nodoc:
+          @scope = @scope.new(scope_level_resource: resource, jsonapi_resource: resource_type)
+
+          controller(resource.resource_scope) { yield }
+        ensure
+          @scope = @scope.parent
+        end
+        # :nocov:
+        private
+
+        def resource_type_with_module_prefix(resource = nil)
+          resource_name = resource || @scope[:jsonapi_resource]
+          [@scope[:module], resource_name].compact.collect(&:to_s).join('/')
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi-resources.rb

@@ -0,0 +1,27 @@
+require 'jsonapi/naive_cache'
+require 'jsonapi/compiled_json'
+require 'jsonapi/resource'
+require 'jsonapi/cached_resource_fragment'
+require 'jsonapi/response_document'
+require 'jsonapi/acts_as_resource_controller'
+require 'jsonapi/resource_controller'
+require 'jsonapi/resource_controller_metal'
+require 'jsonapi/resources/version'
+require 'jsonapi/configuration'
+require 'jsonapi/paginator'
+require 'jsonapi/formatter'
+require 'jsonapi/routing_ext'
+require 'jsonapi/mime_types'
+require 'jsonapi/resource_serializer'
+require 'jsonapi/exceptions'
+require 'jsonapi/error'
+require 'jsonapi/error_codes'
+require 'jsonapi/request_parser'
+require 'jsonapi/operation_dispatcher'
+require 'jsonapi/processor'
+require 'jsonapi/relationship'
+require 'jsonapi/include_directives'
+require 'jsonapi/operation_result'
+require 'jsonapi/operation_results'
+require 'jsonapi/callbacks'
+require 'jsonapi/link_builder'

metadata

@@ -0,0 +1,223 @@
+--- !ruby/object:Gem::Specification
+name: sanger-jsonapi-resources
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dan Gebhardt
+- Larry Gebhardt
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+  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
+    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
+    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: pry
+  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: concurrent-ruby-ext
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A resource-centric approach to implementing the controllers, routes,
+  and serializers needed to support the JSON API spec.
+email:
+- dan@cerebris.com
+- larry@cerebris.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/generators/jsonapi/USAGE
+- lib/generators/jsonapi/controller_generator.rb
+- lib/generators/jsonapi/resource_generator.rb
+- lib/generators/jsonapi/templates/jsonapi_controller.rb
+- lib/generators/jsonapi/templates/jsonapi_resource.rb
+- lib/jsonapi-resources.rb
+- lib/jsonapi/acts_as_resource_controller.rb
+- lib/jsonapi/cached_resource_fragment.rb
+- lib/jsonapi/callbacks.rb
+- lib/jsonapi/compiled_json.rb
+- lib/jsonapi/configuration.rb
+- lib/jsonapi/error.rb
+- lib/jsonapi/error_codes.rb
+- lib/jsonapi/exceptions.rb
+- lib/jsonapi/formatter.rb
+- lib/jsonapi/include_directives.rb
+- lib/jsonapi/link_builder.rb
+- lib/jsonapi/mime_types.rb
+- lib/jsonapi/naive_cache.rb
+- lib/jsonapi/operation.rb
+- lib/jsonapi/operation_dispatcher.rb
+- lib/jsonapi/operation_result.rb
+- lib/jsonapi/operation_results.rb
+- lib/jsonapi/paginator.rb
+- lib/jsonapi/processor.rb
+- lib/jsonapi/relationship.rb
+- lib/jsonapi/relationship_builder.rb
+- lib/jsonapi/request_parser.rb
+- lib/jsonapi/resource.rb
+- lib/jsonapi/resource_controller.rb
+- lib/jsonapi/resource_controller_metal.rb
+- lib/jsonapi/resource_serializer.rb
+- lib/jsonapi/resources/version.rb
+- lib/jsonapi/response_document.rb
+- lib/jsonapi/routing_ext.rb
+homepage: https://github.com/cerebris/jsonapi-resources
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Easily support JSON API in Rails.
+test_files: []