hive-stalker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fe189ec6141b4b1fc8bc94733dcc72bc6a878d7f
+  data.tar.gz: afca1d0ad149d706275dda33cf5243045e48320c
+SHA512:
+  metadata.gz: 69cd58d14dc01d27de88849a1b6bd8c8839784e1e91df77e2a1ffe0e66ea20228e4e4ef5505d8cb25638a3310a4c799ce69a5f8faa7b9ba797d48cb7b0810866
+  data.tar.gz: b30990b731fc9c78ac428067fd5b3e72d300579d3c2e6cebc1b1e12cc70ce7f434858a37402352cc20457cc3d03f2d07c95ef378b43db158dbb8b90779accacd

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+spec/.examples.txt

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Change log
+
+This document represents a high-level overview of changes made to this project.
+It will not list every miniscule change, but will allow you to view - at a
+glance - what to expact from upgrading to a new version.
+
+## [unpublished]
+
+### Added
+
+### Changed
+
+### Fixed
+
+### Security
+
+### Deprecated
+
+### Removed
+
+## [0.1.0] - 2016-12-22
+
+### Added
+
+- Basic client and wrappper to access player data from Hive2 API.

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2016 Michael Senn
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,6 @@
+# Sunscout
+
+## License
+
+The gem is available as open source under the terms of the [Apache-2.0 License](http://opensource.org/licenses/Apache-2.0).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/TODO.md

@@ -0,0 +1,4 @@
+# Dev
+
+- Integration tests (hitting the Hive API)
+- Documentation of classes

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hive-stalker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hive-stalker.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "hive-stalker"
+  spec.version       = '0.1.0'
+  spec.authors       = ["Michael Senn"]
+  spec.email         = ["michael@morrolan.ch"]
+
+  spec.summary       = %q{Binding to Natural Selection 2's Hive2 ELO system}
+  # spec.description   = %q{}
+  spec.homepage      = "https://bitbucket.org/Lavode/hivestalker"
+  spec.license       = "Apache-2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "typhoeus"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "yard"
+end
+

data/lib/hive_stalker/api_error.rb

@@ -0,0 +1,9 @@
+module HiveStalker
+  # Error raised when communication with the Hive2 API fails, e.g. when:
+  # - Connection times out
+  # - DNS resolution fails
+  # - API returns non-successful status code
+  # - API returns invalid or incomplete JSON
+  class APIError < StandardError
+  end
+end

data/lib/hive_stalker/client.rb

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+require 'json'
+require 'typhoeus'
+
+module HiveStalker
+  # Low-level binding to the Hive2 HTTP API.
+  # @example Basic usage
+  #   require 'hive_stalker'
+  #   client = HiveStalker::Client.new
+  #   begin
+  #     data = client.get_player_data(48221310)
+  #     puts "Playtime: #{ data[:time_total] }s"
+  #   rescue APIError => e
+  #     puts "Error when querying player data:"
+  #     puts e.message
+  #     if e.cause
+  #       puts "Caused by:"
+  #       puts e.cause.message
+  #     end
+  #   end
+  class Client
+    # Default API endpoint of Hive2 API, which will be used unless overwritten.
+    # `%{{action}}` is a placeholder for the to-be-performed action.
+    HIVE_ENDPOINT = 'http://hive2.ns2cdt.com/api/%{action}'
+    # Path of 'get player data' action. `%{{player_id}}` is a placeholder for
+    # the to-be-queried player's account ID.
+    GET_PLAYER_DATA = 'get/playerData/%{player_id}'
+
+    # API endpoint of Hive2 API.
+    # @return [String]
+    attr_reader :endpoint
+
+    # Initialize a new instance of the class.
+    #
+    # @param endpoint [String] API endpoint of Hive2 API. Defaults to
+    #   {Client::HIVE_ENDPOINT}.
+    #   Must contain `%{{action}}` as placeholder for the action.
+    def initialize(endpoint: HIVE_ENDPOINT)
+      @endpoint = endpoint
+    end
+
+    # Retrieve statistics of a given player.
+    #
+    # @param player_id [Fixnum] Account ID for which to query data.
+    # @return [Hash<Symbol, Object>] Hash with player statistics.
+    # @raise [APIError] In case of errors communicating with the API.
+    def get_player_data(player_id)
+      raw_data = call_api(GET_PLAYER_DATA, player_id: player_id)
+
+      begin
+        {
+          player_id: raw_data.fetch('pid'),
+          steam_id: raw_data.fetch('steamid'),
+          alias: raw_data.fetch('alias'),
+          score: raw_data.fetch('score'),
+          level: raw_data.fetch('level'),
+          experience: raw_data.fetch('xp'),
+          badges_enabled: raw_data.fetch('badges_enabled'),
+          badges: raw_data.fetch('badges') || [],
+          skill: raw_data.fetch('skill'),
+          time_total: raw_data.fetch('time_played'),
+          time_marine: raw_data.fetch('marine_playtime'),
+          time_alien: raw_data.fetch('alien_playtime'),
+          time_commander: raw_data.fetch('commander_time'),
+          reinforced_tier: raw_data.fetch('reinforced_tier'),
+          adagrad_sum: raw_data.fetch('adagrad_sum')
+        }
+      rescue KeyError => e
+        raise APIError, "Incomplete JSON received from API: #{ e.message }"
+      end
+    end
+
+    private
+    def call_api(action, **kwargs)
+      url = HIVE_ENDPOINT % { action: action }
+      url = url % kwargs
+
+      response = Typhoeus.get(url)
+      if response.success?
+        begin
+          JSON.parse(response.body)
+        rescue JSON::ParserError
+          raise APIError, "Invalid JSON received from API."
+        end
+      elsif response.code == 0
+        raise APIError, "Error while connecting to API: #{ response.return_message }"
+      else
+        raise APIError, "Non-success status code recieved from API: #{ response.code }"
+      end
+    end
+
+  end
+end

data/lib/hive_stalker/player_data.rb

@@ -0,0 +1,89 @@
+module HiveStalker
+  # Container for various player statistics. Essentially a glorified struct.
+  class PlayerData
+    # Player ID, probably NS2/Hive2-internal.
+    # @return [Fixnum]
+    attr_reader :player_id
+
+    # Steam account ID.
+    # @return [Fixnum]
+    attr_reader :steam_id
+
+    # User alias (in-game name)
+    # @return [String]
+    attr_reader :alias
+
+    # Score - not sure where it's used or shown.
+    # @return [Fixnum]
+    attr_reader :score
+
+    # Level
+    # @return [Fixnum]
+    attr_reader :level
+
+    # Experience points
+    # @return [Fixnum]
+    attr_reader :experience
+
+    # Whether badges are enabled.
+    # 
+    # Not sure where this comes from.
+    # @return [TrueClass, FalseClass]
+    attr_reader :badges_enabled
+
+    # Array of badges. Always empty so far.
+    # @return [Array]
+    attr_reader :badges
+
+    # Skill / ELO
+    # @return [Fixnum]
+    attr_reader :skill
+
+    # Total time played in seconds.
+    #
+    # This equals {#time_marine} + {#time_alien}
+    # @return [Fixnum]
+    attr_reader :time_total
+
+    # Time played as marines in seconds.
+    # @return [Fixnum]
+    attr_reader :time_marine
+
+    # Time played as aliens in seconds.
+    # @return [Fixnum]
+    attr_reader :time_alien
+
+    # Time played as commander in seconds.
+    # @return [Fixnum]
+    attr_reader :time_commander
+
+    # Don't know what this is. Always nil.
+    # @return [NilClass]
+    attr_reader :reinforced_tier
+
+    # AdaGrad sum (https://en.wikipedia.org/wiki/Stochastic_gradient_descent#AdaGrad).
+    # @return [Float]
+    attr_reader :adagrad_sum
+
+
+    # Initialize a new instance of the class.
+    #
+    # @param kwargs [Hash<Symbol, Object>] data with which to initialize the
+    #   instance's attributes.
+    def initialize(**kwargs)
+      @player_id       = kwargs[:player_id]
+      @steam_id        = kwargs[:steam_id]
+      @score           = kwargs[:score]
+      @level           = kwargs[:level]
+      @experience      = kwargs[:experience]
+      @badges_enabled  = kwargs[:badges_enabled]
+      @badges          = kwargs[:badges]
+      @time_total      = kwargs[:time_total]
+      @time_marine     = kwargs[:time_marine]
+      @time_alien      = kwargs[:time_alien]
+      @time_commander  = kwargs[:time_commander]
+      @reinforced_tier = kwargs[:reinforced_tier]
+      @adagrad_sum     = kwargs[:adagrad_sum]
+    end
+  end
+end

data/lib/hive_stalker/stalker.rb

@@ -0,0 +1,42 @@
+module HiveStalker
+  # High-level binding to the Hive2 HTTP API.
+  # @example Basic usage
+  #   require 'hive_stalker'
+  #   stalker = HiveStalker::Stalker.new
+  #   begin
+  #     data = stalker.get_player_data('STEAM_0:0:24110655')
+  #     puts "--- #{ data.alias } ---"
+  #     puts "Playtime: #{ data.time_total }s"
+  #     puts "Skill: #{ data.skill }"
+  #   rescue APIError => e
+  #     puts "Could not retrieve player statistics."
+  #     puts e.message
+  #   end
+  class Stalker
+    # API client which is used.
+    # @return [Client]
+    attr_reader :client
+
+    # Initialize a new instance of the class.
+    #
+    # @param kwargs [Hash] Configuration settings which are passed through to
+    #   the underlying client. See {Client#initialize} for details.
+    def initialize(**kwargs)
+      @client = Client.new(kwargs)
+    end
+
+    # Retrieve statistics of a given player.
+    #
+    # @param steam_id [String, Fixnum] Any supported Steam or account ID. 
+    #
+    #   See {SteamID.from_string} for supported formats.
+    # @return [PlayerData] Object containing player statistics.
+    # @raise [APIError] In case of errors communicating with the API.
+    # @raise [ArgumentError] If the supplied string could not be converted to
+    #   an account ID.
+    def get_player_data(steam_id)
+      account_id = SteamID.from_string(steam_id)
+      PlayerData.new(@client.get_player_data(account_id))
+    end
+  end
+end

data/lib/hive_stalker/steam_id.rb

@@ -0,0 +1,45 @@
+module HiveStalker
+  # Module to convert various formats of Steam IDs into an account ID.
+  module SteamID
+    STEAM_ID_64_OFFSET = 61197960265728
+
+    PATTERN_STEAM_ID = /^STEAM_0:([0-9]):([0-9]+)$/
+    PATTERN_STEAM_ID_3 = /^U:([0-9]{1,2}):([0-9]+)$/
+    PATTERN_STEAM_ID_64 = /^765([0-9]+)$/
+    PATTERN_ACCOUNT_ID = /^[0-9]{8}$/
+
+    # Convert Steam ID into account ID suitable for API calls.
+    # @param s [String] Steam ID, either of:
+    #   - Steam ID: STEAM_0:0:24110655
+    #   - Steam ID 3: U:1:48221310
+    #   - Steam ID 64: 76561198008487038
+    #   - Account ID: 48221310
+    # @return [Fixnum] Account ID
+    # @raise [ArgumentError] If the supplied string could not be converted to
+    #   an account ID.
+    def self.from_string(s)
+      # In case we get a fixnum.
+      s = s.to_s
+
+      # https://developer.valvesoftware.com/wiki/SteamID#Format
+      PATTERN_ACCOUNT_ID.match(s) do |m|
+        return s.to_i
+      end
+
+      PATTERN_STEAM_ID.match(s) do |m|
+        return m[1].to_i + m[2].to_i * 2
+      end
+
+      PATTERN_STEAM_ID_3.match(s) do |m|
+        return m[2].to_i
+      end
+
+      PATTERN_STEAM_ID_64.match(s) do |m|
+        return m[1].to_i - STEAM_ID_64_OFFSET
+      end
+
+      # If we get until here, we did not match any regex.
+      raise ArgumentError, "#{ s.inspect } is not a supported SteamID."
+    end
+  end
+end

data/lib/hive_stalker.rb

@@ -0,0 +1,11 @@
+# coding: utf-8
+
+require 'hive_stalker/steam_id'
+require 'hive_stalker/client'
+require 'hive_stalker/stalker'
+require 'hive_stalker/player_data'
+require 'hive_stalker/api_error'
+
+module HiveStalker
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: hive-stalker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Senn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- michael@morrolan.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.md
+- bin/console
+- bin/setup
+- hive-stalker.gemspec
+- lib/hive_stalker.rb
+- lib/hive_stalker/api_error.rb
+- lib/hive_stalker/client.rb
+- lib/hive_stalker/player_data.rb
+- lib/hive_stalker/stalker.rb
+- lib/hive_stalker/steam_id.rb
+homepage: https://bitbucket.org/Lavode/hivestalker
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Binding to Natural Selection 2's Hive2 ELO system
+test_files: []