pg_export 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69c56bdaa52fa25112c93ffd284cd806ce6fa707
-  data.tar.gz: 285340dfcf4c20067d57e8d805868b453f7cbf5f
+  metadata.gz: 763552e9063089d2137c2eff38b159caee96f457
+  data.tar.gz: 445e0c662a841abf1c9ee1f3ba4fa05dc845e6e3
 SHA512:
-  metadata.gz: 8d51c8854e8d2b4d17dd43c96e43d4e1a97af5c8653472e51898fa3018278b5126629d279e29c407ddf0233bb898da77e3f06456495604a63e2ac07f743b3ca2
-  data.tar.gz: be9ad50fb36708db2e6232168677fc9eb8f24f4491862d37feb73230e0bd3aa550ebd19b1f4def5c6475620be2b507b54b1abce891b327cada84a1d1afbe4a86
+  metadata.gz: 9f8e27408b4aa14d29783f3672c456d09521cce85195fee112fbd32b8fd3b987f039a82dc28e652553fc40f63be0d80509cf05eb1299494c9beaac57ff8d7f2f
+  data.tar.gz: ab1c4938fbbb933735c35f806d6eca4745d240a7d749641180724ccebaba06e976b49a73762bc36eb4a7a577fdb6f2fe8e20ca41f4028cba29f8c235125c9204

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.5.1 - 2017.03.31
+
+- Simplify Dump entity design
+- Fix docs
+
 ### 0.5.0 - 2017.03.11
 
 - Add restriction on DUMP_ENCRYPTION_KEY, to be exactly 16 characters length 

data/README.md

@@ -71,7 +71,7 @@ __Step 1.__ Prepare FTP account and put configuration into env variables. Dumps
     BACKUP_FTP_USER="user"
     BACKUP_FTP_PASSWORD="password"
     
-__Step 2.__ Put dump encryption key into env variable (at least 16 characters). Dumps will be SSL(AES-128-CBC) encrypted using that key.
+__Step 2.__ Put dump encryption key into env variable (exactly 16 characters). Dumps will be SSL(AES-128-CBC) encrypted using that key.
  
     # /etc/environment
     DUMP_ENCRYPTION_KEY="1234567890abcdef"

data/lib/pg_export/entities/dump.rb

@@ -0,0 +1,48 @@
+class PgExport
+  class Dump
+    extend Forwardable
+    include SizeHuman
+
+    CHUNK_SIZE = (2**16).freeze
+
+    def_delegators :file, :path, :read, :write, :<<, :rewind, :close, :size, :eof?
+
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def ext
+      ''
+    end
+
+    def open(operation_type, &block)
+      case operation_type.to_sym
+      when :read then File.open(path, 'r', &block)
+      when :write then File.open(path, 'w', &block)
+      else raise ArgumentError, 'Operation type can be only :read or :write'
+      end
+    end
+
+    def each_chunk
+      open(:read) do |file|
+        yield file.read(CHUNK_SIZE) until file.eof?
+      end
+    end
+
+    def to_s
+      "#{name} (#{size_human})"
+    end
+
+    private
+
+    def file
+      @file ||= Tempfile.new(file_name)
+    end
+
+    def file_name
+      name.downcase.gsub(/[^0-9a-z]/, '_')
+    end
+  end
+end

data/lib/pg_export/includable_modules/dump/size_human.rb

@@ -1,5 +1,5 @@
 class PgExport
-  module Dump
+  class Dump
     module SizeHuman
       def size_human
         {

data/lib/pg_export/services/aes/decryptor.rb

@@ -2,7 +2,7 @@ class PgExport
   class Aes
     class Decryptor < Base
       def call(enc_dump)
-        dump = PlainDump.new
+        dump = Dump.new('Dump')
         copy_using(cipher, from: enc_dump, to: dump)
         logger.info "Create #{dump}"
         dump

data/lib/pg_export/services/aes/encryptor.rb

@@ -2,7 +2,7 @@ class PgExport
   class Aes
     class Encryptor < Base
       def call(dump)
-        enc_dump = EncryptedDump.new
+        enc_dump = Dump.new('Encrypted Dump')
         copy_using(cipher, from: dump, to: enc_dump)
         logger.info "Create #{enc_dump}"
         enc_dump

data/lib/pg_export/services/bash_utils.rb

@@ -7,7 +7,7 @@ class PgExport
     end
 
     def create_dump
-      dump = PlainDump.new
+      dump = Dump.new('Dump')
       Open3.popen3("pg_dump -Fc --file #{dump.path} #{database_name}") do |_, _, err|
         error = err.read
         raise PgDumpError, error unless error.empty?

data/lib/pg_export/services/dump_storage.rb

@@ -16,7 +16,7 @@ class PgExport
     end
 
     def download(name)
-      dump = EncryptedDump.new
+      dump = Dump.new('Encrypted Dump')
       ftp_adapter.download_file(dump.path, name)
       logger.info "Download #{dump} #{name} from #{ftp_adapter}"
       dump

data/lib/pg_export/version.rb

@@ -1,3 +1,3 @@
 class PgExport
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.5.1'.freeze
 end

data/lib/pg_export.rb

@@ -12,9 +12,7 @@ require 'pg_export/includable_modules/dump/size_human'
 require 'pg_export/includable_modules/services_container'
 require 'pg_export/errors'
 require 'pg_export/configuration'
-require 'pg_export/entities/dump/base'
-require 'pg_export/entities/plain_dump'
-require 'pg_export/entities/encrypted_dump'
+require 'pg_export/entities/dump'
 require 'pg_export/services/ftp_adapter'
 require 'pg_export/services/ftp_connection'
 require 'pg_export/services/bash_utils'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_export
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Krzysztof Maicher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-11 00:00:00.000000000 Z
+date: 2017-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cli_spinnable
@@ -148,9 +148,7 @@ files:
 - bin/setup
 - lib/pg_export.rb
 - lib/pg_export/configuration.rb
-- lib/pg_export/entities/dump/base.rb
-- lib/pg_export/entities/encrypted_dump.rb
-- lib/pg_export/entities/plain_dump.rb
+- lib/pg_export/entities/dump.rb
 - lib/pg_export/errors.rb
 - lib/pg_export/includable_modules/colourable_string.rb
 - lib/pg_export/includable_modules/dump/size_human.rb

data/lib/pg_export/entities/dump/base.rb

@@ -1,42 +0,0 @@
-class PgExport
-  module Dump
-    class Base
-      extend Forwardable
-      include SizeHuman
-
-      CHUNK_SIZE = (2**16).freeze
-
-      def_delegators :file, :path, :read, :write, :<<, :rewind, :close, :size, :eof?
-
-      def initialize
-        @file = Tempfile.new('dump')
-      end
-
-      def ext
-        ''
-      end
-
-      def open(operation_type, &block)
-        case operation_type.to_sym
-        when :read then File.open(path, 'r', &block)
-        when :write then File.open(path, 'w', &block)
-        else raise ArgumentError, 'Operation type can be only :read or :write'
-        end
-      end
-
-      def each_chunk
-        open(:read) do |file|
-          yield file.read(CHUNK_SIZE) until file.eof?
-        end
-      end
-
-      def to_s
-        "#{name || self.class} #{file.class} (#{size_human})"
-      end
-
-      private
-
-      attr_reader :file
-    end
-  end
-end

data/lib/pg_export/entities/encrypted_dump.rb

@@ -1,7 +0,0 @@
-class PgExport
-  class EncryptedDump < Dump::Base
-    def name
-      'Encrypted Dump'
-    end
-  end
-end

data/lib/pg_export/entities/plain_dump.rb

@@ -1,7 +0,0 @@
-class PgExport
-  class PlainDump < Dump::Base
-    def name
-      'Dump'
-    end
-  end
-end