cloudgarage-api 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed9846103bf204429d93058dc290bfaf654ed47e41bffecb52fe81a56806de58
-  data.tar.gz: 0bf05055812f995cea5dc6af117ac4d990dbac38d34095b9a7da05ba625414d9
+  metadata.gz: 6ce5a791fca9db82814f9109112a2dd6a923d436e6478005c70f9d40c6637b2e
+  data.tar.gz: 1112eae2a3916e2727a5e8229ebe3d40ea7f3b870e2774ac8086223526eb4010
 SHA512:
-  metadata.gz: 5411022bee23d99be2e61d88097ea14f16e19084524229691304b89117aaba76e6cd9cf2485588217fb9d1828ea0c079d2970754583a47367e4aa09cc1987944
-  data.tar.gz: 288146e09da86819d8816be459a43701f356fada580083fb411920ece08e56bd7e8b20e8caee056017892720e17c1d2595b05fdb3478e7891d578fd20141d12c
+  metadata.gz: 50fef22aa6fe4fcbd9bdc054391aba3a4036ca1c64074ce701e3d974b9d1aa8b1b1fa054e5a9d8614410a28d3a60f17f1b2b46b95d0ae8b2c16792e6ba150cda
+  data.tar.gz: 15e396bbe70172a370b6c91ea997cec92a0e380eb16f77e7c2b19a9445f3612d8d518360cd5a0db5f1fa4f534cf6e8ed7cdf7da70db535a2a6158fd6947d1286

data/README.md

@@ -1,6 +1,6 @@
-# Ruby Binding of CloudGarage Public API
+# Ruby Binding and CLI of CloudGarage Public API
 
-A Ruby Binding of [CloudGarage Public API](https://api.cloudgarage.jp/doc/index.html).
+A Ruby Binding Library and CLI of [CloudGarage Public API](https://api.cloudgarage.jp/doc/index.html).
 
 ## Installation
 
@@ -14,21 +14,49 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it yourself to use CLI as:
 
     $ gem install cloudgarage-api
 
-## Usage
+## Usage of CLI (cloudgarage command)
 
 Beginning, get your API keys ('Client ID' and 'Client Secret') from the console of CloudGarage.
 
-### Create client instance:
+```sh
+$ cloudgarage help
+Commands:
+  cloudgarage contracts [contract_id]             # get contracts information
+  cloudgarage create <name> <password> [opts...]  # create a server
+  cloudgarage delete [--notify] <server_id>       # delete server
+  cloudgarage help [COMMAND]                      # Describe available commands or one specific command
+  cloudgarage images [os|application|private]     # get images
+  cloudgarage keypairs [keypair_id]               # get SSH Key pairs
+  cloudgarage login <id> <secret>                 # login to CloudGarage Service and get a token
+  cloudgarage restart [--hard] <server_id>        # restart server
+  cloudgarage serves [server_id]                  # get servers information
+  cloudgarage start <server_id>                   # start server
+  cloudgarage stop <server_id>                    # stop server
+
+Options:
+  [--json], [--no-json]
+```
+
+You can get result by JSON using `--json` option for searching or querying (ex. `jq`)
+
+## Usage of API from ruby language
+
+Beginning, get your API keys ('Client ID' and 'Client Secret') from the console of CloudGarage.
+
+### Create client instance and login:
 
 ```ruby
-require 'cloudgarage-api'
-client = CloudGarage.new(client_id, client_secret)
+require 'cloudgarage/api'
+client = CloudGarage::API.new
+token = client.login(client_id, client_secret)
 ```
 
+You can use the `token` while 24H. If the token expired, try to login again.
+
 ### Contract APIs
 
 ```ruby

data/cloudgarage-api.gemspec

@@ -1,7 +1,7 @@
 
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "cloudgarage-api/version"
+require "cloudgarage/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "cloudgarage-api"
@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Tada, Tadashi"]
   spec.email         = ["t@tdtds.jp"]
 
-  spec.summary       = %q{CloudGarage API}
-  spec.description   = %q{Control CloudGarage VPS by it's public API}
+  spec.summary       = %q{CloudGarage API and CLI}
+  spec.description   = %q{Ruby Binding and CLI of CloudGarage Public API}
   spec.homepage      = "https://github.com/tdtds/cloudgarage-api"
 
   # Specify which files should be added to the gem when it is released.
@@ -23,7 +23,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rest-client", "~> 2.0"
-
+  spec.add_dependency "thor", "~> 0.20"
+  spec.add_dependency "pit"
+  
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

data/exe/cloudgarage

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'cloudgarage/cli'
+CloudGarage::CLI.start

data/lib/cloudgarage/api.rb

@@ -0,0 +1,142 @@
+#
+# A ruby wrapper of CloudGarage public API
+#
+# Copyright (C) 2019 by Tada, Tadashi <t@tdtds.jp>
+# You can distribute under GPL 3.0
+#
+require 'rest-client'
+require 'json'
+
+module CloudGarage
+  class API
+    BASE_URI = 'https://api.cloudgarage.jp'.freeze
+
+    attr_accessor :token
+
+    def initialize(token = nil)
+      @token = token
+    end
+
+    def login(client_id, client_secret)
+      payload = {'client_id' => client_id, 'client_secret' => client_secret}
+      @token = post('tokens', payload)[:token][:id]
+    end
+
+    def contracts(contract_id = nil)
+      if contract_id 
+        get("contracts/#{contract_id}")[:contract]
+      else
+        get('contracts')[:contracts]
+      end
+    end
+
+    # image_type: :os, :application, :private
+    def images(image_type = nil)
+      images = get("images")[:images]
+      if image_type
+        image_type = image_type.to_s.upcase
+        images.select!{|i| i[:image_type] == image_type}
+      end
+      return images
+    end
+
+    def keypairs(keypair_id = nil)
+      if keypair_id
+        get("keypairs/#{keypair_id}")[:keypair]
+      else
+        get('keypairs')[:keypairs]
+      end
+    end
+
+    def servers()
+      get('servers')[:servers]
+    end
+
+    def server_info(server_id)
+      get("servers/#{server_id}")[:server_detail]
+    end
+
+    def server_auto_backup_info(server_id)
+      get("servers/#{server_id}/autoBackup")[:autoBackup]
+    end
+
+    def server_security_info(server_id)
+      get("servers/#{server_id}/security")[:securityRules]
+    end
+
+    def create_server(name, password, contract_id: nil, spec: {}, ports: [], image_id: nil, keyname: nil, comment: nil)
+      payload = {'name' => name, 'password' => password}
+      payload['contract_id'] = contract_id if contract_id
+      payload['spec'] = spec unless spec.empty?
+      payload['ports'] = ports unless ports.empty?
+      payload['image_id'] = image_id if image_id
+      payload['keyname'] = keyname if keyname
+      payload['comment'] = comment if comment
+      post('servers', payload)[:resource_id]
+    end
+
+    # operation: :start, :restart, :restart_hard, :stop
+    # servers: array of server UUIDs
+    def operate_servers(operation, servers)
+      payload = {'operate' => operation.to_s.upcase, 'servers' => [servers].flatten}
+      post('servers/operate', payload)
+    end
+    def start_servers(servers); operate_servers(:start, servers); end
+    def restart_servers(servers); operate_servers(:restart, servers); end
+    def restart_hard_servers(servers); operate_servers(:restart_hard, servers); end
+    def stop_servers(servers); operate_servers(:stop, servers); end
+
+    def delete_server(resource_id, notify = true)
+      delete("servers/#{resource_id}?sendMail=#{notify ? 'true': 'false'}")
+      return true
+    end
+
+    def version
+      get("version")[:version]
+    end
+
+  private
+    def header
+      h = {'Content-Type' => 'application/json'}
+      h['X-Auth-Token'] = @token if @token
+      return h
+    end
+
+    def call_api
+      begin
+        yield
+      rescue RestClient::ExceptionWithResponse => ex
+        def ex.message
+          if @response
+            "#{default_message}: #{JSON.parse(response.body)['fault']['messages'].join(' ')}"
+          else
+            default_message
+          end
+        end
+        raise ex
+      end
+  end
+
+    def get(api)
+      call_api do
+        parse_body(RestClient.get("#{BASE_URI}/#{api}", header))
+      end
+    end
+
+    def post(api, payload)
+      call_api do
+        parse_body(RestClient.post("#{BASE_URI}/#{api}", payload.to_json, header))
+      end
+    end
+
+    def delete(api)
+      call_api do
+        RestClient.delete("#{BASE_URI}/#{api}", header)
+      end
+    end
+
+    def parse_body(res)
+      JSON.parse(res.body, symbolize_names: true)
+    end
+  end
+end

data/lib/cloudgarage/cli.rb

@@ -0,0 +1,164 @@
+require 'cloudgarage/api'
+require 'thor'
+require 'pit'
+
+module CloudGarage
+  class CLI < Thor
+    class_option :json, default: false, type: :boolean # show result by json
+
+    desc 'login <id> <secret>', 'login to CloudGarage Service and get a token'
+    def login(client_id, client_secret)
+      @token = API.new.login(client_id, client_secret)
+      save_token(@token)
+    end
+
+    desc 'contracts [contract_id]', 'get contracts information'
+    def contracts(contract_id = nil)
+      call_api do |c|
+        c.contracts(contract_id)
+      end
+    end
+
+    desc 'images [os|application|private]', 'get images'
+    def images(image_type = nil)
+      call_api do |c|
+        c.images(image_type)
+      end
+    end
+
+    desc 'keypairs [keypair_id]', 'get SSH Key pairs'
+    def keypairs(keypair_id = nil)
+      call_api do |c|
+        c.keypairs(keypair_id)
+      end
+    end
+
+    desc 'serves [server_id]', 'get servers information'
+    option :backup, default: false, type: :boolean
+    option :security, default: false, type: :boolean
+    def servers(server_id = nil)
+      call_api do |c|
+        if server_id
+          if options[:backup]
+            c.server_auto_backup_info(server_id)
+          elsif options[:security]
+            c.server_security_info(server_id)
+          else
+            c.server_info(server_id)
+          end
+        else
+          c.servers
+        end
+      end
+    end
+
+    desc 'create <name> <password> [opts...]', 'create a server'
+    option :contract_id, default: nil, type: :string
+    option :spec, default: '{}', type: :string
+    option :ports, default: '[]', type: :string
+    option :image_id, default: nil, type: :string
+    option :keyname, default: nil, type: :string
+    option :comment, default: nil, type: :string
+    def create(name, password)
+      call_api do |c|
+        c.create_server(name, password,
+          contract_id: options[:contract_id],
+          image_id: options[:image_id],
+          spec: JSON.parse(options[:spec]),
+          ports: JSON.parse(options[:ports]),
+          keyname: options[:keyname],
+          comment: options[:comment]
+        )
+      end
+    end
+
+    desc 'start <server_id>', 'start server'
+    def start(server_id)
+      call_api do |c|
+        c.start_servers(server_id)
+      end
+    end
+
+    desc 'stop <server_id>', 'stop server'
+    def stop(server_id)
+      call_api do |c|
+        c.stop_servers(server_id)
+      end
+    end
+
+    desc 'restart [--hard] <server_id>', 'restart server'
+    option :hard, default: false, type: :boolean
+    def restart(server_id)
+      call_api do |c|
+        if options[:hard]
+          c.restart_hard_servers(server_id)
+        else
+          c.restart_servers(server_id)
+        end
+      end
+    end
+
+    desc 'delete [--notify] <server_id>', 'delete server'
+    option :notify, default: true, type: :boolean
+    def delete(server_id)
+      call_api do |c|
+        c.delete_server(server_id, options[:notify])
+        return nil
+      end
+    end
+
+  private
+    CREDENTIAL_KEY = 'api.cloudgarage.jp'
+    def load_token
+      Pit::get(CREDENTIAL_KEY)[:token]
+    end
+
+    def save_token(token)
+      Pit::set(CREDENTIAL_KEY, data: {token: token})
+    end
+
+    def client
+      @token = load_token unless @token
+      API.new(@token)
+    end
+
+    def refresh_token
+      if $stdin.tty? && $stdout.tty?
+        begin
+          puts 'Access tokens expired, enter your Client ID and Secret.'
+          print 'Client ID: '
+          client_id = $stdin.gets.chomp
+          print 'Client Secret: '
+          client_secret = $stdin.gets.chomp
+          login(client_id, client_secret)
+        rescue Interrupt
+          exit 255
+        rescue
+          $stderr.puts "Could not login. try again."
+          exit 255
+          end
+      else
+        $stderr.puts "Access tokens expired. try login again."
+        exit 255
+      end
+    end
+
+    def call_api
+      begin
+        result = yield(client)
+        if options[:json]
+          puts result.to_json if result
+        else
+          pp result if result
+        end
+        exit 0
+      rescue RestClient::Unauthorized => e
+        refresh_token
+        retry
+      rescue => e
+        $stderr.puts e.message
+        exit 255
+      end
+    end
+  end
+end

data/lib/cloudgarage/version.rb

@@ -0,0 +1,3 @@
+module CloudGarage
+  VERSION = "1.0.0".freeze
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudgarage-api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Tada, Tadashi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-12 00:00:00.000000000 Z
+date: 2019-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: pit
+  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
@@ -94,10 +122,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Control CloudGarage VPS by it's public API
+description: Ruby Binding and CLI of CloudGarage Public API
 email:
 - t@tdtds.jp
-executables: []
+executables:
+- cloudgarage
 extensions: []
 extra_rdoc_files: []
 files:
@@ -111,8 +140,10 @@ files:
 - bin/console
 - bin/setup
 - cloudgarage-api.gemspec
-- lib/cloudgarage-api.rb
-- lib/cloudgarage-api/version.rb
+- exe/cloudgarage
+- lib/cloudgarage/api.rb
+- lib/cloudgarage/cli.rb
+- lib/cloudgarage/version.rb
 homepage: https://github.com/tdtds/cloudgarage-api
 licenses: []
 metadata: {}
@@ -134,5 +165,5 @@ requirements: []
 rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
-summary: CloudGarage API
+summary: CloudGarage API and CLI
 test_files: []

data/lib/cloudgarage-api.rb

@@ -1,137 +0,0 @@
-#
-# A ruby wrapper of CloudGarage public API
-#
-# Copyright (C) 2019 by Tada, Tadashi <t@tdtds.jp>
-# You can distribute under GPL 3.0
-#
-require 'rest-client'
-
-class CloudGarage
-  BASE_URI = 'https://api.cloudgarage.jp'.freeze
-
-  def initialize(client_id, client_secret)
-    @client_id, @client_secret = client_id, client_secret
-    token
-  end
-
-  def token
-    payload = {'client_id' => @client_id, 'client_secret' => @client_secret}
-    @token = post('tokens', payload)[:token][:id]
-  end
-
-  def contracts(contract_id = nil)
-    if contract_id 
-      get("contracts/#{contract_id}")[:contract]
-    else
-      get('contracts')[:contracts]
-    end
-  end
-
-  # image_type: :os, :application, :private
-  def images(image_type = nil)
-    images = get("images")[:images]
-    if image_type
-      image_type = image_type.to_s.upcase
-      images.select!{|i| i[:image_type] == image_type}
-    end
-    return images
-  end
-
-  def keypairs(keypair_id = nil)
-    if keypair_id
-      get("keypairs/#{keypair_id}")[:keypair]
-    else
-      get('keypairs')[:keypairs]
-    end
-  end
-
-  def servers()
-    get('servers')[:servers]
-  end
-
-  def server_info(server_id)
-    get("servers/#{server_id}")[:server_detail]
-  end
-
-  def server_auto_backup_info(server_id)
-    get("servers/#{server_id}/autoBackup")[:autoBackup]
-  end
-
-  def server_security_info(server_id)
-    get("servers/#{server_id}/security")[:securityRules]
-  end
-
-  def create_server(name, password, contract_id: nil, spec: {}, ports: [], image_id: nil, keyname: nil, comment: nil)
-    payload = {'name' => name, 'password' => password}
-    payload['contract_id'] = contract_id if contract_id
-    payload['spec'] = spec unless spec.empty?
-    payload['ports'] = ports unless ports.empty?
-    payload['image_id'] = image_id if image_id
-    payload['keyname'] = keyname if keyname
-    payload['comment'] = comment if comment
-    post('servers', payload)[:resource_id]
-  end
-
-  # operation: :start, :restart, :restart_hard, :stop
-  # servers: array of server UUIDs
-  def operate_servers(operation, servers)
-    payload = {'operate' => operation.to_s.upcase, 'servers' => [servers].flatten}
-    post('servers/operate', payload)
-  end
-  def start_servers(servers); operate_servers(:start, servers); end
-  def restart_servers(servers); operate_servers(:restart, servers); end
-  def restart_hard_servers(servers); operate_servers(:restart_hard, servers); end
-  def stop_servers(servers); operate_servers(:stop, servers); end
-
-  def delete_server(resource_id, notify = true)
-    delete("servers/#{resource_id}?sendMail=#{notify ? 'true': 'false'}")
-  end
-
-  def version
-    get("version")[:version]
-  end
-
-private
-  def header
-    h = {'Content-Type' => 'application/json'}
-    h['X-Auth-Token'] = @token if @token
-    return h
-  end
-
-  def call_api
-    begin
-      yield
-    rescue RestClient::ExceptionWithResponse => ex
-      def ex.message
-        if @response
-          "#{default_message}: #{JSON.parse(response.body)['fault']['messages'].join(' ')}"
-        else
-          default_message
-        end
-      end
-      raise ex
-    end
-end
-
-  def get(api)
-    call_api do
-      parse_body(RestClient.get("#{BASE_URI}/#{api}", header))
-    end
-  end
-
-  def post(api, payload)
-    call_api do
-      parse_body(RestClient.post("#{BASE_URI}/#{api}", payload.to_json, header))
-    end
-  end
-
-  def delete(api)
-    call_api do
-      RestClient.delete("#{BASE_URI}/#{api}", header)
-    end
-  end
-
-  def parse_body(res)
-    JSON.parse(res.body, symbolize_names: true)
-  end
-end

data/lib/cloudgarage-api/version.rb

@@ -1,3 +0,0 @@
-class CloudGarage
-  VERSION = "0.1.2".freeze
-end