A lot of improvements

.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 100

.gitignore

@@ -16,3 +16,4 @@ spec/secret.rb
 test/tmp
 test/version_tmp
 tmp
+spec/examples.txt

.rspec

@@ -1 +1,4 @@
--f d -c --warning
+--require spec_helper
+--format doc
+--color
+--warning

.rubocop.yml

@@ -0,0 +1,21 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.4
+
+Layout/LineLength:
+  Max: 100
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
+Naming/FileName:
+  Exclude:
+    - lib/steam-api.rb
+Naming/AccessorMethodName:
+  Exclude:
+    - lib/steam-api/steam/**/*

Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in simple-steam.gemspec

Rakefile

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new
 
 task default: :spec
+
+desc 'Alias for spec task'
 task test: :spec

lib/steam-api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'json'
 
@@ -6,7 +8,6 @@
 require_relative 'steam-api/client'
 require_relative 'steam-api/exceptions'
 require_relative 'steam-api/response'
-require_relative 'steam-api/helpers'
 require_relative 'steam-api/steam/apps'
 require_relative 'steam-api/steam/economy'
 require_relative 'steam-api/steam/news'
@@ -15,5 +16,3 @@
 require_relative 'steam-api/steam/store'
 require_relative 'steam-api/steam/user'
 require_relative 'steam-api/steam/user_stats'
-
-include Steam::Helpers

lib/steam-api/client.rb

@@ -1,7 +1,13 @@
+# frozen_string_literal: true
+
 module Steam
   # Client object used to communicate with the steam webapi
   class Client
-    def initialize(url)
+    # @param [String] api The endpoint of the API
+    # @param [String] base_url the root uri for steam's API
+    # @return [Steam::Client] The Client
+    def initialize(api, base_url: 'https://api.steampowered.com')
+      url = File.join(base_url, api)
       @conn = Faraday.new(url: url)
     end
 
@@ -12,16 +18,16 @@ def initialize(url)
     def get(resource, params: {}, key: Steam.apikey)
       params[:key] = key
       response = @conn.get resource, params
-      JSON.parse(response.body)
-      # response
+      response = JSON.parse(response.body)
+      response = Response.new response
     rescue JSON::ParserError
       puts response.body
       # If the steam web api returns an error it's virtually never in json, so
       #   lets pretend that we're getting some sort of consistant response
       #   for errors.
       raise Steam::UnavailableError if response.status == '503'
 
-      { error: '500 Internal Server Error' }
+      Response.new error: '500 Internal Server Error'
     end
   end
 end

lib/steam-api/exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Steam
   # Error returning the requested object from the Steam API
   class SteamError < StandardError

lib/steam-api/response.rb

@@ -1,33 +1,39 @@
+# frozen_string_literal: true
+
 module Steam
   # Since the steam responses are so randomly inconsistant we're making a new
   #   class to manage the responses.
-  # FIXME: move all hash extensions here once the gem is finished and make
   class Response < Hash
-    # def parse_key(key)
-    #   fail Steam::JSONError unless self.key?(key)
-    #   self[key]
-    # end
-  end
-end
+    def initialize(raw_response)
+      super()
 
-class Hash
-  # Simple method to access a nested field, since Valve seems to like
-  #   nesting their json a few levels on every request.
-  # @param [String] key The key to extract from the hash
-  def parse_key(key)
-    raise Steam::JSONError unless key?(key)
+      raw_response.each do |key, value|
+        self[key] =
+          case value
+          when Hash then self.class.new(value)
+          else value
+          end
+      end
+    end
 
-    self[key]
-  end
+    # Simple method to access a nested field, since Valve seems to like
+    #   nesting their json a few levels on every request.
+    # @param [String] key The key to extract from the hash
+    def parse_key(key)
+      raise Steam::JSONError unless key?(key)
+
+      self[key]
+    end
 
-  # Many responses from the apis (but not all) include a success
-  #   field, so this allows us to check it wiht minimal fuss.
-  # @param [String] success_condition what the success condition should be
-  # @return [Boolean] Returns true or raises an exception.
-  def check_success(success_condition: true)
-    success = parse_key('success')
-    raise Steam::SteamError unless success == success_condition
+    # Many responses from the apis (but not all) include a success
+    #   field, so this allows us to check it wiht minimal fuss.
+    # @param [String] success_condition what the success condition should be
+    # @return [Boolean] Returns true or raises an exception.
+    def check_success(success_condition: true)
+      success = parse_key('success')
+      raise Steam::SteamError unless success == success_condition
 
-    true
+      true
+    end
   end
 end

lib/steam-api/ruby/hash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Takes a hash and converts it into a URL encoded parameter string.
 #   NOTE: this does not do any uri escaping at this point, since all args
 #         should be numeric.

lib/steam-api/steam.rb

@@ -1,19 +1,16 @@
-# Base class def
+# frozen_string_literal: true
+
+# Base class definition
 module Steam
-  @apikey = ENV['STEAM_API_KEY']
+  class << self
+    attr_writer :apikey
 
-  def self.apikey
-    if @apikey.nil?
-      unless ENV.key?('STEAM_API_KEY')
-        raise ArgumentError, 'Please set your Steam API key.'
-      end
+    def apikey
+      return @apikey if @apikey
 
-      @apikey = ENV['STEAM_API_KEY']
-    end
-    @apikey
-  end
+      raise ArgumentError, 'Please set your Steam API key.' unless ENV.key?('STEAM_API_KEY')
 
-  def self.apikey=(key)
-    @apikey = key
+      @apikey = ENV.fetch('STEAM_API_KEY')
+    end
   end
 end

lib/steam-api/steam/apps.rb

@@ -1,47 +1,50 @@
+# frozen_string_literal: true
+
 module Steam
   # A Ruby DSL for communicating with the Apps portion of the Steam Web API.
   # @see https://developer.valvesoftware.com/wiki/Steam_Web_API
   # @since 1.0.0
   module Apps
-    # Get Steam Applications
-    # @return [Hash] A list of objects containing the title and app ID of
-    #   each program available in the store.
-    # @see http://wiki.teamfortress.com/wiki/WebAPI/GetAppList
-    def self.get_all
-      response = client.get('GetApplist/v2')
-                       .parse_key('applist')
-                       .parse_key('apps')
-      response
-    end
+    class << self
+      # Get Steam Applications
+      # @return [Hash] A list of objects containing the title and app ID of
+      #   each program available in the store.
+      # @see http://wiki.teamfortress.com/wiki/WebAPI/GetAppList
+      def get_all
+        client.get('GetApplist/v2').parse_key('applist').parse_key('apps')
+      end
 
-    # Get Servers at Address
-    # @param [String] addr IP or IP:queryport to list
-    # @return [Hash] A hash containing the API response
-    # @see http://wiki.teamfortress.com/wiki/WebAPI/GetServersAtAddress
-    def self.get_servers(addr: nil, api_version: 'v1')
-      response = client.get "GetServersAtAddress/#{api_version}",
-                            params: { addr: ERB::Util.url_encode(addr) }
-      response = response.parse_key('response')
-      response.check_success
-      response.parse_key('servers')
-    end
+      # Get Servers at Address
+      # @param [String] addr IP or IP:queryport to list
+      # @return [Hash] A hash containing the API response
+      # @see http://wiki.teamfortress.com/wiki/WebAPI/GetServersAtAddress
+      def get_servers(addr: nil, api_version: 'v1')
+        response = client.get(
+          "GetServersAtAddress/#{api_version}", params: { addr: ERB::Util.url_encode(addr) }
+        )
+        response = response.parse_key('response')
+        response.check_success
+        response.parse_key('servers')
+      end
 
-    # Check if a given version of an App is current
-    # @param [Fixnum] appid AppID of game
-    # @param [Fixnum] version The installed version of the game
-    # @return [Hash] A hash containing the API response
-    # @see http://wiki.teamfortress.com/wiki/WebAPI/UpToDateCheck
-    def self.up_to_date(appid: nil, version: 'v1', api_version: 'v1')
-      response = client.get "UpToDateCheck/#{api_version}",
-                            params: { appid: appid, version: version }
-      response = response.parse_key('response')
-      response.check_success
-      response.delete('success')
-      response
-    end
+      # Check if a given version of an App is current
+      # @param [Fixnum] appid AppID of game
+      # @param [Fixnum] version The installed version of the game
+      # @return [Hash] A hash containing the API response
+      # @see http://wiki.teamfortress.com/wiki/WebAPI/UpToDateCheck
+      def up_to_date(appid: nil, version: 'v1', api_version: 'v1')
+        response = client.get(
+          "UpToDateCheck/#{api_version}", params: { appid: appid, version: version }
+        )
+        response = response.parse_key('response')
+        response.check_success
+        response.delete('success')
+        response
+      end
 
-    def self.client
-      build_client 'ISteamApps'
+      def client
+        Steam::Client.new 'ISteamApps'
+      end
     end
   end
 end