steam-id 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a6cf18a2204410c6772f50957b7c1b7617c288c
+  data.tar.gz: 4acc1ac662cf695c80bef760e06d471643f1cfc3
+SHA512:
+  metadata.gz: c60c39a114cd46046b03e6b98725f8dfa2fec2faff33722550b1890a72462bc4af9ab351577f355e0554797fb8c3b25103e10eb71b22004481402542d2083ea6
+  data.tar.gz: 2bab90e6d37b0ec067eec2c6ff4bbfbb5a59a52af68eb80c4659fd7bbd03fe7c1caefa0a121c408d878abfd56469ec21b39aaf3c4b3cd7a3d498d135f4f2e27c

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format progress
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016
+
+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,71 @@
+# Id
+[![Build Status](https://travis-ci.org/fastpeek/steam-id.svg?branch=master)](https://travis-ci.org/fastpeek/steam-id)
+![Gem Version](https://img.shields.io/gem/v/steam-id.svg)
+
+Valve's SteamId data type in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'steam-id'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install steam-id
+
+## Usage
+
+```ruby
+# Create from Community Id
+id = CommunityId.parse(76561197998193728)
+
+# Create from a Steam2 Id
+id = Steam2Id.parse('STEAM_0:0:18964000')
+
+# Create from a Steam3Id
+id = Steam3Id.parse('[U:1:37928000]')
+```
+
+The `#parse` method returns nil if the parsing fails. Parsing can be a success
+but the Steam Id can still be invalid. To determine validity of the Steam ID a
+`#valid?` method is provided.
+
+```ruby
+# Create from Community Id
+id = CommunityId.parse(76561197998193728)
+id.valid? # => true
+
+id = Steam2Id.parse('STEAM_0:0:0')
+id.valid? # => false
+```
+
+A `#to_s` and `#to_i` method are also provided for representing the object in
+String and Integer form. By default `#to_s` returns the Steam2 string
+representation. A printer class can be passed to `#to_s` to render in different
+formats.  The `#to_i` method returns the 64 bit steam id.
+
+
+```ruby
+# Create from Community Id
+id = CommunityId.parse(76561197998193728)
+id.to_s # => 'STEAM_0:0:18964000'
+id.to_s(Steam::Id::Steam3Printer) # => '[U:1:37928000]'
+
+id = Steam2Id.parse('STEAM_0:0:18964000')
+id.to_i # => 76561197998193728
+```
+
+## Limitations
+
+Steam3 ID support is limited to account types of "Individual"
+
+## References
+
+[SteamKit](https://github.com/SteamRE/SteamKit/blob/master/SteamKit2/SteamKit2/Types/SteamID.cs)

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'steam/id'
+
+# 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/lib/steam/id.rb

@@ -0,0 +1,29 @@
+require 'steamd'
+Steamd.load_language
+
+require 'steam/id/version'
+require 'steam/id/struct'
+require 'steam/id/base'
+require 'steam/id/community_id'
+require 'steam/id/steam2_id'
+require 'steam/id/steam3_id'
+require 'steam/id/steam3_id_parser'
+require 'steam/id/steam2_id_parser'
+require 'steam/id/steam2_printer'
+require 'steam/id/steam3_printer'
+
+# Root Steam namespace
+module Steam
+  # Represents a Valve Steam Id
+  module Id
+  end
+end
+
+# Represents a Valve Steam Id in the Community Id format
+CommunityId = Steam::Id::CommunityId
+
+# Represents a Valve Steam Id in the Steam2 Id format
+Steam2Id    = Steam::Id::Steam2Id
+
+# Represents a Valve Steam Id in the Steam3 Id format
+Steam3Id    = Steam::Id::Steam3Id

data/lib/steam/id/base.rb

@@ -0,0 +1,70 @@
+require 'forwardable'
+
+module Steam
+  module Id
+    # Represents a SteamID holds the various parts of the Steam Id an internal
+    # 64bit datastructure
+    class Base
+      extend Forwardable
+
+      # Delegate some getter methods to the internal data struct
+      def_delegators :@struct, :account_id, :account_type, :instance, :universe
+
+      # Delegate some setter methods to the internal data struct
+      def_delegators :@struct, :account_id=,
+                     :account_type=, :instance=, :universe=
+
+      attr_reader :struct
+
+      # Create a new Steam ID
+      def initialize(struct = Struct.new)
+        @struct = struct
+      end
+
+      # Return the Steam Id in string format. By default the Steam2 format
+      # is returned
+      #
+      # @param klass [Printer] a steam id printer
+      # @return [String] the steam id in the desired format
+      def to_s(klass = Steam2Printer)
+        printer ||= klass.new(self)
+        printer.print
+      end
+
+      # Return the Steam Id in int format.
+      #
+      # @return [Integer] the steam id in int format
+      def to_i
+        @struct.to_i
+      end
+
+      # Returns true if the Steam id is valid
+      #
+      # @return [Bool] true if valid, otherwise false
+      def valid?
+        valid_universe? && valid_account?
+      end
+
+      private
+
+      # @api private
+      def valid_account?
+        return false if account_type <= EAccountType::INVALID ||
+                        account_type >= EAccountType::MAX
+
+        if account_type == EAccountType::INDIVIDUAL
+          return false if account_id.zero?
+        end
+
+        true
+      end
+
+      # @api private
+      def valid_universe?
+        return false if universe <= EUniverse::INVALID ||
+                        universe >= EUniverse::MAX
+        true
+      end
+    end
+  end
+end

data/lib/steam/id/community_id.rb

@@ -0,0 +1,19 @@
+
+module Steam
+  module Id
+    # Represents a 64 bit community ID
+    class CommunityId < Base
+      # Parse a community id from an input
+      #
+      # @param id [String, Integer] the input id
+      def self.parse(id)
+        new(id)
+      end
+
+      # Create a community id object
+      def initialize(id)
+        super(Struct.new(id))
+      end
+    end
+  end
+end

data/lib/steam/id/steam2_id.rb

@@ -0,0 +1,34 @@
+
+module Steam
+  module Id
+    # Represents a Steam ID in the Steam2 format.
+    class Steam2Id < Base
+      # Parse a Steam2Id from a given input string
+      #
+      # @param id [String] the input string
+      # @return [Steam2Id, nil]
+      def self.parse(id)
+        parser = Steam2IdParser.new(id)
+        parser.parse
+
+        new(parser.universe, parser.account_id, parser.auth_server)
+      end
+
+      # Instantiate a Steam2Id object
+      def initialize(universe, account_id, auth_server)
+        super()
+        self.instance = 1
+        self.universe = universe
+        self.account_type = EAccountType::INDIVIDUAL
+        self.account_id = (account_id << 1) | auth_server
+      end
+
+      # Sets the correct universe for a Steam2Id
+      #
+      # @param universe [Integer] the universe
+      def universe=(universe)
+        struct.universe = universe.zero? ? EUniverse::PUBLIC : universe
+      end
+    end
+  end
+end

data/lib/steam/id/steam2_id_parser.rb

@@ -0,0 +1,34 @@
+module Steam
+  module Id
+    # Parse a steam 2 id string
+    class Steam2IdParser
+      # A Regex representing a valid Steam 2 string
+      # rubocop:disable LineLength
+      STEAM2_REGEX = /STEAM_(?<universe>[0-4]):(?<authserver>[0-1]):(?<accountid>\d+)/
+
+      attr_reader :universe, :account_id, :auth_server
+
+      def initialize(id)
+        @id = id.to_s
+        @universe = EUniverse::INVALID
+        @account_id = 0
+        @auth_server = 0
+      end
+
+      # Parse a Steam2Id from a given input string
+      def parse
+        return unless matches
+        @universe   = Integer(matches['universe'])
+        @account_id = Integer(matches['accountid'])
+        @auth_server = Integer(matches['authserver'])
+      end
+
+      private
+
+      # @api private
+      def matches
+        @matches ||= @id.match(STEAM2_REGEX)
+      end
+    end
+  end
+end

data/lib/steam/id/steam2_printer.rb

@@ -0,0 +1,39 @@
+module Steam
+  module Id
+    # Prints a given Steam::Id in the Steam2 format
+    class Steam2Printer
+      attr_reader :base
+
+      # Creates a new instance of the Steam2Printer
+      def initialize(base)
+        @base = base
+      end
+
+      # Prints the String
+      #
+      # @return [String]
+      def print
+        "STEAM_#{universe_digit}:#{account_id & 1}:#{account_id >> 1}"
+      end
+
+      private
+
+      # Gives the real digit represented by the universe
+      #
+      # @return [Integer] the universe digit
+      def universe_digit
+        universe <= EUniverse::PUBLIC ? 0 : universe
+      end
+
+      # @api private
+      def universe
+        base.universe
+      end
+
+      # @api private
+      def account_id
+        base.account_id
+      end
+    end
+  end
+end

data/lib/steam/id/steam3_id.rb

@@ -0,0 +1,29 @@
+
+module Steam
+  module Id
+    # Represents a Valve Steam Id in the Steam3 format.
+    #
+    # @note Only individual accounts are supported
+    class Steam3Id < Base
+      # Create a Steam3 id by parsing an input string
+      #
+      # @param id [String] the input id
+      def self.parse(id)
+        parser = Steam3IdParser.new(id)
+        parser.parse
+
+        new(parser.universe, parser.instance,
+            parser.account_id, parser.type)
+      end
+
+      # Instantiate a Steam3 id
+      def initialize(universe, instance, account_id, account_type)
+        super()
+        self.universe = universe
+        self.instance = instance
+        self.account_id = account_id
+        self.account_type = account_type
+      end
+    end
+  end
+end

data/lib/steam/id/steam3_id_parser.rb

@@ -0,0 +1,53 @@
+module Steam
+  module Id
+    # Parse a steam 3 id string
+    class Steam3IdParser
+      # A Regex representing a valid Steam 3 string
+      # rubocop:disable LineLength
+      STEAM3_REGEX = /\[(?<type>[AGMPCgcLTIUai]):(?<universe>[0-4]):(?<account>\d+)(:(?<instance>\d+))?\]/
+
+      attr_reader :account_id
+      attr_reader :universe
+      attr_reader :type
+
+      def initialize(id)
+        @id = id.to_s
+        @type = nil
+        @account_id = 0
+        @universe = EUniverse::INVALID
+        @type = 'U'
+      end
+
+      # Create a Steam3 id by parsing an input string
+      def parse
+        return unless matches
+
+        @account_id = Integer(matches['account'])
+        @universe = Integer(matches['universe'])
+        @type = matches['type']
+      end
+
+      # The instance of the account. Currently only instance 1 is supported
+      def instance
+        1
+      end
+
+      # The type of account as an integer
+      def type
+        case @type
+        when 'U'
+          EAccountType::INDIVIDUAL
+        else
+          EAccountType::INVALID
+        end
+      end
+
+      private
+
+      # @api private
+      def matches
+        @matches ||= @id.match(STEAM3_REGEX)
+      end
+    end
+  end
+end

data/lib/steam/id/steam3_printer.rb

@@ -0,0 +1,32 @@
+module Steam
+  module Id
+    # Prints a Steam::Id in the Steam 3 format
+    class Steam3Printer
+      attr_reader :base
+
+      # Creates a new Steam3Printer object
+      def initialize(base)
+        @base = base
+      end
+
+      # Prints the Steam::Id in Steam3 format.
+      #
+      # @note Only Individual account types are supported
+      def print
+        "[U:#{instance}:#{account_id}]"
+      end
+
+      private
+
+      # @api private
+      def instance
+        base.instance
+      end
+
+      # @api private
+      def account_id
+        base.account_id
+      end
+    end
+  end
+end

data/lib/steam/id/struct.rb

@@ -0,0 +1,91 @@
+module Steam
+  module Id
+    # The internal datastructure of a steamid. A 64 bit integer
+    class Struct
+      attr_reader :data
+
+      # The bit mask applied to get the account id
+      ACCOUNT_ID_MASK   = 0xFFFFFFFF
+
+      # The bit mask applied to get the instance mask
+      INSTANCE_MASK     = 0xFFFFF
+
+      # The bit mask applied to get the universe mask
+      UNIVERSE_MASK     = 0xFF
+
+      # The bit mask applied to get the account type
+      ACCOUNT_TYPE_MASK = 0xF
+
+      def initialize(data = 0)
+        @data = data.to_i
+      end
+
+      # Returns the internal integer
+      def to_i
+        @data.to_i
+      end
+
+      # Gets the account id
+      #
+      # @return [Integer] the account id
+      def account_id
+        get(0, ACCOUNT_ID_MASK)
+      end
+
+      # Sets the account_id
+      #
+      # @return [Integer] the account id
+      def account_id=(value)
+        set(0, ACCOUNT_ID_MASK, value)
+      end
+
+      # Gets the instance
+      #
+      # @return [Integer] the account id
+      def instance
+        get(32, INSTANCE_MASK)
+      end
+
+      # Sets the instance
+      def instance=(value)
+        set(32, INSTANCE_MASK, value)
+      end
+
+      # Gets the account type
+      #
+      # @return [Integer] the account type
+      def account_type
+        get(52, ACCOUNT_TYPE_MASK)
+      end
+
+      # Sets the account type
+      def account_type=(value)
+        set(52, ACCOUNT_TYPE_MASK, value)
+      end
+
+      # Gets the universe
+      #
+      # @return [Integer] the universe
+      def universe
+        get(56, UNIVERSE_MASK)
+      end
+
+      # Sets the universe
+      def universe=(value)
+        set(56, UNIVERSE_MASK, value)
+      end
+
+      private
+
+      # @api private
+      def get(offset, mask)
+        (@data >> offset) & mask
+      end
+
+      # @api private
+      def set(offset, mask, value)
+        @data = (@data & ~(mask << offset)) | ((value & mask) << offset)
+      end
+    end
+  end
+end

data/lib/steam/id/version.rb

@@ -0,0 +1,6 @@
+module Steam
+  module Id
+    # The current Steam::Id Gem version
+    VERSION = '0.1.0'.freeze
+  end
+end

data/steam-id.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'steam/id/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'steam-id'
+  spec.version       = Steam::Id::VERSION
+  spec.authors       = ['Taylor Finnell']
+  spec.email         = ['tmfinnell@gmail.com']
+  spec.license       = 'MIT'
+
+  spec.summary       = 'Steam IDs in Ruby.'
+  spec.description   = 'Steam IDs in Ruby.'
+  spec.homepage      = 'https://github.com/fastpeek/steam-id'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'steamd', '~> 0.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: steam-id
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Taylor Finnell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: steamd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+description: Steam IDs in Ruby.
+email:
+- tmfinnell@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/steam/id.rb
+- lib/steam/id/base.rb
+- lib/steam/id/community_id.rb
+- lib/steam/id/steam2_id.rb
+- lib/steam/id/steam2_id_parser.rb
+- lib/steam/id/steam2_printer.rb
+- lib/steam/id/steam3_id.rb
+- lib/steam/id/steam3_id_parser.rb
+- lib/steam/id/steam3_printer.rb
+- lib/steam/id/struct.rb
+- lib/steam/id/version.rb
+- steam-id.gemspec
+homepage: https://github.com/fastpeek/steam-id
+licenses:
+- MIT
+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.1
+signing_key: 
+specification_version: 4
+summary: Steam IDs in Ruby.
+test_files: []