gs2-ruby-sdk-timer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be3b68fdf3a5bc13e30ae222bb3d27a391d22ead
+  data.tar.gz: 8f7275f88464b1dcc35a4a172729c65b4da13a3b
+SHA512:
+  metadata.gz: 74ede709e1bddb074091f3aeeb0946f83a7f69e1a892331868f235a4aa22bb920a0cf77f67f5f0c9c6162bb8991ca7cb6986663244b922d6fe8cb71c0e6d1f5f
+  data.tar.gz: 32499ee842a5e0964e6fa55bc964e219b29d574df25a466a65a07b778af1a256d7a6251c8fd9b3bc173e48e1bee041bd69f888b9f30f9bb5e44971f620e69504

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,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.project

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>gs2-sdk-for-ruby-timer</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-timer
+===============

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

@@ -0,0 +1,274 @@
+require 'gs2/core/AbstractClient.rb'
+
+module Gs2 module Timer
+  
+  # GS2-Timer クライアント
+  #
+  # @author Game Server Services, Inc.
+  class Client < Gs2::Core::AbstractClient
+  
+    @@ENDPOINT = 'timer'
+  
+    # コンストラクタ
+    # 
+    # @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]
+    #      * timerPoolId => タイマープールID
+    #      * ownerId => オーナーID
+    #      * name => タイマープール名
+    #      * description => 説明文
+    #      * createAt => 作成日時
+    #  * nextPageToken => 次ページトークン
+    def describe_timer_pool(pageToken = nil, limit = nil)
+      query = {}
+      if pageToken; query['pageToken'] = pageToken end
+      if limit; query['limit'] = limit end
+      return get(
+        'Gs2Timer', 
+        'DescribeTimerPool',
+        @@ENDPOINT,
+        '/timerPool',
+        query)
+    end
+ 
+    # タイマープールを作成。<br>
+    # <br>
+    # GS2-Timer を利用するには、まずタイマープールを作成する必要があります。<br>
+    # タイマープールには複数のタイマーを格納することができます。<br>
+    # 
+    # @param request [Array]
+    #  * name => タイマープール名
+    #  * description => 説明文
+    # @return [Array]
+    #  * item
+    #    * timerPoolId => タイマープールID
+    #    * ownerId => オーナーID
+    #    * name => タイマープール名
+    #    * description => 説明文
+    #    * createAt => 作成日時
+    def create_timer_pool(request)
+      body = {}
+      if not request; raise ArgumentError.new() end
+      if request.has_key?('name'); body['name'] = request['name'] end
+      if request.has_key?('description'); body['description'] = request['description'] end
+      return post(
+        'Gs2Timer', 
+        'CreateTimerPool',
+        @@ENDPOINT,
+        '/timerPool',
+        body)
+    end
+
+    # タイマープールを更新。<br>
+    # 
+    # @param request [Array]
+    #  * timerPoolName => タイマープール名
+    #  * description => 説明文
+    # @return [Array]
+    #  * item
+    #    * timerPoolId => タイマープールID
+    #    * ownerId => オーナーID
+    #    * name => タイマープール名
+    #    * description => 説明文
+    #    * createAt => 作成日時
+    def update_timer_pool(request)
+      body = {}
+      if not request; raise ArgumentError.new() end
+      if not request.has_key?('timerPoolName'); raise ArgumentError.new() end
+      if request.has_key?('description'); body['description'] = request['description'] end
+      return put(
+        'Gs2Timer', 
+        'UpdateTimerPool',
+        @@ENDPOINT,
+        '/timerPool/' + request['timerPoolName'],
+        body)
+    end
+ 
+    # タイマープールを取得
+    # 
+    # @param request [Array]
+    #  * timerPoolName => タイマープール名
+    # @return [Array]
+    #  * item
+    #   * timerPoolId => タイマープールID
+    #   * ownerId => オーナーID
+    #   * name => タイマープール名
+    #   * description => 説明文
+    #   * createAt => 作成日時
+    def get_timer_pool(request)
+      if not request; raise ArgumentError.new() end
+      if not request.has_key?('timerPoolName'); raise ArgumentError.new() end
+      if request['timerPoolName'] == nil; raise ArgumentError.new() end
+      return get(
+        'Gs2Timer', 
+        'GetTimerPool',
+        @@ENDPOINT,
+        '/timerPool/' + request['timerPoolName'])
+    end
+ 
+    # タイマープールを削除
+    # 
+    # @param request [Array]
+    #  * timerPoolName => タイマープール名
+    def delete_timer_pool(request)
+      if not request; raise ArgumentError.new() end
+      if not request.has_key?('timerPoolName'); raise ArgumentError.new() end
+      if request['timerPoolName'] == nil; raise ArgumentError.new() end
+      return delete(
+        'Gs2Timer', 
+        'DeleteTimerPool',
+        @@ENDPOINT,
+        '/timerPool/' + request['timerPoolName'])
+    end
+ 
+    # タイマーリストを取得
+    # 
+    # @param request [Array]
+    # * timerPoolName => タイマープール名
+    # @param string $pageToken ページトークン
+    # @param integer $limit 取得件数
+    # @return [Array]
+    #  * items
+    #    [Array]
+    #      * timerId => タイマーID
+    #      * timerPoolId => タイマープールID
+    #      * ownerId => オーナーID
+    #      * callbackMethod => HTTPメソッド
+    #      * callbackUrl => コールバックURL
+    #      * callbackBody => コールバックボディ
+    #      * executeTime => 実行時間
+    #      * retryMax => 最大リトライ回数
+    #      * createAt => 作成日時
+    #  * nextPageToken => 次ページトークン
+    def describe_timer(request, pageToken = nil, limit = nil)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('timerPoolName'); raise ArgumentError.new(); end
+      if request['timerPoolName'] == nil; raise ArgumentError.new(); end
+      query = {}
+      if pageToken; query['pageToken'] = pageToken; end
+      if limit; query['limit'] = limit; end
+      return get(
+        'Gs2Timer', 
+        'DescribeTimer', 
+        @@ENDPOINT,
+        '/timerPool/' + request['timerPoolName'] + '/timer',
+        query)
+    end
+ 
+    # タイマーを作成<br>
+    # <br>
+    # タイマーを作成すると、指定した時刻に指定したURLに指定したパラメータを持ったアクセスを発生させます。<br>
+    # 基本的には指定した時刻以降に60秒以内に呼び出し処理が開始されます。<br>
+    # 混雑時には60秒以上かかることがありますので、タイミングがシビアな処理には向きません。<br>
+    # <br>
+    # アカウントBANを指定した時刻付近で解除する。など、タイミングがシビアでない処理で利用することをおすすめします。<br>
+    # 
+    # @param request [Array]
+    #  * callbackMethod => HTTPメソッド
+    #  * callbackUrl => コールバックURL
+    #  * callbackBody => コールバックボディ
+    #  * executeTime => 実行時間
+    #  * retryMax => 最大リトライ回数(OPTIONAL)
+    # @return [Array]
+    #  * item
+    #   * timerId => タイマーID
+    #   * timerPoolId => タイマープールID
+    #   * ownerId => オーナーID
+    #   * callbackMethod => HTTPメソッド
+    #   * callbackUrl => コールバックURL
+    #   * callbackBody => コールバックボディ
+    #   * executeTime => 実行時間
+    #   * retryMax => 最大リトライ回数
+    #   * createAt => 作成日時
+    def create_timer(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('timerPoolName'); raise ArgumentError.new(); end
+      if request['timerPoolName'] == nil; raise ArgumentError.new(); end
+      body = {};
+      if request.has_key?('callbackMethod'); body['callbackMethod'] = request['callbackMethod']; end
+      if request.has_key?('callbackUrl'); body['callbackUrl'] = request['callbackUrl']; end
+      if request.has_key?('executeTime'); body['executeTime'] = request['executeTime']; end
+      if request.has_key?('retryMax'); body['retryMax'] = request['retryMax']; end
+      query = {}
+      return post(
+        'Gs2Timer', 
+        'CreateTimer', 
+        @@ENDPOINT,
+        '/timerPool/' + request['timerPoolName'] + '/timer',
+        body,
+        query)
+    end
+ 
+    # タイマーを取得
+    # 
+    # @param request [Array]
+    # * timerPoolName => タイマープール名
+    # * timerId => タイマーID
+    # @return [Array]
+    #  * item
+    #   * timerId => タイマーID
+    #   * timerPoolId => タイマープールID
+    #   * ownerId => オーナーID
+    #   * callbackMethod => HTTPメソッド
+    #   * callbackUrl => コールバックURL
+    #   * callbackBody => コールバックボディ
+    #   * executeTime => 実行時間
+    #   * retryMax => 最大リトライ回数
+    #   * createAt => 作成日時
+    def get_timer(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('timerPoolName'); raise ArgumentError.new(); end
+      if request['timerPoolName'] == nil; raise ArgumentError.new(); end
+      if not request.has_key?('timerId'); raise ArgumentError.new(); end
+      if request['timerId'] == nil; raise ArgumentError.new(); end
+      query = {}
+      return get(
+        'Gs2Timer',
+        'GetTimer',
+        @@ENDPOINT,
+        '/timerPool/' + request['timerPoolName'] + '/timer/' + request['timerId'],
+        query)
+    end
+ 
+    # タイマーを削除
+    # 
+    # @param request [Array]
+    #  * timerPoolName => タイマープール名
+    #  * timerId => タイマーID
+    def delete_timer(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('timerPoolName'); raise ArgumentError.new(); end
+      if request['timerPoolName'] == nil; raise ArgumentError.new(); end
+      if not request.has_key?('timerId'); raise ArgumentError.new(); end
+      if request['timerId'] == nil; raise ArgumentError.new(); end
+      query = {}
+      return delete(
+        'Gs2Timer', 
+        'DeleteTimer', 
+        @@ENDPOINT,
+        '/timerPool/' + request['timerPoolName'] + '/timer/' + request['timerId'],
+        query)
+    end
+  end
+end end

data/lib/gs2/timer/version.rb

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

data/lib/gs2-timer.rb

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

metadata

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