libgss 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d65517f74f8f6290c265bde2dcfa858974f4ee8
-  data.tar.gz: f1b27493e24d26c5990a5885fede27f07d62bd7b
+  metadata.gz: a77c17af378bc6038a7ce58b8a07e4d60757fab3
+  data.tar.gz: aaf5b60ce2937cacce2f6fc35a398d446fcd0e9f
 SHA512:
-  metadata.gz: 64a4ad4a6de5294fb7f28fef442e51614967e8afc82f227f8307cc15f51f375598c4c48bc51f01cee8008820797443fd62085a6f234fd9f4456163b68ef454e9
-  data.tar.gz: 0de31d99679a417841856d0b828b210a58ee04f4152f2c66301757ab02740919657fc709e153970a61de6c34d80fcf7c4874e08e71de3298e27caaf93b388ccf
+  metadata.gz: fb962ff05a56236c77dda5c1a85c29bb5d9230a285c07784379d63b109db944f24641690f34e680095f8e388aa3a9ca3e500a09a655421e1faa9febed8e5b11a
+  data.tar.gz: e91b141a88aee2001402312a5c0b968707d37e3324fea35686ab9825316b68019424ede486313f023a01c212f84c2b98f1ae95f9f2d2a68093602ad12d1a7f8b

data/Gemfile.lock

@@ -1,10 +1,12 @@
 PATH
   remote: .
   specs:
-    libgss (0.7.1)
+    libgss (0.7.2)
       httpclient
       json
       oauth
+      tengine_support
+      uuid
 
 GEM
   remote: https://rubygems.org/
@@ -16,6 +18,8 @@ GEM
     httpclient (2.3.4.1)
     i18n (0.6.5)
     json (1.8.0)
+    macaddr (1.6.1)
+      systemu (~> 2.5.0)
     multi_json (1.7.9)
     oauth (0.4.7)
     rake (10.0.4)
@@ -27,8 +31,11 @@ GEM
     rspec-expectations (2.13.0)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.13.1)
+    systemu (2.5.2)
     tengine_support (1.2.2)
       activesupport (>= 3.0.0, < 4.0.0)
+    uuid (2.3.7)
+      macaddr (~> 1.0)
 
 PLATFORMS
   ruby
@@ -38,4 +45,3 @@ DEPENDENCIES
   libgss!
   rake
   rspec
-  tengine_support

data/lib/libgss/network.rb

@@ -4,11 +4,17 @@ require 'libgss'
 require 'httpclient'
 require 'json'
 require 'uri'
+require 'tengine/support/yaml_with_erb'
+
+require 'uuid'
 
 module Libgss
 
   class Network
 
+    class Error < StandardError
+    end
+
     API_VERSION = "1.0.0".freeze
 
     attr_reader :base_url
@@ -23,6 +29,7 @@ module Libgss
     attr_accessor :api_version
     attr_accessor :platform
     attr_accessor :player_id
+    attr_accessor :player_info
     attr_accessor :public_asset_url_prefix
     attr_accessor :public_asset_url_suffix
 
@@ -49,7 +56,7 @@ module Libgss
     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
+        @base_url = base_url_or_host.sub(/\/\Z/, '')
         uri = URI.parse(@base_url)
         @ssl_base_url = build_https_url(uri)
       else
@@ -60,6 +67,7 @@ module Libgss
       @ssl_base_url = @base_url if @ssl_disabled
       @platform  = options[:platform] || "fontana"
       @player_id = options[:player_id]
+      @player_info = options[:player_info] || {}
 
       @consumer_secret = options[:consumer_secret] || ENV["CONSUMER_SECRET"]
       @ignore_signature_key = !!options[:ignore_signature_key]
@@ -77,21 +85,14 @@ module Libgss
       r << fields.join(", ") << ">"
     end
 
-    def req_headers
-      {
-        "X-Device-Type" => device_type_cd,
-        "X-Client-Version" => client_version,
-      }
-    end
-
     # GSSサーバに接続してログインの検証と処理を行います。
     #
-    # @param [String] base_url_or_host 接続先の基準となるURLあるいはホスト名
-    # @param [Hash] options オプション
-    # @option options [String]  :platform 接続先のGSSサーバの認証のプラットフォーム。デフォルトは"fontana"。
+    # @param [Hash] extra オプション
+    # @option extra [Integer] :device_type デバイス種別
+    # @option extra [Integer] :device_id デバイス識別子
     # @return [Boolean] ログインに成功した場合はtrue、失敗した場合はfalse
     def login(extra = {})
-      attrs = { "player[id]" => player_id }
+      attrs = @player_info.merge({ "player[id]" => player_id })
       extra.each{|k, v| attrs[ "player[#{k}]" ] = v }
       res = Libgss.with_retry("login") do
         @httpclient.post(login_url, attrs, req_headers)
@@ -104,39 +105,104 @@ module Libgss
       end
     end
 
+    # GSSサーバに接続してログインの検証と処理を行います。
+    #
+    # @param [Hash] extra オプション
+    # @see #login
+    # @return ログインに成功した場合は自身のオブジェクト返します。失敗した場合はLibgss::Network::Errorがraiseされます。
+    def login!(extra = {})
+      raise Error, "Login Failure" unless login(extra)
+      self
+    end
+
+    # @return [Boolean] コンストラクタに指定されたignore_signature_keyを返します
     def ignore_signature_key?
       @ignore_signature_key
     end
 
+    # load_player_id メソッドをオーバーライドした場合に使用することを想定しています。
+    # それ以外の場合は使用しないでください。
     def setup
       load_player_id
       login
     end
 
+    # @return [Libgss::ActionRequest] アクション用リクエストを生成して返します
     def new_action_request
       ActionRequest.new(httpclient_for_action, action_url, req_headers)
     end
 
+    # @return [Libgss::AsyncActionRequest] 非同期アクション用リクエストを生成して返します
     def new_async_action_request
       AsyncActionRequest.new(httpclient_for_action, async_action_url, async_result_url, req_headers)
     end
 
+    # @return [Libgss::AssetRequest] 公開アセットを取得するリクエストを生成して返します
     def new_public_asset_request(asset_path)
       AssetRequest.new(@httpclient, public_asset_url(asset_path), req_headers)
     end
 
+    # @return [Libgss::AssetRequest] 保護付きアセットを取得するリクエストを生成して返します
     def new_protected_asset_request(asset_path)
       AssetRequest.new(@httpclient, protected_asset_url(asset_path), req_headers)
     end
 
+    # @param [String] path 対象となるapp_garden.ymlへのパス。デフォルトは "config/app_garden.yml"
+    # @return 成功した場合自身のオブジェクトを返します。
+    def load_app_garden(path = "config/app_garden.yml")
+      hash = YAML.load_file_with_erb(path)
+      self.consumer_secret = hash["consumer_secret"]
+      if platform = hash["platform"]
+        name = (platform["name"] || "").strip
+        unless name.empty?
+          self.platform = name
+        end
+      end
+      self
+    end
+
+    # device_idを生成します
+    #
+    # @param [Hash] options オプション
+    # @option options [Integer] :device_type デバイス種別
+    # @return [String] 生成したUUIDの文字列
+    def generate_device_id(options = {device_type: 1})
+      result = uuid_gen.generate
+      player_info.update(options)
+      player_info[:device_id] = result
+      result
+    end
+
+    # device_idを設定します
+    #
+    # @param [String] device_id デバイスID
+    # @param [Hash] options オプション
+    # @option options [Integer] :device_type デバイス種別
+    def set_device_id(device_id, options = {device_type: 1})
+      if player_info[:device_id] = device_id
+        player_info.update(options)
+      end
+    end
+
+    def uuid_gen
+      @uuid_gen ||= UUID.new
+    end
+
+    private
+
+    def req_headers
+      {
+        "X-Device-Type" => device_type_cd,
+        "X-Client-Version" => client_version,
+      }
+    end
+
     def httpclient_for_action
       @httpclient_for_action ||=
         @ignore_signature_key ? @httpclient :
         HttpClientWithSignatureKey.new(@httpclient, self)
     end
 
-    private
-
     # ストレージからplayer_idをロードします
     # 保存されていたらtrueを、保存されていなかったらfalseを返します。
     #

data/lib/libgss/version.rb

@@ -1,3 +1,3 @@
 module Libgss
-  VERSION = "0.7.1"
+  VERSION = "0.7.2"
 end

data/libgss.gemspec

@@ -21,9 +21,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "tengine_support"
 
   spec.add_runtime_dependency "httpclient"
   spec.add_runtime_dependency "json"
   spec.add_runtime_dependency "oauth"
+  spec.add_runtime_dependency "tengine_support"
+  spec.add_runtime_dependency "uuid"
 end

data/spec/libgss/actions/game_data_spec.rb

@@ -25,6 +25,7 @@ describe Libgss::ActionRequest do
       "items"=>{"20001"=>3, "20005"=>1},
       "equipments"=>{"head"=>10018, "body"=>10012, "right_hand"=>10001, "left_hand"=>nil}
     },
+    "gender" => 0,
     "greeting_points"=>0,
     "login_bonus"=>[[10001, 1]],
     "invitation_code"=>nil,

data/spec/libgss/network_spec.rb

@@ -1,9 +1,11 @@
 require 'spec_helper'
 
+require 'uuid'
+
 describe Libgss::Network do
 
   let(:network) do
-    # Libgss::Network.new("http://localhost:3000")
+    # Libgss::Network.new("http://localhost:4000")
     new_network
   end
 
@@ -22,6 +24,19 @@ describe Libgss::Network do
     end
   end
 
+  describe "#initialize" do
+    context "with_trail_slash" do
+      let(:target){ new_network("http://localhost:4000/") }
+      it{ target.base_url.should == network.base_url }
+      it{ target.ssl_base_url.should == network.ssl_base_url }
+    end
+    context "hostname only" do
+      let(:target){ new_network("localhost") }
+      it{ target.base_url.should == "http://localhost:#{ENV['DEFAULT_HTTP_PORT' ] ||  80}" }
+      it{ target.ssl_base_url.should == "https://localhost:#{ENV['DEFAULT_HTTPS_PORT' ] || 443}" }
+    end
+  end
+
   describe "#login" do
     before do
       network.player_id = "1000001"
@@ -51,21 +66,27 @@ describe Libgss::Network do
 
     end
 
-    context "failure" do
-      it "unregistered (maybe invalid) player_id" do
+    context "failure with unregistered (maybe invalid) player_id" do
+      before do
         network.player_id = "unregistered"
         network.auth_token.should == nil
         network.signature_key.should == nil
+      end
+
+      it "by using login" do
         res = network.login
         network.auth_token.should == nil
         network.signature_key.should == nil
         res.should == false
       end
+      it "by using login!" do
+        expect{ network.login! }.to raise_error(Libgss::Network::Error)
+      end
     end
 
     context "error" do
       shared_examples_for "Libgss::Network#login failure" do
-        it do
+        it "by using login"do
           network.auth_token.should == nil
           network.signature_key.should == nil
           res = network.login
@@ -73,12 +94,17 @@ describe Libgss::Network do
           network.signature_key.should == nil
           res.should == false
         end
+        it "by using login"do
+          network.auth_token.should == nil
+          network.signature_key.should == nil
+          expect{ network.login! }.to raise_error(Libgss::Network::Error)
+        end
       end
 
       [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 = mock(:reponse)
+            res = double(:reponse)
             res.should_receive(:status).and_return(status_code)
             HTTPClient.any_instance.should_receive(:post).and_return(res)
           end
@@ -88,7 +114,7 @@ describe Libgss::Network do
 
       context "JSON parse Error" do
         before do
-          res = mock(:reponse)
+          res = double(:reponse)
           res.stub(:status).and_return(200)
           res.should_receive(:content).and_return("invalid JSON format string")
           HTTPClient.any_instance.should_receive(:post).and_return(res)
@@ -118,4 +144,44 @@ describe Libgss::Network do
     # end
   end
 
+
+  describe "load_app_garden" do
+    it "without filepath" do
+      network.consumer_secret = nil
+      network.platform = nil
+      Dir.chdir(File.expand_path("../../../fontana_sample", __FILE__)) do
+        network.load_app_garden
+      end
+      network.consumer_secret.should_not be_nil
+      network.platform.should be_nil
+    end
+
+    it "with filepath" do
+      network.consumer_secret = nil
+      network.platform = "fontana"
+      network.load_app_garden(File.expand_path("../../../fontana_sample/config/app_garden.yml", __FILE__))
+      network.consumer_secret.should_not be_nil
+      network.platform.should == "fontana"
+    end
+  end
+
+  describe "generate_device_id" do
+    let(:generated){ UUID.new.generate }
+
+    before do
+      network.uuid_gen.should_receive(:generate).and_return(generated)
+      network.player_info.should == {}
+    end
+
+    it "without options" do
+      network.generate_device_id
+      network.player_info.should == {device_type: 1, device_id: generated}
+    end
+
+    it "with device_type" do
+      network.generate_device_id(device_type: 2)
+      network.player_info.should == {device_type: 2, device_id: generated}
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: libgss
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - akima
@@ -53,13 +53,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: tengine_support
+  name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: httpclient
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: oauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -95,7 +95,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: oauth
+  name: tengine_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: uuid
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -195,3 +209,4 @@ test_files:
 - spec/protected_assets/Icon.png
 - spec/public_assets/Default.png
 - spec/spec_helper.rb
+has_rdoc: