neofugo_client 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae350873d6d5289db3b32e6c9bbd9dc615ffc905
+  data.tar.gz: e80a24c7aa733414d00576795501ab2f584d59a8
+SHA512:
+  metadata.gz: 28f61bf81eb23d697e15d3ed4537e318fc0cb1af0b6e158b1843708cee9efcddac94a33b61cbaa731ce681d20c17f909e896893740f3061c03f9005714d3f342
+  data.tar.gz: 7c81ccf07552993f5fceb017a8c247e12d3942d46ccc4d11d39de92bc9c96b10cc5648416219cb476e7f9eebf6c5aa10981e50a506adb0f2462e4be264c44e43

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendors

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in neofugo_client.gemspec
+gemspec

data/README.md

@@ -0,0 +1,130 @@
+# NeofugoClient
+
+[株式会社ネオジニア](http://www.neogenia.co.jp)のサービス「[ネオ富豪](http://neof5.neogenia.co.jp)」にRubyプログラムから参加するのを簡略化するgemです。
+
+## インストール
+下記コマンドでgemをインストールします。
+
+    $ gem install neofugo_client
+
+## サンプル
+
+sampleディレクトリに、ただ単純に手札を出すだけのサンプルクライアントを置いています。
+
+## 前提
+ネオ富豪はサーバとWebSocketを使用して通信します。
+通信内容の仕様は公式サイトの[プログラム仕様](http://neof5.neogenia.co.jp/spec/)を確認してください。
+
+ごく簡単に説明すると
+- サーバと接続する
+- サーバから各種情報を受信する
+- 受信した内容から自分の出す札を決定する
+- 決定した札をサーバに送信する
+
+を繰り返します。この内、
+
+- 受信した内容から自分の出す札を決定する
+
+*以外*の部分をこのライブラリがサポートし、何を出すかの部分だけを実装すると
+ネオ富豪のクライアントとして動作するようになります。
+
+#### ネオ富豪サーバからのメッセージ概要
+
+サーバからは以下のようなメッセージが送信されます。
+
+```js
+{
+    "YourNum":0,                                // 受信者の番号（接続順に0から振られます）
+    "Kind":"ProcessTurn",                       // ゲーム内で起こったイベントの種類
+    "Teban":0,                                  // 現在の手番（プレイヤー番号）
+    "IsKakumei":false,                          // 革命中かどうか
+    "PlayerInfo":[                              // 対戦中のプレイヤーの情報
+        {"Name":"ExampleProgram","HavingCardCount":11,"Ranking":0,"OrderOfFinish":0},
+        {"Name":"COM1","HavingCardCount":11,"Ranking":0,"OrderOfFinish":0},
+        {"Name":"COM2","HavingCardCount":10,"Ranking":0,"OrderOfFinish":0},
+        {"Name":"COM3","HavingCardCount":9,"Ranking":0,"OrderOfFinish":0},
+        {"Name":"COM4","HavingCardCount":9,"Ranking":0,"OrderOfFinish":0}],
+    "Deck":"D3 H3 D4 S7 H9 D0 SJ CQ SQ DA JK",   // 現在の手札（1枚のカードを2文字で表します）
+    "Ba":["S3","D5","S6"],                       // 場に出ているカード
+    "Yama":"",                                   // 山にあるカード（流れたカード）
+    "History":["2-[S3]","3-[D5]","4-[S6]"]       // ゲームの初手から現在局面までの手の全履歴
+}
+```
+
+この中で`Kind`の値が`ProcessTurn`の場合、「あなた」の手番が回ってきたことになるので、
+このメッセージを受信したときに出す手を決めてサーバに返すとゲームが進行していきます。
+
+#### NeofugoClient概要
+NeofugoClientは
+
+- サーバと指定した部屋（練習用の部屋、本番勝負用の部屋などがあります）にアクセスし、メッセージを送受信する部分
+- 「あなた」のロジックを実装する部分
+
+に分かれています。
+上記で「`Kind`の値が`ProcessTrun`の場合」と書きましたが、そのあたりはライブラリ側が処理するので、
+実際に実装するのは`Strategy`クラスを継承したの特定のメソッドのみになります。
+`Strategy`クラスを継承すると予めサーバからのメッセージの`Kind`に対応したメソッドが定義されているので、
+その中で反応したいメッセージに対応するメソッドのみオーバーライドしてロジックを完成させてください。
+
+#### 最小限のサンプル
+基本的には`Kind=PorcessTrun`に反応すれば良いため対応する`on_process_turn`をオーバーライドします。
+また選んだカードを送信するには、(これもネオ富豪のメッセージに変換されますが)`put()`で出すカードを指定します。
+
+```ruby
+require "neofugo_client"
+
+class MyStrategy < NeofugoClient::Strategy
+  def on_process_turn(m)
+    cards = your_comprelex_daifugo_logic(m)
+    puts(cards)
+  end
+end
+```
+
+引数の`m`は先程載せたメッセージの`json`データをRubyのオブジェクトに変換したものです。
+
+- メッセージ全体は`Message`クラスに該当します
+- メッセージ直下にあるプロパティはプロパティー名をスネークケースにしたインスタンス変数として保持しています。例) `YourNum` => @your_num
+- `@player_info`は`PlayerInfo`クラスの配列です。
+- `@deck`は`Card`クラスの配列です。
+- `@ba`は`Card`クラスの配列の配列です。
+- `@yama`は`Card`クラスの配列です。
+- `@history`は`History`クラスの配列です。
+
+この内、最もロジックに関連する変数は`ba`(今現在場に出ているカード)と`deck`(今あなたが持っているカード)です。
+どちらも`Card`クラスが元になっているため、`Card`クラスの概要を下記に記載します。
+メッセージ上カードがどう表されるかは公式サイトを参照してください。
+このライブラリ上では`Card`クラスは３つのプロパティで表現されます。
+
+```ruby
+class Card
+  def initialize
+    @type #カードの種類を表す文字列です。クラブ: C, ハート: H, ダイヤ: D, スペード: S, ただしJokerの場合JKです。
+    @mark #カードに書かれている数字です。A, 2, 3, 4, ... J, Q, K。ただしJokerの場合`nil`です。
+    @value #革命時でない場合のカードの強さを表します。3から順に, 0, 1, 2, 3, 4, 5
+  end
+end
+```
+
+この`Card`クラスのインスタンスが`ba`, `deck`を構成しています。
+`deck`は単純に今「あなた」が持っている`Card`の配列です。
+
+`ba`は今場に出ているカードの状態です。流れた場合は`[]`配列です。
+`ba`については１回に複数枚出すパターンがありえるので、「`Card`の配列の配列」で保持しています。
+
+ - カードが１枚ずつ３人から`c1, c2, c3`の順で出された
+ 
+   `ba = [[c1], [c2], [c3]]`
+
+ - カードが２枚ずつ二人から`(c1-1, c1-2), (c2-1, c2-2)`の順で出された
+
+   `ba = [[c1-1, c1-2], [c2-1, c2-2]]`
+
+という形で取得できます。直接的には最後の手順に対して出せる札が決まるので最後の要素を解析して出す札を決めてください。
+
+#### その他
+ネオ富豪のメッセージは、常に最新のメッセージ一つの中に今までのゲームの状態を取得するための情報をすべて保持しているため
+上記までで説明していない変数などを利用して有利なロジックを考えてみてください。
+例えば、今までに出された札(`history`)と自分が今持っているカード(`deck`)を解析すれば、少なくともこのカードはもう
+自分しか持っていないはず、などが推測出来ると思います。
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/neofugo_client.rb

@@ -0,0 +1,91 @@
+require 'json'
+
+require 'websocket-client-simple'
+
+require "neofugo_client/version"
+require 'neofugo_client/util/util'
+require 'neofugo_client/base'
+require 'neofugo_client/test_connection'
+require 'neofugo_client/test_rule_test'
+require 'neofugo_client/test_practice'
+require 'neofugo_client/strategy'
+
+module NeofugoClient
+  class PlayerInfo
+    attr_accessor :name, :having_card_count, :ranking, :order_of_finish
+
+    def to_s
+      inspect
+    end
+
+    def inspect
+      "(Player name:r#{@name}, having_card_count: #{@having_card_count}, ranking: #{@ranking}, order_of_finish: #{@order_of_finish})"
+    end
+  end
+
+  class Message
+    attr_accessor :your_num, :kind, :teban, :is_kakumei, :player_info, :deck, :ba, :yama, :history, :message
+    def inspect
+      "(your_num: #{@your_num}, kind: #{@kind}, teban: #{@teban}, is_kakumei: #{@is_kakumei}, player_info: #{@player_info}, deck: #{@deck}, ba: #{@ba}, yama: #{@yama}, history: #{@history}, message: #{@message})"
+    end
+  end
+
+  class Card
+    MARK_TO_VALUE = {
+      '3' => 0,
+      '4' => 1,
+      '5' => 2,
+      '6' => 3,
+      '7' => 4,
+      '8' => 5,
+      '9' => 6,
+      '0' => 7,
+      'J' => 8,
+      'Q' => 9,
+      'K' => 10,
+      'A' => 11,
+      '2' => 12,
+      'JK' => 13
+    }
+    attr_accessor :type, :mark, :value
+
+    def to_card_string
+      [@type, @mark].join
+    end
+
+    def to_s
+      inspect
+    end
+
+    def inspect
+      [@type, @mark, ["(", @value, ")"].join].join
+    end
+
+    class << self
+      def to_card(e)
+        c = Card.new
+        if e == 'JK'
+          c.type = 'JK'
+          c.mark = nil
+          c.value = MARK_TO_VALUE['JK']
+        else
+          c.type = e[0]
+          c.mark = e[1]
+          #p [:mark_to_value, e[1], MARK_TO_VALUE[e[1]], MARK_TO_VALUE]
+          c.value = MARK_TO_VALUE[e[1]]
+        end
+        c
+      end
+    end
+  end
+
+  class History
+    attr_accessor :player_num, :action, :cards
+    def to_s
+      inspect
+    end
+    def inspect
+      "(Hist player_num: #{@player_num}, action: #{@action}, cards: #{@cards})"
+    end
+  end
+end

data/lib/neofugo_client/base.rb

@@ -0,0 +1,145 @@
+module NeofugoClient
+  using Util::StringEx
+  class Base
+    class << self
+      def create(opts={})
+        client = self.new(opts)
+        yield client
+        client
+      end
+    end
+
+    attr_accessor :host, :port, :verbose, :strategy_class
+    def initialize(opts = {})
+      @host = opts['host'] || 'neof5master.azurewebsites.net'
+      @port = opts['port'] || 80
+      @ws_handler = nil
+      @finished = false
+    end
+
+    def run()
+      @ws = WebSocket::Client::Simple.connect(build_url)
+      @strategy = @strategy_class.new(@ws)
+      handle
+
+      loop do
+        if @finished
+          @ws.close
+          break
+        end
+      end
+    end
+
+    def handle
+      this = self
+      ws = @ws
+      ws.on :message do |msg|
+        if msg.data == 'ping'
+          ws.send(nil, :type => :pong)
+        else
+          this.on_message(msg)
+        end
+      end
+
+      ws.on :open do
+        this.on_open
+      end
+
+      ws.on :close do |e|
+        this.on_close(e)
+      end
+
+      ws.on :error do |e|
+        this.on_error(e)
+      end
+    end
+
+    def on_open()
+    end
+
+    def on_close(e)
+    end
+
+    def on_error(e)
+    end
+
+    def on_message(msg)
+      begin
+        obj = parse_message(msg)
+        dispatch_by_kind(obj)
+      rescue => e
+        STDERR.puts e
+        STDERR.puts e.backtrace.join("\n")
+      end
+    end
+
+    def build_base_websocket_url()
+      "ws://#{@host}:#{@port}"
+    end
+
+    def list_to_card_list(card_list_string)
+      card_list_string.split(/ /).map {|e|
+        Card.to_card(e)
+      }
+    end
+
+    def dispatch_by_kind(obj)
+      result = @strategy.send("on_" + obj.kind.pascal_to_snake, obj)
+      if obj.kind == "Finish"
+        @finished = true
+      end
+    end
+
+    def parse_message(msg)
+      begin
+        j = JSON.parse(msg.data)
+
+        m = Message.new
+        m.kind = j['Kind']
+        if %w(Tweet Exception).include?(j['Kind'])
+          m.message = j['Message']
+          return m
+        end
+
+        m.your_num = j["YourNum"]
+        m.teban = j['Teban']
+        m.is_kakumei = j['IsKakumei']
+        m.player_info = j['PlayerInfo'].map {|e|
+          pi = PlayerInfo.new
+          pi.name = e['Name']
+          pi.having_card_count = e['HavingCardCount']
+          pi.ranking = e['Ranking']
+          pi.order_of_finish = e['OrderOfFinish']
+          pi
+        }
+        m.deck = list_to_card_list(j['Deck'])
+        #p [:ba_raw, j['Ba']]
+        m.ba = j['Ba'].map{|e| list_to_card_list(e)}
+        m.yama = j['Yama']
+        m.history = j['History'].map {|e|
+          a = History.new
+          if e[0] == '/'
+            a.action = :nagare
+          else
+            a.player_num = e[0].to_i
+            if e[2] == 'P'
+              a.action = :pass
+            elsif e[2] == 'A'
+              a.action = :agari
+            else
+              a.action = :player_action
+            end
+            if /\[([^\]]+)\]/ =~ e
+              a.cards = list_to_card_list(Regexp.last_match(1))
+            end
+          end
+          a
+        }
+        m
+      rescue => e
+        p e
+      end
+    end
+  end
+end
+

data/lib/neofugo_client/strategy.rb

@@ -0,0 +1,62 @@
+module NeofugoClient
+  class Strategy
+    def initialize(ws)
+      @ws = ws
+    end
+
+    def put(cards)
+      json = {
+        "Kind": "Put",
+        "Cards": cards.map(&:to_card_string).join(" ")
+      }.to_json
+      puts "put -----------------------------------"
+      p json
+      @ws.send(json)
+    end
+
+    def tweet(msg)
+      @ws.send({
+        "Kind": "Tweet",
+        "Message": msg
+      }.to_json)
+    end
+
+    def on_start(m)
+    end
+
+    def on_card_distributed(m)
+    end
+
+    def on_card_swapped(m)
+    end
+
+    def on_thinking(m)
+    end
+
+    def on_process_turn(m)
+    end
+
+    def on_cards_are_put(m)
+    end
+
+    def on_kakumei(m)
+    end
+
+    def on_nagare(m)
+    end
+
+    def on_agari(m)
+    end
+
+    def on_finish(m)
+    end
+
+    def on_tweet(m)
+    end
+
+    def on_exception(m)
+      puts "exception -------------------------------------------------------"
+      p m
+    end
+  end
+end

data/lib/neofugo_client/test_connection.rb

@@ -0,0 +1,13 @@
+module NeofugoClient
+  class TestConnection < Base
+    attr_accessor :name
+    def initialize(opts = {})
+      super(opts)
+    end
+
+    def build_url()
+      build_base_websocket_url + "/test/connection?name=#{@name}"
+    end
+  end
+end
+

data/lib/neofugo_client/test_practice.rb

@@ -0,0 +1,13 @@
+module NeofugoClient
+  class TestPractice < Base
+    attr_accessor :name, :room_id
+    def initialize(opts = {})
+      super(opts)
+    end
+
+    def build_url()
+      build_base_websocket_url + "/test/practice/#{@room_id}?name=#{@name}"
+    end
+  end
+end
+

data/lib/neofugo_client/test_rule_test.rb

@@ -0,0 +1,13 @@
+module NeofugoClient
+  class TestRuleTest < Base
+    attr_accessor :name, :room_id
+    def initialize(opts = {})
+      super(opts)
+    end
+
+    def build_url()
+      build_base_websocket_url + "/test/ruletest/#{@room_id}?name=#{@name}"
+    end
+  end
+end
+

data/lib/neofugo_client/util/util.rb

@@ -0,0 +1,11 @@
+module NeofugoClient
+  module Util
+    module StringEx
+      refine String do
+        def pascal_to_snake
+          self.scan(/[A-Z][^A-Z]+/).map(&:downcase).join("_")
+        end
+      end
+    end
+  end
+end

data/lib/neofugo_client/version.rb

@@ -0,0 +1,3 @@
+module NeofugoClient
+  VERSION = "0.1.1"
+end

data/neofugo_client.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'neofugo_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "neofugo_client"
+  spec.version       = NeofugoClient::VERSION
+  spec.authors       = ["pocari"]
+  spec.email         = ["caffelattenonsugar@gmail.com"]
+
+  spec.summary       = %q{Neofugo client by ruby}
+  spec.description   = %q{This library can implement Neofugo Client easy.}
+  spec.homepage      = "https://github.com/pocari"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "websocket-client-simple", "~> 0.2.2"
+end

data/sample/neofugo_client_sample.rb

@@ -0,0 +1,75 @@
+$:.unshift File.expand_path '../lib', File.dirname(__FILE__)
+require "neofugo_client"
+
+require 'open-uri'
+
+def get_new_room_id
+  str = open('http://neof5master.azurewebsites.net/playroom/practice/B').read
+  if /<pre>(.*)<\/pre>/ =~ str
+    ws_url = Regexp.last_match(1)
+    if /(P\d+)/ =~ ws_url
+      Regexp.last_match(1)
+    end
+  end
+end
+
+class MyStrategy < NeofugoClient::Strategy
+  def on_start(m)
+    puts "start----------------------------------------"
+    tweet("よろしくお願いします")
+  end
+
+  def on_finish(m)
+    puts "finish----------------------------------------"
+    p m
+    tweet("お疲れ様でした")
+  end
+
+  def build_pattern(deck, n)
+    deck.chunk{|e|
+      e.value
+    }.select {|e, ch|
+      ch.size >= n
+    }.map {|e, ch|
+      [e, ch.first(n)]
+    }
+  end
+
+  def on_process_turn(m)
+    puts "process trun --------------------------------------------------->"
+    p [:ba, m.ba]
+    p [:deck, m.deck]
+
+    last = m.ba.last
+    cards = nil
+    if !last
+      cards = 4.downto(1).map{|e| build_pattern(m.deck, e)}.find{|e| e.size > 0}.first[1]
+    else
+      pattern = build_pattern(m.deck, last.size)
+
+      n, cards = pattern.find {|e, ch|
+        if m.is_kakumei
+          last.first.value > e
+        else
+          last.first.value < e
+        end
+      }
+    end
+
+    p [:cards, cards]
+    tweet("action: #{cards}")
+    put(cards ? cards : [])
+  end
+end
+
+room_id = ARGV.shift || get_new_room_id
+client = NeofugoClient::TestPractice.create do |c|
+  c.verbose = true
+  c.name = 'Sample'
+  c.room_id = room_id
+  c.strategy_class = MyStrategy
+end
+
+puts "playroom id: #{room_id}"
+client.run
+

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: neofugo_client
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- pocari
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: websocket-client-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+description: This library can implement Neofugo Client easy.
+email:
+- caffelattenonsugar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/neofugo_client.rb
+- lib/neofugo_client/base.rb
+- lib/neofugo_client/strategy.rb
+- lib/neofugo_client/test_connection.rb
+- lib/neofugo_client/test_practice.rb
+- lib/neofugo_client/test_rule_test.rb
+- lib/neofugo_client/util/util.rb
+- lib/neofugo_client/version.rb
+- neofugo_client.gemspec
+- sample/neofugo_client_sample.rb
+homepage: https://github.com/pocari
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Neofugo client by ruby
+test_files: []