libgss 0.4.0 → 0.4.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTY1Y2NkY2JlMzViNGQ4YzczYTQyMmY1MThiZDFhZDQzOGMwMmY3Nw==
+    NWI5MTBmYjkxNGM3OTRjYWZlMzQ5NDYwY2NiZDA5M2ViYmM5Mjc1OQ==
   data.tar.gz: !binary |-
-    MzY4M2Q0N2Y3NjRhMmMyYmJjNjM3MzIxNTdhMzY2ZGU0NmViNGQ4NA==
+    ZjNiYTE4YWI0NTljNmJjNzcyZDBmOTY1MmU5ZDU2M2FlMTk2NmVhYw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MzAxOWExYTUwYjMwOWNhOWQ0ZTVlMjIyMDQyOGI5Y2ExN2E2MzlmYjFmNzdi
-    MmU3NDgwYTdkZjIwOTJkODc0YTkxM2FmYTIyNGY5OWE1N2RmNWYzNTkyODJj
-    ZGVjNGE0ZDI3N2RhOTI0NzdmNjVkMzE3MmE2Y2QwNGVjZDVlZDg=
+    YzNkMDkxNzIzYzZhNmJkNmQ2MTk2NzYxNWExYzUwYmYxOTBiOWVmNmRkMjkw
+    NDg5OWJiZGU4YjJkODc2ZjBkOWU1NWFmYjZiZDQ4ZDgyMTE1NWVjYjRhYjY0
+    YmFlNDM0MDBmMWFiYmI1Mjg0NmFiMDZhNGM4YzFkMGM2ZjE2YTA=
   data.tar.gz: !binary |-
-    NjczMGQzZDI3ZTkwZDkyMzkwMGZjOWRjNTBlNDRkNGJkNDRjNzliNGJmZDI2
-    NTYyYmM2NzRiMTc0YWM2NGY0Mzc1MjVhOWQwZDAzOTQ5NzNlZTYwMjY1ZTRl
-    NDI1NjYwNjA4MDUzZjFiOTJjNGRkOWVmZWNiMTljYzU3YzdlNGE=
+    ZDE4MDBmNGI1MzFjNzdjZTI5OTc1MDA0NGQ4ZDkzODA4OTBhOTllNDhmOGNm
+    MTVlYWNlN2RmNzYwMjBlMDk5OTIzNWYxY2FiZmRiZTNiZjBiMTdkNDgxOTNl
+    ODU2MWFjNDVjOTRmMzZhNGE3ZDA4MjQ4MThmZDRiYzAyY2FiMTQ=

data/README.md

@@ -22,26 +22,45 @@ Or install it yourself as:
 
 ## Usage
 
-    $ irb -r libgss
-    
-    >> network = Libgss::Network.new("http://localhost:3000", ssl_disabled: true)
-    => #<Libgss::Network:2152782140 @ssl_disabled=true, @base_url="http://localhost:3000", @ssl_base_url="http://localhost:3000", @platform="fontana">
-    >> network.player_id = "1000001"
-    => "1000001"
-    >> network.login
-    => true
-    >> 
-    ?> req1 = network.new_action_request
-    => #<Libgss::ActionRequest:2152568320 @action_url="http://localhost:3000/api/1.0.0/actions.json?auth_token=259rKDuSb3CT1UxbywAf", @status=0, @actions=[], @action_id=0>
-    >> req1.execute("ItemRubyStoredScript", "use_item", {"item_cd" => "20001"})
-    => #<Libgss::Action:0x0000010092f7b0 @id=1, @args={:action=>"execute", :name=>"ItemRubyStoredScript", :key=>"use_item", :args=>{"item_cd"=>"20001"}}>
-    >> req1.get_by_game_data
-    => #<Libgss::Action:0x000001008f9188 @id=2, @args={:action=>"get", :name=>"GameData"}>
-    >> req1.send_request
-    => nil
-    >> 
-    ?> req1.outputs
-    => [{"result"=>"You don't have enough item", "id"=>1}, {"result"=>{"content"=>{"hp"=>15, "max_hp"=>15, "mp"=>5, "max_mp"=>5, "exp"=>100, "money"=>200, "items"=>{"20001"=>0, "20005"=>1}, "equipments"=>{"head"=>10018, "body"=>10012, "right_hand"=>10001, "left_hand"=>nil}}, "greeting_points"=>0, "login_bonus"=>[[10001, 1]], "invitation_code"=>nil, "invite_player"=>nil, "read_notifications"=>[]}, "id"=>2}]
-    >> 
-    ?> req1.outputs.get(1)
-    => {"result"=>"You don't have enough item", "id"=>1}
+```
+$ irb -r libgss
+
+>> network = Libgss::Network.new("http://localhost:3000", ssl_disabled: true)
+=> #<Libgss::Network:2152782140 @ssl_disabled=true, @base_url="http://localhost:3000", @ssl_base_url="http://localhost:3000", @platform="fontana">
+>> network.player_id = "1000001"
+=> "1000001"
+>> network.login
+=> true
+>> 
+?> req1 = network.new_action_request
+=> #<Libgss::ActionRequest:2152568320 @action_url="http://localhost:3000/api/1.0.0/actions.json?auth_token=259rKDuSb3CT1UxbywAf", @status=0, @actions=[], @action_id=0>
+>> req1.execute("ItemRubyStoredScript", "use_item", {"item_cd" => "20001"})
+=> #<Libgss::Action:0x0000010092f7b0 @id=1, @args={:action=>"execute", :name=>"ItemRubyStoredScript", :key=>"use_item", :args=>{"item_cd"=>"20001"}}>
+>> req1.get_by_game_data
+=> #<Libgss::Action:0x000001008f9188 @id=2, @args={:action=>"get", :name=>"GameData"}>
+>> req1.send_request
+=> nil
+>> 
+?> req1.outputs
+=> [{"result"=>"You don't have enough item", "id"=>1}, {"result"=>{"content"=>{"hp"=>15, "max_hp"=>15, "mp"=>5, "max_mp"=>5, "exp"=>100, "money"=>200, "items"=>{"20001"=>0, "20005"=>1}, "equipments"=>{"head"=>10018, "body"=>10012, "right_hand"=>10001, "left_hand"=>nil}}, "greeting_points"=>0, "login_bonus"=>[[10001, 1]], "invitation_code"=>nil, "invite_player"=>nil, "read_notifications"=>[]}, "id"=>2}]
+>> 
+?> req1.outputs.get(1)
+=> {"result"=>"You don't have enough item", "id"=>1}
+```
+
+
+## connection testing
+
+You can use `gss-server-time` command to test connection like this:
+
+```
+$ gss-server-time http://localhost:3000 -a path/to/app_garden.yml.erb
+```
+
+or
+
+```
+$ gss-server-time http://localhost:3000 -p fontana -c <consumer_secret> -i <player_id>
+```
+
+see `gss-server-time --help` for more options

data/README_ja.md

@@ -30,32 +30,50 @@ libgss-rubyはGroovenautsのGSS用通信ライブラリです。
 
 手動で以下のコマンドを実行してインストールできます:
 
-    $ gem install libgss
+```
+$ gem install libgss
+```
 
 ## irbでの使用方法
 
-    $ irb -r libgss
-    
-    >> network = Libgss::Network.new("http://localhost:3000", ssl_disabled: true)
-    => #<Libgss::Network:2152782140 @ssl_disabled=true, @base_url="http://localhost:3000", @ssl_base_url="http://localhost:3000", @platform="fontana">
-    >> network.player_id = "1000001"
-    => "1000001"
-    >> network.login
-    => true
-    >> 
-    ?> req1 = network.new_action_request
-    => #<Libgss::ActionRequest:2152568320 @action_url="http://localhost:3000/api/1.0.0/actions.json?auth_token=259rKDuSb3CT1UxbywAf", @status=0, @actions=[], @action_id=0>
-    >> req1.execute("ItemRubyStoredScript", "use_item", {"item_cd" => "20001"})
-    => #<Libgss::Action:0x0000010092f7b0 @id=1, @args={:action=>"execute", :name=>"ItemRubyStoredScript", :key=>"use_item", :args=>{"item_cd"=>"20001"}}>
-    >> req1.get_by_game_data
-    => #<Libgss::Action:0x000001008f9188 @id=2, @args={:action=>"get", :name=>"GameData"}>
-    >> req1.send_request
-    => nil
-    >> 
-    ?> req1.outputs
-    => [{"result"=>"You don't have enough item", "id"=>1}, {"result"=>{"content"=>{"hp"=>15, "max_hp"=>15, "mp"=>5, "max_mp"=>5, "exp"=>100, "money"=>200, "items"=>{"20001"=>0, "20005"=>1}, "equipments"=>{"head"=>10018, "body"=>10012, "right_hand"=>10001, "left_hand"=>nil}}, "greeting_points"=>0, "login_bonus"=>[[10001, 1]], "invitation_code"=>nil, "invite_player"=>nil, "read_notifications"=>[]}, "id"=>2}]
-    >> 
-    ?> req1.outputs.get(1)
-    => {"result"=>"You don't have enough item", "id"=>1}
-
-
+```
+$ irb -r libgss
+
+>> network = Libgss::Network.new("http://localhost:3000", ssl_disabled: true)
+=> #<Libgss::Network:2152782140 @ssl_disabled=true, @base_url="http://localhost:3000", @ssl_base_url="http://localhost:3000", @platform="fontana">
+>> network.player_id = "1000001"
+=> "1000001"
+>> network.login
+=> true
+>> 
+?> req1 = network.new_action_request
+=> #<Libgss::ActionRequest:2152568320 @action_url="http://localhost:3000/api/1.0.0/actions.json?auth_token=259rKDuSb3CT1UxbywAf", @status=0, @actions=[], @action_id=0>
+>> req1.execute("ItemRubyStoredScript", "use_item", {"item_cd" => "20001"})
+=> #<Libgss::Action:0x0000010092f7b0 @id=1, @args={:action=>"execute", :name=>"ItemRubyStoredScript", :key=>"use_item", :args=>{"item_cd"=>"20001"}}>
+>> req1.get_by_game_data
+=> #<Libgss::Action:0x000001008f9188 @id=2, @args={:action=>"get", :name=>"GameData"}>
+>> req1.send_request
+=> nil
+>> 
+?> req1.outputs
+=> [{"result"=>"You don't have enough item", "id"=>1}, {"result"=>{"content"=>{"hp"=>15, "max_hp"=>15, "mp"=>5, "max_mp"=>5, "exp"=>100, "money"=>200, "items"=>{"20001"=>0, "20005"=>1}, "equipments"=>{"head"=>10018, "body"=>10012, "right_hand"=>10001, "left_hand"=>nil}}, "greeting_points"=>0, "login_bonus"=>[[10001, 1]], "invitation_code"=>nil, "invite_player"=>nil, "read_notifications"=>[]}, "id"=>2}]
+>> 
+?> req1.outputs.get(1)
+=> {"result"=>"You don't have enough item", "id"=>1}
+```
+
+## 接続確認
+
+上記のirbでの接続テストを1コマンドで実行できるように`gss-server-time`コマンドを用意しています。
+
+```
+$ gss-server-time http://localhost:3000 -a path/to/app_garden.yml.erb
+```
+
+あるいは
+
+```
+$ gss-server-time http://localhost:3000 -p fontana -c <consumer_secret> -i <player_id>
+```
+
+という風に使用します。詳しくは `gss-server-time --help` を参照してください。

data/lib/libgss/network.rb

@@ -33,6 +33,15 @@ module Libgss
     TEST_HTTP_PORT  = 3000
     TEST_HTTPS_PORT = 3001
 
+    # Libgss::Networkのコンストラクタです。
+    #
+    # @param [String] base_url_or_host 接続先の基準となるURLあるいはホスト名
+    # @param [Hash] options オプション
+    # @option options [String]  :platform 接続先のGSSサーバの認証のプラットフォーム。デフォルトは"fontana"。
+    # @option options [String]  :player_id 接続に使用するプレイヤのID
+    # @option options [String]  :consumer_secret GSSサーバとクライアントの間で行う署名の検証に使用される文字列。
+    # @option options [Boolean] :ssl_disabled SSLを無効にするかどうか。
+    # @option options [Boolean]  :ignore_signature_key シグネチャキーによる署名を行うかどうか
     def initialize(base_url_or_host, options = {})
       @ssl_disabled = options.delete(:ssl_disabled)
       if base_url_or_host =~ URI.regexp
@@ -61,6 +70,13 @@ module Libgss
       r << fields.join(", ") << ">"
     end
 
+
+    # GSSサーバに接続してログインの検証と処理を行います。
+    #
+    # @param [String] base_url_or_host 接続先の基準となるURLあるいはホスト名
+    # @param [Hash] options オプション
+    # @option options [String]  :platform 接続先のGSSサーバの認証のプラットフォーム。デフォルトは"fontana"。
+    # @return [Boolean] ログインに成功した場合はtrue、失敗した場合はfalse
     def login(extra = {})
       attrs = { "player[id]" => player_id }
       extra.each{|k, v| attrs[ "player[#{k}]" ] = v }

data/lib/libgss/version.rb

@@ -1,3 +1,3 @@
 module Libgss
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libgss
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - akima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-11 00:00:00.000000000 Z
+date: 2013-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler