steam_ladder 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c8ed1c0753b53024ace92b2bd23743c727e544ce252701349f7260ec7e81dc38
+  data.tar.gz: 1a8ca572d9dd6b09ab0c66a223a0597a08b7393084a9c8303fa260961c15fc9a
+SHA512:
+  metadata.gz: b163ace523b9cf6520feb717247e58460af6a372e243d3ab31902ff41182b6384a9264e14fb2fe4aaab9c380b6bffb1b54632641908fd5f6f6a6fe2dcde4e139
+  data.tar.gz: a8aa296972ecd9487141d0354dcc54ad1303ef3db6b6632d1b4a54556c336e359805b934a5df289d0250bf43a4f9ff0dd7004b1fa4b0f6844b539ca3cd866dd7

data/.devcontainer/Dockerfile

@@ -0,0 +1,19 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.191.1/containers/ruby/.devcontainer/base.Dockerfile
+
+# [Choice] Ruby version: 3, 3.0, 2, 2.7, 2.6
+ARG VARIANT="3.0"
+FROM mcr.microsoft.com/vscode/devcontainers/ruby:0-${VARIANT}
+
+# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="none"
+RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install additional gems.
+RUN gem install rubocop
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

data/.devcontainer/devcontainer.json

@@ -0,0 +1,32 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.191.1/containers/ruby
+{
+	"name": "Ruby",
+	"build": {
+		"dockerfile": "Dockerfile",
+		"args": { 
+			// Update 'VARIANT' to pick a Ruby version: 3, 3.0, 2, 2.7, 2.6
+			"VARIANT": "3",
+			// Options
+			"NODE_VERSION": "none"
+		}
+	},
+
+	// Set *default* container specific settings.json values on container create.
+	"settings": {},
+
+	// Add the IDs of extensions you want installed when the container is created.
+	"extensions": [
+		"rebornix.Ruby"
+	],
+	
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "ruby --version",
+
+	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode"
+
+}

data/.github/workflows/gem-push.yml

@@ -0,0 +1,44 @@
+name: Ruby Gem
+
+on:
+  release:
+    types:
+      - created
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+.env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+3.0.2

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm: 3.0.2
+script: bin/rspec

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    steam_ladder (1.0.0)
+      http (~> 5.0, >= 5.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.15.3)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    http (5.0.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.3.0)
+    http-cookie (1.0.4)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    json (2.5.1)
+    llhttp-ffi (0.3.1)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
+    public_suffix (4.0.6)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.1.0)
+    tins (1.29.1)
+      sync
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  coveralls (~> 0.8.23)
+  rspec (~> 3.5)
+  steam_ladder!
+
+BUNDLED WITH
+   2.2.22

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Melvin
+
+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,178 @@
+<img width="500px" src="https://user-images.githubusercontent.com/1312973/131711153-f8390028-8e1d-4e84-8b50-aa859dc4fef8.png"  />
+
+<b>Ruby wrapper for the <a href="https://steamladder.com/">Steam Ladder</a> API</b>.
+
+[![Build Status](https://app.travis-ci.com/melvinsh/steam_ladder.svg?branch=main)](https://app.travis-ci.com/melvinsh/steam_ladder)  [![Gem Version](https://badge.fury.io/rb/steam_ladder.svg)](https://badge.fury.io/rb/steam_ladder)  [![Coverage Status](https://coveralls.io/repos/github/melvinsh/steam_ladder/badge.svg?branch=main)](https://coveralls.io/github/melvinsh/steam_ladder?branch=main)
+
+## <a name='Tableofcontents'></a>Table of contents
+
+<!-- vscode-markdown-toc -->
+* [Installation](#Installation)
+* [Usage examples](#Usageexamples)
+	* [Initialization](#Initialization)
+	* [Getting a profile](#Gettingaprofile)
+	* [Updating a profile](#Updatingaprofile)
+	* [Getting a ladder](#Gettingaladder)
+		* [Normal request](#Normalrequest)
+		* [Specifying a region or country](#Specifyingaregionorcountry)
+
+<!-- vscode-markdown-toc-config
+	numbering=false
+	autoSave=true
+	/vscode-markdown-toc-config -->
+<!-- /vscode-markdown-toc -->
+
+## <a name='Installation'></a>Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'steam_ladder', '~> 1.0.0'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install steam_ladder
+```
+
+Inside of your Ruby program do:
+```ruby
+require 'steam_ladder'
+```
+
+## <a name='Usageexamples'></a>Usage examples
+### <a name='Initialization'></a>Initialization
+``` ruby
+@steam_ladder = SteamLadder.new('API_KEY')
+```
+
+### <a name='Gettingaprofile'></a>Getting a profile
+``` ruby
+profile = @steam_ladder.profile('76561198029517073')
+``` 
+
+Will return an object like the one below (with many more attributes that have been removed from this example).
+
+``` ruby
+OpenStruct {
+  :steam_user => OpenStruct {
+    :steam_name => "Melvin",
+    :steam_id => "76561198029517073",
+    :steamladder_url => "https://steamladder.com/profile/76561198029517073/",
+    :steam_join_date => "2010-08-25T18:20:11",
+    :steam_country_code => "NL",
+    :is_steam_private => false
+  },
+
+  :steam_ladder_info => OpenStruct {
+    :is_staff => false,
+    :is_winter_18 => false,
+    :is_winter_19 => false,
+    :is_donator => false,
+    :is_top_donator => false,
+    :patreon_tier => "Platinum"
+  },
+
+  :steam_stats => OpenStruct {
+    :last_update => "2021-08-17T19:54:03.800318",
+    :level => 151,
+    :xp => 122052,
+    :friends => 211,
+    :badges => OpenStruct {
+      :total => 337
+    }
+  }
+}
+```
+
+Objects can be accessed like:
+
+``` ruby
+profile.steam_user.steam_id         # '76561198029517073'
+profile.steam_user.steam_join_date  # '2010-08-25T18:20:11'
+profile.steam_stats.badges.total    # 337
+```
+
+### <a name='Updatingaprofile'></a>Updating a profile
+``` ruby
+update = @steam_ladder.update_profile('76561198029517073')
+``` 
+
+Returns an object with a `success` attribute that can be either `true` or `false`.
+If the update fails (usually due to the limit - once every four hours), the `error` attribute can be accessed.
+
+The `last_update` attribute indicates the last update time.
+
+Example implementation:
+
+``` ruby
+update = @api.update_profile('76561197996764410')
+
+if update.success
+  puts "Yay! We did it."
+else
+  puts "Oh no, something went wrong: #{update.error}"
+  puts "Last update was at #{update.last_update}, so maybe we went too fast."
+end
+```
+
+### <a name='Gettingaladder'></a>Getting a ladder
+#### <a name='Normalrequest'></a>Normal request
+``` ruby
+# Available types: xp, games, playtime, badges, steam_age, vac, game_ban
+ladder = @steam_ladder.ladder('xp')
+``` 
+
+#### <a name='Specifyingaregionorcountry'></a>Specifying a region or country
+``` ruby
+# Available country codes: alpha-2 country codes (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+# Available regions: europe, north_america, south_america, asia, africa, oceania, antarctica
+
+ladder = @steam_ladder.ladder('xp', 'nl')
+ladder = @steam_ladder.ladder('games', 'europe')
+``` 
+
+Will return an object like the one below.
+
+``` ruby
+OpenStruct {
+            :type => "XP",
+        :type_url => "xp",
+    :country_code => nil,
+          :ladder => []
+}
+```
+
+The `ladder` contains a maximum of `100` users and their position. Example user:
+
+``` ruby
+OpenStruct {
+    :pos => 0,
+    :steam_user => OpenStruct {
+      :steam_name => "St4ck",
+      :steam_id => "76561198023414915",
+      :steamladder_url => "https://steamladder.com/profile/76561198023414915/",
+      :steam_join_date => "2010-04-03T19:44:07",
+      :steam_country_code => nil,
+      :steam_avatar_src => "https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/c4/c4cad1abe3a53c25e26a827655804bf754fbbe76_full.jpg"
+    },
+    :steam_stats => OpenStruct {
+      :level => 5000,
+      :xp => 125282351,
+      :badges => OpenStruct {},
+      :games => OpenStruct {},
+      :bans => OpenStruct {}
+    }
+}    
+```
+
+So if we want the Steam name of the user in the 4th place:
+
+``` ruby
+ladder = @steam_ladder.ladder('xp')
+ladder[3].steam_user.steam_name # "K-miK"
+```
+

data/bin/bundle

@@ -0,0 +1,118 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'rubygems'
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($PROGRAM_NAME) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV['BUNDLER_VERSION']
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless 'update'.start_with?(ARGV.first || ' ') # must be running `bundle update`
+
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      bundler_version = a if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+
+      bundler_version = Regexp.last_match(1)
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV['BUNDLE_GEMFILE']
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path('../Gemfile', __dir__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when 'gems.rb' then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||=
+      env_var_version || cli_arg_version ||
+      lockfile_version
+  end
+
+  def bundler_requirement
+    return "#{Gem::Requirement.default}.a" unless bundler_version
+
+    bundler_gem_version = Gem::Version.new(bundler_version)
+
+    requirement = bundler_gem_version.approximate_recommendation
+
+    return requirement unless Gem::Version.new(Gem::VERSION) < Gem::Version.new('2.7.0')
+
+    requirement += '.a' if bundler_gem_version.prerelease?
+
+    requirement
+  end
+
+  def load_bundler!
+    ENV['BUNDLE_GEMFILE'] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem 'bundler', bundler_requirement
+    end
+    return if gem_error.nil?
+
+    require_error = activation_error_handling do
+      require 'bundler/version'
+    end
+    if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+      return
+    end
+
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+load Gem.bin_path('bundler', 'bundle') if m.invoked_as_script?

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/lib/steam_ladder.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'http'
+
+class SteamLadder
+  def initialize(key, url = 'https://steamladder.com/api/v1')
+    @key = key
+    @url = url
+  end
+
+  def profile(steam_id_64)
+    json = http_get("#{@url}/profile/#{steam_id_64}/")
+    JSON.parse(json, object_class: OpenStruct)
+  end
+
+  def update_profile(steam_id_64)
+    json = http_post("#{@url}/profile/#{steam_id_64}/")
+    response = JSON.parse(json, object_class: OpenStruct)
+
+    if response.error
+      OpenStruct.new(
+        success: false,
+        error: response.error,
+        last_update: response.last_update
+      )
+    else
+      OpenStruct.new(
+        success: true,
+        last_update: response.steam_stats.last_update
+      )
+    end
+  end
+
+  def ladder(type, country = nil)
+    url = "#{@url}/ladder/#{type}/"
+    url += "#{country}/" if country
+
+    json = http_get(url)
+    JSON.parse(json, object_class: OpenStruct)
+  end
+
+  private
+
+  def http_get(url)
+    HTTP.headers(authorization: "Token #{@key}")
+        .get(url)
+  end
+
+  def http_post(url)
+    HTTP.headers(authorization: "Token #{@key}")
+        .post(url)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+unless ENV['API_KEY']
+  raise "Please set ENV['API_KEY'] in order to run the tests."
+  exit 1
+end
+
+require 'coveralls'
+Coveralls.wear!
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # This allows you to limit a spec run to individual examples or groups
+  #   # you care about by tagging them with `:focus` metadata. When nothing
+  #   # is tagged with `:focus`, all examples get run. RSpec also provides
+  #   # aliases for `it`, `describe`, and `context` that include `:focus`
+  #   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  #   config.filter_run_when_matching :focus
+  #
+  #   # Allows RSpec to persist some state between runs in order to support
+  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
+  #   # you configure your source control system to ignore this file.
+  #   config.example_status_persistence_file_path = "spec/examples.txt"
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  #   config.disable_monkey_patching!
+  #
+  #   # This setting enables warnings. It's recommended, but in some cases may
+  #   # be too noisy due to issues in dependencies.
+  #   config.warnings = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = "doc"
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # 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
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end

data/spec/steam_ladder_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative '../lib/steam_ladder'
+
+describe SteamLadder do
+  before do
+    @api = SteamLadder.new(ENV['API_KEY'])
+  end
+
+  describe 'profile' do
+    it 'retrieves a Steam Ladder profile' do
+      profile = @api.profile('76561198029517073')
+
+      expect(profile.steam_user.steam_id).to eq('76561198029517073')
+      expect(profile.steam_user.steam_join_date).to eq('2010-08-25T18:20:11')
+    end
+  end
+
+  describe 'update_profile' do
+    it 'updates a Steam Ladder profile' do
+      update = @api.update_profile('76561197996764410')
+
+      expect(update).to respond_to(:success, :last_update)
+
+      expect(update.success).to be(true).or be(false)
+      expect(update.last_update).to be_a(String)
+
+      unless update.success
+        expect(update).to respond_to(:error)
+        expect(update.error).to be_a(String)
+      end
+    end
+  end
+
+  describe 'ladder' do
+    it 'retrieves a Steam ladder by type' do
+      ladder = @api.ladder('xp')
+
+      expect(ladder.type).to eq('XP')
+      expect(ladder.ladder).to be_an_instance_of(Array)
+      expect(ladder.ladder.length).to eq(100)
+      expect(ladder.country_code).to eq(nil)
+    end
+
+    it 'retrieves a Steam ladder by type and country' do
+      ladder = @api.ladder('playtime', 'nl')
+
+      expect(ladder.type).to eq('PT')
+      expect(ladder.ladder).to be_an_instance_of(Array)
+      expect(ladder.ladder.length).to eq(100)
+      expect(ladder.country_code).to eq('NL')
+    end
+
+    it 'retrieves a Steam ladder by type and region' do
+      ladder = @api.ladder('badges', 'europe')
+
+      expect(ladder.type).to eq('B')
+      expect(ladder.ladder).to be_an_instance_of(Array)
+      expect(ladder.ladder.length).to eq(100)
+      expect(ladder.country_code).to eq('EUROPE')
+    end
+  end
+end

data/steam_ladder.gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |gem|
+  gem.name          = 'steam_ladder'
+  gem.version       = '1.0.1'
+  gem.licenses      = ['MIT']
+  gem.summary       = 'Ruby wrapper for the Steam Ladder API.'
+  gem.description   = 'Ruby wrapper to access the Steam Ladder API at https://steamladder.com/api/.'
+  gem.authors       = ['Melvin Lammerts']
+  gem.email         = 'hi@melv.in'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- spec/*`.split("\n")
+  gem.require_paths = ['lib']
+
+  gem.homepage      = 'https://rubygems.org/gems/steam_ladder'
+  gem.metadata      = { 'source_code_uri' => 'https://github.com/melvinsh/steam_ladder' }
+
+  gem.add_runtime_dependency 'http', '~> 5.0', '>= 5.0.1'
+
+  gem.add_development_dependency 'coveralls', '~> 0.8.23'
+  gem.add_development_dependency 'rspec', '~> 3.5'
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: steam_ladder
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Melvin Lammerts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: Ruby wrapper to access the Steam Ladder API at https://steamladder.com/api/.
+email: hi@melv.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".devcontainer/Dockerfile"
+- ".devcontainer/devcontainer.json"
+- ".github/workflows/gem-push.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- bin/bundle
+- bin/rspec
+- lib/steam_ladder.rb
+- spec/spec_helper.rb
+- spec/steam_ladder_spec.rb
+- steam_ladder.gemspec
+homepage: https://rubygems.org/gems/steam_ladder
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/melvinsh/steam_ladder
+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: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Steam Ladder API.
+test_files:
+- spec/spec_helper.rb
+- spec/steam_ladder_spec.rb