space_elevator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5c508252df0ffc2f5f92b49f94034b9e869ea59
+  data.tar.gz: f8c316961a39b24f63c9608326336888a117a9be
+SHA512:
+  metadata.gz: '069f5e2925bd28ec63d1eef3b3ff926374ccfaeee6e74523f60e825c8ebc39a10718bc9e1977a12b3dbe0d2d37962e74b9a6a394e7e228713f5bf519d0fced51'
+  data.tar.gz: 1906914eafafe526dbc65acfea27cf004feede44429dd4a65fd836336ed1208d07501161421027d2a445de0c5d028750f8ebc32013cfe115f01a2fd6290bb00b

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,74 @@
+# space_elevator - The ActionCable Client for Ruby
+
+space_elevator is a _client_ for integrating a ruby application with a remote ActionCable-based backend provided by Rails 5 or compatible framework. It allows for subscription and publication to multiple _channels_ simultaneously, and eavesdropping on wire-level messages. Harness the power of WebSockets to receive push notifications in your own Ruby applications!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'space_elevator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install space_elevator
+
+## Usage
+
+```ruby
+require 'space_elevator'
+require 'eventmachine'
+require 'em-websocket-client'
+
+EventMachine.run do
+
+    url = 'ws://example.com'
+
+    # Create a SpaceElevator::Client with a disconnect handler.
+    client = SpaceElevator::Client.new(url) do
+        puts 'Disconnected. Exiting...'
+        EventMachine.stop_event_loop
+    end
+
+    # Connect the client using the provided callback block.
+    client.connect do |msg|
+        case msg['type'] # The server will always set a 'type'.
+        when 'welcome' # Sent after a successful connection.
+            puts 'The server says "welcome".'
+
+            # Subscribe to something..
+            client.subscribe(channel: 'ChatChannel') do |chat|
+                puts "Received Chat Event: #{chat}"
+                if chat['type'] == 'confirm_subscription'
+                    puts "Subscription to #{chat['identifier']['channel']} confirmed!"
+                    # Broadcast to the channel!
+                    client.publish('ChatChannel', {subject: 'Hi', text: "What's up, y'all!?!?"})
+                end
+            end
+
+            # Subscribe to something else simultaneously. Note the additional parameters!
+            client.subscribe(channel: 'PlatformChannel', platform_id: platform_id) do |m|
+                puts "Received Platform #{platform_id} Event: #{m}"
+                # Do whatever, here.
+            end
+        when 'ping'
+            puts 'The server just pinged us.'
+        else
+            puts msg
+        end
+    end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/preston/space_elevator. 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
+
+This work is published under the Apache 2.0 license. Copyright (c) 2017 Preston Lee.

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/lib/space_elevator.rb

@@ -0,0 +1,84 @@
+require 'space_elevator/version'
+
+module SpaceElevator
+    # Super-light utility for integrating with ActionCable-based backends.
+    class Client
+        attr_accessor :client
+        attr_accessor :connected
+        attr_accessor :connection_handler
+        attr_accessor :channel_handlers
+        attr_accessor :disconnect_handler
+        attr_accessor :url
+
+        def initialize(url, &disconnect_handler)
+            self.url = url
+            self.disconnect_handler = disconnect_handler
+      end
+
+        def connect(&block)
+            self.connection_handler = block
+            self.channel_handlers = {}
+            self.client = EventMachine::WebSocketClient.connect(url)
+            client.callback do
+                puts "Connected WebSocket to #{url}."
+                self.connected = true
+            end
+            client.stream do |raw|
+                message = parse_message(raw.to_s)
+                if message['identifier'] && message['identifier']['channel']
+                    channel_handlers[message['identifier']['channel']].call(message)
+                else
+                    connection_handler.call(message)
+                end
+            end
+            client.disconnect do
+                self.connected = false
+                disconnect_handler.call
+            end
+         end
+
+        def subscribe(identifier, &block)
+            push(create_subscribe_message(identifier))
+            channel_handlers[identifier[:channel]] = block
+        end
+
+        def push(msg)
+            client.send_msg(msg)
+        end
+
+        def publish(channel, data)
+            msg = create_publish_message(channel, data)
+            # puts "PUSHING: #{msg}"
+            push(msg)
+          end
+
+        def create_publish_message(channel, data)
+            message = {
+                command: 'message',
+                identifier: { channel: channel }
+            }
+            message[:data] = data.to_json if data
+            message[:identifier] = message[:identifier].to_json
+            message.to_json
+        end
+
+        def create_subscribe_message(identifier)
+            message = {
+                command: 'subscribe',
+                identifier: identifier.to_json
+            }
+            # message[:identifier].merge!(data) if data
+            # message[:data] = data.to_json if data
+            # message[:identifier] = message[:identifier].to_json
+            # puts message
+            message.to_json
+        end
+
+        def parse_message(message)
+            result = JSON.parse(message)
+            result['identifier'] = JSON.parse(result['identifier']) if result['identifier']
+            result['data'] = JSON.parse(result['data']) if result['data']
+            result
+        end
+    end
+end

data/lib/space_elevator/version.rb

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

data/space_elevator.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'space_elevator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "space_elevator"
+  spec.version       = SpaceElevator::VERSION
+  spec.authors       = ["Preston Lee"]
+  spec.email         = ["preston.lee@prestonlee.com"]
+
+  spec.summary       = %q{Ruby client for integrating a ruby application with a remote ActionCable-based backend provided by Rails 5 or compatible framework.}
+  spec.description   = %q{Ruby client for integrating a ruby application with a remote ActionCable-based backend provided by Rails 5 or compatible framework. It allows for subscription and publication to multiple _channels_ simultaneously, and eavesdropping on wire-level messages. Harness the power of WebSockets to receive push notifications in your own Ruby applications!}
+  spec.homepage      = "https://github.com/preston/space_elevator"
+
+  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_dependency "eventmachine", ">= 1.2.3"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: space_elevator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Preston Lee
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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.3
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Ruby client for integrating a ruby application with a remote ActionCable-based
+  backend provided by Rails 5 or compatible framework. It allows for subscription
+  and publication to multiple _channels_ simultaneously, and eavesdropping on wire-level
+  messages. Harness the power of WebSockets to receive push notifications in your
+  own Ruby applications!
+email:
+- preston.lee@prestonlee.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/space_elevator.rb
+- lib/space_elevator/version.rb
+- space_elevator.gemspec
+homepage: https://github.com/preston/space_elevator
+licenses: []
+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: Ruby client for integrating a ruby application with a remote ActionCable-based
+  backend provided by Rails 5 or compatible framework.
+test_files: []