chatopsify 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 216f9a98d4907836c37bfc4454f177b1ba57acdf83e24b84e800c8d67f1c5d9c
-  data.tar.gz: d493671383220e3df3d80cc07627bd31ab27c3fc9ab8e23a3bad49ecfdd215ba
+  metadata.gz: 14141a20c1a8a4cfda8993608f336919ef400ad96644ca994658fd215b494a8b
+  data.tar.gz: dbf4b8583120ec65a00d0e47fa82e469ed4fd80e27644d1d9def262c9e8849fb
 SHA512:
-  metadata.gz: f035c97f0c8449746fb3ea2f16361736d2841e162e4b965a5f63037931216e53b6949631cd66a857d4e749341faf31ff97d202539396e90e2b658ab1cd03c982
-  data.tar.gz: d3d04ec37b3683597cc7a530314947cbc3ea086522c1993589579d9a3804c2cffcfb835160285327a7adc37e0108841b206ff65f910876097009d626c914a80b
+  metadata.gz: 690503d6828f98cd64ce2e90540c6adcdcaccfcc59093ad195f887ee5893c549b8ffd87f6a94e9f2985826cbd12bb8bc63ab6da54b52fdba8137c88ed49465c9
+  data.tar.gz: 29c67e0bed4b61b825c49a4e903fc1643516a9d14279bf12b0547e04a3a802b0de0fb80fccc2dce17af082fa0bb4e3675ec185aed0796761aee8f604c82065cb

data/.github/workflows/run_rubocop.yml

@@ -8,20 +8,17 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby 2.6 is
-      uses: actions/setup-ruby@v1
+    - uses: actions/checkout@v4
+    - name: Set up Ruby 2.6.4
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6.x
-    - uses: actions/cache@v1
-      with:
-        path: vendor/bundle
-        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-gems-
+        ruby-version: 2.6.4
+    # - uses: ruby/setup-ruby@v1
+    #   with:
+    #     bundler-cache: true
     - name: Run Rubocop linter
       run: |
-        gem install bundler
+        gem install bundler -v 2.4.22
         bundle config path vendor/bundle
         bundle install --jobs 4 --retry 3
         bundle exec rubocop

data/.github/workflows/run_tests.yml

@@ -8,20 +8,14 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby 2.6 is
-      uses: actions/setup-ruby@v1
+    - uses: actions/checkout@v4
+    - name: Set up Ruby 2.6.4
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6.x
-    - uses: actions/cache@v1
-      with:
-        path: vendor/bundle
-        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-gems-
+        ruby-version: 2.6.4
     - name: Run test suite
       run: |
-        gem install bundler
+        gem install bundler -v 2.4.22
         bundle config path vendor/bundle
         bundle install --jobs 4 --retry 3
         bundle exec rake test

data/.rubocop.yml

@@ -6,8 +6,14 @@ Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: single_quotes
 
+Metrics/AbcSize:
+  Enabled: false
+
 Layout/LineLength:
   Max: 120
+Metrics/MethodLength:
+  Max: 120
+
 
 AllCops:
   NewCops: enable

data/Gemfile

@@ -5,8 +5,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in Chatopsify.gemspec
 gemspec
 
-gem 'rake', '~> 13.0'
-
+gem 'bundler', '~> 2'
 gem 'minitest', '~> 5.0'
-
+gem 'rake', '~> 13.0'
 gem 'rubocop', '~> 1.21'

data/README.md

@@ -1,9 +1,10 @@
 # Chatopsify
 
-![Gem](https://img.shields.io/gem/v/Chatopsify?color=%234cc61f&label=Gem%20version&logo=ruby&logoColor=red)
-![Gem](https://img.shields.io/gem/dt/Chatopsify?color=%2330c754&label=Downloads&logo=rubygems&logoColor=red)
-![GitHub Workflow Status](https://img.shields.io/github/workflow/status/rs-phunt/Chatopsify/Tests%20%F0%9F%A7%AA?label=Tests&logo=github)
-![GitHub Workflow Status](https://img.shields.io/github/workflow/status/rs-phunt/Chatopsify/Rubocop%20Lint?label=Rubocop&logo=github)
+![Gem](https://img.shields.io/gem/v/chatopsify?color=%25234cc61f&label=Gem%20version&logo=ruby&logoColor=red&link=https%3A%2F%2Frubygems.org%2Fgems%2Fchatopsify)
+![Gem](https://img.shields.io/gem/dt/chatopsify?color=%2330c754&label=Downloads&logo=rubygems&logoColor=red&link=https%3A%2F%2Frubygems.org%2Fgems%2Fchatopsify)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/papakvy/chatopsify/run_rubocop.yml?branch=main&logo=rubocop&logoColor=red&label=Rubocop%20Lint)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/papakvy/chatopsify/run_tests.yml?branch=main&logo=rubocop&logoColor=red&label=Tests%20%F0%9F%A7%AA)
+<!-- ![GitHub Repo stars](https://img.shields.io/github/stars/papakvy/chatopsify?logoColor=red) -->
 
 ## Installation
 
@@ -29,19 +30,22 @@ Require the gem in your `Capfile`:
 
 ## Configuration
 
-### Puts `CHATOPS_API_KEY` into your ENV
-
-- Export to your `bash`: `export CHATOPS_API_KEY=xxx`
-
-- Add to `.env` if you're using `dotenv` gem
+### Using ENV (or `.env`)
 
+```bash
+export CHATOPS_URI='your_chatops_uri'
+export CHATOPS_API_KEY='your_chatops_api_key'
+export CHATOPS_CHANNEL_ID='your_channel_id'
+```
 
-### Puts `CHATOPS_CHANNEL_ID` into your ENV or custom in `config/deploy`
+### Using `config/deploy`
 
 ```ruby
 # config/deploy.rb
 ...
-set :chatops_channel_id, 'xxx'
+set :chatops_uri, 'your_chatops_uri'
+set :chatops_api_key, 'your_chatops_api_key'
+set :chatops_channel_id, 'your_channel_id'
 ...
 ```
 

data/chatopsify.gemspec

@@ -12,15 +12,15 @@ Gem::Specification.new do |spec|
   spec.email         = ['phunt@runsystem.net']
 
   spec.summary       = 'Publish deployment notifications to ChatOps via the API'
-  spec.description   = 'Publish deployment notifications to ChatOps via the API'
+  spec.description   = 'chatopsify = ChatOps + Capistrano notifications via API'
   spec.homepage      = 'https://github.com/papakvy/chatopsify'
   spec.license       = 'MIT'
   spec.required_ruby_version = '>= 2.6'
 
   # spec.metadata['allowed_push_host'] = 'TODO: Set to your gem server 'https://example.com''
   spec.metadata['rubygems_mfa_required'] = 'true'
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/papakvy/chatopsify'
+  # spec.metadata['homepage_uri'] = spec.homepage
+  # spec.metadata['source_code_uri'] = 'https://github.com/papakvy/chatopsify'
   spec.metadata['changelog_uri'] = 'https://github.com/papakvy/chatopsify/blob/master/CHANGELOG.md'
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -31,9 +31,6 @@ Gem::Specification.new do |spec|
   # Uncomment to register a new dependency of your gem
 
   spec.add_dependency 'capistrano', '~> 3.2', '>= 3.2.0'
-  spec.add_dependency 'tzinfo', '~> 1.1'
-  spec.add_development_dependency 'bundler', '~> 2'
-  spec.add_development_dependency 'rake', '~> 1'
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/capistrano/tasks/chatopsify.cap

@@ -1,11 +1,15 @@
 namespace :chatops do
   desc "Notify ChatOps Started"
   task :notify_started do
-    # return
     set :chatops_time_started, Time.now
     run_locally do
       if fetch(:chatops_notify_events).include? :started
-        Chatopsify::Co.call.process(Chatopsify::CoLib.msg_fmt(:starting))
+        info 'Notifying ChatOps of deploy started'
+        begin
+          Chatopsify::Co.call.process(Chatopsify::CoLib.msg_fmt(:starting))
+        rescue StandardError => e
+          info "ERROR notify_started: #{e}"
+        end
       end
     end
   end
@@ -18,7 +22,11 @@ namespace :chatops do
     run_locally do
       if fetch(:chatops_notify_events).include? :finished
         info 'Notifying ChatOps of deploy finished'
-        Chatopsify::Co.call.process(Chatopsify::CoLib.msg_fmt(:success))
+        begin
+          Chatopsify::Co.call.process(Chatopsify::CoLib.msg_fmt(:success))
+        rescue StandardError => e
+          info "ERROR notify_finished: #{e}"
+        end
       end
     end
   end
@@ -31,7 +39,11 @@ namespace :chatops do
     run_locally do
       if fetch(:chatops_notify_events).include? :failed
         info 'Notifying ChatOps of deploy failed'
-        Chatopsify::Co.call.process(Chatopsify::CoLib.msg_fmt(:failed))
+        begin
+          Chatopsify::Co.call.process(Chatopsify::CoLib.msg_fmt(:failed))
+        rescue StandardError => e
+          info "ERROR notify_failed: #{e}"
+        end
       end
     end
   end
@@ -51,7 +63,7 @@ namespace :load do
       servers.map{ |e| ["#{e.hostname} (#{e.properties.fetch(:my_property)&.upcase!})"]}.join(', ')
     }
     set :chatops_deploy_starting_text, ->{
-      "### :zap: ⎡#{fetch(:application)}⎦ is deploying by ⎡*#{fetch(:local_user)}*⎦: Starting •••"
+      "### :zap: ⎡#{fetch(:application)}⎦ is being deployed by ⎡*#{fetch(:local_user)}*⎦: Starting •••"
     }
     set :chatops_deploy_succeed_text, ->{
       time_elapsed = Integer(fetch(:chatops_time_finished, 0).to_i - fetch(:chatops_time_started, 0).to_i)
@@ -61,7 +73,7 @@ namespace :load do
     set :chatops_deploy_failed_text, ->{
       time_elapsed = Integer(fetch(:chatops_time_finished, 0).to_i - fetch(:chatops_time_started, 0).to_i)
       "### :sos: ⎡#{fetch(:application)}⎦ was deployed by ⎡#{fetch(:local_user)}⎦: " \
-      "*failed* in **#{time_elapsed}** seconds."
+      "*failed* within **#{time_elapsed}** seconds."
     }
     set :chatops_notify_events, [:started, :finished, :failed]
   end

data/lib/chatopsify/co.rb

@@ -2,10 +2,9 @@
 
 require 'json'
 require 'net/http'
-require 'tzinfo'
 
 module Chatopsify
-  # ChatOps service
+  # ChatOps services
   class Co
     def initialize(api_key = nil)
       @api_key    = api_key || load_api_key
@@ -25,8 +24,8 @@ module Chatopsify
       puts e.message
     end
 
-    def call_get(id = nil)
-      send_get_request(id)
+    def call_delete(id = nil)
+      send_delete_request(id)
     rescue StandardError => e
       puts e.message
     end
@@ -67,11 +66,10 @@ module Chatopsify
       puts "Response: #{res.code} #{res.body}"
     end
 
-    def send_get_request(id = nil)
+    def send_delete_request(id = nil)
       uri = URI(@uri)
       uri.path += "/#{id}" if id
 
-      # req = Net::HTTP::Get.new(co_uri)
       req = Net::HTTP::Delete.new(uri)
       req['authorization'] = "Bearer #{o_api_key}"
       res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
@@ -97,20 +95,23 @@ module Chatopsify
         end
       end
 
+      # rubocop:disable Lint/TripleQuotes, Style/StringLiterals, Layout/IndentationWidth
       def msg_fmt(status = nil)
 """#{text(status)}
 | TITLE | CONTENTS |
 |----------:|:-------------|
-| Stage | #{fetch(:stage).upcase!} |
-| Server | #{fetch(:ip_address) }|
+| Stage | #{fetch(:stage)&.upcase!} |
+| Server | #{fetch(:ip_address)}|
 | Branch | #{fetch(:branch)} |
 | Revision | #{fetch(:current_revision) || '<empty>'} |
-| Timestamp | #{TZInfo::Timezone.get('Asia/Ho_Chi_Minh')&.now || Time.now} |
+| Timestamp | #{Time.now.getlocal('+07:00') || Time.now} |
 """
       end
+      # rubocop:enable Lint/TripleQuotes, Style/StringLiterals, Layout/IndentationWidth
     end
   end
 
+  # CoSecurity service
   class CoSecurity
     require 'openssl'
     require 'securerandom'
@@ -124,44 +125,40 @@ module Chatopsify
     end
 
     def encrypt_string
-      begin
-        cipher = OpenSSL::Cipher::AES256.new(:CBC)
-        cipher.encrypt
-        salt = SecureRandom.random_bytes(16)
-        key_iv = OpenSSL::PKCS5.pbkdf2_hmac_sha1(generate_pwd, salt, 2000, cipher.key_len + cipher.iv_len)
-        key = key_iv[0, cipher.key_len]
-        iv = key_iv[cipher.key_len, cipher.iv_len]
-
-        cipher.key = key
-        cipher.iv = iv
-
-        encrypted = cipher.update(@str) + cipher.final
-        (salt + encrypted).unpack1('H*')
-      rescue => e
-        false
-      end
+      cipher = OpenSSL::Cipher.new('aes-256-cbc')
+      cipher.encrypt
+      salt = SecureRandom.random_bytes(16)
+      key_iv = OpenSSL::PKCS5.pbkdf2_hmac_sha1(generate_pwd, salt, 2000, cipher.key_len + cipher.iv_len)
+      key = key_iv[0, cipher.key_len]
+      iv = key_iv[cipher.key_len, cipher.iv_len]
+
+      cipher.key = key
+      cipher.iv = iv
+
+      encrypted = cipher.update(@str) + cipher.final
+      (salt + encrypted).unpack1('H*')
+    rescue StandardError => e
+      puts e.message
     end
 
     def decrypt_string
-      begin
-        encrypted = [@str].pack('H*')
-        cipher = OpenSSL::Cipher::AES256.new(:CBC)
-        cipher.decrypt
+      encrypted = [@str].pack('H*')
+      cipher = OpenSSL::Cipher.new('aes-256-cbc')
+      cipher.decrypt
 
-        salt = encrypted[0, 16]
-        encrypted_data = encrypted[16..-1]
+      salt = encrypted[0, 16]
+      encrypted_data = encrypted[16..]
 
-        key_iv = OpenSSL::PKCS5.pbkdf2_hmac_sha1(generate_pwd, salt, 2000, cipher.key_len + cipher.iv_len)
-        key = key_iv[0, cipher.key_len]
-        iv = key_iv[cipher.key_len, cipher.iv_len]
+      key_iv = OpenSSL::PKCS5.pbkdf2_hmac_sha1(generate_pwd, salt, 2000, cipher.key_len + cipher.iv_len)
+      key = key_iv[0, cipher.key_len]
+      iv = key_iv[cipher.key_len, cipher.iv_len]
 
-        cipher.key = key
-        cipher.iv = iv
+      cipher.key = key
+      cipher.iv = iv
 
-        cipher.update(encrypted_data) + cipher.final
-      rescue => e
-        false
-      end
+      cipher.update(encrypted_data) + cipher.final
+    rescue StandardError => e
+      puts e.message
     end
 
     private

data/lib/chatopsify/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Chatopsify
-  VERSION = '0.0.4'
+  VERSION = '0.0.6'
 end

data/test/test_helper.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 $LOAD_PATH.unshift File.expand_path('lib', __dir__)
-require 'Chatopsify'
+require 'chatopsify'
 
 require 'minitest/autorun'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chatopsify
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - phunt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-16 00:00:00.000000000 Z
+date: 2024-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -30,49 +30,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
-- !ruby/object:Gem::Dependency
-  name: tzinfo
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-description: Publish deployment notifications to ChatOps via the API
+description: chatopsify = ChatOps + Capistrano notifications via API
 email:
 - phunt@runsystem.net
 executables: []
@@ -96,18 +54,15 @@ files:
 - lib/capistrano/tasks/chatopsify.cap
 - lib/chatopsify.rb
 - lib/chatopsify/co.rb
-- lib/chatopsify/co_service.rb
 - lib/chatopsify/version.rb
 - lib/core_ext/custom_lib.rb
-- test/chatworkify_test.rb
+- test/chatopsify_test.rb
 - test/test_helper.rb
 homepage: https://github.com/papakvy/chatopsify
 licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-  homepage_uri: https://github.com/papakvy/chatopsify
-  source_code_uri: https://github.com/papakvy/chatopsify
   changelog_uri: https://github.com/papakvy/chatopsify/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []

data/lib/chatopsify/co_service.rb

@@ -1,10 +0,0 @@
-module Chatopsify
-  class CoService
-    CO_URI = 'https://chat.runsystem.vn/api/v4/posts'.freeze
-
-    def initialize(api_key, channel_id)
-      @api_key = api_key
-      @channel_id = channel_id
-    end
-  end
-end