seapig-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c97228621e62280b1e0bb387e54be3ae02d9da4
+  data.tar.gz: d6e9c22f412022329fcd741d2f0e9aeb2c4dbd01
+SHA512:
+  metadata.gz: 12b0f66e99e846ff9435071ff0657ed302be2b3fcdc7a0847db0490b921c9be6f74e448e06bbe2886311adbdf37a72d9e6f772decd23d0c75e5ebcc0f93d28e3
+  data.tar.gz: bae21935b4e0790a97c7210fee6adeb3946d7cdb33e54c1c834d46cbfc9f4a551d2f452c20ab25d8ae5dab492d3a994e7b5edc946ce0a26b61281e509d0e3594

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 yunta
+
+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.rdoc

@@ -0,0 +1,36 @@
+= Seapig
+
+Nothing here yet.
+
+To cover:
+
+* what are seapigs and why they exist? (why not just having a db table?)
+  * link to https://www.youtube.com/watch?v=_y4DbZivHCY
+* properties of seapig system
+  * data is cached in memory
+  * only diffs are sent
+  * data is generated in separate processes
+  * data gets regenerated on dependency change (immediately on db change)
+* describe current limits
+  * one level deps only
+  * single object can have at most one generation process running at all times
+  * cache is dropped when last client unlinks
+  * no client-side timeout detection
+  * postgres only (but is that really a problem? ;))
+* graph of server/client side seapig object states
+* disclaimer on non-efficient code. it's all a draft, a test of idea.
+* rails not needed
+* stuff will change
+* seapig = firebase for apps that need real db
+* works nicely with mithril
+* how to use this shit
+  * dummy app is a minimal demo
+  * bundle exec rails s
+  * bundle exec ruby ../../bin/seapig-server.rb
+  * bundle exec ruby ../../bin/seapig-worker.rb ws://127.0.0.1:3001/seapig
+  * bundle exec ruby ../../bin/seapig-notifier.rb ws://127.0.0.1:3001/seapig
+  * application.js needs: require seapig/seapig
+  * application.js needs: require json-patch
+  * ActiveRecord models that are used for triggering regeneration of data need:
+    * acts_as_seapig_dependency
+    * and seapig_dependency_changed after commits

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Seapig'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+#APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+#load 'rails/tasks/engine.rake'
+
+
+#load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/bin/seapig-observer

@@ -0,0 +1,18 @@
+#!/bin/env ruby
+
+require 'seapig-client'
+require 'pp'
+
+EM.run {
+	
+	SeapigServer.new(ARGV[0],name: 'observer').slave(ARGV[1]).onchange { |what|
+		puts "-"*80 + " " + Time.new.to_s
+		puts what.version
+		pp what
+		puts
+	}
+
+}
+
+
+

data/bin/seapig-worker

@@ -0,0 +1,64 @@
+#!/bin/env ruby
+
+require 'websocket-eventmachine-client'
+require 'json'
+require 'jsondiff'
+
+
+class Producer
+
+	@producers_by_regexp = {}
+	@patterns = []
+
+	def self.patterns
+		@patterns
+	end
+
+
+	def self.init
+		@producers_by_regexp = Hash[*ObjectSpace.each_object(Class).select { |klass| klass < Producer }.map { |klass| klass.patterns.map { |pattern| [Regexp.new(Regexp.escape(pattern).gsub('\*','.*?')), klass] }}.flatten]
+		@patterns = @producers_by_regexp.values.map { |klass| klass.patterns }.flatten
+	end
+	
+
+	def self.for(object_id)
+		@producers_by_regexp.each_pair.find { |pattern,generator| object_id =~ pattern }[1]
+	end
+	
+end
+
+Dir['lib/seapigs/*.rb'].each { |f| require './'+f }
+Producer.init
+
+
+EM.run {
+
+	socket = WebSocket::EventMachine::Client.connect(uri: ARGV[0])
+
+	
+	socket.onopen {
+		socket.send(JSON.dump(action: 'client-options-set', options: {name: 'worker'}))
+		Producer.patterns.each { |pattern|
+			socket.send JSON.dump(action: 'object-producer-register', pattern: pattern)
+		}
+	}
+
+	
+	socket.onmessage { |message|
+		message = JSON.load message
+		case message['action']
+		when 'object-produce'
+			start = Time.new
+			object, version = Producer.for(object_id = message['id']).produce(object_id)
+			puts 'Generated %25s in %5.2fs'%[object_id, (Time.new-start).to_f]
+			socket.send JSON.dump(action: 'object-patch', id: object_id, old_version: 0, new_version: version, value: object)
+		end
+	}
+
+	
+	socket.onclose { |code, reason|
+		EM.stop
+	}
+
+}
+

data/lib/seapig/client.rb

@@ -0,0 +1,178 @@
+require 'websocket-eventmachine-client'
+require 'json'
+require 'jsondiff'
+require 'hana'
+
+class SeapigServer
+
+	attr_reader :socket
+	
+	def initialize(uri, options={})
+		@connected = false
+		@uri = uri
+		@options = options
+		@slave_objects = {}
+		@master_objects = {}
+
+		@socket = WebSocket::EventMachine::Client.connect(uri: uri)
+
+		@socket.onopen {
+			@connected = true
+			@socket.send JSON.dump(action: 'client-options-set', options: @options)
+			@slave_objects.each_pair { |object_id, object|
+				@socket.send JSON.dump(action: 'object-consumer-register', id: object_id, latest_known_version: object.version)
+			}
+			@master_objects.each_pair { |object_id, object|
+				@socket.send JSON.dump(action: 'object-producer-register', pattern: object_id)
+				object.upload(0, {})
+			}
+		}
+		
+		@socket.onmessage { |message|
+			message = JSON.load message
+			#p message['action'], message['id'], message['patch']
+			case message['action']
+			when 'object-update'
+				@slave_objects.values.each { |object|
+					object.patch(message) if object.matches?(message['id'])
+				}
+			when 'object-destroy'
+				@slave_objects.values.each { |object|
+					object.destroy(message) if object.matches?(message['id'])
+				}
+			when 'object-produce'
+				@master_objects[message['id']].upload(0,{}) if @master_objects[message['id']]
+			else
+				p :wtf, message
+			end
+		}
+		
+		@socket.onclose { |code, reason|
+			if @connected
+				puts 'Seapig connection died, quitting'
+				EM.stop
+			end
+		}
+	end
+
+
+	def disconnect
+		@connected = false
+		@socket.close
+	end
+
+
+	def detach_fd
+		@connected = false
+		IO.new(@socket.detach).close
+	end
+	
+	
+	def slave(object_id)
+		object = if object_id.include?('*') then SeapigWildcardObject.new(self, object_id) else SeapigObject.new(self, object_id) end
+		@socket.send JSON.dump(action: 'object-consumer-register', id: object_id, latest_known_version: object.version) if @connected
+		@slave_objects[object_id] = object
+	end
+
+
+	def master(object_id)
+		object = SeapigObject.new(self, object_id)
+		object.version = Time.new.to_f
+		@socket.send JSON.dump(action: 'object-producer-register', pattern: object_id) if @connected
+		@master_objects[object_id] = object
+	end
+end
+
+
+class SeapigObject < Hash
+
+	attr_accessor :version, :object_id, :valid
+
+
+	def matches?(id)
+		id =~ Regexp.new(Regexp.escape(@object_id).gsub('\*','.*?'))
+	end
+
+
+	def initialize(server, object_id)
+		@server = server
+		@object_id = object_id
+		@version = 0
+		@onchange = nil
+		@valid = false
+		@shadow = JSON.load(JSON.dump(self))
+	end
+
+	
+	def onchange(&block)
+		@onchange = block
+	end
+
+	
+	def patch(message)
+		if not message['old_version']
+			self.clear
+		elsif message['old_version'] == 0
+			self.clear
+		elsif not @version == message['old_version']
+			p @version, message
+			puts "Seapig lost some updates, this should never happen"
+			exit 2
+		end		
+		Hana::Patch.new(message['patch']).apply(self)
+		@shadow = JSON.load(JSON.dump(self))
+		@version = message['new_version']
+		@valid = true
+		@onchange.call(self) if @onchange
+	end
+
+
+	def changed
+		old_version = @version
+		@version += 1
+		upload(old_version, @shadow)
+		@shadow = sanitized
+	end
+
+
+	def sanitized
+		JSON.load(JSON.dump(self))
+	end
+
+
+	def upload(old_version, old_object)
+		message = {
+			id: @object_id,
+			action: 'object-patch',
+			old_version: old_version,
+			new_version: @version,
+			patch: JsonDiff.generate(old_object, self.sanitized)
+		}
+		@server.socket.send JSON.dump(message)
+	end
+	
+	
+
+end
+
+
+
+class SeapigWildcardObject < SeapigObject
+
+
+	def patch(message)
+		self[message['id']] ||= SeapigObject.new(@server, message['id'])
+		self[message['id']].patch(message)
+#		puts JSON.dump(self)
+		@onchange.call(self) if @onchange
+	end
+
+
+	def destroy(message)
+		self.delete(message['id'])
+		@onchange.call(self) if @onchange
+	end
+
+end
+
+

data/lib/seapig/version.rb

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

data/lib/seapig-client.rb

@@ -0,0 +1,4 @@
+require "seapig/client.rb"
+
+module Seapig
+end

data/test/integration/navigation_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class NavigationTest < ActionDispatch::IntegrationTest
+  # test "the truth" do
+  #   assert true
+  # end
+end
+

data/test/seapig_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class SeapigTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, Seapig
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../../test/dummy/config/environment.rb",  __FILE__)
+ActiveRecord::Migrator.migrations_paths = [File.expand_path("../../test/dummy/db/migrate", __FILE__)]
+require "rails/test_help"
+
+# Filter out Minitest backtrace while allowing backtrace from other libraries
+# to be shown.
+Minitest.backtrace_filter = Minitest::BacktraceFilter.new
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# Load fixtures from the engine
+if ActiveSupport::TestCase.respond_to?(:fixture_path=)
+  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
+  ActionDispatch::IntegrationTest.fixture_path = ActiveSupport::TestCase.fixture_path
+  ActiveSupport::TestCase.fixtures :all
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: seapig-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- yunta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: websocket-eventmachine-client
+  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: jsondiff
+  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: hana
+  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'
+description: meh
+email:
+- maciej.blomberg@mikoton.com
+executables:
+- seapig-observer
+- seapig-worker
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- bin/seapig-observer
+- bin/seapig-worker
+- lib/seapig-client.rb
+- lib/seapig/client.rb
+- lib/seapig/version.rb
+- test/integration/navigation_test.rb
+- test/seapig_test.rb
+- test/test_helper.rb
+homepage: https://github.com/yunta-mb/seapig-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.4.8
+signing_key: 
+specification_version: 4
+summary: Transient object synchronization lib - client
+test_files:
+- test/integration/navigation_test.rb
+- test/test_helper.rb
+- test/seapig_test.rb