steam-id2 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec86282b71c3b0a2d93e517510b3d2e61665dd55
-  data.tar.gz: 2fd43ccf4fba3dd093cbe227f0f2dd708235de26
+  metadata.gz: ee09596078843cb2f0a400b773bfb99c1577e46e
+  data.tar.gz: 04544f850fde363f3e85ef340c7c24173d08acd2
 SHA512:
-  metadata.gz: a58b02610133e911555d3a2f6f868a63764195373ebd8f3c629666628f584f98333686a72f232b6ac559ca99e7f68db33762e21bcac252cd8b9f1d5918a44673
-  data.tar.gz: 44f6747c01d2da87c87bbd8680d5e99b2ebd3c62951ce81ab8229098dc5dd8a0db220f1c1b74cf1e07897a2a6c5ec7fba5cde8e92fb7d23b12f968334bc74c33
+  metadata.gz: 14c5f853b575116936f27abc8318fc96e89d54c378bdf17748ca68fe8830b40dce7e97c2129fe85a64687bd78067588828911ffbaa795792c2dc673891b90a20
+  data.tar.gz: cb02da295fd149a4174c3dc67b659db140345eabacf26a08b1d396b2c742cfe87bc914e6bdad0835078bfa4579b118e3323e8da2bf7678f1d1a4d20e12a114b2

data/.circleci/config.yml

@@ -0,0 +1,43 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+       - image: circleci/ruby:2.4.1
+
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "steam-id2.gemspec" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: Install Dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "steam-id2.gemspec" }}
+
+      - run:
+          name: Run Tests
+          command: |
+            mkdir /tmp/test-results
+            bundle exec rspec --format RspecJunitFormatter \
+                              --out /tmp/test-results/rspec.xml \
+                              --format progress
+
+      - store_test_results:
+          path: /tmp/test-results
+
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CHANGELOG.md

@@ -19,6 +19,16 @@ glance - what to expact from upgrading to a new version.
 ### Removed
 
 
+## [0.4.0]
+
+### Added
+
+- `SteamID::SteamID` class representing a single Steam ID.
+- `Parser` class allowing to parse various formats of Steam IDs into their
+  respective account ID.
+- `SteamID#from_string` convenience method.
+
+
 ## [0.3.0] - 2017-05-30
 
 ### Added

data/lib/steam-id/parser.rb

@@ -0,0 +1,146 @@
+# coding: utf-8
+
+require 'steam-condenser'
+
+module SteamID
+  # Create SteamID objects based on numeric or string-based Steam ID inputs.
+  # @see SteamID
+  class Parser
+    # Pattern to match classical Steam IDs (STEAM_0:...)
+    PATTERN_STEAM_ID = /^STEAM_[0-9]:([0-9]):([0-9]+)$/i
+    # Pattern to match Steam ID 3 format ([U:1:...])
+    PATTERN_STEAM_ID_3 = /^\[?U:([0-9]{1,2}):([0-9]+)\]?$/i
+    # Pattern to match Steam ID 64 aka profile ID format (765...):
+    # Must have at least 14 digits, else ID_64 - OFFSET would be < 0.
+    PATTERN_STEAM_ID_64 = /^(765[0-9]{11,})$/
+    # Pattern to match plain account IDs.
+    # Not sure what its valid range is - exists with at least 7 and 8 numbers.
+    PATTERN_ACCOUNT_ID = /^[0-9]+$/
+
+    # Pattern to match ID64-based profile URLs.
+    PATTERN_COMMUNITY_URL = /^https?:\/\/steamcommunity\.com\/profiles\/(765[0-9]{11,})\/?$/
+    # Pattern to match ID3-based profile URLs.
+    PATTERN_COMMUNITY_URL_STEAM_ID_3 = /^https?:\/\/steamcommunity\.com\/profiles\/\[U:([0-9]{1,2}):([0-9]+)\]$/i
+    # Pattern to match custom-URL-based profile URLs.
+    PATTERN_CUSTOM_URL = /^https?:\/\/steamcommunity\.com\/id\/([^\/]+)\/?$/
+
+    # Initialize parser
+    # @param api_key [String] Key for Steam web API. `nil` to disable API
+    #   functionality.
+    def initialize(api_key: nil)
+      @api_key = api_key
+      if api_key
+        ::WebApi.api_key = @api_key.to_s
+      end
+    end
+
+    # Create SteamID object based on any kind of recognized Steam ID.
+    # @param s [String]: Any form of known Steam ID, profile URL, or 'vanity'/
+    #   custom URL.
+    # @see Parser#from_steam_id Supported formats of Steam IDs
+    # @see Parser#from_community_url Supported formats of community URLs
+    # @see Parser#from_vanity_url Supported formats of vanity URLs
+    # @return [SteamID]
+    # @raise [ArgumentError] If the supplied string was not a valid custom URL.
+    # @raise [WebApiError] If the Steam API returned an error.
+    def from_string(s)
+      account_id = nil
+
+      # Todo: Refactor
+      begin
+        # Checking for Steam ID first. Most restrictive check, and also does
+        # not require a call to Steam Web API.
+        account_id = from_steam_id(s)
+      rescue ArgumentError
+        begin
+          # Community URL afterwards, does not require an API call either.
+          account_id = from_community_url(s)
+        rescue ArgumentError
+          begin
+            # Trying to resolve as custom/vanity URL now.
+            account_id = from_vanity_url(s, steam_api_key: steam_api_key)
+          rescue ArgumentError
+          end
+        end
+      end
+
+      if account_id.nil?
+        raise ArgumentError, "Could not convert #{ s } to account id."
+      else
+        account_id
+      end
+    end
+
+    # Create SteamID object based on Steam ID.
+    # @param id [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 [SteamID]
+    # @raise [ArgumentError] If the supplied string could not be converted to
+    #   an account ID.
+    def 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 SteamID.new(m[1].to_i + m[2].to_i * 2)
+      end
+
+      PATTERN_STEAM_ID_3.match(id) do |m|
+        return SteamID.new(m[2].to_i)
+      end
+
+      PATTERN_STEAM_ID_64.match(id) do |m|
+        return SteamID.new(m[1].to_i - SteamID::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 SteamID.new(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
+
+    # Create SteamID object based on community URL.
+    # @param url [String] community URL: http://steamcommunity.com/profiles/76561198008487038
+    # @return [SteamID]
+    # @raise [ArgumentError] If the supplied string was not a valid community URL.
+    def from_community_url(url)
+      PATTERN_COMMUNITY_URL.match(url) do |m|
+        return self.from_steam_id(m[1])
+      end
+
+      PATTERN_COMMUNITY_URL_STEAM_ID_3.match(url) do |m|
+        return self.from_steam_id(m[2])
+      end
+
+      raise ArgumentError, "#{ url.inspect } is not a supported community URL."
+    end
+
+    # Create SteamID object based on custom URL. Note that this requires the
+    # API key to be set.
+    # @param url [String] custom URL: 
+    #   - http://steamcommunity.com/id/some-custom-url
+    #   - some-custom-url
+    # @return [SteamID]
+    # @raise [ArgumentError] If the supplied string was not a valid custom URL.
+    # @raise [WebApiError] If the Steam API returned an error.
+    def from_vanity_url(url)
+      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
+  end
+end

data/lib/steam-id/steam_id.rb

@@ -1,119 +1,42 @@
-require 'steam-condenser'
+# coding: utf-8
 
 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
-    # Must be at least 14 numbers, else ID_64 - OFFSET would be < 0.
-    PATTERN_STEAM_ID_64 = /^765([0-9]{11,})$/
-    # 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_COMMUNITY_URL_STEAM_ID_3 = /^https?:\/\/steamcommunity\.com\/profiles\/\[U:([0-9]{1,2}):([0-9]+)\]$/i
-    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
+  # Class representing a single Steam ID - that is, one logical account
+  class SteamID
+    # Offset between ID 64 and account ID.
+    ID_64_OFFSET = 76561197960265728
+    # Base URL for Steam community profiles based on ID64 / ID3.
+    PROFILE_BASE_URL = "https://steamcommunity.com/profiles"
+
+    attr_reader :account_id
+
+    # Create new SteamID
+    # @param account_id [Integer] Numeric account ID.
+    def initialize(account_id)
+      @account_id = account_id
     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
-
-      PATTERN_COMMUNITY_URL_STEAM_ID_3.match(url) do |m|
-        return self.from_steam_id(m[2])
-      end
+    # @return [String] Classical Steam ID (eg STEAM_0:....)
+    def id
+      offset = @account_id / 2
+      index  = @account_id - 2 * offset
 
-      raise ArgumentError, "#{ url.inspect } is not a supported community URL."
+      "STEAM_0:#{ index }:#{ offset }"
     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."
+    # @return [Integer] Steam ID 64 / Steam profile ID (eg 765...)
+    def id_64
+      @account_id + ID_64_OFFSET
     end
 
-    def self.from_string(s, steam_api_key: nil)
-      account_id = nil
-
-      # Todo: Refactor
-      begin
-        # Checking for Steam ID first. Most restrictive check, and also does
-        # not require a call to Steam Web API.
-        account_id = from_steam_id(s)
-      rescue ArgumentError
-        begin
-          # Community URL afterwards, does not require an API call either.
-          account_id = from_community_url(s)
-        rescue ArgumentError
-          begin
-            # Trying to resolve as custom/vanity URL now.
-            account_id = from_vanity_url(s, steam_api_key: steam_api_key)
-          rescue ArgumentError
-          end
-        end
-      end
+    # @return [String] Steam ID 3 (eg [U:1:...])
+    def id_3
+      "[U:1:#{ @account_id }]"
+    end
 
-      if account_id.nil?
-        raise ArgumentError, "Could not convert #{ s } to account id."
-      else
-        account_id
-      end
+    # @return [String] URL to player's profile on Steam community.
+    def profile_url
+      "#{ PROFILE_BASE_URL }/#{ id_64 }"
     end
   end
 end

data/lib/steam_id.rb

@@ -1,7 +1,20 @@
 # coding: utf-8
 
 require 'steam-id/steam_id'
+require 'steam-id/parser'
 
+# Handle Steam IDs.
 module SteamID
-  # Your code goes here...
+  # Create SteamID object based on Steam ID.
+  # @param s [String] Steam ID which to use.
+  # @param api_key (see Parser#initialize)
+  # @return [SteamID]
+  # @see Parser#from_string Supported formats of Steam ID.
+  # @example
+  #   id1 = SteamID.from_string('STEAM_0:0:24110655')
+  #   id2 = SteamID.from_string('gabenewell', api_key: '...')
+  #   puts "Accounts are equal: #{ id1.account_id == id2.account_id }"
+  def from_string(s, api_key: nil)
+
+  end
 end

data/steam-id2.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "steam-id2"
-  spec.version       = '0.3.0'
+  spec.version       = '0.4.0'
   spec.authors       = ["Michael Senn"]
   spec.email         = ["michael@morrolan.ch"]
 
@@ -21,8 +21,9 @@ Gem::Specification.new do |spec|
   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 "rake", "~> 12"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "yard"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.3"
+  spec.add_development_dependency "yard", "~> 0.9"
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: steam-id2
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Michael Senn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-30 00:00:00.000000000 Z
+date: 2017-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: steam-condenser
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 description: 
 email:
 - michael@morrolan.ch
@@ -87,7 +101,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
+- ".rspec"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -95,6 +111,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/steam-id/parser.rb
 - lib/steam-id/steam_id.rb
 - lib/steam_id.rb
 - steam-id2.gemspec