poring_backup 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9443a747e4f2589aa9c81ac0d0968359070e21eb
+  data.tar.gz: 557092c3199de2e150dcfef3b0afabd2655e0fb1
+SHA512:
+  metadata.gz: 2b3298b1c5ffb8db11edcb4919a0c2b3c422ea01cf0b01cebbff4b701d2a1b7e8a04350a1f71415ead2fa9cda8ee0ac46372dfaeeb5c62c5ed25f8414b00b3f9
+  data.tar.gz: 43c5429b16dde4ea30f1137d19f20a843a5a8f1028cc451833e4ec11c3c269d060eff27fe3a41d2fced98d94f76aff71a3cac859f2249dcc93f7e52429b994a3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 PiYa
+
+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/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PoringBackup'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/generators/poring_backup/install_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators/base'
+
+module PoringBackup
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_initializer_file
+        copy_file "init_backup.rb", "config/initializers/poring_backup.rb"
+      end
+    end
+  end
+end

data/lib/generators/poring_backup/templates/init_backup.rb

@@ -0,0 +1,28 @@
+
+# run backup `rake poring_backup:perform`
+
+PoringBackup.config do
+
+  # before do
+  #   #do somethings before backup
+  # end
+
+  # after do
+  #   #do somethings after backup
+  # end
+
+  # database :PostgreSQL do
+  #   database 'database_name'
+  #   username 'username'
+  #   password 'password'
+  # end
+
+  # store_with :S3 do
+  #   access_key_id 'access_key_id'
+  #   secret_access_key 'secret_access_key'
+  #   bucket 'bucket_name'
+  #   region 'region'
+  #   path 'your/path'
+  # end
+
+end

data/lib/poring_backup.rb

@@ -0,0 +1,24 @@
+
+require 'aws-sdk'
+require 'logging'
+
+require 'poring_backup/setting'
+require 'poring_backup/logger'
+
+require 'poring_backup/database'
+require 'poring_backup/databases/postgresql'
+
+require 'poring_backup/storage'
+require 'poring_backup/storages/s3'
+
+# tasks
+require "poring_backup/railtie" if defined?(Rails)
+
+module PoringBackup
+  class << self
+    attr_reader :model
+    def config &block
+      @model = Setting.new(&block)
+    end
+  end
+end

data/lib/poring_backup/callback.rb

@@ -0,0 +1,29 @@
+module PoringBackup
+  module Settings
+    module Callback
+
+      def before &block
+        @before_actions << block
+      end
+
+      def after &block
+        @after_actions << block
+      end
+
+      private
+         def before_backup
+          unless @before_actions.empty?
+            PoringBackup.logger.info "----- before processing..."
+            @before_actions.each { |action| action.call(PoringBackup.logger) }
+          end
+        end
+
+        def after_backup
+          unless @after_actions.empty?
+            PoringBackup.logger.info "----- after processing..."
+            @after_actions.each { |action| action.call(PoringBackup.logger) }
+          end
+        end
+    end
+  end
+end

data/lib/poring_backup/database.rb

@@ -0,0 +1,44 @@
+module PoringBackup
+  class Database
+
+    attr_reader :setting
+    attr_reader :file, :tmp_file_path, :file_path
+    attr_reader :path, :tmp_dir, :file_dir
+    attr_reader :created_at
+
+    def initialize setting, &block
+      @created_at = setting.created_at
+      @setting = setting
+      @path ||= 'db_backups'
+      @file ||= 'db_backup.psql'
+      
+      gen_file_dir
+      gen_file_path
+      gen_tmp_dir
+      gen_tmp_file_path
+    end
+
+    def backup
+      FileUtils.mkdir_p(tmp_dir)
+    end
+
+    def clear_tmp!
+      FileUtils.rm_rf(tmp_file_path)
+    end
+
+    private
+      def gen_file_dir
+        @file_dir = "#{path}/#{created_at}"
+      end
+      def gen_file_path
+        @file_path = "#{file_dir}/#{file}"
+      end
+
+      def gen_tmp_dir
+        @tmp_dir = "#{setting.tmp_dir}/#{file_dir}"
+      end
+      def gen_tmp_file_path
+        @tmp_file_path ||= "#{tmp_dir}/#{file}"
+      end
+  end
+end

data/lib/poring_backup/databases/postgresql.rb

@@ -0,0 +1,81 @@
+module PoringBackup
+  module Databases
+    class PostgreSQL < Database
+
+      def initialize setting, &block
+        @database = nil
+        @host = 'localhost'
+        @port = nil
+        @username = nil
+        @password = nil
+
+        instance_eval(&block) if block_given?
+        @file = "#{@database}.pgsql"
+        super
+      end
+
+      def backup
+        PoringBackup.logger.info "PostgreSQL backup processing"
+        super
+        begin
+          system db_dump
+          PoringBackup.logger.info "#{' '*18}success"
+        rescue => e
+          PoringBackup.logger.warn "#{' '*18}failed!"
+          PoringBackup.logger.debug "#{' '*18}tmp_file: #{tmp_file_path}"
+          PoringBackup.logger.debug "#{' '*18}errors => #{e}"
+        end
+        PoringBackup.logger.info "#{' '*18}finished"
+      end
+
+      def restore
+        #psql -U {user-name} -d {desintation_db} -f {dumpfilename.sql}
+        #psql -U <username> -d <dbname> -1 -f <filename>.sql
+        #pg_restore -U <username> -d <dbname> -1 -f <filename>.dump
+      end
+
+      def database name
+        @database = name
+      end
+
+      def host name
+        @host = name
+      end
+
+      def port number
+        @port = number
+      end
+
+      def username name
+        @username = name
+      end
+
+      def password password
+        @password = password
+      end
+
+      def db_dump
+        "pg_dump #{connection_options} #{general_options} #{@database}"
+      end
+
+      private
+        def connection_options
+          options = ''
+          options << "--host=#{@host || 'localhost'}"
+          options << " --port=#{@port}" if @port
+          options << " --username=#{@username}" if @username
+          # options << " --no-password"
+          # options << " --password"
+          options
+        end
+
+        def general_options
+          options = ''
+          options << "--file=#{tmp_file_path}"
+          options << ' --compress=9'
+          options
+        end
+    end
+  end
+  
+end

data/lib/poring_backup/logger.rb

@@ -0,0 +1,45 @@
+module PoringBackup
+  class << self
+    attr_reader :logger
+  end
+  module Logger
+    class << self
+      def log_file_path
+        file_name = Rails.env.product? ? 'backup' : "backup_#{Rails.env}"
+        "log/#{file_name}.log"
+      end
+    end
+
+    Logging.color_scheme( 'bright',
+      :levels => {
+        :info  => :green,
+        :warn  => :yellow,
+        :error => :red,
+        :fatal => [:white, :on_red]
+      },
+      :date => :blue,
+      :logger => :cyan,
+      :message => :magenta
+    )
+
+    Logging.appenders.stdout(
+      'stdout',
+      :layout => Logging.layouts.pattern(
+        :pattern => '[%d] %-5l %c: %m\n',
+        :color_scheme => 'bright'
+      )
+    )
+    
+    PoringBackup.instance_variable_set("@logger", Logging.logger['PoringBackup::Log'])
+    PoringBackup.logger.add_appenders(
+      Logging.appenders.stdout,
+      Logging.appenders.file(:poring_backup,
+        filename: log_file_path,
+        # layout: Logging.layouts.pattern(
+        #   :pattern => '[%d] %-5l : %m\n',
+        #   :color_scheme => 'bright'
+        # )
+      )
+    )
+  end
+end

data/lib/poring_backup/railtie.rb

@@ -0,0 +1,10 @@
+require 'poring_backup'
+require 'rails'
+
+module PoringBackup
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      import File.expand_path('../../tasks/poring_backup_tasks.task', __FILE__)
+    end
+  end
+end

data/lib/poring_backup/setting.rb

@@ -0,0 +1,64 @@
+require 'poring_backup/callback'
+
+module PoringBackup
+  class Setting
+    include Settings::Callback
+
+    attr_reader :before_actions, :after_actions
+    attr_reader :dir, :tmp_dir
+    attr_reader :databases, :storages
+    attr_reader :created_at
+    
+    def initialize &block
+      @created_at = Time.now.strftime("%Y.%m.%d.%H.%M.%S")
+      @before_actions = []
+      @after_actions = []
+      @dir = 'poring_backups'
+      @tmp_dir = "tmp/poring_backups"
+      @databases = []
+      @storages = []
+      instance_eval(&block) if block_given?
+    end
+
+    def database model, &block
+      @databases << class_from_scope(Databases, model).new(self, &block)
+    end
+
+    def store_with model, &block
+      @storages << class_from_scope(Storages, model).new(self, &block)
+    end
+
+    def perform!
+      PoringBackup.logger.info "PoringBackup Start..."
+      before_backup
+      backup!
+      store!
+      clear_tmp!
+      after_backup
+      PoringBackup.logger.info "PoringBackup Done"
+    end
+
+    def clear_tmp!
+      FileUtils.rm_rf(tmp_dir)
+      PoringBackup.logger.debug "clear tmp directory"
+    end
+
+    private
+      def class_from_scope scope, klass
+        "#{scope}::#{klass}".constantize
+      end
+
+      def backup!
+        PoringBackup.logger.info "--------- Backup ----------"
+        databases.each(&:backup)
+      end
+
+      def store!
+        PoringBackup.logger.info "----------- Store ---------"
+        storages.each(&:upload)
+      end
+
+     
+      
+  end
+end

data/lib/poring_backup/storage.rb

@@ -0,0 +1,11 @@
+module PoringBackup
+  class Storage
+
+    attr_reader :setting
+
+    def initialize setting, &block
+      @setting = setting
+    end
+
+  end
+end

data/lib/poring_backup/storages/s3.rb

@@ -0,0 +1,66 @@
+module PoringBackup
+  module Storages
+    class S3 < Storage
+      
+      attr_reader :s3, :bucket_object
+
+        def initialize setting, &block
+          super
+          instance_eval(&block) if block_given?
+          @s3 = aws_resource
+          @bucket_object = @s3.bucket(@bucket)
+        end
+
+        def access_key_id key
+          @access_key_id = key
+        end
+
+        def secret_access_key key
+          @secret_access_key = key
+        end
+
+        def bucket name
+          @bucket = name
+        end
+
+        def region name
+          @region = name
+        end
+
+        def path name
+          @path = name
+        end
+
+        def upload
+          PoringBackup.logger.info "S3 processing"
+          setting.databases.each do |db|
+            s3_path = "#{@path}/#{db.file_path}"
+            object = @bucket_object.object(s3_path)
+            success = object.upload_file(db.tmp_file_path)
+            if success
+              PoringBackup.logger.info "#{' '*3}uploaded: #{s3_path}"
+            else
+              PoringBackup.logger.warn "#{' '*3}uploaded failure: #{db.tmp_file_path}"
+            end
+          end
+          PoringBackup.logger.info "#{' '*3}finished"
+        end
+
+        private
+          def aws_resource
+            @aws_resource ||= Aws::S3::Resource.new(client: aws_client)
+          end
+          def aws_client
+            @aws_client ||= Aws::S3::Client.new(
+                              region: @region,
+                              credentials: aws_credentials
+                            )
+          end
+
+          def aws_credentials
+            @aws_credentials ||= Aws::Credentials.new(@access_key_id, @secret_access_key)
+          end
+
+    end
+  end
+end