hyper-operation 0.5.12 → 0.99.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 05753e5d4f4a534d04de4875a1ba3d2a6ced3772
-  data.tar.gz: 61a5654f0bf9e3e222bb1a8b42e942c1985cf4f8
+SHA256:
+  metadata.gz: 8c7fa9d96880d409b3869de5ce0cde0ad9e92977cf76e7987ac508fbd3c724ba
+  data.tar.gz: e9a5b22277beb20b54dfedc09876ac45b65892557b48dd5e436318c93b73a32d
 SHA512:
-  metadata.gz: a79a6f25eed5763ece0a6d9324f42c595bfd1e78920ca58824dc30f32d3d37e363b25f3ea79baf89e3d42c08e79c8b245b1eb404f951f463f816a0a008c1b566
-  data.tar.gz: 2ff2869def836d2a54b64d5776dfcb091925b15a525252c14dc6f568bb9125786ef6d6101bc656119c5e89833f0149cea3a7794f2fbf9fd9eb964ca1af7d9011
+  metadata.gz: a822149b518d86b889536971f9c0976b2b69aa85ba52b26053f3c4c661ff54f820a213440e77bbff1e6028df64589b2a8618d43d20b5bb869045e57f567bf323
+  data.tar.gz: 91791060f154b31dc31fb0223e9b42fbed20ad53cce9d1b2e148ce83eafb0c5ce693c22d56b4ca7f333b8901bac0dfee39e06c15af799f440114ac7005b06de1

data/.gitignore

@@ -5,6 +5,8 @@ capybara-*.html
 /tmp
 /db/*.sqlite3
 /db/*.sqlite3-journal
+/spec/test_app/db/*.sqlite3
+/spec/test_app/db/*.sqlite3-journal
 /public/system
 /coverage/
 /spec/tmp
@@ -49,4 +51,5 @@ bower.json
 *.gem
 
 .idea
-*.iml
+.vscode
+*.iml

data/.travis.yml

@@ -0,0 +1,33 @@
+dist: trusty
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.4
+  - 2.5.1
+  - ruby-head
+services:
+  - mysql
+env:
+  - DRIVER=google-chrome TZ=Europe/Berlin
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: ruby-head
+before_install:
+  - if [[ "$DRIVER" == "google-chrome" ]]; then wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add -; fi
+  - if [[ "$DRIVER" == "google-chrome" ]]; then echo "deb http://dl.google.com/linux/chrome/deb/ stable main" | sudo tee /etc/apt/sources.list.d/google-chrome.list; fi
+  - if [[ "$DRIVER" == "google-chrome" ]]; then sudo apt-get update -qq && sudo apt-get install -qq -y google-chrome-stable; fi
+  - gem install bundler
+before_script:
+  - cd spec/test_app
+  - bundle install --jobs=3 --retry=3
+  - bundle exec rails db:setup
+  - cd ../../
+  - if [[ "$DRIVER" == "google-chrome" ]]; then bundle exec chromedriver-update; fi
+  - if [[ "$DRIVER" == "google-chrome" ]]; then ls -lR ~/.chromedriver-helper/; fi
+  - if [[ "$DRIVER" == "google-chrome" ]]; then bundle exec chromedriver --version; fi
+  - if [[ "$DRIVER" == "google-chrome" ]]; then google-chrome --version; fi
+  - if [[ "$DRIVER" == "google-chrome" ]]; then which google-chrome; fi
+script: bundle exec rspec
+gemfile:
+  - gemfiles/opal_0_11_react-rails_2_4.gemfile

data/DOCS-POLICIES.md

@@ -407,6 +407,99 @@ class MessagePolicy
 end
 ```
 
+## Regulating Scopes
+
+Consider the following expression (evaluated on the client)
+
+```ruby
+  Order.for_vip_customers.count
+```
+
+Even though the policy system will prevent us from looking into the actual attributes of any record, a malicioius hacker can find private information about our data if the above expression is not secured.  Moreover a DOS attack could be formed by repeatedly attempting to perform a variant of `Order.all`.
+
+To prevent this scopes and relationships can also be regulated.   A scope and relationship regulation is a proc that will return either a truthy or falsy value or calls the `denied!` method.   The proc is evaluated in the context of the relationship object, and the `acting_user` method is available for the proc's use in making decisions.
+
+All the scopes in a chain are evaluated together, and permission is granted or denied as follows:
+
++ If *any* of the regulations in a chain of scopes calls `denied!` then the remote request is aborted;
++ If *any* of the regulations in a chain of scopes returns a truthy value then access is granted to the entire chain;
++ If *none* of the regulations in a chain of scopes returns a truthy value then the request is aborted.
+
+Example:
+
+```ruby
+class Order < ApplicationRecord
+  regulate_scope(:for_vip_customers) { denied! unless acting_user.admin? }
+  regulate_scope(:active) { acting_user.admin? } 
+end
+
+class User < ApplicationRecord 
+  regulate_relationship(:orders) { self == acting_user }
+end
+
+ # in component code
+ 
+   user.orders.count              # valid if user is the acting user because the orders regulation returned true
+                                  # but will raise error if acting_user is not == user
+   user.orders.active.count       # valid if user is the acting user or if current user is an administrator
+   user.orders.for_vip_customers  # fails unless acting user is an admin
+```
+
+By default all relationships and scopes (including `all` and `unscoped` have a regulation that returns nil, so unless you explicitly provide a regulation that returns true, the client can not access any scopes.
+
+There are some short hand ways to define regulations as well:
+
+#### Constant Regulations
+
+If the regulation always does the same thing you can specify what to do without the block:
+
+```ruby
+  regulate_scope my_scope: :always_allow        # any truthy value works
+  regulate_scope my_scope: :denied!             # :deny or :denied work as well
+  regulate_relationship many_of_those: :denied! # works the same on relationships
+```
+
+Always denying a regulation effectively makes it inaccessible except on the server.
+
+Likewise be careful of always returning true for a scope, as this means that a hacker only needs
+to include this scope in the chain to gain access to the chain.  So just make sure that scopes that return
+true, narrow the scope down to something you would not mind anybody seeing.
+
+For development you can easily access everything (except regulations that explicitly invoke denied!) simply by doing this:
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  regulate_scope all: :always_allow if Rails.env.development?
+  regulate_scope unscoped: :always_allow if Rails.env.development?
+end
+```
+
+#### Regulations directly on scopes and has_many relationships
+
+You can also directly add the regulation where you declare the scope or relationship using the `regulate:` option.
+
+```ruby
+  # here is a handy scope to add to ApplicationRecord that you can attach to 
+  # any scope chain to give admin's full access
+  scope :admin, ->() {}, regulate: -> () { acting_user.admin? || denied! }
+  
+  # customers can always see their orders, otherwise we return nil meaning "don't know yet"
+  has_many :orders, regulate: -> () { acting_user == self } 
+```
+
+## Regulating server_method and finder_method methods
+
+The server or finder method proc will be executed in the context of the appropriate object (a record for server_method, and a relationship collection for finder_method.) Attached to this object will be the current `acting_user` method, and a `denied!` method.
+
+You can use these methods to restrict access to server and finder methods.
+
+```ruby
+  server_method :unit_cost do
+    denied! unless acting_user.admin? # only admin's can see this
+    # continue on calculating the unit cost
+  end
+```
+
 ## Browser Initiated Change policies
 
 To allow code in the browser to create, update or destroy a model, there must be a change access policy defined for that operation.

data/DOCS.md

@@ -204,7 +204,7 @@ class QuickCheckout < Hyperloop::Operation
   param :sku, type: String
   param qty: 1, type: Integer, minimum: 1
 
-  step { AddItemToCart(params) }
+  step { AddItemToCart.run(params) }
   step ValidateUserDefaultCC
   step Checkout
 end

data/Gemfile

@@ -1,3 +1,7 @@
 source 'https://rubygems.org'
-
+#gem "opal-jquery", git: "https://github.com/opal/opal-jquery.git", branch: "master"
+gem 'hyper-spec',       path: '../hyper-spec'
+gem 'hyperloop-config', path: '../hyperloop-config'
+gem 'hyper-store',      path: '../hyper-store'
+gem 'hyper-component',  path: '../hyper-component'
 gemspec

data/Gemfile.lock

@@ -0,0 +1,379 @@
+GIT
+  remote: https://github.com/opal/opal-jquery.git
+  revision: 6249dfaf406ecd7199079b4f4d9dc67cfdf4d602
+  branch: master
+  specs:
+    opal-jquery (0.4.3)
+      opal (>= 0.10.0, < 0.12.0)
+
+PATH
+  remote: ../hyper-component
+  specs:
+    hyper-component (1.0.0.lap28)
+      hyper-store (= 1.0.0.lap28)
+      hyperloop-config (= 1.0.0.lap28)
+      libv8 (~> 6.3.0)
+      mini_racer (~> 0.1.15)
+      opal (>= 0.11.0, < 0.12.0)
+      opal-activesupport (~> 0.3.1)
+      react-rails (>= 2.4.0, < 2.5.0)
+
+PATH
+  remote: ../hyper-spec
+  specs:
+    hyper-spec (1.0.0.lap28)
+      capybara
+      chromedriver-helper (= 1.2.0)
+      libv8 (~> 6.3.0)
+      method_source
+      mini_racer (~> 0.1.15)
+      opal (>= 0.11.0, < 0.12.0)
+      parser (>= 2.3.3.1)
+      pry
+      rspec-rails
+      selenium-webdriver
+      timecop (~> 0.8.1)
+      uglifier
+      unparser
+      webdrivers
+
+PATH
+  remote: ../hyper-store
+  specs:
+    hyper-store (1.0.0.lap28)
+      hyperloop-config (= 1.0.0.lap28)
+      opal (>= 0.11.0, < 0.12.0)
+
+PATH
+  remote: ../hyperloop-config
+  specs:
+    hyperloop-config (1.0.0.lap28)
+      libv8 (~> 6.3.0)
+      mini_racer (~> 0.1.15)
+      opal (>= 0.11.0, < 0.12.0)
+      opal-browser (~> 0.2.0)
+      uglifier
+
+PATH
+  remote: .
+  specs:
+    hyper-operation (1.0.0.lap28)
+      activerecord (>= 4.0.0)
+      hyper-component (= 1.0.0.lap28)
+      mutations
+      opal-activesupport (~> 0.3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    abstract_type (0.0.7)
+    actioncable (5.2.1)
+      actionpack (= 5.2.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.1)
+      actionview (= 5.2.1)
+      activesupport (= 5.2.1)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.1)
+      activesupport (= 5.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.1)
+      activesupport (= 5.2.1)
+      globalid (>= 0.3.6)
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
+      arel (>= 9.0)
+    activestorage (5.2.1)
+      actionpack (= 5.2.1)
+      activerecord (= 5.2.1)
+      marcel (~> 0.3.1)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    adamantium (0.2.0)
+      ice_nine (~> 0.11.0)
+      memoizable (~> 0.4.0)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    archive-zip (0.11.0)
+      io-like (~> 0.3.0)
+    arel (9.0.0)
+    ast (2.4.0)
+    babel-source (5.8.35)
+    babel-transpiler (0.7.0)
+      babel-source (>= 4.0, < 6)
+      execjs (~> 2.0)
+    builder (3.2.3)
+    capybara (3.8.0)
+      addressable
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      xpath (~> 3.1)
+    childprocess (0.9.0)
+      ffi (~> 1.0, >= 1.0.11)
+    chromedriver-helper (1.2.0)
+      archive-zip (~> 0.10)
+      nokogiri (~> 1.8)
+    coderay (1.1.2)
+    concord (0.1.5)
+      adamantium (~> 0.2.0)
+      equalizer (~> 0.0.9)
+    concurrent-ruby (1.0.5)
+    connection_pool (2.2.2)
+    cookiejar (0.3.3)
+    crass (1.0.4)
+    daemons (1.2.6)
+    database_cleaner (1.7.0)
+    diff-lcs (1.3)
+    em-http-request (1.1.5)
+      addressable (>= 2.3.4)
+      cookiejar (!= 0.3.1)
+      em-socksify (>= 0.3)
+      eventmachine (>= 1.0.3)
+      http_parser.rb (>= 0.6.0)
+    em-socksify (0.3.2)
+      eventmachine (>= 1.0.0.beta.4)
+    em-websocket (0.5.1)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    equalizer (0.0.11)
+    erubi (1.7.1)
+    eventmachine (1.2.7)
+    execjs (2.7.0)
+    ffi (1.9.25)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    hike (1.2.3)
+    http_parser.rb (0.6.0)
+    httpclient (2.8.3)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    interception (0.5)
+    io-like (0.3.0)
+    jquery-rails (4.3.3)
+      rails-dom-testing (>= 1, < 3)
+      railties (>= 4.2.0)
+      thor (>= 0.14, < 2.0)
+    libv8 (6.3.292.48.1)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.2)
+      mimemagic (~> 0.3.2)
+    memoizable (0.4.2)
+      thread_safe (~> 0.3, >= 0.3.1)
+    method_source (0.9.0)
+    mimemagic (0.3.2)
+    mini_mime (1.0.1)
+    mini_portile2 (2.3.0)
+    mini_racer (0.1.15)
+      libv8 (~> 6.3)
+    minitest (5.11.3)
+    multi_json (1.13.1)
+    mutations (0.8.3)
+      activesupport
+    mysql2 (0.5.2)
+    nio4r (2.3.1)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
+    opal (0.11.3)
+      ast (>= 2.3.0)
+      hike (~> 1.2)
+      parser (= 2.3.3.1)
+      sourcemap (~> 0.1.0)
+    opal-activesupport (0.3.1)
+      opal (>= 0.5.0, < 1.0.0)
+    opal-browser (0.2.0)
+      opal
+      paggio
+    opal-rails (0.9.5)
+      jquery-rails
+      opal (>= 0.11.0, < 0.12)
+      opal-activesupport (>= 0.0.5)
+      opal-jquery (~> 0.4.0)
+      opal-sprockets (~> 0.4.2)
+      rails (>= 4.1, < 6.0)
+      sprockets-rails (>= 2.3.3, < 4.0)
+    opal-sprockets (0.4.2.0.11.0.3.1)
+      opal (~> 0.11.0)
+      sprockets (~> 3.1)
+      tilt (>= 1.4)
+    paggio (0.2.6)
+    parser (2.3.3.1)
+      ast (~> 2.2)
+    procto (0.0.3)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-rescue (1.4.5)
+      interception (>= 0.5)
+      pry
+    public_suffix (3.0.3)
+    puma (3.12.0)
+    pusher (1.3.1)
+      httpclient (~> 2.7)
+      multi_json (~> 1.0)
+      pusher-signature (~> 0.1.8)
+    pusher-fake (1.10.0)
+      em-http-request (~> 1.1)
+      em-websocket (~> 0.5)
+      multi_json (~> 1.6)
+      thin (~> 1.5)
+    pusher-signature (0.1.8)
+    rack (2.0.5)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.1)
+      actioncable (= 5.2.1)
+      actionmailer (= 5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
+      activemodel (= 5.2.1)
+      activerecord (= 5.2.1)
+      activestorage (= 5.2.1)
+      activesupport (= 5.2.1)
+      bundler (>= 1.3.0)
+      railties (= 5.2.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.1)
+      actionpack (= 5.2.1)
+      activesupport (= 5.2.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (12.3.1)
+    react-rails (2.4.7)
+      babel-transpiler (>= 0.7.0)
+      connection_pool
+      execjs
+      railties (>= 3.2)
+      tilt
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-rails (3.8.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-steps (2.1.1)
+      rspec (>= 3.0, < 3.99)
+    rspec-support (3.8.0)
+    rspec-wait (0.0.9)
+      rspec (>= 3, < 4)
+    rubyzip (1.2.2)
+    selenium-webdriver (3.14.0)
+      childprocess (~> 0.5)
+      rubyzip (~> 1.2)
+    sourcemap (0.1.1)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.13)
+    thin (1.7.2)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0, >= 1.0.4)
+      rack (>= 1, < 3)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tilt (2.0.8)
+    timecop (0.8.1)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    uglifier (4.1.19)
+      execjs (>= 0.3.0, < 3)
+    unparser (0.2.8)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2.0)
+      concord (~> 0.1.5)
+      diff-lcs (~> 1.3)
+      equalizer (~> 0.0.9)
+      parser (>= 2.3.1.2, < 2.6)
+      procto (~> 0.0.2)
+    webdrivers (3.4.0)
+      nokogiri (~> 1.6)
+      rubyzip (~> 1.0)
+      selenium-webdriver (~> 3.0)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+    xpath (3.1.0)
+      nokogiri (~> 1.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  chromedriver-helper
+  database_cleaner
+  hyper-component!
+  hyper-operation!
+  hyper-spec!
+  hyper-store!
+  hyperloop-config!
+  mysql2
+  opal (>= 0.11.0, < 0.12.0)
+  opal-browser (~> 0.2.0)
+  opal-jquery!
+  opal-rails (~> 0.9.4)
+  pry-rescue
+  puma
+  pusher
+  pusher-fake
+  rails (>= 4.0.0)
+  rake
+  react-rails (>= 2.4.0, < 2.5.0)
+  rspec-rails
+  rspec-steps (~> 2.1.1)
+  rspec-wait
+  sqlite3
+  timecop (~> 0.8.1)
+
+BUNDLED WITH
+   1.16.1