RubyGems - audiences - Versions diffs - 0.1.0 - Mend

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (19) hide show

checksums.yaml +7 -0
data/Rakefile +18 -0
data/app/controllers/audiences/application_controller.rb +6 -0
data/app/controllers/audiences/contexts_controller.rb +15 -0
data/app/controllers/audiences/scim_proxy_controller.rb +19 -0
data/app/jobs/audiences/application_job.rb +6 -0
data/app/models/audiences/application_record.rb +8 -0
data/app/models/audiences/context.rb +15 -0
data/app/views/layouts/audiences/application.html.erb +15 -0
data/config/routes.rb +18 -0
data/db/migrate/20230725194934_create_audiences_contexts.rb +12 -0
data/docs/CHANGELOG.md +0 -0
data/docs/README.md +66 -0
data/lib/audiences/engine.rb +13 -0
data/lib/audiences/scim_proxy.rb +31 -0
data/lib/audiences/version.rb +5 -0
data/lib/audiences.rb +33 -0
data/lib/tasks/audiences_tasks.rake +5 -0
metadata +79 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 301017a77754bc9639d80ae7cf2a5260c1a6811e9bec5c49daefaca3b9833220
+  data.tar.gz: bd65ad4e4baf6577420716c58b75921700cd866d43514cf7c18978d564b0d5e7
+SHA512:
+  metadata.gz: 0af804e8e6e477a2248b80339721897e3dd48ba27aa34f3524dbef8e5fd0cf09de9feaee0093fa2208030b7a194385e2313157a20f64cc3b536e719ac35d1b5d
+  data.tar.gz: '08b631ec00c43818f1537ee222df54e196df0f6cb918e6cd45eb23c552a70b9d953a3a25c8774bf3d842360be406cdee4d9ffd89e54d33bd0760d8182348b637'

data/Rakefile ADDED Viewed

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+# frozen_string_literal: true
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(spec: %w[app:db:drop app:db:prepare])
+require "rubocop/rake_task"
+RuboCop::RakeTask.new(:rubocop)
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+task default: %i[rubocop spec]

data/app/controllers/audiences/application_controller.rb ADDED Viewed

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Audiences
+  class ApplicationController < ActionController::API
+  end
+end

data/app/controllers/audiences/contexts_controller.rb ADDED Viewed

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Audiences
+  class ContextsController < ApplicationController
+    def show
+      render json: current_context.as_json(only: %w[match_all], methods: %w[key criteria])
+    end
+  private
+    def current_context
+      @current_context ||= Audiences.load(params[:key])
+    end
+  end
+end

data/app/controllers/audiences/scim_proxy_controller.rb ADDED Viewed

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require "audiences/scim_proxy"
+module Audiences
+  class ScimProxyController < ApplicationController
+    def get
+      status, body = ScimProxy.get(params[:scim_path], scim_params)
+      render body: body, status: status, content_type: "application/json"
+    end
+  private
+    def scim_params
+      params.except(:scim_path, :controller, :action).permit!.to_h
+    end
+  end
+end

data/app/jobs/audiences/application_job.rb ADDED Viewed

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Audiences
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/models/audiences/application_record.rb ADDED Viewed

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module Audiences
+  # @private
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/audiences/context.rb ADDED Viewed

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Audiences
+  class Context < ApplicationRecord
+    belongs_to :owner, polymorphic: true
+    def key
+      Audiences.sign(owner)
+    end
+    def criteria
+      []
+    end
+  end
+end

data/app/views/layouts/audiences/application.html.erb ADDED Viewed

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Audiences</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+  <%= stylesheet_link_tag    "audiences/application", media: "all" %>
+</head>
+<body>
+<%= yield %>
+</body>
+</html>

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+Audiences::Engine.routes.draw do
+  get "/scim(/*scim_path)" => "scim_proxy#get", as: :scim_proxy
+  get "/:key" => "contexts#show", as: :signed_context
+end
+Rails.application.routes.draw do
+  mount Audiences::Engine, at: "/audiences", as: :audiences
+  direct :audience_context do |owner, options|
+    audiences.route_for(:signed_context, key: Audiences.sign(owner), **options)
+  end
+  direct :audience_scim_proxy do |options|
+    audiences.route_for(:scim_proxy, **options)
+  end
+end

data/db/migrate/20230725194934_create_audiences_contexts.rb ADDED Viewed

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+class CreateAudiencesContexts < ActiveRecord::Migration[6.0]
+  def change
+    create_table :audiences_contexts do |t|
+      t.references :owner, polymorphic: true, null: false, index: { unique: true }
+      t.boolean :match_all, default: false, null: false
+      t.timestamps
+    end
+  end
+end

data/docs/CHANGELOG.md ADDED Viewed

File without changes

data/docs/README.md ADDED Viewed

@@ -0,0 +1,66 @@
+# Audiences
+"Audiences" is a SCIM-integrated notifier for real-time Rails actions based on group changes.
+## Usage
+### Creating/Managing audiences
+An audience is tied to an owning model withing your application. For the rest of this document we're going to assume a model Team. To create audiences for a team, using `audiences-react`, you'll render an audiences editor for your model.
+That can be done with a unobstrusive JS renderer like react-rails, or a custom one as in [our dummy app](../audiences/spec/dummy/app/frontend/entrypoints/application.js). The editor will need two arguments:
+- The context URI: `audience_context_url(owner)` helper
+- The SCIM endpoint: `audience_scim_proxy_url` helper if using the [proxy](#configuring-the-scim-proxy), or the SCIM endpoint.
+### Listening to audience changes
+**TBD**
+### Configuring the SCIM proxy
+The Audience::ScimProxy should point to the real SCIM endpoint. The proxy allows you to configure the endpoint and the credentials/headers:
+I.e.:
+```ruby
+# frozen_string_literal: true
+require "audiences/scim_proxy"
+Audiences::ScimProxy.config = {
+  uri: "http://super-secret-scim.com/scim/v2/",
+  headers: {
+    "Authorization": "Beaer very-secret"
+  }
+  debug: $stdout,
+}
+```
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem "audiences"
+```
+And then execute:
+```bash
+$ bundle
+```
+Or install it yourself as:
+```bash
+$ gem install audiences
+```
+## Contributing
+See [development guide](../../docs/development.md).
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/audiences/engine.rb ADDED Viewed

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+require "audiences"
+module Audiences
+  # Audiences Engine
+  #
+  # i.e.: `mount Audiences::Engine`
+  #
+  class Engine < ::Rails::Engine
+    isolate_namespace Audiences
+  end
+end

data/lib/audiences/scim_proxy.rb ADDED Viewed

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+require "net/http"
+require "uri"
+module Audiences
+  module ScimProxy
+    mattr_accessor :config do
+      {}
+    end
+  module_function
+    def get(path, query)
+      response = perform_request(path: path, method: :Get, query: query)
+      [response.code, response.body]
+    end
+    private_class_method def perform_request(method:, path:, query: {})
+      uri = URI.join(config[:uri], path)
+      uri.query = URI.encode_www_form(query)
+      request = ::Net::HTTP.const_get(method).new(uri, config[:headers])
+      http = ::Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      http.request(request)
+    end
+  end
+end

data/lib/audiences/version.rb ADDED Viewed

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

data/lib/audiences.rb ADDED Viewed

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+require "audiences/version"
+# Audiences system
+# Audiences pushes notifications to your rails app when a
+# SCIM backend updates a user, notifying matching audiences.
+#
+module Audiences
+  GID_RESOURCE = "audiences"
+module_function
+  # Provides a key to load an audience context for the given owner.
+  # An owner should implment GlobalID::Identification.
+  #
+  # @param owner [GlobalID::Identification] an owning model
+  # @return [String] context key
+  #
+  def sign(owner)
+    owner.to_sgid(for: GID_RESOURCE)
+  end
+  # Loads a context for the given context key
+  #
+  # @param token [String] a signed token (see #sign)
+  # @return Audience::Context
+  #
+  def load(key)
+    owner = GlobalID::Locator.locate_signed(key, for: GID_RESOURCE)
+    ::Audiences::Context.where(owner: owner).first_or_create!.tap(&:readonly!)
+  end
+end

data/lib/tasks/audiences_tasks.rake ADDED Viewed

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :audiences do
+#   # Task goes here
+# end

metadata ADDED Viewed

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: audiences
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carlos Palhares
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-08-16 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'
+description: Audiences notify the Rails app when a SCIM backend updates a user affecting
+  matching audiences
+email:
+- carlos.palhares@powerhrg.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- app/controllers/audiences/application_controller.rb
+- app/controllers/audiences/contexts_controller.rb
+- app/controllers/audiences/scim_proxy_controller.rb
+- app/jobs/audiences/application_job.rb
+- app/models/audiences/application_record.rb
+- app/models/audiences/context.rb
+- app/views/layouts/audiences/application.html.erb
+- config/routes.rb
+- db/migrate/20230725194934_create_audiences_contexts.rb
+- docs/CHANGELOG.md
+- docs/README.md
+- lib/audiences.rb
+- lib/audiences/engine.rb
+- lib/audiences/scim_proxy.rb
+- lib/audiences/version.rb
+- lib/tasks/audiences_tasks.rake
+homepage: https://github.com/powerhome/power-tools
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/powerhome/power-tools
+  source_code_uri: https://github.com/powerhome/power-tools
+  changelog_uri: https://github.com/powerhome/power-tools/blob/main/packages/audiences/docs/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Audiences system
+test_files: []

audiences 0.1.0