sakura-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: efd5e983753789e52601e9ac4a964b12126a4332
+  data.tar.gz: 738d21ce3ec8ead5bbc4a299cc2facb31d01c780
+SHA512:
+  metadata.gz: 1e0ff298884e5271b0b22a4b30d9500c603fa0597b6db756546a225b77ce0f64d17efd72c58f19d0c59bc95a23b22cc30e021f9b67bb422dbc1dd1cb649a3f4a
+  data.tar.gz: 7ea1e26078515dc5bffd37667870683d1a9c2380c0a6fa0f6da8b452fbf9a022d3903f6c0fdcf91d65b2e97335675f258c4517101530c49e2986487672bddfad

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Shintaro Kojima
+
+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,170 @@
+# Sakura CLI
+
+Sakura CLI は, [さくらのレンタルサーバー](http://www.sakura.ne.jp/)のコントロールパネルをコマンドラインから制御するためのツールです.
+
+:construction: このバージョンでは, ライト/スタンダード/プレミアムに共通する **メールアドレス管理** 機能のみサポートします
+
+## セットアップ
+
+Sakura CLI をインストールします.
+
+```zsh
+gem install sakura-cli
+```
+
+Sakura CLI は[PhantomJS](http://phantomjs.org/download.html) に依存しています.
+お使いのOS に合った方法でインストールしてください.
+
+Mac の場合は
+
+```zsh
+brew install phantomjs
+```
+
+でもインストールできます.
+
+### 環境設定
+
+ログイン情報を環境変数に設定します.
+
+```zsh
+export SAKURA_DOMAIN='example.com'
+export SAKURA_PASSWD='your_password'
+```
+
+[dotenv](https://github.com/bkeepers/dotenv) を使うと便利かもしれません.
+
+```zsh
+# ~/.sakura.env (dotenv の場合)
+
+SAKURA_DOMAIN='example.com'
+SAKURA_PASSWD='your_password'
+```
+
+場合によっては[direnv](https://github.com/zimbatm/direnv) もいいでしょう.
+
+
+## 使いかた
+
+```sakura help``` や ```sakura mail help``` コマンドでヘルプが表示できます.
+
+```zsh
+$ sakura help
+Commands:
+  sakura help [COMMAND]  # Describe available commands or one specific command
+  sakura mail            # Manage mail addresses
+
+$ sakura mail help
+Commands:
+  sakura mail create LOCAL_PART [PASSWORD]             # Create a mail address
+  sakura mail delete LOCAL_PART                        # Delete a mail address
+  sakura mail forward LOCAL_PART [{add|remove} EMAIL]  # Add, remove or show mail address(es) to forward
+  sakura mail help [COMMAND]                           # Describe subcommands or one specific subcommand
+  sakura mail keep LOCAL_PART [enable|disable]         # Switch keep or flush mails
+  sakura mail list                                     # List all mail addresses of the domain
+  sakura mail password LOCAL_PART [PASSWORD]           # Update password of a mail address
+  sakura mail quota LOCAL_PART [VALUE]                 # Update or show quota of a mail address
+  sakura mail scan LOCAL_PART [enable|disable]         # Switch virus scan
+```
+
+### メールアドレス一覧
+
+```sakura mail list``` コマンドで, メールアドレス一覧とその概要を表示できます.
+
+```zsh
+$ sakura mail list
+# domain: example.com
+address              virus_scan        usage /     quota
+---------------------------------------------------------
+dummy                      true     379.13KB /     200MB
+dummy001                   true       1.79MB /       2GB
+dummy002                   true       6.28KB /       2GB
+postmaster                 true           0B /       2GB
+```
+
+### メールアドレス作成
+
+```sakura mail create``` コマンドで, メールアドレスを作成できます.
+
+```zsh
+$ sakura mail create dummy
+password?
+password(confirm)?
+```
+
+コマンド引数に初期パスワードを指定することもできます.
+
+### メールアドレス削除
+
+```sakura mail delete``` コマンドで, メールアドレスを削除できます.
+
+### クォータ表示・変更
+
+```sakura mail quota``` コマンドで, 現在のクォータを表示・変更できます.
+
+```zsh
+$ sakura mail quota dummy     # 現在のクォータを表示
+200MB
+
+$ sakura mail quota dummy 300 # 300MB に変更
+```
+
+変更する場合, 単位はMB です.
+
+### パスワード変更
+
+```sakura mail password``` コマンドで, パスワードをリセットできます.
+
+```zsh
+$ sakura mail password dummy
+password?
+password(confirm)?
+```
+
+コマンド引数に初期パスワードを指定することもできます.
+
+### メール転送
+
+```sakura mail forward``` コマンドで, 転送先リストを表示・編集できます.
+
+```zsh
+$ sakura mail forward dummy                         # 転送先リストを表示
+foo@example.com
+$ sakura mail forward dummy add bar@example.com     # 転送先に追加
+$ sakura mail forward dummy remove bar@example.com  # 転送先から削除
+```
+
+```sakura mail keep``` コマンドで, メールをメールボックスに残すか/転送専用にするか の設定を表示・変更できます.
+
+```zsh
+$ sakura mail keep dummy          # 設定を表示
+true
+$ sakura mail keep dummy disable  # メールボックスに残す
+```
+
+### ウィルスチェック
+
+```sakura mail scan``` コマンドで, ウィルスチェックの設定を表示・変更できます.
+
+```zsh
+$ sakura mail scan dummy         # ウィルスチェックの設定を表示
+false
+$ sakura mail scan dummy enable  # 有効にする
+```
+
+## その他
+
+### dotenv から起動
+
+```~/.sakura.env``` に環境変数一覧がある場合
+
+```zsh
+dotenv -f ~/.sakura.env sakura
+```
+
+のように実行します.
+
+
+## Copyright and License
+
+Copyright (c) 2015 Shintaro Kojima. Code released under the [MIT license](LICENSE).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.verbose = true
+end
+
+desc 'Run tests'
+task :default => :test

data/exe/sakura

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+
+$: << File.expand_path('../../lib', Pathname.new(__FILE__).realpath)
+
+require 'sakura/cli/root'
+Sakura::Cli::Root.start

data/lib/sakura.rb

@@ -0,0 +1,5 @@
+require 'uri'
+
+module Sakura
+  BASE_URL = URI('https://secure.sakura.ad.jp/rscontrol/')
+end

data/lib/sakura/cli/mail.rb

@@ -0,0 +1,153 @@
+require 'thor'
+require 'sakura'
+require 'sakura/client'
+require 'sakura/mail_address'
+
+module Sakura
+  module Cli
+    class Mail < Thor
+      desc 'list', 'List all mail addresses of the domain'
+      def list
+        addrs = MailAddress.all
+
+        puts "# domain: #{Client.current_session.domain}"
+        puts MailAddress.header
+        addrs.each {|addr| puts addr.to_s }
+      end
+
+      desc 'create LOCAL_PART [PASSWORD]', 'Create a mail address'
+      def create(local_part, password=nil)
+        password ||= ask_password
+
+        begin
+          MailAddress.create local_part, password
+        rescue
+          abort $!
+        end
+      end
+
+      desc 'delete LOCAL_PART', 'Delete a mail address'
+      def delete(local_part)
+        mail = MailAddress.find(local_part)
+        abort %(No mail address: "#{local_part}") unless mail
+
+        begin
+          mail.delete
+        rescue
+          abort $!
+        end
+      end
+
+      desc 'quota LOCAL_PART [VALUE]', 'Update or show quota of a mail address'
+      def quota(local_part, value=nil)
+        mail = MailAddress.find(local_part)
+        abort %(No mail address: "#{local_part}") unless mail
+
+        begin
+          if value
+            mail.quota = value
+          else
+            puts mail.quota
+          end
+        rescue
+          abort $!
+        end
+      end
+
+      desc 'password LOCAL_PART [PASSWORD]', 'Update password of a mail address'
+      def password(local_part, password=nil)
+        password ||= ask_password
+        mail = MailAddress.find(local_part)
+        abort %(No mail address: "#{local_part}") unless mail
+
+        begin
+          mail.password = password
+        rescue
+          abort $!
+        end
+      end
+
+      desc 'scan LOCAL_PART [enable|disable]', 'Switch virus scan'
+      def scan(local_part, value=nil)
+        self.class.handle_argument_error if value && value !~ /enable|disable/
+
+        mail = MailAddress.find(local_part)
+        abort %(No mail address: "#{local_part}") unless mail
+
+        begin
+          case value
+          when 'enable'
+            mail.virus_scan = true
+          when 'disable'
+            mail.virus_scan = false
+          when nil
+            puts mail.virus_scan
+          end
+        rescue
+          abort $!
+        end
+      end
+
+      desc 'forward LOCAL_PART [{add|remove} EMAIL]', 'Add, remove or show mail address(es) to forward'
+      def forward(local_part, operation=nil, mail_to_forward=nil)
+        if (operation && operation !~ /add|remove/) || (!mail_to_forward && operation)
+          self.class.handle_argument_error
+        end
+
+        mail = MailAddress.find(local_part)
+        abort %(No mail address: "#{local_part}") unless mail
+
+        begin
+          case operation
+          when 'add'
+            mail.forward_to mail_to_forward
+          when 'remove'
+            mail.delete_forward_to mail_to_forward
+          when nil
+            mail.forward_list.each {|m| puts m }
+          end
+        rescue
+          abort $!
+        end
+      end
+
+      desc 'keep LOCAL_PART [enable|disable]', 'Switch keep or flush mails'
+      def keep(local_part, value=nil)
+        self.class.handle_argument_error if value && value !~ /enable|disable/
+
+        mail = MailAddress.find(local_part)
+        abort %(No mail address: "#{local_part}") unless mail
+
+        begin
+          case value
+          when 'enable'
+            mail.keep = true
+          when 'disable'
+            mail.keep = false
+          when nil
+            puts mail.keep
+          end
+        rescue
+          abort $!
+        end
+      end
+
+
+      private
+
+      def ask_password
+        password = ask('password?', echo: false)
+        puts
+        confirm  = ask('password(confirm)?', echo: false)
+        puts
+        abort "password doesn't match" unless password == confirm
+
+        password
+      end
+
+      def abort(message)
+        super "\nERROR: #{message}"
+      end
+    end
+  end
+end

data/lib/sakura/cli/root.rb

@@ -0,0 +1,11 @@
+require 'thor'
+require 'sakura/cli/mail'
+
+module Sakura
+  module Cli
+    class Root < Thor
+      desc 'mail', 'Manage mail addresses'
+      subcommand 'mail', Mail
+    end
+  end
+end

data/lib/sakura/cli/version.rb

@@ -0,0 +1,5 @@
+module Sakura
+  module Cli
+    VERSION = "0.1.0"
+  end
+end

data/lib/sakura/client.rb

@@ -0,0 +1,73 @@
+require 'capybara/poltergeist'
+require 'sakura'
+require 'sakura/cli/version'
+
+Capybara.default_driver = :poltergeist
+Capybara.current_session.driver.headers = {'User-Agent' => "sakura-cli/#{Sakura::Cli::VERSION}"}
+
+module Sakura
+  class Client
+    include Capybara::DSL
+
+    attr_reader :domain
+
+    def self.current_session
+      @current_session ||= new
+    end
+
+
+    def initialize
+      @domain, @passwd = credentials
+    end
+
+    def login?
+      !@last_login.nil?
+    end
+
+    def login
+      visit BASE_URL
+      fill_in 'domain',   with: @domain
+      fill_in 'password', with: @passwd
+      find('form input[type=image]').click
+
+      @last_login = Time.now if page.text =~ /ログインドメイン: #{@domain}/
+
+      raise_when_error
+      login?
+    end
+
+    def get(url)
+      login unless login?
+      visit url
+      page
+    end
+
+    def process(url, &block)
+      login unless login?
+      visit url
+      instance_eval &block
+
+      raise_when_error
+      page
+    end
+
+
+    private
+
+    def credentials
+      warn 'SAKURA_DOMAIN is not set' unless ENV['SAKURA_DOMAIN']
+      warn 'SAKURA_PASSWD is not set' unless ENV['SAKURA_PASSWD']
+
+      if ENV['SAKURA_DOMAIN'] && ENV['SAKURA_PASSWD']
+        [ENV['SAKURA_DOMAIN'], ENV['SAKURA_PASSWD']]
+      else
+        exit 1
+      end
+    end
+
+    def raise_when_error
+      error = page.all('.error-message')
+      raise error.first.text unless error.empty?
+    end
+  end
+end

data/lib/sakura/mail_address.rb

@@ -0,0 +1,164 @@
+require 'sakura/client'
+
+module Sakura
+  class MailAddress
+    MAIL_URL = BASE_URL + 'rs/mail'
+
+    attr_reader :address, :virus_scan, :usage, :quota, :link, :link_to_delete
+
+    class << self
+      def create(local_part, password)
+        Client.current_session.process(MAIL_URL) do
+          fill_in 'NewUsername', with: local_part
+          fill_in 'Password1',   with: password
+          fill_in 'Password2',   with: password
+          find('input[name="Submit_useradd"]').click
+        end
+
+        true
+      end
+
+      def all
+        page = Client.current_session.get(MAIL_URL)
+
+        page.all(:xpath, '//a[contains(@href, "mail?Username=")]/../..').map{|element|
+          arguments = element.all('td').map(&:text)[0..-2] + element.all('a').map{|i| i[:href] }
+          MailAddress.new(*arguments)
+        }
+      end
+
+      def find(local_part)
+        all.find {|m| m.address == local_part }
+      end
+
+      def header
+        str = tabularize('address', 'virus_scan', 'usage', 'quota')
+        "#{str}\n#{'-' * (str.size+1)}"
+      end
+
+      def tabularize(*args)
+        args[0].ljust(20) <<
+          args[1].to_s.rjust(11) <<
+          "#{args[2]} /".to_s.rjust(15) <<
+          args[3].to_s.rjust(10)
+      end
+    end
+
+
+    def initialize(address, virus_scan, usage, quota, link, link_to_delete=nil)
+      @address        = address
+      @virus_scan     = virus_scan == '○'
+      @usage          = usage
+      @quota          = quota
+      @link           = link
+      @link_to_delete = link_to_delete
+    end
+
+    def delete
+      link = @link_to_delete
+      Client.current_session.process(MAIL_URL) do
+        find("a[href=\"#{link}\"]").click
+      end
+
+      true
+    end
+
+    def quota=(value)
+      page = Client.current_session.process(MAIL_URL + @link) {
+        fill_in 'MailQuota', with: value
+        find('input[name="Submit_quotaedit"]').click
+      }
+
+      page.text =~ /利用中のディスク領域: \S+ \/ (\S+)/
+      @quota = $1
+    end
+
+    def password=(value)
+      Client.current_session.process(MAIL_URL + @link) do
+        fill_in 'Password1', with: value
+        fill_in 'Password2', with: value
+        find('input[name="Submit_password"]').click
+      end
+    end
+
+    def virus_scan=(value)
+      value = value ? 1 : 0
+      Client.current_session.process(MAIL_URL + @link) do
+        find("input[name='VirusScan'][value='#{value}']").click
+      end
+
+      @virus_scan = value == 1
+    end
+
+    def enable_virus_scan
+      virus_scan = true
+    end
+
+    def disable_virus_scan
+      virus_scan = false
+    end
+
+    def keep
+      if @keep.nil?
+        page = Client.current_session.get(MAIL_URL + @link)
+        @keep = page.find('input[name="Save"]:checked').value == '1'
+      end
+
+      @keep
+    end
+
+    def keep=(value)
+      value = value ? 1 : 0
+      Client.current_session.process(MAIL_URL + @link) do
+        find("input[name='Save'][value='#{value}']").click
+      end
+
+      @keep = value == 1
+    end
+
+    def enable_keep
+      keep = true
+    end
+
+    def disable_keep
+      keep = false
+    end
+
+    def forward_list
+      if @forward_list.nil?
+        page = Client.current_session.get(MAIL_URL + @link)
+        @forward_list = page.all('select[name="DeleteAddress[]"] option').map(&:text)
+      end
+
+      @forward_list
+    end
+
+    def forward_to(mail)
+      Client.current_session.process(MAIL_URL + @link) do
+        execute_script <<-JS
+          var f = document.Transfer;
+          f.Address.value = '#{mail}';
+          f.SubAction.value = 'add';
+          f.submit();
+        JS
+      end
+
+      @forward_list ||= []
+      @forward_list << mail
+    end
+
+    def delete_forward_to(mail)
+      Client.current_session.process(MAIL_URL + @link) do
+        find_field('DeleteAddress[]').select(mail)
+        find('a[href="javascript:tr_delete();"]').click
+      end
+
+      @forward_list ||= []
+      @forward_list.delete mail
+    end
+
+    def to_s
+      self.class.tabularize(@address, @virus_scan, @usage, @quota)
+    end
+  end
+end

data/sakura-cli.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sakura/cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sakura-cli"
+  spec.version       = Sakura::Cli::VERSION
+  spec.authors       = ["Shintaro Kojima"]
+  spec.email         = ["goodies@codeout.net"]
+
+  spec.summary       = %q{Command-line tool for Sakura's Rental Server.}
+  spec.description   = %q{Command-line tool and client library to control the dashboard of Sakura Rental Server.}
+  spec.homepage      = "https://github.com/codeout/sakura-cli"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "poltergeist"
+  spec.add_runtime_dependency "thor"
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.required_ruby_version = '>= 2.0.0'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: sakura-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shintaro Kojima
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  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: 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: Command-line tool and client library to control the dashboard of Sakura
+  Rental Server.
+email:
+- goodies@codeout.net
+executables:
+- sakura
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/sakura
+- lib/sakura.rb
+- lib/sakura/cli/mail.rb
+- lib/sakura/cli/root.rb
+- lib/sakura/cli/version.rb
+- lib/sakura/client.rb
+- lib/sakura/mail_address.rb
+- sakura-cli.gemspec
+homepage: https://github.com/codeout/sakura-cli
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.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: Command-line tool for Sakura's Rental Server.
+test_files: []
+has_rdoc: