scim_engine 1.0.0

data/spec/models/scim_engine/schema/base_spec.rb

@@ -0,0 +1,19 @@
+require 'rails_helper'
+
+describe ScimEngine::Schema::Base do
+  describe '#as_json' do
+    it 'converts the scim_attributes to attributes' do
+      attribute = ScimEngine::Schema::Attribute.new(name: 'nickName')
+      schema = described_class.new(scim_attributes: [attribute])
+      expect(schema.as_json['attributes']).to eql([attribute.as_json])
+      expect(schema.as_json['scim_attributes']).to be_nil
+    end
+  end
+
+  describe '#initialize' do
+    it 'creates a meta' do
+      schema = described_class.new
+      expect(schema.meta.resourceType).to eql('Schema')
+    end
+  end
+end

data/spec/models/scim_engine/schema/group_spec.rb

@@ -0,0 +1,66 @@
+require 'rails_helper'
+
+describe ScimEngine::Schema::Group do
+  it 'returns Group schema as JSON' do
+    expected_json = <<-EOJ
+    {
+    "name": "Group",
+    "id": "urn:ietf:params:scim:schemas:core:2.0:Group",
+    "description": "Represents a Group",
+    "meta": {
+      "resourceType": "Schema",
+      "location": "/scim_engine/Schemas?name=urn%3Aietf%3Aparams%3Ascim%3Aschemas%3Acore%3A2.0%3AGroup"
+    },
+    "attributes": [
+      {
+        "multiValued": false,
+        "required": true,
+        "caseExact": false,
+        "mutability": "readWrite",
+        "uniqueness": "none",
+        "returned": "default",
+        "name": "displayName",
+        "type": "string"
+      },
+      {
+        "multiValued": true,
+        "required": false,
+        "caseExact": false,
+        "mutability": "readOnly",
+        "uniqueness": "none",
+        "returned": "default",
+        "name": "members",
+        "type": "complex",
+        "subAttributes": [
+          {
+            "multiValued": false,
+            "required": true,
+            "caseExact": false,
+            "mutability": "readOnly",
+            "uniqueness": "none",
+            "returned": "default",
+            "name": "value",
+            "type": "string"
+          },
+          {
+            "multiValued": false,
+            "required": false,
+            "caseExact": false,
+            "mutability": "readOnly",
+            "uniqueness": "none",
+            "returned": "default",
+            "name": "display",
+            "type": "string"
+          }
+        ]
+      }
+    ]
+  }
+    EOJ
+
+    group_schema = ScimEngine::Schema::Group.new
+
+    expect(JSON.parse(expected_json)).to eql(JSON.parse(group_schema.to_json))
+
+  end
+end

data/spec/models/scim_engine/schema/user_spec.rb

@@ -0,0 +1,140 @@
+require 'rails_helper'
+
+describe ScimEngine::Schema::User do
+  it 'returns User schema as JSON' do
+    expected_json = <<-EOJ
+    [
+      {
+        "multiValued": false,
+        "required": true,
+        "caseExact": false,
+        "mutability": "readWrite",
+        "uniqueness": "server",
+        "returned": "default",
+        "name": "userName",
+        "type": "string"
+      },
+      {
+        "multiValued": false,
+        "required": true,
+        "caseExact": false,
+        "mutability": "readWrite",
+        "uniqueness": "none",
+        "returned": "default",
+        "name": "name",
+        "type": "complex",
+        "subAttributes": [
+          {
+            "multiValued": false,
+            "required": true,
+            "caseExact": false,
+            "mutability": "readWrite",
+            "uniqueness": "none",
+            "returned": "default",
+            "name": "familyName",
+            "type": "string"
+          },
+          {
+            "multiValued": false,
+            "required": true,
+            "caseExact": false,
+            "mutability": "readWrite",
+            "uniqueness": "none",
+            "returned": "default",
+            "name": "givenName",
+            "type": "string"
+          },
+          {
+            "multiValued": false,
+            "required": false,
+            "caseExact": false,
+            "mutability": "readWrite",
+            "uniqueness": "none",
+            "returned": "default",
+            "name": "formatted",
+            "type": "string"
+          }
+        ]
+      },
+      {
+        "multiValued": true,
+        "required": true,
+        "caseExact": false,
+        "mutability": "readWrite",
+        "uniqueness": "none",
+        "returned": "default",
+        "name": "emails",
+        "type": "complex",
+        "subAttributes": [
+          {
+            "multiValued": false,
+            "required": true,
+            "caseExact": false,
+            "mutability": "readWrite",
+            "uniqueness": "none",
+            "returned": "default",
+            "name": "value",
+            "type": "string"
+          },
+          {
+            "multiValued": false,
+            "required": false,
+            "caseExact": false,
+            "mutability": "readWrite",
+            "uniqueness": "none",
+            "returned": "default",
+            "name": "primary",
+            "type": "boolean"
+          },
+          {
+            "multiValued": false,
+            "required": false,
+            "caseExact": false,
+            "mutability": "readWrite",
+            "uniqueness": "none",
+            "returned": "default",
+            "name": "type",
+            "type": "string"
+          }
+        ]
+      },
+      {
+        "multiValued": true,
+        "required": true,
+        "caseExact": false,
+        "mutability": "immutable",
+        "uniqueness": "none",
+        "returned": "default",
+        "name": "groups",
+        "type": "complex",
+        "subAttributes": [
+          {
+            "multiValued": false,
+            "required": true,
+            "caseExact": false,
+            "mutability": "readOnly",
+            "uniqueness": "none",
+            "returned": "default",
+            "name": "value",
+            "type": "string"
+          },
+          {
+            "multiValued": false,
+            "required": false,
+            "caseExact": false,
+            "mutability": "readOnly",
+            "uniqueness": "none",
+            "returned": "default",
+            "name": "display",
+            "type": "string"
+          }
+        ]
+      }
+    ]
+    EOJ
+
+    expect(JSON.parse(expected_json)).to eql(JSON.parse(ScimEngine::Schema::User.scim_attributes.to_json))
+
+  end
+
+end

data/spec/rails_helper.rb

@@ -0,0 +1,57 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+require 'spec_helper'
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../dummy/config/environment', __FILE__)
+# Prevent database truncation if the environment is production
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+require 'rspec/rails'
+require 'byebug'
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+# Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
+
+# Checks for pending migrations and applies them before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace("gem name")
+end

data/spec/spec_helper.rb

@@ -0,0 +1,99 @@
+require 'factory_bot_rails'
+
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+  config.include FactoryBot::Syntax::Methods
+end

metadata

@@ -0,0 +1,246 @@
+--- !ruby/object:Gem::Specification
+name: scim_engine
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- ''
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.7.2
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.8.2
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.11.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.11.1
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.0.2
+description: |-
+  There's no general purpose SCIM SDK for Ruby on Rails. As a result, anyone implementing SCIM will need to take care of the SCIM schema and
+  protocol, which may take a significant overhead compared the implementation of the actual APIs. This project aims to extract SCIM specifics as a rails engine that can be plugged into a Ruby on Rails project.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- app/controllers/scim_engine/application_controller.rb
+- app/controllers/scim_engine/resource_types_controller.rb
+- app/controllers/scim_engine/resources_controller.rb
+- app/controllers/scim_engine/schemas_controller.rb
+- app/controllers/scim_engine/service_provider_configurations_controller.rb
+- app/models/scim_engine/authentication_error.rb
+- app/models/scim_engine/authentication_scheme.rb
+- app/models/scim_engine/bulk.rb
+- app/models/scim_engine/complex_types/base.rb
+- app/models/scim_engine/complex_types/email.rb
+- app/models/scim_engine/complex_types/name.rb
+- app/models/scim_engine/complex_types/reference.rb
+- app/models/scim_engine/error_response.rb
+- app/models/scim_engine/errors.rb
+- app/models/scim_engine/filter.rb
+- app/models/scim_engine/meta.rb
+- app/models/scim_engine/not_found_error.rb
+- app/models/scim_engine/resource_invalid_error.rb
+- app/models/scim_engine/resource_type.rb
+- app/models/scim_engine/resources/base.rb
+- app/models/scim_engine/resources/group.rb
+- app/models/scim_engine/resources/user.rb
+- app/models/scim_engine/schema/attribute.rb
+- app/models/scim_engine/schema/base.rb
+- app/models/scim_engine/schema/derived_attributes.rb
+- app/models/scim_engine/schema/email.rb
+- app/models/scim_engine/schema/group.rb
+- app/models/scim_engine/schema/name.rb
+- app/models/scim_engine/schema/reference.rb
+- app/models/scim_engine/schema/user.rb
+- app/models/scim_engine/service_provider_configuration.rb
+- app/models/scim_engine/supportable.rb
+- app/views/layouts/scim_engine/application.html.erb
+- config/routes.rb
+- lib/scim_engine.rb
+- lib/scim_engine/engine.rb
+- lib/scim_engine/version.rb
+- lib/tasks/scim_engine_tasks.rake
+- spec/controllers/scim_engine/application_controller_spec.rb
+- spec/controllers/scim_engine/resource_types_controller_spec.rb
+- spec/controllers/scim_engine/resources_controller_spec.rb
+- spec/controllers/scim_engine/schemas_controller_spec.rb
+- spec/controllers/scim_engine/service_provider_configurations_controller_spec.rb
+- spec/dummy/README.rdoc
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/to_time_preserves_timezone.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/config/secrets.yml
+- spec/dummy/log/test.log
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/models/scim_engine/complex_types/email_spec.rb
+- spec/models/scim_engine/resource_type_spec.rb
+- spec/models/scim_engine/resources/base_spec.rb
+- spec/models/scim_engine/resources/base_validation_spec.rb
+- spec/models/scim_engine/resources/user_spec.rb
+- spec/models/scim_engine/schema/attribute_spec.rb
+- spec/models/scim_engine/schema/base_spec.rb
+- spec/models/scim_engine/schema/group_spec.rb
+- spec/models/scim_engine/schema/user_spec.rb
+- spec/rails_helper.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Cisco-AMP/scim_engine
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A general purpase SCIM implementation that could be plugged into rails applications
+  as an engine to provide SCIM functionality.
+test_files:
+- spec/spec_helper.rb
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/config/secrets.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/to_time_preserves_timezone.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config.ru
+- spec/dummy/Rakefile
+- spec/dummy/public/favicon.ico
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/404.html
+- spec/dummy/log/test.log
+- spec/dummy/README.rdoc
+- spec/models/scim_engine/resources/base_validation_spec.rb
+- spec/models/scim_engine/resources/user_spec.rb
+- spec/models/scim_engine/resources/base_spec.rb
+- spec/models/scim_engine/schema/attribute_spec.rb
+- spec/models/scim_engine/schema/group_spec.rb
+- spec/models/scim_engine/schema/user_spec.rb
+- spec/models/scim_engine/schema/base_spec.rb
+- spec/models/scim_engine/resource_type_spec.rb
+- spec/models/scim_engine/complex_types/email_spec.rb
+- spec/controllers/scim_engine/schemas_controller_spec.rb
+- spec/controllers/scim_engine/resource_types_controller_spec.rb
+- spec/controllers/scim_engine/resources_controller_spec.rb
+- spec/controllers/scim_engine/service_provider_configurations_controller_spec.rb
+- spec/controllers/scim_engine/application_controller_spec.rb
+- spec/rails_helper.rb