barker 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 984796895fe9bc71b1d2ce82ea679d7fe75f78ae
+  data.tar.gz: c987d3c1af4e2662bfd0b416610bfcb24426bc0f
+SHA512:
+  metadata.gz: 3c0da2c756ae07411f8a08151a6e733f88aedddd82d4015746cff8c08276a784da35769191fcf54b63ce69bb247384c9301fcb080d3798db22db6872d2206f9e
+  data.tar.gz: 64de935ceff6389621d30888bc389e4520f0212f800f42975cd395f35dad9d8726a638ed943b51d72f6aaf3a27ffca256d6912eaa3b3e5d66485ce0a2e5194ab

data/.gitignore

@@ -0,0 +1,3 @@
+*.swp
+pkg/
+tmp/

data/.ruby-gemset

@@ -0,0 +1 @@
+barker

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.simplecov

@@ -0,0 +1,7 @@
+require 'simplecov-rcov'
+
+SimpleCov.coverage_dir "tmp/coverage"
+SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter if ENV['CI']
+SimpleCov.start do
+  add_filter '/test/'
+end

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'simplecov',      '~> 0.6', :require => false, :group => :test
+gem 'simplecov-rcov', '~> 0.2', :require => false, :group => :test

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    barker (0.2.2)
+      activemodel
+      activesupport
+      thread_safe
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    atomic (1.1.10)
+    builder (3.0.4)
+    factory_girl (4.2.0)
+      activesupport (>= 3.0.0)
+    i18n (0.6.1)
+    metaclass (0.0.1)
+    minitest (5.0.2)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.7.3)
+    rack (1.5.2)
+    rake (10.0.4)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    simplecov-rcov (0.2.3)
+      simplecov (>= 0.4.1)
+    thread_safe (0.1.0)
+      atomic
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  barker!
+  factory_girl
+  minitest
+  mocha
+  rack
+  rake
+  simplecov (~> 0.6)
+  simplecov-rcov (~> 0.2)

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jan Owiesniak
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,204 @@
+# barker
+
+Barker game show engine.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'barker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install barker
+
+## Usage
+
+### Guidelines
+
+Barker let you define project specific guidelines that will be called during the game show life cycle.
+The default behaviour is implemented in Barker::Guideline::Base.
+
+Example of a project specific guideline.
+
+```ruby
+module Barker
+  module Guideline
+
+    class Llmcquiz < Base
+      include Errors
+
+      def quizzes
+        [Quiz.new(questions.sample(5))]
+      end
+
+      def jokers
+        [:fifty_fifty]
+      end
+
+      def questions
+        Barker::Import::Yaml.process(path)
+      end
+
+      def round_time
+        20
+      end
+
+      def path
+        File.expand_path "#{File.dirname(__FILE__)}/../../../lib/barker/guideline/llmcquiz/questions.yaml"
+      end
+    end
+
+  end
+end
+```
+
+### Api
+
+Only interact with the a api instance.
+Api calls always return a instance of Barker::Api::Response.
+
+Barker exceptions will not bubble up the stacktrace instead they will be caught in response.error.
+You can check for errors with the response.ok? method.
+
+```ruby
+class Response < OpenStruct
+  def ok?
+    !error
+  end
+end
+```
+
+#### Create a new game show
+
+The game show will automatically be stored in a memory store.
+
+```ruby
+api = Barker::Api::Base.new
+api.create # => <Barker::Api::Response game_show_id="1", candidate_ids=[], started_at=nil, finished_at=nil, aborted_at=nil, started?=false, running?=false, finished?=false, aborted?=false, jokers=[], stage=-1, round=-1>
+```
+
+You can pass a optional guideline
+
+```ruby
+api.create(:guideline => :llmcquiz) # => <Barker::Api::Response game_show_id="1", candidate_ids=[], started_at=nil, finished_at=nil, aborted_at=nil, started?=false, running?=false, finished?=false, aborted?=false, jokers=[:fifty_fifty], stage=-1, round=-1>
+```
+
+#### Add or remove candidates
+
+```ruby
+api = Barker::Api::Base.new
+game_show_id = api.create.game_show_id
+
+api.candidates(game_show_id) # => []
+api.join(game_show_id, 42, "de") # => <Barker::Api::Response candidate_id=42, locale="de", joined_at=2013-06-11 18:44:23 +0200, leaved_at=nil, aborted?=false, joined?=true, leaved?=false, jokers=[]>
+api.candidates(game_show_id) # => [<Barker::Api::Response candidate_id=42, locale="de", joined_at=2013-06-11 18:44:51 +0200, leaved_at=nil, aborted?=false, joined?=true, leaved?=false, jokers=[]>]
+api.leave(game_show_id, candidate_id) => #<Barker::Api::Response candidate_id=42, locale="de", joined_at=2013-06-11 18:45:46 +0200, leaved_at=2013-06-11 18:45:46 +0200, aborted?=false, joined?=true, leaved?=true, jokers=[]>
+api.candidates(game_show_id, candidate_id) => [#<Barker::Api::Response candidate_id=42, locale="de", joined_at=2013-06-11 18:45:46 +0200, leaved_at=2013-06-11 18:45:46 +0200, aborted?=false, joined?=true, leaved?=true, jokers=[]>]
+```
+
+#### Control
+
+##### Start
+
+```ruby
+api = Barker::Api::Base.new
+game_show_id = api.create.game_show_id
+
+api.start(game_show_id) # => <Barker::Api::Response game_show_id="1", candidate_ids=[], started_at=2013-06-11 18:51:41 +0200, finished_at=nil, aborted_at=nil, started?=true, running?=true, finished?=false, aborted?=false, jokers=[:fifty_fifty], stage=-1, round=-1>
+api.abort(game_show_id) # => <Barker::Api::Response game_show_id="1", candidate_ids=[], started_at=nil, finished_at=nil, aborted_at=2013-06-11 18:51:41 +0200, started?=false, running?=false, finished?=false, aborted?=true, jokers=[:fifty_fifty], stage=-1, round=-1>
+api.finish(game_show_id) # => <Barker::Api::Response game_show_id="1", candidate_ids=[], started_at=nil, finished_at=2013-06-11 18:51:41 +0200, aborted_at=nil, started?=false, running?=false, finished?=true, aborted?=false, jokers=[:fifty_fifty], stage=-1, round=-1>
+```
+
+##### Abort
+
+```ruby
+api = Barker::Api::Base.new
+game_show_id = api.create.game_show_id
+
+api.abort(game_show_id) # => <Barker::Api::Response game_show_id="1", candidate_ids=[], started_at=nil, finished_at=nil, aborted_at=2013-06-11 18:51:41 +0200, started?=false, running?=false, finished?=false, aborted?=true, jokers=[:fifty_fifty], stage=-1, round=-1>
+```
+
+##### Finish
+
+```ruby
+api = Barker::Api::Base.new
+game_show_id = api.create.game_show_id
+
+api.finish(game_show_id) # => <Barker::Api::Response game_show_id="1", candidate_ids=[], started_at=nil, finished_at=2013-06-11 18:51:41 +0200, aborted_at=nil, started?=false, running?=false, finished?=true, aborted?=false, jokers=[:fifty_fifty], stage=-1, round=-1>
+```
+
+##### Ask
+
+```ruby
+api = Barker::Api::Base.new
+game_show_id = api.create.game_show_id
+
+api.join(game_show_id, 42, "de")
+
+api.start(game_show_id)
+api.next_stage(game_show_id) # => <Barker::Api::Response game_show_id="1", candidate_ids=[42], started_at=2013-06-11 19:00:20 +0200, finished_at=nil, aborted_at=nil, started?=true, running?=true, finished?=false, aborted?=false, jokers=[:fifty_fifty], stage=0, round=-1>}
+api.next_round(game_show_id) # => <Barker::Api::Response game_show_id="1", candidate_ids=[42], started_at=2013-06-11 19:00:20 +0200, finished_at=nil, aborted_at=nil, started?=true, running?=true, finished?=false, aborted?=false, jokers=[:fifty_fifty], stage=0, round=0>}
+
+api.ask(game_show_id, 42) # => <Barker::Api::Response question_id=9, candidate_id=42, label="frage", state=:asked, asked_at=2013-06-11 19:02:52 +0200, answered_at=nil, asked?=true, answered?=false, open?=false, answers=[#<Barker::Api::Response answer_id=21, label="antwort", correct?=false, revealed?=false>, #<Barker::Api::Response answer_id=22, label="antwort", correct?=true, revealed?=false>
+```
+
+##### Answer
+
+```ruby
+api = Barker::Api::Base.new
+game_show_id = api.create.game_show_id
+
+api.join(game_show_id, 42, "de")
+
+api.start(game_show_id)
+api.next_stage(game_show_id)
+api.next_round(game_show_id)
+api.ask(game_show_id, 42)
+
+api.answer(game_show_id, 42, 25) # => <Barker::Api::Response answer_id=25, label="antwort", correct?=false, revealed?=false>
+api.given_answer(game_show_id, 25) # => <Barker::Api::Response answer_id=25, label="antwort", correct?=false, revealed?=false>
+```
+
+##### Joker
+
+```ruby
+api = Barker::Api::Base.new
+game_show_id = api.create.game_show_id
+
+api.join(game_show_id, 42, "de")
+
+api.start(game_show_id)
+api.next_stage(game_show_id)
+api.next_round(game_show_id)
+api.ask(game_show_id, 42)
+
+api.candidates(game_show_id) # => [<Barker::Api::Response candidate_id=42, locale="de", joined_at=2013-06-11 19:08:44 +0200, leaved_at=nil, aborted?=false, joined?=true, leaved?=false, jokers=[]>]
+api.joker(game_show_id) # => <Barker::Api::Response joker_id="fifty_fifty">
+api.candidates(game_show_id) # => [<Barker::Api::Response candidate_id=42, locale="de", joined_at=2013-06-11 19:08:44 +0200, leaved_at=nil, aborted?=false, joined?=true, leaved?=false, jokers=[:fifty_fifty]>]
+```
+
+### Store
+
+For now barker only support a memory store / repo.
+ActiveRecord will be supported sooner or later.
+
+### How to use in Rails
+
+Here is a very early concept how it could be used in a rails app.
+
+http://gitlab.neopoly.de/jo/barker/issues/19#note_23
+
+TODO: Add example with real api.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+   t.libs << "test"
+   t.test_files = FileList['test/**/*test.rb']
+   t.verbose = true
+end

data/barker.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'barker/version'
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jan Owiesniak"]
+  gem.email         = ["jo@neopoly.de"]
+  gem.description   = %q{barker}
+  gem.summary       = %q{barker}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "barker"
+  gem.require_paths = ["lib"]
+  gem.version       = Barker::VERSION
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rack"
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "factory_girl"
+  gem.add_development_dependency "mocha"
+
+  gem.add_dependency 'activesupport'
+  gem.add_dependency 'activemodel'
+  gem.add_dependency "thread_safe"
+end

data/ci/run

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+if [ "$WORKSPACE" = "" -o "$JOB_NAME" = "" ]; then
+  echo "\$WORKSPACE or \$JOB_NAME missing"
+  exit 1
+fi
+
+CI_DIR="$WORKSPACE/ci"
+ROOT_DIR="$CI_DIR/.."
+
+export CI=1
+export PROJECT="$JOB_NAME"
+export COVERAGE=1
+
+# RVM
+source "$HOME/.rvm/scripts/rvm"
+rvm use $(cat $ROOT_DIR/.ruby-version)@$(cat $ROOT_DIR/.ruby-gemset)
+
+# run
+bundle && bundle exec rake test

data/lib/barker/answer.rb

@@ -0,0 +1,11 @@
+module Barker
+  class Answer < Entity.new(:id, :label, :correct)
+
+    include Barker::Validations::NumericalityOfId
+
+    def correct?
+      correct
+    end
+
+  end
+end

data/lib/barker/api/base.rb

@@ -0,0 +1,145 @@
+module Barker
+  module Api
+    class Base
+
+      include Errors
+
+      def create(options = {})
+        catch_error do
+          game_show = Barker::GameShow.new([], [], :guideline => options[:guideline])
+          repo.add game_show
+          build_game_show(game_show)
+        end
+      end
+
+      def get(game_show_id)
+        catch_error do
+          build_game_show repo.get(game_show_id)
+        end
+      end
+
+      def remove(game_show_id)
+        catch_error do
+          build_game_show repo.remove(repo.get(game_show_id))
+        end
+      end
+
+      def join(game_show_id, candidate_id, candidate_locale)
+        catch_error do
+          candidate = Barker::Candidate.new(OpenStruct.new(:id => candidate_id, :locale => candidate_locale))
+          repo.around(game_show_id) { |game_show| game_show.join(candidate) }
+          build_candidate(candidate)
+        end
+      end
+
+      def leave(game_show_id, candidate_id)
+        catch_error do
+          game_show = repo.get game_show_id
+          candidate = game_show.leave(candidate_id)
+          repo.update game_show
+          build_candidate(candidate)
+        end
+      end
+
+      def start(game_show_id)
+        catch_error do
+          build_game_show repo.around(game_show_id) { |game_show| game_show.start }
+        end
+      end
+      
+      def raw(game_show_id)
+        catch_error do
+          repo.get(game_show_id)
+        end
+      end
+
+      def finish(game_show_id)
+        catch_error do
+          build_game_show repo.around(game_show_id) { |game_show| game_show.finish }
+        end
+      end
+
+      def abort(game_show_id)
+        catch_error do
+          build_game_show repo.around(game_show_id) { |game_show| game_show.abort }
+        end
+      end
+
+      def next_stage(game_show_id)
+        catch_error do
+          build_game_show repo.around(game_show_id) { |game_show| game_show.next_stage }
+        end
+      end
+
+      def next_round(game_show_id)
+        catch_error do
+          build_game_show repo.around(game_show_id) { |game_show| game_show.next_round }
+        end
+      end
+
+      def ask(game_show_id, candidate_id, options = {})
+        catch_error do
+          game_show = repo.get game_show_id
+          candidate_question = game_show.ask(candidate_id, options)
+          repo.update game_show
+          build_candidate_question(candidate_question)
+        end
+      end
+
+      def answer(game_show_id, candidate_id, answer_id)
+        catch_error do
+          game_show = repo.get game_show_id
+          given_answer = game_show.answer(candidate_id, answer_id)
+          repo.update game_show
+          build_candidate_answer(given_answer)
+        end
+      end
+
+      def joker(game_show_id, candidate_id, joker_id)
+        catch_error do
+          game_show = repo.get game_show_id
+          candidate_question = game_show.ask(candidate_id)
+          candidate_joker = game_show.joker(candidate_id, joker_id)
+          repo.update game_show
+          build_candidate_joker(candidate_joker)
+        end
+      end
+
+      private
+
+      def catch_error
+        begin
+          yield
+        rescue Barker::Errors::BarkerError => e
+          Response::Error.new(:error => e.class)
+        end
+      end
+
+      def repo
+        @repo ||= Barker::Repo::Memory::GameShow.new
+      end
+
+      def build_candidate_question(candidate_question)
+        Response::CandidateQuestion.new(:candidate_question => candidate_question)
+      end
+
+      def build_candidate_answer(candidate_answer)
+        Response::CandidateAnswer.new(:candidate_answer => candidate_answer)
+      end
+
+      def build_candidate(candidate)
+        Response::Candidate.new(:candidate => candidate)
+      end
+
+      def build_candidate_joker(candidate_joker)
+        Response::CandidateJoker.new(:candidate_joker => candidate_joker)
+      end
+
+      def build_game_show(game_show)
+        Response::GameShow.new(:game_show => game_show)
+      end
+
+    end
+
+  end
+end

data/lib/barker/api/response/base.rb

@@ -0,0 +1,25 @@
+require 'forwardable'
+
+module Barker
+  module Api
+    module Response
+
+      class Base < OpenStruct
+        def error?
+          !!error
+        end
+
+        def ok?
+          !error?
+        end
+
+        private
+
+        def to_i(attribute)
+          attribute && attribute.to_i
+        end
+      end
+
+    end
+  end
+end

data/lib/barker/api/response/candidate.rb

@@ -0,0 +1,38 @@
+module Barker
+  module Api
+    module Response
+      class Candidate < Base
+
+        extend Forwardable
+        def_delegators :candidate, :id, :candidate_id, :locale, :joined_at, :leaved_at, :aborted_at, :joined?, :leaved?, :aborted?
+
+        def jokers
+          candidate.jokers.map {|candidate_joker| Response::CandidateJoker.new(:candidate_joker => candidate_joker)}
+        end
+
+        def to_hash
+          {
+            'id'           => id,
+            'candidate_id' => candidate_id,
+            'locale'       => locale,
+            'jokers'       => jokers? && jokers.map(&:to_hash) || [],
+            'joker_ids'    => jokers? && jokers.map(&:joker_id) || [],
+            'joined_at'    => to_i(joined_at),
+            'leaved_at'    => to_i(leaved_at),
+            'aborted_at'   => to_i(aborted_at),
+            'joined?'      => joined?, 
+            'leaved?'      => leaved?,
+            'aborted?'     => aborted?
+          }
+        end
+
+        private
+
+        def jokers?
+          jokers && jokers.map(&:candidate_joker).any?
+        end
+
+      end
+    end
+  end
+end

data/lib/barker/api/response/candidate_answer.rb

@@ -0,0 +1,23 @@
+module Barker
+  module Api
+    module Response
+      class CandidateAnswer < Base
+
+        extend Forwardable
+        def_delegators :candidate_answer, :id, :answer_id, :candidate_id, :label, :revealed?, :correct?
+
+        def to_hash
+          {
+            'id'           => id,
+            'answer_id'    => answer_id,
+            'candidate_id' => candidate_id,
+            'label'        => label,
+            'revealed?'    => revealed?,
+            'correct?'     => correct?
+          }
+        end
+
+      end
+    end
+  end
+end

data/lib/barker/api/response/candidate_joker.rb

@@ -0,0 +1,21 @@
+module Barker
+  module Api
+    module Response
+      class CandidateJoker < Base
+
+        extend Forwardable
+        def_delegators :candidate_joker, :id, :joker_id, :candidate_id, :used_at
+
+        def to_hash
+          {
+            'id' => id,
+            'joker_id' => joker_id,
+            'candidate_id' => candidate_id,
+            'used_at' => to_i(used_at)
+          }
+        end
+
+      end
+    end
+  end
+end