scimaenaga 0.7.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d2d55daa03a9b1e4771b1f2e1287a75075514d57faeb0075ea8784a7dd8cc9e
-  data.tar.gz: b4a38c2c629cce871703a2a1874c3be93e34d55f0d5eacadae8da9b8c5e5c438
+  metadata.gz: 41335471b09b4e09028210f9c05586a1f171cf2e6cf3d12d03b07bddd0022dc3
+  data.tar.gz: 12c2072c1bc4a57274cb427a4507ed2b4a13a038b9e311bfdb7e29fabc94e524
 SHA512:
-  metadata.gz: 43e2ec416e2f9bad5c185042aff3e6fd576437d3d9bff5ac6ad5d1f930246fa0b59b12e1940a5498e386c8c8f385a245d531907e7ab5850cc8ebc5a7c35df607
-  data.tar.gz: 284bead26bc660ca0d4cc229dd5f13102501904b7658e3e780f5ea5657eb367c52cd5399d4a29dcd20af66eee19ce4592af7defa62c2f182bb7b23f76ebe6a31
+  metadata.gz: fc91680912294a747970e1ede984f5bbe4ad555bfacace02cc844abd6d13b124cb07f62481a6e7a7aaf1258253ca5e3d9fc83d4606cebfc44e50041dbd0e881f
+  data.tar.gz: 87da8ec3d1a3295d1766f13dc8474e525dc0a0c96fc4a458e79279ff48b05d7e8d628311880b10aa15925f149a59a4f54991154eeea605304df4338779dc03d3

data/README.md

@@ -17,7 +17,7 @@ The goal of the Gem is to offer a relatively painless way of adding SCIM 2.0 to
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'scimaenaga', require: 'scim_rails'
+gem 'scimaenaga'
 ```
 
 And then execute:
@@ -35,13 +35,13 @@ $ gem install scimaenaga
 Generate the config file with:
 
 ```bash
-$ rails generate scim_rails config
+$ rails generate scimaenaga config
 ```
 
 The config file will be located at:
 
 ```
-config/initializers/scim_rails_config.rb
+config/initializers/scimaenaga_config.rb
 ```
 
 Please update the config file with the models and attributes of your app.
@@ -50,7 +50,7 @@ Mount the gem in your routes file:
 
 ```ruby
 Application.routes.draw do
-  mount ScimRails::Engine => "/"
+  mount Scimaenaga::Engine => "/"
 end
 ```
 
@@ -95,7 +95,7 @@ The config setting `basic_auth_model_authenticatable_attribute` is the model att
 
 Assuming the attribute is `:api_token`, generate the password using:
 ```ruby
-token = ScimRails::Encoder.encode(company)
+token = Scimaenaga::Encoder.encode(company)
 # use the token as password for requests
 company.api_token = token # required
 company.save! # don't forget to persist the company record
@@ -119,7 +119,7 @@ In the config settings, ensure you set `signing_secret` to a secret key that wil
 
 If you have already generated the `api_token` in the "Basic Auth" section, then use that as your bearer token and ignore the steps below:
 ```ruby
-token = ScimRails::Encoder.encode(company)
+token = Scimaenaga::Encoder.encode(company)
 # use the token as bearer token for requests
 company.api_token = token #required
 company.save! # don't forget to persist the company record
@@ -245,11 +245,26 @@ If you would like, you can supply a custom handler for exceptions in the initial
 For example, you might want to notify Honeybadger:
 
 ```ruby
-ScimRails.configure do |config|
+Scimaenaga.configure do |config|
   config.on_error = ->(e) { Honeybadger.notify(e) }
 end
 ```
 
+### Schemas endpoint
+
+If you need Schemas endpoint configure `schemas`.
+(Azure AD requires Schemas endpoint when registering to Application Gallery.)
+
+You have to configure `schemas` as
+- corresponding with other configurations.
+e.g.) When `userName` is defined in `mutable_user_attributes`, configure `userName` as `mutability: 'readWrite'`.
+
+- corresponding with your model.
+e.g.) When `userName` must be specified configure `userName` as `required: true`
+
+Sample config (with comment) is written in lib/generators/scimaenaga/templates/initializer.rb.
+For more details, read [Schema Definition](https://datatracker.ietf.org/doc/html/rfc7643#section-7), and [Schema Representation](https://datatracker.ietf.org/doc/html/rfc7643#section-8.7)
+
 ## Contributing
 
 ### [Code of Conduct](https://github.com/StudistCorporation/scimaenaga/blob/master/CODE_OF_CONDUCT.md)

data/Rakefile

@@ -8,27 +8,25 @@ require 'rdoc/task'
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'ScimRails'
+  rdoc.title    = 'Scimaenaga'
   rdoc.options << '--line-numbers'
   rdoc.rdoc_files.include('README.md')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
 load 'rails/tasks/engine.rake'
 
-
 load 'rails/tasks/statistics.rake'
 
-
 Bundler::GemHelper.install_tasks
 
-Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each { |f| load f }
 
 require 'rspec/core'
 require 'rspec/core/rake_task'
 
-desc "Run all specs in spec directory (excluding plugin specs)"
-RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
 
-task :default => :spec
+task default: :spec

data/app/controllers/concerns/{scim_rails → scimaenaga}/exception_handler.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module ScimRails
+module Scimaenaga
   module ExceptionHandler
     extend ActiveSupport::Concern
 
@@ -25,10 +25,19 @@ module ScimRails
     class UnexpectedError < StandardError
     end
 
+    class ResourceNotFound < StandardError
+      attr_reader :id
+
+      def initialize(id)
+        super
+        @id = id
+      end
+    end
+
     included do
       if Rails.env.production?
         rescue_from StandardError do |exception|
-          on_error = ScimRails.config.on_error
+          on_error = Scimaenaga.config.on_error
           if on_error.respond_to?(:call)
             on_error.call(exception)
           else
@@ -37,98 +46,99 @@ module ScimRails
 
           json_response(
             {
-              schemas: ["urn:ietf:params:scim:api:messages:2.0:Error"],
-              status: "500"
+              schemas: ['urn:ietf:params:scim:api:messages:2.0:Error'],
+              status: '500',
             },
             :internal_server_error
           )
         end
       end
 
-      rescue_from ScimRails::ExceptionHandler::InvalidCredentials do
+      rescue_from Scimaenaga::ExceptionHandler::InvalidCredentials do
         json_response(
           {
-            schemas: ["urn:ietf:params:scim:api:messages:2.0:Error"],
-            detail: "Authorization failure. The authorization header is invalid or missing.",
-            status: "401"
+            schemas: ['urn:ietf:params:scim:api:messages:2.0:Error'],
+            detail: 'Authorization failure. The authorization header is invalid or missing.',
+            status: '401',
           },
           :unauthorized
         )
       end
 
-      rescue_from ScimRails::ExceptionHandler::InvalidRequest do |e|
+      rescue_from Scimaenaga::ExceptionHandler::InvalidRequest do |e|
         json_response(
           {
-            schemas: ["urn:ietf:params:scim:api:messages:2.0:Error"],
+            schemas: ['urn:ietf:params:scim:api:messages:2.0:Error'],
             detail: "Invalid request. #{e.message}",
-            status: "400"
+            status: '400',
           },
           :bad_request
         )
       end
 
-      rescue_from ScimRails::ExceptionHandler::InvalidQuery do
+      rescue_from Scimaenaga::ExceptionHandler::InvalidQuery do
         json_response(
           {
-            schemas: ["urn:ietf:params:scim:api:messages:2.0:Error"],
-            scimType: "invalidFilter",
-            detail: "The specified filter syntax was invalid, or the specified attribute and filter comparison combination is not supported.",
-            status: "400"
+            schemas: ['urn:ietf:params:scim:api:messages:2.0:Error'],
+            scimType: 'invalidFilter',
+            detail: 'The specified filter syntax was invalid, or the specified attribute and filter comparison combination is not supported.',
+            status: '400',
           },
           :bad_request
         )
       end
 
-      rescue_from ScimRails::ExceptionHandler::UnsupportedPatchRequest do
+      rescue_from Scimaenaga::ExceptionHandler::UnsupportedPatchRequest do
         json_response(
           {
-            schemas: ["urn:ietf:params:scim:api:messages:2.0:Error"],
-            detail: "Invalid PATCH request.",
-            status: "422"
+            schemas: ['urn:ietf:params:scim:api:messages:2.0:Error'],
+            detail: 'Invalid PATCH request.',
+            status: '422',
           },
           :unprocessable_entity
         )
       end
 
-      rescue_from ScimRails::ExceptionHandler::UnsupportedDeleteRequest do
+      rescue_from Scimaenaga::ExceptionHandler::UnsupportedDeleteRequest do
         json_response(
           {
-            schemas: ["urn:ietf:params:scim:api:messages:2.0:Error"],
-            detail: "Delete operation is disabled for the requested resource.",
-            status: "501"
+            schemas: ['urn:ietf:params:scim:api:messages:2.0:Error'],
+            detail: 'Delete operation is disabled for the requested resource.',
+            status: '501',
           },
           :not_implemented
         )
       end
 
-      rescue_from ScimRails::ExceptionHandler::InvalidConfiguration do |e|
+      rescue_from Scimaenaga::ExceptionHandler::InvalidConfiguration do |e|
         json_response(
           {
-            schemas: ["urn:ietf:params:scim:api:messages:2.0:Error"],
+            schemas: ['urn:ietf:params:scim:api:messages:2.0:Error'],
             detail: "Invalid configuration. #{e.message}",
-            status: "500"
+            status: '500',
           },
           :internal_server_error
         )
       end
 
-      rescue_from ScimRails::ExceptionHandler::UnexpectedError do |e|
+      rescue_from Scimaenaga::ExceptionHandler::UnexpectedError do |e|
         json_response(
           {
-            schemas: ["urn:ietf:params:scim:api:messages:2.0:Error"],
+            schemas: ['urn:ietf:params:scim:api:messages:2.0:Error'],
             detail: "Unexpected Error. #{e.message}",
-            status: "500"
+            status: '500',
           },
           :internal_server_error
         )
       end
 
-      rescue_from ActiveRecord::RecordNotFound do |e|
+      rescue_from ActiveRecord::RecordNotFound,
+                  Scimaenaga::ExceptionHandler::ResourceNotFound do |e|
         json_response(
           {
-            schemas: ["urn:ietf:params:scim:api:messages:2.0:Error"],
+            schemas: ['urn:ietf:params:scim:api:messages:2.0:Error'],
             detail: "Resource #{e.id} not found.",
-            status: "404"
+            status: '404',
           },
           :not_found
         )
@@ -139,18 +149,18 @@ module ScimRails
         when /has already been taken/
           json_response(
             {
-              schemas: ["urn:ietf:params:scim:api:messages:2.0:Error"],
+              schemas: ['urn:ietf:params:scim:api:messages:2.0:Error'],
               detail: e.message,
-              status: "409"
+              status: '409',
             },
             :conflict
           )
         else
           json_response(
             {
-              schemas: ["urn:ietf:params:scim:api:messages:2.0:Error"],
+              schemas: ['urn:ietf:params:scim:api:messages:2.0:Error'],
               detail: e.message,
-              status: "422"
+              status: '422',
             },
             :unprocessable_entity
           )

data/app/controllers/concerns/scimaenaga/response.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Scimaenaga
+  module Response
+    CONTENT_TYPE = 'application/scim+json'
+
+    def json_response(object, status = :ok)
+      render \
+        json: object,
+        status: status,
+        content_type: CONTENT_TYPE
+    end
+
+    def json_scim_response(object:, status: :ok, counts: nil)
+      case params[:action]
+      when 'index'
+        render \
+          json: list_response(object, counts),
+          status: status,
+          content_type: CONTENT_TYPE
+      when 'show', 'create', 'put_update', 'patch_update'
+        render \
+          json: object_response(object),
+          status: status,
+          content_type: CONTENT_TYPE
+      end
+    end
+
+    private
+
+      def list_response(object, counts)
+        object = object
+                 .order(:id)
+                 .offset(counts.offset)
+                 .limit(counts.limit)
+        {
+          schemas: [
+            'urn:ietf:params:scim:api:messages:2.0:ListResponse'
+          ],
+          totalResults: counts.total,
+          startIndex: counts.start_index,
+          itemsPerPage: counts.limit,
+          Resources: list_objects(object),
+        }
+      end
+
+      def list_objects(objects)
+        objects.map do |object|
+          object_response(object)
+        end
+      end
+
+      def object_response(object)
+        schema = case object
+                 when Scimaenaga.config.scim_users_model
+                   Scimaenaga.config.user_schema
+                 when Scimaenaga.config.scim_groups_model
+                   Scimaenaga.config.group_schema
+                 else
+                   raise Scimaenaga::ExceptionHandler::InvalidQuery,
+                         "Unknown model: #{object}"
+                 end
+        find_value(object, schema)
+      end
+
+      # `find_value` is a recursive method that takes a "user" and a
+      # "user schema" and replaces any symbols in the schema with the
+      # corresponding value from the user. Given a schema with symbols,
+      # `find_value` will search through the object for the symbols,
+      # send those symbols to the model, and replace the symbol with
+      # the return value.
+
+      def find_value(object, schema)
+        case schema
+        when Hash
+          schema.each.with_object({}) do |(key, value), hash|
+            hash[key] = find_value(object, value)
+          end
+        when Array, ActiveRecord::Associations::CollectionProxy
+          schema.map do |value|
+            find_value(object, value)
+          end
+        when Scimaenaga.config.scim_users_model
+          find_value(schema, Scimaenaga.config.user_abbreviated_schema)
+        when Scimaenaga.config.scim_groups_model
+          find_value(schema, Scimaenaga.config.group_abbreviated_schema)
+        when Symbol
+          find_value(object, object.public_send(schema))
+        else
+          schema
+        end
+      end
+  end
+end

data/app/controllers/scimaenaga/application_controller.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Scimaenaga
+  class ApplicationController < ActionController::API
+    include ActionController::HttpAuthentication::Basic::ControllerMethods
+    include ExceptionHandler
+    include Response
+
+    before_action :authorize_request
+
+    private
+
+      def authorize_request
+        send(authentication_strategy) do |searchable_attribute, authentication_attribute|
+          authorization = AuthorizeApiRequest.new(
+            searchable_attribute: searchable_attribute,
+            authentication_attribute: authentication_attribute
+          )
+          @company = authorization.company
+        end
+        raise Scimaenaga::ExceptionHandler::InvalidCredentials if @company.blank?
+      end
+
+      def authentication_strategy
+        if request.headers['Authorization']&.include?('Bearer')
+          :authenticate_with_oauth_bearer
+        else
+          :authenticate_with_http_basic
+        end
+      end
+
+      def authenticate_with_oauth_bearer
+        authentication_attribute = request.headers['Authorization'].split.last
+        payload = Scimaenaga::Encoder.decode(authentication_attribute).with_indifferent_access
+        searchable_attribute = payload[Scimaenaga.config.basic_auth_model_searchable_attribute]
+
+        yield searchable_attribute, authentication_attribute
+      end
+
+      def find_value_for(attribute)
+        params.dig(*path_for(attribute))
+      end
+
+      # `path_for` is a recursive method used to find the "path" for
+      # `.dig` to take when looking for a given attribute in the
+      # params.
+      #
+      # Example: `path_for(:name)` should return an array that looks
+      # like [:names, 0, :givenName]. `.dig` can then use that path
+      # against the params to translate the :name attribute to "John".
+
+      def path_for(attribute, object = controller_schema, path = [])
+        at_path = path.empty? ? object : object.dig(*path)
+        return path if at_path == attribute
+
+        case at_path
+        when Hash
+          at_path.each do |key, _value|
+            found_path = path_for(attribute, object, [*path, key])
+            return found_path if found_path
+          end
+          nil
+        when Array
+          at_path.each_with_index do |_value, index|
+            found_path = path_for(attribute, object, [*path, index])
+            return found_path if found_path
+          end
+          nil
+        end
+      end
+  end
+end

data/app/controllers/{scim_rails → scimaenaga}/scim_groups_controller.rb

@@ -1,27 +1,27 @@
 # frozen_string_literal: true
 
-module ScimRails
-  class ScimGroupsController < ScimRails::ApplicationController
+module Scimaenaga
+  class ScimGroupsController < Scimaenaga::ApplicationController
     def index
       if params[:filter].present?
-        query = ScimRails::ScimQueryParser.new(
-          params[:filter], ScimRails.config.queryable_group_attributes
+        query = Scimaenaga::ScimQueryParser.new(
+          params[:filter], Scimaenaga.config.queryable_group_attributes
         )
 
         groups = @company
-                 .public_send(ScimRails.config.scim_groups_scope)
+                 .public_send(Scimaenaga.config.scim_groups_scope)
                  .where(
-                   "#{ScimRails.config.scim_groups_model
+                   "#{Scimaenaga.config.scim_groups_model
                                .connection.quote_column_name(query.attribute)}
                                #{query.operator} ?",
                    query.parameter
                  )
-                 .order(ScimRails.config.scim_groups_list_order)
+                 .order(Scimaenaga.config.scim_groups_list_order)
       else
         groups = @company
-                 .public_send(ScimRails.config.scim_groups_scope)
+                 .public_send(Scimaenaga.config.scim_groups_scope)
                  .preload(:users)
-                 .order(ScimRails.config.scim_groups_list_order)
+                 .order(Scimaenaga.config.scim_groups_list_order)
       end
 
       counts = ScimCount.new(
@@ -35,14 +35,14 @@ module ScimRails
 
     def show
       group = @company
-              .public_send(ScimRails.config.scim_groups_scope)
+              .public_send(Scimaenaga.config.scim_groups_scope)
               .find(params[:id])
       json_scim_response(object: group)
     end
 
     def create
       group = @company
-              .public_send(ScimRails.config.scim_groups_scope)
+              .public_send(Scimaenaga.config.scim_groups_scope)
               .create!(permitted_group_params)
 
       json_scim_response(object: group, status: :created)
@@ -50,7 +50,7 @@ module ScimRails
 
     def put_update
       group = @company
-              .public_send(ScimRails.config.scim_groups_scope)
+              .public_send(Scimaenaga.config.scim_groups_scope)
               .find(params[:id])
       group.update!(permitted_group_params)
       json_scim_response(object: group)
@@ -58,32 +58,32 @@ module ScimRails
 
     def patch_update
       group = @company
-              .public_send(ScimRails.config.scim_groups_scope)
+              .public_send(Scimaenaga.config.scim_groups_scope)
               .find(params[:id])
-      patch = ScimPatch.new(params, ScimRails.config.mutable_group_attributes_schema)
+      patch = ScimPatch.new(params, :group)
       patch.save(group)
 
       json_scim_response(object: group)
     end
 
     def destroy
-      unless ScimRails.config.group_destroy_method
-        raise ScimRails::ExceptionHandler::InvalidConfiguration
+      unless Scimaenaga.config.group_destroy_method
+        raise Scimaenaga::ExceptionHandler::InvalidConfiguration
       end
 
       group = @company
-              .public_send(ScimRails.config.scim_groups_scope)
+              .public_send(Scimaenaga.config.scim_groups_scope)
               .find(params[:id])
       raise ActiveRecord::RecordNotFound unless group
 
       begin
-        group.public_send(ScimRails.config.group_destroy_method)
+        group.public_send(Scimaenaga.config.group_destroy_method)
       rescue NoMethodError => e
-        raise ScimRails::ExceptionHandler::InvalidConfiguration, e.message
+        raise Scimaenaga::ExceptionHandler::InvalidConfiguration, e.message
       rescue ActiveRecord::RecordNotDestroyed => e
-        raise ScimRails::ExceptionHandler::InvalidRequest, e.message
-      rescue => e
-        raise ScimRails::ExceptionHandler::UnexpectedError, e.message
+        raise Scimaenaga::ExceptionHandler::InvalidRequest, e.message
+      rescue StandardError => e
+        raise Scimaenaga::ExceptionHandler::UnexpectedError, e.message
       end
 
       head :no_content
@@ -102,19 +102,19 @@ module ScimRails
 
       def member_params
         {
-          ScimRails.config.group_member_relation_attribute =>
+          Scimaenaga.config.group_member_relation_attribute =>
             params[:members].map do |member|
-              member[ScimRails.config.group_member_relation_schema.keys.first]
+              member[Scimaenaga.config.group_member_relation_schema.keys.first]
             end,
         }
       end
 
       def mutable_attributes
-        ScimRails.config.mutable_group_attributes
+        Scimaenaga.config.mutable_group_attributes
       end
 
       def controller_schema
-        ScimRails.config.mutable_group_attributes_schema
+        Scimaenaga.config.mutable_group_attributes_schema
       end
   end
 end

data/app/controllers/scimaenaga/scim_schemas_controller.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Scimaenaga
+  class ScimSchemasController < Scimaenaga::ApplicationController
+    def index
+      schemas = Scimaenaga.config.schemas
+
+      counts = ScimCount.new(
+        start_index: params[:startIndex],
+        limit: params[:count],
+        total: schemas.count
+      )
+
+      list_schemas_response(schemas, counts)
+    end
+
+    def show
+      schema = Scimaenaga.config.schemas.find do |s|
+        s[:id] == params[:id]
+      end
+
+      raise Scimaenaga::ExceptionHandler::ResourceNotFound, params[:id] if schema.nil?
+
+      json_response(schema)
+    end
+
+    private
+
+      def list_schemas_response(schemas, counts)
+        response = {
+          schemas: [
+            'urn:ietf:params:scim:api:messages:2.0:ListResponse'
+          ],
+          totalResults: counts.total,
+          startIndex: counts.start_index,
+          itemsPerPage: counts.limit,
+          Resources: schemas[counts.offset...counts.offset + counts.limit],
+        }
+        json_response(response)
+      end
+  end
+end