gs2-ruby-sdk-stamina 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b0bee334d7e80df544657c5e50dbea608a2d4e7
+  data.tar.gz: c7a6e704ff1b4732547ae3f05eb180bfa30c17c7
+SHA512:
+  metadata.gz: ca05c62d2e90b6f843d2d6adbef559ec520dbcffc03c222232f429cbb692bd50a77372f852974732e221c95745689fbe632c3917cf0b1ed2631f68640bce8360
+  data.tar.gz: 014e1d5d009dc27f1d73d141a6f9275a0dd1361bb53c55120d667cec968fe615a00d7f4cdf8a7c7f34ddfb2a2acd1d75999ea570e0b897f7e61f0fab6392e201

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

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/stamina"
+
+# 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-stamina.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gs2/stamina/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gs2-ruby-sdk-stamina"
+  spec.version       = Gs2::Stamina::VERSION
+  spec.authors       = ["Game Server Services, Inc."]
+  spec.email         = ["contact@gs2.io"]
+  spec.licenses		 = "Apache-2.0"
+
+  spec.summary       = %q{Game Server Services GS2-Stamina 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_dependency "gs2-ruby-sdk-auth", "~> 0.0.1"
+  
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/gs2/stamina/Client.rb

@@ -0,0 +1,292 @@
+require 'gs2/core/AbstractClient.rb'
+
+module Gs2 module Stamina
+  
+  # GS2-Stamina クライアント
+  #
+  # @author Game Server Services, Inc.
+  class Client < Gs2::Core::AbstractClient
+  
+    @@ENDPOINT = 'stamina'
+  
+    # コンストラクタ
+    # 
+    # @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]
+    #       * staminaPoolId => スタミナプールID
+    #       * ownerId => オーナーID
+    #       * name => スタミナプール名
+    #       * description => 説明文
+    #       * serviceClass => サービスクラス
+    #       * increaseInterval => スタミナの更新速度
+    #       * createAt => 作成日時
+    #   * nextPageToken => 次ページトークン
+    def describe_stamina_pool(pageToken = nil, limit = nil)
+      query = {}
+      if pageToken; query['pageToken'] = pageToken; end
+      if limit; query['limit'] = limit; end
+      return get(
+            'Gs2Stamina', 
+            'DescribeStaminaPool', 
+            @@ENDPOINT, 
+            '/staminaPool',
+            query);
+    end
+    
+    # スタミナプールを作成<br>
+    # <br>
+    # GS2-Staminaを利用するには、まずスタミナプールを作成する必要があります。<br>
+    # スタミナプールには複数のユーザのスタミナ値を格納することができます。<br>
+    # <br>
+    # スタミナプールの設定として、スタミナ値の回復速度を秒単位で指定できます。<br>
+    # この設定値を利用して、スタミナ値の回復処理を行いつつユーザごとに最新のスタミナ値を取得することができます。<br>
+    # 
+    # @param request [Array]
+    #   * name => スタミナプール名
+    #   * description => 説明文
+    #   * serviceClass => サービスクラス
+    #   * increaseInterval => スタミナの更新速度
+    # @return [Array]
+    #   * item
+    #     * staminaPoolId => スタミナプールID
+    #     * ownerId => オーナーID
+    #     * name => スタミナプール名
+    #     * description => 説明文
+    #     * serviceClass => サービスクラス
+    #     * increaseInterval => スタミナの更新速度
+    #     * createAt => 作成日時
+    def create_stamina_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
+      if request.has_key?('serviceClass'); body['serviceClass'] = request['serviceClass']; end
+      if request.has_key?('increaseInterval'); body['increaseInterval'] = request['increaseInterval']; end
+      query = {}
+      return post(
+            'Gs2Stamina', 
+            'CreateStaminaPool', 
+            @@ENDPOINT, 
+            '/staminaPool',
+            body,
+            query);
+    end
+  
+    # サービスクラスリストを取得
+    # 
+    # @return [Array] サービスクラス
+    def describeServiceClass()
+      query = {}
+      result = get(
+          'Gs2Stamina',
+          'DescribeServiceClass',
+          @@ENDPOINT,
+          '/staminaPool/serviceClass',
+          query);
+      return result['items'];
+    end
+    
+    # スタミナプールを取得
+    # 
+    # @param request [Array]
+    #   * staminaPoolName => スタミナプール名
+    # @return [Array]
+    #   * item
+    #     * staminaPoolId => スタミナプールID
+    #     * ownerId => オーナーID
+    #     * name => スタミナプール名
+    #     * description => 説明文
+    #     * serviceClass => サービスクラス
+    #     * increaseInterval => スタミナの更新速度
+    #     * createAt => 作成日時
+    def get_stamina_pool(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('staminaPoolName'); raise ArgumentError.new(); end
+      if not request['staminaPoolName']; raise ArgumentError.new(); end
+      query = {}
+      return get(
+          'Gs2Stamina',
+          'GetStaminaPool',
+          @@ENDPOINT,
+          '/staminaPool/' + request['staminaPoolName'],
+          query);
+    end
+  
+    # スタミナプールの状態を取得
+    # 
+    # @param request [Array]
+    #   * staminaPoolName => スタミナプール名
+    # @return [Array]
+    #   * status => 状態
+    def get_stamina_pool_status(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('staminaPoolName'); raise ArgumentError.new(); end
+      if not request['staminaPoolName']; raise ArgumentError.new(); end
+      query = {}
+      return get(
+          'Gs2Stamina',
+          'GetStaminaPoolStatus',
+          @@ENDPOINT,
+          '/staminaPool/' + request['staminaPoolName'] + '/status',
+          query);
+    end
+    
+    # スタミナプールを更新
+    # 
+    # @param request [Array]
+    #   * staminaPoolName => スタミナプール名
+    #   * description => 説明文
+    #   * serviceClass => サービスクラス
+    #   * increaseInterval => スタミナの更新速度
+    # @return [Array]
+    #   * item
+    #     * staminaPoolId => スタミナプールID
+    #     * ownerId => オーナーID
+    #     * name => スタミナプール名
+    #     * description => 説明文
+    #     * serviceClass => サービスクラス
+    #     * increaseInterval => スタミナの更新速度
+    #     * createAt => 作成日時
+    def update_stamina_pool(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('staminaPoolName'); raise ArgumentError.new(); end
+      if not request['staminaPoolName']; raise ArgumentError.new(); end
+      body = {}
+      if request.has_key?('description'); body['description'] = request['description']; end
+      if request.has_key?('serviceClass'); body['serviceClass'] = request['serviceClass']; end
+      if request.has_key?('increaseInterval'); body['increaseInterval'] = request['increaseInterval']; end
+      query = {}
+      return put(
+          'Gs2Stamina',
+          'UpdateStaminaPool',
+          @@ENDPOINT,
+          '/staminaPool/' + request['staminaPoolName'],
+          body,
+          query);
+    end
+    
+    # スタミナプールを削除
+    # 
+    # @param request [Array]
+    #   * staminaPoolName => スタミナプール名
+    def delete_stamina_pool(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('staminaPoolName'); raise ArgumentError.new(); end
+      if not request['staminaPoolName']; raise ArgumentError.new(); end
+      query = {}
+      return delete(
+            'Gs2Stamina', 
+            'DeleteStaminaPool', 
+            @@ENDPOINT, 
+            '/staminaPool/' + request['staminaPoolName'],
+            query);
+    end
+  
+    # スタミナ値を取得<br>
+    # <br>
+    # 指定したユーザの最新のスタミナ値を取得します。<br>
+    # 回復処理などが行われた状態の値が応答されますので、そのままゲームで利用いただけます。<br>
+    # <br>
+    # accessToken には {http://static.docs.gs2.io/ruby/auth/Gs2/Auth/Client.html#login-instance_method Gs2::Auth::Client::login()} でログインして取得したアクセストークンを指定してください。<br>
+    # 
+    # @param request [Array]
+    #   * staminaPoolName => スタミナプール名
+    #   * maxValue => スタミナ値の最大値
+    #   * accessToken => アクセストークン
+    # @return [Array]
+    #   * item
+    #     * userId => ユーザID
+    #     * value => スタミナ値
+    #     * overflow => 最大値を超えているスタミナ値
+    #     * lastUpdateAt => 更新日時
+    #   * nextIncreaseTimestamp => 次回スタミナ値が回復するタイムスタンプ(unixepoch)
+    def get_stamina(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('staminaPoolName'); raise ArgumentError.new(); end
+      if not request['staminaPoolName']; raise ArgumentError.new(); end
+      if not request.has_key?('accessToken'); raise ArgumentError.new(); end
+      if not request['accessToken']; raise ArgumentError.new(); end
+      query = {}
+      if request.has_key?('maxValue'); query['maxValue'] = request['maxValue']; end
+      header = {
+        'X-GS2-ACCESS-TOKEN' => request['accessToken']
+      }
+      return get(
+          'Gs2Stamina',
+          'GetStamina',
+          @@ENDPOINT,
+          '/staminaPool/' + request['staminaPoolName'] + '/stamina',
+          query,
+          header);
+    end
+  
+    # スタミナ値を増減させる<br>
+    # <br>
+    # 同一ユーザに対するスタミナ値の増減処理が衝突した場合は、後でリクエストを出した側の処理が失敗します。<br>
+    # そのため、同時に複数のデバイスを利用してゲームを遊んでいる際に、一斉にクエストを開始することで1回分のスタミナ消費で2回ゲームが遊べてしまう。<br>
+    # というような不正行為を防ぐことが出来るようになっています。<br>
+    # <br>
+    # クエストに失敗した時に消費したスタミナ値を戻してあげる際や、スタミナ値の回復アイテムを利用した際などに<br>
+    # スタミナ値を増やす操作を行うことになりますが、その際に overflow に true を指定することで、スタミナ値の最大値を超える回復を行えます。<br>
+    # スタミナ値の上限を超えた部分は overflow フィールドに格納され、優先してそちらが消費されます。<br>
+    # <br>
+    # accessToken には {http://static.docs.gs2.io/ruby/auth/Gs2/Auth/Client.html#login-instance_method Gs2::Auth::Client::login()} でログインして取得したアクセストークンを指定してください。<br>
+    # 
+    # @param request [Array]
+    #   * staminaPoolName => スタミナプール名
+    #   * variation => スタミナ値の増減量
+    #   * maxValue => スタミナ値の最大値
+    #   * overflow => スタミナ値の最大値を超えることを許容するか
+    #   * accessToken => アクセストークン
+    # @return [Array]
+    #   * item
+    #     * userId => ユーザID
+    #     * value => スタミナ値
+    #     * overflow => 最大値を超えているスタミナ値
+    #     * lastUpdateAt => 更新日時
+    def change_stamina(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('staminaPoolName'); raise ArgumentError.new(); end
+      if not request['staminaPoolName']; raise ArgumentError.new(); end
+      if not request.has_key?('accessToken'); raise ArgumentError.new(); end
+      if not request['accessToken']; raise ArgumentError.new(); end
+      body = {}
+      if request.has_key?('variation'); body['variation'] = request['variation']; end
+      if request.has_key?('maxValue'); body['maxValue'] = request['maxValue']; end
+      if request.has_key?('overflow'); body['overflow'] = request['overflow']; end
+      query = {}
+      header = {
+        'X-GS2-ACCESS-TOKEN' => request['accessToken']
+      }
+      return post(
+          'Gs2Stamina', 
+          'ChangeStamina', 
+          @@ENDPOINT, 
+          '/staminaPool/' + request['staminaPoolName'] + '/stamina',
+          body,
+          query,
+          header);
+    end
+  end
+end end

data/lib/gs2/stamina/version.rb

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

data/lib/gs2-stamina.rb

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

metadata

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