basics are working

Author: catmando

Gemfile

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

README.md

@@ -1,41 +1,79 @@
-# Syncromesh
+# Synchromesh ![](logo.jpg?raw=true)
 
-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/syncromesh`. To experiment with that code, run `bin/console` for an interactive prompt.
+Synchromesh provides multi-client synchronization for [reactive-record](https://github.com/catprintlabs/reactive-record)
 
-TODO: Delete this and the text above, and describe your gem
+In otherwords browser 1 creates, updates, or destroys a model, and the changes are broadcast to all other clients.
+
+Add the gem, setup the configuration, and synchromesh does the rest.
+
+## Transports
+
+Currently there are two transport mechanisms:  
+
++ [Pusher](http://pusher.com) which gives you zero config websockets.  
++ Short cycle polling (for development)
+
+As soon as Opal is working on Rails 5, we will add ActionCable.   
+
+Also near term we will have a simple mechanism to plug in your own transport.
+
+## Security [NOT IMPLEMENTED YET]
+
+Synchromesh builds on top of ReactiveRecord's model-based permission mechanism:
+
+Each *user* gets a private transport channel.  Before broadcasting an update to a users channel Synchromesh filters the data based on that users permissions.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'syncromesh'
+gem 'synchromesh'
 ```
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
-Or install it yourself as:
+Also you must `require 'synchromesh'` from your client side code.  The easiest way is to
+find the `require 'reactive-record'` line (typically in `components.rb`) and add `require 'synchromesh'` directly below it.  
 
-    $ gem install syncromesh
+## Configuration
 
-## Usage
+Add an initializer like this:
 
-TODO: Write usage instructions here
+```ruby
+# for rails this would go in: config/initializers/synchromesh.rb
+Synchromesh.configuration do |config|
 
-## Development
+  config.transport = :pusher # set to :none to turn off, or to :simple_poller (see below)
+
+  config.app_id =         '2xxxx2'
+  config.key =            'dxxxxxxxxxxxxxxxxxx9'
+  config.secret =         '2xxxxxxxxxxxxxxxxxx2'
+  config.channel_prefix = 'synchromesh'                   # this can be any string
+
+  # config.client_logging = false                         # default is true
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+  # simple_poller - good for debug or while developing on a plane... does NOT use long polling, so is not
+  # workable for production
 
-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).
+  # config.transport = :simple_poller
+  # config.seconds_between_poll = 5                       # default is 0.5
+  # config.seconds_polled_data_will_be_retained = 1.hour  # clears channel data after this time, default is 5 minutes,
+
+end
+```
+
+## Development
+
+TBD
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/syncromesh. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/reactive-ruby/synchromesh. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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).
-

bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "syncromesh"
+require "synchromesh"
 
 # 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.

design.md

@@ -1,6 +1,6 @@
 module ReactiveRecord
 
-  class Syncromesh
+  class Synchromesh
 
     include React::IsomorphicHelpers
 
@@ -19,8 +19,9 @@ module ReactiveRecord
 
     before_first_mount do |context|
       if on_opal_client?
+        puts "setting up synchromesh on client: <%= Synchromesh.transport %> time now = <%= Time.now %>"
 
-        <% if Syncromesh.transport == :pusher %>
+        <% if Synchromesh.transport == :pusher %>
 
           change = lambda do |data|
             sync_change Hash.new(data)
@@ -31,34 +32,38 @@ module ReactiveRecord
           end
 
           %x{
-            <% if Syncromesh.client_logging %>
+            <% if Synchromesh.client_logging %>
             Pusher.log = function(message) {
               if (window.console && window.console.log) {
                 window.console.log(message);
               }
             };
             <% end %>
 
-            var pusher = new Pusher('<%= Syncromesh.key %>', {
-              encrypted: <%= Syncromesh.encrypted %>
-            });
+            <% if defined?(PusherFake) %>
+              var pusher = <%= PusherFake.javascript %>;
+            <% else %>
+              var pusher = new Pusher('<%= Synchromesh.key %>', {
+                encrypted: <%= Synchromesh.encrypted %>
+              });
+            <% end %>
 
-            var channel = pusher.subscribe('<%= Syncromesh.channel %>');
+            var channel = pusher.subscribe('<%= Synchromesh.channel %>');
             channel.bind('change', change);
             channel.bind('destroy', destroy);
           }
 
-        <% elsif Syncromesh.transport == :simple_poller %>
+        <% elsif Synchromesh.transport == :simple_poller %>
 
           id = nil
 
           HTTP.get(`window.ReactiveRecordEnginePath`+"/syncromesh-subscribe/").then do |response|
             id = response.json[:id]
           end
 
-          puts "SECONDS BETWEEN POLL SET TO <%= Syncromesh.seconds_between_poll %> SECONDS"
+          puts "SECONDS BETWEEN POLL SET TO <%= Synchromesh.seconds_between_poll %> SECONDS"
 
-          every(<%= Syncromesh.seconds_between_poll %>) do
+          every(<%= Synchromesh.seconds_between_poll %>) do
             HTTP.get(`window.ReactiveRecordEnginePath`+"/syncromesh-read/#{id}").then do |response|
               response.json.each do |update|
                 case update[0]