tassadar-server 0.1.0

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--tty --colour --profile --format nested

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create ruby-1.9.3-p194@tassadar-server_gem

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,83 @@
+PATH
+  remote: .
+  specs:
+    tassadar-server (0.1.0)
+      grape
+      grape-rabl
+      rack-throttle
+      redis
+      tassadar
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.10)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    backports (2.6.5)
+    bindata (1.4.5)
+    builder (3.1.4)
+    bump (0.3.8)
+    bzip2-ruby (0.2.7)
+    descendants_tracker (0.0.1)
+    diff-lcs (1.1.3)
+    grape (0.2.3)
+      activesupport
+      builder
+      hashie (~> 1.2)
+      multi_json (>= 1.3.2)
+      multi_xml
+      rack
+      rack-accept
+      rack-mount
+      virtus
+    grape-rabl (0.1.0)
+      grape (~> 0.2.3)
+      i18n
+      rabl
+      tilt
+    hashie (1.2.0)
+    i18n (0.6.1)
+    json_spec (1.1.0)
+      multi_json (~> 1.0)
+      rspec (~> 2.0)
+    multi_json (1.5.0)
+    multi_xml (0.5.1)
+    rabl (0.7.9)
+      activesupport (>= 2.3.14)
+      multi_json (~> 1.0)
+    rack (1.4.1)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rack-throttle (0.3.0)
+      rack (>= 1.0.0)
+    redis (3.0.2)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    tassadar (0.1.0)
+      bindata
+      bzip2-ruby
+    tilt (1.3.3)
+    virtus (0.5.4)
+      backports (~> 2.6.1)
+      descendants_tracker (~> 0.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bump
+  json_spec
+  rack-test
+  rspec
+  tassadar-server!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Agora Games
+
+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/Procfile

@@ -0,0 +1 @@
+web: bundle exec rackup config.ru -p $PORT

data/README.md

@@ -0,0 +1,64 @@
+# tassadar-server
+
+This simple rack-based web service uses the pure-ruby [Tassadar](https://github.com/agoragames/tassadar) library
+to parse uploaded Starcraft II replay files and send a JSON response.
+
+This service is designed to enable Tassadar in polyglot or browser-based projects where Ruby may not be the significant language.
+
+## Installation
+
+    $ gem install tassadar-server
+
+## Usage
+
+#### Options
+
+The server can be configured using the following environment variables:
+
+| **Option** | **Description** | **Details** |
+|------------|-----------------|-------------|
+| THROTTLE   | Allowed requests per hour | for each user |
+| REDIS_URL | Redis server | required if THROTTLE is enabled |
+| WHITELIST | Comma-separated list of allowed IP addresses | Optional |
+| USER_HEADER | Header containing unique user id | defaults to IP address if not set |
+
+#### Start the server
+
+    $ rackup ./config.ru
+
+You can also mount tassadar-server into a Rails 3 application, or use unicorn to set up a cluster of workers for increased load.
+
+#### Parse a replay
+
+    $ http -f POST http://localhost:9292/sc2/replay file@spec/replays/delta_quadrant.SC2Replay
+
+    POST /sc2/replay HTTP/1.1
+    Host: localhost:9292
+    Content-Type: multipart/form-data; boundary=cd85979359044d7cac045667d
+    cf591c3
+    Accept-Encoding: gzip, deflate, compress
+    Accept: */*
+    Content-Type: application/json
+    Content-Length: 633
+    Server: WEBrick/1.3.1 (Ruby/1.9.3/2012-04-20)
+    Date: Thu, 03 Jan 2013 01:32:21 GMT
+    Connection: Keep-Alive
+
+    {"replay":{"game":{"category":"Ladder","map":"Delta Quadrant","speed"
+    :"Faster","time":"2011-07-05 18:01:08 -0400","type":"1v1","winner":{"
+    actual_race":"Zerg","chosen_race":"Zerg","handicap":100,"id":2569192,
+    "name":"redgar","won":true,"color":{"alpha":255,"red":0,"green":66,"b
+    lue":255}}},"players":[{"player":{"actual_race":"Terran","chosen_race
+    ":"Terran","handicap":100,"id":1918894,"name":"guitsaru","won":false,
+    "color":{"alpha":255,"red":180,"green":20,"blue":30}}},{"player":{"ac
+    tual_race":"Zerg","chosen_race":"Zerg","handicap":100,"id":2569192,"n
+    ame":"redgar","won":true,"color":{"alpha":255,"red":0,"green":66,"blu
+    e":255}}}]}}
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/config.ru

@@ -0,0 +1,30 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+
+require 'tassadar-server'
+
+use Rack::Config do |env|
+  env['api.tilt.root'] = File.join(
+    File.dirname(__FILE__), 'lib', 'tassadar', 'server', 'views'
+  )
+end
+
+if ENV['REDIS_URL']
+  require 'redis'
+  $redis = Redis.new url: ENV['REDIS_URL']
+end
+
+if ENV['WHITELIST']
+  require 'tassadar/server/whitelist'
+  use Tassadar::Server::Whitelist,
+    ENV['WHITELIST'].split(',').delete_if(&:empty?)
+end
+
+if ENV['THROTTLE']
+  require 'tassadar/server/throttle'
+  use Tassadar::Server::Throttle,
+    max: ENV['THROTTLE'].to_i,
+    cache: $redis,
+    key_prefix: :throttle
+end
+
+run Tassadar::Server::API

data/lib/tassadar-server.rb

@@ -0,0 +1,11 @@
+require 'tassadar'
+require 'grape'
+require 'grape/rabl'
+
+require 'tassadar/server/version'
+require 'tassadar/server/api'
+
+module Tassadar
+  module Server
+  end
+end

data/lib/tassadar/server/api.rb

@@ -0,0 +1,32 @@
+module Tassadar
+  module Server
+    class API < ::Grape::API
+      version 'v1', :using => :header, :vendor => 'agoragames'
+      format :json
+      formatter :json, Grape::Formatter::Rabl
+      content_type :json, 'application/json'
+
+      helpers do
+        def get_file
+          unless params[:file] &&
+                (tmpfile = params[:file][:tempfile]) &&
+                (name = params[:file][:filename])
+            error! 'No file uploaded', 500
+          end
+          tmpfile
+        end
+
+        def parse(path)
+          Tassadar::SC2::Replay.new(path)
+        end
+      end
+
+      resource :sc2 do
+        desc 'Return parsed output for an uploaded replay'
+        post :replay, rabl: 'replay' do
+          @replay = parse(get_file)
+        end
+      end
+    end
+  end
+end

data/lib/tassadar/server/throttle.rb

@@ -0,0 +1,28 @@
+require 'rack/throttle'
+
+module Tassadar
+  module Server
+    class Throttle < Rack::Throttle::Hourly
+
+      def client_identifier(request)
+        # Determine whether the user should be identified by a unique
+        # header (for example, a username or token), or simply by IP
+        # for the purpose of rate limiting.
+        if ENV['USER_HEADER'] && request.env.has_key?(ENV['USER_HEADER'])
+          request.env[ENV['USER_HEADER']].to_s
+        else
+          request.ip.to_s
+        end
+      end
+
+      # Patch for unmerged https://github.com/datagraph/rack-throttle/pull/6
+      def http_error(code, message = nil, headers = {})
+        [ code,
+          { 'Content-Type' => 'text/plain; charset=utf-8' }.merge(headers),
+          Array( http_status(code) + (message.nil? ? "\n" : " (#{message})\n") )
+        ]
+      end
+      
+    end
+  end
+end

data/lib/tassadar/server/version.rb

@@ -0,0 +1,5 @@
+module Tassadar
+  module Server
+    VERSION = '0.1.0'
+  end
+end

data/lib/tassadar/server/views/replay.rabl

@@ -0,0 +1,30 @@
+object @replay => :replay
+child :game => :game do
+
+  attribute :category,
+    :map,
+    :speed,
+    :time,
+    :type
+
+  child :winner => :winner do
+    attributes :actual_race,
+      :chosen_race,
+      :handicap,
+      :id,
+      :name,
+      :won,
+      :color
+  end
+
+end
+
+child :players => :players do
+  attributes :actual_race,
+    :chosen_race,
+    :handicap,
+    :id,
+    :name,
+    :won,
+    :color
+end

data/lib/tassadar/server/whitelist.rb

@@ -0,0 +1,29 @@
+module Tassadar
+  module Server
+    class Whitelist
+      def initialize(app, addresses)
+        @app = app
+        @whitelist = addresses
+      end
+
+      def call(env)
+        if white_listed?(env)
+          @app.call(env)
+        else
+          [ 403,
+            { 'Content-Type' => 'text/plain; charset=utf-8' },
+            Array( "IP #{remote_ip(env)} is not whitelisted" )
+          ]
+        end
+      end
+
+      def remote_ip(env)
+        Rack::Request.new(env).ip
+      end
+      
+      def white_listed?(env)
+        @whitelist.include? remote_ip(env)
+      end
+    end
+  end
+end

data/spec/replays/delta_quadrant.json

@@ -0,0 +1 @@
+{"replay":{"game":{"category":"Ladder","map":"Delta Quadrant","speed":"Faster","time":"2011-07-05 18:01:08 -0400","type":"1v1","winner":{"actual_race":"Zerg","chosen_race":"Zerg","handicap":100,"id":2569192,"name":"redgar","won":true,"color":{"alpha":255,"red":0,"green":66,"blue":255}}},"players":[{"player":{"actual_race":"Terran","chosen_race":"Terran","handicap":100,"id":1918894,"name":"guitsaru","won":false,"color":{"alpha":255,"red":180,"green":20,"blue":30}}},{"player":{"actual_race":"Zerg","chosen_race":"Zerg","handicap":100,"id":2569192,"name":"redgar","won":true,"color":{"alpha":255,"red":0,"green":66,"blue":255}}}]}}

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rack/test'
+require 'json_spec'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'tassadar-server')
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.include JsonSpec::Helpers
+end

data/spec/tassadar-server_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Tassadar::Server::API do
+  include Rack::Test::Methods
+
+  def app
+    Rack::Builder.parse_file('config.ru').first
+  end
+
+  describe 'POST /sc2/replay' do
+    let(:valid_replay) {
+      File.join(
+        File.dirname(__FILE__), 'replays', 'delta_quadrant.SC2Replay'
+      )
+    }
+
+    let(:valid_replay_json) {
+      File.join(
+        File.dirname(__FILE__), 'replays', 'delta_quadrant.json'
+      )
+    }
+
+    context 'with no file' do
+      before { post '/sc2/replay' }
+      subject { last_response }
+      its(:status) { should eql 500 }
+    end
+
+    context 'with a valid file' do
+      before do
+        post '/sc2/replay', :file => Rack::Test::UploadedFile.new(
+          valid_replay, 'mime/type'
+        )
+      end
+      subject { last_response }
+      its(:status) { should eql 201 }
+
+      describe 'body' do
+        subject { last_response.body }
+        it 'should match the expected json' do
+          should be_json_eql File.read(valid_replay_json)
+        end
+      end
+
+    end
+  end
+end

data/tassadar-server.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tassadar/server/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'tassadar-server'
+  gem.version       = Tassadar::Server::VERSION
+  gem.authors       = ['Logan Koester']
+  gem.email         = ['logan@logankoester.com']
+  gem.description   = %q{A web service interface to the tassadar Starcraft 2 replay parser}
+  gem.summary       = %q{A web service interface to the tassadar Starcraft 2 replay parser}
+  gem.homepage      = 'https://github.com/agoragames/tassadar-server'
+
+  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.require_paths = ['lib']
+
+  gem.add_dependency 'tassadar'
+  gem.add_dependency 'grape'
+  gem.add_dependency 'grape-rabl'
+
+  gem.add_dependency 'redis'
+  gem.add_dependency 'rack-throttle'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'json_spec'
+  gem.add_development_dependency 'bump'
+end

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: tassadar-server
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Logan Koester
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tassadar
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: grape-rabl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-throttle
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json_spec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A web service interface to the tassadar Starcraft 2 replay parser
+email:
+- logan@logankoester.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Procfile
+- README.md
+- Rakefile
+- config.ru
+- lib/tassadar-server.rb
+- lib/tassadar/server/api.rb
+- lib/tassadar/server/throttle.rb
+- lib/tassadar/server/version.rb
+- lib/tassadar/server/views/replay.rabl
+- lib/tassadar/server/whitelist.rb
+- spec/replays/delta_quadrant.SC2Replay
+- spec/replays/delta_quadrant.json
+- spec/spec_helper.rb
+- spec/tassadar-server_spec.rb
+- tassadar-server.gemspec
+homepage: https://github.com/agoragames/tassadar-server
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A web service interface to the tassadar Starcraft 2 replay parser
+test_files:
+- spec/replays/delta_quadrant.SC2Replay
+- spec/replays/delta_quadrant.json
+- spec/spec_helper.rb
+- spec/tassadar-server_spec.rb