srcon 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 01ca5a4f817107e44e4504160a4e4cb5ccbda0840effff7b2ca6589a656968f8
+  data.tar.gz: 176db79c6bf541bddbb56eb066015932d013329cc4a7d961f0e3d425fe3f4535
+SHA512:
+  metadata.gz: 44a89cdf86a588a6cc03258113007fc67f023533f4894a1c8aa445388f3971f9600ec84a1f765904cc130fb616dafd7c93fa0126881b6e2265d09be230425fa7
+  data.tar.gz: 2887245f0499c8b7780d3c20b448bf732e5cdfd81c7cdebc06fd2847f7a321b35d02a314fe70809efe0a6b0f2db9b970d012a10910f3eab4ef14d30d008d821e

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.*.swp

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+srcon

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.1

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in srcon.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    srcon (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pry (~> 0.11)
+  rake (~> 10.0)
+  rspec (~> 3.7)
+  srcon!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Brandon
+
+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,45 @@
+# Srcon
+
+Srcon is a Ruby implementation of Valve's [Source RCON Protocol](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol). It is a TCP-based protocol used for communicating with [Source Dedicated Servers](https://developer.valvesoftware.com/wiki/Source_Dedicated_Server) typically accessible via Steam.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'srcon'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install srcon
+
+## Usage
+
+```ruby
+require 'srcon'
+
+connection = Srcon::Connection.new('123.45.67.8', 28717, 'some_password')
+connection.send('help')
+connection.receive
+```
+
+
+## Development
+
+1. Fork the repository.
+2. Create a new branch.
+3. Make sure tests pass.
+4. Open a pull request.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nevern02/srcon.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+$LOAD_PATH << File.expand_path('../lib/srcon', __FILE__)
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :console do
+  require 'srcon'
+  require 'pry'
+  binding.pry
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "srcon"
+
+# 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(__FILE__)

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/srcon.rb

@@ -0,0 +1,7 @@
+require 'srcon/connection'
+require 'srcon/packet'
+require 'srcon/version'
+
+module Srcon
+  class MaxPacketSize < StandardError; end
+end

data/lib/srcon/connection.rb

@@ -0,0 +1,50 @@
+require 'socket'
+
+module Srcon
+  class Connection
+    class AuthenticationFailure < StandardError; end
+
+    attr_reader :host, :port, :socket
+
+    # @param [String] host The host the server is listening on
+    # @param [Integer] port The port the server is listening on
+    # @param [String] password The password for authentication
+    def initialize(host, port, password = nil)
+      @host = host
+      @port = port
+      @id   = rand(Process.pid)
+
+      connect!(password)
+    end
+
+    # @return [Srcon::Packet] The deconstructed packet received from the socket
+    def receive
+      Srcon::Packet.from_message(*socket.recvmsg)
+    end
+
+    # @param [String] message A message to send to the server
+    # @param [Integer] type The type of message
+    #
+    # @return [Integer] The number of bytes that were sent
+    def send(message, type = Srcon::Packet::SERVERDATA_EXECCOMMAND)
+      packet = Srcon::Packet.new(message, type, @id)
+      @id += 1
+      socket&.sendmsg(packet.to_b)
+    end
+
+    private
+
+    def connect!(password = nil)
+      @socket = TCPSocket.new(host, port)
+
+      return unless password
+
+      # Authenticate if a password was provided
+      send(password, Srcon::Packet::SERVERDATA_AUTH)
+
+      response = receive
+
+      raise AuthenticationFailure.new("Failed RCON auth to #{host}:#{port}") unless response.body == 'Authenticated.'
+    end
+  end
+end

data/lib/srcon/packet.rb

@@ -0,0 +1,47 @@
+module Srcon
+  class Packet
+    MINIMUM_BYTE_SIZE = 10
+    MAXIMUM_BYTE_SIZE = 4096
+
+    # Packet types
+    SERVERDATA_AUTH           = 3
+    SERVERDATA_AUTH_RESPONSE  = 2
+    SERVERDATA_EXECCOMMAND    = 2
+    SERVERDATA_RESPONSE_VALUE = 0
+
+    attr_reader :id, :body, :type
+
+    def self.from_message(body, addrinfo, rflags)
+      body_unpacked = body.unpack('l<l<l<Z*')
+      new(body_unpacked[3], body_unpacked[2], body_unpacked[0])
+    end
+
+    # @param [String] body The message body for the packet
+    def initialize(body = '', type = SERVERDATA_EXECCOMMAND, id = 1)
+      @body = body
+      @type = type
+      @id   = id
+    end
+
+    def body=(new_body)
+      @body = new_body
+
+      if size > MAXIMUM_BYTE_SIZE
+        raise Srcon::MaxPacketSize.new("Maximum packet size is #{MAXIMUM_BYTE_SIZE} bytes")
+      end
+    end
+
+    def size
+      MINIMUM_BYTE_SIZE + body.bytesize
+    end
+
+    def to_b
+      sizeb = [size].pack('l<')
+      idb   = [id].pack('l<')
+      typeb = [type].pack('l<')
+      bodyb = [body].pack('Z*')
+
+      sizeb + idb + typeb + bodyb + "\0"
+    end
+  end
+end

data/lib/srcon/version.rb

@@ -0,0 +1,3 @@
+module Srcon
+  VERSION = "0.1.0"
+end

data/srcon.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "srcon/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "srcon"
+  spec.version       = Srcon::VERSION
+  spec.authors       = ["Brandon R."]
+  spec.email         = ["brandon@blrice.net"]
+
+  spec.summary       = %q{A socket library implementing Valve's RCON protocol.}
+  spec.description   = %q{A socket library implementing Valve's RCON protocol.}
+  spec.homepage      = "https://github.com/nevern02/srcon"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rspec",   "~> 3.7"
+  spec.add_development_dependency "pry",     "~> 0.11"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: srcon
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brandon R.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: A socket library implementing Valve's RCON protocol.
+email:
+- brandon@blrice.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/srcon.rb
+- lib/srcon/connection.rb
+- lib/srcon/packet.rb
+- lib/srcon/version.rb
+- srcon.gemspec
+homepage: https://github.com/nevern02/srcon
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A socket library implementing Valve's RCON protocol.
+test_files: []