mikrotik-backup 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b93e44f47ccf7b94c5299f3d31fac447e7baf9b0
-  data.tar.gz: dc642aa5811d8f1dcded8f641edb3ca1e2029312
+  metadata.gz: 96593143d646861c03ba188f955a05c94858800c
+  data.tar.gz: 546c4eb084bde83820b1c06ca6bb0f8eae5a9287
 SHA512:
-  metadata.gz: e873503d5f54fae05ce646bb5a87e37039e0943e021150933edd1bda5ee82cbb0da9318c241c792863b0f4d73a351b1cdd1cf672573465d492e4a4a58ad044ee
-  data.tar.gz: fc331b9138099b15c6043e8a3d929dd73047cffcd26ea9caf277c0cd76a7afaeb29db355494a58723e720d50d51a504931036b71fc5ab3e4843418fc241d7668
+  metadata.gz: 086ef209caca808523f1fc4209cd13193ca68b1a21d517690ccaacf5919486736afd85c64fa0c63aefeb702263d5ad9cb4bee97256bdf706e86967cea6deb3dc
+  data.tar.gz: 68e3b92844951dcfdeb6059d234274d4c28f878453469016ed3261e4372d7d284671fb8ccabe07073e2cf8637b7723a15143f78e1db5b47fb07e3bc493313c99

data/.gitignore

@@ -1,16 +1,16 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-/.idea/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/.idea/
 *.gem

data/Gemfile

@@ -1,8 +1,8 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in mikrotik_backup.gemspec
-gemspec
-# Add Net::SSH GEM
-gem 'net-ssh'
-# Add Net::SFTP GEM
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mikrotik_backup.gemspec
+gemspec
+# Add Net::SSH GEM
+gem 'net-ssh'
+# Add Net::SFTP GEM
 gem 'net-sftp'

data/LICENSE.txt

@@ -1,22 +1,22 @@
-Copyright (c) 2015 POS_troi
-
-MIT License
-
-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.
+Copyright (c) 2015 POS_troi
+
+MIT License
+
+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

@@ -1,75 +1,79 @@
-[![Gem Version](https://badge.fury.io/rb/mikrotik-backup.svg)](http://badge.fury.io/rb/mikrotik-backup)
-
-# Mikrotik Backup
-
-Backup MikroTik configuration using SSH and SFTP.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'mikrotik-backup'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install mikrotik-backup
-
-## Usage
-
-```ruby
-
-require 'mikrotik-backup'
-#Config
-# name - associate host name (and name backup file)
-# host - host address
-# user - user name
-# password - user password
-# path - local folder for save backup file. "/var/backup/"
-config = [
-    {name:'Router1', host: '10.10.10.1' , user:'admin' , password:'admin', path:'./'},
-    {name:'Router2', host: '10.10.10.2' ,user:'admin' ,password:'admin', path: './'}
-]
-
-
-backup = MTik_backup.new(config)
-# Logging
-backup.logger(Logger::ERROR)
-# Start backup and download
-backup.backup(true) # <-- "false" - enable only create backup and not download
-```
-### Logging
-```ruby
-# Logging only Error, out to console
-logger
-
-# Full log out to console
-logger(Logger::DEBUG)
-
-# Full log out to file 
-logger(Logger::DEBUG,'backup.log')
-```
-
-### Only Download backup (previously created)
-```ruby
-config = [
-    {name:'Router1', host: '10.10.10.1' , user:'admin' , password:'admin', path:'./'},
-    {name:'Router2', host: '10.10.10.2' ,user:'admin' ,password:'admin', path: './'}
-]
-
-backup = MTik_backup.new(config)
-backup.download
-```
-
-## Contributing
-
-1. Fork it ( https://github.com/POStroi/ruby_mikrotik_backup/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+[![Gem Version](https://badge.fury.io/rb/mikrotik-backup.svg)](http://badge.fury.io/rb/mikrotik-backup)
+
+# Mikrotik Backup
+
+Backup MikroTik configuration using SSH and SFTP.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mikrotik-backup'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mikrotik-backup
+
+## Usage
+
+### Backup only
+```ruby
+
+require 'mikrotik-backup'
+
+#Time format
+time = Time.now.strftime("%d-%m-%Y")
+
+#Config
+# name - associate host name (and name backup file)
+# host - host address
+# user - user name
+# password - user password
+# path - local folder for save backup file. "/var/backup/"
+# format - backup file format, 'binary' or 'script'
+config = [
+    {name:"Router1-#{time}", host: '10.10.10.1', user:'admin', password:'admin', path:'./', format:'binary'},
+    {name:"Router2-#{time}", host: '10.10.10.2', user:'admin', password:'admin', path:'./', format:'script'}
+]
+
+
+backup = MTik_backup.new(config)
+# Start backup
+backup.backup
+```
+
+### Only Download backup (previously created)
+```ruby
+backup.download
+```
+
+### Create backup and download
+```ruby
+backup.backup_and_download
+```
+
+### Logging
+```ruby
+# Logging only Error, out to console
+backup.logger(Logger::ERROR) #<- Default
+
+# Full log out to console
+backup.logger(Logger::DEBUG)
+
+# Full log out to file
+backup.logger(Logger::DEBUG,'backup.log')
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/POStroi/ruby_mikrotik_backup/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -1,2 +1,2 @@
-require "bundler/gem_tasks"
-
+require "bundler/gem_tasks"
+

data/lib/mikrotik-backup.rb

@@ -1,89 +1,108 @@
-require "mikrotik-backup/version"
-require 'net/ssh'
-require 'net/sftp'
-# MikroTik backup class
-class MTik_backup
-  # Initialize
-  def initialize(config)
-    @config = config
-    logger
-  end
-  # Setting for Ruby Logger
-  def logger(log_level = Logger::ERROR,log_file = nil)
-    if log_file.nil?
-      @log = Logger.new(STDOUT)
-    else
-      @log = Logger.new(log_file)
-    end
-    @log.level = log_level
-    @log.formatter = proc { |severity, datetime, progname, msg|
-      "[#{datetime.strftime("%Y-%m-%d %H:%M:%S")}] #{severity}: #{msg}\n"
-    }
-  end
-
-  # Backup and download MTik config
-  def backup(download=false)
-    @config.each do |config|
-      connect_to_host(config[:host],config[:user],config[:password])
-      backup_config(config[:name])
-      download_backup(config[:host],config[:user],config[:password],config[:name],config[:path]) if download
-    end
-  end
-  # Only download MTik config
-  def download
-    @config.each do |config|
-      download_backup(config[:host],config[:user],config[:password],config[:name],config[:path])
-    end
-  end
-
-  # Private section
-  private
-  # Function connect to SSH/SFTP host
-  def connect_to_host(host,user,password,sftp=false)
-    begin
-      if sftp
-        @log.info("SFTP connect to host #{host}")
-        @ssh_connect = Net::SFTP.start(host,user,:password=>password)
-      else
-        @log.info("SSH connect to host #{host}")
-        @ssh_connect = Net::SSH.start(host,user,:password=>password)
-      end
-    rescue Exception => error
-      @log.error("#{error}")
-      exit
-    end
-  end
-  # Backup function, send SSH command
-  def backup_config(name)
-    @log.info("Backup MikroTik configuration")
-    send_command("/export file=#{name}")
-    @ssh_connect.close
-  end
-  # Download backup file from host
-  def download_backup(host,user,password,name,path)
-    connect_to_host(host,user,password,true)
-    local_file = path+name+".rsc"
-    remote_file = name+".rsc"
-    download_file(remote_file,local_file)
-    @ssh_connect.close(@ssh_connect)
-  end
-  # Send command to host (SSH)
-  def send_command(command)
-    begin
-      @ssh_connect.exec!(command)
-    rescue Exception => error
-      @log.error("#{error}")
-    end
-  end
-  # Download file from host
-  def download_file(remote_file, local_file)
-    begin
-      @log.info("Download file #{remote_file} to #{local_file}")
-      @ssh_connect.download!(remote_file,local_file)
-    rescue Exception => error
-      @log.error("#{error}")
-      exit
-    end
-  end
-end
-
+require "mikrotik-backup/version"
+require 'net/ssh'
+require 'net/sftp'
+# MikroTik backup class
+# noinspection RubyArgCount
+class MTik_backup
+  # Initialize
+  def initialize(config)
+    @config = config
+    logger
+  end
+  # Setting for Ruby Logger
+  def logger(log_level = Logger::ERROR,log_file = nil)
+    if log_file.nil?
+      @log = Logger.new(STDOUT)
+    else
+      @log = Logger.new(log_file)
+    end
+    @log.level = log_level
+    @log.formatter = proc { |severity, datetime, progname, msg|
+      "[#{datetime.strftime("%Y-%m-%d %H:%M:%S")}] #{severity}: #{msg}\n"
+    }
+  end
+  # Backup MTik config
+  def backup
+    @config.each do |config|
+      connect_to_host(config[:host],config[:user],config[:password])
+      backup_config(config[:name],config[:format])
+    end
+    return true
+  end
+  # Only download MTik config
+  def download
+    @config.each do |config|
+      download_backup(config[:host],config[:user],config[:password],config[:name],config[:path],config[:format])
+    end
+    return true
+  end
+  # Backup and download MTik config
+  def backup_and_download
+    @config.each do |config|
+      connect_to_host(config[:host],config[:user],config[:password])
+      backup_config(config[:name],config[:format])
+      download_backup(config[:host],config[:user],config[:password],config[:name],config[:path],config[:format])
+    end
+    return true
+  end
+
+# Private section
+  private
+  # Function connect to SSH/SFTP host
+  def connect_to_host(host,user,password,sftp=false)
+    begin
+      if sftp
+        @log.info("SFTP connect to host #{host}")
+        @ssh_connect = Net::SFTP.start(host,user,:password=>password)
+      else
+        @log.info("SSH connect to host #{host}")
+        @ssh_connect = Net::SSH.start(host,user,:password=>password)
+      end
+    rescue Exception => error
+      @log.error("#{error}")
+      exit
+    end
+  end
+  # Backup function, send SSH command
+  def backup_config(name,format='binary')
+    @log.info("Backup MikroTik configuration")
+    if format == 'binary'
+      send_command("/system backup save name=#{name}")
+    elsif format == 'script'
+      send_command("/export file=#{name}")
+    end
+    @ssh_connect.close
+  end
+  # Download backup file from host
+  def download_backup(host,user,password,name,path,format)
+    connect_to_host(host,user,password,true)
+    if format == 'binary'
+      local_file = path+name+".backup"
+      remote_file = name+".backup"
+    elsif format== 'script'
+      local_file = path+name+".rsc"
+      remote_file = name+".rsc"
+    end
+    download_file(remote_file,local_file)
+    @ssh_connect.close(@ssh_connect)
+  end
+  # Send command to host (SSH)
+  def send_command(command)
+    begin
+      @ssh_connect.exec!(command)
+    rescue Exception => error
+      @log.error("#{error}")
+    end
+  end
+  # Download file from host
+  def download_file(remote_file, local_file)
+    begin
+      @log.info("Download file #{remote_file} to #{local_file}")
+      @ssh_connect.download!(remote_file,local_file)
+    rescue Exception => error
+      @log.error("#{error}")
+      exit
+    end
+  end
+end
+

data/lib/mikrotik-backup/version.rb

@@ -1,3 +1,3 @@
-module MikrotikBackup
-  VERSION = "0.0.3"
-end
+module MikrotikBackup
+  VERSION = "0.0.4"
+end

data/mikrotik-backup.gemspec

@@ -1,25 +1,25 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'mikrotik-backup/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "mikrotik-backup"
-  spec.version       = MikrotikBackup::VERSION
-  spec.authors       = ["POS_troi"]
-  spec.email         = ["root@sysalex.com"]
-  spec.summary       = %q{Backup MikroTik configuration using SSH and SFTP.}
-  spec.description   = %q{Backup MikroTik configuration using SSH and SFTP.}
-  spec.homepage      = "https://sysalex.com"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_dependency "net-ssh", "~> 2.9"
-  spec.add_dependency "net-sftp", "~> 2.1"
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mikrotik-backup/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mikrotik-backup"
+  spec.version       = MikrotikBackup::VERSION
+  spec.authors       = ["POS_troi"]
+  spec.email         = ["root@sysalex.com"]
+  spec.summary       = %q{Backup MikroTik configuration using SSH and SFTP.}
+  spec.description   = %q{Backup MikroTik configuration using SSH and SFTP.}
+  spec.homepage      = "https://sysalex.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "net-ssh", "~> 2.9"
+  spec.add_dependency "net-sftp", "~> 2.1"
 end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: mikrotik-backup
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - POS_troi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-10 00:00:00.000000000 Z
+date: 2015-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.9'
 - !ruby/object:Gem::Dependency
   name: net-sftp
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.1'
 description: Backup MikroTik configuration using SSH and SFTP.
@@ -73,7 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -91,17 +91,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Backup MikroTik configuration using SSH and SFTP.