devise_slack_notifiable 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 405a786a39943e716f064ab9fbb0f40f93c0d48b6e8ebb9bd9890041ecc85ef7
-  data.tar.gz: a39dbf5d465f6b475e4c408dc80ccb27227806a449da6925348c8e728ae279c3
+  metadata.gz: b99296dbdd359b33c21ff11fd912a5079072e16d448b0ab0204a551663c3cd3d
+  data.tar.gz: 3759859e2a7b792e05094887c0057afe6f2ddf1e30fd05b3618c615b52e0bced
 SHA512:
-  metadata.gz: 1476715f8668cc552ac89fa267b6e2e5f133381b24f2454a0b93c5356b3de3de47a1222c4b845c7842860386bb5df7e35eff68767e955a55574caa3091df62c2
-  data.tar.gz: 27a0e40a15f0fe22ba041278e503287b5619518ccec0490a611137325cb3fd6ca41f939af421dbb7bfe436fed9cc52bcc6ccf8b0f60ff0874dcf690b3235825e
+  metadata.gz: 5043d05915f13b686b7d71921dd9c0411ed4a39d5da8ae323f2b13cfd2a69834b78ccc6153975a2af5bb47529ddf65056d49fd09f6cfd64e82469018f677934e
+  data.tar.gz: 8566eeef5f0658b6de2483b97cb3f629c47c2db5ac65efea4cb0d63d89ecb2f13912c1b1a8b05e7c5b39b96f6d9b556c8d6dec6a55a97584655a1e7b4a44502d

data/.editorconfig

@@ -1,9 +1,9 @@
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.github/workflows/gem-push.yml

@@ -0,0 +1,28 @@
+name: Ruby Gem
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.6
+        uses: actions/setup-ruby@v1
+        with:
+          version: 2.6.x
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.github/workflows/ruby.yml

@@ -0,0 +1,27 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+
+    - name: Install dependencies
+      run: bundle install
+
+    - name: Run tests and send coverage
+      run: bundle exec rspec
+      env:
+        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

data/.gitignore

@@ -6,6 +6,8 @@
 /pkg/
 /spec/reports/
 /tmp/
+/out/
+*.gem
 
 # rspec failure tracking
 .rspec_status

data/.travis.yml

@@ -4,9 +4,3 @@ cache: bundler
 rvm:
   - 2.6.5
 before_install: gem install bundler -v 2.1.4
-
-deploy:
-  provider: rubygems
-  api_key: "YOUR API KEY"
-  on:
-    tags: true

data/Gemfile

@@ -8,3 +8,4 @@ gemspec
 gem 'rake', '~> 12.0'
 gem 'rspec', '~> 3.0'
 gem 'slack-notifier'
+gem 'codecov'

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    devise_slack_notifiable (0.1.0)
+    devise_slack_notifiable (0.2.0)
+      devise
       rails
       slack-notifier
 
@@ -63,15 +64,28 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
+    bcrypt (3.1.13)
     builder (3.2.4)
+    codecov (0.1.17)
+      json
+      simplecov
+      url
     concurrent-ruby (1.1.6)
     crass (1.0.6)
+    devise (4.7.2)
+      bcrypt (~> 3.0)
+      orm_adapter (~> 0.1)
+      railties (>= 4.1.0)
+      responders
+      warden (~> 1.2.3)
     diff-lcs (1.3)
+    docile (1.3.2)
     erubi (1.9.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     i18n (1.8.3)
       concurrent-ruby (~> 1.0)
+    json (2.3.0)
     loofah (2.6.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -87,6 +101,7 @@ GEM
     nio4r (2.5.2)
     nokogiri (1.10.9-x64-mingw32)
       mini_portile2 (~> 2.4.0)
+    orm_adapter (0.5.0)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -117,6 +132,9 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
     rake (12.3.3)
+    responders (3.0.1)
+      actionpack (>= 5.0)
+      railties (>= 5.0)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -130,8 +148,12 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
     slack-notifier (2.3.2)
-    sprockets (3.7.2)
+    sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
     sprockets-rails (3.2.1)
@@ -142,6 +164,9 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
+    url (0.3.2)
+    warden (1.2.8)
+      rack (>= 2.0.6)
     websocket-driver (0.7.2)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
@@ -151,6 +176,7 @@ PLATFORMS
   x64-mingw32
 
 DEPENDENCIES
+  codecov
   devise_slack_notifiable!
   rake (~> 12.0)
   rspec (~> 3.0)

data/README.md

@@ -2,6 +2,10 @@
 
 Devise slack notifications gem. It posts message after registration and confirmation (if Devise confirmations strategy is enabled).
 
+[![Gem Version](https://badge.fury.io/rb/devise_slack_notifiable.svg)](https://badge.fury.io/rb/devise_slack_notifiable)
+[![codecov](https://codecov.io/gh/invoicity/devise_slack_notifiable/branch/master/graph/badge.svg)](https://codecov.io/gh/invoicity/devise_slack_notifiable)
+[![ruby](https://github.com/invoicity/devise_slack_notifiable/workflows/Ruby/badge.svg)](https://github.com/invoicity/devise_slack_notifiable/actions)
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -1,8 +1,8 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/devise_slack_notifiable.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.metadata['changelog_uri'] = 'https://github.com/invoicity/devise_slack_notifiable/releases'
 
   spec.add_dependency 'rails'
+  spec.add_dependency 'devise'
   spec.add_dependency 'slack-notifier'
 
   # Specify which files should be added to the gem when it is released.

data/lib/devise/models/slack_notifiable.rb

@@ -2,20 +2,26 @@
 
 module Devise
   module Models
+    # Slack notifications for devise models!
     module SlackNotifiable
       extend ActiveSupport::Concern
 
       included do
+        # Rails hook
+        # Triggers slack registration message
         after_create :registration_notification
 
         protected
 
+        # Devise hook
+        # Triggers slack confirmation message
         def after_confirmation
           confirmation_notification
 
-          super
+          super if defined?(super)
         end
 
+        # Sends slack notification if confirmation_message_enabled
         def confirmation_notification
           return unless DeviseSlackNotifiable.configuration.confirmation_message_enabled
 
@@ -24,6 +30,7 @@ module Devise
           )
         end
 
+        # Sends slack notification
         def registration_notification
           send_slack_notification(
             DeviseSlackNotifiable.configuration.registration_message_formatter
@@ -32,6 +39,9 @@ module Devise
 
         private
 
+        # Creates notifier and sends message
+        #
+        # @param [Proc] formatter
         def send_slack_notification(formatter)
           notifier = DeviseSlackNotifiable::Notifier.new
           notifier.send_message(self, formatter)

data/lib/devise_slack_notifiable.rb

@@ -11,6 +11,9 @@ module DeviseSlackNotifiable
     attr_accessor :configuration
   end
 
+  # Configuration block
+  #
+  # @yield
   def self.configure
     self.configuration ||= DeviseSlackNotifiable::Configuration.new
     yield(configuration)

data/lib/devise_slack_notifiable/configuration.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module DeviseSlackNotifiable
+  # Configuration container
   class Configuration
     attr_accessor :enabled,
                   :slack_webhook,
@@ -9,6 +10,9 @@ module DeviseSlackNotifiable
                   :confirmation_message_enabled,
                   :context_fields
 
+    # DeviseSlackNotifiable::Configuration constructor.
+    #
+    # Sets default values
     def initialize
       @enabled = false
       @slack_webhook = nil

data/lib/devise_slack_notifiable/errors/configuration.rb

@@ -2,6 +2,8 @@
 
 module DeviseSlackNotifiable
   module Errors
+    # Configuration error
+    # raised when properties are missing
     class Configuration < StandardError; end
   end
 end

data/lib/devise_slack_notifiable/notifier.rb

@@ -3,7 +3,13 @@
 require 'slack-notifier'
 
 module DeviseSlackNotifiable
+  # Module <-> Slack communication layer
+  # and payload builder
   class Notifier
+
+    # DeviseSlackNotifiable::Notifier constructor.
+    #
+    # Creates Slack::Notifier instance
     def initialize
       return unless enabled?
 
@@ -31,18 +37,33 @@ module DeviseSlackNotifiable
 
     attr_reader :client
 
+    # Integration enabled?
+    #
+    # @return [Boolean]
     def enabled?
       DeviseSlackNotifiable.configuration.enabled
     end
 
+    # Webhook URL
+    #
+    # @return [String, NilClass]
     def webhook
       DeviseSlackNotifiable.configuration.slack_webhook
     end
 
+    # Context fields
+    #
+    # @return [Array]
     def context_fields
       DeviseSlackNotifiable.configuration.context_fields
     end
 
+    # Message builder
+    #
+    # @param [String] message
+    # @param [ActiveRecord::Base] entity
+    #
+    # @return [Hash]
     def formatter(message, entity)
       {
         blocks: [
@@ -54,9 +75,6 @@ module DeviseSlackNotifiable
               emoji: true
             }
           },
-          {
-            type: 'divider'
-          },
           {
             type: 'section',
             text: {

data/lib/devise_slack_notifiable/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-
-module DeviseSlackNotifiable
-  VERSION = '0.1.0'
-end
+# frozen_string_literal: true
+
+module DeviseSlackNotifiable
+  VERSION = '0.2.0'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devise_slack_notifiable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - whitemerry
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: slack-notifier
   requirement: !ruby/object:Gem::Requirement
@@ -46,6 +60,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"