hyper-mesh 0.4.0 → 0.5.0

data/docs/configuration_details.md

@@ -0,0 +1,62 @@
+## Installation
+
+If you do not already have hyper-react installed, then use the reactrb-rails-generator gem to setup hyper-react, reactive-record and associated gems.
+
+Then add this line to your application's Gemfile:
+
+```ruby
+gem 'HyperMesh'
+```
+
+And then execute:
+
+    $ bundle install
+
+Also you must `require 'hyper-tracemesh'` from your client side code.  The easiest way is to
+find the `require 'reactive-record'` line (typically in `components.rb`) and replace it with
+ `require 'HyperMesh'`.  
+
+## Configuration
+
+Add an initializer like this:
+
+```ruby
+# for rails this would go in: config/initializers/HyperMesh.rb
+HyperMesh.configuration do |config|
+  config.transport = :simple_poller # or :none, action_cable, :pusher - see below)
+end
+# for a minimal setup you will need to define at least one channel, which you can do
+# in the same file as your initializer.
+# Normally you would put these policies in the app/policies/ directory
+class ApplicationPolicy
+  # allow all clients to connect to the Application channel
+  regulate_connection { true } # or always_allow_connection for short
+  # broadcast all model changes over the Application channel *DANGEROUS*
+  regulate_all_broadcasts { |policy| policy.send_all }
+end
+```
+
+Assuming you are up and running with Hyper-React on Rails:
+
+1. **Add the gem**  
+add `gem 'hyper-mesh'`, and bundle install
+6. **Add the models directory to asset path**   
+```ruby
+# application.rb
+    config.assets.paths << ::Rails.root.join('app', 'models').to_s
+```
+
+2. **Require HyperMesh instead of HyperReact**  
+replace `require 'hyper-react'` with `require 'hyper-mesh'` in the components manifest (`app/views/components.rb`.)
+3. **Require your models on the client_side_scoping**  
+add `require 'models'` to the bottom of the components manifest
+4. add a models manifest in the models directory:  
+```ruby
+# app/models/models.rb
+require_tree './public'
+```
+5. create a `public` directory in your models directory and move any models that you want access to on the client into this directory.  Access to these models will be protected by *Policies* you will be creating later.
+
+A minimal HyperMesh configuration consists of a simple initializer file, and at least one *Policy* class that will *authorize* who gets to see what.
+
+The initializer file specifies what transport will be used.  Currently you can use [Pusher](http://pusher.com), ActionCable (if using Rails 5), Pusher-Fake (for development) or a Simple Poller for testing etc.

data/docs/pusher_faker_quickstart.md

@@ -0,0 +1,28 @@
+### Pusher-Fake
+
+You can also use the [Pusher-Fake](https://github.com/tristandunn/pusher-fake) gem while in development.  Setup is a little tricky.  First
+add `gem 'pusher-fake'` to the development and/or test section of your gem file. Then setup your config file:
+
+```ruby
+# typically config/initializers/HyperMesh.rb
+# or you can do a similar setup in your tests (see this gem's specs)
+require 'pusher'
+require 'pusher-fake'
+# The app_id, key, and secret need to be assigned directly to Pusher
+# so PusherFake will work.
+Pusher.app_id = "MY_TEST_ID"      # you use the real or fake values
+Pusher.key =    "MY_TEST_KEY"
+Pusher.secret = "MY_TEST_SECRET"
+# The next line actually starts the pusher-fake server (see the Pusher-Fake readme for details.)
+require 'pusher-fake/support/base' # if using pusher with rspec change this to pusher-fake/support/rspec
+# now copy over the credentials, and merge with PusherFake's config details
+HyperMesh.configuration do |config|
+  config.transport = :pusher
+  config.channel_prefix = "HyperMesh"
+  config.opts = {
+    app_id: Pusher.app_id,
+    key: Pusher.key,
+    secret: Pusher.secret
+  }.merge(PusherFake.configuration.web_options)
+end
+```

data/docs/pusher_quickstart.md

@@ -0,0 +1,17 @@
+### Pusher Configuration
+
+Add `gem 'pusher'` to your gem file, and add `//= require 'HyperMesh/pusher'` to your application.js file.
+
+```ruby
+# typically config/initializers/HyperMesh.rb
+HyperMesh.configuration do |config|
+  config.transport = :pusher
+  config.opts = {
+    app_id: '2xxxx2',
+    key:    'dxxxxxxxxxxxxxxxxxx9',
+    secret: '2xxxxxxxxxxxxxxxxxx2',
+    encrypted: false # optional defaults to true
+  }
+  config.channel_prefix = 'syncromesh' # or any other string you want
+end
+```

data/docs/simple_poller_quickstart.md

@@ -29,6 +29,11 @@ Once you have hyper-react installed then add this initializer:
 #config/initializers/synchromesh.rb
 HyperMesh.configuration do |config|
   config.transport = :simple_poller
+  # options
+  config.opts = {
+    seconds_between_poll: 5, # default is 0.5 you may need to increase if testing with Selenium
+    seconds_polled_data_will_be_retained: 1.hour  # clears channel data after this time, default is 5 minutes
+  }
 end
 ```
 

data/examples/words/Gemfile

@@ -43,16 +43,17 @@ group :development do
   # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
   gem 'spring'
   gem 'spring-watcher-listen', '~> 2.0.0'
+  gem 'pry'
 end
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
 gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
 
 gem 'hyper-react'
+gem 'opal-browser'
 gem 'react-rails', '>= 1.3.0'
 gem 'opal-rails', '>= 0.8.1'
 gem 'therubyracer', platforms: :ruby
 gem 'react-router-rails', '~> 0.13.3'
-gem 'reactrb-router'
-gem 'reactive-record', '>= 0.8.0'
-gem 'synchromesh', path: '../..'
+gem 'hyper-router'
+gem 'hyper-mesh', path: '../..'

data/examples/words/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: ../..
   specs:
-    synchromesh (0.4.0)
+    hyper-mesh (0.4.1)
       activerecord (>= 0.3.0)
-      reactive-record (>= 0.7.43)
+      hyper-react (>= 0.10.0)
 
 GEM
   remote: https://rubygems.org/
@@ -45,13 +45,14 @@ GEM
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (7.1.2)
+    arel (7.1.4)
     babel-source (5.8.35)
     babel-transpiler (0.7.0)
       babel-source (>= 4.0, < 6)
       execjs (~> 2.0)
     builder (3.2.2)
-    byebug (9.0.5)
+    byebug (9.0.6)
+    coderay (1.1.1)
     coffee-rails (4.2.1)
       coffee-script (>= 2.2.0)
       railties (>= 4.0.0, < 5.2.x)
@@ -68,6 +69,13 @@ GEM
     globalid (0.3.7)
       activesupport (>= 4.1.0)
     hike (1.2.3)
+    hyper-react (0.10.0)
+      opal (>= 0.8.0)
+      opal-activesupport (>= 0.2.0)
+      react-rails
+    hyper-router (2.4.0)
+      hyper-react
+      opal-browser
     i18n (0.7.0)
     jbuilder (2.6.0)
       activesupport (>= 3.0.0, < 5.1)
@@ -89,13 +97,12 @@ GEM
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
     mini_portile2 (2.1.0)
-    minitest (5.9.0)
+    minitest (5.9.1)
     multi_json (1.12.1)
     nio4r (1.2.1)
-    nokogiri (1.6.8)
+    nokogiri (1.6.8.1)
       mini_portile2 (~> 2.1.0)
-      pkg-config (~> 1.1.7)
-    opal (0.10.2)
+    opal (0.10.3)
       hike (~> 1.2)
       sourcemap (~> 0.1.0)
       sprockets (~> 3.1)
@@ -115,7 +122,10 @@ GEM
       rails (>= 4.0, < 6.0)
       sprockets-rails (< 3.0)
     paggio (0.2.6)
-    pkg-config (1.1.7)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
     puma (3.6.0)
     rack (2.0.1)
     rack-test (0.6.3)
@@ -144,7 +154,7 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (11.3.0)
-    rb-fsevent (0.9.7)
+    rb-fsevent (0.9.8)
     rb-inotify (0.9.7)
       ffi (>= 0.5.0)
     react-rails (1.4.2)
@@ -157,20 +167,8 @@ GEM
     react-router-rails (0.13.3.2)
       rails (>= 3.1)
       react-rails (~> 1.4.0)
-    reactive-record (0.8.3)
-      opal-browser
-      opal-rails
-      rails (>= 3.2.13)
-      react-rails
-      hyper-react
-    hyper-react (0.8.8)
-      opal (>= 0.8.0)
-      opal-activesupport (>= 0.2.0)
-      opal-browser (= 0.2.0)
     reactrb-rails-generator (0.2.0)
       rails (>= 4.0.0)
-    reactrb-router (0.8.2)
-      hyper-react
     ref (2.0.0)
     sass (3.4.22)
     sass-rails (5.0.6)
@@ -179,11 +177,13 @@ GEM
       sprockets (>= 2.8, < 4.0)
       sprockets-rails (>= 2.0, < 4.0)
       tilt (>= 1.1, < 3)
+    slop (3.6.0)
     sourcemap (0.1.1)
-    spring (1.7.2)
-    spring-watcher-listen (2.0.0)
+    spring (2.0.0)
+      activesupport (>= 4.2)
+    spring-watcher-listen (2.0.1)
       listen (>= 2.7, < 4.0)
-      spring (~> 1.2)
+      spring (>= 1.2, < 3.0)
     sprockets (3.7.0)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -191,7 +191,7 @@ GEM
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       sprockets (>= 2.8, < 4.0)
-    sqlite3 (1.3.11)
+    sqlite3 (1.3.12)
     therubyracer (0.12.2)
       libv8 (~> 3.16.14.0)
       ref
@@ -203,9 +203,9 @@ GEM
     turbolinks-source (5.0.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
-    uglifier (3.0.2)
+    uglifier (3.0.3)
       execjs (>= 0.3.0, < 3)
-    web-console (3.3.1)
+    web-console (3.4.0)
       actionview (>= 5.0)
       activemodel (>= 5.0)
       debug_inspector
@@ -220,23 +220,24 @@ PLATFORMS
 DEPENDENCIES
   byebug
   coffee-rails (~> 4.2)
+  hyper-mesh!
+  hyper-react
+  hyper-router
   jbuilder (~> 2.5)
   jquery-rails
   listen (~> 3.0.5)
+  opal-browser
   opal-rails (>= 0.8.1)
+  pry
   puma (~> 3.0)
   rails (~> 5.0.0, >= 5.0.0.1)
   react-rails (>= 1.3.0)
   react-router-rails (~> 0.13.3)
-  reactive-record (>= 0.8.0)
-  hyper-react
   reactrb-rails-generator
-  reactrb-router
   sass-rails (~> 5.0)
   spring
   spring-watcher-listen (~> 2.0.0)
   sqlite3
-  synchromesh!
   therubyracer
   turbolinks (~> 5)
   tzinfo-data

data/examples/words/app/views/components.rb

@@ -1,7 +1,9 @@
 # app/views/components.rb
 require 'opal'
 require 'react'
-require 'hyper-react'
+#require 'hyper-react'
+require 'hyper-mesh'
+
 if React::IsomorphicHelpers.on_opal_client?
   require 'opal-jquery'
   require 'browser'
@@ -9,7 +11,7 @@ if React::IsomorphicHelpers.on_opal_client?
   require 'browser/delay'
   # add any additional requires that can ONLY run on client here
 end
-require 'reactrb-router'
+require 'hyper-router'
 require 'react_router'
 require 'hyper-mesh'
 require 'models'

data/examples/words/config/initializers/hyper_mesh.rb

@@ -0,0 +1,14 @@
+#config/initializers/hyper_mesh.rb
+
+#puts "*****  #{__FILE__} ****"
+#binding.pry
+#File.join(Rails.root, 'app', 'models', 'public')
+#binding.pry
+#Opal.append_path File.join(Rails.root, 'app', 'models').untaint
+
+
+
+HyperMesh.configuration do |config|
+  config.transport = :action_cable
+  config.channel_prefix = "synchromesh"
+end

data/examples/words/config/routes.rb

@@ -1,5 +1,5 @@
 Rails.application.routes.draw do
-  mount ReactiveRecord::Engine => '/rr'
+  mount HyperMesh::Engine => '/rr'
   get 'test', to: 'test#app'
   # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
 end

data/lib/hyper-mesh.rb

@@ -49,11 +49,12 @@ else
   require "reactive_record/serializers"
   require "reactive_record/pry"
   require_relative 'active_record_base'
-  require 'synchromesh/synchromesh_controller'
   require 'hypermesh/version'
   require 'synchromesh/connection'
   require 'synchromesh/synchromesh'
   require 'synchromesh/policy'
+  require 'synchromesh/synchromesh_controller'
+
   Opal.append_path File.expand_path('../sources/', __FILE__).untaint
   Opal.append_path File.expand_path('../', __FILE__).untaint
   Opal.append_path File.expand_path('../../vendor', __FILE__).untaint

data/lib/hypermesh/version.rb

@@ -1,3 +1,3 @@
 module Hypermesh
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/reactive_record/active_record/public_columns_hash.rb

@@ -7,11 +7,11 @@ module ActiveRecord
     def self.public_columns_hash
       return @public_columns_hash if @public_columns_hash
       Dir.glob(Rails.root.join('app/models/public/*.rb')).each do |file|
-        require_dependency(file) rescue nil
+        require_dependency(file)
       end
       @public_columns_hash = {}
       descendants.each do |model|
-        @public_columns_hash[model.name] = model.columns_hash
+        @public_columns_hash[model.name] = model.columns_hash rescue nil
       end
       @public_columns_hash
     end

data/lib/reactive_record/active_record/reactive_record/isomorphic_base.rb

@@ -55,7 +55,7 @@ module ReactiveRecord
       end
       path = ::Rails.application.routes.routes.detect do |route|
         # not sure why the second check is needed.  It happens in the test app
-        route.app == ReactiveRecord::Engine or (route.app.respond_to?(:app) and route.app.app == ReactiveRecord::Engine)
+        route.app == HyperMesh::Engine or (route.app.respond_to?(:app) and route.app.app == HyperMesh::Engine)
       end.path.spec
       "<script type='text/javascript'>\n"+
         "window.ReactiveRecordEnginePath = '#{path}';\n"+

data/lib/reactive_record/engine.rb

@@ -1,6 +1,4 @@
-#require 'rails'
-
-module ReactiveRecord
+module HyperMesh
   class Engine < ::Rails::Engine
     isolate_namespace ReactiveRecord
     config.generators do |g|
@@ -10,4 +8,4 @@ module ReactiveRecord
       g.helper false
     end
   end
-end
+end

data/lib/reactive_record/permissions.rb

@@ -6,24 +6,47 @@ module ReactiveRecord
   end
 end
 
+module HyperMesh
+  class InternalPolicy
+
+    def self.accessible_attributes_for(model, acting_user)
+      user_channels = ClassConnectionRegulation.connections_for(acting_user, false) +
+        InstanceConnectionRegulation.connections_for(acting_user, false)
+      internal_policy = InternalPolicy.new(model, model.attribute_names, user_channels)
+      ChannelBroadcastRegulation.broadcast(internal_policy)
+      InstanceBroadcastRegulation.broadcast(model, internal_policy)
+      internal_policy.accessible_attributes_for
+    end
+
+    def accessible_attributes_for
+      accessible_attributes = Set.new
+      @channel_sets.each do |channel, attribute_set|
+        accessible_attributes.merge attribute_set
+      end
+      accessible_attributes << :id unless accessible_attributes.empty?
+      accessible_attributes
+    end
+  end
+end
+
 class ActiveRecord::Base
 
   attr_accessor :acting_user
 
+  def view_permitted?(attribute)
+    HyperMesh::InternalPolicy.accessible_attributes_for(self, acting_user).include? attribute.to_sym
+  end
+
   def create_permitted?
-    true
+    false
   end
 
   def update_permitted?
-    true
+    false
   end
 
   def destroy_permitted?
-    true
-  end
-
-  def view_permitted?(attribute)
-    true
+    false
   end
 
   def only_changed?(*attributes)