libgss 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7851a6116163ca2eb6bf2af61af08bebd7a59383
-  data.tar.gz: ef4dcbd1330729b3d27d63a643b600abee0e5af9
+  metadata.gz: 04a7f3350eb992b75f94b53b265dcaccf33aa168
+  data.tar.gz: 3f915ba45f3bfbf49cc8313b7b61b465882d36f7
 SHA512:
-  metadata.gz: 17085bf8a1bd853273cfcd6bce736eb5f64aba253d09161bfc99cd9f898acd463430143c6cc80cfde8517f1c5dd5c99ef901466371932e481fd850d2e4e8d7ec
-  data.tar.gz: 6f09c4a77661bc89bb5981ddd1981c51df36f2df209060e8b3b1abf3eee18371af0842777470b85ee2f707f4c73512336d474703ce5e9d6961871993127b7d25
+  metadata.gz: 428061466d77c8e1764bd3c4bc21430c70d77ac31704a31bd4ab133188ddfbd631b072443c415ae3bff53f52910c3fe908875f179cc3a3de862260dfcc821ac3
+  data.tar.gz: e020cecda53511ceb7e739340b9d68d6aa864714408534a778f791134ea1aa43aa5b4afa172e5c7fe5cb322d6ed82701104806b585f9768f533757d12a334278

data/lib/libgss.rb

@@ -20,6 +20,43 @@ module Libgss
 
   MAX_RETRY_COUNT = (ENV["LIBGSS_MAX_RETRY_COUNT"] || 10).to_i
 
+  class Error < StandardError; end
+  class ClientError < Error; end
+
+  class ErrorResponse < Error
+    class << self
+      def subclasses
+        @subclasses ||= []
+      end
+      def inherited(klass)
+        subclasses << klass
+      end
+      def build(res)
+        return nil if res.nil?
+        klass = subclasses.detect{|k| k.respond_to?(:match?) && k.match?(res)} || self
+        klass.new(res.status, res.content)
+      end
+    end
+
+    attr_reader :status
+    def initialize(status, message)
+      @status = status
+      super(message)
+    end
+  end
+
+  class InvalidResponse < ErrorResponse
+  end
+
+  class ServerBlockError < ErrorResponse
+    STATUS = 503
+    BODY = "api maintenance".freeze
+    def self.match?(res)
+      res.content.nil? ? false :
+        (res.status == STATUS) && (res.content.strip == BODY)
+    end
+  end
+
   class << self
 
     def with_retry(name)

data/lib/libgss/action_request.rb

@@ -70,10 +70,11 @@ module Libgss
 
     # レスポンスの処理を行います
     def process_response(res, req_type)
-      case res.code.to_i
+      case res.status.to_i
       when 200..299 then # OK
       else
-        raise Error, "failed to send #{req_type}: [#{res.code}] #{res.content}"
+        # raise Error, "failed to send #{req_type}: [#{res.status}] #{res.content}"
+        raise ErrorResponse.build(res)
       end
       verify_signature(res) do |content|
         begin

data/lib/libgss/network.rb

@@ -12,8 +12,7 @@ module Libgss
 
   class Network
 
-    class Error < StandardError
-    end
+    Error = Libgss::Error
 
     attr_reader :base_url
     attr_reader :ssl_base_url
@@ -52,6 +51,7 @@ module Libgss
     # @option options [String]  :platform 接続先のGSSサーバの認証のプラットフォーム。デフォルトは"fontana"。
     # @option options [String]  :api_version APIのバージョン。デフォルトは "1.0.0"
     # @option options [String]  :player_id 接続に使用するプレイヤのID
+    # @option options [Hash]    :player_info pf_player_info として格納されるはずの諸情報
     # @option options [String]  :consumer_secret GSSサーバとクライアントの間で行う署名の検証に使用される文字列。
     # @option options [Boolean] :ignore_oauth_nonce OAuth認証時にoauth_nonceとoauth_timestampを使用しないかどうか。
     # @option options [String]  :oauth_nonce OAuth認証のoauth_nonceパラメータ
@@ -105,13 +105,14 @@ module Libgss
     # @param [Hash] extra オプション
     # @option extra [Integer] :device_type デバイス種別
     # @option extra [Integer] :device_id デバイス識別子
-    # @return [Boolean] ログインに成功した場合はtrue、失敗した場合はfalse
-    def login(extra = {})
+    # @return [Integer, false, Error] 基本的にサーバが返したレスポンスのステータスを返しますが、200番台でも検証に失敗した場合などは、falseあるいは例外オブジェクトを返します。
+    def login_and_status(extra = {})
       @player_info[:id] = player_id
       @player_info.update(extra)
-      attrs = @player_info.each_with_object({}){|(k,v), d| d[ "player[#{k}]" ] = v }
+      # attrs = @player_info.each_with_object({}){|(k,v), d| d[ "player[#{k}]" ] = v }
+      json = {"player" => @player_info}.to_json
       res = Libgss.with_retry("login") do
-        @httpclient.post(login_url, attrs, req_headers)
+        @httpclient.post(login_url, json, req_headers)
       end
       process_json_response(res) do |obj|
         @player_id ||= obj["player_id"]
@@ -121,14 +122,31 @@ module Libgss
       end
     end
 
+    # GSSサーバに接続してログインの検証と処理を行います。
+    #
+    # @param [Hash] extra オプション
+    # @option extra [Integer] :device_type デバイス種別
+    # @option extra [Integer] :device_id デバイス識別子
+    # @return [Boolean] ログインに成功した場合はtrue、失敗した場合はfalse
+    def login(extra = {})
+      case login_and_status(extra)
+      when 200...300 then true
+      else false
+      end
+    end
+
     # GSSサーバに接続してログインの検証と処理を行います。
     #
     # @param [Hash] extra オプション
     # @see #login
     # @return ログインに成功した場合は自身のオブジェクト返します。失敗した場合はLibgss::Network::Errorがraiseされます。
     def login!(extra = {})
-      raise Error, "Login Failure" unless login(extra)
-      self
+      result = login_and_status(extra)
+      case result
+      when 200...300 then return self
+      when ErrorResponse then raise result
+      else raise Error, "Login Failure"
+      end
     end
 
     # @return [Boolean] コンストラクタに指定されたignore_signature_keyを返します
@@ -227,6 +245,7 @@ module Libgss
 
     def req_headers
       {
+        "Content-Type" => "application/json",
         "X-Device-Type" => device_type_cd,
         "X-Client-Version" => client_version,
       }
@@ -245,19 +264,21 @@ module Libgss
     end
 
     def process_json_response(res)
-      case res.status
+      result = res.status
+      case result
       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}"
+      when 300...600 then
+        return ErrorResponse.build(res)
+      else
+        raise InvalidResponse.new(result, "invalid http status")
       end
       begin
         obj = JSON.parse(res.content)
-        return yield(obj)
+        yield(obj)
+        return result
       rescue JSON::ParserError => e
         $stderr.puts("\e[31m[#{e.class}] #{e.message}\n#{res.content}")
-        return false
+        return e
       end
     end
 

data/lib/libgss/version.rb

@@ -1,3 +1,3 @@
 module Libgss
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

data/spec/libgss/network_spec.rb

@@ -130,8 +130,7 @@ describe Libgss::Network do
       [300, 400, 500].map{|n| (1..10).map{|i| n + i} }.flatten.each do |status_code|
         context "status_code is #{status_code}" do
           before do
-            res = double(:reponse)
-            res.should_receive(:status).and_return(status_code)
+            res = double(:reponse, status: status_code, content: nil)
             HTTPClient.any_instance.should_receive(:post).and_return(res)
           end
           it_should_behave_like "Libgss::Network#login failure"
@@ -141,9 +140,7 @@ describe Libgss::Network do
       context "JSON parse Error" do
         before do
           $stderr.stub(:puts).with(an_instance_of(String)) # $stderrにメッセージが出力されます
-          res = double(:reponse)
-          res.stub(:status).and_return(200)
-          res.should_receive(:content).twice.and_return("invalid JSON format string")
+          res = double(:reponse, status: 200, content: "invalid JSON format string")
           HTTPClient.any_instance.should_receive(:post).and_return(res)
         end
 
@@ -242,8 +239,7 @@ describe Libgss::Network do
       [300, 400, 500].map{|n| (1..10).map{|i| n + i} }.flatten.each do |status_code|
         context "status_code is #{status_code}" do
           before do
-            res = double(:reponse)
-            res.should_receive(:status).and_return(status_code)
+            res = double(:reponse, {status: status_code, content: nil})
             HTTPClient.any_instance.should_receive(:post).and_return(res)
           end
           it_should_behave_like "Libgss::Network#login failure"
@@ -253,9 +249,7 @@ describe Libgss::Network do
       context "JSON parse Error" do
         before do
           $stderr.stub(:puts).with(an_instance_of(String)) # $stderrにメッセージが出力されます
-          res = double(:reponse)
-          res.stub(:status).and_return(200)
-          res.should_receive(:content).twice.and_return("invalid JSON format string")
+          res = double(:reponse, {status: 200, content: "invalid JSON format string"})
           HTTPClient.any_instance.should_receive(:post).and_return(res)
         end
 
@@ -351,13 +345,13 @@ describe Libgss::Network do
       it "with empty oauth_nonce" do
         proc{
           spec_with_network_options({oauth_nonce: ''})
-        }.should raise_error(::Libgss::ActionRequest::Error)
+        }.should raise_error(::Libgss::ErrorResponse)
       end
       it "with old oauth_timestamp" do
         time = Time.local(2013,7,1,12,0,0)
         proc{
           spec_with_network_options({oauth_timestamp: time.to_i})
-        }.should raise_error(::Libgss::ActionRequest::Error)
+        }.should raise_error(::Libgss::ErrorResponse)
       end
     end
   end

data/spec/libgss/server_block_spec.rb

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe "サーバ閉塞中" do
+  before do
+    mock_res = mock(:res, {status: 503, content: "api maintenance"})
+    HTTPClient.any_instance.stub(:post).and_return(mock_res)
+  end
+
+  context "login" do
+    let(:network){ new_network }
+    it :login do
+      network.login_and_status.should be_a Libgss::ErrorResponse
+    end
+    it :login! do
+      expect{ network.login!}.to raise_error(Libgss::ServerBlockError)
+    end
+  end
+
+  context "action request" do
+    let(:network){ new_network }
+    it do
+      r = network.new_action_request
+      r.server_time
+      expect{ r.send_request }.to raise_error(Libgss::ServerBlockError)
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libgss
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - akima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-25 00:00:00.000000000 Z
+date: 2013-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -215,6 +215,7 @@ files:
 - spec/libgss/async_action_request_spec.rb
 - spec/libgss/network_spec.rb
 - spec/libgss/response_signatrue_spec.rb
+- spec/libgss/server_block_spec.rb
 - spec/protected_assets/Icon.png
 - spec/public_assets/Default.png
 - spec/spec_helper.rb
@@ -269,6 +270,7 @@ test_files:
 - spec/libgss/async_action_request_spec.rb
 - spec/libgss/network_spec.rb
 - spec/libgss/response_signatrue_spec.rb
+- spec/libgss/server_block_spec.rb
 - spec/protected_assets/Icon.png
 - spec/public_assets/Default.png
 - spec/spec_helper.rb