cinc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9c2928e6ef48aa239557a092667aedaccb2e87cad9f12bbbeb9a02e1f7c93ca5
+  data.tar.gz: 75a9d7c898051045a1ee483f80de46eb911d77fee01ee7ad155ba0c339cf59af
+SHA512:
+  metadata.gz: a7e9d1dc0306e6394066500c0302e8763a815591124893453e770da86c3675ab4eeeb073876766c9a82dc0c014f526e7707dd981413d7d0c29fc396cb10c2efd
+  data.tar.gz: 7a4101f7fc9ce8731c62226e41e474719a7bf9b69dea6838c3ae40ed58cf16e99e29e300babb4bab23a8b9b92fd074f7b5602f7e3722ab8bfd5c0d05d71ad0b4

data/.gitignore

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

data/.ruby-gemset

@@ -0,0 +1 @@
+cinc

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Basic client with `get_airbases` method that returns details of all airbases on map

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cinc.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jeffrey Jones
+
+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,54 @@
+# Cinc
+
+A ruby client for the "Commander In Chief" (Cinc) 3rd party RCP server that
+runs on an instance of the Digital Combat Simulator (DCS) game.
+
+See https://gitlab.com/cinc/cinc-server/tree/master/src for more information on
+the Cinc server.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cinc'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install cinc
+
+## Usage
+
+```
+require 'cinc'
+
+client = Cinc::Client.new("hostname", 9001)
+
+array_of_airbase_hashes = client.get_airbases
+
+```
+
+## 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 Gitlab at https://gitlab.com/cinc/cinc-ruby-client
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cinc"
+
+# 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/cinc.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/cinc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cinc"
+  spec.version       = Cinc::VERSION
+  spec.authors       = ["Jeffrey Jones"]
+  spec.email         = ["jeff@jones.be"]
+
+  spec.summary       = %q{CinC (Commander-In-Chief) is an 3rd RPC system for Eagle Dynamics's DigitalCombatSimulator}
+  spec.homepage      = "https://gitlab.com/cinc/cinc-ruby-client"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://gitlab.com/cinc/cinc-ruby-client"
+  spec.metadata["changelog_uri"] = "https://gitlab.com/cinc/cinc-ruby-client/-/blob/master/CHANGELOG.md"
+  spec.metadata["bug_tracker_uri"] = "https://gitlab.com/cinc/cinc-ruby-client/-/issues"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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"]
+end

data/lib/cinc.rb

@@ -0,0 +1,6 @@
+require "cinc/version"
+require "cinc/client"
+
+module Cinc
+  class ConnectionError < StandardError; end
+end

data/lib/cinc/client.rb

@@ -0,0 +1,46 @@
+require 'socket'
+require 'json'
+
+module Cinc
+  class Client
+
+    def initialize(server = 'localhost', port = 9001)
+      @socket = TCPSocket.new(server, port)
+      rescue StandardError => e
+        raise ConnectionError.new(e.message)
+    end
+
+    def get_airbases
+      command = Command.new('get_airbases', {})
+
+      return process_command(command)
+    end
+
+    private
+
+    def process_command(command)
+      @socket.puts command.to_json
+      return JSON.parse @socket.gets
+      rescue StandardError => e
+        raise ConnectionError.new(e.message)
+    end
+
+    class Command
+
+      attr_accessor :name, :arguments
+
+      def initialize(name, arguments)
+        @name = name
+        @arguments = arguments
+      end
+
+      def to_json
+        {
+          name: name,
+          arguments: arguments
+        }.to_json
+      end
+
+    end
+  end
+end

data/lib/cinc/version.rb

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

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: cinc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeffrey Jones
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-08 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- jeff@jones.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cinc.gemspec
+- lib/cinc.rb
+- lib/cinc/client.rb
+- lib/cinc/version.rb
+homepage: https://gitlab.com/cinc/cinc-ruby-client
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/cinc/cinc-ruby-client
+  source_code_uri: https://gitlab.com/cinc/cinc-ruby-client
+  changelog_uri: https://gitlab.com/cinc/cinc-ruby-client/-/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://gitlab.com/cinc/cinc-ruby-client/-/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: CinC (Commander-In-Chief) is an 3rd RPC system for Eagle Dynamics's DigitalCombatSimulator
+test_files: []