gs2-ruby-sdk-identifier 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70c3bab2ee79ef960ef92c2a626428932b628eb4
+  data.tar.gz: ab370ea8bfd1bd7032e252e45a80aad0de8f7fa4
+SHA512:
+  metadata.gz: 26c8d0d4b5c01079e1081775ec93343f5d9dec9da62e4a6a7d4614e6647c30e439d500a28629ad6b676a96998300b3336be6f42f7e19d18e16b2ec841bcba670
+  data.tar.gz: 6d80508d5461327fa60a6304ff238ca07519edebe84661203926f9518b4e315a894ef2db9737e4ee10dacbdaa67cc65b2b4a0ecb6ca0dc634d8708a60bdf1e5f

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

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

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

data/lib/gs2/identifier/Client.rb

@@ -0,0 +1,418 @@
+require 'gs2/core/AbstractClient.rb'
+
+module Gs2 module Identifier
+  
+  # GS2-Identifier クライアント
+  #
+  # @author Game Server Services, Inc.
+  class Client < Gs2::Core::AbstractClient
+  
+    @@ENDPOINT = 'identifier'
+  
+    # コンストラクタ
+    # 
+    # @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]
+    #      * userId => ユーザID
+    #      * ownerId => オーナーID
+    #      * name => ユーザ名
+    #      * createAt => 作成日時
+    #  * nextPageToken => 次ページトークン
+    def describe_user(pageToken = nil, limit = nil)
+      query = {}
+      if pageToken; query['pageToken'] = pageToken; end
+      if limit; query['limit'] = limit; end
+      return get(
+            'Gs2Identifier', 
+            'DescribeUser', 
+            @@ENDPOINT, 
+            '/user',
+            query);
+    end
+
+    # ユーザを作成<br>
+    # <br>
+    # GS2のサービスを利用するにはユーザを作成する必要があります。<br>
+    # ユーザを作成後、ユーザに対して権限設定を行い、ユーザに対応したGSI(クライアントID/シークレット)を発行することでAPIが利用できるようになります。<br>
+    # 
+    # @param request [Array]
+    #   * name => ユーザ名
+    # @return [Array]
+    #   * item
+    #     * userId => ユーザID
+    #     * ownerId => オーナーID
+    #     * name => ユーザ名
+    #     * createAt => 作成日時
+    def create_user(request)
+      if not request; raise ArgumentError.new(); end
+      body = {}
+      if request.has_key?('name'); body['name'] = request['name']; end
+      query = {}
+      return post(
+            'Gs2Identifier', 
+            'CreateUser', 
+            @@ENDPOINT, 
+            '/user',
+            body,
+            query);
+    end
+
+    # ユーザを取得
+    #
+    # @param request [Array]
+    #   * userName => ユーザ名
+    # @return [Array]
+    #   * item
+    #     * userId => ユーザID
+    #     * ownerId => オーナーID
+    #     * name => ユーザ名
+    #     * createAt => 作成日時
+    def get_user(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('userName'); raise ArgumentError.new(); end
+      query = {}
+      return get(
+          'Gs2Identifier',
+          'GetUser',
+          @@ENDPOINT,
+          '/user/' + request['userName'],
+          query);
+    end
+
+    # ユーザを削除
+    # 
+    # @param request [Array]
+    #   * userName => ユーザ名
+    def delete_user(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('userName'); raise ArgumentError.new(); end
+      if not request['userName']; raise ArgumentError.new(); end
+      query = {}
+      return delete(
+            'Gs2Identifier', 
+            'DeleteUser', 
+            @@ENDPOINT, 
+            '/user/' + request['userName'],
+            query);
+    end
+
+    # GSIリストを取得
+    # 
+    # @param request [Array]
+    #   * userName => ユーザ名
+    # @param pageToken [String] ページトークン
+    # @param limit [Integer] 取得件数
+    # @return [Array]
+    #   * items
+    #     [Array]
+    #       * identifierId => GSIID
+    #       * ownerId => オーナーID
+    #       * clientId => クライアントID
+    #       * createAt => 作成日時
+    #   * nextPageToken => 次ページトークン
+    def describe_identifier(request, pageToken = nil, limit = nil)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('userName'); raise ArgumentError.new(); end
+      if not request['userName']; raise ArgumentError.new(); end
+      query = {}
+      if pageToken; query['pageToken'] = pageToken; end
+      if limit; query['limit'] = limit; end
+      return get(
+          'Gs2Identifier',
+          'DescribeIdentifier',
+          @@ENDPOINT,
+          '/user/' + request['userName'] + '/identifier',
+          query);
+    end
+
+    # GSIを作成<br>
+    # <br>
+    # GSIはSDKなどでAPIを利用する際に必要となる クライアントID/シークレット です。<br>
+    # AWSでいうIAMのクレデンシャルに相当します。<br>
+    # 
+    # @param request [Array]
+    #   * userName => ユーザ名
+    # @return [Array]
+    #   * item
+    #     * identifierId => GSIID
+    #     * ownerId => オーナーID
+    #     * clientId => クライアントID
+    #     * clientSecret => クライアントシークレット
+    #     * createAt => 作成日時
+    def create_identifier(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('userName'); raise ArgumentError.new(); end
+      if not request['userName']; raise ArgumentError.new(); end
+      body = {}
+      query = {}
+      return post(
+          'Gs2Identifier',
+          'CreateIdentifier',
+          @@ENDPOINT,
+          '/user/' + request['userName'] + '/identifier',
+          body,
+          query);
+    end
+
+    # GSIを削除
+    # 
+    # @param request [Array]
+    #   * userName => ユーザ名
+    #   * identifierId => GSI ID
+    def delete_identifier(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('userName'); raise ArgumentError.new(); end
+      if not request['userName']; raise ArgumentError.new(); end
+      if not request.has_key?('identifierId'); raise ArgumentError.new(); end
+      if not request['identifierId']; raise ArgumentError.new(); end
+      query = {}
+      return delete(
+          'Gs2Identifier',
+          'DeleteIdentifier',
+          @@ENDPOINT,
+          '/user/' + request['userName'] + '/identifier/' + request['identifierId'],
+          query);
+    end
+
+    # ユーザが保持しているセキュリティポリシー一覧を取得
+    #
+    # @param request [Array]
+    #   * userName => ユーザ名
+    # @return [Array]
+    #   * items
+    #     [Array]
+    #       * identifierId => GSIID
+    #       * ownerId => オーナーID
+    #       * clientId => クライアントID
+    #       * createAt => 作成日時
+    def get_has_security_policy(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('userName'); raise ArgumentError.new(); end
+      if not request['userName']; raise ArgumentError.new(); end
+      query = {}
+      return get(
+          'Gs2Identifier',
+          'HasSecurityPolicy',
+          @@ENDPOINT,
+          '/user/' + request['userName'] + '/securityPolicy',
+          query);
+    end
+
+    # ユーザにセキュリティポリシーを割り当てる
+    #
+    # @param request [Array]
+    #   * userName => ユーザ名
+    #   * securityPolicyId => セキュリティポリシーID
+    def attach_security_policy(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('userName'); raise ArgumentError.new(); end
+      if not request['userName']; raise ArgumentError.new(); end
+      body = {}
+      if request.has_key?('securityPolicyId'); body['securityPolicyId'] = request['securityPolicyId']; end
+      query = {}
+      return put(
+          'Gs2Identifier',
+          'AttachSecurityPolicy',
+          @@ENDPOINT,
+          '/user/' + request['userName'] + '/securityPolicy',
+          body);
+    end
+
+    # ユーザに割り当てられたセキュリティポリシーを解除
+    #
+    # @param request [Array]
+    #   * userName => ユーザ名
+    #   * securityPolicyId => セキュリティポリシーID
+    def detach_security_policy(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('userName'); raise ArgumentError.new(); end
+      if not request['userName']; raise ArgumentError.new(); end
+      if not request.has_key?('securityPolicyId'); raise ArgumentError.new(); end
+      if not request['securityPolicyId']; raise ArgumentError.new(); end
+      query = {}
+      return delete(
+          'Gs2Identifier',
+          'DetachSecurityPolicy',
+          @@ENDPOINT,
+          '/user/' + request['userName'] + '/securityPolicy/' + request['securityPolicyId'],
+          query);
+    end
+
+    # セキュリティポリシーリストを取得
+    #
+    # @param pageToken [String] ページトークン
+    # @param limit [Integer] 取得件数
+    # @return [Array]
+    #   * items
+    #     [Array]
+    #       * securityPolicyId => セキュリティポリシーID
+    #        * ownerId => オーナーID
+    #       * name => セキュリティポリシー名
+    #        * policy => ポリシー
+    #        * createAt => 作成日時
+    #       * updateAt => 更新日時
+    #   * nextPageToken => 次ページトークン
+    def describe_security_policy(pageToken = nil, limit = nil)
+      query = {}
+      if pageToken; query['pageToken'] = pageToken; end
+      if limit; query['limit'] = limit; end
+      return get(
+          'Gs2Identifier',
+          'DescribeSecurityPolicy',
+          @@ENDPOINT,
+          '/securityPolicy',
+          query);
+    end
+
+    # 共用セキュリティポリシーリストを取得
+    #
+    # @param pageToken [String] ページトークン
+    # @param limit [Integer] 取得件数
+    # @return [Array]
+    #   * items
+    #     [Array]
+    #       * securityPolicyId => セキュリティポリシーID
+    #       * ownerId => オーナーID
+    #       * name => セキュリティポリシー名
+    #       * policy => ポリシー
+    #       * createAt => 作成日時
+    #       * updateAt => 更新日時
+    #   * nextPageToken => 次ページトークン
+    def describe_common_security_policy(pageToken = nil, limit = nil)
+      query = {}
+      if pageToken; query['pageToken'] = pageToken; end
+      if limit; query['limit'] = limit; end
+      return get(
+          'Gs2Identifier',
+          'DescribeSecurityPolicy',
+          @@ENDPOINT,
+          '/securityPolicy/common',
+          query);
+    end
+  
+    # セキュリティポリシーを作成<br>
+    # <br>
+    # セキュリティポリシーはユーザの権限を定義したものです。<br>
+    # AWSのIAMポリシーに似せて設計されていますが、いくつかAWSのIAMポリシーと比較して劣る点があります。<br>
+    # 2016/9 時点では以下の様な点が IAMポリシー とは異なります。<br>
+    # 
+    # * リソースに対するアクセス制御はできません。
+    # * アクションのワイルドカードは最後に1箇所のみ利用できます。
+    #
+    # @param array request
+    #  * name => セキュリティポリシー名
+    #  * policy => ポリシー
+    # @return array
+    #  * item
+    #    * securityPolicyId => セキュリティポリシーID
+    #    * ownerId => オーナーID
+    #    * name => セキュリティポリシー名
+    #    * policy => ポリシー
+    #    * createAt => 作成日時
+    #    * updateAt => 更新日時
+    def create_security_policy(request)
+      if not request; raise ArgumentError.new(); end
+      body = {}
+      if request.has_key?('name'); body['name'] = request['name']; end
+      if request.has_key?('policy'); body['policy'] = request['policy']; end
+      query = {}
+      return post(
+          'Gs2Identifier',
+          'CreateSecurityPolicy',
+          @@ENDPOINT,
+          '/securityPolicy',
+          body,
+          query);
+    end
+    
+    # セキュリティポリシーを取得
+    #
+    # @param request [Array]
+    #   * securityPolicyName => セキュリティポリシー名
+    # @return [Array]
+    #   * item
+    #     * securityPolicyId => セキュリティポリシーID
+    #     * ownerId => オーナーID
+    #     * name => セキュリティポリシー名
+    #     * policy => ポリシー
+    #     * createAt => 作成日時
+    #     * updateAt => 更新日時
+    def get_security_policy(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('securityPolicyName'); raise ArgumentError.new(); end
+      query = {}
+      return get(
+          'Gs2Identifier',
+          'GetSecurityPolicy',
+          @@ENDPOINT,
+          '/securityPolicy/' + request['securityPolicyName'],
+          query);
+    end
+    
+    # セキュリティポリシーを更新
+    #
+    # @param request [Array]
+    #   * securityPolicyName => セキュリティポリシー名
+    # @return [Array]
+    #   * item
+    #     * securityPolicyId => セキュリティポリシーID
+    #     * ownerId => オーナーID
+    #     * name => セキュリティポリシー名
+    #     * policy => ポリシー
+    #     * createAt => 作成日時
+    #     * updateAt => 更新日時
+    def update_security_policy(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('securityPolicyName'); raise ArgumentError.new(); end
+      if not request['securityPolicyName']; raise ArgumentError.new(); end
+      body = {}
+      if request.has_key?('policy'); body['policy'] = request['policy']; end
+      query = {}
+      return put(
+          'Gs2Identifier',
+          'UpdateSecurityPolicy',
+          @@ENDPOINT,
+          '/securityPolicy/' + request['securityPolicyName'],
+          body,
+          query);
+    end
+    
+    # セキュリティポリシーを削除
+    #
+    # @param request [Array]
+    #   * securityPolicyName => セキュリティポリシー名
+    def delete_security_policy(request)
+      if not request; raise ArgumentError.new(); end
+      if not request.has_key?('securityPolicyName'); raise ArgumentError.new(); end
+      if not request['securityPolicyName']; raise ArgumentError.new(); end
+      query = {}
+      return delete(
+          'Gs2Identifier',
+          'DeleteSecurityPolicy',
+          @@ENDPOINT,
+          '/securityPolicy/' + request['securityPolicyName'],
+          query);
+    end
+  end
+end end

data/lib/gs2/identifier/version.rb

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

metadata

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