actionslack 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d806e62f1769081a642b1bc493bb2bff9385e12a42695c0efd50ee40a6c8d05
-  data.tar.gz: 8bb05daac3e625e206c7ba47141fe88272831b531513c732916a4acaeb8e1635
+  metadata.gz: 21fc855745a83c67aefd2391434f8dede96aff1b45ae677c2abdaec2047933fa
+  data.tar.gz: b09236edbb043bf9bbd6cbc1f50472c1dd1eef5fc11821174fd9bd160400c467
 SHA512:
-  metadata.gz: ee9728f120912769b9eccf32bd4a77c8b63d1cd5a888a7f0ea25a2019216e31aeb528c461cb3a6fd10dc193405999cde8ab8f336be507de6f8cf95d564a9c4f1
-  data.tar.gz: 030caa0c7a13a46b7bdaadc5607bce2c8114b89c78a40785b21e02d721ba68c561e50235b33278e012ea4457336854c11bc82c6c921c15f78e145fb75cbeb457
+  metadata.gz: 7b194b4a378398b8b8ff13b5d6b2fd906288b565ac33f392fb72467356f30d63f0e7e6e144621be04adaf95e713182277ec49521fa8b5298900c6d9d0f82acd8
+  data.tar.gz: e46830da21df1ad7ce58863e6e09a6113b7e4d847af2ec44f3592f80a4e8a77b2617cf6b471796edbf69e357941e7cc1edf28624c6c2e07a3a4f1e308bf2d69c

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright © 2022 Akito Hikasa
+
+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

@@ -4,13 +4,11 @@ ActionSlack is a framework that supports your implementation of slack notificati
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add actionslack
-
-If bundler is not being used to manage dependencies, install the gem by executing:
+```ruby
+gem 'actionslack', require: 'action_slack'
+```
 
-    $ gem install actionslack
+That's all
 
 ## Usage
 
@@ -55,12 +53,27 @@ person = Person.new('John')
 WelcomingNewCommer.notify(new_person: person)
 ```
 
-## Development
+Optionally, three configuration items are available.
+
+Especially, there are three options for type: local, testflight, and production.
+
+In `local`, ActionSlack does not post to Slack, only writes logs.
+In `testflight`, ActionSlack will post to Slack, but adds an obvious prefix to the message to tell you that it is not a notice from a production environment.
+So, I recommend to use it for checking connections.
 
-I will not release this to rubygems until becomes stable.
-Until then, I develop this privately.
+I know you understand about `production` mode.
+
+```ruby
+ActionSlack.configure do |config|
+  config.filepath = "#{PROJECT_ROOT}/webhooks.yml"
+  config.async = false # then, we don't use ActiveJob for posting
+  config.type = :production
+end
+```
+
+## Development
 
-I'm also planning providing rspec tools. Stay tuned.
+I'm planning provide rspec tools.
 
 ## Contributing
 

data/lib/action_slack/base.rb

@@ -12,11 +12,7 @@ module ActionSlack
       def notify(**kargs)
         instance = create(**kargs)
 
-        if ActionSlack.configuration.async
-          SendJob.perform_later(url: instance.url, message: instance.message)
-        else
-          Notifier.notify(url: instance.url, message: instance.message)
-        end
+        Notifier.notify(url: instance.url, message: instance.message)
       end
 
       def attributes=(attrs)

data/lib/action_slack/configuration.rb

@@ -24,8 +24,18 @@ module ActionSlack
       @configuration = self.class.default_configuration.dup
     end
 
+    def async?
+      async
+    end
+
+    %i[local testflight production].each do |type_name|
+      define_method :"#{type_name}?" do
+        type_name == type
+      end
+    end
+
     set_default(:filepath, 'config/slack_webhooks.yml')
     set_default(:async, true)
-    set_default(:env, :development)
+    set_default(:type, :local) # production, testflight, local
   end
 end

data/lib/action_slack/logger.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActionSlack
+  class Logger < ::Logger; end
+end

data/lib/action_slack/notifier.rb

@@ -1,9 +1,31 @@
 # frozen_string_literal: true
 
 module ActionSlack
-  class Notifier
-    def self.notify(url:, message:)
-      Slack::Notifier.new(url).post(text: message)
+  module Notifier
+    module_function
+
+    def notify(url:, message:)
+      message = ActionSlack.configuration.testflight? ? "[ActionSlack Test Posting]\n#{message}\n" : message
+
+      if ActionSlack.configuration.async?
+        notify_later(url, message)
+      else
+        notify_now(url, message)
+      end
+    end
+
+    def notify_now(url, message)
+      if ActionSlack.configuration.local?
+        ActionSlack.logger.debug { "Post to Slack webhook url: #{url}, message: \"#{message}\"" }
+      else
+        ActionSlack.logger.info { "Start posting to Slack webhook url: #{url}, message: \"#{message}\"" }
+        Slack::Notifier.new(url).post(text: message)
+        ActionSlack.logger.info 'Posted to Slack'
+      end
+    end
+
+    def notify_later(url, message)
+      SendJob.perform_later(url: url, message: message)
     end
   end
 end

data/lib/action_slack/send_job.rb

@@ -2,8 +2,8 @@
 
 module ActionSlack
   class SendJob < ActiveJob::Base
-    def perform(url:, message:)
-      Notifier.notify(url: url, message: message)
+    def perform(url, message)
+      Notifier.__send__(:notify_now, url, message)
     end
   end
 end

data/lib/action_slack/version.rb

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

data/lib/action_slack/webhook.rb

@@ -26,9 +26,9 @@ module ActionSlack
 
       def load_yaml(src)
         if Psych::VERSION > '4.0'
-          YAML.load(src, symbolize_names: true, aliases: true, freeze: true)
+          YAML.safe_load(src, symbolize_names: true, freeze: true)
         else
-          YAML.safe_load(src)
+          YAML.safe_load(src, symbolize_names: true)
         end
       end
     end

data/lib/action_slack.rb

@@ -4,6 +4,7 @@ require 'active_support'
 require 'active_support/core_ext'
 require 'yaml'
 require 'erb'
+require 'logger'
 require 'slack-notifier'
 
 module ActionSlack
@@ -13,6 +14,7 @@ module ActionSlack
   autoload :Webhook
   autoload :Notifier
   autoload :Base
+  autoload :Logger
 
   autoload :SendJob if const_defined?(:ActiveJob)
 
@@ -24,5 +26,18 @@ module ActionSlack
     def configuration
       @configuration ||= Configuration.new
     end
+
+    def logger
+      @logger ||= ActionSlack::Logger.new($stdout, level: :info)
+    end
+
+    def logger=(logger)
+      if logger.nil?
+        self.logger.level = Logger::FATAL
+        return
+      end
+
+      @logger = logger
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionslack
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - kakubin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-03 00:00:00.000000000 Z
+date: 2022-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !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'
 description: actionslack
 email:
 - wetsand.wfs@gmail.com
@@ -65,11 +79,13 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - lib/action_slack.rb
 - lib/action_slack/base.rb
 - lib/action_slack/configuration.rb
+- lib/action_slack/logger.rb
 - lib/action_slack/notifier.rb
 - lib/action_slack/send_job.rb
 - lib/action_slack/version.rb
@@ -97,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.0.3.1
 signing_key:
 specification_version: 4
 summary: actionslack