hotline 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ddf955bd5b12ad0d8122b1e07de691b29f68705517fd6878247ff6063a3c857a
+  data.tar.gz: 14579f74347736e736ee01108552f4ab3da18a3e922284491601e3a25f14c0e8
+SHA512:
+  metadata.gz: bd6f30ba39f7d004f888be1ff62aee9d7e83e15ba10bd7ea97e793904cfeaf1292514ce8424d6fdc250ea7832546f65ce675cc6cec1173dd6f199265666d26c4
+  data.tar.gz: f0b368c0bd91a5eeb0ba29cfaf978fcb9f1ee7cc5c089fa31283a673d9b2511585c6d645b52d7838449e2431ac0cf033b398d900400bc75d471359ae32bd8685

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Bryce Mecum
+
+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,64 @@
+# hotline
+
+![CI](https://github.com/amoeba/hotline/actions/workflows/ruby.yml/badge.svg)
+
+An implementation of the Hotline protocols, currently just the tracker client.
+
+Implementation status:
+
+- [ ] Server
+  - [ ] Server
+  - [ ] Client
+- [ ] Tracker
+  - [ ] Server
+  - [x] Client
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hotline'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hotline
+
+## Usage
+
+At this point, only the tracker client is written:
+
+### Tracker Client
+
+```ruby
+require 'hotline/tracker/client'
+
+client = Hotline::Tracker::Client.new("hltracker.com")
+client.fetch
+client.servers.each do |server|
+    puts server.name
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/amoeba/hotline. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Hotline project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/amoeba/hotline/blob/main/CODE_OF_CONDUCT.md).

data/bin/tracker_client

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'hotline'
+
+host = ARGV[0]
+
+if host.nil? || host.length <= 0
+  puts "Usage: tracker_client [tracker_url]"
+  exit(1)
+end
+
+client = Hotline::Tracker::Client.new(host)
+client.fetch
+client.servers.each do |s|
+  puts s.name
+end

data/lib/hotline/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Hotline
+  VERSION = "0.1.0"
+end

data/lib/hotline.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "hotline/version"
+require_relative "tracker/client"
+
+module Hotline
+end

data/lib/tracker/client.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "socket"
+require "bindata"
+require "hotline/version"
+require_relative "types"
+require_relative "exceptions"
+
+module Hotline
+  module Tracker
+    class Client
+      DEFAULT_PORT = 5498
+      RECV_TIMEOUT = 20
+
+      attr_reader :version
+
+      def initialize(host = nil, port = DEFAULT_PORT, version = 1)
+        @host = host
+        @port = port
+        @version = version.to_s
+      end
+
+      def to_s
+        [
+          self.class.name,
+          "{host: #{@host}, port: #{@port}, version: #{@version}}"
+        ].join("")
+      end
+
+      def socket
+        @socket ||= begin
+          s = TCPSocket.new(@host, @port)
+          s.setsockopt(Socket::SOL_SOCKET, Socket::SO_RCVTIMEO, [RECV_TIMEOUT, 0].pack("l_2"))
+          s
+        end
+      end
+
+      def servers
+        @servers ||= []
+      end
+
+      def fetch
+        handshake
+        header = read_header
+        @servers = read_servers(header)
+      end
+
+      private
+
+      def handshake
+        request = Request.new(version: version.to_i)
+        request.write(socket)
+
+        response = Request.read(socket.read(request.num_bytes))
+        raise InvalidTrackerResponse if response != request
+      end
+
+      def read_header
+        Response.read(socket.read(Response.new.num_bytes))
+      end
+
+      def read_servers(header)
+        data = socket.read(header.remaining)
+        servers = []
+        cursor = 0
+
+        header.n.times do
+          server = Server.read(data[cursor..])
+          servers << server
+          cursor += server.num_bytes
+        end
+
+        servers
+      end
+    end
+  end
+end

data/lib/tracker/exceptions.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class InvalidTrackerResponse < StandardError
+end

data/lib/tracker/types.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Request < BinData::Record
+  endian :big
+  string :protocol, read_length: 4, value: "HTRK"
+  uint16 :version
+end
+
+class Response < BinData::Record
+  endian :big
+
+  uint16 :kind
+  uint16 :remaining
+  uint16 :padding
+  uint16 :n
+end
+
+class Server < BinData::Record
+  endian :big
+
+  uint32 :ip
+  uint16 :port
+  uint16 :n_users
+  uint16 :empty # Not used
+
+  uint8 :name_len
+  string :name, read_length: :name_len
+
+  uint8 :desc_len
+  string :description, read_length: :desc_len
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: hotline
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bryce Mecum
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bindata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: An implementation of the Hotline protocols, currently just the tracker
+  client.
+email:
+- petridish@gmail.com
+executables:
+- tracker_client
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/tracker_client
+- lib/hotline.rb
+- lib/hotline/version.rb
+- lib/tracker/client.rb
+- lib/tracker/exceptions.rb
+- lib/tracker/types.rb
+homepage: https://github.com/amoeba/hotline
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/amoeba/hotline
+  source_code_uri: https://github.com/amoeba/hotline
+  changelog_uri: https://github.com/amoeba/hotline/releases
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Ruby gem for the Hotline protocol
+test_files: []