scim_rails 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69ddfe751f11e33adf91e96b99ccaaa7258bb1468ea8463511ae0b04eaeca4bf
-  data.tar.gz: ac7a95b8e8f7c5455bdf7b9a64d3b2c88c015974530077f80ab37a1e6751e468
+  metadata.gz: a512e0428de106c5cca2fcd17935cdbf27ac9b1cb9e1c3300e97fd938c64e834
+  data.tar.gz: fdb2be8912304c726a4238d4b890c231d9224133cb793014bcb0bb90df41037a
 SHA512:
-  metadata.gz: 05d83eb5dee1ecbfa49116f5d1f70e5f4e600393419055d93dfdff8e735e865ef2eeedf15b73c5899543f47168763b7f7cf13b897ba53e80332d7d813b427219
-  data.tar.gz: be1735ff8d1de4d79d5aa70c39b0cffdbc22f26d7adc105e5c03ec2fc61953d00a7ba363b0e59b57adf3aae3f32a880275eac00eaf5874adae789954ea22c3f1
+  metadata.gz: 6b1e54f6ccfc8709849313936376fbc07964afc2b45faf8c39d901857cc66a4577c77904f425bd2ed3d5811fd642621f5e5e9197e13d48da2a5a83a61cf52332
+  data.tar.gz: 74a09e8f9383023ec5b3f0d5d328ba3bd385faac1b4878efdae1c6ddd0fc184eaa053eac567e491e2991caae576c19a102352efd266f04be3efbcf6158b235ce

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.com/lessonly/scim_rails.svg?branch=master)](https://travis-ci.com/lessonly/scim_rails)
+
 # ScimRails
 
 NOTE: This Gem is not yet fully SCIM complaint. It was developed with the main function of interfacing with Okta. There are features of SCIM that this Gem does not implement as described in the SCIM documentation or that have been left out completely.
@@ -246,6 +248,20 @@ Sample request:
 $ curl -X PATCH 'http://username:password@localhost:3000/scim/v2/Users/1' -d '{"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"], "Operations": [{"op": "replace", "value": { "active": false }}]}' -H 'Content-Type: application/scim+json'
 ```
 
+### Error Handling
+
+By default, scim_rails will output any unhandled exceptions to your configured rails logs.
+
+If you would like, you can supply a custom handler for exceptions in the initializer. The only requirement is that the value you supply responds to `#call`.
+
+For example, you might want to notify Honeybadger:
+
+```ruby
+ScimRails.configure do |config|
+  config.on_error = ->(e) { Honeybadger.notify(e) }
+end
+```
+
 ## Contributing
 
 ### [Code of Conduct](https://github.com/lessonly/scim_rails/blob/master/CODE_OF_CONDUCT.md)

data/Rakefile

@@ -14,7 +14,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
 load 'rails/tasks/engine.rake'
 
 

data/app/controllers/concerns/scim_rails/exception_handler.rb

@@ -12,12 +12,15 @@ module ScimRails
     end
 
     included do
-      # StandardError must be ordered _first_ or it will catch all exceptions
-      #
-      # TODO: Build a plugin/configuration for error handling so that the
-      # detailed production errors are logged somewhere if desired.
       if Rails.env.production?
-        rescue_from StandardError do
+        rescue_from StandardError do |exception|
+          on_error = ScimRails.config.on_error
+          if on_error.respond_to?(:call)
+            on_error.call(exception)
+          else
+            Rails.logger.error(exception.inspect)
+          end
+
           json_response(
             {
               schemas: ["urn:ietf:params:scim:api:messages:2.0:Error"],

data/app/controllers/scim_rails/scim_users_controller.rb

@@ -126,9 +126,23 @@ module ScimRails
     end
 
     def patch_active_param
-      active = params.dig("Operations", 0, "value", "active")
-      raise ScimRails::ExceptionHandler::UnsupportedPatchRequest if active.nil?
-      active
+      handle_invalid = lambda do
+        raise ScimRails::ExceptionHandler::UnsupportedPatchRequest
+      end
+
+      operations = params["Operations"] || {}
+
+      valid_operation = operations.find(handle_invalid) do |operation|
+        valid_patch_operation?(operation)
+      end
+
+      valid_operation.dig("value", "active")
+    end
+
+    def valid_patch_operation?(operation)
+      operation["op"].casecmp("replace") &&
+        operation["value"] &&
+        [true, false].include?(operation["value"]["active"])
     end
   end
 end

data/lib/generators/scim_rails/templates/initializer.rb

@@ -14,7 +14,7 @@ ScimRails.configure do |config|
   # Model used for user records.
   config.scim_users_model = "User"
 
-  # Metod used for retriving user records from the
+  # Method used for retrieving user records from the
   # authenticatable model.
   config.scim_users_scope = :users
 

data/lib/scim_rails/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ScimRails
   class << self
     def configure
@@ -5,22 +7,26 @@ module ScimRails
     end
 
     def config
-      @_config ||= Config.new
+      @config ||= Config.new
     end
   end
 
+  # Class containing configuration of ScimRails
   class Config
-    ALGO_NONE = "none".freeze
+    ALGO_NONE = "none"
 
-    attr_accessor \
+    attr_writer \
       :basic_auth_model,
+      :mutable_user_attributes_schema,
+      :scim_users_model
+
+    attr_accessor \
       :basic_auth_model_authenticatable_attribute,
       :basic_auth_model_searchable_attribute,
       :mutable_user_attributes,
-      :mutable_user_attributes_schema,
+      :on_error,
       :queryable_user_attributes,
       :scim_users_list_order,
-      :scim_users_model,
       :scim_users_scope,
       :scim_user_prevent_update_on_create,
       :signing_secret,

data/lib/scim_rails/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ScimRails
-  VERSION = '0.3.0'
+  VERSION = "0.3.1"
 end

data/spec/controllers/scim_rails/scim_users_controller_spec.rb

@@ -10,13 +10,13 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
 
     context "when unauthorized" do
       it "returns scim+json content type" do
-        get :index
+        get :index, as: :json
 
-        expect(response.content_type).to eq "application/scim+json"
+        expect(response.media_type).to eq "application/scim+json"
       end
 
       it "fails with no credentials" do
-        get :index
+        get :index, as: :json
 
         expect(response.status).to eq 401
       end
@@ -24,7 +24,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
       it "fails with invalid credentials" do
         request.env['HTTP_AUTHORIZATION'] = ActionController::HttpAuthentication::Basic.encode_credentials("unauthorized","123456")
 
-        get :index
+        get :index, as: :json
 
         expect(response.status).to eq 401
       end
@@ -36,13 +36,13 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
       end
 
       it "returns scim+json content type" do
-        get :index
+        get :index, as: :json
 
-        expect(response.content_type).to eq "application/scim+json"
+        expect(response.media_type).to eq "application/scim+json"
       end
 
       it "is successful with valid credentials" do
-        get :index
+        get :index, as: :json
 
         expect(response.status).to eq 200
       end
@@ -50,7 +50,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
       it "returns all results" do
         create_list(:user, 10, company: company)
 
-        get :index
+        get :index, as: :json
         response_body = JSON.parse(response.body)
         expect(response_body.dig("schemas", 0)).to eq "urn:ietf:params:scim:api:messages:2.0:ListResponse"
         expect(response_body["totalResults"]).to eq 10
@@ -59,7 +59,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
       it "defaults to 100 results" do
         create_list(:user, 300, company: company)
 
-        get :index
+        get :index, as: :json
         response_body = JSON.parse(response.body)
         expect(response_body["totalResults"]).to eq 300
         expect(response_body["Resources"].count).to eq 100
@@ -72,7 +72,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
         get :index, params: {
           startIndex: 101,
           count: 200,
-        }
+        }, as: :json
         response_body = JSON.parse(response.body)
         expect(response_body["totalResults"]).to eq 400
         expect(response_body["Resources"].count).to eq 200
@@ -88,7 +88,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
         get :index, params: {
           startIndex: 1,
           count: 10,
-        }
+        }, as: :json
         response_body = JSON.parse(response.body)
         expect(response_body["totalResults"]).to eq 400
         expect(response_body["Resources"].count).to eq 10
@@ -101,7 +101,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
 
         get :index, params: {
           filter: "email eq test1@example.com"
-        }
+        }, as: :json
         response_body = JSON.parse(response.body)
         expect(response_body["totalResults"]).to eq 1
         expect(response_body["Resources"].count).to eq 1
@@ -113,7 +113,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
 
         get :index, params: {
           filter: "familyName eq Shellstrop"
-        }
+        }, as: :json
         response_body = JSON.parse(response.body)
         expect(response_body["totalResults"]).to eq 1
         expect(response_body["Resources"].count).to eq 1
@@ -122,7 +122,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
       it "returns no results for unfound filter parameters" do
         get :index, params: {
           filter: "familyName eq fake_not_there"
-        }
+        }, as: :json
         response_body = JSON.parse(response.body)
         expect(response_body["totalResults"]).to eq 0
         expect(response_body["Resources"].count).to eq 0
@@ -131,7 +131,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
       it "returns no results for undefined filter queries" do
         get :index, params: {
           filter: "address eq 101 Nowhere USA"
-        }
+        }, as: :json
         expect(response.status).to eq 400
         response_body = JSON.parse(response.body)
         expect(response_body.dig("schemas", 0)).to eq "urn:ietf:params:scim:api:messages:2.0:Error"
@@ -145,13 +145,13 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
 
     context "when unauthorized" do
       it "returns scim+json content type" do
-        get :show, params: { id: 1 }
+        get :show, params: { id: 1 }, as: :json
 
-        expect(response.content_type).to eq "application/scim+json"
+        expect(response.media_type).to eq "application/scim+json"
       end
 
       it "fails with no credentials" do
-        get :show, params: { id: 1 }
+        get :show, params: { id: 1 }, as: :json
 
         expect(response.status).to eq 401
       end
@@ -159,7 +159,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
       it "fails with invalid credentials" do
         request.env['HTTP_AUTHORIZATION'] = ActionController::HttpAuthentication::Basic.encode_credentials("unauthorized","123456")
 
-        get :show, params: { id: 1 }
+        get :show, params: { id: 1 }, as: :json
 
         expect(response.status).to eq 401
       end
@@ -171,20 +171,20 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
       end
 
       it "returns scim+json content type" do
-        get :show, params: { id: 1 }
+        get :show, params: { id: 1 }, as: :json
 
-        expect(response.content_type).to eq "application/scim+json"
+        expect(response.media_type).to eq "application/scim+json"
       end
 
       it "is successful with valid credentials" do
         create(:user, id: 1, company: company)
-        get :show, params: { id: 1 }
+        get :show, params: { id: 1 }, as: :json
 
         expect(response.status).to eq 200
       end
 
       it "returns :not_found for id that cannot be found" do
-        get :show, params: { id: "fake_id" }
+        get :show, params: { id: "fake_id" }, as: :json
 
         expect(response.status).to eq 404
       end
@@ -193,7 +193,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
         new_company = create(:company)
         create(:user, company: new_company, id: 1)
 
-        get :show, params: { id: 1 }
+        get :show, params: { id: 1 }, as: :json
 
         expect(response.status).to eq 404
       end
@@ -206,13 +206,13 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
 
     context "when unauthorized" do
       it "returns scim+json content type" do
-        post :create
+        post :create, as: :json
 
-        expect(response.content_type).to eq "application/scim+json"
+        expect(response.media_type).to eq "application/scim+json"
       end
 
       it "fails with no credentials" do
-        post :create
+        post :create, as: :json
 
         expect(response.status).to eq 401
       end
@@ -220,7 +220,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
       it "fails with invalid credentials" do
         request.env['HTTP_AUTHORIZATION'] = ActionController::HttpAuthentication::Basic.encode_credentials("unauthorized","123456")
 
-        post :create
+        post :create, as: :json
 
         expect(response.status).to eq 401
       end
@@ -242,9 +242,9 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
               value: "new@example.com"
             }
           ]
-        }
+        }, as: :json
 
-        expect(response.content_type).to eq "application/scim+json"
+        expect(response.media_type).to eq "application/scim+json"
       end
 
       it "is successful with valid credentials" do
@@ -260,7 +260,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
               value: "new@example.com"
             }
           ]
-        }
+        }, as: :json
 
         expect(response.status).to eq 201
         expect(company.users.count).to eq 1
@@ -283,7 +283,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
               value: "new@example.com"
             }
           ]
-        }
+        }, as: :json
 
         expect(response.status).to eq 201
         expect(company.users.count).to eq 1
@@ -299,7 +299,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
               value: "new@example.com"
             }
           ]
-        }
+        }, as: :json
 
         expect(response.status).to eq 422
         expect(company.users.count).to eq 0
@@ -318,7 +318,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
               value: "new@example.com"
             }
           ]
-        }
+        }, as: :json
 
         expect(response.status).to eq 201
         expect(company.users.count).to eq 1
@@ -339,7 +339,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
               value: "new@example.com"
             }
           ]
-        }
+        }, as: :json
 
         expect(response.status).to eq 409
         expect(company.users.count).to eq 1
@@ -359,7 +359,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
             },
           ],
           active: "false"
-        }
+        }, as: :json
 
         expect(response.status).to eq 201
         expect(company.users.count).to eq 1
@@ -375,13 +375,13 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
 
     context "when unauthorized" do
       it "returns scim+json content type" do
-        put :put_update, params: { id: 1 }
+        put :put_update, params: { id: 1 }, as: :json
 
-        expect(response.content_type).to eq "application/scim+json"
+        expect(response.media_type).to eq "application/scim+json"
       end
 
       it "fails with no credentials" do
-        put :put_update, params: { id: 1 }
+        put :put_update, params: { id: 1 }, as: :json
 
         expect(response.status).to eq 401
       end
@@ -389,7 +389,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
       it "fails with invalid credentials" do
         request.env['HTTP_AUTHORIZATION'] = ActionController::HttpAuthentication::Basic.encode_credentials("unauthorized","123456")
 
-        put :put_update, params: { id: 1 }
+        put :put_update, params: { id: 1 }, as: :json
 
         expect(response.status).to eq 401
       end
@@ -403,20 +403,20 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
       end
 
       it "returns scim+json content type" do
-        put :put_update, params: put_params
+        put :put_update, params: put_params, as: :json
 
-        expect(response.content_type).to eq "application/scim+json"
+        expect(response.media_type).to eq "application/scim+json"
       end
 
       it "is successful with with valid credentials" do
-        put :put_update, params: put_params
+        put :put_update, params: put_params, as: :json
 
         expect(response.status).to eq 200
       end
 
       it "deprovisions an active record" do
         request.content_type = "application/scim+json"
-        put :put_update, params: put_params(active: false)
+        put :put_update, params: put_params(active: false), as: :json
 
         expect(response.status).to eq 200
         expect(user.reload.active?).to eq false
@@ -426,14 +426,14 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
         user.archive!
         expect(user.reload.active?).to eq false
         request.content_type = "application/scim+json"
-        put :put_update, params: put_params(active: true)
+        put :put_update, params: put_params(active: true), as: :json
 
         expect(response.status).to eq 200
         expect(user.reload.active?).to eq true
       end
 
       it "returns :not_found for id that cannot be found" do
-        get :put_update, params: { id: "fake_id" }
+        get :put_update, params: { id: "fake_id" }, as: :json
 
         expect(response.status).to eq 404
       end
@@ -442,7 +442,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
         new_company = create(:company)
         create(:user, company: new_company, id: 1000)
 
-        get :put_update, params: { id: 1000 }
+        get :put_update, params: { id: 1000 }, as: :json
 
         expect(response.status).to eq 404
       end
@@ -457,7 +457,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
             },
           ],
           active: "true"
-        }
+        }, as: :json
 
         expect(response.status).to eq 422
       end
@@ -470,13 +470,13 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
 
     context "when unauthorized" do
       it "returns scim+json content type" do
-        patch :patch_update, params: patch_params(id: 1)
+        patch :patch_update, params: patch_params(id: 1), as: :json
 
-        expect(response.content_type).to eq "application/scim+json"
+        expect(response.media_type).to eq "application/scim+json"
       end
 
       it "fails with no credentials" do
-        patch :patch_update, params: patch_params(id: 1)
+        patch :patch_update, params: patch_params(id: 1), as: :json
 
         expect(response.status).to eq 401
       end
@@ -484,7 +484,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
       it "fails with invalid credentials" do
         request.env['HTTP_AUTHORIZATION'] = ActionController::HttpAuthentication::Basic.encode_credentials("unauthorized","123456")
 
-        patch :patch_update, params: patch_params(id: 1)
+        patch :patch_update, params: patch_params(id: 1), as: :json
 
         expect(response.status).to eq 401
       end
@@ -498,19 +498,19 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
       end
 
       it "returns scim+json content type" do
-        patch :patch_update, params: patch_params(id: 1)
+        patch :patch_update, params: patch_params(id: 1), as: :json
 
-        expect(response.content_type).to eq "application/scim+json"
+        expect(response.media_type).to eq "application/scim+json"
       end
 
       it "is successful with valid credentials" do
-        patch :patch_update, params: patch_params(id: 1)
+        patch :patch_update, params: patch_params(id: 1), as: :json
 
         expect(response.status).to eq 200
       end
 
       it "returns :not_found for id that cannot be found" do
-        get :patch_update, params: patch_params(id: "fake_id")
+        get :patch_update, params: patch_params(id: "fake_id"), as: :json
 
         expect(response.status).to eq 404
       end
@@ -519,7 +519,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
         new_company = create(:company)
         create(:user, company: new_company, id: 1000)
 
-        get :patch_update, params: patch_params(id: 1000)
+        get :patch_update, params: patch_params(id: 1000), as: :json
 
         expect(response.status).to eq 404
       end
@@ -529,7 +529,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
         user = company.users.first
         expect(user.archived?).to eq false
 
-        patch :patch_update, params: patch_params(id: 1)
+        patch :patch_update, params: patch_params(id: 1), as: :json
 
         expect(response.status).to eq 200
         expect(company.users.count).to eq 1
@@ -542,7 +542,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
         user = company.users.first.tap(&:archive!)
         expect(user.archived?).to eq true
 
-        patch :patch_update, params: patch_params(id: 1,  active: true)
+        patch :patch_update, params: patch_params(id: 1,  active: true), as: :json
 
         expect(response.status).to eq 200
         expect(company.users.count).to eq 1
@@ -550,6 +550,24 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
         expect(user.archived?).to eq false
       end
 
+      it "is case insensetive for op value" do
+        # Note, this is for backward compatibility. op should always
+        # be lower case and support for case insensitivity will be removed
+        patch :patch_update, params: {
+          id: 1,
+          Operations: [
+            {
+              op: "Replace",
+              value: {
+                active: false
+              }
+            }
+          ]
+        }, as: :json
+
+        expect(response.status).to eq 200
+      end
+
       it "throws an error for non status updates" do
         patch :patch_update, params: {
           id: 1,
@@ -563,12 +581,59 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
               }
             }
           ]
+        }, as: :json
+
+        expect(response.status).to eq 422
+        response_body = JSON.parse(response.body)
+        expect(response_body.dig("schemas", 0)).to eq "urn:ietf:params:scim:api:messages:2.0:Error"
+      end
+
+      it "returns 422 when value is not an object" do
+        patch :patch_update, params: {
+          id: 1,
+          Operations: [
+            {
+              op: "replace",
+              path: "displayName",
+              value: "Francis"
+            }
+          ]
         }
 
         expect(response.status).to eq 422
         response_body = JSON.parse(response.body)
         expect(response_body.dig("schemas", 0)).to eq "urn:ietf:params:scim:api:messages:2.0:Error"
       end
+
+      it "returns 422 when value is missing" do
+        patch :patch_update, params: {
+          id: 1,
+          Operations: [
+            {
+              op: "replace"
+            }
+          ]
+        }, as: :json
+
+        expect(response.status).to eq 422
+        response_body = JSON.parse(response.body)
+        expect(response_body.dig("schemas", 0)).to eq "urn:ietf:params:scim:api:messages:2.0:Error"
+      end
+
+      it "returns 422 operations key is missing" do
+        patch :patch_update, params: {
+          id: 1,
+          Foobars: [
+            {
+              op: "replace"
+            }
+          ]
+        }, as: :json
+
+        expect(response.status).to eq 422
+        response_body = JSON.parse(response.body)
+        expect(response_body.dig("schemas", 0)).to eq "urn:ietf:params:scim:api:messages:2.0:Error"
+      end
     end
   end