API v2

Author: ysakasin

.rubocop.yml

@@ -5,24 +5,11 @@ AllCops:
     - "vendor/**/*"
 
 Metrics:
-  Exclude:
-    - "lib/bcdice_wrap.rb"
-    - "lib/bcdice_api/app.rb"
-
-Metrics/ClassLength:
-  Exclude:
-    - "test/**/*"
-
-Metrics/AbcSize:
   Exclude:
     - "test/**/*"
     - "lib/bcdice_wrap.rb"
     - "lib/bcdice_api/app.rb"
-
-Metrics/BlockLength:
-  Exclude:
-    - "test/**/*"
-    - "lib/bcdice_api/app.rb"
+    - "lib/bcdice_api/v2/app.rb"
 
 Lint/RaiseException:
   Enabled: true

Rakefile

@@ -12,6 +12,14 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
+namespace :test do
+  Rake::TestTask.new(:v2) do |t|
+    t.libs += ['lib']
+    t.test_files = ['test/test_api_v2.rb', 'test/test_dicebot_v2.rb']
+    t.verbose = true
+  end
+end
+
 RuboCop::RakeTask.new
 
 Rake::Task[:test].enhance do

lib/bcdice_api/app.rb

@@ -6,6 +6,8 @@
 require 'sinatra/reloader' if development?
 require 'exception'
 
+require_relative 'v2/app'
+
 module BCDiceAPI
   class App < Sinatra::Application
     class << self
@@ -20,6 +22,8 @@ class << self
       register Sinatra::Reloader
     end
 
+    use V2::App
+
     helpers Sinatra::Jsonp
 
     helpers do
@@ -48,10 +52,6 @@ def diceroll(system, command)
       end
     end
 
-    before do
-      response.headers['Access-Control-Allow-Origin'] = '*'
-    end
-
     get '/' do
       'Hello. This is BCDice-API.'
     end

lib/bcdice_api/v2/app.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'sinatra'
+require 'sinatra/base'
+require 'sinatra/jsonp'
+
+require 'sinatra/reloader' if development?
+
+require 'bcdice/user_defined_dice_table'
+
+module BCDiceAPI
+  module V2
+    class App < Sinatra::Base
+      class << self
+        attr_accessor :test_rands
+      end
+
+      before do
+        response.headers['Access-Control-Allow-Origin'] = '*'
+      end
+
+      helpers Sinatra::Jsonp
+
+      helpers do
+        def roll(id, command)
+          klass = BCDiceAPI::DICEBOTS[id]
+          raise UnsupportedDicebot if klass.nil?
+          raise CommandError if command.nil? || command.empty?
+
+          game_system = klass.new(command)
+          game_system.randomizer = RandomizerMock.new(App.test_rands) if App.test_rands
+
+          result = game_system.eval
+          raise CommandError if result.nil?
+
+          {
+            ok: true,
+            text: result.text,
+            secret: result.secret?,
+            success: result.success?,
+            failure: result.failure?,
+            critical: result.critical?,
+            fumble: result.fumble?,
+            rands: result.detailed_rands.map(&:to_h)
+          }
+        end
+      end
+
+      get '/v2/version' do
+        jsonp api: BCDiceAPI::VERSION, bcdice: BCDice::VERSION
+      end
+
+      get '/v2/admin' do
+        jsonp BCDiceAPI::ADMIN
+      end
+
+      get '/v2/game_system' do
+        game_system = BCDice.all_game_systems.sort_by { |game| game::SORT_KEY } .map do |game|
+          { id: game::ID, name: game::NAME, sort_key: game::SORT_KEY }
+        end
+
+        jsonp game_system: game_system
+      end
+
+      get '/v2/game_system/:id' do |id|
+        game_system = BCDice.game_system_class(id)
+        raise UnsupportedDicebot if game_system.nil?
+
+        ret = {
+          ok: true,
+          id: game_system::ID,
+          name: game_system::NAME,
+          sort_key: game_system::SORT_KEY,
+          command_pattern: game_system.command_pattern.source,
+          help_message: game_system::HELP_MESSAGE
+        }
+
+        jsonp ret
+      end
+
+      get '/v2/game_system/:id/roll' do |id|
+        jsonp roll(id, params[:command])
+      end
+
+      post '/v2/game_system/:id/roll' do |id|
+        jsonp roll(id, params[:command])
+      end
+
+      post '/v2/original_table' do
+        table = BCDice::UserDefinedDiceTable.new(params[:table])
+
+        jsonp text: params[:table]
+
+        ret = {
+          ok: true,
+          text: table.roll,
+          rands: table.randomizer.detailed_rand_results.map(&:to_h)
+        }
+
+        jsonp ret
+      end
+
+      error UnsupportedDicebot do
+        status 400
+        jsonp ok: false, reason: 'unsupported game system'
+      end
+
+      error CommandError do
+        status 400
+        jsonp ok: false, reason: 'unsupported command'
+      end
+    end
+  end
+end

test/test_api_v2.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+ENV['RACK_ENV'] = 'test'
+require 'test/unit'
+require 'rack/test'
+
+require 'cgi'
+
+require 'bcdice_api'
+
+class V2APITest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    BCDiceAPI::App
+  end
+
+  def test_version
+    get '/v2/version'
+    json = JSON.parse(last_response.body)
+
+    assert last_response.ok?
+    assert_equal '*', last_response.headers['Access-Control-Allow-Origin']
+    assert json.key?('bcdice')
+    assert json.key?('api')
+  end
+
+  def test_game_system_list
+    get '/v2/game_system'
+    json = JSON.parse(last_response.body)
+
+    assert       last_response.ok?
+    assert_false json['game_system'].empty?
+    assert_instance_of Array, json['game_system']
+
+    first = json['game_system'].first
+    assert first.key?('name')
+    assert first.key?('id')
+    assert first.key?('sort_key')
+  end
+
+  def test_game_system_info
+    get '/v2/game_system/DiceBot'
+    json = JSON.parse(last_response.body)
+
+    assert last_response.ok?
+    assert json['ok']
+    assert_equal json['id'], 'DiceBot'
+    assert_instance_of String, json['name']
+    assert_instance_of String, json['command_pattern']
+    assert_instance_of String, json['sort_key']
+    assert_instance_of String, json['help_message']
+    assert_false json['name'].empty?
+    assert_false json['command_pattern'].empty?
+    assert_false json['sort_key'].empty?
+
+    pend 'DiceBot::HELP_MESSAGE will be supported in BCDice v3'
+    assert_false json['help_message'].empty?
+  end
+
+  def test_diceroll
+    get '/v2/game_system/DiceBot/roll?command=1d100<=70'
+
+    json = JSON.parse(last_response.body)
+
+    assert last_response.ok?
+    assert json['ok']
+    assert json['text']
+    assert_false json['secret']
+    assert_boolean json['success']
+    assert_boolean json['failure']
+    assert_false json['critical']
+    assert_false json['fumble']
+    assert_instance_of Array, json['rands']
+  end
+
+  def test_diceroll_with_post
+    post '/v2/game_system/DiceBot/roll', { command: '1d100<=70' }
+
+    json = JSON.parse(last_response.body)
+
+    assert last_response.ok?
+    assert json['ok']
+    assert json['text']
+    assert_false json['secret']
+    assert_boolean json['success']
+    assert_boolean json['failure']
+    assert_false json['critical']
+    assert_false json['fumble']
+    assert_instance_of Array, json['rands']
+  end
+
+  def test_detailed
+    get '/v2/game_system/Cthulhu7th/roll?command=CC1'
+
+    json = JSON.parse(last_response.body)
+
+    assert last_response.ok?
+    assert json['ok']
+    assert_not_empty(json['rands'].select { |r| r['kind'] == 'tens_d10' })
+  end
+
+  def test_unexpected_game_system
+    get '/v2/game_system/Hoge/roll?command=1d100<=70'
+
+    json = JSON.parse(last_response.body)
+
+    assert last_response.bad_request?
+    assert_false json['ok']
+    assert_equal json['reason'], 'unsupported game system'
+  end
+
+  def test_unexpected_command
+    get '/v2/game_system/DiceBot/roll?command=a'
+
+    json = JSON.parse(last_response.body)
+
+    assert last_response.bad_request?
+    assert_false json['ok']
+    assert_equal json['reason'], 'unsupported command'
+  end
+
+  def test_no_command
+    get '/v2/game_system/DiceBot/roll'
+
+    json = JSON.parse(last_response.body)
+
+    assert last_response.bad_request?
+    assert_false json['ok']
+    assert_equal json['reason'], 'unsupported command'
+  end
+
+  def test_blank_command
+    get '/v2/game_system/DiceBot/roll?command='
+
+    json = JSON.parse(last_response.body)
+
+    assert last_response.bad_request?
+    assert_false json['ok']
+    assert_equal json['reason'], 'unsupported command'
+  end
+
+  def test_original_table
+    table_text = <<~TABLE
+      飲み物表
+      1D6
+      1:水
+      2:緑茶
+      3:麦茶
+      4:コーラ
+      5:オレンジジュース
+      6:選ばれし者の知的飲料
+    TABLE
+
+    post '/v2/original_table', { table: table_text }
+
+    json = JSON.parse(last_response.body)
+
+    assert last_response.ok?
+    assert_true json['ok']
+    assert_instance_of String, json['text']
+    assert_true json['text'].start_with?('飲み物表(')
+    assert_instance_of Array, json['rands']
+  end
+end