gs2-ruby-sdk-notification 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f0f39fc7c3e46e816f3c47856a68b9a830c62fa
+  data.tar.gz: 3d6618c99625b92ee4fccdeebce661363c2fbe0a
+SHA512:
+  metadata.gz: 4e4a131fdfe5a677146b9ee1c3d869b51b593e223dbce0e74774f3b5d83fd329e53387a699fa6e7e6e511c59c39e7ddcb132c1ed896bac4f0b22f04869344db6
+  data.tar.gz: 12b4dc496957655e35fb291326950579661157272379d5eceaa040539d629d6a2c731ab26e1d052ecf9a1adf03fffdaccaf91ac81013976a1e34cba338bc23b6

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-notification</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-notification
+===============

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/notification"
+
+# 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-notification.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/notification/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gs2-ruby-sdk-notification"
+  spec.version       = Gs2::Notification::VERSION
+  spec.authors       = ["Game Server Services, Inc."]
+  spec.email         = ["contact@gs2.io"]
+  spec.licenses		 = "Apache-2.0"
+
+  spec.summary       = %q{Game Server Services GS2-Notification 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-notification.rb

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

data/lib/gs2/notification/Client.rb

@@ -0,0 +1,289 @@
+require 'gs2/core/AbstractClient.rb'
+
+module Gs2 module Notification
+  
+  # GS2-Notification クライアント
+  #
+  # @author Game Server Services, Inc.
+  class Client < Gs2::Core::AbstractClient
+  
+    @@ENDPOINT = 'notification'
+  
+    # コンストラクタ
+    # 
+    # @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]
+    #       * notificationId => 通知ID
+    #       * ownerId => オーナーID
+    #       * name => 通知名
+    #       * description => 説明文
+    #       * createAt => 作成日時
+    #       * updateAt => 更新日時
+    #   * nextPageToken => 次ページトークン
+    def describe_notification(pageToken = nil, limit = nil)
+      query = {}
+      if pageToken; query['pageToken'] = pageToken; end
+      if limit; query['limit'] = limit; end
+      return get(
+            'Gs2Notification', 
+            'DescribeNotification', 
+            @@ENDPOINT, 
+            '/notification',
+            query);
+    end
+    
+    # 通知を作成<br>
+    # <br>
+    # 通知はGS2内で発生したイベントを受け取る手段を提供します。<br>
+    # 例えば、GS2-Watch の監視データが一定の閾値を超えた時に通知する。といった用途に利用できます。<br>
+    # <br>
+    # GS2 のサービスの多くはクオータを買い、その範囲内でサービスを利用する形式が多く取られていますが、<br>
+    # 現在の消費クオータが GS2-Watch で取れますので、クオータの消費量が予約量の80%を超えたら通知をだす。というような使い方ができます。<br>
+    # 
+    # @param request [Array]
+    #   * name => 通知名
+    #   * description => 説明文
+    # @return [Array]
+    #   * item
+    #     * notificationId => 通知ID
+    #     * ownerId => オーナーID
+    #     * name => 通知名
+    #     * description => 説明文
+    #     * createAt => 作成日時
+    #     * updateAt => 更新日時
+    def create_notification(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
+      query = {}
+      return post(
+            'Gs2Notification', 
+            'CreateNotification', 
+            @@ENDPOINT, 
+            '/notification',
+            body,
+            query);
+    end
+  
+    # 通知を取得
+    #
+    # @param request [Array]
+    #   * notificationName => 通知名
+    # @return [Array]
+    #   * item
+    #     * notificationId => 通知ID
+    #     * ownerId => オーナーID
+    #     * name => 通知名
+    #     * description => 説明文
+    #     * createAt => 作成日時
+    #     * updateAt => 更新日時
+    def get_notification(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('notificationName'); raise ArgumentError.new(); end
+      if not request['notificationName']; raise ArgumentError.new(); end
+      query = {}
+      return get(
+          'Gs2Notification',
+          'GetNotification',
+          @@ENDPOINT,
+          '/notification/' + request['notificationName'],
+          query);
+    end
+  
+    # 通知を更新
+    #
+    # @param request [Array]
+    #   * notificationName => 通知名
+    #   * description => 説明文
+    # @return [Array] 
+    #   * item
+    #     * notificationId => 通知ID
+    #     * ownerId => オーナーID
+    #     * name => 通知名
+    #     * description => 説明文
+    #     * createAt => 作成日時
+    #     * updateAt => 更新日時
+    def update_notification(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('notificationName'); raise ArgumentError.new(); end
+      if not request['notificationName']; raise ArgumentError.new(); end
+      body = {}
+      if request.has_key?('description'); body['description'] = request['description']; end
+      query = {}
+      return put(
+          'Gs2Notification',
+          'UpdateNotification',
+          @@ENDPOINT,
+          '/notification/' + request['notificationName'],
+          body,
+          query);
+    end
+    
+    # 通知を削除
+    # 
+    # @param request [Array]
+    #   * notificationName => 通知名
+    def delete_notification(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('notificationName'); raise ArgumentError.new(); end
+      if not request['notificationName']; raise ArgumentError.new(); end
+      query = {}
+      return delete(
+            'Gs2Notification', 
+            'DeleteNotification', 
+            @@ENDPOINT, 
+            '/notification/' + request['notificationName'],
+            query);
+    end
+    
+    # 通知先リストを取得
+    #
+    # @param request [Array]
+    #   * notificationName => 通知名
+    # @param pageToken [String] ページトークン
+    # @param limit [Integer] 取得件数
+    # @return [Array]
+    #   * items
+    #     [Array]
+    #       * subscribeId => 通知先ID
+    #       * notificationId => 通知ID
+    #       * type => 通知プロトコル
+    #       * endpoint => 通知先
+    #       * createAt => 作成日時
+    #   * nextPageToken => 次ページトークン
+    def describe_subscribe(request, pageToken = nil, limit = nil)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('notificationName'); raise ArgumentError.new(); end
+      if not request['notificationName']; raise ArgumentError.new(); end
+      query = {}
+      if pageToken; query['pageToken'] = pageToken; end
+      if limit; query['limit'] = limit; end
+      return get(
+          'Gs2Notification',
+          'DescribeSubscribe',
+          @@ENDPOINT,
+          '/notification/' + request['notificationName'] + '/subscribe',
+          query);
+    end
+    
+    # 通知先を作成<br>
+    # <br>
+    # E-Mail, HTTP/HTTPS 通信を指定して通知先を登録できます。<br>
+    # 通知先は1つの通知に対して複数登録することもできます。<br>
+    # <br>
+    # そのため、メールとSlackに通知する。といった利用ができます。<br>
+    # <br>
+    # type に指定できるパラメータ<br>
+    #
+    # * email
+    # * http/https
+    #
+    # <br>
+    # endpoint には type に指定したプロトコルによって指定する内容が変わります。<br>
+    # email を選択した場合には メールアドレスを、<br>
+    # http/https を選択した場合には URL を指定してください。<br>
+    # <br>
+    # http/https を選択した場合には登録時に疎通確認を行います。<br>
+    # 指定したURLでPOSTリクエストを受け付けられる状態で登録してください。<br>
+    # 疎通確認の通信は通常の通知とは異なり、body パラメータがからの通信が発生します。ご注意ください。<br>
+    #
+    # @param request [Array]
+    #   * notificationName => 通知名
+    #   * name => 通知先名
+    #   * type => 通知プロトコル
+    #   * endpoint => 通知先
+    # @return [Array]
+    #   * item
+    #     * subscribeId => 通知先ID
+    #     * notificationId => 通知ID
+    #     * type => 通知プロトコル
+    #     * endpoint => 通知先
+    #     * createAt => 作成日時
+    def create_subscribe(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('notificationName'); raise ArgumentError.new(); end
+      if not request['notificationName']; raise ArgumentError.new(); end
+      body = {}
+      if request.has_key?('name'); body['name'] = request['name']; end
+      if request.has_key?('type'); body['type'] = request['type']; end
+      if request.has_key?('endpoint'); body['endpoint'] = request['endpoint']; end
+      query = {}
+      return post(
+          'Gs2Notification',
+          'CreateSubscribe',
+          @@ENDPOINT,
+          '/notification/' + request['notificationName'] + '/subscribe',
+          body,
+          query);
+    end
+    
+    # 通知先を取得
+    #
+    # @param request [Array]
+    #   * notificationName => 通知名
+    #   * subscribeId => 通知先ID
+    # @return [Array]
+    #   * item
+    #     * subscribeId => 通知先ID
+    #     * notificationId => 通知ID
+    #     * type => 通知プロトコル
+    #     * endpoint => 通知先
+    #     * createAt => 作成日時
+    def get_subscribe(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('notificationName'); raise ArgumentError.new(); end
+      if not request['notificationName']; raise ArgumentError.new(); end
+      if not request.has_key?('subscribeId'); raise ArgumentError.new(); end
+      if not request['subscribeId']; raise ArgumentError.new(); end
+      query = {}
+      return get(
+          'Gs2Notification',
+          'GetSubscribe',
+          @@ENDPOINT,
+          '/notification/' + request['notificationName'] + '/subscribe/' + request['subscribeId'],
+          query);
+    end
+    
+    # 通知先を削除
+    # 
+    # @param request [Array]
+    #   * notificationName => 通知名
+    #   * subscribeId => 通知先ID
+    def delete_subscribe(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('notificationName'); raise ArgumentError.new(); end
+      if not request['notificationName']; raise ArgumentError.new(); end
+      if not request.has_key?('subscribeId'); raise ArgumentError.new(); end
+      if not request['subscribeId']; raise ArgumentError.new(); end
+      query = {}
+      return delete(
+          'Gs2Notification',
+          'DeleteSubscribe',
+          @@ENDPOINT,
+          '/notification/' + request['notificationName'] + '/subscribe/' + request['subscribeId'],
+          query);
+    end
+  end
+end end

data/lib/gs2/notification/version.rb

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

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: gs2-ruby-sdk-notification
+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-notification.gemspec
+- lib/gs2-notification.rb
+- lib/gs2/notification/Client.rb
+- lib/gs2/notification/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-Notification Client Library
+test_files: []