steam-web-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 630561b41e626bba893ea0e76999dc6c9bf2190d
+  data.tar.gz: bd2d4303a27167872dce046dad6740031cd8ba7c
+SHA512:
+  metadata.gz: dfc10ac3067351b69b84f847b1a4be0497fb6b5d5cf208d107c5f2be978737ee535fb349ff8a3d5c12a446fc8ad046586fda1ad28ddbc406cef9a3d46c5a2c94
+  data.tar.gz: a86824291f5bc51cee344d7b15a204f4f82725220c1474c93bf17ce671e907db4ca9d023f0ed79698782fef28aa3e9df1bff2c7a0b5db2f359b244d0f44f6be1

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  TargetRubyVersion: 2.3

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,39 @@
+# Steam::Web::Api
+
+Ruby interface to Valve's Steam web API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'steam-web-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install steam-web-api
+
+## Usage
+
+To configure the gem, one must set the `STEAM_API_KEY` environment variable
+to the api key issued to you by Valve.
+
+```ruby
+steam_user = Steam::Web::Api::User.new
+steam_user.friends('76561197998193728')
+```
+
+## Running tests
+
+You must specify `STEAM_API_KEY`.
+
+`STEAM_API_KEY=123 rake spec`
+
+## License
+
+MIT

data/Rakefile

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

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'steam/web/api'
+
+# 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/web/api.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+require 'net/http'
+
+require 'steam/web/api/version'
+require 'steam/web/api/configuration'
+
+require 'steam/web/api/connection'
+require 'steam/web/api/request'
+require 'steam/web/api/request_url'
+require 'steam/web/api/request_params'
+require 'steam/web/api/response'
+require 'steam/web/api/client'
+
+require 'steam/web/api/vanity_url'
+
+require 'steam/web/api/interfaces/steam_user'
+
+module Steam
+  module Web
+    # Access to Steam's web api
+    #
+    # @example Using the SteamUser interface
+    #   steam_user = Steam::Web::Api::SteamUser.new
+    #   steam_user.bans(steam_id)
+    module Api
+    end
+  end
+end

data/lib/steam/web/api/client.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+module Steam
+  module Web
+    module Api
+      # Handles http concerns for the steam api.
+      class Client
+        attr_reader :interface
+
+        def initialize(interface)
+          @interface = interface
+        end
+
+        def get(method, params = {}, version = nil)
+          url = RequestUrl.new(interface, method, params, version)
+          request = Request.new(url)
+          http = Connection.new
+          resp = http.get(request)
+          Response.new(resp)
+        end
+      end
+    end
+  end
+end

data/lib/steam/web/api/configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Steam
+  module Web
+    module Api
+      # Holds the configuration required to use the web api
+      class Configuration
+        attr_reader :steam_api_key
+
+        def initialize
+          @steam_api_key = ENV['STEAM_API_KEY']
+        end
+      end
+    end
+  end
+end

data/lib/steam/web/api/connection.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Steam
+  module Web
+    module Api
+      class Connection
+        def get(request)
+          Net::HTTP.start(request.host, 80) do |http|
+            request = Net::HTTP::Get.new(request.url)
+            http.request(request)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/steam/web/api/interfaces/steam_user.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+module Steam
+  module Web
+    module Api
+      # Represents the SteamUser steam api interface.
+      class SteamUser
+        # Valve's steam user interface name
+        INTERFACE = 'ISteamUser'
+
+        def initialize
+          @client = Client.new(INTERFACE)
+        end
+
+        # Get player summaries.
+        #
+        # @return [Hash<String, Hash>] hash of player summaries keyed by community id
+        def player_summaries(*steam_ids)
+          result = @client
+                   .get('GetPlayerSummaries', steamids: steam_ids.join(','))
+                   .extract(:response, :players)
+
+          result.each_with_object({}) do |player, hsh|
+            hsh[player['steamid']] = player
+            hsh
+          end
+        end
+
+        # Get player friends.
+        #
+        # @return [Hash<String, Hash>] hash of player friends keyed by community id
+        def friends(steam_id)
+          result = @client
+                   .get('GetFriendList', { steamid: steam_id }, 'v0001')
+                   .extract(:friendslist, :friends)
+
+          result.each_with_object({}) do |friend, hsh|
+            steam_id = friend.delete('steamid')
+            hsh[steam_id] = friend
+          end
+        end
+
+        # Get player bans.
+        #
+        # @return [Hash<String, Hash>] hash of player bans keyed by community id
+        def bans(*steam_ids)
+          body = { steamids: steam_ids.join(',') }
+
+          result = @client
+                   .get('GetPlayerBans', body, 'v1')
+                   .extract(:players)
+
+          result.each_with_object({}) do |player, hsh|
+            steam_id = player.delete('SteamId')
+            hsh[steam_id] = player
+          end
+        end
+
+        # Resolve a vanity url to a community id. You may pass in the
+        # vanity name or the full communtity profile url.
+        #
+        # @return [String,nil] the community id if resolved, otherwise nil
+        def resolve_vanity_url(vanity)
+          body = { vanityurl: VanityUrl.new(vanity).url }
+
+          @client
+            .get('ResolveVanityURL', body, 'v0001')
+            .extract(:response, :steamid)
+        end
+      end
+    end
+  end
+end

data/lib/steam/web/api/request.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module Steam
+  module Web
+    module Api
+      class Request
+        # Instantiate a request object
+        #
+        # @param url [RequestUrl] the request url object
+        def initialize(url)
+          @url = url
+        end
+
+        def url
+          @url.to_s
+        end
+
+        def host
+          uri.host
+        end
+
+        private
+
+        def uri
+          URI(url)
+        end
+      end
+    end
+  end
+end

data/lib/steam/web/api/request_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Steam
+  module Web
+    module Api
+      class RequestParams
+        def initialize(params = {})
+          @params = params
+        end
+
+        def query_string
+          to_hash.each_pair.map { |key, val| "#{key}=#{val}" }.join('&')
+        end
+
+        def to_hash
+          @params.merge(key: Configuration.new.steam_api_key)
+        end
+      end
+    end
+  end
+end

data/lib/steam/web/api/request_url.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+module Steam
+  module Web
+    module Api
+      class RequestUrl
+        DEFAULT_VERSION = 'v0002'
+
+        attr_reader :interface, :method, :params, :version
+
+        def initialize(interface, method, params, version)
+          @interface = interface
+          @method = method
+          @params = params
+          @version = version
+        end
+
+        def to_s
+          "#{url}?#{RequestParams.new(params).query_string}"
+        end
+
+        private
+
+        def url
+          [base, interface, method, version].join('/')
+        end
+
+        def version
+          @version || DEFAULT_VERSION
+        end
+
+        def base
+          'http://api.steampowered.com'
+        end
+      end
+    end
+  end
+end

data/lib/steam/web/api/response.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+module Steam
+  module Web
+    module Api
+      class Response
+        def initialize(http_response)
+          @response = http_response.dup
+        end
+
+        def extract(*keys)
+          if code == 200
+            parsed_body.dig(*keys.map(&:to_s))
+          else
+            []
+          end
+        end
+
+        def parsed_body
+          JSON.parse(body)
+        rescue JSON::ParserError
+          {}
+        end
+
+        def body
+          @response.body
+        end
+
+        def code
+          @response.code.to_i
+        end
+      end
+    end
+  end
+end

data/lib/steam/web/api/vanity_url.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module Steam
+  module Web
+    module Api
+      class VanityUrl
+        def initialize(url)
+          @vanity = url
+        end
+
+        def url
+          if url?
+            @vanity.split('/').last
+          else
+            @vanity
+          end
+        end
+
+        private
+
+        def url?
+          @vanity.include?('steamcommunity')
+        end
+      end
+    end
+  end
+end

data/lib/steam/web/api/version.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module Steam
+  module Web
+    module Api
+      # Current Steam::Web::Api major version.
+      MAJOR = '0'
+
+      # Current Steam::Web::Api minor version.
+      MINOR = '1'
+
+      # Current Steam::Web::Api patch version.
+      PATCH = '0'
+
+      # Current Steam::Web::Api version.
+      VERSION = [
+        MAJOR,
+        MINOR,
+        PATCH
+      ].join('.')
+    end
+  end
+end

data/steam-web-api.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'steam/web/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'steam-web-api'
+  spec.version       = Steam::Web::Api::VERSION
+  spec.authors       = ['Taylor Finnell']
+  spec.email         = ['tmfinnell@gmail.com']
+  spec.license       = 'MIT'
+
+  spec.summary       = "Ruby interface to Valve's Web API"
+  spec.description   = "Ruby interface to Valve's Web API"
+  spec.homepage      = 'http://github.com/fastpeek/steam-web-api'
+
+  spec.required_ruby_version = '>= 2.3'
+
+  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_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 2.3'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.44.1'
+  spec.add_development_dependency 'pry', '~> 0.10.4'
+  spec.add_development_dependency 'dotenv', '~> 2.2'
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: steam-web-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Taylor Finnell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-17 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.44.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.44.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: Ruby interface to Valve's Web API
+email:
+- tmfinnell@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/steam/web/api.rb
+- lib/steam/web/api/client.rb
+- lib/steam/web/api/configuration.rb
+- lib/steam/web/api/connection.rb
+- lib/steam/web/api/interfaces/steam_user.rb
+- lib/steam/web/api/request.rb
+- lib/steam/web/api/request_params.rb
+- lib/steam/web/api/request_url.rb
+- lib/steam/web/api/response.rb
+- lib/steam/web/api/vanity_url.rb
+- lib/steam/web/api/version.rb
+- steam-web-api.gemspec
+homepage: http://github.com/fastpeek/steam-web-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+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: Ruby interface to Valve's Web API
+test_files: []