flipper-notifications 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7454bfa365f06fc55eca778468079bd424f5066d397793c4a00314a25fcba558
-  data.tar.gz: c20e47aee59098725c5d9997b4d0d0c6e580765a27e39077bd51a310ed5c7aaa
+  metadata.gz: fac8c375a1f9e69c790e85c4bdb7d6baf53327e6fcd3db9cbafb69a69bc235ed
+  data.tar.gz: ae854c74b8a3e62e1c23701566fabbc3fef1d81e49be3d377e16855e312022a2
 SHA512:
-  metadata.gz: f386c0fa4172a702549a7846480bef5a026852be8154dfb2a918f5024cf9eda5358bf910d63887b1a54b6e5483b17fc80be88b4cc388ace540ac7d6fdb787975
-  data.tar.gz: ee7c0d82fe98c5f826871792ffd3dda442a8a28e4fee84cc3267a6312ec4a8756d8104bf0058ffc90fb98d2fe063667c8f6d87d2a8925cf469792de82b4bdf23
+  metadata.gz: 4a565d1fb16d6c66c3a5900e4e278088bbefc0c05639398928d87539eb60571e9bcc09c761fd0a6624785f8b5f9a19db73097a73696eff9a928d7da3eee827d2
+  data.tar.gz: 54bc9009ecf98dcdddd8b6c830b130041aee4a93f1dcb41178f8c6910672d8b05b3fe392eaa6c0ead2ecf5167a739abccedcc90012f333348b2f9b31d6150bcb

data/.github/workflows/rails-tests.yml

@@ -0,0 +1,31 @@
+name: Tests (Rails app)
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby_version:
+          - 3.1
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+      - name: Ruby version
+        run: ruby -v
+      - name: Install dependencies
+        working-directory: spec/rails/defaults
+        run: bundle install
+      - name: Run tests
+        working-directory: spec/rails/defaults
+        run: bin/rails test

data/.github/workflows/ruby-tests.yml

@@ -0,0 +1,31 @@
+name: Tests (Ruby)
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby_version:
+          - 3.0
+          - 3.1
+          - 3.2
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+      - name: Ruby version
+        run: ruby -v
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rspec

data/.github/workflows/style-check.yml

@@ -0,0 +1,30 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Style Check
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.1
+    - name: Install dependencies
+      run: bundle install
+    - name: Run Rubocop
+      run: bundle exec rubocop -D

data/.gitignore

@@ -8,7 +8,7 @@
 /pkg/
 /spec/reports/
 /tmp/
-/**/vendor/bundle/
+/**/.vendor/bundle/
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -1,6 +1,15 @@
 AllCops:
   NewCops: enable
   SuggestExtensions: false
+  Exclude:
+    - "Gemfile"
+    - "flipper-notifications.gemspec"
+    - "Rakefile"
+    - "bin/*"
+    - "spec/rails/**/*"
+
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines_except_namespace
 
 Layout/HashAlignment:
   EnforcedColonStyle: table

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ 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
+reported by contacting the project team at jlubrano@wrapbook.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.

data/Gemfile

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    flipper-notifications (0.1.0)
+    flipper-notifications (0.1.1)
       activesupport (~> 7.0)
       flipper (~> 0.24)
       httparty (~> 0.17)

data/README.md

@@ -3,6 +3,8 @@
 Rails-compatible Slack notifications when [Flipper](https://github.com/jnunemaker/flipper)
 flags are updated.
 
+![FlipperNotification](images/flipper-notifications.png)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -24,7 +26,7 @@ Or install it yourself as:
 * Ruby 3
 * ActiveSupport 7
 
-This gem is designed to work within a Rails app.  At the very least, you will
+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.
 
@@ -53,12 +55,47 @@ end
 
 ### Implementing Your Own Webhooks
 
-WIP
+This gem provides an implementation to send notifications to Slack via an
+[incoming webhook](https://api.slack.com/messaging/webhooks).
+If you want to integrate with a service other than Slack, you may wish to
+implement your own `Webhook` by following the pattern established by this gem.
+If you implement your own `Webhook`, and you have a Rails app that uses `ActiveJob`,
+you can use the `Flipper::Notifications::WebhookNotificationJob` provided by this
+gem to send webhook requests asynchronously. The job also includes a sensible
+retry strategy just in case the internet or your notification service is having a bad day.
+
+Your `Webhook` can start by inheriting from `Flipper::Notifications::Webhook`.
+The `Webhook` base class defines an initializer that takes one keyword argument, `url`.
+You only need to implement an instance method named `notify`. The `notify` method
+should take keyword arguments.  Within the `notify` method you have access to
+[HTTParty](https://github.com/jnunemaker/httparty) methods for sending requests.
+In the end, your `Webhook` might look something like this:
+
+```ruby
+class MyWebhook < Flipper::Notifications::Webhook
+
+  def notify(foo:, bar:)
+    webhook_api_errors do
+      self.class.post(@url, body: { foo: foo, bar: bar }.to_json)
+    end
+  end
+
+end
+```
+
+The `webhook_api_errors` helper wraps common API errors as specific `Flipper::Notifications`
+error types:
+
+* `Flipper::Notifications::ClientError` - 4XX HTTP responses
+* `Flipper::Notifications::ServerError` - 5XX HTTP responses
+* `Flipper::Notifications::NetworkError` - Timeouts
 
 ### Implementing Your Own Notifiers
 
+You may want to implement notifications without using the `Webhook` pattern
+described above. If so, all you have to do is implement your own `Notifier`.
 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.
+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.
 
@@ -68,41 +105,41 @@ Flipper::Notifications.configure do |config|
 
   notifier = ->(event:) do
     context = "#{Rails.env} (changed by: #{Current.user.email})"
-    WebhookNotificationJob.perform_later(webhook: webhook, event: event, context_markdown: context)
+    Flipper::Notifications::WebhookNotificationJob.perform_later(webhook: webhook, event: event, context_markdown: context)
   end
 
   config.notifiers = [notifier]
 end
 ```
 
+The `event` object will be a `Flipper::Notifications::FeatureEvent`.
+
 ## 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
+Then, run `bundle exec rspec` 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:
+After merging in the new functionality to the main branch, you can run the following
+to push a new version of the gem to [rubygems.org](https://rubygems.org):
 
 ```
 git checkout main
-git pull --prune
+git pull
 bundle exec rake version:bump:<major, minor, or patch>
 bundle exec rubocop -a
-git commit -a --amend
+git commit -a --amend --no-edit
 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
+https://github.com/wrapbook/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.
 

data/flipper-notifications.gemspec

@@ -8,10 +8,10 @@ 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.email         = ["jlubrano@wrapbook.com"]
 
   spec.summary       = %q{Rails-compatible Slack notifications for Flipper feature flags}
-  spec.homepage      = "https://github.com/jdlubrano/flipper-notifications"
+  spec.homepage      = "https://github.com/wrapbook/flipper-notifications"
   spec.license       = "MIT"
 
   spec.metadata["homepage_uri"] = spec.homepage

data/lib/flipper/notifications/configuration.rb

@@ -3,6 +3,7 @@
 module Flipper
   module Notifications
     class Configuration
+
       def initialize
         @enabled   = false
         @notifiers = []
@@ -13,6 +14,7 @@ module Flipper
       def enabled?
         @enabled
       end
+
     end
   end
 end

data/lib/flipper/notifications/event_serializer.rb

@@ -6,6 +6,7 @@ require_relative "feature_event"
 module Flipper
   module Notifications
     class EventSerializer < ActiveJob::Serializers::ObjectSerializer
+
       def serialize?(argument)
         argument.is_a?(FeatureEvent)
       end
@@ -20,6 +21,7 @@ module Flipper
       def deserialize(hash)
         FeatureEvent.new(**hash.symbolize_keys.slice(:feature_name, :operation))
       end
+
     end
   end
 end

data/lib/flipper/notifications/feature_event.rb

@@ -3,6 +3,7 @@
 module Flipper
   module Notifications
     class FeatureEvent
+
       NOTEWORTHY_OPERATIONS = %w[
         add
         enable
@@ -95,6 +96,7 @@ module Flipper
           "#{words[0...-1].join(', ')} and #{words.last}"
         end
       end
+
     end
   end
 end

data/lib/flipper/notifications/features_subscriber.rb

@@ -6,6 +6,7 @@ require_relative "feature_event"
 module Flipper
   module Notifications
     class FeaturesSubscriber
+
       def call(*args)
         return unless enabled?
 
@@ -18,6 +19,7 @@ module Flipper
       def enabled?
         Flipper::Notifications.configuration.enabled?
       end
+
     end
   end
 end

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

@@ -6,6 +6,7 @@ require "flipper/notifications/webhooks/errors"
 module Flipper
   module Notifications
     class WebhookNotificationJob < ActiveJob::Base
+
       # TODO: Pull queue from configuration?
       # queue_as :low
 
@@ -17,6 +18,7 @@ module Flipper
       def perform(webhook:, **webhook_args)
         webhook.notify(**webhook_args)
       end
+
     end
   end
 end

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

@@ -6,6 +6,7 @@ module Flipper
   module Notifications
     module Notifiers
       class WebhookNotifier
+
         def initialize(webhook:)
           @webhook = webhook
         end
@@ -13,6 +14,7 @@ module Flipper
         def call(event:)
           WebhookNotificationJob.perform_later(webhook: @webhook, event: event)
         end
+
       end
     end
   end

data/lib/flipper/notifications/railtie.rb

@@ -7,6 +7,7 @@ require "flipper/notifications/notifiers/webhook_notifier"
 module Flipper
   module Notifications
     class Railtie < Rails::Railtie
+
       initializer "flipper-notifications.configure_rails_initialization" do
         Flipper::Notifications.subscribe!
 
@@ -15,6 +16,7 @@ module Flipper
           Webhooks::Serializer
         ]
       end
+
     end
   end
 end

data/lib/flipper/notifications/version.rb

@@ -2,6 +2,6 @@
 
 module Flipper
   module Notifications
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

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

@@ -4,6 +4,7 @@ module Flipper
   module Notifications
     module Webhooks
       class ApiError < StandardError
+
         def initialize(response)
           @response = response
         end
@@ -11,6 +12,7 @@ module Flipper
         def message
           "Webhook API call resulted in #{@response.code} response: #{@response.body}"
         end
+
       end
 
       class ClientError < ApiError; end
@@ -18,6 +20,7 @@ module Flipper
       class ServerError < ApiError; end
 
       class NetworkError < ApiError
+
         def initialize(cause)
           @cause = cause
         end
@@ -25,6 +28,7 @@ module Flipper
         def message
           "Webhook API call network error: #{cause.class.name} - #{cause.message}"
         end
+
       end
     end
   end

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

@@ -7,6 +7,7 @@ module Flipper
   module Notifications
     module Webhooks
       class Serializer < ActiveJob::Serializers::ObjectSerializer
+
         def serialize?(argument)
           argument.is_a?(Webhook)
         end
@@ -21,6 +22,7 @@ module Flipper
         def deserialize(hash)
           hash["class"].constantize.new(**hash["attributes"].deep_symbolize_keys)
         end
+
       end
     end
   end

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

@@ -6,6 +6,7 @@ module Flipper
   module Notifications
     module Webhooks
       class Slack < Webhook
+
         MARKDOWN = "mrkdwn"
 
         headers "Content-type" => "application/json"
@@ -52,6 +53,7 @@ module Flipper
             ]
           }
         end
+
       end
     end
   end

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

@@ -7,6 +7,7 @@ module Flipper
   module Notifications
     module Webhooks
       class Webhook
+
         include HTTParty
 
         default_timeout 5 # seconds
@@ -40,6 +41,7 @@ module Flipper
         rescue Errno::ECONNRESET, Timeout::Error => e
           raise NetworkError, e
         end
+
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-notifications
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Joel Lubrano
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-23 00:00:00.000000000 Z
+date: 2023-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -180,11 +180,14 @@ dependencies:
         version: '7.0'
 description:
 email:
-- joel.lubrano@gmail.com
+- jlubrano@wrapbook.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rails-tests.yml"
+- ".github/workflows/ruby-tests.yml"
+- ".github/workflows/style-check.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -198,6 +201,7 @@ files:
 - bin/console
 - bin/setup
 - flipper-notifications.gemspec
+- images/flipper-notifications.png
 - lib/flipper/notifications.rb
 - lib/flipper/notifications/configuration.rb
 - lib/flipper/notifications/event_serializer.rb
@@ -212,13 +216,13 @@ files:
 - 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
+homepage: https://github.com/wrapbook/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
+  homepage_uri: https://github.com/wrapbook/flipper-notifications
+  source_code_uri: https://github.com/wrapbook/flipper-notifications
+  changelog_uri: https://github.com/wrapbook/flipper-notifications/releases
 post_install_message:
 rdoc_options: []
 require_paths: