gameworks 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10a8ee8b5768eec3e315cf623d160995d9b321c7
-  data.tar.gz: 12daacb5259d91a5b299c1289c2ebfc77981a46c
+  metadata.gz: 01d5ecb9664001e09d3f01c6c77d9a12f9547576
+  data.tar.gz: 9f62c669b47d6259e171ed8ad064dc472dfb40fa
 SHA512:
-  metadata.gz: b606bae8289aef66caf94c308b27a94cfeb02f1bb999d4a8e91b93cea38061cee95be9b3a880a368f25526a054a7c5efae6147847a726f01735a122bd67eff17
-  data.tar.gz: 41cb36e64d04fb488324834bdba461a2eda9de821b8d3fe8b0dc8d847143d27881bfdfc669ed615a7c06446eede468827a1afe7ecfc027ee0e33b7b2cb7697a0
+  metadata.gz: 659f986391dbd3b06b6bec347bdca19594faa67449e09b330d7035694a62ecf0c1766400ef4e9e7bed5819a71a34a4277544f54d19c7e8f9cc05260204dc3050
+  data.tar.gz: 395bad2789fcbe1590770df68eeee522341bd12ecf2515b43ae1f3cc511f0a14d9d21fdcadb0ce686f1baec99196b60d51e8a2ed79b68687f20c77e012703c4a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gameworks (1.0.1)
+    gameworks (2.1.0)
       eventmachine (~> 1.0, >= 1.0.7)
       json (~> 1.8, >= 1.8.3)
       rake (~> 10.0)
@@ -12,7 +12,7 @@ GEM
   specs:
     daemons (1.2.3)
     diff-lcs (1.2.5)
-    eventmachine (1.0.7)
+    eventmachine (1.0.8)
     json (1.8.3)
     rack (1.6.4)
     rake (10.4.2)
@@ -20,15 +20,15 @@ GEM
       rspec-core (~> 3.3.0)
       rspec-expectations (~> 3.3.0)
       rspec-mocks (~> 3.3.0)
-    rspec-core (3.3.1)
+    rspec-core (3.3.2)
       rspec-support (~> 3.3.0)
     rspec-eventmachine (0.2.0)
       eventmachine (>= 0.12.0)
       rspec (>= 2.0, < 4.0)
-    rspec-expectations (3.3.0)
+    rspec-expectations (3.3.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.3.0)
-    rspec-mocks (3.3.1)
+    rspec-mocks (3.3.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
@@ -47,4 +47,4 @@ DEPENDENCIES
   rspec-eventmachine (~> 0.2)
 
 BUNDLED WITH
-   1.10.5
+   1.10.6

data/{README → README.md}

@@ -1,48 +1,119 @@
-= Quick start server
+# Gameworks
 
-Install required gems and run server:
-bundle install
-bundle exec thin start
+## About
 
-To run specs:
-bundle exec spec spec
+Gameworks is a framework for creating turn-based games hosted by a server, that
+can be interacted with via an API.  At Instructure, we use it to create games
+for the final round of our coding competition: Mebipenny.
 
-(You will probably already have the gems installed so you probably don't need the 'bundle exec')
-All request and response payloads are serialized JSON data.
+## Installation
 
-= DATA TYPES
+Add `gem 'gameworks'` to your Gemfile, or install manually with `gem install gameworks`
 
-== New Player (request)
+## Usage
 
-  {name: <string>}
+You will create classes to extend this engine, and then be able to interact
+with the game via an API.  Let's go over how all that works.
+
+### Implementation
+
+At minimum, you'll need a 3 files, that will look something like the following:
+
+`config.ru`:
+```ruby
+#!ruby
+
+require_relative 'your_game/server'
+use Rack::CommonLogger
+
+# Override Lint middleware to handle async callback (-1 http response)
+module Rack
+  class Lint
+    def call(env = nil)
+      @app.call(env)
+    end
+  end
+end
+
+run YourGame::Server.new
+```
+
+`your_game/server.rb`:
+```ruby
+require 'gameworks'
+require_relative 'game'
+
+module YourGame
+  class Server < Gameworks::Server
+    def game_class
+      YourGame::Game
+    end
+  end
+end
+```
+
+`your_game/game.rb`:
+```ruby
+require 'gameworks'
+
+module YourGame
+  class Game < Gameworks::Game
+    # you're reached player capacity
+    def full?
+    end
+
+    # an array of players currently taking a turn
+    def active_players
+    end
+
+    # given a json payload, create a move object
+    def build_move(payload, player)
+    end
+
+    # given a move object, is it legal
+    def move_legal?(move, player)
+    end
 
-name of the new player. the game engine may extend this.
+    # given a lecal move, apply it
+    def process_move(move, player)
+    end
+  end
+end
+```
 
-== Player (response)
+### API Data Types
 
+The following are the default request/response data.  You game implementation
+may extend any/all of these.
+
+#### New Player (request)
+
+```
+  {name: <string>}
+```
+
+#### Player (response)
+
+```
   {name: <string>,
    score: <integer>,
    disqualified: <boolean>}
+```
 
-name, current score, and disqualified status of the player. the game engine may
-extend this.
-
-== New Game (request)
+#### New Game (request)
 
-determined by the game engine
+Nothing by default, determined by your game implementation.
 
-== Game (response)
+#### Game (response)
 
+```
   {players: [<Player>*],
    state: <Game State>}
+```
 
 players is the set of Players joined to the game.
 
-state is the current Game State.
-
-the game engine may extend this.
-
-== Game Delta (response)
+#### Game Delta (response)
 
   {players: [<Player>*],
    state: <Game State>}
@@ -50,29 +121,27 @@ the game engine may extend this.
 players is the set of Players whose scores have changed since the request
 began.
 
-state is the current Game State.
-
-the game engine may extend this.
-
-== Game State (response)
+#### Game State (response)
 
   'initiating', 'in play', or 'completed'
 
 See descriptions of game states below.
 
-== New Move (request)
+#### New Move (request)
 
-determined by the game engine.
+Nothing by default, determined by your game implementation.
 
-= STARTING A GAME
+### Using the API
+
+#### Starting a Game
 
 To spawn a new game on the server, POST to / with a New Game object as payload.
 You will receive a 201 Created response with the game's root path (henceforth
 <game path>) in the Location HTTP response header.
 
-= GAME STATES
+#### Game States
 
-== INITIATING
+##### Initiating
 
 The game begins in this state. You join a game by POSTing to
 <game path>/players with a Player object as payload.
@@ -87,7 +156,7 @@ longer be joined.
 
 Once the game is full the game moves to the in play state.
 
-== IN PLAY
+##### In Play
 
 In this state, players POST to <game path>/moves with Line objects as payload.
 These requests must include an X-Turn-Token HTTP request header with the value
@@ -110,17 +179,17 @@ After a 200 OK response, the game may have moved to the completed state. This
 state change will be indicated in the Game Delta object. Once the game is
 completed, further moves are ignored with a 410 Gone response.
 
-== COMPLETED
+##### Completed
 
 Play is complete. Game state can still be pulled, but no new POSTs are
 accepted.
 
-= IDEMPOTENT VIEW
+#### Idempotent View
 
 At any point, the full game state can be requested with a GET request to
 <game path>. You will receive an immediate 200 OK response with a Game object.
 
-= OBSERVERS
+#### Observers (v1)
 
 (Intended for use by game viewer, but may be used by others.)
 
@@ -142,7 +211,11 @@ replacing the first %s. For instance, a HTML comet technique:
 
     { "wrapper": "<script type='text/javascript'>myUpdater(%s);</script>\n" }
 
-= MATCHMAKING
+#### Observers (v2)
+
+TODO: notes about push
+
+#### Matchmaking
 
 When you have a bot you'd like to try against others, but you don't want to set
 up a game yourself and you don't care who your opponent is, you can connect

data/lib/gameworks/notifier.rb

@@ -11,11 +11,12 @@ module Gameworks
 
       uri = URI(build_url(game))
       req = Net::HTTP::Post.new(uri)
+      ssl = uri.scheme == 'https'
 
       req.basic_auth(key, secret)
       req.body = body
       req["Content-Type"] = "application/json"
-      Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+      Net::HTTP.start(uri.hostname, uri.port, use_ssl: ssl) do |http|
         http.request(req)
       end
     end

data/lib/gameworks/version.rb

@@ -1,3 +1,3 @@
 module Gameworks
-  VERSION = "2.1.0"
+  VERSION = "2.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gameworks
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Brian Palmer
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-14 00:00:00.000000000 Z
+date: 2015-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -150,11 +150,10 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - Gemfile.lock
-- README
+- README.md
 - Rakefile
 - bin/console
 - bin/setup
-- build.sh
 - gameworks.gemspec
 - lib/gameworks.rb
 - lib/gameworks/fuse.rb
@@ -192,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: A game framework

data/build.sh

@@ -1,8 +0,0 @@
-#! /bin/bash
-. ~/.bash_profile
-export COVERAGE=1
-rvm use ruby-2.1.5 2>/dev/null || :
-
-gem install bundler
-bundle install
-bundle exec rspec