audiences 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd34ee00e56f72a0ea41a829b12ac9ddbc491380c0ae693ccaab7eba2de4dda1
-  data.tar.gz: cb81d224d20d2ce709cafa5b25d6f3d36b006f5ff5d694fd12f03b37e60f3692
+  metadata.gz: 8f83dd42249d90e09a66c7f11b5adb821e7f0fbc3add8089f075fe2668e79d35
+  data.tar.gz: 351a6676df1a297b691842e06fc18b721d3581a9bdd0ea6101bce2ed81cee06e
 SHA512:
-  metadata.gz: d14d0e9bdc98f4cbf166330a48f7e70ae236fafe3556034b37b4fea18a61c9b3dd2b8f9e4ea99028413ad6caaf399eb821ea4999285f8402a190b2ab03f476a4
-  data.tar.gz: 898d631afc7d53bd7941f58dc89cc2bc351ae071fbe2739c5a778255328bdf702a92770fb5a47420d88d59fcb62741233aeebf924b8a09dba13e540c43601894
+  metadata.gz: f90802d28319f4cbc95a8be9f9f2e68115ac7142ab6fcbf4c9be0437a14a2e57b6d58632e1befeb37b19ba1b2ce9de1d6f8fc2d9b674b120ee51d240e47140dd
+  data.tar.gz: d70f080cdad97a5bdfc31b701d7659a300dbeeef3c380371b1d91c7198a30c4ff9899c5106a0eb2af972e8b6d53e77ab718fb962c6f8734c960375394ffa60c6

data/app/controllers/audiences/contexts_controller.rb

@@ -44,7 +44,7 @@ module Audiences
       params.permit(
         :match_all,
         criteria: [groups: {}],
-        extra_users: [:externalId, :displayName, { photos: %i[type value] }]
+        extra_users: Audiences.config.resources[:Users].attributes
       ).to_h.symbolize_keys
     end
   end

data/app/controllers/audiences/scim_proxy_controller.rb

@@ -6,7 +6,7 @@ module Audiences
       resources = Audiences::Scim.resource(params[:scim_path].to_sym)
                                  .query(filter: params[:filter])
 
-      render json: resources
+      render json: resources, except: %w[schemas meta]
     end
   end
 end

data/docs/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Unreleased
 
+# Version 1.3.0 (2024-09-03)
+
+- Filter out inactive users by default [#382](https://github.com/powerhome/audiences/pull/382)
+
+# Version 1.2.2 (2024-08-21)
+
+- Permit configured resource attributes [#375](https://github.com/powerhome/audiences/pull/375)
+
 # Version 1.2.1 (2024-08-06)
 
 - Fix audiences URL helpers [#372](https://github.com/powerhome/audiences/pull/372)

data/docs/README.md

@@ -103,12 +103,12 @@ See a working example in our dummy app:
 
 ### SCIM Resource Attributes
 
-Configure which attributes are requested from the SCIM backend for each resource type. `Audiences` requires at least `id` and `displayName`, and also requests `photos` and `externalId` for users by default. To request additional attributes:
+Configure which attributes are requested from the SCIM backend for each resource type. `Audiences` includes `id`, `externalId`, and `displayName` by default in every resource type. It also requests `photos.type` and `photos.value` for users by default. To request additional attributes:
 
 ```ruby
 Audiences.configure do |config|
-  config.resource :Users, attributes: "id,externalId,displayName,photos,name"
-  config.resource :Groups, attributes: "id,displayName,mfaRequired"
+  config.resource :Users, attributes: ["name" => %w[givenName familyName formatted]]
+  config.resource :Groups, attributes: %w[mfaRequired]
 end
 ```
 

data/lib/audiences/configuration.rb

@@ -46,7 +46,8 @@ module Audiences
   # @see `resource`.
   #
   config_accessor :resources do
-    { Users: Scim::Resource.new(type: :Users, attributes: "id,externalId,displayName,photos") }
+    { Users: Scim::Resource.new(type: :Users, attributes: ["active", { "photos" => %w[type value] }],
+                                filter: "active eq true") }
   end
 
   #
@@ -55,8 +56,8 @@ module Audiences
   # @param type [Symbol] the resource type in plural, as in scim (i.e.: :Users)
   # @param attributes [String] the list of attributes to fetch for the resource (i.e.: "id,externalId,displayName")
   # @see [Audiences::Scim::Resource]
-  def config.resource(type:, **kwargs)
-    config.resources[type] = Scim::Resource.new(type: type, **kwargs)
+  def config.resource(type, **kwargs)
+    resources[type] = Scim::Resource.new(type: type, **kwargs)
   end
 
   #

data/lib/audiences/scim/resource.rb

@@ -3,16 +3,41 @@
 module Audiences
   module Scim
     class Resource
-      attr_accessor :options, :type
+      attr_accessor :options, :type, :attributes, :filter
 
-      def initialize(type:, attributes: "id,externalId,displayName", **options)
+      def initialize(type:, attributes: [], filter: nil, **options)
         @type = type
         @options = options
-        @options[:attributes] = attributes
+        @attributes = ["id", "externalId", "displayName", *attributes]
+        @filter = filter
       end
 
       def query(**options)
-        ResourcesQuery.new(Scim.client, resource: self, **@options, **options)
+        options_filter = options.delete(:filter)
+        ResourcesQuery.new(Scim.client, resource: self,
+                                        attributes: scim_attributes,
+                                        filter: merged_filter(options_filter),
+                                        **@options, **options)
+      end
+
+      def scim_attributes
+        @attributes.reduce([]) do |attrs, attr|
+          case attr
+          when Hash
+            attrs + attr.map do |key, nested_attrs|
+              nested_attrs.map { "#{key}.#{_1}" }
+            end
+          else
+            attrs + [attr]
+          end
+        end.join(",")
+      end
+
+      def merged_filter(filter)
+        return @filter unless filter
+        return filter unless @filter
+
+        "(#{@filter}) and (#{filter})"
       end
     end
   end

data/lib/audiences/scim.rb

@@ -12,9 +12,9 @@ module Audiences
       Client.new(**Audiences.config.scim)
     end
 
-    def resource(type, **options)
+    def resource(type)
       Audiences.config.resources.fetch(type) do
-        Resource.new(type: type, **options)
+        Resource.new(type: type)
       end
     end
   end

data/lib/audiences/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Audiences
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: audiences
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Carlos Palhares
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-06 00:00:00.000000000 Z
+date: 2024-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails