steam-id2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1bba90f3409c8ed2fa3a29936611a9ee8f1a3ce8
+  data.tar.gz: bc66bac1e1595e8e8bf8c710c211949f6a2d429b
+SHA512:
+  metadata.gz: 5702892387d37107eb996ec168f44315c4a9958eb80a6480a5e0de143251d3c0f1ef0b13463f137260c7b63cdb3da7f0be780b83b5babfd2ce3d44372cc2b8dc
+  data.tar.gz: 24763f1af669221b5434bd12a3efbcf4b2ecadca4ef617c119596032730ae11a1bbdb108c2a44aae17f0c818c3d7bdb16a61f2b9ad425fdfb29f7775aff794b2

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+# 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] - 02.01.2017
+
+### Added
+
+- Module to allow conversion of SteamIDs into account IDs suitable for e.g.
+  Hive 2 API calls.
+
+  Supported are:
+  - Steam ID
+  - Steam ID 3
+  - Steam ID 64
+  - Community URL
+  - Profile URL

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 @@
+# CHANGE ME 
+
+## 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/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/lib/steam-id/steam_id.rb

@@ -0,0 +1,88 @@
+require 'steam-condenser'
+
+module SteamID
+  # Module to convert various formats of Steam IDs into an account ID.
+  module SteamID
+    STEAM_ID_64_OFFSET = 61197960265728
+
+    PATTERN_STEAM_ID = /^STEAM_[0-9]:([0-9]):([0-9]+)$/i
+    PATTERN_STEAM_ID_3 = /^U:([0-9]{1,2}):([0-9]+)$/i
+    PATTERN_STEAM_ID_64 = /^765([0-9]+)$/
+    # Not sure what its valid range is - exists with at least 7 and 8 numbers.
+    PATTERN_ACCOUNT_ID = /^[0-9]+$/
+
+    PATTERN_COMMUNITY_URL = /^https?:\/\/steamcommunity\.com\/profiles\/(765[0-9]+)\/?$/
+    PATTERN_CUSTOM_URL = /^https?:\/\/steamcommunity\.com\/id\/([^\/]+)\/?$/
+
+    # Resolve custom URL into account ID suitable for API calls.
+    # @param s [String] custom URL: 
+    #   - http://steamcommunity.com/id/some-custom-url
+    #   - some-custom-url
+    # @return [Fixnum] Account ID
+    # @raise [ArgumentError] If the supplied string was not a valid community URL.
+    def self.from_vanity_url(url, steam_api_key:)
+      WebApi.api_key = steam_api_key
+
+      PATTERN_CUSTOM_URL.match(url) do |m|
+        url = m[1]
+      end
+
+      steam_id = SteamId.resolve_vanity_url(url)
+      if steam_id.nil?
+        raise ArgumentError, "#{ url } was not a valid custom URL."
+      else
+        from_steam_id(steam_id)
+      end
+    end
+
+    # Convert community URL into account ID suitable for API calls.
+    # @param s [String] community URL: http://steamcommunity.com/profiles/76561198008487038
+    # @return [Fixnum] Account ID
+    # @raise [ArgumentError] If the supplied string was not a valid community URL.
+    def self.from_community_url(url)
+      PATTERN_COMMUNITY_URL.match(url) do |m|
+        return self.from_steam_id(m[1])
+      end
+
+      raise ArgumentError, "#{ url.inspect } is not a supported community URL."
+    end
+
+    # 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_steam_id(id)
+      # In case we get a fixnum.
+      id = id.to_s
+
+      # https://developer.valvesoftware.com/wiki/SteamID#Format
+      PATTERN_STEAM_ID.match(id) do |m|
+        return m[1].to_i + m[2].to_i * 2
+      end
+
+      PATTERN_STEAM_ID_3.match(id) do |m|
+        return m[2].to_i
+      end
+
+      PATTERN_STEAM_ID_64.match(id) do |m|
+        return m[1].to_i - STEAM_ID_64_OFFSET
+      end
+
+      # Matching this one last, as not to catch an ID 64 on accident.
+      PATTERN_ACCOUNT_ID.match(id) do |m|
+        return id.to_i
+      end
+
+      # If we get until here, we did not match any regex.
+      raise ArgumentError, "#{ id.inspect } is not a supported SteamID."
+    end
+
+    def self.from_string(s)
+    end
+  end
+end

data/lib/steam_id.rb

@@ -0,0 +1,7 @@
+# coding: utf-8
+
+require 'steam-id/steam_id'
+
+module SteamID
+  # Your code goes here...
+end

data/steam-id2.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          = "steam-id2"
+  spec.version       = '0.1.0'
+  spec.authors       = ["Michael Senn"]
+  spec.email         = ["michael@morrolan.ch"]
+
+  spec.summary       = %q{Convert Steam IDs}
+  # spec.description   = %q{}
+  spec.homepage      = "https://bitbucket.org/Lavode/steamid"
+  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_runtime_dependency 'steam-condenser', '~> 1.3'
+
+  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
+

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: steam-id2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Senn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: steam-condenser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/steam-id/steam_id.rb
+- lib/steam_id.rb
+- steam-id2.gemspec
+homepage: https://bitbucket.org/Lavode/steamid
+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: Convert Steam IDs
+test_files: []