saklient 0.0.1

data/lib/saklient/cloud/models/model.rb

@@ -0,0 +1,348 @@
+# -*- encoding: UTF-8 -*-
+
+require_relative '../client'
+require_relative '../resources/resource'
+require_relative 'query_params'
+require_relative '../../errors/saklient_exception'
+
+module Saklient
+  module Cloud
+    module Models
+
+      # @private
+      class Model
+
+        protected
+
+        # @private
+        # @return [Saklient::Cloud::Client]
+        attr_accessor :_client
+
+        # @private
+        # @return [Saklient::Cloud::Client]
+        def get_client
+          return @_client
+        end
+
+        public
+
+        # @return [Saklient::Cloud::Client]
+        attr_reader :client
+
+        def client
+          get_client
+        end
+
+        protected
+
+        # @private
+        # @return [QueryParams]
+        attr_accessor :_query
+
+        # @private
+        # @return [QueryParams]
+        def get_query
+          return @_query
+        end
+
+        public
+
+        # @return [QueryParams]
+        attr_reader :query
+
+        def query
+          get_query
+        end
+
+        protected
+
+        # @private
+        # @return [Fixnum]
+        attr_accessor :_total
+
+        # @private
+        # @return [Fixnum]
+        def get_total
+          return @_total
+        end
+
+        public
+
+        # @return [Fixnum]
+        attr_reader :total
+
+        def total
+          get_total
+        end
+
+        protected
+
+        # @private
+        # @return [Fixnum]
+        attr_accessor :_count
+
+        # @private
+        # @return [Fixnum]
+        def get_count
+          return @_count
+        end
+
+        public
+
+        # @return [Fixnum]
+        attr_reader :count
+
+        def count
+          get_count
+        end
+
+        protected
+
+        # @private
+        # @return [String]
+        def _api_path
+          return nil
+        end
+
+        # @private
+        # @return [String]
+        def _root_key
+          return nil
+        end
+
+        # @private
+        # @return [String]
+        def _root_key_m
+          return nil
+        end
+
+        # @private
+        # @return [String]
+        def _class_name
+          return nil
+        end
+
+        public
+
+        # @param [Saklient::Cloud::Client] client
+        def initialize(client)
+          Saklient::Util::validate_type(client, 'Saklient::Cloud::Client')
+          @_client = client
+          _reset
+        end
+
+        protected
+
+        # 次に取得するリストの開始オフセットを指定します.
+        #
+        # @private
+        # @param [Fixnum] offset オフセット
+        # @return [Model] this
+        def _offset(offset)
+          Saklient::Util::validate_type(offset, 'Fixnum')
+          @_query.begin = offset
+          return self
+        end
+
+        # 次に取得するリストの上限レコード数を指定します.
+        #
+        # @private
+        # @param [Fixnum] count 上限レコード数
+        # @return [Model] this
+        def _limit(count)
+          Saklient::Util::validate_type(count, 'Fixnum')
+          @_query.count = count
+          return self
+        end
+
+        # 次に取得するリストのソートカラムを指定します.
+        #
+        # @private
+        # @param [String] column カラム名
+        # @param [bool] reverse
+        # @return [Model] this
+        def _sort(column, reverse = false)
+          Saklient::Util::validate_type(column, 'String')
+          Saklient::Util::validate_type(reverse, 'bool')
+          op = reverse ? '-' : ''
+          @_query.sort << op + column
+          return self
+        end
+
+        # Web APIのフィルタリング設定を直接指定します.
+        #
+        # @private
+        # @param [String] key キー
+        # @param [any] value 値
+        # @param [bool] multiple valueに配列を与え, OR条件で完全一致検索する場合にtrueを指定します. 通常, valueはスカラ値であいまい検索されます.
+        # @return [Model]
+        def _filter_by(key, value, multiple = false)
+          Saklient::Util::validate_type(key, 'String')
+          Saklient::Util::validate_type(multiple, 'bool')
+          filter = @_query.filter
+          if multiple
+            filter[key.to_sym] = [] if !(!filter.nil? && filter.key?(key.to_sym))
+            values = filter[key.to_sym]
+            values << value
+          else
+            raise Saklient::Errors::SaklientException.new('filter_duplicated', 'The same filter key can be specified only once (by calling the same method \'withFooBar\')') if !filter.nil? && filter.key?(key.to_sym)
+            filter[key.to_sym] = value
+          end
+          return self
+        end
+
+        # 次のリクエストのために設定されているステートをすべて破棄します.
+        #
+        # @private
+        # @return [Model] this
+        def _reset
+          @_query = Saklient::Cloud::Models::QueryParams.new()
+          @_total = 0
+          @_count = 0
+          return self
+        end
+
+        # 新規リソース作成用のオブジェクトを用意します.
+        #
+        # 返り値のオブジェクトにパラメータを設定し, save() を呼ぶことで実際のリソースが作成されます.
+        #
+        # @private
+        # @return [Saklient::Cloud::Resources::Resource] リソースオブジェクト
+        def _create
+          a = [
+            @_client,
+            nil,
+            false
+          ]
+          return Saklient::Util::create_class_instance('saklient.cloud.resources.' + _class_name, a)
+        end
+
+        # 指定したIDを持つ唯一のリソースを取得します.
+        #
+        # @private
+        # @param [String] id
+        # @return [Saklient::Cloud::Resources::Resource] リソースオブジェクト
+        def _get_by_id(id)
+          Saklient::Util::validate_type(id, 'String')
+          query = @_query.build
+          _reset
+          result = @_client.request('GET', _api_path + '/' + Saklient::Util::url_encode(id), query)
+          @_total = 1
+          @_count = 1
+          a = [
+            @_client,
+            result,
+            true
+          ]
+          return Saklient::Util::create_class_instance('saklient.cloud.resources.' + _class_name, a)
+        end
+
+        # リソースの検索リクエストを実行し, 結果をリストで取得します.
+        #
+        # @private
+        # @return [Array<Saklient::Cloud::Resources::Resource>] リソースオブジェクトの配列
+        def _find
+          query = @_query.build
+          _reset
+          result = @_client.request('GET', _api_path, query)
+          @_total = result[:Total]
+          @_count = result[:Count]
+          data = []
+          records = result[_root_key_m.to_sym]
+          for record in records
+            a = [
+              @_client,
+              record,
+              false
+            ]
+            i = Saklient::Util::create_class_instance('saklient.cloud.resources.' + _class_name, a)
+            data << i
+          end
+          return data
+        end
+
+        # リソースの検索リクエストを実行し, 唯一のリソースを取得します.
+        #
+        # @private
+        # @return [Saklient::Cloud::Resources::Resource] リソースオブジェクト
+        def _find_one
+          query = @_query.build
+          _reset
+          result = @_client.request('GET', _api_path, query)
+          @_total = result[:Total]
+          @_count = result[:Count]
+          return nil if @_total == 0
+          records = result[_root_key_m.to_sym]
+          a = [
+            @_client,
+            records[0],
+            false
+          ]
+          return Saklient::Util::create_class_instance('saklient.cloud.resources.' + _class_name, a)
+        end
+
+        # 指定した文字列を名前に含むリソースに絞り込みます.
+        #
+        # 大文字・小文字は区別されません.
+        # 半角スペースで区切られた複数の文字列は, それらをすべて含むことが条件とみなされます.
+        #
+        # @private
+        # @todo Implement test case
+        # @param [String] name
+        # @return [Model]
+        def _with_name_like(name)
+          Saklient::Util::validate_type(name, 'String')
+          return _filter_by('Name', name)
+        end
+
+        # 指定したタグを持つリソースに絞り込みます.
+        #
+        # 複数のタグを指定する場合は withTags() を利用してください.
+        #
+        # @private
+        # @todo Implement test case
+        # @param [String] tag
+        # @return [Model]
+        def _with_tag(tag)
+          Saklient::Util::validate_type(tag, 'String')
+          return _filter_by('Tags.Name', [tag])
+        end
+
+        # 指定したすべてのタグを持つリソースに絞り込みます.
+        #
+        # @private
+        # @todo Implement test case
+        # @param [Array<String>] tags
+        # @return [Model]
+        def _with_tags(tags)
+          Saklient::Util::validate_type(tags, 'Array')
+          return _filter_by('Tags.Name', [tags])
+        end
+
+        # 指定したDNFに合致するタグを持つリソースに絞り込みます.
+        #
+        # @private
+        # @todo Implement test case
+        # @param [Array<Array<String>>] dnf
+        # @return [Model]
+        def _with_tag_dnf(dnf)
+          Saklient::Util::validate_type(dnf, 'Array')
+          return _filter_by('Tags.Name', dnf)
+        end
+
+        # 名前でソートします.
+        #
+        # @private
+        # @todo Implement test case
+        # @param [bool] reverse
+        # @return [Model]
+        def _sort_by_name(reverse = false)
+          Saklient::Util::validate_type(reverse, 'bool')
+          return _sort('Name', reverse)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/saklient/cloud/models/model_appliance.rb

@@ -0,0 +1,161 @@
+# -*- encoding: UTF-8 -*-
+
+require_relative '../client'
+require_relative 'model'
+require_relative '../resources/appliance'
+
+module Saklient
+  module Cloud
+    module Models
+
+      # アプライアンスを検索・作成するための機能を備えたクラス.
+      class Model_Appliance < Saklient::Cloud::Models::Model
+
+        protected
+
+        # @private
+        # @return [String]
+        def _api_path
+          return '/appliance'
+        end
+
+        # @private
+        # @return [String]
+        def _root_key
+          return 'Appliance'
+        end
+
+        # @private
+        # @return [String]
+        def _root_key_m
+          return 'Appliances'
+        end
+
+        # @private
+        # @return [String]
+        def _class_name
+          return 'Appliance'
+        end
+
+        public
+
+        # 次に取得するリストの開始オフセットを指定します.
+        #
+        # @param [Fixnum] offset オフセット
+        # @return [Model_Appliance] this
+        def offset(offset)
+          Saklient::Util::validate_type(offset, 'Fixnum')
+          return _offset(offset)
+        end
+
+        # 次に取得するリストの上限レコード数を指定します.
+        #
+        # @param [Fixnum] count 上限レコード数
+        # @return [Model_Appliance] this
+        def limit(count)
+          Saklient::Util::validate_type(count, 'Fixnum')
+          return _limit(count)
+        end
+
+        # Web APIのフィルタリング設定を直接指定します.
+        #
+        # @param [String] key キー
+        # @param [any] value 値
+        # @param [bool] multiple valueに配列を与え, OR条件で完全一致検索する場合にtrueを指定します. 通常, valueはスカラ値であいまい検索されます.
+        # @return [Model_Appliance]
+        def filter_by(key, value, multiple = false)
+          Saklient::Util::validate_type(key, 'String')
+          Saklient::Util::validate_type(multiple, 'bool')
+          return _filter_by(key, value, multiple)
+        end
+
+        # 次のリクエストのために設定されているステートをすべて破棄します.
+        #
+        # @return [Model_Appliance] this
+        def reset
+          return _reset
+        end
+
+        # 指定したIDを持つ唯一のリソースを取得します.
+        #
+        # @param [String] id
+        # @return [Saklient::Cloud::Resources::Appliance] リソースオブジェクト
+        def get_by_id(id)
+          Saklient::Util::validate_type(id, 'String')
+          return _get_by_id(id)
+        end
+
+        # リソースの検索リクエストを実行し, 結果をリストで取得します.
+        #
+        # @return [Array<Saklient::Cloud::Resources::Appliance>] リソースオブジェクトの配列
+        def find
+          return _find
+        end
+
+        # 指定した文字列を名前に含むリソースに絞り込みます.
+        #
+        # 大文字・小文字は区別されません.
+        # 半角スペースで区切られた複数の文字列は, それらをすべて含むことが条件とみなされます.
+        #
+        # @todo Implement test case
+        # @param [String] name
+        # @return [Model_Appliance]
+        def with_name_like(name)
+          Saklient::Util::validate_type(name, 'String')
+          return _with_name_like(name)
+        end
+
+        # 指定したタグを持つリソースに絞り込みます.
+        #
+        # 複数のタグを指定する場合は withTags() を利用してください.
+        #
+        # @todo Implement test case
+        # @param [String] tag
+        # @return [Model_Appliance]
+        def with_tag(tag)
+          Saklient::Util::validate_type(tag, 'String')
+          return _with_tag(tag)
+        end
+
+        # 指定したすべてのタグを持つリソースに絞り込みます.
+        #
+        # @todo Implement test case
+        # @param [Array<String>] tags
+        # @return [Model_Appliance]
+        def with_tags(tags)
+          Saklient::Util::validate_type(tags, 'Array')
+          return _with_tags(tags)
+        end
+
+        # 指定したDNFに合致するタグを持つリソースに絞り込みます.
+        #
+        # @todo Implement test case
+        # @param [Array<Array<String>>] dnf
+        # @return [Model_Appliance]
+        def with_tag_dnf(dnf)
+          Saklient::Util::validate_type(dnf, 'Array')
+          return _with_tag_dnf(dnf)
+        end
+
+        # 名前でソートします.
+        #
+        # @todo Implement test case
+        # @param [bool] reverse
+        # @return [Model_Appliance]
+        def sort_by_name(reverse = false)
+          Saklient::Util::validate_type(reverse, 'bool')
+          return _sort_by_name(reverse)
+        end
+
+        # @private
+        # @param [Saklient::Cloud::Client] client
+        def initialize(client)
+          super(client)
+          Saklient::Util::validate_type(client, 'Saklient::Cloud::Client')
+        end
+
+      end
+
+    end
+  end
+end

data/lib/saklient/cloud/models/model_archive.rb

@@ -0,0 +1,207 @@
+# -*- encoding: UTF-8 -*-
+
+require_relative '../client'
+require_relative 'model'
+require_relative '../resources/archive'
+require_relative '../enums/escope'
+
+module Saklient
+  module Cloud
+    module Models
+
+      # アーカイブを検索・作成するための機能を備えたクラス.
+      class Model_Archive < Saklient::Cloud::Models::Model
+
+        protected
+
+        # @private
+        # @return [String]
+        def _api_path
+          return '/archive'
+        end
+
+        # @private
+        # @return [String]
+        def _root_key
+          return 'Archive'
+        end
+
+        # @private
+        # @return [String]
+        def _root_key_m
+          return 'Archives'
+        end
+
+        # @private
+        # @return [String]
+        def _class_name
+          return 'Archive'
+        end
+
+        public
+
+        # 次に取得するリストの開始オフセットを指定します.
+        #
+        # @param [Fixnum] offset オフセット
+        # @return [Model_Archive] this
+        def offset(offset)
+          Saklient::Util::validate_type(offset, 'Fixnum')
+          return _offset(offset)
+        end
+
+        # 次に取得するリストの上限レコード数を指定します.
+        #
+        # @param [Fixnum] count 上限レコード数
+        # @return [Model_Archive] this
+        def limit(count)
+          Saklient::Util::validate_type(count, 'Fixnum')
+          return _limit(count)
+        end
+
+        # Web APIのフィルタリング設定を直接指定します.
+        #
+        # @param [String] key キー
+        # @param [any] value 値
+        # @param [bool] multiple valueに配列を与え, OR条件で完全一致検索する場合にtrueを指定します. 通常, valueはスカラ値であいまい検索されます.
+        # @return [Model_Archive]
+        def filter_by(key, value, multiple = false)
+          Saklient::Util::validate_type(key, 'String')
+          Saklient::Util::validate_type(multiple, 'bool')
+          return _filter_by(key, value, multiple)
+        end
+
+        # 次のリクエストのために設定されているステートをすべて破棄します.
+        #
+        # @return [Model_Archive] this
+        def reset
+          return _reset
+        end
+
+        # 新規リソース作成用のオブジェクトを用意します.
+        #
+        # 返り値のオブジェクトにパラメータを設定し, save() を呼ぶことで実際のリソースが作成されます.
+        #
+        # @return [Saklient::Cloud::Resources::Archive] リソースオブジェクト
+        def create
+          return _create
+        end
+
+        # 指定したIDを持つ唯一のリソースを取得します.
+        #
+        # @param [String] id
+        # @return [Saklient::Cloud::Resources::Archive] リソースオブジェクト
+        def get_by_id(id)
+          Saklient::Util::validate_type(id, 'String')
+          return _get_by_id(id)
+        end
+
+        # リソースの検索リクエストを実行し, 結果をリストで取得します.
+        #
+        # @return [Array<Saklient::Cloud::Resources::Archive>] リソースオブジェクトの配列
+        def find
+          return _find
+        end
+
+        # 指定した文字列を名前に含むリソースに絞り込みます.
+        #
+        # 大文字・小文字は区別されません.
+        # 半角スペースで区切られた複数の文字列は, それらをすべて含むことが条件とみなされます.
+        #
+        # @todo Implement test case
+        # @param [String] name
+        # @return [Model_Archive]
+        def with_name_like(name)
+          Saklient::Util::validate_type(name, 'String')
+          return _with_name_like(name)
+        end
+
+        # 指定したタグを持つリソースに絞り込みます.
+        #
+        # 複数のタグを指定する場合は withTags() を利用してください.
+        #
+        # @todo Implement test case
+        # @param [String] tag
+        # @return [Model_Archive]
+        def with_tag(tag)
+          Saklient::Util::validate_type(tag, 'String')
+          return _with_tag(tag)
+        end
+
+        # 指定したすべてのタグを持つリソースに絞り込みます.
+        #
+        # @todo Implement test case
+        # @param [Array<String>] tags
+        # @return [Model_Archive]
+        def with_tags(tags)
+          Saklient::Util::validate_type(tags, 'Array')
+          return _with_tags(tags)
+        end
+
+        # 指定したDNFに合致するタグを持つリソースに絞り込みます.
+        #
+        # @todo Implement test case
+        # @param [Array<Array<String>>] dnf
+        # @return [Model_Archive]
+        def with_tag_dnf(dnf)
+          Saklient::Util::validate_type(dnf, 'Array')
+          return _with_tag_dnf(dnf)
+        end
+
+        # 名前でソートします.
+        #
+        # @todo Implement test case
+        # @param [bool] reverse
+        # @return [Model_Archive]
+        def sort_by_name(reverse = false)
+          Saklient::Util::validate_type(reverse, 'bool')
+          return _sort_by_name(reverse)
+        end
+
+        # @private
+        # @param [Saklient::Cloud::Client] client
+        def initialize(client)
+          super(client)
+          Saklient::Util::validate_type(client, 'Saklient::Cloud::Client')
+        end
+
+        # 指定したサイズのアーカイブに絞り込みます.
+        #
+        # @param [Fixnum] sizeGib
+        # @return [Model_Archive]
+        def with_size_gib(sizeGib)
+          Saklient::Util::validate_type(sizeGib, 'Fixnum')
+          _filter_by('SizeMB', [sizeGib * 1024])
+          return self
+        end
+
+        # パブリックアーカイブに絞り込みます.
+        #
+        # @return [Model_Archive]
+        def with_shared_scope
+          _filter_by('Scope', [Saklient::Cloud::Enums::EScope::shared])
+          return self
+        end
+
+        # プライベートアーカイブに絞り込みます.
+        #
+        # @return [Model_Archive]
+        def with_user_scope
+          _filter_by('Scope', [Saklient::Cloud::Enums::EScope::user])
+          return self
+        end
+
+        # サイズでソートします.
+        #
+        # @param [bool] reverse
+        # @return [Model_Archive]
+        def sort_by_size(reverse = false)
+          Saklient::Util::validate_type(reverse, 'bool')
+          _sort('SizeMB', reverse)
+          return self
+        end
+
+      end
+
+    end
+  end
+end