sockeye-server 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 94e44f2887c4211da9337702430f0359552f8e04
+  data.tar.gz: 8db3c1a6baf06de44be4a9b7ac81b70038ed23d8
+SHA512:
+  metadata.gz: 1ea7c8ca763a19809c246c5761d29ee78098875eccd4d17531805d74b9b767edafeda9c869f3d09114511e4d75f6fbdb9f91041e1f566c5eaee51b5687f5dd5e
+  data.tar.gz: b29d9251f4beb15c21e3f2e016ed0c0b6736f5fd90e6011d43580623bf17f3a7c05727663c46ee1f540ed020a0dc561a54139fe17b66ad7f73db176a4c4bcc70

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jack.hayter@googlemail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Hockey Community
+
+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 @@
+# Sockeye::Server
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sockeye/server`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sockeye-server'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sockeye-server
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/[USERNAME]/sockeye-server. 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](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,5 @@
+module Sockeye
+  module Server
+    VERSION = "0.1.0"
+  end
+end

data/lib/sockeye/server.rb

@@ -0,0 +1,140 @@
+require "sockeye/server/version"
+require 'json'
+require 'eventmachine'
+require 'websocket-eventmachine-server'
+
+module Sockeye
+  class Server
+
+    attr_accessor :connections, :connection_map, :host, :port, :secret_token, :authentication_method
+
+    def initialize(host:, port:, secret_token:, authentication_method: nil)
+      self.connections = {}
+      self.connection_map = {}
+      self.host = host
+      self.port = port
+      self.secret_token = secret_token
+      self.authentication_method = authentication_method
+    end
+
+    # Safely parse data as JSON, but return nil values on failure
+    #
+    def json_try_parse(data)
+      begin
+        return JSON.parse(data, symbolize_names: true)
+      rescue JSON::ParserError => e
+        return nil
+      end
+    end
+
+    # Call the supplied authentication method
+    #
+    def authenticate(token)
+      return self.authentication_method.call(token)
+    end
+
+    # Add a connection to the list and add a map entry to link the
+    # connection object with an authenticated identifier
+    #
+    def add_connection(identifier:, connection:)
+      connections[identifier] = [] if connections[identifier].nil?
+      connections[identifier] << connection
+      connection_map[connection.object_id] = identifier
+    end
+
+    # Safely remove the specified connection from the connections lists
+    #
+    def remove_connection(connection)
+      identifier = connection_map[connection.object_id]
+      if connections[identifier].is_a? Array
+        connections[identifier].delete(connection)
+        connections.delete(identifier) if connections[identifier].empty?
+      end
+      connection_map.delete(connection.object_id)
+    end
+
+    # Find all open connections associated with the specified identifiers
+    # then attempt to push the payload to each of them
+    #
+    def deliver_to_many(payload:, identifiers:)
+      identifiers.each do |identifier|
+        identified_connections = connections[identifier]
+        next unless identified_connections.is_a? Array
+        identified_connections.each do |connection|
+          begin
+            connection.send({payload: payload, status: 200}.to_json, :type => :text)
+          rescue
+          end
+        end
+      end
+    end
+
+    # Main server connection listener loop. Uses an EventMachine and websocket
+    # server to handle and abstract raw connections. Handles authentication
+    # and delivery actions for clients and pushers.
+    #
+    def listen
+      EM.run do
+        WebSocket::EventMachine::Server.start(host: self.host, port: self.port) do |ws|
+
+          # Called when a new message arrives at the server
+          #
+          ws.onmessage do |message, type|
+
+            # Attempt to parse the received data as JSON
+            #
+            message_json = json_try_parse(message)
+            if message_json.nil?
+              ws.send({payload: "invalid message", status: 400}.to_json, :type => :text)
+              ws.close
+            else
+
+              # Execute the appropriate action based on JSON action
+              #
+              case message_json[:action].to_sym
+
+              # Handle authentication requests by calling the authentication
+              # method supplied on server setup
+              #
+              when :authenticate
+                authentication_result = authenticate(message_json[:payload])
+                if authentication_result
+                  add_connection(identifier: authentication_result, connection: ws)
+                  ws.send({payload: "authenticated", status: 200}.to_json, :type => :text)
+                else
+                  ws.send({payload: "authentication failure", status: 401}.to_json, :type => :text)
+                  ws.close
+                end
+
+              # Handle delivery requests by verifying the auth token supplied
+              # then push out the payload to all connected specified clients
+              #
+              when :deliver
+                if message_json[:secret_token] == self.secret_token
+                  deliver_to_many(payload: message_json[:payload], identifiers: message_json[:identifiers])
+                  ws.send({payload: "payload pushed", status: 201}.to_json, :type => :text)
+                  ws.close
+                else
+                  ws.send({payload: "authentication failure", status: 401}.to_json, :type => :text)
+                  ws.close
+                end
+
+              else
+                ws.send({payload: "invalid action", status: 405}.to_json, :type => :text)
+                ws.close
+              end
+
+            end
+          end
+
+          # Cleanup connection lists when a connection is closed
+          #
+          ws.onclose do
+            remove_connection(ws)
+          end
+
+        end
+      end
+    end
+  end
+end

data/sockeye-server.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sockeye/server/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sockeye-server"
+  spec.version       = Sockeye::Server::VERSION
+  spec.authors       = ["Jack Hayter"]
+  spec.email         = ["jack.hayter@googlemail.com"]
+
+  spec.summary       = "A websockets based server for payload delivery to clients"
+  spec.description   = "A websockets based real-time message solution for delivering messages to specific clients"
+  spec.homepage      = "https://github.com/HockeyCommunity/sockeye-server"
+  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.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency 'eventmachine', '~> 1.2', '>= 1.2.3'
+  spec.add_runtime_dependency 'websocket-eventmachine-server', '~> 1.0', '>= 1.0.1'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: sockeye-server
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jack Hayter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+- !ruby/object:Gem::Dependency
+  name: websocket-eventmachine-server
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+description: A websockets based real-time message solution for delivering messages
+  to specific clients
+email:
+- jack.hayter@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sockeye/server.rb
+- lib/sockeye/server/version.rb
+- sockeye-server.gemspec
+homepage: https://github.com/HockeyCommunity/sockeye-server
+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.10
+signing_key: 
+specification_version: 4
+summary: A websockets based server for payload delivery to clients
+test_files: []