libgss 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjBlOTY0MzIyNTBkNDMzY2ExMGE5NDk2YzQzOTg2NWExNmJhOWQ0Yg==
+    Y2Y0OGU1MjZkZDE4ZDA2YmYzM2Q5YzNhNjMzYjczZTQwOThmODFiMg==
   data.tar.gz: !binary |-
-    M2IyMzllMWM1ZWMyY2M3ZGFmOTA2MTJhNWQzNWNlNGE1ODJhOTMwYQ==
+    NDMwZmZiNTY5OGE3MTk2ZWMzZDRmN2IzNjgzMjkyYjdhNDY2YjBkNw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    Y2M1YWZkNmQ2NTk0NzMwOWRlY2U3NGMwYjE5MDNkZTVkNWM3Yjg5ZWVlZjli
-    MmU2OTU4MDFiMDZhNzc3OGUwZWU2MzIyNGYxMTZhMTA5Njk3NzQ5NmFiNjU5
-    MTdmNDJiNDdkYjhjOGNkMmExNWRlOTA4MTNkMTBiM2RjYTg5ZGU=
+    ZDQ0NWUxMTNmZTVjZjg2MTJiNGMwZGUyYmI2NDM3NjI1YzJhODRlMjZlNTc4
+    MDE3ODg4MTA0MjZhMGQwZTY4ZmI3NTdlNDYzY2MxZjI1Y2NjN2FkMzU5MDFj
+    N2FiOWEwNGIxYjY5OTViYWQ4NGRlZDg4OTdkNWIzY2ZiMDExZjA=
   data.tar.gz: !binary |-
-    MTU1OWRkNmMyODk4OWRjNDRlYmM3OTVjYmEzNzVjYTVhNGU1Y2FkNDc4NDYw
-    NjhhYmYzMGM1YmMxMWU1M2ZkMzJjNzA1ZDIyMjM2NTMyNzRiMjcxN2M0OTBj
-    ZDRlMDdkZjFkNmVjZDcyNDNiMzEwODMwZDU1ZmIyYTY3MjY2ZTY=
+    Y2JkMDE0NTljMmNlOGY5M2UwMTFlODY0NTkwNjUxZTVkMGNjNDQxZjkzNGNl
+    ZGM0Mzc3ZDNiNzgyM2ZjMGU5MGNiZGVjYjUwZTljMzU0YzIyMjcwNTZkNzMw
+    MDAwZDdjMmQyMTUxZjUzMzFlNTRhZTVjNDQ2MGI0ODA0OTZkZjk=

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    libgss (0.0.1)
+    libgss (0.0.2)
       httpclient
       json
 
@@ -10,7 +10,7 @@ GEM
   specs:
     diff-lcs (1.2.3)
     httpclient (2.3.3)
-    json (1.7.7)
+    json (1.8.0)
     rake (10.0.4)
     rspec (2.13.0)
       rspec-core (~> 2.13.0)

data/README.md

@@ -1,6 +1,10 @@
 # Libgss
 
-TODO: Write a gem description
+Network library for Groovenauts GSS.
+
+Usually game developers use other network libraries built in each environment,
+but can use this network library in oder to write test script about Stored Script
+which is server side script in GSS.
 
 ## Installation
 
@@ -18,12 +22,26 @@ Or install it yourself as:
 
 ## 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
+    $ 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}

data/README_ja.md

@@ -0,0 +1,57 @@
+# libgss-ruby
+
+libgss-rubyはGroovenautsのGSS用通信ライブラリです。
+
+通常、GSSと通信するためには、直接HTTPのAPIをコールするか、それぞれの環境に合わせた
+通信ライブラリを用いる必要があります。
+
+しかしこのlibgss-rubyとRSpecやminitestなどを組み合わせることによって、GSSにおける
+サーバーサイドスクリプトであるストアドスクリプトのユニットテストを記述することが
+できます。
+
+## インストール方法
+
+### bundlerを使う方法
+
+アプリケーションのGemfileに以下の行を追加します:
+
+    gem 'libgss'
+
+以下の行を実行します:
+
+    $ bundle
+
+
+### 手動でインストールする方法
+
+手動で以下のコマンドを実行してインストールできます:
+
+    $ 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}
+
+

data/lib/libgss/action_request.rb

@@ -30,6 +30,12 @@ module Libgss
       @action_id = 0;
     end
 
+    def inspect
+      r = "#<#{self.class.name}:#{self.object_id} "
+      fields = (instance_variables - [:@httpclient]).map{|f| "#{f}=#{instance_variable_get(f).inspect}"}
+      r << fields.join(", ") << ">"
+    end
+
     def next_action_id
       @action_id += 1
     end

data/lib/libgss/network.rb

@@ -44,6 +44,12 @@ module Libgss
       @httpclient.ssl_config.verify_mode = nil # 自己署名の証明書をOKにする
     end
 
+    def inspect
+      r = "#<#{self.class.name}:#{self.object_id} "
+      fields = (instance_variables - [:@httpclient]).map{|f| "#{f}=#{instance_variable_get(f).inspect}"}
+      r << fields.join(", ") << ">"
+    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)

data/lib/libgss/outputs.rb

@@ -7,17 +7,17 @@ module Libgss
 
   class Outputs
     extend Forwardable
+    include Enumerable
 
     def initialize(array)
       @array = array
     end
 
     # メソッドを@arrayに移譲する
-    def_delegators :@array, :[], :length, :first, :last
+    def_delegators :@array, :[], :length, :first, :last, :inspect, :each
 
     def get(id)
       @array.detect{|output| output["id"] == id}
     end
-
   end
 end

data/lib/libgss/version.rb

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

data/spec/libgss/action_request_spec.rb

@@ -154,6 +154,14 @@ describe Libgss::ActionRequest do
       end
 
 
+      it "outputs is an Enumerable" do
+        request.get_by_player.with(ACITON_ID_PLAYER)
+        request.server_time.with(ACITON_ID_SERVER_TIME)
+        request.get_by_game_data.with(ACITON_ID_GAME_DATA) # withメソッドで短く書くこともできます。
+        request.send_request
+        request.outputs.map{|r| r["id"]}.should == [ACITON_ID_PLAYER, ACITON_ID_SERVER_TIME, ACITON_ID_GAME_DATA]
+      end
+
     end
   end
 

data/spec/libgss/network_spec.rb

@@ -72,4 +72,14 @@ describe Libgss::Network do
     its(:status){ should == Libgss::ActionRequest::STATUS_PREPARING }
   end
 
+  describe "#inspect" do
+    it "doesn't contain @httpclient" do
+      network.inspect.should_not =~ /@httpclient/
+    end
+
+    it "isn't too long" do
+      network.inspect.length.should < 200
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libgss
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - akima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-20 00:00:00.000000000 Z
+date: 2013-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,7 @@ files:
 - Gemfile.lock
 - LICENSE.txt
 - README.md
+- README_ja.md
 - Rakefile
 - lib/libgss.rb
 - lib/libgss/action.rb