libgss 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjBlOTY0MzIyNTBkNDMzY2ExMGE5NDk2YzQzOTg2NWExNmJhOWQ0Yg==
+  data.tar.gz: !binary |-
+    M2IyMzllMWM1ZWMyY2M3ZGFmOTA2MTJhNWQzNWNlNGE1ODJhOTMwYQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    Y2M1YWZkNmQ2NTk0NzMwOWRlY2U3NGMwYjE5MDNkZTVkNWM3Yjg5ZWVlZjli
+    MmU2OTU4MDFiMDZhNzc3OGUwZWU2MzIyNGYxMTZhMTA5Njk3NzQ5NmFiNjU5
+    MTdmNDJiNDdkYjhjOGNkMmExNWRlOTA4MTNkMTBiM2RjYTg5ZGU=
+  data.tar.gz: !binary |-
+    MTU1OWRkNmMyODk4OWRjNDRlYmM3OTVjYmEzNzVjYTVhNGU1Y2FkNDc4NDYw
+    NjhhYmYzMGM1YmMxMWU1M2ZkMzJjNzA1ZDIyMjM2NTMyNzRiMjcxN2M0OTBj
+    ZDRlMDdkZjFkNmVjZDcyNDNiMzEwODMwZDU1ZmIyYTY3MjY2ZTY=

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in libgss.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    libgss (0.0.1)
+      httpclient
+      json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.3)
+    httpclient (2.3.3)
+    json (1.7.7)
+    rake (10.0.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  libgss!
+  rake
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 akima
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Libgss
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'libgss'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install libgss
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+ENV['DEFAULT_HTTP_PORT'] ||= '3000'
+ENV['DEFAULT_HTTPS_PORT'] ||= '3001'

data/lib/libgss/action.rb

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+require 'libgss'
+
+module Libgss
+
+  class Action
+
+    attr_accessor :id
+
+    def initialize(id, args)
+      @id = id
+      @args = args
+    end
+
+    def with(new_id)
+      @id = new_id
+      self
+    end
+
+    def to_hash
+      {"id" => id}.update(@args)
+    end
+
+  end
+end

data/lib/libgss/action_request.rb

@@ -0,0 +1,302 @@
+# -*- coding: utf-8 -*-
+require 'libgss'
+
+require 'net/http'
+require 'uri'
+
+module Libgss
+
+  class ActionRequest
+
+    STATUS_PREPARING = 0
+    STATUS_SENDING   = 1
+    STATUS_WAITING   = 2
+    STATUS_RECEIVED  = 3
+    STATUS_SUCCESS   = 4
+    STATUS_ERROR     = 5
+    STATUS_TIMEOUT   = 6
+
+
+    # 読み込みのみ、書き込み不可
+    attr_reader :action_url
+    attr_reader :status, :outputs
+
+    # コンストラクタ
+    def initialize(httpclient, action_url)
+      @httpclient = httpclient
+      @action_url = action_url
+      @status = STATUS_PREPARING
+      @actions = []
+      @action_id = 0;
+    end
+
+    def next_action_id
+      @action_id += 1
+    end
+
+    def add_action(hash)
+      action = Action.new(next_action_id, hash)
+      @actions << action
+      action
+    end
+
+    # アクション群を実行するために実際にHTTPリクエストを送信します。
+    def send_request(&callback)
+      res = @httpclient.post(action_url, {"inputs" => @actions.map(&:to_hash)}.to_json)
+      r = JSON.parse(res.body)
+      # puts res.body
+      @outputs = Outputs.new(r["outputs"])
+      callback.call(@outputs) if callback
+    end
+
+    # 条件に該当するデータを取得
+    # @param [String] name 対象となるコレクション名
+    # @param [Hash] conditions 検索条件
+    # @param [Array<Array<String, Integer>>] order フィールド名と(1 or -1)の組み合わせの配列
+    # @return [Array<Libgss::JsonObject>]該当したデータを表すJSONオブジェクトの配列
+    def find_all(name, conditions = nil, order = nil)
+      args =  {action: "all", name: name}
+      args[:conditions] = conditions if conditions
+      args[:order] = order if order
+      add_action(args)
+    end
+
+    # ページネーション付きで条件に該当するデータを取得
+    # @param [String] name 対象となるコレクション名
+    # @param [String] page 取得するページ
+    # @param [String] per_page 1ページあたりの件数
+    # @param [Hash] conditions 検索条件
+    # @param [Array<Array<String, Integer>>] order フィールド名と(1 or -1)の組み合わせの配列
+    # @return [Array<Libgss::JsonObject>]該当したデータを表すJSONオブジェクトの配列
+    def paginate(name, page, per_page, conditions = nil, order = nil)
+      args =  {action: "all", name: name, page: page, per_page: per_page}
+      args[:conditions] = conditions if conditions
+      args[:order] = order if order
+      add_action(args)
+    end
+
+    # 条件に該当するデータを取得
+    # @param [String] name 対象となるコレクション名
+    # @param [Hash] conditions 検索条件
+    # @return [Integer] 該当したデータの件数
+    def count(name, conditions = nil)
+      args =  {action: "count", name: name}
+      args[:conditions] = conditions if conditions
+      add_action(args)
+    end
+
+    # 条件に該当するデータを１件だけ取得
+    # @param [String] name 対象となるコレクション名
+    # @param [Hash] conditions 検索条件
+    # @param [Array<Array<String, Integer>>] order フィールド名と(1 or -1)の組み合わせの配列
+    # @return [Libgss::JsonObject] 該当したデータを表すJSONオブジェクト
+    def find_first(name, conditions = nil, order = nil)
+      args =  {action: "first", name: name}
+      args[:conditions] = conditions if conditions
+      args[:order] = order if order
+      add_action(args)
+    end
+
+    # 辞書テーブルからinputに対応するoutputの値を返します。
+    # @param [String] name 対象となる辞書のコレクション名
+    # @param [String] input 入力オブジェクトの文字列表現
+    # @param [Hash] conditions 検索条件
+    # @return [Object] outputの値を示すJSONオブジェクト
+    def get_by_dictionary(name, input, conditions = nil)
+      args = {action: "get", name: name, input: input}
+      args[:conditions] = conditions if conditions
+      add_action(args)
+    end
+
+    # 期間テーブルからinputに対応するoutputの値を返します。
+    # @param [String] name 対象となる機関テーブルのコレクション名
+    # @param [Integer] time 対象となるUNIX時刻
+    # @param [Hash] conditions 検索条件
+    # @return [Object] outputの値を示すJSONオブジェクト
+    def get_by_schedule(name, time = Time.now.to_i, conditions = nil)
+      args = {action: "get", name: name, time: time}
+      args[:conditions] = conditions if conditions
+      add_action(args)
+    end
+
+    # 整数範囲テーブルからinputに対応するoutputの値を返します。
+    # @param [String] name 対象となる整数範囲テーブルのコレクション名
+    # @param [Integer] input 対象となる入力値
+    # @param [Hash] conditions 検索条件
+    # @return [Object] outputの値を示すJSONオブジェクト
+    def get_by_int_range(name, input, conditions = nil)
+      args = {action: "get", name: name, input: input}
+      args[:conditions] = conditions if conditions
+      add_action(args)
+    end
+
+    # 確率テーブルからinputに対応するoutputの値を返します。
+    # diceがあるのであまり使われないはず。
+    #
+    # @param [String] name 対象となる確率テーブルのコレクション名
+    # @param [String] value 対象となるオブジェクトの文字列表現
+    # @param [Hash] conditions 検索条件
+    # @return [Object] valueの値を示すJSONオブジェクト
+    def get_by_probability(name, value, conditions = nil)
+      args = {action: "get", name: name, value: value}
+      args[:conditions] = conditions if conditions
+      add_action(args)
+    end
+
+    # プレイヤーからplayer_idに対応するプレイヤーを返します
+    #
+    # @param [String] name 対象となるコレクション名
+    # @param [String] player_id 対象となるplayer_id
+    # @param [Hash] conditions 検索条件
+    # @return [Object] プレイヤーを表すJSONオブジェクト
+    def get_by_player(name = "Player", player_id = nil)
+      args =  {action: "get"}
+      args[:name] = name if name
+      args[:player_id] = player_id.to_s if player_id
+      add_action(args)
+    end
+
+    # ゲームデータからplayer_idに対応するゲームデータを返します
+    #
+    # @param [String] name 対象となるコレクション名
+    # @param [String] player_id 対象となるplayer_id
+    # @param [Hash] conditions 検索条件
+    # @return [Object] ゲームデータを表すJSONオブジェクト
+    def get_by_game_data(name = "GameData", player_id = nil)
+      args =  {action: "get"}
+      args[:name] = name if name
+      args[:player_id] = player_id.to_s if player_id
+      add_action(args)
+    end
+
+
+
+
+    # ログあるいは履歴を登録します。
+    #
+    # @param [String] name 対象となるコレクション名
+    # @param [Hash] attrs 属性
+    # @return
+    def create(name, attrs)
+      args =  {action: "create", name: name, attrs: attrs}
+      add_action(args)
+    end
+
+    # プレイヤー、ゲームデータを更新します。
+    # @param [String] name 対象となるコレクション名
+    # @param [Hash] player_id 対象を特定するためのID。
+    # @param [Hash] attrs 属性。対象を特定するためのplayer_idを含みません。
+    # @return
+    def update(name, attrs, player_id = nil)
+      args =  {action: "update", name: name, attrs: attrs}
+      args[:player_id] = player_id.to_s if player_id
+      add_action(args)
+    end
+
+
+    # 確率テーブルに従って、発生させた乱数から得られた値
+    # @param [String] name 対象となるコレクション名
+    # @param [Hash] conditions 検索条件
+    # @return [Object] 確率テーブルの値
+    def dice(name, conditions = nil)
+      args = {action: "dice", name: name}
+      args[:conditions] = conditions if conditions
+      add_action(args)
+    end
+
+    # ストアドスクリプトを実行します。
+    # @param [String] name 対象となるコレクション名
+    # @param [Hash] key 対象となるスクリプトのキー
+    # @param [Hash] args スクリプトに渡す引数
+    # @return [Object] ストアドスクリプトの結果
+    def execute(name, key, args = nil)
+      action_args = {action: "execute", name: name, key: key}
+      action_args[:args] = args if args
+      add_action(action_args)
+    end
+
+
+
+    # サーバの現在時刻を返します。
+    # @return [Time] 現在時刻を表すUNIX時刻
+    def server_time()
+      add_action(action: "server_time")
+    end
+
+    # 引数timeに指定された時刻の運用日付を返します。
+    # 「運用日付」とは AppGarden の[ゲーム内日付変更時刻]で
+    # 設定された時刻を日付の開始時刻とした場合の日付(Ruby
+    # ストアドスクリプト内ではDateオブジェクト)を返します。
+    #
+    # @param [Time] time time に指定された時刻(省略時は現在時刻)の運用日付
+    # @return [Date] timeが属する運用日付
+    def server_date(time = nil)
+      args = {action: "server_date"}
+      args[:time] = time if time
+      add_action(args)
+    end
+
+
+
+    # # フレンドシップを更新します。
+    # # @param [String] name 対象となるコレクション名
+    # # @param [Hash] attrs 属性。対象を特定するためのIDを含みます。
+    # # @return
+    # def update_friendship(name, attrs)
+    # end
+
+    # # フレンドシップを削除します。
+    # # @param [String] name 対象となるコレクション名
+    # # @param [Hash] target 対象となるフレンドのID
+    # # @return
+    # def delete_friendship(name, target)
+    # end
+
+    # フレンドシップを申請をします。
+    # @param [String] name 対象となるコレクション名
+    # @param [Hash] target 対象となるフレンドのID
+    # @return
+    def apply(name, target)
+      args = {action: "apply", name: name, target: target}
+      add_action(args)
+    end
+
+    # フレンドシップの申請を承認します。
+    # @param [String] name 対象となるコレクション名
+    # @param [Hash] target 対象となるフレンドのID
+    # @return
+    def approve(name, target)
+      args = {action: "approve", name: name, target: target}
+      add_action(args)
+    end
+
+    # フレンドシップの申請のキャンセル、申請却下、フレンド解除をします。
+    # @param [String] name 対象となるコレクション名
+    # @param [Hash] target 対象となるフレンドのID
+    # @return
+    def breakoff(name, target)
+      args = {action: "breakoff", name: name, target: target}
+      add_action(args)
+    end
+
+    # フレンドをブロック（ブラックリスト追加）します。
+    # @param [String] name 対象となるコレクション名
+    # @param [Hash] target 対象となるフレンドのID
+    # @return
+    def block(name, target)
+      args = {action: "block", name: name, target: target}
+      add_action(args)
+    end
+
+    # フレンドをブロックの解除（ブラックリストから除外）します。
+    # @param [String] name 対象となるコレクション名
+    # @param [Hash] target 対象となるフレンドのID
+    # @return
+    def unblock(name, target)
+      args = {action: "unblock", name: name, target: target}
+      add_action(args)
+    end
+
+  end
+
+end

data/lib/libgss/asset_request.rb

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+module Libgss
+  class AssetRequest
+
+    STATUS_PREPARING = 0
+    STATUS_SENDING   = 1
+    STATUS_WAITING   = 2
+    STATUS_RECEIVED  = 3
+    STATUS_SUCCESS   = 4
+    STATUS_ERROR     = 5
+    STATUS_TIMEOUT   = 6
+
+    attr_reader :url, :status, :response_data
+
+    # コンストラクタ
+    def initialize(httpclient, url)
+      @httpclient = httpclient
+      @url = url
+      @response_data = nil
+      @status = STATUS_PREPARING
+    end
+
+    def send_request(&callback)
+      res = @httpclient.get(url)
+      @response_data = res.body
+      callback.call(@response_data) if callback
+    end
+  end
+end

data/lib/libgss/network.rb

@@ -0,0 +1,105 @@
+# -*- coding: utf-8 -*-
+require 'libgss'
+
+require 'httpclient'
+require 'json'
+require 'uri'
+
+module Libgss
+
+  class Network
+
+    API_VERSION = "1.0.0".freeze
+
+    attr_reader :base_url
+    attr_reader :ssl_base_url
+    attr_reader :ssl_disabled
+
+    attr_reader :auth_token, :signature_key
+
+    attr_accessor :api_version
+    attr_accessor :platform
+    attr_accessor :player_id
+    attr_accessor :public_asset_url_prefix
+    attr_accessor :public_asset_url_suffix
+
+
+    DEFAULT_HTTP_PORT = (ENV['DEFAULT_HTTP_PORT'] || 80).to_i
+    DEFAULT_HTTPS_PORT = (ENV['DEFAULT_HTTPS_PORT'] || 443).to_i
+
+    def initialize(base_url_or_host, options = {})
+      @ssl_disabled = options.delete(:ssl_disabled)
+      if base_url_or_host =~ URI.regexp
+        @base_url = base_url_or_host
+        uri = URI.parse(@base_url)
+        @ssl_base_url = build_https_url(uri)
+      else
+        uri = URI::Generic.build({scheme: "http", host: base_url_or_host, port: DEFAULT_HTTP_PORT}.update(options))
+        @base_url = uri.to_s
+        @ssl_base_url = build_https_url(uri)
+      end
+      @ssl_base_url = @base_url if @ssl_disabled
+      @platform = "fontana"
+      @httpclient = HTTPClient.new
+      @httpclient.ssl_config.verify_mode = nil # 自己署名の証明書をOKにする
+    end
+
+    def login
+      raise "player_id is not set." if player_id.nil? || player_id.empty?
+      res = @httpclient.post(login_url, "player[id]" => player_id)
+      case res.status
+      when 200...300 then # OK
+      when 300...400 then return false # リダイレクト対応はしません
+      when 400...500 then return false
+      when 500...600 then return false
+      else raise "invalid http status: #{res.status}"
+      end
+      begin
+        obj = JSON.parse(res.content)
+      rescue JSON::ParserError => e
+        return false
+      end
+      @auth_token = obj["auth_token"]
+      @signature_key = obj["signature_key"]
+      true
+    end
+
+    def new_action_request
+      ActionRequest.new(@httpclient, action_url)
+    end
+
+    def new_public_asset_request(asset_path)
+      AssetRequest.new(@httpclient, public_asset_url(asset_path))
+    end
+
+    def new_protected_asset_request(asset_path)
+      AssetRequest.new(@httpclient, protected_asset_url(asset_path))
+    end
+
+    private
+
+    def build_https_url(uri)
+      uri.scheme = "https"
+      uri.port = DEFAULT_HTTPS_PORT
+      uri.to_s
+    end
+
+    def login_url
+      @login_url ||= ssl_base_url + "/platforms/#{platform}/sign_in.json"
+    end
+
+    def action_url
+      @action_url ||= base_url + "/api/#{API_VERSION}/actions.json?auth_token=#{auth_token}"
+    end
+
+    def public_asset_url(asset_path)
+      "#{@public_asset_url_prefix}#{asset_path}#{@public_asset_url_suffix}"
+    end
+
+    def protected_asset_url(asset_path)
+      path = URI.encode(asset_path) # パラメータとして渡されるのでURLエンコードする必要がある
+      @action_url ||= base_url + "/api/#{API_VERSION}/assets?path=#{path}&auth_token=#{auth_token}"
+    end
+  end
+
+end

data/lib/libgss/outputs.rb

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+require 'libgss'
+
+require 'forwardable'
+
+module Libgss
+
+  class Outputs
+    extend Forwardable
+
+    def initialize(array)
+      @array = array
+    end
+
+    # メソッドを@arrayに移譲する
+    def_delegators :@array, :[], :length, :first, :last
+
+    def get(id)
+      @array.detect{|output| output["id"] == id}
+    end
+
+  end
+end

data/lib/libgss/version.rb

@@ -0,0 +1,3 @@
+module Libgss
+  VERSION = "0.0.1"
+end

data/lib/libgss.rb

@@ -0,0 +1,11 @@
+require "libgss/version"
+
+module Libgss
+
+  autoload :Network      , "libgss/network"
+  autoload :Action       , "libgss/action"
+  autoload :ActionRequest, "libgss/action_request"
+  autoload :Outputs      , "libgss/outputs"
+
+  autoload :AssetRequest , "libgss/asset_request"
+end

data/libgss.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'libgss/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "libgss"
+  spec.version       = Libgss::VERSION
+  spec.authors       = ["akima"]
+  spec.email         = ["t-akima@groovenauts.jp"]
+  spec.description   = %q{network library for Groovenauts GSS}
+  spec.summary       = %q{network library for Groovenauts GSS}
+  spec.homepage      = "http://www.groovenauts.jp/service/#gss"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency "httpclient"
+  spec.add_runtime_dependency "json"
+end