flipper-notifications 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7454bfa365f06fc55eca778468079bd424f5066d397793c4a00314a25fcba558
+  data.tar.gz: c20e47aee59098725c5d9997b4d0d0c6e580765a27e39077bd51a310ed5c7aaa
+SHA512:
+  metadata.gz: f386c0fa4172a702549a7846480bef5a026852be8154dfb2a918f5024cf9eda5358bf910d63887b1a54b6e5483b17fc80be88b4cc388ace540ac7d6fdb787975
+  data.tar.gz: ee7c0d82fe98c5f826871792ffd3dda442a8a28e4fee84cc3267a6312ec4a8756d8104bf0058ffc90fb98d2fe063667c8f6d87d2a8925cf469792de82b4bdf23

data/.gitignore

@@ -0,0 +1,14 @@
+*.swp
+.DS_Store
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/**/vendor/bundle/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,5 @@
+--format documentation
+--color
+--require spec_helper
+--order rand
+--exclude-pattern "spec/rails/**/*"

data/.rubocop.yml

@@ -0,0 +1,31 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Lint/MissingSuper:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedShorthandSyntax: never
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at joel.lubrano@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/jdlubrano/flipper-notifications" }
+
+# Specify your gem's dependencies in flipper-notifications.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,117 @@
+PATH
+  remote: .
+  specs:
+    flipper-notifications (0.1.0)
+      activesupport (~> 7.0)
+      flipper (~> 0.24)
+      httparty (~> 0.17)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activejob (7.0.4)
+      activesupport (= 7.0.4)
+      globalid (>= 0.3.6)
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    bundler-gem_version_tasks (0.2.1)
+    concurrent-ruby (1.1.10)
+    crack (0.4.5)
+      rexml
+    debug (1.7.1)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    flipper (0.26.0)
+      concurrent-ruby (< 2)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    hashdiff (1.0.1)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    io-console (0.6.0)
+    irb (1.6.2)
+      reline (>= 0.3.0)
+    json (2.6.3)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    minitest (5.16.3)
+    multi_xml (0.6.0)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    reline (0.3.2)
+      io-console (~> 0.5)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.41.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  activejob (~> 7.0)
+  bundler
+  bundler-gem_version_tasks
+  debug
+  flipper-notifications!
+  rake
+  rspec
+  rubocop
+  simplecov
+  webmock
+
+BUNDLED WITH
+   2.3.11

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Joel Lubrano
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,118 @@
+# Flipper::Notifications
+
+Rails-compatible Slack notifications when [Flipper](https://github.com/jnunemaker/flipper)
+flags are updated.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flipper-notifications'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flipper-notifications
+
+## Dependencies
+
+* Ruby 3
+* ActiveSupport 7
+
+This gem is designed to work within a Rails app.  At the very least, you will
+need `activesupport` since that library drives instrumentation from Flipper
+itself.
+
+## Usage
+
+After you initialize `Flipper`, you can also configure `Flipper::Notifications`.
+
+```ruby
+# config/initializers/flipper.rb
+
+Flipper.configure do |config|
+  config.adapter { ... }
+end
+
+Flipper::Notifications.configure do |config|
+  # You have to enable notifications; you probably only want notifications enabled in production.
+  config.enabled = true
+
+  slack_webhook = Flipper::Notifications::Webhooks::Slack.new(url: ENV.fetch("SLACK_WEBHOOK_URL"))
+
+  config.notifiers = [
+    Flipper::Notifications::Notifiers::WebhookNotifier.new(webhook: webhook)
+  ]
+end
+```
+
+### Implementing Your Own Webhooks
+
+WIP
+
+### Implementing Your Own Notifiers
+
+A `Notifier` is any object that responds to a `call` method with a keyword
+argument named `event`.  You can use a `lambda` as your notifier if you prefer.
+Using a `lambda` can come in handy if you want to provide additional context
+to your notifications.
+
+```ruby
+Flipper::Notifications.configure do |config|
+  webhook = Flipper::Notifications::Webhooks::Slack.new(url: ENV.fetch("SLACK_WEBHOOK_URL"))
+
+  notifier = ->(event:) do
+    context = "#{Rails.env} (changed by: #{Current.user.email})"
+    WebhookNotificationJob.perform_later(webhook: webhook, event: event, context_markdown: context)
+  end
+
+  config.notifiers = [notifier]
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`,
+and then run `bundle exec rake release`, which will create a git tag for the
+version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Releasing
+
+After merging in the new functionality to the main branch:
+
+```
+git checkout main
+git pull --prune
+bundle exec rake version:bump:<major, minor, or patch>
+bundle exec rubocop -a
+git commit -a --amend
+bundle exec rake release
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/jdlubrano/flipper-notifications. This project is intended to
+be a safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Flipper::Notifications project’s codebases,
+issue trackers, chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/[USERNAME]/flipper-notifications/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "bundler/gem_version_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flipper/notifications"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/flipper-notifications.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "flipper/notifications/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "flipper-notifications"
+  spec.version       = Flipper::Notifications::VERSION
+  spec.authors       = ["Joel Lubrano"]
+  spec.email         = ["joel.lubrano@gmail.com"]
+
+  spec.summary       = %q{Rails-compatible Slack notifications for Flipper feature flags}
+  spec.homepage      = "https://github.com/jdlubrano/flipper-notifications"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = "bin"
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport", "~> 7.0"
+  spec.add_runtime_dependency "flipper", "~> 0.24"
+  spec.add_runtime_dependency "httparty", "~> 0.17"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency 'bundler-gem_version_tasks'
+  spec.add_development_dependency "debug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "webmock"
+
+  spec.add_development_dependency "activejob", "~> 7.0"
+end

data/lib/flipper/notifications/configuration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Flipper
+  module Notifications
+    class Configuration
+      def initialize
+        @enabled   = false
+        @notifiers = []
+      end
+
+      attr_accessor :enabled, :notifiers
+
+      def enabled?
+        @enabled
+      end
+    end
+  end
+end

data/lib/flipper/notifications/event_serializer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "active_job"
+require_relative "feature_event"
+
+module Flipper
+  module Notifications
+    class EventSerializer < ActiveJob::Serializers::ObjectSerializer
+      def serialize?(argument)
+        argument.is_a?(FeatureEvent)
+      end
+
+      def serialize(event)
+        super(
+          feature_name: event.feature.name,
+          operation:    event.operation
+        )
+      end
+
+      def deserialize(hash)
+        FeatureEvent.new(**hash.symbolize_keys.slice(:feature_name, :operation))
+      end
+    end
+  end
+end

data/lib/flipper/notifications/feature_event.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Flipper
+  module Notifications
+    class FeatureEvent
+      NOTEWORTHY_OPERATIONS = %w[
+        add
+        enable
+        disable
+        clear
+        remove
+      ].freeze
+
+      def self.from_active_support(event:)
+        new(
+          feature_name: event.payload[:feature_name],
+          operation:    event.payload[:operation]
+        )
+      end
+
+      def initialize(feature_name:, operation:)
+        @feature   = Flipper.feature(feature_name)
+        @operation = operation.to_s
+      end
+
+      attr_reader :feature, :operation
+
+      def summary_markdown
+        msg = String.new("Feature *#{feature.name}* was #{action_taken}.")
+
+        if include_state?
+          msg << " The feature is now *fully enabled.*" if feature.on?
+          msg << " The feature is now *fully disabled.*" if feature.off?
+        end
+
+        msg
+      end
+
+      def feature_enabled_settings_markdown
+        return "" unless feature.conditional?
+
+        [].tap do |settings|
+          settings << "The feature is now enabled for:" if feature.conditional?
+
+          settings << "- Groups: #{to_sentence(feature.enabled_groups.map(&:name).sort)}" if feature.enabled_groups.any?
+
+          settings << "- Users: #{to_sentence(feature.actors_value.sort)}" if feature.actors_value.any?
+
+          if feature.percentage_of_actors_value.positive?
+            settings << "- #{feature.percentage_of_actors_value}% of users"
+          end
+
+          settings << "- #{feature.percentage_of_time_value}% of the time" if feature.percentage_of_time_value.positive?
+        end.join("\n")
+      end
+
+      def noteworthy?
+        NOTEWORTHY_OPERATIONS.include?(operation)
+      end
+
+      def ==(other)
+        other.is_a?(self.class) && feature == other.feature && operation == other.operation
+      end
+
+      private
+
+      def action_taken
+        case operation
+        when "add"
+          "added"
+        when "clear"
+          "cleared"
+        when "remove"
+          "removed"
+        when "enable", "disable"
+          "updated"
+        else
+          "" # noop
+        end
+      end
+
+      def include_state?
+        %w[enable disable].include?(operation)
+      end
+
+      def to_sentence(words)
+        case words.length
+        when 0
+          ""
+        when 1
+          words.first.to_s
+        when 2
+          "#{words.first} and #{words.last}"
+        else
+          "#{words[0...-1].join(', ')} and #{words.last}"
+        end
+      end
+    end
+  end
+end

data/lib/flipper/notifications/features_subscriber.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "active_support/notifications"
+require_relative "feature_event"
+
+module Flipper
+  module Notifications
+    class FeaturesSubscriber
+      def call(*args)
+        return unless enabled?
+
+        event = FeatureEvent.from_active_support(event: ActiveSupport::Notifications::Event.new(*args))
+        Flipper::Notifications.notify(event: event) if event.noteworthy?
+      end
+
+      private
+
+      def enabled?
+        Flipper::Notifications.configuration.enabled?
+      end
+    end
+  end
+end

data/lib/flipper/notifications/jobs/webhook_notification_job.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "active_job"
+require "flipper/notifications/webhooks/errors"
+
+module Flipper
+  module Notifications
+    class WebhookNotificationJob < ActiveJob::Base
+      # TODO: Pull queue from configuration?
+      # queue_as :low
+
+      retry_on Webhooks::NetworkError,
+               Webhooks::ServerError,
+               attempts: 3,
+               wait:     :exponentially_longer
+
+      def perform(webhook:, **webhook_args)
+        webhook.notify(**webhook_args)
+      end
+    end
+  end
+end

data/lib/flipper/notifications/notifiers/webhook_notifier.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "flipper/notifications/jobs/webhook_notification_job"
+
+module Flipper
+  module Notifications
+    module Notifiers
+      class WebhookNotifier
+        def initialize(webhook:)
+          @webhook = webhook
+        end
+
+        def call(event:)
+          WebhookNotificationJob.perform_later(webhook: @webhook, event: event)
+        end
+      end
+    end
+  end
+end

data/lib/flipper/notifications/railtie.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "flipper/notifications/event_serializer"
+require "flipper/notifications/webhooks/serializer"
+require "flipper/notifications/notifiers/webhook_notifier"
+
+module Flipper
+  module Notifications
+    class Railtie < Rails::Railtie
+      initializer "flipper-notifications.configure_rails_initialization" do
+        Flipper::Notifications.subscribe!
+
+        config.active_job.custom_serializers += [
+          EventSerializer,
+          Webhooks::Serializer
+        ]
+      end
+    end
+  end
+end

data/lib/flipper/notifications/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Flipper
+  module Notifications
+    VERSION = "0.1.0"
+  end
+end

data/lib/flipper/notifications/webhooks/errors.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Flipper
+  module Notifications
+    module Webhooks
+      class ApiError < StandardError
+        def initialize(response)
+          @response = response
+        end
+
+        def message
+          "Webhook API call resulted in #{@response.code} response: #{@response.body}"
+        end
+      end
+
+      class ClientError < ApiError; end
+
+      class ServerError < ApiError; end
+
+      class NetworkError < ApiError
+        def initialize(cause)
+          @cause = cause
+        end
+
+        def message
+          "Webhook API call network error: #{cause.class.name} - #{cause.message}"
+        end
+      end
+    end
+  end
+end

data/lib/flipper/notifications/webhooks/serializer.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "active_job"
+require_relative "webhook"
+
+module Flipper
+  module Notifications
+    module Webhooks
+      class Serializer < ActiveJob::Serializers::ObjectSerializer
+        def serialize?(argument)
+          argument.is_a?(Webhook)
+        end
+
+        def serialize(webhook)
+          super(
+            "class"      => webhook.class.name,
+            "attributes" => webhook.serialized_attributes
+          )
+        end
+
+        def deserialize(hash)
+          hash["class"].constantize.new(**hash["attributes"].deep_symbolize_keys)
+        end
+      end
+    end
+  end
+end

data/lib/flipper/notifications/webhooks/slack.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative "webhook"
+
+module Flipper
+  module Notifications
+    module Webhooks
+      class Slack < Webhook
+        MARKDOWN = "mrkdwn"
+
+        headers "Content-type" => "application/json"
+
+        def notify(event:, context_markdown: nil)
+          webhook_api_errors do
+            self.class.post(url, body: request_body(event: event, context_markdown: context_markdown))
+          end
+        end
+
+        private
+
+        def request_body(event:, context_markdown:)
+          { blocks: blocks(event: event, context_markdown: context_markdown) }.to_json
+        end
+
+        def blocks(event:, context_markdown:)
+          [
+            feature_section(event: event),
+            context_block(context_markdown: context_markdown)
+          ].compact
+        end
+
+        def feature_section(event:)
+          {
+            type: "section",
+            text: {
+              type: MARKDOWN,
+              text: "#{event.summary_markdown}\n#{event.feature_enabled_settings_markdown}".strip
+            }
+          }
+        end
+
+        def context_block(context_markdown:)
+          return if context_markdown.nil?
+
+          {
+            type:     "context",
+            elements: [
+              {
+                type: MARKDOWN,
+                text: context_markdown
+              }
+            ]
+          }
+        end
+      end
+    end
+  end
+end

data/lib/flipper/notifications/webhooks/webhook.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "httparty"
+require_relative "errors"
+
+module Flipper
+  module Notifications
+    module Webhooks
+      class Webhook
+        include HTTParty
+
+        default_timeout 5 # seconds
+        raise_on 400..599
+
+        def initialize(url:)
+          @url = url
+        end
+
+        attr_reader :url
+
+        def notify(**_kwargs)
+          raise "Implement #notify in your subclass"
+        end
+
+        def serialized_attributes
+          { url: url }
+        end
+
+        def ==(other)
+          other.is_a?(self.class) && url == other.url
+        end
+
+        private
+
+        def webhook_api_errors(&block)
+          block.call
+        rescue HTTParty::ResponseError => e
+          error = e.response.code.to_i < 500 ? ClientError : ServerError
+          raise error, e.response
+        rescue Errno::ECONNRESET, Timeout::Error => e
+          raise NetworkError, e
+        end
+      end
+    end
+  end
+end

data/lib/flipper/notifications/webhooks.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Flipper
+  module Notifications
+    module Webhooks
+    end
+  end
+end
+
+require_relative "webhooks/slack"

data/lib/flipper/notifications.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "active_support/notifications"
+require "flipper/notifications/version"
+
+require_relative "notifications/configuration"
+require_relative "notifications/feature_event"
+require_relative "notifications/features_subscriber"
+require_relative "notifications/webhooks"
+
+module Flipper
+  module Notifications
+    class Error < StandardError; end
+
+    module_function
+
+    @subscriber = nil
+
+    def configure
+      yield configuration if block_given?
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def notify(event:)
+      configuration.notifiers.each { |notifier| notifier.call(event: event) }
+    end
+
+    def subscribe!
+      @subscriber = ActiveSupport::Notifications.subscribe(
+        Flipper::Feature::InstrumentationName,
+        FeaturesSubscriber.new
+      )
+    end
+
+    def unsubscribe!
+      ActiveSupport::Notifications.unsubscribe(@subscriber)
+    end
+  end
+end
+
+require_relative "notifications/railtie" if defined?(Rails::Railtie)

metadata

@@ -0,0 +1,241 @@
+--- !ruby/object:Gem::Specification
+name: flipper-notifications
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joel Lubrano
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: flipper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler-gem_version_tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description:
+email:
+- joel.lubrano@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- flipper-notifications.gemspec
+- lib/flipper/notifications.rb
+- lib/flipper/notifications/configuration.rb
+- lib/flipper/notifications/event_serializer.rb
+- lib/flipper/notifications/feature_event.rb
+- lib/flipper/notifications/features_subscriber.rb
+- lib/flipper/notifications/jobs/webhook_notification_job.rb
+- lib/flipper/notifications/notifiers/webhook_notifier.rb
+- lib/flipper/notifications/railtie.rb
+- lib/flipper/notifications/version.rb
+- lib/flipper/notifications/webhooks.rb
+- lib/flipper/notifications/webhooks/errors.rb
+- lib/flipper/notifications/webhooks/serializer.rb
+- lib/flipper/notifications/webhooks/slack.rb
+- lib/flipper/notifications/webhooks/webhook.rb
+homepage: https://github.com/jdlubrano/flipper-notifications
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jdlubrano/flipper-notifications
+  source_code_uri: https://github.com/jdlubrano/flipper-notifications
+  changelog_uri: https://github.com/jdlubrano/flipper-notifications/releases
+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: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Rails-compatible Slack notifications for Flipper feature flags
+test_files: []