libgss 0.2.0 → 0.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDEzZGE2OTI5OGE3MDMzNTgxZjU2Zjg0ZmY4YzVlMDAzYzMwOGQzOA==
+    OTdkNjg4OGZmYTAzNDNjN2VjNTM4Mjg0NzIzOGU4MTMzODdjYzgxZQ==
   data.tar.gz: !binary |-
-    YjExOGRiOGM5NzlhNDNjNTNkMmRiODM4NDc5MTVhM2ExZjBkNzVhZQ==
+    OWY0MWFkMDNmMDEzZTlmMzY0NWI5NzJmMzRhZjU1ZmU3NWFkNDE2OQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZmU2NzFiYThmNDIzMTA0MDk4ODg1NDQzYmIzODYyN2I0MDI1ZmZhY2QzOGJi
-    YzkwMjY1NDkzNTI1NWIxNDAzYjg5Njc4NDYzOWY2OTdmMWJjYWQ2MWFlOWNk
-    M2Y1ODdkMjE3MzVhMjllNmViYzI0YTFhYWZkNmI1MjA3Zjc5MjQ=
+    ZDcyMzY2YWI4NDVmZWJjZTIzZTE2MTEzMWQyZDBmZTU2Mjk1OWQyZWJiYTdl
+    Yjc1MDljNzhmODkzYjUxYmVlYTlmMjFmOGI3MjIxYmFkZDQwNzI2MTQwZmFi
+    Zjk2MmM4NGQyZTk4MGE3NWZkNjVlNjU4OTlhMDlhMWJkYTE2YzI=
   data.tar.gz: !binary |-
-    Y2Y2NzE0MjEzMGU4MjcwMDc1Mzc4NTBkNTFlMTU5ZmNjOGMyOGRmMDU0Mzc1
-    ZDY3NTdmYjYyOGJhMmYzZjQ2OTNjMWM2NzM0ZjY3NWM3NDkwNjdmZjA1NTQ3
-    MjlhOTQ1MjBmODMxYjJhOGFiZjZlMWExMjNjZTM0MWY4NTM5NjE=
+    NTA5M2U4NWQ2ZDlhODI4ZTUyZjQyNzgyZGNmNzYyMGQ0ZWE1NmNhNzU5OTk5
+    M2M2MjM1MTljZmY2MGFkYzJkNGY2ZGYxNTllNjUxZjMxOWJjNzIwMjhkZWYz
+    NTlhZmU3NThmNDIwYmY3ZWY5MDQ4MWRiNWFhZDFkMGFkZDA4MmM=

data/lib/libgss/http_client_with_signature_key.rb

@@ -0,0 +1,132 @@
+# -*- coding: utf-8 -*-
+require 'libgss'
+
+require 'oauth'
+
+require 'digest/hmac'
+
+module Libgss
+  class HttpClientWithSignatureKey
+
+    attr_reader :impl, :network
+    def initialize(impl, network)
+      @impl, @network = impl, network
+    end
+
+    def post(uri, body, original_headers = {}, &block)
+      headers = {
+        "oauth_consumer_key" => network.consumer_key || "",
+        "oauth_token"        => network.auth_token,
+      }
+      oauth_params = {
+        "body" => body,
+        "oauth_signature_method" => "HMAC-SHA1"
+      }.update(headers)
+
+      req_hash = {
+        "method" => "POST",
+        "uri"    => uri,
+        "parameters" => oauth_params
+      }
+
+      options = {
+        :consumer_secret => network.consumer_secret,
+        :token_secret    => network.signature_key
+      }
+
+      signature_class = Libgss.use_oauth_gem ? ::OAuth::Signature : Signature
+      $stdout.puts("signature_class: #{signature_class.name}") if ENV["VERBOSE"]
+
+      headers["oauth_signature"] = signature_class.sign(req_hash, options)
+
+      res = @impl.post(uri, body, headers.update(original_headers))
+    end
+
+    class Signature
+      class << self
+        def sign(req_hash, options)
+          new(req_hash, options).sign
+        end
+      end
+
+      def initialize(req_hash, options)
+        @request, @options = req_hash, options
+      end
+
+      def sign
+        s = digest          # ダイジェストを計算
+        Base64.encode64(s). # BASE64でエンコード
+          chomp.        # 末尾から改行コード(\r or \n)を取り除いた文字列を返す
+          gsub(/\n/,'') # 改行を全て取り除く
+      end
+
+      def digest
+        s = signature_base_string # base_stringを計算
+        digest_class = ::Digest::SHA1 # http://doc.ruby-lang.org/ja/1.9.3/class/Digest=3a=3aSHA1.html
+
+        # digest_class.digest(s) # Digestクラスを使って計算
+
+        # http://doc.ruby-lang.org/ja/1.9.3/library/digest=2fhmac.html
+        # http://doc.ruby-lang.org/ja/1.9.3/class/Digest=3a=3aHMAC.html
+        ::Digest::HMAC.digest(s, secret, digest_class)
+      end
+
+      def signature_base_string
+        base = [
+          @request["method"],
+          normalized_uri,
+          normalized_parameters]
+        base.map { |v| escape(v) }.join("&")
+      end
+
+      def normalized_uri
+        u = URI.parse(@request["uri"])
+        "#{u.scheme.downcase}://#{u.host.downcase}#{(u.scheme.downcase == 'http' && u.port != 80) || (u.scheme.downcase == 'https' && u.port != 443) ? ":#{u.port}" : ""}#{(u.path && u.path != '') ? u.path : '/'}"
+      rescue
+        @request["uri"]
+      end
+
+      def normalized_parameters
+        normalize(parameters_for_signature)
+      end
+
+      def parameters_for_signature
+        parameters.reject { |k,v| k == "oauth_signature"}
+      end
+
+      def parameters
+        @request["parameters"]
+      end
+
+
+      def secret
+        "#{escape(@options[:consumer_secret])}&#{escape(@options[:token_secret])}"
+      end
+
+
+      RESERVED_CHARACTERS = /[^a-zA-Z0-9\-\.\_\~]/
+
+      def escape(value)
+        URI::escape(value.to_s, RESERVED_CHARACTERS)
+      rescue ArgumentError
+        URI::escape(value.to_s.force_encoding(Encoding::UTF_8), RESERVED_CHARACTERS)
+      end
+
+      def normalize(params)
+        params.sort.map do |k, values|
+
+          if values.is_a?(Array)
+            # multiple values were provided for a single key
+            values.sort.collect do |v|
+              [escape(k),escape(v)] * "="
+            end
+          else
+            [escape(k),escape(values)] * "="
+          end
+        end * "&"
+      end
+
+    end
+
+  end
+end

data/lib/libgss/network.rb

@@ -17,6 +17,9 @@ module Libgss
 
     attr_reader :auth_token, :signature_key
 
+    attr_accessor :consumer_secret
+    attr_accessor :consumer_key
+
     attr_accessor :api_version
     attr_accessor :platform
     attr_accessor :player_id
@@ -43,6 +46,10 @@ module Libgss
       end
       @ssl_base_url = @base_url if @ssl_disabled
       @platform = "fontana"
+
+      @consumer_secret = options[:consumer_secret] || ENV["CONSUMER_SECRET"]
+      @ignore_signature_key = !!options[:ignore_signature_key]
+
       @httpclient = HTTPClient.new
       @httpclient.ssl_config.verify_mode = nil # 自己署名の証明書をOKにする
     end
@@ -53,16 +60,10 @@ module Libgss
       r << fields.join(", ") << ">"
     end
 
-    def register
-      res = @httpclient.post(registration_url)
-      process_json_response(res) do |obj|
-        self.player_id = obj["player_id"].sub(/\Afontana:/, '')
-        !!self.player_id
-      end
-    end
-
-    def login
-      res = @httpclient.post(login_url, "player[id]" => player_id)
+    def login(extra = {})
+      attrs = { "player[id]" => player_id }
+      extra.each{|k, v| attrs[ "player[#{k}]" ] = v }
+      res = @httpclient.post(login_url, attrs)
       process_json_response(res) do |obj|
         @player_id ||= obj["player_id"]
         @auth_token = obj["auth_token"]
@@ -71,12 +72,17 @@ module Libgss
       end
     end
 
+    def ignore_signature_key?
+      @ignore_signature_key
+    end
+
     def setup
-      (load_player_id || register) && login
+      load_player_id
+      login
     end
 
     def new_action_request
-      ActionRequest.new(@httpclient, action_url)
+      ActionRequest.new(httpclient_for_action, action_url)
     end
 
     def new_public_asset_request(asset_path)
@@ -87,6 +93,12 @@ module Libgss
       AssetRequest.new(@httpclient, protected_asset_url(asset_path))
     end
 
+    def httpclient_for_action
+      @httpclient_for_action ||=
+        @ignore_signature_key ? @httpclient :
+        HttpClientWithSignatureKey.new(@httpclient, self)
+    end
+
     private
 
     # ストレージからplayer_idをロードします

data/lib/libgss/version.rb

@@ -1,3 +1,3 @@
 module Libgss
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/libgss.rb

@@ -6,6 +6,13 @@ module Libgss
   autoload :Action       , "libgss/action"
   autoload :ActionRequest, "libgss/action_request"
   autoload :Outputs      , "libgss/outputs"
+  autoload :HttpClientWithSignatureKey, "libgss/http_client_with_signature_key"
 
   autoload :AssetRequest , "libgss/asset_request"
+
+  class << self
+    attr_accessor :use_oauth_gem
+  end
+
+  self.use_oauth_gem = (ENV["USE_OAUTH_GEM"] =~ /\Atrue\Z|\Aon\Z/i)
 end

data/libgss.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "httpclient"
   spec.add_runtime_dependency "json"
+  spec.add_runtime_dependency "oauth"
 end

data/spec/libgss/action_request_spec.rb

@@ -7,8 +7,7 @@ describe Libgss::ActionRequest do
   end
 
   let(:network) do
-    network = Libgss::Network.new("http://localhost:3000")
-    network.player_id = "1000001"
+    network = new_network
     network.login.should == true
     network
   end

data/spec/libgss/actions/dictionary_spec.rb

@@ -3,11 +3,7 @@ require 'spec_helper'
 
 describe Libgss::ActionRequest do
 
-  let(:network) do
-    network = Libgss::Network.new("http://localhost:3000")
-    network.player_id = "1000001"
-    network
-  end
+  let(:network){ new_network }
 
   let(:request) do
     network.login

data/spec/libgss/actions/friendship_spec.rb

@@ -4,8 +4,7 @@ require 'spec_helper'
 describe "Libgss::ActionRequest friendship" do
 
   let(:network) do
-    network = Libgss::Network.new("http://localhost:3000")
-    network.player_id = "1000001"
+    network = new_network
     network.login
     network
   end

data/spec/libgss/actions/game_data_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 describe Libgss::ActionRequest do
 
   let(:network) do
-    network = Libgss::Network.new("http://localhost:3000")
+    network = new_network
     network.player_id = "1000001"
     network.login
     network

data/spec/libgss/actions/int_range_spec.rb

@@ -3,11 +3,7 @@ require 'spec_helper'
 
 describe Libgss::ActionRequest do
 
-  let(:network) do
-    network = Libgss::Network.new("http://localhost:3000")
-    network.player_id = "1000001"
-    network
-  end
+  let(:network){ new_network }
 
   let(:request) do
     network.login

data/spec/libgss/actions/log_spec.rb

@@ -3,11 +3,7 @@ require 'spec_helper'
 
 describe Libgss::ActionRequest do
 
-  let(:network) do
-    network = Libgss::Network.new("http://localhost:3000")
-    network.player_id = "1000001"
-    network
-  end
+  let(:network){ new_network }
 
   let(:request) do
     network.login

data/spec/libgss/actions/master_spec.rb

@@ -3,11 +3,7 @@ require 'spec_helper'
 
 describe Libgss::ActionRequest do
 
-  let(:network) do
-    network = Libgss::Network.new("http://localhost:3000")
-    network.player_id = "1000001"
-    network
-  end
+  let(:network){ new_network }
 
   let(:request) do
     network.login

data/spec/libgss/actions/probability_spec.rb

@@ -3,11 +3,7 @@ require 'spec_helper'
 
 describe Libgss::ActionRequest do
 
-  let(:network) do
-    network = Libgss::Network.new("http://localhost:3000")
-    network.player_id = "1000001"
-    network
-  end
+  let(:network){ new_network }
 
   let(:request) do
     network.login

data/spec/libgss/actions/ruby_stored_script_spec.rb

@@ -4,8 +4,7 @@ require 'spec_helper'
 describe Libgss::ActionRequest do
 
   let(:network) do
-    network = Libgss::Network.new("http://localhost:3000")
-    network.player_id = "1000001"
+    network = new_network
     network.login
     network
   end

data/spec/libgss/actions/schedule_spec.rb

@@ -3,11 +3,7 @@ require 'spec_helper'
 
 describe Libgss::ActionRequest do
 
-  let(:network) do
-    network = Libgss::Network.new("http://localhost:3000")
-    network.player_id = "1000001"
-    network
-  end
+  let(:network){ new_network }
 
   let(:request) do
     network.login

data/spec/libgss/asset_request_spec.rb

@@ -7,8 +7,7 @@ describe "Libgss::AssetRequest" do
   end
 
   let(:network) do
-    network = Libgss::Network.new("http://localhost:3000")
-    network.player_id = "1000001"
+    network = new_network
     network.public_asset_url_prefix = "http://localhost:3000/a/"
     network.login
     network

data/spec/libgss/network_spec.rb

@@ -6,17 +6,6 @@ describe Libgss::Network do
     Libgss::Network.new("http://localhost:3000")
   end
 
-  describe "#registration" do
-    context "valid" do
-      it do
-        network.player_id.should == nil
-        network.register
-        network.player_id.should_not == nil
-        network.player_id.should_not =~ /^fontana:/
-      end
-    end
-  end
-
   describe "#setup" do
     context "valid" do
       it do
@@ -25,7 +14,7 @@ describe Libgss::Network do
         network.signature_key.should == nil
         res = network.setup
         network.player_id.should_not == nil
-        network.player_id.should_not =~ /^fontana:/
+        network.player_id.should =~ /^fontana:/
         network.auth_token.should_not == nil
         network.signature_key.should_not == nil
         res.should == true

data/spec/spec_helper.rb

@@ -7,3 +7,11 @@ def request_fixture_load(fixture_name)
   c = HTTPClient.new
   c.post("http://localhost:3000/libgss_test/fixture_loadings/#{fixture_name}.json", "_method" => "put")
 end
+
+
+def new_network(url = "http://localhost:3000", player_id = "1000001")
+  network = Libgss::Network.new(url)
+  network.player_id = player_id
+  network.consumer_secret = "cpqomf5gs4ob6prd5w5zd52yg9du7150"
+  network
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libgss
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - akima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-31 00:00:00.000000000 Z
+date: 2013-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth
+  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'
 description: network library for Groovenauts GSS
 email:
 - t-akima@groovenauts.jp
@@ -100,6 +114,7 @@ files:
 - lib/libgss/action.rb
 - lib/libgss/action_request.rb
 - lib/libgss/asset_request.rb
+- lib/libgss/http_client_with_signature_key.rb
 - lib/libgss/network.rb
 - lib/libgss/outputs.rb
 - lib/libgss/version.rb