entangled 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7dd7732a7af0fdbc6a792eb242f507817adcfde
+  data.tar.gz: 0091ccff6cdad24ac350dace118ae33a5331bc5a
+SHA512:
+  metadata.gz: f64204d586309f97651845b5a642a333a4f88d943608326d84063560b4f2ed180304433a7caa5810cb5ddb2eed9c296ab5e1f4c535ea6d05219215ed02385e93
+  data.tar.gz: 8573a37652353e3b32807bb653040036b2981927a74fa4565a9b51897f24d37ae3996b4720b689b4a791ad59e6933f624d0fe4d23d17b92e4bd9fee98f23832b

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 entangled.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Dennis Charles Hackethal
+
+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,31 @@
+# Entangled
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'entangled'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install entangled
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/entangled/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/entangled.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'entangled/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "entangled"
+  spec.version       = Entangled::VERSION
+  spec.authors       = ["Dennis Charles Hackethal"]
+  spec.email         = ["dennis.hackethal@gmail.com"]
+  spec.summary       = %q{Makes Rails real time through websockets.}
+  spec.description   = %q{Makes Rails real time through websockets. Check out the JavaScript counterpart for the front end.}
+  spec.homepage      = "https://github.com/so-entangled/rails"
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency 'tubesock', '~> 0.2'
+  spec.add_dependency 'rails', '~> 4.2'
+end

data/lib/entangled.rb

@@ -0,0 +1,269 @@
+require "entangled/version"
+require 'tubesock'
+
+module Entangled
+	module Model
+		module ClassMethods
+			# Create after_ callbacks for options
+			def entangle(options = {})
+
+				# If :only is specified, the options can either
+				# be an array or a symbol
+				if options[:only].present?
+
+					# If it is a symbol, something like only: :create
+					# was passed in, and we need to create a hook
+					# only for that one option
+					if options[:only].is_a?(Symbol)
+						create_hook options[:only]
+
+					# If it is an array, something like only: [:create, :update]
+					# was passed in, and we need to create hook for each
+					# of these options
+					elsif options[:only].is_a?(Array)
+						options[:only].each { |option| create_hook option }
+					end
+
+				# Instead of :only, :except can be specified; similarly,
+				# the options can either be an array or a symbol
+				elsif options[:except].present?
+
+					# If it is a symbol, it has to be taken out of the default
+					# options. A callback has to be defined for each of the
+					# remaining options
+					if options[:except].is_a?(Symbol)
+						(default_options - [options[:except]]).each do |option|
+							create_hook option
+						end
+
+					# If it is an array, it also has to be taen out of the
+					# default options. A callback then also has to be defined
+					# for each of the remaining options
+					elsif options[:except].is_a?(Array)
+						(default_options - options[:except]).each do |option|
+							create_hook option
+						end
+					end
+				else
+
+					# If neither :only nor :except is specified, simply create
+					# a callback for each default option
+					default_options.each { |option| create_hook option }
+				end
+			end
+
+			# By default, model updates will be published after_create,
+			# after_update, and after_destroy. This behavior can be
+			# modified by passing :only or :except options to the
+			# entangle class method
+			def default_options
+				[:create, :update, :destroy]
+			end
+
+			# The inferred channel name. For example, if the class name
+			# is DeliciousTaco, the inferred channel name is "delicious_tacos"
+			def inferred_channel_name
+				name.underscore.pluralize
+			end
+
+			# Creates callbacks in the extented model
+			def create_hook(name)
+				send :"after_#{name}", proc { publish(name) }
+			end
+		end
+		
+		module InstanceMethods
+			private
+
+			# Publishes to client. Whoever is subscribed
+			# to the model's channel or the record's channel
+			# gets the message
+			def publish(action)
+				Redis.new.publish(
+					self.class.inferred_channel_name,
+					json(action)
+				)
+
+				Redis.new.publish(
+					inferred_channel_name_for_single_record,
+					json(action)
+				)
+			end
+
+			# The inferred channel name for a single record
+			# containing the inferred channel name from the class
+			# and the record's id. For example, if it's a
+			# DeliciousTaco with the id 1, the inferred channel
+			# name for the single record is "delicious_tacos/1"
+			def inferred_channel_name_for_single_record
+				"#{self.class.inferred_channel_name}/#{id}"
+			end
+
+			# JSON containing the type of action (:create, :update
+			# or :destroy) and the record itself. This is eventually
+			# broadcast to the client
+			def json(action)
+				{
+					action: action,
+					resource: self
+				}.to_json
+			end
+		end
+		
+		def self.included(receiver)
+			receiver.extend         ClassMethods
+			receiver.send :include, InstanceMethods
+		end
+	end
+	
+  module Controller
+  	include Tubesock::Hijack
+
+  	module ClassMethods
+  		
+  	end
+  	
+  	module InstanceMethods
+  		private
+
+  		# The plural name of the resource, inferred from the
+  		# controller's name. For example, if it's the TacosController,
+  		# the resources_name will be "tacos". This is used to
+  		# infer the instance variable name for collections assigned
+  		# in the controller action
+  		def resources_name
+  			controller_name
+  		end
+
+  		# The singular name of the resource, inferred from the
+  		# resources_name. This is used to infer the instance
+  		# variable name for a single record assigned in the controller
+  		# action
+  		def resource_name
+  			resources_name.singularize
+  		end
+
+  		# Broadcast events to every connected client
+  		def broadcast(&block)
+  			# Use hijack to handle sockets
+  			hijack do |tubesock|
+  				# Assuming restful controllers, the behavior of
+  				# this method has to change depending on the action
+  				# it's being used in
+  				case action_name
+
+  				# If the controller action is 'index', a collection
+  				# of records should be broadcast
+  				when 'index'
+  					yield
+
+  					# The following code will run if an instance
+  					# variable with the plural resource name has been
+  					# assigned in yield. For example, if a
+  					# TacosController's index action looked something
+  					# like this:
+
+  					# def index
+  					#   broadcast do
+  					#     @tacos = Taco.all
+  					#   end
+  					# end
+
+  					# ...then @tacos will be broadcast to all connected
+  					# clients. The variable name, in this example,
+  					# has to be "@tacos"
+  					if instance_variable_get(:"@#{resources_name}")
+  						redis_thread = Thread.new do
+  							Redis.new.subscribe resources_name do |on|
+  								on.message do |channel, message|
+  									tubesock.send_data message
+  								end
+
+  								# Broadcast collection to all connected clients
+  								tubesock.send_data({
+  									resources: instance_variable_get(:"@#{resources_name}")
+  								}.to_json)
+  							end
+  						end
+
+  						# When client disconnects, kill the thread
+  						tubesock.onclose do
+  							redis_thread.kill
+  						end
+  					end
+
+  				# If the controller's action name is 'show', a single record
+  				# should be broadcast
+  				when 'show'
+  					yield
+
+  					# The following code will run if an instance variable
+  					# with the singular resource name has been assigned in
+  					# yield. For example, if a TacosController's show action
+  					# looked something like this:
+
+  					# def show
+  					#   broadcast do
+  					#     @taco = Taco.find(params[:id])
+  					#   end
+  					# end
+
+  					# ...then @taco will be broadcast to all connected clients.
+  					# The variable name, in this example, has to be "@taco"
+  					if instance_variable_get(:"@#{resource_name}")
+  						redis_thread = Thread.new do
+  							Redis.new.subscribe "#{resources_name}/#{instance_variable_get(:"@#{resource_name}").id}" do |on|
+  								on.message do |channel, message|
+  									tubesock.send_data message
+  								end
+
+  								# Broadcast single resource to all connected clients
+  								tubesock.send_data({ resource: instance_variable_get(:"@#{resource_name}") }.to_json)
+  							end
+  						end
+
+  						# When client disconnects, kill the thread
+  						tubesock.onclose do
+  							redis_thread.kill
+  						end
+  					end
+
+  				# If the controller's action name is 'create', a record should be
+  				# created. Before yielding, the params hash has to be prepared
+  				# with attributes sent to the socket. The actual publishing
+  				# happens in the model's callback
+  				when 'create'
+  					tubesock.onmessage do |m|
+  						params[resource_name.to_sym] = JSON.parse(m).symbolize_keys
+  						yield
+  					end
+
+  				# If the controller's action name is 'update', a record should be
+  				# updated. Before yielding, the params hash has to be prepared
+  				# with attributes sent to the socket. The default attributes
+  				# id, created_at, and updated_at should not be included in params.
+  				when 'update'
+  					tubesock.onmessage do |m|
+  						params[resource_name.to_sym] = JSON.parse(m).except('id', 'created_at', 'updated_at', 'webSocketUrl').symbolize_keys
+  						yield
+  					end
+
+  				# For every other controller action, simply wrap whatever is
+  				# yielded in the tubesock block to execute it in the context
+  				# of the socket. The delete action is automatically covered
+  				# by this, and other custom action can be added through this.
+  				else
+  					tubesock.onmessage do |m|
+  						yield
+  					end
+  				end
+  			end
+  		end
+  	end
+  	
+  	def self.included(receiver)
+  		receiver.extend         ClassMethods
+  		receiver.send :include, InstanceMethods
+  	end
+  end
+end

data/lib/entangled/version.rb

@@ -0,0 +1,3 @@
+module Entangled
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: entangled
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dennis Charles Hackethal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: tubesock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Makes Rails real time through websockets. Check out the JavaScript counterpart
+  for the front end.
+email:
+- dennis.hackethal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- entangled.gemspec
+- lib/entangled.rb
+- lib/entangled/version.rb
+homepage: https://github.com/so-entangled/rails
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Makes Rails real time through websockets.
+test_files: []