steamrb 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99caa4cd2e21acd6cf5b3d53ce3079a6ca6a7a15
-  data.tar.gz: 3ccd1cc12a21b735f67d42d511b94a3c6a9079e2
+  metadata.gz: 4b1b84d1db3f1b16870c6f5ee648e92d63ca80d6
+  data.tar.gz: 596e8ec9bcaea8a9416c91055970d04fb668f949
 SHA512:
-  metadata.gz: 2593c4948cd249f4464e3baabd18252ee7ba1b616cf81955cf5dddfa5303e63b65db3f3ff3ecc0ebb9c8472c50689a568aeb4fbba99cdf89e7b85aa2dd7753b8
-  data.tar.gz: 532adb1b7b9e99a5faff2e845d2a6f689b2684b0b88f181d69c77b65378dcac16e2b2704820309045b2a6a4b49e02f6cc9c0e48b1e5aceae41816e41bcac1a9d
+  metadata.gz: 61a3e00b660a8b68b8a16fdc65ef4371a355b65c89fb2e9d981072db2c2eb3492fba7125d1a13100f542f35e413947a73eef941e793f99d1e90758090f05e7a1
+  data.tar.gz: c88a674ece9968ebb3c9a4079652bd958c75dceae9b4dfa8de1bab2ca8b6655a4332af9d598fcf98896ac56c7d919cf9db7e39c9a540ebca715dfb0485a6683d

data/.yardopts

@@ -0,0 +1 @@
+--markup=markdown

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016
+
+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

@@ -1,4 +1,6 @@
 # Steam
+[![Build Status](https://travis-ci.org/fastpeek/steam.svg?branch=master)](https://travis-ci.org/fastpeek/steamrb)
+![Gem Version](https://img.shields.io/gem/v/steamrb.svg)
 
 Ruby Client for Steam.
 
@@ -108,9 +110,17 @@ bot.plugin(:csgo)
 bot.start
 ```
 
+## Running the tests
+
+To run the integration tests you must specify a Steam username and password. For
+the plugin integration test to pass this account must have CS:GO installed.
+
+`STEAM_LOG_LEVEL=DEBUG USERNAME=username PASSWORD=password rake spec:all`
+
 ## License
 
-MIT
+[MIT](https://github.com/fastpeek/steam/blob/master/LICENSE)
 
 ## References
 [SteamKit](https://github.com/SteamRE/SteamKit/)
+ 

data/lib/steam/byte_reader.rb

@@ -6,8 +6,6 @@ module Steam
   class ByteReader
     extend Forwardable
 
-    attr_reader :io
-
     # Create a ByteReader object
     #
     # @param io [:read] an io object
@@ -15,63 +13,29 @@ module Steam
       @io = io
     end
 
-    # Reads an unsigned 64 bit integer from the stream
-    #
-    # @return [Integer] The 64 bit integer
-    def read_int64
-      io.read(8).unpack('C*').each_with_index.reduce(0) do |sum, (byte, index)|
-        sum + byte * (256**index)
-      end
-    end
-    alias int64 read_int64
-
-    # Reads an unsigned short from the stream
-    #
-    # @return [Integer] The short
-    def read_short
-      io.read(2).unpack('S*').first
-    end
-    alias short read_short
-
     # Reads a string of a given length from the stream
     #
+    # @param len [Integer] the number of bytes to read
     # @return [String] The read string
     def string(len)
-      io.read(len)
-    end
-
-    # Reads a single bytes from the stream
-    #
-    # @return [Integer] The byte
-    def byte
-      io.read(1).ord
+      read(len)
     end
 
     # Reads an unsigned 32 bit integer from the stream
     #
     # @return [Integer] The 32 bit integer
     def unsigned_int32
-      io.read(4).unpack('<I*').first
+      @io.read(4).unpack('<I*').first
     end
 
     # Reads an signed 32 bit integer from the stream
     #
     # @return [Integer] The 32 bit integer
     def signed_int32
-      io.read(4).unpack('<i*').first
-    end
-
-    # Reads an signed 16 bit integer from the stream
-    #
-    # @return [Integer] The 16 bit integer
-    def signed_int16
-      io.read(2).unpack('<s*').first
+      @io.read(4).unpack('<i*').first
     end
 
     def_delegator :@io, :read, :read
-    def_delegator :@io, :readbyte, :readbyte
     def_delegator :@io, :eof?, :eof?
-    def_delegator :@io, :tell, :tell
-    def_delegator :@io, :lineno, :lineno
   end
 end

data/lib/steam/byte_writer.rb

@@ -6,8 +6,6 @@ module Steam
   class ByteWriter
     extend Forwardable
 
-    attr_reader :io
-
     # Wrap an Int64 allowing the lo and hi
     # 32 bits to be extracted
     class Int64Type
@@ -55,11 +53,6 @@ module Steam
       @io.write([value].pack('<I'))
     end
 
-    # Writes an signed long from the stream
-    def write_signed_long(value)
-      @io.write([value].pack('<l_'))
-    end
-
     # Writes a 32 bit intger to the stream
     def write_int32(value)
       @io.write([value].pack('<l'))
@@ -74,16 +67,10 @@ module Steam
       end
     end
 
-    # Writes a single byte to the stream
-    def write_byte(byte)
-      @io.write([byte].pack('C'))
-    end
-
     # Writes the given bytes to the stream
     def write(bytes)
       @io.write(bytes)
     end
-    alias write_string write
 
     # The byte representation of this writer object
     #

data/lib/steam/emsg_util.rb

@@ -3,7 +3,8 @@ module Steam
   # Utility to provide EMsg convenience. Allows looking up
   # EMsg name by the EMsg integer value.
   #
-  # EMsgUtil.new(123).name # => 'SOME_EMSG'
+  # @example Getting an EMsg name from its value
+  #   EMsgUtil.new(123).name # => 'SOME_EMSG'
   class EMsgUtil
     # Instantiate the object
     #

data/lib/steam/handler/collection.rb

@@ -22,7 +22,8 @@ module Steam
         handler = find_handler(packet.msg_type)
 
         if handler.nil?
-          Steam.logger.debug("No hander found for: #{EMsgUtil.new(packet.emsg).name}")
+          emsg = EMsgUtil.new(packet.emsg)
+          Steam.logger.debug("No hander found for: #{emsg.name}")
           return false
         end
 

data/lib/steam/logger.rb

@@ -2,8 +2,16 @@
 require 'logger'
 
 module Steam
-  # Small wrapper around the Ruby Logger class
+  # Small wrapper around the Ruby Logger class. A `STEAM_LOG_LEVEL`
+  # environment variable may also dictate the log level.
+  #
+  # @example Creating a Logger object
+  #   logger = Logger.new(STDOUT)
+  #   logger.level = Logger::WARN
   class Logger < ::Logger
+    # Raised when the #env_key env variable is not supported
+    InvalidLogLevel = Class.new(StandardError)
+
     # Log level WARN
     WARN  = ::Logger::WARN
     # Log level INFO
@@ -18,10 +26,31 @@ module Steam
     # Create a Logger that logs to a given IO object
     #
     # @param io [#read] The io object
-    # @param level [Integer] log lvel
-    def initialize(io, level = DEBUG)
-      self.level = level
+    def initialize(io)
       super(io)
+      self.level = _level
+    end
+
+    private
+
+    # @api private
+    def _level
+      level = ENV[env_key]
+      level = 'DEBUG' if level.nil? || level.empty?
+      unless allowed_levels.include?(level.to_s)
+        raise InvalidLogLevel, "log level #{level} not allowed, must be one of"\
+                  "#{allowed_levels}"
+      end
+      self.class.const_get("Logger::#{level}")
+    end
+
+    # @api private
+    def allowed_levels
+      %w(WARN INFO ERROR DEBUG FATAL)
+    end
+
+    def env_key
+      'STEAM_LOG_LEVEL'
     end
   end
 end

data/lib/steam/networking/packet.rb

@@ -39,8 +39,8 @@ module Steam
       def encode
         stream = ByteWriter.new
         stream.write_unsigned_int32(body.length)
-        stream.write_string(TCP_MAGIC)
-        stream.write_string(body)
+        stream.write(TCP_MAGIC)
+        stream.write(body)
         stream.string
       end
 

data/lib/steam/plugins.rb

@@ -89,18 +89,17 @@ module Steam
 
     # @api private
     def require_plugins
-      required_plugins = @plugins.map do |plugin|
-        begin
-          require "steam/#{plugin}"
-          plugin
-        rescue LoadError
-          msg = "Failed to load #{plugin} plugin. Is it in your Gemfile?"
-          Steamd.logger.error(msg)
-          nil
-        end
-      end
+      @plugins.map { |plugin| _require(plugin) }.compact
+    end
 
-      required_plugins.compact
+    # @api private
+    def _require(plugin)
+      require "steam/#{plugin}"
+      plugin
+    rescue LoadError
+      msg = "Failed to load steam-#{plugin} plugin. Is it in your Gemfile?"
+      Steamd.logger.error(msg)
+      nil
     end
   end
 end

data/lib/steam/version.rb

@@ -7,7 +7,7 @@ module Steam
   MINOR = '1'
 
   # Patch version of the gem
-  PATCH = '0'
+  PATCH = '1'
 
   # Current Steam gem version
   VERSION = [MAJOR, MINOR, PATCH].join('.')

data/lib/steam.rb

@@ -36,11 +36,7 @@ module Steam
   #
   # @param io [:read] the io stream
   # @return [Steam::Logger]
-  def self.logger(io = STDOUT, level = Steam::Logger::INFO)
-    @logger ||= begin
-                  logger = Steam::Logger.new(io)
-                  logger.level = level
-                  logger
-                end
+  def self.logger(io = STDOUT)
+    @logger ||= Steam::Logger.new(io)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: steamrb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Taylor Finnell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-01 00:00:00.000000000 Z
+date: 2016-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: steamd
@@ -149,7 +149,9 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/console