jason-rails 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2883964fb830dbb506a0e845caa3398436d72262f72cc6b295efce14dcc96346
-  data.tar.gz: 631d00d04195b1e1f48111ca5a6cc02775488e48f94ab5d8d29783a66a6c91a8
+  metadata.gz: 453e1a0d649445d973de2e3adf27f88f91c5bf983e65b3c2d993f090816db72b
+  data.tar.gz: ec2600988c60bcb6f661b8835cd3bcb7d3a4b740749ab0f21109e9b6a513b4ca
 SHA512:
-  metadata.gz: 6de81fcdba79fc067fe7515ad83be895e30d19686e548bfb774026993ab965cf6f0aaa9cebcd4807448e5218c8c9609f414e6ec05d5eb717aef880e3f2e012ea
-  data.tar.gz: adb6476af69fe904588f55214b930959a0b0d1d2357c3edafca77cc4f8d528a72cb0f72cde6dbec4e097e58d6e5758a2c429419cd9ad60f02d0352dd9abe385b
+  metadata.gz: cc2ba8529669a1fe4c48d2ee2ba595a7e3ae907a0d10234f12d68d797de63177143187c5c3767cf32ab35bd053c3c9f3bfa14461f8b6be71d8df437e3e997c7d
+  data.tar.gz: c93e0002f3a7e2379ed29483b6a8323b4b492a319ccc4f9948f0638c47e62a9eeb8b416fad2bbe2cc6b5c13f11a103eab462b7a35f5a36145037981e49c99cc6

data/.gitignore

@@ -11,4 +11,7 @@
 .rspec_status
 client/node_modules/
 
-client/yarn-error.log
+client/yarn-error.log
+*.log
+*.gem
+.DS_Store

data/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/Gemfile.lock

@@ -0,0 +1,184 @@
+PATH
+  remote: .
+  specs:
+    jason-rails (0.5.1)
+      connection_pool (>= 2.2.3)
+      jsondiff
+      rails (>= 5)
+      redis (>= 4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.1)
+      actionpack (= 6.1.1)
+      activesupport (= 6.1.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.1)
+      actionpack (= 6.1.1)
+      activejob (= 6.1.1)
+      activerecord (= 6.1.1)
+      activestorage (= 6.1.1)
+      activesupport (= 6.1.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.1)
+      actionpack (= 6.1.1)
+      actionview (= 6.1.1)
+      activejob (= 6.1.1)
+      activesupport (= 6.1.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.1)
+      actionview (= 6.1.1)
+      activesupport (= 6.1.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.1)
+      actionpack (= 6.1.1)
+      activerecord (= 6.1.1)
+      activestorage (= 6.1.1)
+      activesupport (= 6.1.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.1)
+      activesupport (= 6.1.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.1)
+      activesupport (= 6.1.1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.1)
+      activesupport (= 6.1.1)
+    activerecord (6.1.1)
+      activemodel (= 6.1.1)
+      activesupport (= 6.1.1)
+    activestorage (6.1.1)
+      actionpack (= 6.1.1)
+      activejob (= 6.1.1)
+      activerecord (= 6.1.1)
+      activesupport (= 6.1.1)
+      marcel (~> 0.3.1)
+      mimemagic (~> 0.3.2)
+    activesupport (6.1.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    connection_pool (2.2.3)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.7)
+      concurrent-ruby (~> 1.0)
+    jsondiff (0.0.5)
+    loofah (2.8.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.5.0)
+    minitest (5.14.3)
+    nio4r (2.5.4)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.1)
+      actioncable (= 6.1.1)
+      actionmailbox (= 6.1.1)
+      actionmailer (= 6.1.1)
+      actionpack (= 6.1.1)
+      actiontext (= 6.1.1)
+      actionview (= 6.1.1)
+      activejob (= 6.1.1)
+      activemodel (= 6.1.1)
+      activerecord (= 6.1.1)
+      activestorage (= 6.1.1)
+      activesupport (= 6.1.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.1)
+      actionpack (= 6.1.1)
+      activesupport (= 6.1.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (~> 1.0)
+    rake (12.3.3)
+    redis (4.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-rails (4.0.2)
+      actionpack (>= 4.2)
+      activesupport (>= 4.2)
+      railties (>= 4.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.0)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    thor (1.0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jason-rails!
+  pry
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rspec-rails
+  sqlite3
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -1,10 +1,12 @@
 # Jason
 
+Jason is still in a highly experimental phase with a rapidly changing API. Production use not recommended - but please give it a try!
+
 ## The goal
 
 I wanted:
  - Automatic updates to client state based on database state
- - Automatic persistence to database
+ - Persistence to the database without many layers of passing parameters
  - Redux for awesome state management
  - Optimistic updates
 
@@ -14,35 +16,141 @@ Jason attempts to minimize this repitition by auto-generating API endpoints, red
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add the gem and the NPM package
 
 ```ruby
 gem 'jason-rails'
 ```
 
-And then execute:
+```bash
+  yarn add @jamesr2323/jason
+```
+
+You will also need have peer dependencies of `redux`, `react-redux` and `@reduxjs/toolkit`.
+
+### In Rails
+
+Include the module `Jason::Publisher` in all models you want to publish via Jason.
+
+Create a new initializer e.g. `jason.rb` which defines your schema
+
+```ruby
+Jason.setup do |config|
+  config.schema = {
+    post: {
+      subscribed_fields: [:id, :name]
+    },
+    comment: {
+      subscribed_fields: [:id]
+    },
+    user: {
+      subscribed_fields: [:id]
+    }
+  }
+end
+```
 
-    $ bundle install
+### In your frontend code
 
-Or install it yourself as:
+First you need to wrap your root component in a `JasonProvider`.
 
-    $ gem install jason
+```jsx
+import { JasonProvider } from '@jamesr2323/jason'
+
+return <JasonProvider>
+  <YourApp />
+</JasonProvider>
+```
+
+This is a wrapper around `react-redux` Provider component. This accepts the following props (all optional):
+
+- `reducers` - An object of reducers that will be included in `configureStore`. Make sure these do not conflict with the names of any of the models you are configuring for use with Jason
+- `extraActions` - Extra actions you want to be available via the `useAct` hook. (See below)
+This must be a function which returns an object which will be merged with the main Jason actions. The function will be passed a dispatch function, store, axios instance and the Jason actions. For example you can add actions for one of your custom slices:
+
+```js
+function extraActions(dispatch, store, restClient, act) {
+  return {
+    local: {
+      upsert: payload => dis({ type: 'local/upsert', payload })
+    }
+  }
+}
+```
+
+- `middleware` - Passed directly to `configureStore` with additional Jason middleware
 
 ## Usage
+Jason provides two custom hooks to access functionality.
+
+### useAct
+This returns an object which allows you to access actions which both update models on the server, and perform an optimistic update to the Redux store.
 
-TODO: Write usage instructions here
+Example
+```jsx
+import React, { useState } from 'react'
+import { useAct } from '@jamesr2323/jason'
+
+export default function PostCreator() {
+  const act = useAct()
+  const [name, setName] = useState('')
+
+  function handleClick() {
+    act.posts.add({ name })
+  }
+
+  return <div>
+    <input value={name} onChange={e => setName(e.target.value)} />
+    <button onClick={handleClick}>Add</button>
+  </div>
+}
+```
+
+### useSub
+This subscribes your Redux store to a model or set of models. It will automatically unsubscribe when the component unmounts.
+
+Example
+```jsx
+import React from 'react'
+import { useSelector } from 'react-redux'
+import { useSub } from '@jamesr2323/jason'
+import _ from 'lodash'
+
+export default function PostsList() {
+  useSub({ model: 'post', includes: ['comments'] })
+  const posts = useSelector(s => _.values(s.posts.entities))
+
+  return <div>
+    { posts.map(({ id, name }) => <div key={id}>{ name }</div>) }
+  </div>
+}
+```
+
+## Authorization
+
+By default all models can be subscribed to and updated without authentication or authorization. Probably you want to lock down access.
+
+### Authorizing subscriptions
+You can do this by providing an class to Jason in the initializer under the `subscription_authorization_service` key. This must be a class receiving a message `call` with the parameters `user`, `model`, `conditions`, `sub_models` and return true or false for whether the user is allowed to access a subscription with those parameters. You can decide the implementation details of this to be as simple or complex as your app requires.
+
+### Authorizing updates
+Similarly to authorizing subscriptions, you can do this by providing an class to Jason in the initializer under the `update_authorization_service` key. This must be a class receiving a message `call` with the parameters `user`, `model`, `instance`, `update`, `remove` and return true or false for whether the user is allowed to access a subscription with those parameters.
+
+## Roadmap
+
+Development is primarily driven by the needs of projects we're using Jason in. In no particular order, being considered is:
+- Failure handling - rolling back local state in case of an error on the server
+- Authorization - more thorough authorization integration, with utility functions for common authorizations. Allowing authorization of access to particular fields such as restricting the fields of a user that are publicly broadcast.
+- Utilities for "Draft editing" - both storing client-side copies of model trees which can be committed or discarded, as well as persisting a shadow copy to the database (to allow resumable editing, or possibly collaborative editing features)
 
 ## Development
 
-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.
 
-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).
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jason. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/jason/blob/master/CODE_OF_CONDUCT.md).
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/jason/api/pusher_controller.rb

@@ -0,0 +1,15 @@
+ class Jason::Api::PusherController < ApplicationController
+  skip_before_action :verify_authenticity_token
+
+  def auth
+    channel_main_name = params[:channel_name].remove("private-#{Jason.pusher_channel_prefix}-")
+    subscription_id = channel_main_name.remove('jason-')
+
+    if Jason::Subscription.find_by_id(subscription_id).user_can_access?(current_user)
+      response = Pusher.authenticate(params[:channel_name], params[:socket_id])
+      return render json: response
+    else
+      return head :forbidden
+    end
+  end
+end

data/app/controllers/jason/api_controller.rb

@@ -0,0 +1,78 @@
+class Jason::ApiController < ::ApplicationController
+  before_action :load_and_authorize_subscription, only: [:create_subscription, :remove_subscription, :get_payload]
+  # config seems to be a reserved name, resulting in infinite loop
+  def configuration
+    payload = {
+      schema: Jason.schema,
+      transportService: Jason.transport_service,
+    }
+
+    if Jason.transport_service == :pusher
+      payload.merge!({
+        pusherKey: Jason.pusher_key,
+        pusherRegion: Jason.pusher_region,
+        pusherChannelPrefix: Jason.pusher_channel_prefix
+      })
+    end
+
+    render json: payload
+  end
+
+  def action
+    type = params[:type]
+    entity = type.split('/')[0].underscore
+    api_model = Jason::ApiModel.new(entity.singularize)
+    model = entity.singularize.camelize.constantize
+    action = type.split('/')[1].underscore
+
+    if action == 'move_priority'
+      id, priority = params[:payload].values_at(:id, :priority)
+
+      instance = model.find(id)
+      priority_filter = instance.as_json.with_indifferent_access.slice(*api_model.priority_scope)
+
+      all_instance_ids = model.send(api_model.scope || :all).where(priority_filter).where.not(id: instance.id).order(:priority).pluck(:id)
+      all_instance_ids.insert(priority.to_i, instance.id)
+
+      all_instance_ids.each_with_index do |id, i|
+        model.find(id).update!(priority: i, skip_publish_json: true)
+      end
+
+      model.publish_all(model.find(all_instance_ids))
+    elsif action == 'upsert' || action == 'add'
+      payload = api_model.permit(params)
+      return render json: model.find_or_create_by_id!(payload).as_json(api_model.as_json_config)
+    elsif action == 'remove'
+      model.find(params[:payload]).destroy!
+    end
+
+    return head :ok
+  end
+
+  def create_subscription
+    @subscription.add_consumer(params[:consumer_id])
+    render json: { channelName: @subscription.channel }
+  end
+
+  def remove_subscription
+    @subscription.remove_consumer(params[:consumer_id])
+  end
+
+  def get_payload
+    if params[:options].try(:[], :force_refresh)
+      @subscription.set_ids_for_sub_models
+    end
+
+    render json: @subscription.get
+  end
+
+  private
+
+  def load_and_authorize_subscription
+    config = params[:config].to_unsafe_h
+    @subscription = Jason::Subscription.upsert_by_config(config['model'], conditions: config['conditions'], includes: config['includes'])
+    if !@subscription.user_can_access?(current_user)
+      return head :forbidden
+    end
+  end
+end