gameoverseer-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad6101c2e2b10272e30528dc1a2e1e9bb3f79338
+  data.tar.gz: 4f2530092e030a77732253b52037e12b19c27bb1
+SHA512:
+  metadata.gz: 94a0513d719bd42096ebe42c3c2df16ebe7f5b67901b1fd0b90edd922a84c92b01cf08e2560231810e38dbfd14a004e4792b58af0aeb4f5c34a67e85b4945588
+  data.tar.gz: 5d5b7ddf98357a84674195dd2cbd32866305540bb109ccf2fe6bd9b99e5910be98df14da2ad23666d999988e9501fc612971e49b92821be3c341cd477b544dba

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gameoverseer-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Cyberarm
+
+MIT License
+
+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,41 @@
+[![Code Climate](https://codeclimate.com/github/cyberarm/gameoverseer-client/badges/gpa.svg)](https://codeclimate.com/github/cyberarm/gameoverseer-client)
+[![Inline docs](http://inch-ci.org/github/cyberarm/gameoverseer-client.svg?branch=master)](http://inch-ci.org/github/cyberarm/gameoverseer-client)
+
+# GameOverseer::Client
+
+Client library for GameOverseer.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gameoverseer-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gameoverseer-client
+
+## Usage
+
+Simple example
+```ruby
+require "gameoverseer/client"
+
+client = GameOverseer::Client.new("localhost", 56789)
+client.transmit('world', 'connect', {access_token: "f2a..."})
+client.disconnect
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/cyberarm/gameoverseer-client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/gameoverseer-client.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gameoverseer/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gameoverseer-client"
+  spec.version       = GameOverseer::Client::VERSION
+  spec.authors       = ["Cyberarm"]
+  spec.email         = ["matthewlikesrobots@gmail.com"]
+  spec.summary       = %q{Client library for GameOverseer.}
+  spec.description   = %q{Library for easily communicating with a GameOverseer server.}
+  spec.homepage      = "https://github.com/cyberarm/gameoverseer-client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "renet", ">= 0.2.0"
+  spec.add_dependency "multi_json"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/gameoverseer/client.rb

@@ -0,0 +1,92 @@
+require "renet"
+require "multi_json"
+
+require_relative "client/version"
+require_relative "client/service_manager"
+require_relative "client/service"
+
+module GameOverseer
+  class Client
+    CHAT = 0 # channel int. used for in-game chat
+    WORLD= 1 # channel int. used for sending/receiving world state updates
+    HANDSHAKE = 2 # channel int. used for authentication or similar purposes
+    FAULT=3 # channel int. used to send/receive errors
+    attr_reader :socket
+
+    def initialize(host = "localhost", port = 56789, compression = true)
+      @host = host
+      @port = port
+      @compression = compression
+
+      GameOverseer::Client.instance = self
+      @service_manager = ServiceManager.new
+
+      @socket = ENet::Connection.new(host, port, 4, 0, 0)
+      @socket.use_compression(compression)
+      @socket.on_packet_receive(method(:handle_packet))
+
+      connect
+    end
+
+    def self.instance
+      @instance
+    end
+    def self.instance=instance
+      @instance = instance
+    end
+
+    def connect(timeout = 1000) # default to 1 second
+      tries = 0
+      begin
+        @socket.connect(timeout)
+      rescue StandardError
+        tries+=1
+        retry unless tries > 3
+        raise if tries > 3
+      end
+    end
+
+    def online?
+      @socket.online?
+    end
+
+    def connected?
+      @socket.connected?
+    end
+
+    def handle_packet(data, channel)
+      _data= data.chomp.strip
+      data = MultiJson.load(_data)
+      ServiceManager.instance.handle_packet(data, channel)
+    end
+
+    def disconnect(timeout = 1000)
+      tries = 0
+      begin
+        @socket.disconnect(timeout)
+      rescue StandardError
+        tries+=1
+        retry unless tries > 3
+        raise if tries > 3
+      end
+    end
+
+    def transmit(channel, mode, data = nil, channel_id = CHAT, reliable = false)
+      raise "channel must be a String" unless channel.is_a?(String)
+      raise "mode must be a String"    unless mode.is_a?(String)
+      raise "data must be a Hash"      unless data.is_a?(Hash) or data == nil
+      raise "reliable must be a Boolean" unless reliable.is_a?(TrueClass) or reliable.is_a?(FalseClass)
+
+      if data
+        message = MultiJson.dump({channel: channel, mode: mode, data: data})
+      else
+        message = MultiJson.dump({channel: channel, mode: mode})
+      end
+      @socket.send_packet(message, reliable, channel_id)
+    end
+
+    def update(timeout = 0)
+      @socket.update(timeout)
+    end
+  end
+end

data/lib/gameoverseer/client/service.rb

@@ -0,0 +1,26 @@
+module GameOverseer
+  class Client
+    class Service
+      def self.inherited(klass)
+        ServiceManager::SERVICES.push(klass)
+      end
+
+      def initialize
+        setup if defined?(setup)
+      end
+
+      def register_channel(string)
+        if ServiceManager.instance.register_channel(self, string)
+          true
+        else
+          false
+        end
+      end
+
+      def transmit(channel, mode, data, channel_id = GameOverseer::Client::CHAT, reliable = false)
+        raise "data must be a Hash when sent from a Service" unless data.is_a?(Hash)
+        Client.instance.transmit(channel, mode, data, channel_id, reliable)
+      end
+    end
+  end
+end

data/lib/gameoverseer/client/service_manager.rb

@@ -0,0 +1,49 @@
+module GameOverseer
+  class Client
+    class ServiceManager
+      SERVICES = []
+      CHANNELS = []
+
+      def initialize
+        GameOverseer::Client::ServiceManager.instance = self
+        SERVICES.each_with_index do |s, index|
+          if s.class == Class
+            SERVICES[index] = s.new
+          end
+        end
+      end
+
+      def self.instance
+        @instance
+      end
+
+      def self.instance=instance
+        @instance = instance
+      end
+
+      def register_channel(instance, string)
+        service = CHANNELS.detect do |_service|
+          if _service[:channel] == string
+            true
+          end
+        end
+
+        raise "channel '#{string}' in use by '#{service[:instance]}'" if service
+
+        CHANNELS.push({instance: instance, channel: string})
+        return true
+      end
+
+      def handle_packet(data, channel)
+        service_channel = data["channel"]
+        # service_method  = data["mode"]
+
+        CHANNELS.each do |service|
+          if service[:channel] == service_channel
+            service[:instance].process_data(data, channel)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gameoverseer/client/version.rb

@@ -0,0 +1,5 @@
+module GameOverseer
+  class Client
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: gameoverseer-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cyberarm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: renet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Library for easily communicating with a GameOverseer server.
+email:
+- matthewlikesrobots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gameoverseer-client.gemspec
+- lib/gameoverseer/client.rb
+- lib/gameoverseer/client/service.rb
+- lib/gameoverseer/client/service_manager.rb
+- lib/gameoverseer/client/version.rb
+homepage: https://github.com/cyberarm/gameoverseer-client
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Client library for GameOverseer.
+test_files: []
+has_rdoc: