sacback 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83bc1c9dd28613bc0b8d1cea52f5b184dcb3f973
+  data.tar.gz: 46b2464c5306818f8b6652c2e4bd7ac3ea31196c
+SHA512:
+  metadata.gz: a4b0938d093e2eef1fa4d06d8e771285d5f59c4919f7ee94cd0bda09bcc786fa8e8e73ff32b506a0c9f59b1fffcaad74556808bc8fe7484d64180912b62efb42
+  data.tar.gz: c109d33c5978ec2398b36604cf5f4eac339ffd2934aeeb13375872856bbadd0d4b1a219cb1552d3c3df4dc503430c90f95e58a485d84e47bac2ba202407d5c1d

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sacback.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Eiichi Shimotori
+
+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,106 @@
+# Sacback
+
+Sacbackはさくらのクラウドのディスクをローカルホストにバックアップするツールです。 (Sakura Cloud Backup tool)
+
+以下の一連の処理を一気に実行します。また、それぞれの処理を個別に実行することもできます。
+
+1. さくらのクラウド上でディスクのアーカイブを作成
+1. アーカイブをローカルホストにダウンロード
+1. さくらのクラウド上のアーカイブを削除
+1. ローカルのアーカイブファイルを圧縮
+
+
+## セットアップ
+
+まだgem化していないため、プロジェクトをクローンしてください。
+
+```
+$ git clone https://github.com/shimotori/sacback.git
+$ cd sacback
+$ bundle install
+```
+
+さくらのクラウドの認証情報とゾーン名を以下の環境変数にセットします。
+
+* SACLOUD_TOKEN: アクセス・トークン
+
+* SACLOUD_SECRET: アクセス・トークン・シークレット
+
+* SACLOUD_ZONE: ゾーン名（石狩第1: is1a, 石狩第2: is1b）
+
+
+
+## 使い方
+
+```
+$ bundle exec bin/sacback
+Commands:
+  sacback a DISK_NAME [LOCAL_DIR_PATH]   # Run all through with the disk (def...
+  sacback c DISK_NAME                    # Create an archive from the disk
+  sacback g ARCHIVE_ID [LOCAL_DIR_PATH]  # Get the archive (default path: /tmp)
+  sacback help [COMMAND]                 # Describe available commands or one...
+  sacback r ARCHIVE_ID                   # Remove the archive
+  sacback z LOCAL_DIR [FILE_NAME]        # Compress the local file (default f...
+
+Options:
+  -s, [--silent], [--no-silent]  # Not write log messages
+      [--curl], [--no-curl]      # Use curl command for downloading
+      [--ftpblocksize=N]         # Block size on FTP transfer (KB) (not used on curl mode)
+                                 # Default: 512
+```
+
+まだgem化していないため、直接 `sacback` コマンドを使うことはできません。
+
+実行する時にはプロジェクトディレクトリーに移動して、`bundle exec bin/sacback` で実行してください。
+
+
+
+#### コマンド
+
+* a: すべての処理を一気に実行します。（以降のc, g, r, z）
+
+  例： `bundle exec bin/sacback a disk1 /backup`
+
+* c: さくらのクラウド上でディスクからアーカイブを作成します。
+
+  アーカイブ名：{ディスク名}-YYMMDD-HHMM
+
+* g: アーカイブをローカルホストにダウンロードします。
+
+  デフォルトファイル名：archive.img
+
+* r: さくらのクラウド上でアーカイブを削除します。
+
+* z: ローカルホストのファイルを圧縮します。（gzip）
+
+  圧縮ファイル名：{アーカイブ名}.gz
+
+
+
+#### オプション
+
+-s, --silent: ログメッセージを表示しません。cronなどで実行する場合はこのオプションを指定してください。
+
+--curl: アーカイブのダウンロードをcurlで行います。デフォルトでは [DoubleBagFTPS](https://github.com/bnix/double-bag-ftps) を使用しますが非常に遅いため、curlが使える環境ではこのオプションの使用をお勧めします。
+
+--ftpblocksize=N: アーカイブダウンロード時のブロックサイズを指定します（KB単位）。curlモードの場合は影響しません。
+
+
+
+#### 注意事項
+
+a, cコマンドのパラメーターで指定する「ディスク名」は部分一致となります。複数のディスク名が該当した場合は最初のものが使用されるため、ユニークに決まる名称を指定した方が良いでしょう。
+
+アーカイブのダウンロード時に、さくらのクラウドのコンソール上では、ステータスが「アップロード」と表示されます。今のところ原因がわかりませんが、動作上は問題ありません。
+
+さくらのクラウド側でたまに `HttpServiceUnavailableException` が発生することがあります。aコマンドで実行していた場合は、失敗した処理から個別に実行して継続することができます。
+
+
+
+## Contributing
+
+1. Fork it ( https://github.com/shimotori/sacback/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/bin/sacback

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'sacback'
+
+Sacback::CLI.start

data/lib/sacback.rb

@@ -0,0 +1,6 @@
+require "sacback/version"
+require "sacback/cli"
+
+module Sacback
+  # Your code goes here...
+end

data/lib/sacback/cli.rb

@@ -0,0 +1,189 @@
+# coding: utf-8
+
+require 'thor'
+require 'date'
+require 'zlib'
+require 'double_bag_ftps'
+require 'saklient/cloud/api'
+require 'sacback'
+require 'sacback/sacloud_request'
+
+
+module Sacback
+  class CLI < Thor
+    
+    ARCHIVE_IMAGE_NAME = 'archive.img'
+    DEFAULT_LOCAL_DIR_PATH = '/tmp'
+    FTP_PORT = 21
+    SACLOUD_API_VERSION = '1.1'
+
+    class_option :silent, type: :boolean, default: false, desc: 'Not write log messages', aliases: '-s'
+    class_option :curl, type: :boolean, default: false, desc: 'Use curl command for downloading'
+    class_option :ftpblocksize, type: :numeric, default: 512, desc: 'Block size on FTP transfer (KB) (not used on curl mode)'
+    
+    
+    desc "a DISK_NAME [LOCAL_DIR_PATH]", "Run all through with the disk (default path: #{DEFAULT_LOCAL_DIR_PATH})"
+    def a(disk_name, local_dir_path = DEFAULT_LOCAL_DIR_PATH)
+      log "a: Run all through: disk=#{disk_name}, local dir=#{local_dir_path}"
+      log
+      archive = invoke :c, [disk_name]
+      # log "archive: #{archive.id} #{archive.name}"
+      invoke :g, [archive.id, local_dir_path]
+      invoke :r, [archive.id]
+      compressed_file_name = archive.name + '.gz'
+      invoke :z, [local_dir_path, ARCHIVE_IMAGE_NAME, compressed_file_name]
+    end
+
+
+    desc "c DISK_NAME", "Create an archive from the disk"
+    def c(disk_name)
+      log "c: Create an archive: disk=#{disk_name}"
+      @api = authorize
+      disk = get_disk disk_name
+      # say "disk: #{disk.id}"
+      archive = create_archive disk
+      log "The archive was created: id=#{archive.id}, name=#{archive.name}"
+      log
+      archive
+    end
+
+
+    desc "g ARCHIVE_ID [LOCAL_DIR_PATH]", "Get the archive (default path: #{DEFAULT_LOCAL_DIR_PATH})"
+    def g(archive_id, local_dir_path = DEFAULT_LOCAL_DIR_PATH)
+      log "g: Get the archive: archive id=#{archive_id}, local dir=#{local_dir_path}"
+      @api = authorize
+      archive = @api.archive.get_by_id archive_id
+      log "archive: #{archive.id} #{archive.name}"
+      
+      archive.open_ftp
+      log 'ftp opened'
+      begin
+        ftp_info = archive.ftp_info
+        # log "ftp: #{ftp_info.user},#{ftp_info.password},#{ftp_info.host_name}"
+
+        local_file = File.join local_dir_path, ARCHIVE_IMAGE_NAME
+        if options[:curl]
+          download_with_curl ftp_info, local_file
+        else
+          download_with_doublebugftps ftp_info, local_file
+        end
+        
+      ensure
+        archive.close_ftp
+        log 'ftp closed'
+      end
+      log
+    end
+
+
+    desc "r ARCHIVE_ID", "Remove the archive"
+    def r(archive_id)
+      log "r: Remove the archive: archive id=#{archive_id}"
+      request = create_rest_api_request
+      result = request.send :delete, "/archive/#{archive_id}"
+      if result['Success'] && result['is_ok']
+        log "The archive #{archive_id} was removed."
+      else
+        abort "Error: removing the archive #{archive_id} failed"
+      end
+      log
+    end
+
+
+    desc "z LOCAL_DIR FILE_NAME COMPRESSED_NAME", "Compress the local file (default file name: #{ARCHIVE_IMAGE_NAME})"
+    def z(dir, name_orig, name_new)
+      log "z: Compress the local file: local dir=#{dir}, target file=#{name_orig}, compressed file=#{name_new}"
+      path_orig = File.join dir, name_orig
+      path_new = File.join dir, name_new
+      log "Start compressing #{path_orig} to #{path_new}"
+      # Zlib::GzipWriter.open(path_new, Zlib::BEST_COMPRESSION) do |gz|
+      #   gz.mtime = File.mtime(path_orig)
+      #   gz.orig_name = name_orig
+      #   File.open(path_orig, 'rb') do |fp|
+      #     while chunk = fp.read(1024 * 1024) do
+      #       gz.puts chunk
+      #     end
+      #   end
+      # end
+      command = "(gzip -c #{path_orig} > #{path_new}) && rm #{path_orig}"
+      `#{command}`
+      log "Compression succeeded: #{path_new}"
+      log
+    end
+    
+    
+    
+    
+    private
+    
+    def log(text = '')
+      say text  unless options[:silent]
+    end
+
+
+    def authorize
+      Saklient::Cloud::API::authorize ENV['SACLOUD_TOKEN'], ENV['SACLOUD_SECRET'], ENV['SACLOUD_ZONE']
+    end
+
+
+    # Get the disk data whose name includes the specific name
+    def get_disk(name)
+      disks = @api.disk.with_name_like(name).limit(1).find()
+      abort "Error: disk is not found: #{name}"  if disks.count == 0
+      
+      disks[0]
+    end
+
+
+    def create_archive(disk)
+      datetime = DateTime.now.strftime "%Y%m%d-%H%M"
+      archive_name = "#{disk.name}-#{datetime}"
+      log "Creating a new archive: #{archive_name}"
+
+      archive = @api.archive.create
+      archive.name = archive_name
+      archive.source = disk
+      archive.save
+      result = archive.sleep_while_copying
+      abort "Creating the archive failed: #{archive_name}"  unless result
+
+      log "Creating the archive succeeded: #{archive_name}"
+      archive
+    end
+
+
+    def create_rest_api_request
+      Sacback::SacloudRequest.new(ENV['SACLOUD_TOKEN'], ENV['SACLOUD_SECRET'], ENV['SACLOUD_ZONE'], SACLOUD_API_VERSION)
+    end
+    
+    
+    def download_with_doublebugftps(ftp_info, local_file)
+      BasicSocket.do_not_reverse_lookup = true
+      ftps = DoubleBagFTPS.new
+      ftps.ftps_mode = DoubleBagFTPS::EXPLICIT
+      ftps.passive = true
+      # ftps.debug_mode = true
+      block_size = options[:ftpblocksize] * 1024
+      ftps.connect ftp_info.host_name, FTP_PORT
+      begin
+        ftps.login ftp_info.user, ftp_info.password
+        log "Start downloading (DoubleBagFTPS): remote file=#{ARCHIVE_IMAGE_NAME}, local file=#{local_file}, block size=#{block_size} bytes"
+        ftps.getbinaryfile ARCHIVE_IMAGE_NAME, local_file, block_size
+        log "Finished downloading: #{local_file}"
+      ensure
+        ftps.close  unless ftps.closed?
+      end
+    end
+    
+    
+    def download_with_curl(ftp_info, local_file)
+      url = "ftp://#{ftp_info.host_name}/#{ARCHIVE_IMAGE_NAME}"
+      auth = "-u #{ftp_info.user}:#{ftp_info.password}"
+      silent = options[:silent] ? '-s -S' : ''  # Show errors only
+      log "Start downloading (curl): remote file=#{ARCHIVE_IMAGE_NAME}, local file=#{local_file}"
+      command = "curl --ftp-ssl --ftp-pasv #{silent} #{auth} -o #{local_file} #{url}"
+      `#{command}`
+      log "Finished downloading: #{local_file}"
+    end
+  end
+end

data/lib/sacback/sacloud_request.rb

@@ -0,0 +1,53 @@
+# coding: utf-8
+
+require 'net/https'
+require 'uri'
+
+
+module Sacback
+  class SacloudRequest
+  
+    def initialize(token, secret, zone, api_version = '1.1')
+      @token = token
+      @secret = secret
+      @base_url = "https://secure.sakura.ad.jp/cloud/zone/#{zone}/api/cloud/#{api_version}"
+    end
+  
+  
+    # Send a request
+    def send(method, path, params = {})
+      uri = URI.parse(@base_url + path)
+  
+      # HTTPS setting
+      https = Net::HTTP.new(uri.host, uri.port)
+      https.use_ssl = true
+      https.verify_mode = OpenSSL::SSL::VERIFY_NONE
+  
+      # Set the request class
+      request_class = case method
+                        when :get     then Net::HTTP::Get
+                        when :post    then Net::HTTP::Post
+                        when :delete  then Net::HTTP::Delete
+                        when :put     then Net::HTTP::Put
+                        else
+                          raise ArgumentError, 'invalid method'
+                      end
+  
+      # Basic Auth setting
+      request = request_class.new(uri.path)
+      request.basic_auth @token, @secret
+  
+      # Parameter setting
+      request.body = JSON.generate(params)  if (method == :post) || (method == :put)
+  
+      # Send the request
+      response = https.start do |x|
+        x.request request
+      end
+
+      # Return the body as JSON 
+      JSON.parse response.body
+    end
+    
+  end
+end

data/lib/sacback/version.rb

@@ -0,0 +1,3 @@
+module Sacback
+  VERSION = "0.0.3"
+end

data/sacback.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sacback/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sacback"
+  spec.version       = Sacback::VERSION
+  spec.authors       = ["Eiichi Shimotori"]
+  spec.email         = ["eiichi.shimotori@gmail.com"]
+  spec.summary       = %q{Sakura Cloud disk backup tool}
+  spec.description   = %q{Command line tool to backup a disk on Sakura Cloud}
+  spec.homepage      = "https://github.com/shimotori/sacback"
+  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 "thor"
+  spec.add_dependency "saklient"
+  spec.add_dependency "double-bag-ftps"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: sacback
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Eiichi Shimotori
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-28 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: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: saklient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: double-bag-ftps
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Command line tool to backup a disk on Sakura Cloud
+email:
+- eiichi.shimotori@gmail.com
+executables:
+- sacback
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/sacback
+- lib/sacback.rb
+- lib/sacback/cli.rb
+- lib/sacback/sacloud_request.rb
+- lib/sacback/version.rb
+- sacback.gemspec
+homepage: https://github.com/shimotori/sacback
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Sakura Cloud disk backup tool
+test_files: []