gs2-ruby-sdk-watch 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44e125588facd495cd3bfdc7d4411139110c91f3
+  data.tar.gz: 9b3d6865a9a2512d3805580f681eaa4f0c2ec222
+SHA512:
+  metadata.gz: eef684d281562f63d9d093cf605ef435226e598332612dfbf5e39543cb3b6c4bd8c0cd8164dedb2b97642c82f121d351fde018f98718bd8d37110c61fda3334d
+  data.tar.gz: 17211d2f7ed472eb288cb694c6304e3eb712a7714cb9464acd154b721f679a51d05d26695eeffd8b987f952543197cb8cea9a16ce05d98a32c291753b638ae52

data/.buildpath

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<buildpath>
+	<buildpathentry kind="src" path="lib"/>
+	<buildpathentry kind="con" path="org.eclipse.dltk.launching.INTERPRETER_CONTAINER"/>
+</buildpath>

data/.gitignore

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

data/.project

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>gs2-ruby-sdk-watch</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.eclipse.dltk.core.scriptbuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.dltk.ruby.core.nature</nature>
+	</natures>
+</projectDescription>

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'test-unit', '3.1.0'
+gem "simplecov", "~> 0.11"

data/README.md

@@ -0,0 +1,2 @@
+gs2-ruby-sdk-watch
+===============

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gs2/sdk/for/ruby/watch"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gs2-ruby-sdk-watch.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gs2/watch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gs2-ruby-sdk-watch"
+  spec.version       = Gs2::Watch::VERSION
+  spec.authors       = ["Game Server Services, Inc."]
+  spec.email         = ["contact@gs2.io"]
+  spec.licenses		 = "Apache-2.0"
+
+  spec.summary       = %q{Game Server Services GS2-Watch Client Library}
+  spec.homepage      = "https://gs2.io/"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "gs2-ruby-sdk-core", "~> 0.0.1"
+  
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/gs2/watch/Client.rb

@@ -0,0 +1,310 @@
+require 'gs2/core/AbstractClient.rb'
+
+module Gs2 module Watch
+  
+  # GS2-Watch クライアント
+  #
+  # @author Game Server Services, Inc.
+  class Client < Gs2::Core::AbstractClient
+  
+    @@ENDPOINT = 'watch'
+  
+    # コンストラクタ
+    # 
+    # @param region [String] リージョン名
+    # @param gs2_client_id [String] GSIクライアントID
+    # @param gs2_client_secret [String] GSIクライアントシークレット
+    def initialize(region, gs2_client_id, gs2_client_secret)
+      super(region, gs2_client_id, gs2_client_secret)
+    end
+    
+    # デバッグ用。通常利用する必要はありません。
+    def self.ENDPOINT(v = nil)
+      if v
+        @@ENDPOINT = v
+      else
+        return @@ENDPOINT
+      end
+    end
+
+    # アラームリストを取得
+    # 
+    # @param pageToken [String] ページトークン
+    # @param limit [Integer] 取得件数
+    # @return [Array]
+    #   * items
+    #     [Array]
+    #       * alermId => アラームID
+    #       * ownerId => オーナーID
+    #       * name => アラーム名
+    #       * description => 説明文
+    #       * service => 監視対象サービス
+    #       * serviceId => 監視対象サービスID
+    #       * operation => 監視対象オペレーション
+    #       * expression => 演算子
+    #       * threshold => 閾値
+    #       * notificationId => 通知ID
+    #       * createAt => 作成日時
+    #       * updateAt => 更新日時
+    #       * status => ステータス
+    #       * lastStatusChangeAt => 最終ステータス更新日時
+    #   * nextPageToken => 次ページトークン
+    def describe_alerm(pageToken = nil, limit = nil)
+      query = {}
+      if pageToken; query['pageToken'] = pageToken; end
+      if limit; query['limit'] = limit; end
+      return get(
+            'Gs2Watch', 
+            'DescribeAlerm', 
+            @@ENDPOINT, 
+            '/alerm',
+            query);
+    end
+    
+    # アラームを作成<br>
+    # <br>
+    # GS2 内のスタティスティックスに対して監視を行うことができます。<br>
+    # クオータの消費量に対して閾値を設定し、閾値を超えた際に通知を出すことができます。<br>
+    # 
+    # @param request [Array]
+    #   * name => アラーム名
+    #   * description => 説明文
+    #   * service => 監視対象サービス
+    #   * serviceId => 監視対象サービスID
+    #   * operation => 監視対象オペレーション
+    #   * expression => 演算子(>=, >, <, <=)
+    #   * threshold => 閾値
+    #   * notificationId => 通知ID
+    # @return [Array]
+    #   * item
+    #     * alermId => アラームID
+    #     * ownerId => オーナーID
+    #     * name => アラーム名
+    #     * description => 説明文
+    #     * service => 監視対象サービス
+    #     * serviceId => 監視対象サービスID
+    #     * operation => 監視対象オペレーション
+    #     * expression => 演算子
+    #     * threshold => 閾値
+    #     * notificationId => 通知ID
+    #     * createAt => 作成日時
+    #     * updateAt => 更新日時
+    #     * status => ステータス
+    #     * lastStatusChangeAt => 最終ステータス更新日時
+    def create_alerm(request)
+      if not request; raise ArgumentError.new(); end
+      body = {}
+      if request.has_key?('name'); body['name'] = request['name']; end
+      if request.has_key?('description'); body['description'] = request['description']; end
+      if request.has_key?('service'); body['service'] = request['service']; end
+      if request.has_key?('serviceId'); body['serviceId'] = request['serviceId']; end
+      if request.has_key?('operation'); body['operation'] = request['operation']; end
+      if request.has_key?('expression'); body['expression'] = request['expression']; end
+      if request.has_key?('threshold'); body['threshold'] = request['threshold']; end
+      if request.has_key?('notificationId'); body['notificationId'] = request['notificationId']; end
+      query = {}
+      return post(
+            'Gs2Watch', 
+            'CreateAlerm', 
+            @@ENDPOINT, 
+            '/alerm',
+            body,
+            query);
+    end
+  
+    # アラームを取得
+    # 
+    # @param request [Array]
+    #   * alermName => アラーム名
+    # @return [Array]
+    #   * item
+    #     * alermId => アラームID
+    #     * ownerId => オーナーID
+    #     * name => アラーム名
+    #     * description => 説明文
+    #     * service => 監視対象サービス
+    #     * serviceId => 監視対象サービスID
+    #     * operation => 監視対象オペレーション
+    #     * expression => 演算子
+    #     * threshold => 閾値
+    #     * notificationId => 通知ID
+    #     * createAt => 作成日時
+    #     * updateAt => 更新日時
+    #     * status => ステータス
+    #     * lastStatusChangeAt => 最終ステータス更新日時
+    def get_alerm(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('alermName'); raise ArgumentError.new(); end
+      if not request['alermName']; raise ArgumentError.new(); end
+      query = {}
+      return get(
+          'Gs2Watch',
+          'GetAlerm',
+          @@ENDPOINT,
+          '/alerm/' + request['alermName'],
+          query);
+    end
+  
+    # アラームを更新
+    # 
+    # @param request [Array]
+    #   * alermName => アラーム名
+    #   * description => 説明文
+    #   * expression => 演算子(>=, >, <, <=)
+    #   * threshold => 閾値
+    #   * notificationId => 通知ID
+    # @return [Array]
+    #   * item
+    #     * alermId => アラームID
+    #     * ownerId => オーナーID
+    #     * name => アラーム名
+    #     * description => 説明文
+    #     * service => 監視対象サービス
+    #     * serviceId => 監視対象サービスID
+    #     * operation => 監視対象オペレーション
+    #     * expression => 演算子
+    #     * threshold => 閾値
+    #     * notificationId => 通知ID
+    #     * createAt => 作成日時
+    #     * updateAt => 更新日時
+    #     * status => ステータス
+    #     * lastStatusChangeAt => 最終ステータス更新日時
+    def update_alerm(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('alermName'); raise ArgumentError.new(); end
+      if not request['alermName']; raise ArgumentError.new(); end
+      body = {}
+      if request.has_key?('description'); body['description'] = request['description']; end
+      if request.has_key?('expression'); body['expression'] = request['expression']; end
+      if request.has_key?('threshold'); body['threshold'] = request['threshold']; end
+      if request.has_key?('notificationId'); body['notificationId'] = request['notificationId']; end
+      query = {}
+      return put(
+          'Gs2Watch',
+          'UpdateAlerm',
+          @@ENDPOINT,
+          '/alerm/' + request['alermName'],
+          body,
+          query);
+    end
+    
+    # アラームを削除
+    # 
+    # @param request [Array]
+    #   * alermName => アラーム名
+    def delete_alerm(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('alermName'); raise ArgumentError.new(); end
+      if not request['alermName']; raise ArgumentError.new(); end
+      query = {}
+      return delete(
+            'Gs2Watch', 
+            'DeleteAlerm', 
+            @@ENDPOINT, 
+            '/alerm/' + request['alermName'],
+            query);
+    end
+  
+    # アラームイベントリストを取得<br>
+    # <br>
+    # 過去にアラームが発生した履歴などを確認できます。<br>
+    #
+    # @param request [Array]
+    #   * alermName => アラーム名
+    # @param pageToken [String] ページトークン
+    # @param limit [Integer] 取得件数
+    # @return [Array]
+    #   * items
+    #     [Array]
+    #       * eventId => アラームイベントID
+    #       * alermId => アラームID
+    #       * type => イベントの種類
+    #       * eventAt => イベント発生日時
+    #   * nextPageToken => 次ページトークン
+    def describe_alerm_event(request, pageToken = nil, limit = nil)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('alermName'); raise ArgumentError.new(); end
+      if not request['alermName']; raise ArgumentError.new(); end
+      query = {}
+      if pageToken; query['pageToken'] = pageToken; end
+      if limit; query['limit'] = limit; end
+      return get(
+          'Gs2Watch',
+          'DescribeAlermEvent',
+          @@ENDPOINT,
+          '/alerm/' + request['alermName'] + '/event',
+          query);
+    end
+  
+    # サービス名リストを取得<br>
+    # <br>
+    # アラームを設定する際に指定できるサービスの一覧を取得できます。<br>
+    #
+    # @return [Array] サービス名リスト
+    def describe_service()
+      query = {}
+      result = get(
+          'Gs2Watch',
+          'DescribeService',
+          @@ENDPOINT,
+          '/service',
+          query);
+      return result['items'];
+    end
+  
+    # オペレーション名リストを取得<br>
+    # <br>
+    # アラームを設定する際に指定できるオペレーションの一覧を取得できます。<br>
+    #
+    # @param request [Array]
+    #   * serviceName => サービス名
+    # @return [Array] オペレーション名リスト
+    def describe_operation(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('serviceName'); raise ArgumentError.new(); end
+      if not request['serviceName']; raise ArgumentError.new(); end
+      query = {}
+      result = get(
+          'Gs2Watch',
+          'DescribeOperation',
+          @@ENDPOINT,
+          '/service/' + request['serviceName'] + '/operation',
+          query);
+      return result['items'];
+    end
+  
+    # メトリクスを取得<br>
+    # <br>
+    # 過去のサービスの利用状況を取得します。<br>
+    # 
+    # @param request [Array]
+    #   * serviceId => サービスID
+    #   * operation => オペレーション名
+    #   * begin => メトリクス取得開始日時(unixepoch)
+    #   * end => メトリクス取得終了日時(unixepoch)
+    #   * allowLongTerm => 7日以上の期間のデータを取得することを許可するか(OPTIONAL)
+    #   * serviceId => サービスID
+    # @return [Array]
+    #   * items
+    #     [Array]
+    #       * timestamp => タイムスタンプ(YYYY-MM-DD HH:mm:SS)
+    #       * value => 値
+    def get_metric(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('serviceId'); raise ArgumentError.new(); end
+      if not request['serviceId']; raise ArgumentError.new(); end
+      if not request.has_key?('operation'); raise ArgumentError.new(); end
+      if not request['operation']; raise ArgumentError.new(); end
+      query = {}
+      if request.has_key?('begin'); query['begin'] = request['begin']; end
+      if request.has_key?('end'); query['end'] = request['end']; end
+      if request.has_key?('allowLongTerm'); query['allowLongTerm'] = request['allowLongTerm']; end
+      return get(
+          'Gs2Watch',
+          'GetMetric',
+          @@ENDPOINT,
+          '/metric/' + request['serviceId'] + '/' + request['operation'],
+          query);
+    end
+  end
+end end

data/lib/gs2/watch/version.rb

@@ -0,0 +1,5 @@
+module Gs2
+  module Watch
+    VERSION = "0.0.1"
+  end
+end

data/lib/gs2-watch.rb

@@ -0,0 +1 @@
+require 'gs2/watch/Client.rb'

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: gs2-ruby-sdk-watch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Game Server Services, Inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gs2-ruby-sdk-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: 
+email:
+- contact@gs2.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".buildpath"
+- ".gitignore"
+- ".project"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gs2-ruby-sdk-watch.gemspec
+- lib/gs2-watch.rb
+- lib/gs2/watch/Client.rb
+- lib/gs2/watch/version.rb
+homepage: https://gs2.io/
+licenses:
+- Apache-2.0
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Game Server Services GS2-Watch Client Library
+test_files: []