mikrotik-backup 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b288aab7fe3d49ac9b2e68587b8a95a2afea05d0
+  data.tar.gz: dc8e155bb93ce960ca7dff440aa238962a2b6bcc
+SHA512:
+  metadata.gz: ee55e02d69f097410c1da458a518ef01b49a3bba33836a3a0480ff6d8567e5d20e723069a9e39f31b3b2b685503757e1c7be78cbc18b1acec5d52316b97dd119
+  data.tar.gz: f1df4edbbfad16dda89663c5291cddf09285193508dcb68a37d6b882e3742bb7c944dcfba8826574d7707c422dc781b1000fae6665c0936701d6e5002429e6f0

data/.gitignore

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

data/Gemfile

@@ -0,0 +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
+gem 'net-sftp'

data/LICENSE.txt

@@ -0,0 +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.

data/README.md

@@ -0,0 +1,73 @@
+# 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

data/Rakefile

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

data/lib/mikrotik-backup.rb

@@ -0,0 +1,89 @@
+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
+

data/lib/mikrotik-backup/version.rb

@@ -0,0 +1,3 @@
+module MikrotikBackup
+  VERSION = "0.0.1"
+end

data/mikrotik-backup.gemspec

@@ -0,0 +1,23 @@
+# 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"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: mikrotik-backup
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- POS_troi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-10 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'
+description: Backup MikroTik configuration using SSH and SFTP.
+email:
+- root@sysalex.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mikrotik-backup.rb
+- lib/mikrotik-backup/version.rb
+- mikrotik-backup.gemspec
+homepage: https://sysalex.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Backup MikroTik configuration using SSH and SFTP.
+test_files: []