gs2-ruby-sdk-realtime 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c9f1adbf36a8ee5b48ca7cf72bc25bbfe7a13f5f
+  data.tar.gz: 5ea684f5751d97810cef1ea1ecd828d5d6aa6145
+SHA512:
+  metadata.gz: 5d49d6b491ebf4421182b6a06db3a7277fcc8347995cecd1d7f92f5155e8afa323bb55026ad0dfd3a74d9022311cc3c26c179a5cf6e9936838c5852e45b07450
+  data.tar.gz: dc9ece8c61dea37c75621ab55a1216152ae507606c5db140788275bf68f10798c7589b4dd4d0a4b63815972659e71244a483f60de4bc47edb8f6ab0f21c3cd9f

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

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

@@ -0,0 +1,284 @@
+require 'gs2/core/AbstractClient.rb'
+
+module Gs2 module Realtime
+  
+  # GS2-Realtime クライアント
+  #
+  # @author Game Server Services, Inc.
+  class Client < Gs2::Core::AbstractClient
+  
+    @@ENDPOINT = 'realtime'
+  
+    # コンストラクタ
+    # 
+    # @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]
+    #       * gatheringPoolId => ギャザリングプールID
+    #       * ownerId => オーナーID
+    #       * name => ギャザリングプール名
+    #       * description => 説明文
+    #       * createAt => 作成日時
+    #   * nextPageToken => 次ページトークン
+    def describe_gathering_pool(pageToken = nil, limit = nil)
+      query = {}
+      if pageToken; query['pageToken'] = pageToken; end
+      if limit; query['limit'] = limit; end
+      return get(
+            'Gs2Realtime', 
+            'DescribeGatheringPool', 
+            @@ENDPOINT, 
+            '/gatheringPool',
+            query);
+    end
+    
+    # ギャザリングプールを作成<br>
+    # <br>
+    # GS2-Realtime を利用するには、まずギャザリングプールを作成する必要があります。<br>
+    # ギャザリングプールには複数のギャザリングを紐付けることができます。<br>
+    # 
+    # @param request [Array]
+    #   * name => マッチメイキング名
+    #   * description => 説明文
+    # @return [Array]
+    #   * item
+    #     * gatheringPoolId => ギャザリングプールID
+    #     * ownerId => オーナーID
+    #     * name => ギャザリングプール名
+    #     * description => 説明文
+    #     * createAt => 作成日時
+    def create_gathering_pool(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(
+            'Gs2Realtime', 
+            'CreateGatheringPool', 
+            @@ENDPOINT, 
+            '/gatheringPool',
+            body,
+            query);
+    end
+  
+    # ギャザリングプールを取得
+    # 
+    # @param request [Array]
+    #   * gatheringPoolName => ギャザリングプール名
+    # @return [Array]
+    #   * item
+    #     * gatheringPoolId => ギャザリングプールID
+    #     * ownerId => オーナーID
+    #     * name => ギャザリングプール名
+    #     * description => 説明文
+    #     * createAt => 作成日時
+    def get_gathering_pool(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('gatheringPoolName'); raise ArgumentError.new(); end
+      if not request['gatheringPoolName']; raise ArgumentError.new(); end
+      query = {}
+      return get(
+          'Gs2Realtime',
+          'GetGatheringPool',
+          @@ENDPOINT,
+          '/gatheringPool/' + request['gatheringPoolName'],
+          query);
+    end
+  
+    # ギャザリングプールを更新
+    # 
+    # @param request [Array]
+    #   * gatheringPoolName => ギャザリングプール名
+    #   * description => 説明文
+    # @return [Array]
+    #   * item
+    #     * gatheringPoolId => ギャザリングプールID
+    #     * ownerId => オーナーID
+    #     * name => ギャザリングプール名
+    #     * description => 説明文
+    #     * createAt => 作成日時
+    def update_gathering_pool(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('gatheringPoolName'); raise ArgumentError.new(); end
+      if not request['gatheringPoolName']; raise ArgumentError.new(); end
+      body = {}
+      if request.has_key?('description'); body['description'] = request['description']; end
+      query = {}
+      return put(
+          'Gs2Realtime',
+          'UpdateGatheringPool',
+          @@ENDPOINT,
+          '/gatheringPool/' + request['gatheringPoolName'],
+          body,
+          query);
+    end
+    
+    # ギャザリングプールを削除
+    # 
+    # @param request [Array]
+    #   * gatheringPoolName => ギャザリングプール名
+    def delete_gathering_pool(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('gatheringPoolName'); raise ArgumentError.new(); end
+      if not request['gatheringPoolName']; raise ArgumentError.new(); end
+      query = {}
+      return delete(
+            'Gs2Realtime', 
+            'DeleteGatheringPool', 
+            @@ENDPOINT, 
+            '/gatheringPool/' + request['gatheringPoolName'],
+            query);
+    end
+    
+    # ギャザリングリストを取得
+    # 
+    # @param request [Array]
+    #   * gatheringPoolName => ギャザリングプール名
+    # @param pageToken [String] ページトークン
+    # @param limit [Integer] 取得件数
+    # @return [Array]
+    #   * items
+    #     [Array]
+    #       * gatheringId => ギャザリングID
+    #       * ownerId => オーナーID
+    #       * name => ギャザリング名
+    #       * hostId => ホストID
+    #       * ipAddress => IPアドレス
+    #       * port => 待ち受けポート
+    #       * secret => 暗号鍵
+    #       * userIds => 参加ユーザIDリスト
+    #       * createAt => 作成日時
+    #   * nextPageToken => 次ページトークン
+    def describe_gathering(request, pageToken = nil, limit = nil)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('gatheringPoolName'); raise ArgumentError.new(); end
+      if not request['gatheringPoolName']; raise ArgumentError.new(); end
+      query = {}
+      if pageToken; query['pageToken'] = pageToken; end
+      if limit; query['limit'] = limit; end
+      return get(
+            'Gs2Realtime', 
+            'DescribeGathering', 
+            @@ENDPOINT, 
+            '/gatheringPool/' + request['gatheringPoolName'] + '/gathering',
+            query);
+    end
+    
+    # ギャザリングを作成<br>
+    # <br>
+    # ギャザリングを作成すると、ゲームサーバが起動します。<br>
+    # ゲームサーバはWebSocketで接続することができ、同じゲームサーバに接続しているユーザ間でメッセージをやり取りすることができます。<br>
+    # ゲームサーバとの通信プロトコルの説明については別途ドキュメントを確認してください。<br>
+    # <br>
+    # userIds にユーザIDを指定することで、ギャザリングに参加できるユーザのIDを制限することができます。<br>
+    # ギャザリング作成時に参加するユーザが確定している場合は指定してください。<br>
+    # 省略すると、暗号鍵を知っていれば誰でも参加することができます。<br>
+    # 
+    # @param request [Array]
+    #   * gatheringPoolName => ギャザリングプール名
+    #   * name => ギャザリング名
+    #   * userIds => 参加ユーザIDリスト
+    # @return [Array]
+    #   * item
+    #     * gatheringId => ギャザリングID
+    #     * ownerId => オーナーID
+    #     * name => ギャザリング名
+    #     * hostId => ホストID
+    #     * ipAddress => IPアドレス
+    #     * port => 待ち受けポート
+    #     * secret => 暗号鍵
+    #     * userIds => 参加ユーザIDリスト
+    #     * createAt => 作成日時
+    def create_gathering(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('gatheringPoolName'); raise ArgumentError.new(); end
+      if not request['gatheringPoolName']; raise ArgumentError.new(); end
+      body = {}
+      if request.has_key?('name'); body['name'] = request['name']; end
+      if request.has_key?('userIds')
+        body['userIds'] = request['userIds']
+        if body['userIds'].is_a?(Array); body['userIds'] = body['userIds'].join(','); end
+      end
+      query = {}
+      return post(
+            'Gs2Realtime', 
+            'CreateGathering', 
+            @@ENDPOINT, 
+            '/gatheringPool/' + request['gatheringPoolName'] + '/gathering',
+            body,
+            query);
+    end
+  
+    # ギャザリングを取得
+    # 
+    # @param request [Array]
+    #   * gatheringPoolName => ギャザリングプール名
+    #   * gatheringName => ギャザリング名
+    # @return [Array]
+    #   * item
+    #     * gatheringId => ギャザリングID
+    #     * ownerId => オーナーID
+    #     * name => ギャザリング名
+    #     * hostId => ホストID
+    #     * ipAddress => IPアドレス
+    #     * port => 待ち受けポート
+    #     * secret => 暗号鍵
+    #     * userIds => 参加ユーザIDリスト
+    #     * createAt => 作成日時
+    def get_gathering(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('gatheringPoolName'); raise ArgumentError.new(); end
+      if not request['gatheringPoolName']; raise ArgumentError.new(); end
+      if not request.has_key?('gatheringName'); raise ArgumentError.new(); end
+      if not request['gatheringName']; raise ArgumentError.new(); end
+      query = {}
+      return get(
+          'Gs2Realtime',
+          'GetGathering',
+          @@ENDPOINT,
+          '/gatheringPool/' + request['gatheringPoolName'] + '/gathering/' + request['gatheringName'],
+          query);
+    end
+    
+    # ギャザリングを削除
+    # 
+    # @param request [Array]
+    #   * gatheringPoolName => ギャザリングプール名
+    #   * gatheringName => ギャザリング名
+    def delete_gathering(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('gatheringPoolName'); raise ArgumentError.new(); end
+      if not request['gatheringPoolName']; raise ArgumentError.new(); end
+      if not request.has_key?('gatheringName'); raise ArgumentError.new(); end
+      if not request['gatheringName']; raise ArgumentError.new(); end
+      query = {}
+      return delete(
+            'Gs2Realtime', 
+            'DeleteGathering', 
+            @@ENDPOINT, 
+            '/gatheringPool/' + request['gatheringPoolName'] + '/gathering/' + request['gatheringName'],
+            query);
+    end
+  end
+end end

data/lib/gs2/realtime/version.rb

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

data/lib/gs2-realtime.rb

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

metadata

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