capistrano-ops 0.2.3 → 0.2.4

data/lib/capistrano/ops/capistrano/v3/tasks/figaro_yml.rake

@@ -7,63 +7,63 @@ namespace :figaro_yml do
 
   desc 'get the `application.yml` file from server and create local if it does not exist'
   task :get do
-      env = fetch(:stage)
-      if !File.exist?('config/application.yml')
-        puts "config/application.yml does not exist, creating it from all stages"
-        run_locally do
-          yamls={}
-          stages = Dir.glob('config/deploy/*.rb')
-          puts "found #{stages.count} stages"
-          stages.map do |f|
-            stage =File.basename(f, '.rb')
-            puts "download #{stage} application.yml"
-            begin 
+    env = fetch(:stage)
+    if !File.exist?('config/application.yml')
+      puts 'config/application.yml does not exist, creating it from all stages'
+      run_locally do
+        yamls = {}
+        stages = Dir.glob('config/deploy/*.rb')
+        puts "found #{stages.count} stages"
+        stages.map do |f|
+          stage = File.basename(f, '.rb')
+          puts "download #{stage} application.yml"
+          begin
             res = capture "cap #{stage} figaro_yml:get_stage"
-            yamls= yamls.merge(YAML.safe_load(res))
-            rescue
-              puts "could not get #{stage} application.yml"
-            end
-            yamls
+            yamls = yamls.merge(YAML.safe_load(res))
+          rescue StandardError
+            puts "could not get #{stage} application.yml"
           end
-          # write to new file
-          puts "writing to config/application.yml"
-          write_to_file('config/application.yml', yamls.to_yaml)
+          yamls
         end
-      else
-        local_yml = YAML.safe_load(File.read('config/application.yml'))
-        on roles(rake_roles) do
-          remote = capture("cat #{shared_path}/config/application.yml")
-          remote_yml = YAML.safe_load(remote)
-          remote_stage = remote_yml[env.to_s]
-          puts "remote application.yml stage '#{env.to_s}':\n\n"
-          puts remote + "\r\n"
-          puts "\r\n"
-          loop do
-            print "Overwrite local application.yml stage '#{env.to_s}'? (y/N): "
-            input = $stdin.gets.strip.downcase
-            answer = (input.empty? ? 'N' : input).downcase.to_s
-
-            next unless %w(y n).include?(answer)
-
-            if answer == 'y'
-              puts 'Updating local application.yml'
-              local_yml[env.to_s] = remote_stage
-              write_to_file('config/application.yml', local_yml.to_yaml)
-              exit
-            end
-            break
+        # write to new file
+        puts 'writing to config/application.yml'
+        write_to_file('config/application.yml', yamls.to_yaml)
+      end
+    else
+      local_yml = YAML.safe_load(File.read('config/application.yml'))
+      on roles(rake_roles) do
+        remote = capture("cat #{shared_path}/config/application.yml")
+        remote_yml = YAML.safe_load(remote)
+        remote_stage = remote_yml[env.to_s]
+        puts "remote application.yml stage '#{env}':\n\n"
+        puts "#{remote}\r\n"
+        puts "\r\n"
+        loop do
+          print "Overwrite local application.yml stage '#{env}'? (y/N): "
+          input = $stdin.gets.strip.downcase
+          answer = (input.empty? ? 'N' : input).downcase.to_s
+
+          next unless %w[y n].include?(answer)
+
+          if answer == 'y'
+            puts 'Updating local application.yml'
+            local_yml[env.to_s] = remote_stage
+            write_to_file('config/application.yml', local_yml.to_yaml)
+            exit
           end
-          puts 'Nothing written to local application.yml'
-          exit
+          break
         end
+        puts 'Nothing written to local application.yml'
+        exit
       end
     end
-    
-    task :get_stage do
-      on roles(rake_roles) do
-        puts capture "cat #{shared_path}/config/application.yml"
-      end
+  end
+
+  task :get_stage do
+    on roles(rake_roles) do
+      puts capture "cat #{shared_path}/config/application.yml"
     end
+  end
 
   desc 'compare and set the figaro_yml file on the server'
   task :compare do
@@ -93,12 +93,12 @@ namespace :figaro_yml do
       result2 = compare_hashes(local_stage_env, remote_stage_env)
       if !result1.empty? || !result2.empty?
         loop do
-          print 'Update remote application.yml? (y/N): '  
+          print 'Update remote application.yml? (y/N): '
           input = $stdin.gets.strip.downcase
           answer = (input.empty? ? 'N' : input).downcase.to_s
 
-          next unless %w(y n).include?(answer)
-        
+          next unless %w[y n].include?(answer)
+
           if answer == 'y'
             puts 'Updating remote application.yml'
             invoke 'figaro_yml:setup'
@@ -116,25 +116,24 @@ namespace :figaro_yml do
     changes = false
     local_server = hash1.to_a - hash2.to_a
     server_local = hash2.to_a - hash1.to_a
-    
-    [local_server + server_local].flatten(1).to_h.keys.each do |k|
+
+    [local_server + server_local].flatten(1).to_h.each_key do |k|
       new_value = hash1[k].to_s
-      new_value = new_value.empty? ? "nil" : new_value
+      new_value = new_value.empty? ? 'nil' : new_value
       old_value = hash2[k].to_s
-      old_value = old_value.empty? ? "nil" : old_value
+      old_value = old_value.empty? ? 'nil' : old_value
 
       if old_value != new_value
-          puts "#{k}: #{old_value} => #{new_value} \r\n"
-          changes = true
+        puts "#{k}: #{old_value} => #{new_value} \r\n"
+        changes = true
       end
     end
-  end 
+  end
 
   def write_to_file(file, content)
     File.open(file, 'w') do |f|
       f.write(content)
     end
   end
-
 end
 # rubocop:enable Metrics/BlockLength

data/lib/capistrano/ops/capistrano/v3/tasks/invoke.rake

@@ -1,24 +1,23 @@
+# frozen_string_literal: true
+
 namespace :invoke do
+  # Defalut to :app roles
+  rake_roles = fetch(:rake_roles, :app)
 
-    # Defalut to :app roles
-    rake_roles = fetch(:rake_roles, :app)
-  
-    desc "Execute a rake task on a remote server (cap invoke:rake TASK=db:migrate)"
-    task :rake do
-      if ENV['TASK']
-        on roles(rake_roles) do
-          within current_path do
-            with rails_env: fetch(:rails_env) do
-              execute :rake, ENV['TASK']
-            end
+  desc 'Execute a rake task on a remote server (cap invoke:rake TASK=db:migrate)'
+  task :rake do
+    if ENV['TASK']
+      on roles(rake_roles) do
+        within current_path do
+          with rails_env: fetch(:rails_env) do
+            execute :rake, ENV['TASK']
           end
         end
-  
-      else
-        puts "\n\nFailed! You need to specify the 'TASK' parameter!",
-             "Usage: cap <stage> invoke:rake TASK=your:task"
       end
+
+    else
+      puts "\n\nFailed! You need to specify the 'TASK' parameter!",
+           'Usage: cap <stage> invoke:rake TASK=your:task'
     end
-  
   end
-  
+end

data/lib/capistrano/ops/capistrano.rb

@@ -8,6 +8,8 @@ if defined?(Capistrano::VERSION) && Gem::Version.new(Capistrano::VERSION).releas
   load File.expand_path('capistrano/v3/tasks/figaro_yml.rake', __dir__)
   load File.expand_path('capistrano/v3/tasks/logs.rake', __dir__)
   load File.expand_path('capistrano/v3/tasks/invoke.rake', __dir__)
+  path = File.expand_path(__dir__)
+  Dir.glob("#{path}/capistrano/v3/tasks/backup/**/*.rake").each { |f| load f }
 else
   puts 'Capistrano 3 is required to use this gem'
 end

data/lib/capistrano/ops/notification/api.rb

@@ -1,30 +1,34 @@
+# frozen_string_literal: true
+
 module Notification
-    class Api
-        attr_accessor :notification_type, :notification_level
+  class Api
+    attr_accessor :notification_type, :notification_level
+
+    def initialize(notification_type: ENV['NOTIFICATION_TYPE'], notification_level: ENV['NOTIFICATION_LEVEL'])
+      self.notification_type = notification_type
+      self.notification_level = notification_level || 'error'
+    end
 
-        def initialize(notification_type: ENV['NOTIFICATION_TYPE'], notification_level: ENV['NOTIFICATION_LEVEL'])
-            self.notification_type = notification_type
-            self.notification_level = notification_level || 'error'
-        end
+    def send_backup_notification(result, title, content, webhook_data = nil)
+      return if notification_type.nil?
+
+      case notification_type
+      when 'slack'
+        Slack.new.backup_notification(result, title, content, notification_level)
+      when 'webhook'
+        Webhook.new.backup_notification(result, webhook_data, notification_level)
+      end
+    end
 
-        def send_backup_notification(result, title, content)
-            return if notification_type.nil?
-            case notification_type
-            when 'slack'
-                Slack.new.backup_notification(result, title, content, notification_level)
-            when 'webhook'
-                Webhook.new.backup_notification(result, title, content, notification_level)
-            end
-        end
+    def send_notification(message)
+      return if notification_type.nil?
 
-        def send_notification(message)
-            return if notification_type.nil?
-            case notification_type
-            when 'slack'
-                Slack.new.notify(message)
-            when 'webhook'
-                p 'webhook'
-            end
-        end
+      case notification_type
+      when 'slack'
+        Slack.new.notify(message)
+      when 'webhook'
+        p 'webhook'
+      end
     end
-end
+  end
+end

data/lib/capistrano/ops/notification/slack.rb

@@ -1,66 +1,72 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'json'
+
 module Notification
-    class Slack
-        require 'uri'
-        require 'net/http'
-        require 'net/https'
-        def initialize
-            @slack_secret = ENV['SLACK_SECRET']
-            @slack_channel = ENV['SLACK_CHANNEL']
-            @slack_base_url ='https://slack.com/api/'
-        end
+  class Slack
+    def initialize
+      @slack_secret = ENV['SLACK_SECRET']
+      @slack_channel = ENV['SLACK_CHANNEL']
+      @conn = Faraday.new(url: 'https://slack.com/api/') do |faraday|
+        faraday.headers['Content-Type'] = 'application/json'
+        faraday.headers['Authorization'] = "Bearer #{@slack_secret}"
+      end
+    end
+
+    def notify(message)
+      return if @slack_secret.nil? || @slack_channel.nil?
 
-        def notify(message)
-            return if @slack_secret.nil? || @slack_channel.nil?
-            uri = URI.parse("#{@slack_base_url}chat.postMessage")
-            http = Net::HTTP.new(uri.host, uri.port)
-            http.use_ssl = true
-            request = Net::HTTP::Post.new(uri.request_uri, initHeader = {'Content-Type' =>'application/json', 'Authorization' => 'Bearer ' + @slack_secret})
-            request.body = {
-                channel: @slack_channel,
-                text: message
-            }.to_json
-            response = http.request(request)
-            puts response.body
+      begin
+        res = @conn.post('chat.postMessage') do |req|
+          req.body = {
+            "channel": @slack_channel,
+            "text": message
+          }.to_json
         end
+        response = JSON.parse(res.body)
+        raise Notification::Error, response['error'] if response['ok'] == false
 
-        def backup_notification(result, title, content, notification_level)
-            return if @slack_secret.nil? || @slack_channel.nil?
-            return if notification_level == 'error' && result
-            uri = URI.parse("#{@slack_base_url}chat.postMessage")
-            http = Net::HTTP.new(uri.host, uri.port)
-            http.use_ssl = true
-            request = Net::HTTP::Post.new(uri.request_uri, initHeader = {'Content-Type' =>'application/json', 'Authorization' => 'Bearer ' + @slack_secret})
-            
-            data = {
-                channel: @slack_channel,
-                blocks: [
-                    {
-                        type: 'header',
-                        text: {
-                            type: 'plain_text',
-                            text: title || "#{Rails.env} Message",
-                            emoji: true
-                        }
-                    },
-                    {
-                        type: 'section',
-                        text: {
-                            type: 'mrkdwn',
-                            text: content || 'No content'
-                        }
-                    }
-                ]
-            }
-            request.body = data.to_json
-            begin
-             response = JSON.parse(http.request(request).body)
-             if response['ok'] == false
-                raise Notification::Error, response['error']
-             end
-             response
-            rescue => e
-                puts "Slack error: \n\t#{e.message}"
-            end
+        response
+      rescue Notification::Error => e
+        puts "Slack error: \n\t#{e.message}"
+      end
+    end
+
+    def backup_notification(result, title, content, notification_level)
+      return if @slack_secret.nil? || @slack_channel.nil?
+      return if notification_level == 'error' && result
+
+      begin
+        res = @conn.post('chat.postMessage') do |req|
+          req.body = {
+            channel: @slack_channel,
+            blocks: [
+              {
+                type: 'header',
+                text: {
+                  type: 'plain_text',
+                  text: title || "#{Rails.env} Message",
+                  emoji: true
+                }
+              },
+              {
+                type: 'section',
+                text: {
+                  type: 'mrkdwn',
+                  text: content || 'No content'
+                }
+              }
+            ]
+          }.to_json
         end
+        response = JSON.parse(res.body)
+        raise Notification::Error, response['error'] if response['ok'] == false
+
+        response
+      rescue Notification::Error => e
+        puts "Slack error: \n\t#{e.message}"
+      end
     end
+  end
 end

data/lib/capistrano/ops/notification/webhook.rb

@@ -1,40 +1,47 @@
+# frozen_string_literal: true
+
 module Notification
-    class Webhook
-        require 'uri'
-        require 'net/http'
-        require 'net/https'
-        require 'openssl'
-        require 'json'
-
-        def initialize
-            @webhook_url = ENV['WEBHOOK_URL']
-            @secret = ENV['WEBHOOK_SECRET']
-        end
-        
-        def generate_signature(payload_body)
-            "md5=#{OpenSSL::HMAC.hexdigest('md5', ENV['WEBHOOK_SECRET'], payload_body)}"
-        end
+  class Webhook
+    require 'faraday'
+    require 'openssl'
+    require 'json'
 
-        def backup_notification(result, date, database, backup_path, notification_level)
-            return if @webhook_url.nil? || @secret.nil?
-            return if result && ENV['NOTIFICATION_LEVEL'] == 'error'
-            data = {
-                domain: ENV['DEFAULT_URL'] || "#{database} Backup",
-                backupPath: result ? backup_path : nil,
-                backupDate: date,
-            }.to_json
-            
-            uri = URI.parse(@webhook_url)
-            https = Net::HTTP.new(uri.host, uri.port)
-            https.use_ssl = uri.scheme == "https"
-            request = Net::HTTP::Post.new(uri.path.empty? ? "/" : uri.path, initHeader = {'Content-Type' =>'application/json', 'x-hub-signature' => generate_signature("#{data}")})
-            request.body = "#{data}"
-            begin
-                response = https.request(request)
-                response.to_hash
-            rescue => e
-                puts "Webhook error: \n\t#{e.message}"
-            end
+    def initialize
+      @webhook_url = ENV['WEBHOOK_URL']
+      @secret = ENV['WEBHOOK_SECRET']
+      @conn = Faraday.new(url: @webhook_url) do |faraday|
+        faraday.headers['Content-Type'] = 'application/json'
+      end
+    end
+
+    def generate_signature(payload_body)
+      "md5=#{OpenSSL::HMAC.hexdigest('md5', ENV['WEBHOOK_SECRET'], payload_body)}"
+    end
+
+    def backup_notification(result, webhook_data, _notification_level)
+      return if @webhook_url.nil? || @secret.nil?
+      return if result && notification_level == 'error'
+
+      @date = webhook_data[:date]
+      @database = webhook_data[:database]
+      @backup_path = webhook_data[:backup_path]
+
+      @data = {
+        domain: ENV['DEFAULT_URL'] || "#{@database} Backup",
+        backupPath: result ? @backup_path : nil,
+        backupDate: @date
+      }.to_json
+
+      begin
+        @response = @conn.post do |req|
+          req.headers['x-hub-signature'] = generate_signature(@data.to_s)
+          req.body = @data
         end
+
+        @response.to_hash
+      rescue StandardError => e
+        puts "Webhook error: \n\t#{e.message}"
+      end
     end
-end
+  end
+end

data/lib/capistrano/ops/notification.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'capistrano/ops/notification/api'
 require 'capistrano/ops/notification/slack'
 require 'capistrano/ops/notification/webhook'
 
 module Notification
-    class Error < StandardError; end
-end
+  class Error < StandardError; end
+end

data/lib/capistrano/ops/railtie.rb

@@ -12,4 +12,4 @@ module Capistrano
       end
     end
   end
-end
+end

data/lib/capistrano/ops/tasks/pg/dump.rake

@@ -2,7 +2,6 @@
 
 # rubocop:disable Metrics/BlockLength
 namespace :pg do
-  
   @database = Rails.configuration.database_configuration[Rails.env]['database']
   @username = Rails.configuration.database_configuration[Rails.env]['username']
   @password = Rails.configuration.database_configuration[Rails.env]['password']
@@ -10,34 +9,33 @@ namespace :pg do
   @portnumber = Rails.configuration.database_configuration[Rails.env]['port']
   @backup_path = Rails.root.join(Rails.env.development? ? 'tmp/backups' : '../../shared/backups').to_s
   backups_enabled = Rails.env.production? || ENV['BACKUPS_ENABLED'] == 'true'
-
+  external_backup = Rails.env.production? || ENV['EXTERNAL_BACKUP_ENABLED'] == 'true'
   task :dump do
     unless backups_enabled
-      p 'dump: Backups are disabled'
+      puts 'dump: Backups are disabled'
       exit(0)
     end
 
     notification = Notification::Api.new
     commandlist = dump_cmd
-    
+
     system "mkdir -p #{@backup_path}" unless Dir.exist?(@backup_path)
-      
+
     result = system(commandlist.join(' && '))
-    
-    if ENV['BACKUP_PROVIDER'].present? && result
-      p "Uploading #{@filename} to #{ENV['BACKUP_PROVIDER']}..."
+
+    if ENV['BACKUP_PROVIDER'].present? && external_backup && result
+      puts "Uploading #{@filename} to #{ENV['BACKUP_PROVIDER']}..."
       provider = Backup::Api.new
       begin
-        provider.upload("#{@backup_path}/#{@filename}", "#{@filename}")
-        p "#{@filename} uploaded to #{ENV['BACKUP_PROVIDER']}"
+        provider.upload("#{@backup_path}/#{@filename}", @filename.to_s)
+        puts "#{@filename} uploaded to #{ENV['BACKUP_PROVIDER']}"
       rescue StandardError => e
-        p "#{@filename} upload failed: #{e.message}"
+        puts "#{@filename} upload failed: #{e.message}"
       end
     end
-    notification.send_backup_notification(result,title,content(result))
-    p result ? "Backup created: #{@backup_path}/#{@filename}" : "Backup failed removing dump file"
+    notification.send_backup_notification(result, title, content(result), { date: @date, database: @database, backup_path: @backup_path })
+    puts result ? "Backup created: #{@backup_path}/#{@filename}" : 'Backup failed removing dump file'
     system "rm #{@backup_path}/#{@filename}" unless result
-    
   end
 
   def title
@@ -56,20 +54,19 @@ namespace :pg do
   end
 
   def dump_cmd
-    date = Time.now.to_i
+    @date = Time.now.to_i
     options = []
     options << " -d #{@database}" if @database.present?
     options << " -U #{@username}" if @username.present?
     options << " -h #{@hostname}" if @hostname.present?
     options << " -p #{@portnumber}" if @portnumber.present?
-    
-    @filename = "#{@database}_#{date}.dump"
-    
+
+    @filename = "#{@database}_#{@date}.dump"
+
     commandlist = []
     commandlist << "export PGPASSWORD='#{@password}'"
     commandlist << "cd #{@backup_path}"
     commandlist << "pg_dump -Fc #{options.join('')} > #{@filename}"
   end
-
 end
 # rubocop:enable Metrics/BlockLength