gamekey 0.0.1

data/Dockerfile

@@ -0,0 +1,13 @@
+FROM       ruby:2.2
+
+COPY       . /usr/src/app
+WORKDIR    /usr/src/app
+RUN        bundle install
+RUN        rake install
+
+VOLUME     ["/data/"]
+
+EXPOSE     8080
+
+ENTRYPOINT ["gamekey", "start"]
+CMD        ["--storage", "/data/gamekey.json"]

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Nane Kratzke
+
+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,133 @@
+# Gamekey
+
+A reference REST service to store game states. 
+This service is intended as a reference service used in Webtechnology Projects 
+at Lübeck University of Applied Sciences.
+
+## Installation via Docker (1st Option)
+
+The most easiest way to deploy the gamekey reference service is via Docker.
+You will find here [Docker](https://docs.docker.com/engine/installation/) installation instructions for various 
+operating systems.
+
+After installing docker you can fetch the latest gamekey image from Docker hub using this command.
+
+    docker pull transit/gamekey
+
+
+You can start the gamekey service like that
+
+    docker run -v $(pwd):/data -p 8080:8080 transit/gamekey
+    
+This will fire up a container with a running gamekey service on port 8080 on your host.
+Gamekey states will be stored in a gamekey.json file under your current working directory.
+(Only if you are using the volume option -v). You can have a look into your gamekey state via
+
+    cat gamekey.json
+    
+The docker installation provides only the server component in a handable manner.
+The intended usage of this provisioning method is to run this service as a central server component.
+
+## Installation via RubyGems (2nd Option)
+
+To interact with this gamekey service you need a client. Gamekey is providing a command line client via RubyGems.org
+for your convenience.
+
+You will find here [Ruby](https://rvm.io/) installation instructions using rvm (Ruby Version Manager).
+After you have installed rvm and Ruby 2.2 or higher successfully, you can install gamekey.
+
+    $ gem install gamekey
+    
+You can get basic usage instructions via:
+
+    $ gamekey help
+    
+If this is working, you have installed all gamekey components successfully.
+
+## Usage
+
+The gamekey package provides several basic commands to start and interact with the gamekey service.
+
+
+### Start a gamekey service
+
+    $ gamekey start
+    
+starts the gamekey service at port 8080.
+
+    $ gamekey help start
+    
+provides additional usage instructions.
+
+Another option is to start the gamekey service like shown in the Docker installation section.
+
+### Register a game with the gamekey service
+
+You have to register a game with the gamekey service to store gamestates.
+To register a game you can use the register command like that.
+
+    $ gamekey register --host http://192.168.99.100:8080 --name SnakeGame > snakegame.json
+    
+This will connect the gamekey service to register a game with name 'SnakeGame'.
+The anser is stored as a JSON file. It should look like that:
+
+    {
+    "type": "game",
+    "name": "SnakeGame",
+    "id": "29bb0d8d-d3ad-4c43-8916-1e9b5d21f2b0",
+    "url": "",
+    "signature": "IZmfTtGDQrsVkZNjzL115toJIoEtpGyaCcrKdV852RQ=",
+    "created": "2016-01-12T10:00:56.633213Z",
+    "secret": "965c444369346f26"
+    }
+
+The command generated a random secret and unique id for the game.
+
+__Be aware: The secret is only returned once! The secret is generated in the command line client
+and not by the service itself. The gamekey service only stores
+the signature, which can be only calculated by knowing id and secret. So if you are loosing your secret
+your game has no access to the gamekey service any longer!__
+
+Each game needs its _id_ and _secret_ for authentication and to do gamestate storing operations.
+ 
+    $ gamekey help register
+    
+provides additional usage instructions. 
+
+### Tests a gamekey service implementation
+
+Your job is to analyze the gamekey service and reimplement it as a Dart service. Your game should work with
+this reference implementation of the Gamekey Service but also with your Dart implementation.
+
+You will find 
+
+- REST API reference implementation in method [GamekeyService::api](lib/gamekey.rb)
+- REST API reference testcases in class [GamekeyReferenceTests](lib/reference.rb)
+
+The provided gamekey service is implemented in Ruby and is tested against a number of test cases.
+You can fire the same test cases against your Dart implementation using this command here:
+
+    $ gamekey test --host http://192.168.99.100:8080
+    
+Of course IP and port number should point at your Dart implementation and not at the Ruby reference implementation.
+
+### Further commands
+
+There are further commands to
+
+- list all games
+- update game data
+- deregister games.
+
+You get usage instructions via:
+
+    $ gamekey help list
+    $ gamekey help update
+    $ gamekey help deregister
+
+## Get the sources
+
+Gamekey is provided via Bitbucket as a public git repository. 
+So you can get all the sources via the following git command.
+
+    $ git clone https://nanekratzke@bitbucket.org/nanekratzke/gamekey.git

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/gamekey

@@ -0,0 +1,232 @@
+#!/usr/bin/env ruby
+
+require 'commander/import'
+require 'securerandom'
+require 'json'
+require 'terminal-table'
+
+require 'gamekey'
+require 'defaults'
+require 'reference'
+
+program :version, '0.0.1'
+program :description, 'Command to launch, manage and test the gamekey service.'
+default_command :help
+
+#
+# Gamekey command to start the gamekey service.
+#
+command :start do |c|
+  c.syntax = 'gamekey start [options]'
+  c.description = 'Starts gamekey service.'
+  c.option '--port NUMBER', Integer, "port number (optional, defaults to #{Defaults::PORT})"
+  c.option '--storage PATH', String, "key value storage file (optional, defaults to #{Defaults::STORAGE})"
+  c.action do |_, options|
+
+    options.default :port => Defaults::PORT
+    options.default :storage => Defaults::STORAGE
+
+    service = GamekeyService.new(storage: options.storage, port: options.port)
+    service.api.run!
+    # Add here some SSL certificate handling to support HTTPS
+    # - https://gist.github.com/TakahikoKawasaki/40ef0ab011b0a467bedf#file-sinatra-ssl-rb
+    # - http://stackoverflow.com/questions/11405161/can-i-enable-ssl-in-sinatra-with-thin
+  end
+end
+
+#
+# Gamekey command to run reference tests cases against a gamekey service.
+#
+command :test do |c|
+  c.syntax = 'gamekey test [options]'
+  c.description = 'Tests a gamekey service.'
+  c.option '--host HOST', String, "host of gamekey service to test (defaults to #{Defaults::TESTHOST})"
+  c.action do |_, options|
+
+    options.default :host => Defaults::TESTHOST
+
+    check = GamekeyReferenceTests.new(host: options.host)
+    check.userResourceHandling
+    check.gameResourceHandling
+    check.gamestateResourceHandling
+
+  end
+end
+
+#
+# Gamekey command to register a new game with gamekey service.
+#
+command :register do |c|
+  c.syntax = 'gamekey register [options]'
+  c.description = 'Registers a new game with the gamekey service.'
+  c.option '--host HOST', String, "host of gamekey service to register with (optional, defaults to #{Defaults::TESTHOST})"
+  c.option '--name STRING', String, "name of the new game (required, must be unique)"
+  c.option '--secret STRING', String, "secret of the game (optional, defaults to an autogenerated secret)"
+  c.option '--url HOST', String, "URI of the new game (optional, defaults to '')"
+
+  c.action do |_, options|
+
+    options.default :host   => Defaults::TESTHOST
+    options.default :url    => ""
+    options.default :secret => SecureRandom.hex(8)
+
+    if !options.name
+      puts "You have to provide a name with --name option."
+      exit(1)
+    end
+
+    uri = URI(options.host)
+    http = Net::HTTP.new(uri.host, uri.port)
+
+    request = Net::HTTP::Post.new("/game")
+    request.set_form_data({
+        'name'   => options.name,
+        'secret' => options.secret,
+        'url'    => options.url
+    })
+
+    res = http.request(request)
+
+    unless res.code == "200"
+      puts "Uuups, there went something wrong."
+      puts "#{res.body}"
+      exit(1)
+    end
+
+    game = JSON.parse(res.body)
+    game['secret'] = options.secret
+
+    puts(JSON.pretty_generate(game))
+  end
+end
+
+#
+# Gamekey command to list all games
+#
+command :list do |c|
+  c.syntax = 'gamekey list [options]'
+  c.description = 'Lists all registered games from the gamekey service.'
+  c.option '--host HOST', String, "host of gamekey service (optional, defaults to #{Defaults::TESTHOST})"
+  c.option '--json', "Return JSON like the REST API (optional, not set by default)"
+
+  c.action do |_, options|
+
+    options.default :host   => Defaults::TESTHOST
+    options.default :json   => false
+
+    uri = URI(options.host)
+    http = Net::HTTP.new(uri.host, uri.port)
+
+    request = Net::HTTP::Get.new("/games")
+    res = http.request(request)
+
+    unless res.code == "200"
+      puts "Uuups, there went something wrong."
+      puts "#{res.body}"
+      exit(1)
+    end
+
+    games = JSON.parse(res.body)
+
+    puts JSON.pretty_generate(games) if options.json
+    unless options.json
+      rows = games.map { |game| [game['name'], game['id'], game['url']] }
+      table = Terminal::Table.new :headings => ['Game', 'ID', 'URL'], :rows => rows
+      puts table
+    end
+  end
+end
+
+#
+# Gamekey command to update game data
+#
+command :update do |c|
+  c.syntax = 'gamekey update [options]'
+  c.description = 'Updates game data of registered game.'
+  c.option '--host HOST', String, "host of gamekey service (optional, defaults to #{Defaults::TESTHOST})"
+  c.option '--id STRING', String, "id of the game (required)"
+  c.option '--secret STRING', String, "secret of the game (required)"
+  c.option '--name STRING', String, "Update for the name of the game (optional, new name must be unique)"
+  c.option '--url STRING', String, "Update for the url of the game (optional, must be a valid url)"
+  c.option '--newsecret STRING', String, "Update for the secret of the game (optional)"
+
+  c.action do |_, options|
+
+    options.default :host   => Defaults::TESTHOST
+
+    if !options.id
+      puts "You have to provide the id of the game with --id option."
+      exit(1)
+    end
+
+    if !options.secret
+      puts "You have to provide the secret with --secret option."
+      exit(1)
+    end
+
+    uri = URI(options.host)
+    http = Net::HTTP.new(uri.host, uri.port)
+
+    request = Net::HTTP::Put.new("/game/#{options.id}")
+    params = {}
+    params['secret'] = options.secret
+    params['name'] = options.name if options.name
+    params['url'] = options.url if options.url
+    params['newsecret'] = options.newsecret if options.newsecret
+    request.set_form_data(params)
+
+    res = http.request(request)
+
+    unless res.code == "200"
+      puts "Uuups, there went something wrong."
+      puts "#{res.body}"
+      exit(1)
+    end
+
+    games = JSON.parse(res.body)
+
+    puts JSON.pretty_generate(games)
+  end
+end
+
+
+#
+# Gamekey command to deregister a new game with gamekey service.
+#
+command :deregister do |c|
+  c.syntax = 'gamekey deregister [options]'
+  c.description = 'Deregisters a game from the gamekey service.'
+  c.option '--host HOST', String, "host of gamekey service (optional, defaults to #{Defaults::TESTHOST})"
+  c.option '--id STRING', String, "id of the game (required)"
+  c.option '--secret STRING', String, "secret of the game (required)"
+
+  c.action do |_, options|
+
+    options.default :host   => Defaults::TESTHOST
+
+    if !options.id
+      puts "You have to provide the id of the game with --id option."
+      exit(1)
+    end
+
+    if !options.secret
+      puts "You have to provide the secret with --secret option."
+      exit(1)
+    end
+
+    uri = URI(options.host)
+    http = Net::HTTP.new(uri.host, uri.port)
+
+    request = Net::HTTP::Delete.new("/game/#{options.id}")
+    request.set_form_data({ 'secret' => options.secret })
+    res = http.request(request)
+
+    unless res.code == "200"
+      puts "Uuups, there went something wrong."
+      puts "#{res.body}"
+      exit(1)
+    end
+
+    puts ("Game deleted: #{res.body}")
+  end
+end

data/gamekey.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gamekey/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gamekey"
+  spec.version       = Gamekey::VERSION
+  spec.authors       = ["Nane Kratzke"]
+  spec.email         = ["nane.kratzke@fh-luebeck.de"]
+  spec.description   = %q{Gamekey service.}
+  spec.summary       = %q{Gamekey service.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.2.0'
+
+  spec.add_runtime_dependency "sinatra"
+  spec.add_runtime_dependency "sinatra-cross_origin"
+  spec.add_runtime_dependency "commander"
+  spec.add_runtime_dependency "colorize"
+  spec.add_runtime_dependency "terminal-table"
+
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/auth.rb

@@ -0,0 +1,14 @@
+require 'defaults'
+require 'base64'
+
+module Auth
+
+  def self.signature(id, pwd)
+    Base64.strict_encode64(Defaults::CRYPTOHASH.digest("#{id},#{pwd}"))
+  end
+
+  def self.authentic?(entity, pwd)
+    entity['signature'] == signature(entity['id'], pwd)
+  end
+
+end