scimitar 1.0.0

data/spec/requests/application_controller_spec.rb

@@ -0,0 +1,49 @@
+# Some tests require the more flexible driver methods for 'get', 'post'
+# etc. than available in RSpec controller tests.
+#
+# See also spec/controllers/scimitar/application_controller_spec.rb.
+#
+require 'spec_helper'
+
+RSpec.describe Scimitar::ApplicationController do
+  before :each do
+    allow_any_instance_of(Scimitar::ApplicationController).to receive(:authenticated?).and_return(true)
+  end
+
+  context 'format handling' do
+    it 'renders "not acceptable" if the request does not use SCIM type' do
+      get '/CustomRequestVerifiers', params: { format: :html }
+
+      expect(response).to have_http_status(:not_acceptable)
+      expect(JSON.parse(response.body)['detail']).to eql('Only application/scim+json type is accepted.')
+    end
+
+    it 'renders 400 if given bad JSON' do
+      post '/CustomRequestVerifiers', params: 'not-json-12345', headers: { 'CONTENT_TYPE' => 'application/scim+json' }
+
+      expect(response).to have_http_status(:bad_request)
+      expect(JSON.parse(response.body)['detail']).to start_with('Invalid JSON - ')
+      expect(JSON.parse(response.body)['detail']).to include("'not-json-12345'")
+    end
+
+    it 'translates Content-Type to Rails request format' do
+      get '/CustomRequestVerifiers', headers: { 'CONTENT_TYPE' => 'application/scim+json' }
+
+      expect(response).to have_http_status(:ok)
+      parsed_body = JSON.parse(response.body)
+      expect(parsed_body['request']['is_scim'     ]).to eql(true)
+      expect(parsed_body['request']['format'      ]).to eql('application/scim+json')
+      expect(parsed_body['request']['content_type']).to eql('application/scim+json')
+    end
+
+    it 'translates Rails request format to header' do
+      get '/CustomRequestVerifiers', params: { format: :scim }
+
+      expect(response).to have_http_status(:ok)
+      parsed_body = JSON.parse(response.body)
+      expect(parsed_body['request']['is_scim'     ]).to eql(true)
+      expect(parsed_body['request']['format'      ]).to eql('application/scim+json')
+      expect(parsed_body['request']['content_type']).to eql('application/scim+json')
+    end
+  end
+end

data/spec/requests/controller_configuration_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+RSpec.describe 'Controller configuration' do
+  before :each do
+    allow_any_instance_of(Scimitar::ApplicationController).to receive(:authenticated?).and_return(true)
+  end
+
+  context 'application_controller_mixin' do
+    it 'the test before-action declared in configuration gets called' do
+      expect_any_instance_of(MockUsersController).to receive(:test_hook)
+
+      get '/Users', params: { format: :scim }
+
+      expect(response).to be_ok
+    end
+  end # "context 'application_controller_mixin' do"
+end

data/spec/requests/engine_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+RSpec.describe Scimitar::Engine do
+  before :each do
+    allow_any_instance_of(Scimitar::ApplicationController).to receive(:authenticated?).and_return(true)
+  end
+
+  context 'parameter parser' do
+
+    # "params" given here as a String, expecting the engine's custom parser to
+    # decode it for us.
+    #
+    it 'decodes JSON', type: :model do
+      post '/Users.scim', params: '{"userName": "foo"}', headers: { 'CONTENT_TYPE' => 'application/scim+json' }
+
+      expect(response.status).to eql(201)
+      expect(JSON.parse(response.body)['userName']).to eql('foo')
+    end
+  end # "context 'parameter parser' do"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,66 @@
+# ============================================================================
+# PREAMBLE
+# ============================================================================
+
+# Get code coverage reports:
+#
+# https://github.com/colszowka/simplecov#getting-started
+#
+# "Load and launch SimpleCov at the very top of your test/test_helper.rb (or
+#  spec_helper.rb [...])"
+#
+require 'simplecov'
+SimpleCov.start 'rails'
+
+# Rails stuff is related to the self-test applications in 'spec/apps'.
+#
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../apps/dummy/config/environment', __FILE__)
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+
+require 'rspec/rails'
+require 'byebug'
+require 'scimitar'
+
+# ============================================================================
+# MAIN RSPEC CONFIGURATION
+# ============================================================================
+
+RSpec.configure do | config |
+  config.disable_monkey_patching!
+  config.infer_spec_type_from_file_location!
+  config.filter_rails_from_backtrace!
+
+  config.color                      = true
+  config.tty                        = true
+  config.order                      = :random
+  config.fixture_path               = "#{::Rails.root}/spec/fixtures"
+  config.use_transactional_fixtures = true
+
+  Kernel.srand config.seed
+end
+
+# ============================================================================
+# MISCELLANEOUS UTILITIES
+# ============================================================================
+
+# Capture stdout from running a given block.
+#
+def spec_helper_capture_stdout( &block )
+  result = ''
+
+  begin
+    old_stdout = $stdout
+    $stdout = StringIO.new
+
+    yield
+
+    result = $stdout.string
+
+  ensure
+    $stdout = old_stdout
+
+  end
+
+  return result
+end

metadata

@@ -0,0 +1,315 @@
+--- !ruby/object:Gem::Specification
+name: scimitar
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- RIP Global
+- Andrew David Hodgkinson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: doggo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: SCIM v2 support for Users and Groups in Ruby On Rails
+email:
+- andrew@ripglobal.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- app/controllers/scimitar/active_record_backed_resources_controller.rb
+- app/controllers/scimitar/application_controller.rb
+- app/controllers/scimitar/resource_types_controller.rb
+- app/controllers/scimitar/resources_controller.rb
+- app/controllers/scimitar/schemas_controller.rb
+- app/controllers/scimitar/service_provider_configurations_controller.rb
+- app/models/scimitar/authentication_error.rb
+- app/models/scimitar/authentication_scheme.rb
+- app/models/scimitar/bulk.rb
+- app/models/scimitar/complex_types/address.rb
+- app/models/scimitar/complex_types/base.rb
+- app/models/scimitar/complex_types/email.rb
+- app/models/scimitar/complex_types/entitlement.rb
+- app/models/scimitar/complex_types/ims.rb
+- app/models/scimitar/complex_types/name.rb
+- app/models/scimitar/complex_types/phone_number.rb
+- app/models/scimitar/complex_types/photo.rb
+- app/models/scimitar/complex_types/reference_group.rb
+- app/models/scimitar/complex_types/reference_member.rb
+- app/models/scimitar/complex_types/role.rb
+- app/models/scimitar/complex_types/x509_certificate.rb
+- app/models/scimitar/engine_configuration.rb
+- app/models/scimitar/error_response.rb
+- app/models/scimitar/errors.rb
+- app/models/scimitar/filter.rb
+- app/models/scimitar/filter_error.rb
+- app/models/scimitar/invalid_syntax_error.rb
+- app/models/scimitar/lists/count.rb
+- app/models/scimitar/lists/query_parser.rb
+- app/models/scimitar/meta.rb
+- app/models/scimitar/not_found_error.rb
+- app/models/scimitar/resource_invalid_error.rb
+- app/models/scimitar/resource_type.rb
+- app/models/scimitar/resources/base.rb
+- app/models/scimitar/resources/group.rb
+- app/models/scimitar/resources/mixin.rb
+- app/models/scimitar/resources/user.rb
+- app/models/scimitar/schema/address.rb
+- app/models/scimitar/schema/attribute.rb
+- app/models/scimitar/schema/base.rb
+- app/models/scimitar/schema/derived_attributes.rb
+- app/models/scimitar/schema/email.rb
+- app/models/scimitar/schema/entitlement.rb
+- app/models/scimitar/schema/group.rb
+- app/models/scimitar/schema/ims.rb
+- app/models/scimitar/schema/name.rb
+- app/models/scimitar/schema/phone_number.rb
+- app/models/scimitar/schema/photo.rb
+- app/models/scimitar/schema/reference_group.rb
+- app/models/scimitar/schema/reference_member.rb
+- app/models/scimitar/schema/role.rb
+- app/models/scimitar/schema/user.rb
+- app/models/scimitar/schema/vdtp.rb
+- app/models/scimitar/schema/x509_certificate.rb
+- app/models/scimitar/service_provider_configuration.rb
+- app/models/scimitar/supportable.rb
+- app/views/layouts/scimitar/application.html.erb
+- config/initializers/scimitar.rb
+- config/routes.rb
+- lib/scimitar.rb
+- lib/scimitar/engine.rb
+- lib/scimitar/version.rb
+- spec/apps/dummy/app/controllers/custom_destroy_mock_users_controller.rb
+- spec/apps/dummy/app/controllers/custom_request_verifiers_controller.rb
+- spec/apps/dummy/app/controllers/mock_groups_controller.rb
+- spec/apps/dummy/app/controllers/mock_users_controller.rb
+- spec/apps/dummy/app/models/mock_group.rb
+- spec/apps/dummy/app/models/mock_user.rb
+- spec/apps/dummy/config/application.rb
+- spec/apps/dummy/config/boot.rb
+- spec/apps/dummy/config/environment.rb
+- spec/apps/dummy/config/environments/test.rb
+- spec/apps/dummy/config/initializers/cookies_serializer.rb
+- spec/apps/dummy/config/initializers/scimitar.rb
+- spec/apps/dummy/config/initializers/session_store.rb
+- spec/apps/dummy/config/routes.rb
+- spec/apps/dummy/db/migrate/20210304014602_create_mock_users.rb
+- spec/apps/dummy/db/migrate/20210308020313_create_mock_groups.rb
+- spec/apps/dummy/db/migrate/20210308044214_create_join_table_mock_groups_mock_users.rb
+- spec/apps/dummy/db/schema.rb
+- spec/controllers/scimitar/application_controller_spec.rb
+- spec/controllers/scimitar/resource_types_controller_spec.rb
+- spec/controllers/scimitar/resources_controller_spec.rb
+- spec/controllers/scimitar/schemas_controller_spec.rb
+- spec/controllers/scimitar/service_provider_configurations_controller_spec.rb
+- spec/models/scimitar/complex_types/address_spec.rb
+- spec/models/scimitar/complex_types/email_spec.rb
+- spec/models/scimitar/lists/count_spec.rb
+- spec/models/scimitar/lists/query_parser_spec.rb
+- spec/models/scimitar/resource_type_spec.rb
+- spec/models/scimitar/resources/base_spec.rb
+- spec/models/scimitar/resources/base_validation_spec.rb
+- spec/models/scimitar/resources/mixin_spec.rb
+- spec/models/scimitar/resources/user_spec.rb
+- spec/models/scimitar/schema/attribute_spec.rb
+- spec/models/scimitar/schema/base_spec.rb
+- spec/models/scimitar/schema/group_spec.rb
+- spec/models/scimitar/schema/user_spec.rb
+- spec/requests/active_record_backed_resources_controller_spec.rb
+- spec/requests/application_controller_spec.rb
+- spec/requests/controller_configuration_spec.rb
+- spec/requests/engine_spec.rb
+- spec/spec_helper.rb
+homepage: https://ripglobal.com/
+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.7.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: SCIM v2 for Rails
+test_files:
+- spec/spec_helper.rb
+- spec/models/scimitar/lists/query_parser_spec.rb
+- spec/models/scimitar/lists/count_spec.rb
+- spec/models/scimitar/resources/base_validation_spec.rb
+- spec/models/scimitar/resources/mixin_spec.rb
+- spec/models/scimitar/resources/user_spec.rb
+- spec/models/scimitar/resources/base_spec.rb
+- spec/models/scimitar/schema/attribute_spec.rb
+- spec/models/scimitar/schema/group_spec.rb
+- spec/models/scimitar/schema/user_spec.rb
+- spec/models/scimitar/schema/base_spec.rb
+- spec/models/scimitar/resource_type_spec.rb
+- spec/models/scimitar/complex_types/email_spec.rb
+- spec/models/scimitar/complex_types/address_spec.rb
+- spec/requests/controller_configuration_spec.rb
+- spec/requests/engine_spec.rb
+- spec/requests/active_record_backed_resources_controller_spec.rb
+- spec/requests/application_controller_spec.rb
+- spec/controllers/scimitar/schemas_controller_spec.rb
+- spec/controllers/scimitar/resource_types_controller_spec.rb
+- spec/controllers/scimitar/resources_controller_spec.rb
+- spec/controllers/scimitar/service_provider_configurations_controller_spec.rb
+- spec/controllers/scimitar/application_controller_spec.rb
+- spec/apps/dummy/app/models/mock_group.rb
+- spec/apps/dummy/app/models/mock_user.rb
+- spec/apps/dummy/app/controllers/custom_request_verifiers_controller.rb
+- spec/apps/dummy/app/controllers/custom_destroy_mock_users_controller.rb
+- spec/apps/dummy/app/controllers/mock_groups_controller.rb
+- spec/apps/dummy/app/controllers/mock_users_controller.rb
+- spec/apps/dummy/config/routes.rb
+- spec/apps/dummy/config/environments/test.rb
+- spec/apps/dummy/config/environment.rb
+- spec/apps/dummy/config/application.rb
+- spec/apps/dummy/config/boot.rb
+- spec/apps/dummy/config/initializers/session_store.rb
+- spec/apps/dummy/config/initializers/cookies_serializer.rb
+- spec/apps/dummy/config/initializers/scimitar.rb
+- spec/apps/dummy/db/schema.rb
+- spec/apps/dummy/db/migrate/20210308020313_create_mock_groups.rb
+- spec/apps/dummy/db/migrate/20210308044214_create_join_table_mock_groups_mock_users.rb
+- spec/apps/dummy/db/migrate/20210304014602_create_mock_users.rb