saklient 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae24ff7a6b88b279ce5929c8f26d4314c497d3f1
+  data.tar.gz: 6115e9a5b55b89686e8a84c2b92823514af1c836
+SHA512:
+  metadata.gz: 411f8943577198feb1f30f2a66c3534ab7ed3b34a1bbe047ebb7a6ae890c0a652e886cd40ab62c8ab4e642f77ac34cdf31d6bb4ec6e430392e787cd2bf31b30b
+  data.tar.gz: 6950f2f696fde82c47711dca57cde7244c1a2cc20c7a7b870ad5ec4572f8bbefbfc9dde6cc2064dde8810dfb7b269e8058f0d89cff6c3809ce1ce13aeb9ab19a

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+config.sh
+testok
+.project
+.settings

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 SAKURA Internet, Inc.
+
+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,43 @@
+# SAKURA Internet API Client Library for Ruby
+
+This library gives you an easy interface to control your resources on
+[SAKURA Cloud](https://secure.sakura.ad.jp/cloud/).
+
+## Table of Contents
+
+<!-- This TOC is generated by https://www.npmjs.org/package/readme-toc -->
+<!-- toc -->
+* [Installation](#installation)
+* [How to use this library in your project](#how-to-use-this-library-in-your-project)
+* [Copyright and license](#copyright-and-license)
+
+<!-- toc stop -->
+
+## Installation
+
+```bash
+gem install specific_install
+gem specific_install -l git@github.com:sakura-internet/saklient.rb.git
+```
+
+
+## How to use this library in your project
+
+
+```ruby
+require 'saklient/cloud/api'
+api = Saklient::Cloud::API.authorize(YOUR_API_TOKEN, YOUR_API_SECRET)
+
+# To access resources in the specified zone
+api_is1b = api.in_zone("is1b")
+
+# ...
+```
+
+
+## Copyright and license
+
+Copyright (C) 2014 SAKURA Internet, Inc.
+
+This library is freely redistributable under [MIT license](http://www.opensource.org/licenses/mit-license.php).
+

data/Rakefile

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

data/config.sh.sample

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+export SACLOUD_TOKEN='xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
+export SACLOUD_SECRET='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+# export SACLOUD_ZONE='is1b'

data/example.rb

@@ -0,0 +1,83 @@
+#require 'saklient/cloud/api'
+require './lib/saklient/cloud/api.rb'
+require 'JSON'
+
+api = Saklient::Cloud::API.authorize(ARGV[0], ARGV[1])
+
+server = api.server.create
+server.name = 'saklient.rb'
+server.description = 'This instance was created by saklient.rb example'
+server.tags = ['saklient-test']
+server.plan = api.product.server.get_by_spec(1, 1)
+server.save
+servers = api.server.with_name_like('saklient.rb').find
+printf "%s\n", servers[0].name
+printf "%s\n", servers[0].description
+printf "%s\n", servers[0].tags[0]
+server.destroy
+
+
+# printf "%s\n", Saklient::Cloud::Enums::EServerInstanceStatus.down
+# printf "%s\n", Saklient::Cloud::Enums::EServerInstanceStatus.compare("aaa", "down").nil?
+# printf "%s\n", Saklient::Cloud::Enums::EServerInstanceStatus.compare("up", "down")
+# printf "%s\n", Saklient::Cloud::Enums::EServerInstanceStatus.compare("down", "up")
+
+
+# # 停止中のサーバに接続されているディスクを一覧
+# servers = api.server.with_status("down").find
+# for server in servers
+#   next if server.tags.empty?
+#   puts ""
+#   printf "server [%s] %s at %s\n", server.id, server.instance.status, server.instance.status_changed_at.to_s
+#   printf "    tags: %s\n", server.tags.join(', ')
+#   #puts JSON.pretty_unparse(server.dump())
+#   for iface in server.ifaces
+#     printf "    iface [%s] %s %s\n", iface.id, iface.mac_address, iface.ip_address || iface.user_ip_address
+#   end
+#   disks = server.find_disks # same as: disks = api.disk.with_server_id(server.id).find
+#   for disk in disks
+#     printf "    disk [%s] %s\n", disk.id, disk.name
+#   end
+# end
+
+
+# # 特定のタグを持つサーバの説明に現在時刻を追記
+# servers = api.server.with_tag("abc").find
+# for server in servers
+#   printf "server [%s] %s\n", server.id, server.name
+#   server.description += "\n" + Time.now.strftime("%Y/%m/%d %H:%M:%S")
+#   server.save
+#   printf "%s\n\n", server.description
+# end
+
+
+# icons = api.icon.with_name_like('cent').limit(1).find
+# abort 'icon not found' if icons.empty?
+# icon = icons[0]
+# printf "icon [%s] %s\n\n", icon.id, icon.name
+# 
+# servers = api.server.with_name_like('cent').find
+# for server in servers
+#     printf "server [%s] %s\n", server.id, server.name
+#     server.icon = nil
+#     server.save
+#     printf "  changed icon to nothing: %s\n", (server.icon.nil? ? 'OK' : 'NG')
+#     server.icon = icon
+#     server.save
+#     printf "  changed icon to: [%s] %s\n\n", server.icon.id, server.icon.name
+# end
+
+
+# plan_from = api.product.server.get_by_spec(2, 4)
+# printf "plan from: [%s] %dcore %dGB\n", plan_from.id, plan_from.cpu, plan_from.memory_gib
+# plan_to   = api.product.server.get_by_spec(4, 8)
+# printf "plan to:   [%s] %dcore %dGB\n", plan_to.id, plan_to.cpu, plan_to.memory_gib
+# printf "\n"
+# 
+# servers = api.server.with_plan(plan_from).find()
+# for server in servers
+#     printf "server [%s] %dcore %dGB '%s'\n", server.id, server.plan.cpu, server.plan.memory_gib, server.name
+#     server.change_plan(plan_to)
+#     printf "    -> [%s] %dcore %dGB\n\n", server.id, server.plan.cpu, server.plan.memory_gib
+# end
+

data/example.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+cd `dirname $0`
+source config.sh
+ruby example.rb "$SACLOUD_TOKEN" "$SACLOUD_SECRET"
+

data/lib/saklient/cloud/api.rb

@@ -0,0 +1,382 @@
+# -*- encoding: UTF-8 -*-
+
+require_relative '../util'
+require_relative 'client'
+require_relative 'product'
+require_relative 'models/model_icon'
+require_relative 'models/model_server'
+require_relative 'models/model_disk'
+require_relative 'models/model_appliance'
+require_relative 'models/model_archive'
+require_relative 'models/model_iso_image'
+require_relative 'models/model_iface'
+require_relative 'models/model_swytch'
+require_relative 'models/model_router'
+require_relative 'models/model_ipv6_net'
+require_relative 'models/model_script'
+
+module Saklient
+  module Cloud
+
+    # さくらのクラウドAPIクライアントを利用する際, 最初にアクセスすべきルートとなるクラス.
+    #
+    # @see API.authorize
+    class API
+
+      protected
+
+      # @private
+      # @return [Client]
+      attr_accessor :_client
+
+      # @private
+      # @return [Client]
+      def get_client
+        return @_client
+      end
+
+      public
+
+      # @private
+      # @return [Client]
+      attr_reader :client
+
+      def client
+        get_client
+      end
+
+      protected
+
+      # @private
+      # @return [Product]
+      attr_accessor :_product
+
+      # @private
+      # @return [Product]
+      def get_product
+        return @_product
+      end
+
+      public
+
+      # 商品情報にアクセスするためのモデルを集めたオブジェクト.
+      #
+      # @return [Product]
+      attr_reader :product
+
+      def product
+        get_product
+      end
+
+      protected
+
+      # @private
+      # @return [Saklient::Cloud::Models::Model_Icon]
+      attr_accessor :_icon
+
+      # @private
+      # @return [Saklient::Cloud::Models::Model_Icon]
+      def get_icon
+        return @_icon
+      end
+
+      public
+
+      # アイコンにアクセスするためのモデル.
+      #
+      # @return [Saklient::Cloud::Models::Model_Icon]
+      attr_reader :icon
+
+      def icon
+        get_icon
+      end
+
+      protected
+
+      # @private
+      # @return [Saklient::Cloud::Models::Model_Server]
+      attr_accessor :_server
+
+      # @private
+      # @return [Saklient::Cloud::Models::Model_Server]
+      def get_server
+        return @_server
+      end
+
+      public
+
+      # サーバにアクセスするためのモデル.
+      #
+      # @return [Saklient::Cloud::Models::Model_Server]
+      attr_reader :server
+
+      def server
+        get_server
+      end
+
+      protected
+
+      # @private
+      # @return [Saklient::Cloud::Models::Model_Disk]
+      attr_accessor :_disk
+
+      # @private
+      # @return [Saklient::Cloud::Models::Model_Disk]
+      def get_disk
+        return @_disk
+      end
+
+      public
+
+      # ディスクにアクセスするためのモデル.
+      #
+      # @return [Saklient::Cloud::Models::Model_Disk]
+      attr_reader :disk
+
+      def disk
+        get_disk
+      end
+
+      protected
+
+      # @private
+      # @return [Saklient::Cloud::Models::Model_Appliance]
+      attr_accessor :_appliance
+
+      # @private
+      # @return [Saklient::Cloud::Models::Model_Appliance]
+      def get_appliance
+        return @_appliance
+      end
+
+      public
+
+      # アプライアンスにアクセスするためのモデル.
+      #
+      # @return [Saklient::Cloud::Models::Model_Appliance]
+      attr_reader :appliance
+
+      def appliance
+        get_appliance
+      end
+
+      protected
+
+      # @private
+      # @return [Saklient::Cloud::Models::Model_Archive]
+      attr_accessor :_archive
+
+      # @private
+      # @return [Saklient::Cloud::Models::Model_Archive]
+      def get_archive
+        return @_archive
+      end
+
+      public
+
+      # アーカイブにアクセスするためのモデル.
+      #
+      # @return [Saklient::Cloud::Models::Model_Archive]
+      attr_reader :archive
+
+      def archive
+        get_archive
+      end
+
+      protected
+
+      # @private
+      # @return [Saklient::Cloud::Models::Model_IsoImage]
+      attr_accessor :_iso_image
+
+      # @private
+      # @return [Saklient::Cloud::Models::Model_IsoImage]
+      def get_iso_image
+        return @_iso_image
+      end
+
+      public
+
+      # ISOイメージにアクセスするためのモデル.
+      #
+      # @return [Saklient::Cloud::Models::Model_IsoImage]
+      attr_reader :iso_image
+
+      def iso_image
+        get_iso_image
+      end
+
+      protected
+
+      # @private
+      # @return [Saklient::Cloud::Models::Model_Iface]
+      attr_accessor :_iface
+
+      # @private
+      # @return [Saklient::Cloud::Models::Model_Iface]
+      def get_iface
+        return @_iface
+      end
+
+      public
+
+      # インタフェースにアクセスするためのモデル.
+      #
+      # @return [Saklient::Cloud::Models::Model_Iface]
+      attr_reader :iface
+
+      def iface
+        get_iface
+      end
+
+      protected
+
+      # @private
+      # @return [Saklient::Cloud::Models::Model_Swytch]
+      attr_accessor :_swytch
+
+      # @private
+      # @return [Saklient::Cloud::Models::Model_Swytch]
+      def get_swytch
+        return @_swytch
+      end
+
+      public
+
+      # スイッチにアクセスするためのモデル.
+      #
+      # @return [Saklient::Cloud::Models::Model_Swytch]
+      attr_reader :swytch
+
+      def swytch
+        get_swytch
+      end
+
+      protected
+
+      # @private
+      # @return [Saklient::Cloud::Models::Model_Router]
+      attr_accessor :_router
+
+      # @private
+      # @return [Saklient::Cloud::Models::Model_Router]
+      def get_router
+        return @_router
+      end
+
+      public
+
+      # ルータにアクセスするためのモデル.
+      #
+      # @return [Saklient::Cloud::Models::Model_Router]
+      attr_reader :router
+
+      def router
+        get_router
+      end
+
+      protected
+
+      # @private
+      # @return [Saklient::Cloud::Models::Model_Ipv6Net]
+      attr_accessor :_ipv6_net
+
+      # @private
+      # @return [Saklient::Cloud::Models::Model_Ipv6Net]
+      def get_ipv6_net
+        return @_ipv6_net
+      end
+
+      public
+
+      # IPv6ネットワークにアクセスするためのモデル.
+      #
+      # @return [Saklient::Cloud::Models::Model_Ipv6Net]
+      attr_reader :ipv6_net
+
+      def ipv6_net
+        get_ipv6_net
+      end
+
+      protected
+
+      # @private
+      # @return [Saklient::Cloud::Models::Model_Script]
+      attr_accessor :_script
+
+      # @private
+      # @return [Saklient::Cloud::Models::Model_Script]
+      def get_script
+        return @_script
+      end
+
+      public
+
+      # スクリプトにアクセスするためのモデル.
+      #
+      # @return [Saklient::Cloud::Models::Model_Script]
+      attr_reader :script
+
+      def script
+        get_script
+      end
+
+      protected
+
+      # @private
+      # @param [Client] client
+      def initialize(client)
+        Saklient::Util::validate_type(client, 'Saklient::Cloud::Client')
+        @_client = client
+        @_product = Saklient::Cloud::Product.new(client)
+        @_icon = Saklient::Cloud::Models::Model_Icon.new(client)
+        @_server = Saklient::Cloud::Models::Model_Server.new(client)
+        @_disk = Saklient::Cloud::Models::Model_Disk.new(client)
+        @_appliance = Saklient::Cloud::Models::Model_Appliance.new(client)
+        @_archive = Saklient::Cloud::Models::Model_Archive.new(client)
+        @_iso_image = Saklient::Cloud::Models::Model_IsoImage.new(client)
+        @_iface = Saklient::Cloud::Models::Model_Iface.new(client)
+        @_swytch = Saklient::Cloud::Models::Model_Swytch.new(client)
+        @_router = Saklient::Cloud::Models::Model_Router.new(client)
+        @_ipv6_net = Saklient::Cloud::Models::Model_Ipv6Net.new(client)
+        @_script = Saklient::Cloud::Models::Model_Script.new(client)
+      end
+
+      public
+
+      # 指定した認証情報を用いてアクセスを行うAPIクライアントを作成します.
+      #
+      # 必要な認証情報は, コントロールパネル右上にあるアカウントのプルダウンから
+      # 「設定」を選択し, 「APIキー」のページにて作成できます.
+      #
+      # @param [String] token ACCESS TOKEN
+      # @param [String] secret ACCESS TOKEN SECRET
+      # @param [String] zone ゾーン名
+      # @return [API] APIクライアント
+      def self.authorize(token, secret, zone = nil)
+        Saklient::Util::validate_type(token, 'String')
+        Saklient::Util::validate_type(secret, 'String')
+        Saklient::Util::validate_type(zone, 'String')
+        c = Saklient::Cloud::Client.new(token, secret)
+        ret = Saklient::Cloud::API.new(c)
+        return !(zone).nil? ? ret.in_zone(zone) : ret
+      end
+
+      # 認証情報を引き継ぎ, 指定したゾーンへのアクセスを行うAPIクライアントを作成します.
+      #
+      # @param [String] name ゾーン名
+      # @return [API] APIクライアント
+      def in_zone(name)
+        Saklient::Util::validate_type(name, 'String')
+        ret = Saklient::Cloud::API.new(@_client.clone_instance)
+        suffix = ''
+        suffix = '-test' if name == 'is1x' || name == 'is1y'
+        ret._client.set_api_root('https://secure.sakura.ad.jp/cloud' + suffix + '/')
+        ret._client.set_api_root_suffix('zone/' + name)
+        return ret
+      end
+
+    end
+
+  end
+end

data/lib/saklient/cloud/client.rb

@@ -0,0 +1,111 @@
+# -*- encoding: UTF-8 -*-
+require 'net/https'
+require 'json'
+require 'uri'
+require_relative '../errors/exception_factory'
+
+module Saklient
+  module Cloud
+    
+    # @private
+    class Client
+      
+      def initialize(token, secret)
+        @config = {
+          api_root: 'https://secure.sakura.ad.jp/cloud/',
+          api_root_suffix: nil
+        }
+        set_access_key token, secret
+        self
+      end
+
+      def println(msg)
+        $stderr.puts msg
+      end
+
+      def clone_instance
+        instance = self.class.new(@config[:token], @config[:secret])
+        instance.set_api_root @config[:api_root]
+        instance.set_api_root_suffix @config[:api_root_suffix]
+
+        instance
+      end
+
+      def set_api_root(url)
+        @config[:api_root] = url
+      end
+
+      def set_api_root_suffix(suffix)
+        @config[:api_root_suffix] = suffix
+      end
+
+      def set_access_key(token, secret)
+        @config[:token]  = token
+        @config[:secret] = secret
+      end
+
+      def request(method, path, params={})
+        json = params.to_json
+
+        unless path =~ /^http/
+          url_root = @config[:api_root]
+          if @config[:api_root_suffix]
+            url_root += @config[:api_root_suffix]
+            url_root = url_root.sub %r|/?$|, '/'
+          end
+          url = url_root + 'api/cloud/1.1' + path
+        end
+
+        url += '?' + URI.escape(json) if method == 'GET' and !params.empty?
+
+        #println '// APIリクエスト中: #{method} #{path}'
+
+        parsed_url = URI.parse url
+
+        if method == 'GET'
+          req = Net::HTTP::Get.new parsed_url
+        else
+          req = Net::HTTP::Post.new parsed_url
+          req.body = json
+        end
+
+        req.basic_auth @config[:token], @config[:secret]
+
+        extra_headers = {
+          'Content-Type'     => 'application/x-www-form-urlencoded',
+          'User-Agent'       => 'sacloud-client-ruby',
+          'X-Requested-With' => 'XMLHttpRequest',
+          'X-Sakura-HTTP-Method' => method,
+          'X-Sakura-Error-Level' => 'warning',
+          'X-Sakura-Request-Format'  => 'json',
+          'X-Sakura-Response-Format' => 'json',
+          'X-Sakura-No-Authenticate-Header' => '1'
+        }
+
+        #println parsed_url
+
+        extra_headers.each do |key, value|
+          req[key] = value
+        end
+
+        http = Net::HTTP.new parsed_url.host, parsed_url.scheme == 'https' ? 443 : 80
+        # http.set_debug_output($stderr) # for debugging
+        if parsed_url.scheme == 'https'
+          http.use_ssl = true
+          # http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+        res = http.start {|conn| conn.request req }
+
+        ret = JSON.parse(res.body, {:symbolize_names => true})
+        status = res.code.to_i
+        unless 200 <= status && status < 300 then
+          raise Saklient::Errors::ExceptionFactory.create(status, ret[:error_code], ret[:error_msg])
+        end
+        
+        ret
+      end
+      
+    end
+    
+  end
+end