hyper-operation 0.5.11 → 0.5.12

data/README.md

@@ -1,110 +1,76 @@
-#  Hyper-Operation
+<div class="githubhyperloopheader">
 
-## Hyper-Operation gem
+<p align="center">
 
-Operations encapsulate business logic. In a traditional MVC architecture, Operations end up either in Controllers, Models or some other secondary construct such as service objects, helpers, or concerns. Here they are first class objects. Their job is to mutate state in the Stores and Models.
+<a href="http://ruby-hyperloop.io/" alt="Hyperloop" title="Hyperloop">
+<img width="350px" src="http://ruby-hyperloop.io/images/hyperloop-github-logo.png">
+</a>
 
-+ Hyperloop::Operation is the base class for Operations.
-+ An Operation orchestrates the updating of the state of your system.
-+ Operations also wrap asynchronous operations such as HTTP API requests.
-+ Operations serve the role of both Action Creators and Dispatchers described in the Flux architecture.
-+ Operations also serve as the bridge between client and server. An operation can run on the client or the server, and can be invoked remotely.
+</p>
 
-## Documentation and Help
+<h2 align="center">The Complete Isomorphic Ruby Framework</h2>
 
-+ Please see the [ruby-hyperloop.io](http://ruby-hyperloop.io/) website for documentation.
-+ Join the Hyperloop [gitter.io](https://gitter.im/ruby-hyperloop/chat) chat for help and support.
+<br>
 
-## Installation and Setup
+<a href="http://ruby-hyperloop.io/" alt="Hyperloop" title="Hyperloop">
+<img src="http://ruby-hyperloop.io/images/githubhyperloopbadge.png">
+</a>
 
-**Note: Operations require Rails currently.**
+<a href="https://gitter.im/ruby-hyperloop/chat" alt="Gitter chat" title="Gitter chat">
+<img src="http://ruby-hyperloop.io/images/githubgitterbadge.png">
+</a>
 
-### Easy Installation
+[![Gem Version](https://badge.fury.io/rb/hyper-operation.svg)](https://badge.fury.io/rb/hyper-operation)
 
-The easiest way to install is to use the `hyper-rails` generator.
+<p align="center">
+<img src="http://ruby-hyperloop.io/images/HyperOperations.png" width="100" alt="Hyper-operation">
+</p>
 
-1. Add `gem 'hyper-rails'` to your Rails `Gemfile` development section.
-2. Install the Gem: `bundle install`
-3. Run the generator: `bundle exec rails g hyperloop:install --all`
-4. Update the bundle: `bundle update`
+</div>
 
-### Manual Installation
+## Hyper-Operation GEM is part of Hyperloop GEMS family
 
-Add `gem 'hyper-operation'` to your Gemfile
-Add `//= require hyperloop-loader` to your application.rb
+Build interactive Web applications quickly. Hyperloop encourages rapid development with clean, pragmatic design. With developer productivity as our highest goal, Hyperloop takes care of much of the hassle of Web development, so you can focus on innovation and delivering end-user value.
 
-If you want operations to interact between server and client you will have to pick a transport:
-```ruby
-# initializers/hyperloop.rb
-Hyperloop.configuration do |config|
-
-  # to use Action Cable
-    config.transport = :action_cable # for rails 5+
-
-  # to use Pusher (see www.pusher.com)
-    config.transport = :pusher
-    config.opts = {
-      app_id: "pusher application id",
-      key: "pusher public key",
-      secret: "pusher secret key"
-    }
-
-  # to use Pusher Fake (creates a fake pusher service)
-    # Its a bit weird:  You have to define require pusher and
-    # define some FAKE pusher keys first, then bring in pusher-fake
-    # the actual key values don't matter just the order!!!
-    require 'pusher'  
-    require 'pusher-fake'
-    Pusher.app_id = "MY_TEST_ID"      # don't bother changing these strings
-    Pusher.key =    "MY_TEST_KEY"
-    Pusher.secret = "MY_TEST_SECRET"
-    require 'pusher-fake/support/base'
-    # then setup your config like pusher but merge in the pusher fake
-    # options
-    config.transport = :pusher
-    config.opts = {
-      app_id: Pusher.app_id,
-      key: Pusher.key,
-      secret: Pusher.secret
-    }.merge(PusherFake.configuration.web_options)
-
-  # For down and dirty simplicity use polling:
-    config.transport = :simple_poller
-    # change this to slow down polling, default is much faster
-    # and hard to debug
-    config.opts = { seconds_between_poll: 2 }
-end
-```
+One language. One model. One set of tests. The same business logic and domain models running on the clients and the server. Hyperloop is fully integrated with Rails and also gives you unfettered access to the complete universe of JavaScript libraries (including React) from within your Ruby code. Hyperloop lets you build beautiful interactive user interfaces in Ruby.
 
-You will also have to add at least one channel policy to authorize the connection between clients and the server.
+Everything has a place in our architecture. Components deliver interactive user experiences, Operations encapsulate business logic, Models magically synchronize data between clients and servers, Policies govern authorization and Stores hold local state.
 
-```ruby
-# app/policies/application_policy.rb
-class Hyperloop::ApplicationPolicy
-  # allow any client too attach to the Hyperloop::Application for example
-  always_allow_connection  
-end
-```
+**Hyper-Operation** brings Operations which encapsulate business logic. In a traditional MVC architecture, Operations end up either in Controllers, Models or some other secondary construct such as service objects, helpers, or concerns. Here they are first class objects. Their job is to mutate state in the Stores and Models.
 
-See the [Channels](#channels) section for more details on authorization.
+## Getting Started
 
-### Add the engine
+1. Update your Gemfile:
 
 ```ruby
-# config/routes.rb
-mount Hyperloop::Engine => '/hyperloop'
+#Gemfile
+
+gem 'hyperloop'
 ```
 
-### Operation Folder Structure
+2. At the command prompt, update your bundle :
+
+        $ bundle update
+
+3. Run the hyperloop install generator:
+
+        $ rails g hyperloop:install
 
-Your Isomorphic Operations live in a `app/hyperloop/operations` folder and your server only Operations in `app/operations`
+4. Follow the guidelines to start developing your application. You may find
+   the following resources handy:
+    * [Getting Started with Hyperloop](http://ruby-hyperloop.io/start/components/)
+    * [Hyperloop Guides](http://ruby-hyperloop.io/docs/architecture)
+    * [Hyperloop Tutorial](http://ruby-hyperloop.io/tutorials)
 
-You will also find an `app/policies` folder with a simple access policy suited for development.  Policies are how you will provide detailed access control to your Isomorphic models.  
+## Community
 
-## Contributing
+#### Getting Help
+Please **do not post** usage questions to GitHub Issues. For these types of questions use our [Gitter chatroom](https://gitter.im/ruby-hyperloop/chat) or [StackOverflow](http://stackoverflow.com/questions/tagged/hyperloop).
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ruby-hyperloop/hyper-operation. 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/ruby-hyperloop/hyper-operation/blob/master/CODE_OF_CONDUCT.md) code of conduct.
+#### Submitting Bugs and Enhancements
+[GitHub Issues](https://github.com/ruby-hyperloop/hyperloop/issues) is for suggesting enhancements and reporting bugs. Before submiting a bug make sure you do the following:
+* Check out our [contributing guide](https://github.com/ruby-hyperloop/hyperloop/blob/master/CONTRIBUTING.md) for info on our release cycle.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+Hyperloop is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/hyper-operation.gemspec

@@ -23,8 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'hyperloop-config', '>= 0.9.7'
   spec.add_dependency 'opal-activesupport'
   spec.add_dependency 'activerecord', '>= 0.3.0'
-  spec.add_dependency 'pusher'
-  spec.add_dependency 'pusher-fake'
 
   spec.add_development_dependency "bundler", "~> 1.8"
   spec.add_development_dependency "rake", "~> 10.0"
@@ -35,10 +33,14 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'hyper-react'
   spec.add_development_dependency 'opal-browser'
   spec.add_development_dependency 'sqlite3', '1.3.10'
+  spec.add_development_dependency 'mysql2'
   spec.add_development_dependency 'database_cleaner'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rspec-wait'
   spec.add_development_dependency 'puma'
   spec.add_development_dependency 'rspec-steps'
+  spec.add_development_dependency 'pusher'
+  spec.add_development_dependency 'pusher-fake'
+  spec.add_development_dependency 'timecop', '~>0.8.1'
 
 end

data/lib/hyper-operation/api.rb

@@ -63,6 +63,11 @@ module Hyperloop
         _Railway.add_param(*args, &block)
       end
 
+      def inbound(*args, &block)
+        name, opts = ParamsWrapper.get_name_and_opts(*args)
+        _Railway.add_param(name, opts.merge(inbound: :true), &block)
+      end
+
       def outbound(*keys)
         keys.each { |key| _Railway.add_param(key => nil, :type => :outbound) }
         #singleton_class.outbound(*keys)
@@ -102,6 +107,11 @@ module Hyperloop
           _Railway.add_param(*args, &block)
         end
 
+        child.singleton_class.define_singleton_method(:inbound) do |*args, &block|
+          name, opts = ParamsWrapper.get_name_and_opts(*args)
+          _Railway.add_param(name, opts.merge(inbound: :true), &block)
+        end
+
         child.singleton_class.define_singleton_method(:outbound) do |*keys|
           keys.each { |key| _Railway.add_param(key => nil, :type => :outbound) }
         end

data/lib/hyper-operation/railway/params_wrapper.rb

@@ -12,7 +12,12 @@ module Hyperloop
       end
 
       def to_h
-        @inputs.with_indifferent_access
+        inputs = @inputs
+        if @locked
+          inputs = inputs.dup
+          self.class.inbound_params.each { |name| inputs.delete :"#{name}" }
+        end
+        inputs.with_indifferent_access
       end
 
       def to_s
@@ -39,6 +44,7 @@ module Hyperloop
 
         def add_param(*args, &block)
           type_method, name, opts, block = translate_args(*args, &block)
+          inbound_params << :"#{name}" if opts.delete(:inbound)
           if opts.key? :default
             hash_filter.optional { send(type_method, name, opts, &block) }
           else
@@ -65,6 +71,10 @@ module Hyperloop
           @hash_filter ||= Mutations::HashFilter.new
         end
 
+        def inbound_params
+          @inbound_params ||= Set.new
+        end
+
         def translate_args(*args, &block)
           name, opts = get_name_and_opts(*args)
           if opts.key?(:type)
@@ -115,6 +125,8 @@ module Hyperloop
             Class.new(superclass.params_wrapper).tap do |wrapper|
               hash_filter = superclass.params_wrapper.hash_filter
               wrapper.instance_variable_set('@hash_filter', hash_filter && hash_filter.dup)
+              inbound_params = superclass.params_wrapper.inbound_params
+              wrapper.instance_variable_set('@inbound_params', inbound_params && inbound_params.dup)
             end
           end
         end

data/lib/hyper-operation/server_op.rb

@@ -101,7 +101,7 @@ module Hyperloop
   end
 
   class ControllerOp < ServerOp
-    param :controller
+    inbound :controller
     alias pre_controller_op_method_missing method_missing
     def method_missing(name, *args, &block)
       if params.controller.respond_to? name

data/lib/hyper-operation/transport/client_drivers.rb

@@ -28,6 +28,10 @@ module Hyperloop
       end
     end
 
+    def self.connect_session
+      connect(['Hyperloop::Session', ClientDrivers.opts[:id].split('-').last])
+    end
+
     def self.action_cable_consumer
       ClientDrivers.opts[:action_cable_consumer]
     end
@@ -114,6 +118,7 @@ module Hyperloop
       end
       controller.session.delete 'hyperloop-dummy-init' unless controller.session.id
       id = "#{SecureRandom.uuid}-#{controller.session.id}"
+      auto_connections = Hyperloop::AutoConnect.channels(id, controller.acting_user)
       config_hash = {
         transport: Hyperloop.transport,
         id: id,
@@ -126,7 +131,7 @@ module Hyperloop
         channel: Hyperloop.channel,
         form_authenticity_token: controller.send(:form_authenticity_token),
         seconds_between_poll: Hyperloop.seconds_between_poll,
-        auto_connect: Hyperloop::AutoConnect.channels(id, controller.acting_user)
+        auto_connect:  auto_connections
       }
       path = ::Rails.application.routes.routes.detect do |route|
         # not sure why the second check is needed.  It happens in the test app
@@ -171,7 +176,6 @@ module Hyperloop
       end
 
       if on_opal_client?
-
         if opts[:transport] == :pusher
 
           opts[:dispatch] = lambda do |data|

data/lib/hyper-operation/transport/connection.rb

@@ -2,7 +2,8 @@ module Hyperloop
   module AutoCreate
     def needs_init?
       return false if Hyperloop.transport == :none
-      return true unless connection.tables.include?(table_name)
+      return true if connection.respond_to?(:data_sources) && !connection.data_sources.include?(table_name)
+      return true if !connection.respond_to?(:data_sources) && !connection.tables.include?(table_name)
       return false unless Hyperloop.on_server?
       return true if defined?(Rails::Server)
       return true unless Connection.root_path

data/lib/hyper-operation/transport/hyperloop.rb

@@ -19,6 +19,7 @@ module Hyperloop
       config.after_initialize { Connection.build_tables }
     end
     Object.send(:remove_const, :Application) if @fake_application_defined
+    @fake_application_defined = false
     policy = begin
       Object.const_get 'ApplicationPolicy'
     rescue LoadError
@@ -61,6 +62,7 @@ module Hyperloop
   define_setting :opts, {}
   define_setting :channel_prefix, 'synchromesh'
   define_setting :client_logging, true
+  define_setting :connect_session, true
 
   def self.app_id
     opts[:app_id] || Pusher.app_id if transport == :pusher

data/lib/hyper-operation/transport/hyperloop_controller.rb

@@ -42,6 +42,17 @@ module Hyperloop
         session.delete 'hyperloop-dummy-init' unless session.id
       end
 
+      def session_channel
+        "Hyperloop::Session-#{session.id}"
+      end
+
+      def regulate(channel)
+        unless channel == session_channel # "Hyperloop::Session-#{client_id.split('-').last}"
+          Hyperloop::InternalPolicy.regulate_connection(try(:acting_user), channel)
+        end
+        channel
+      end
+
       def channels(user = acting_user, session_id = session.id)
         Hyperloop::AutoConnect.channels(session_id, user)
       end
@@ -89,8 +100,7 @@ module Hyperloop
       end
 
       def subscribe
-        channel = params[:channel].gsub('==', '::')
-        Hyperloop::InternalPolicy.regulate_connection(try(:acting_user), channel)
+        channel = regulate params[:channel].gsub('==', '::')
         root_path = request.original_url.gsub(/hyperloop-subscribe.*$/, '')
         Hyperloop::Connection.open(channel, client_id, root_path)
         head :ok
@@ -105,8 +115,7 @@ module Hyperloop
       end
 
       def pusher_auth
-        channel = params[:channel_name].gsub(/^#{Regexp.quote(Hyperloop.channel)}\-/,'').gsub('==', '::')
-        Hyperloop::InternalPolicy.regulate_connection(acting_user, channel)
+        channel = regulate params[:channel_name].gsub(/^#{Regexp.quote(Hyperloop.channel)}\-/,'').gsub('==', '::')
         response = Hyperloop.pusher.authenticate(params[:channel_name], params[:socket_id])
         render json: response
       rescue Exception => e
@@ -114,8 +123,7 @@ module Hyperloop
       end
 
       def action_cable_auth
-        channel = params[:channel_name].gsub(/^#{Regexp.quote(Hyperloop.channel)}\-/,'')
-        Hyperloop::InternalPolicy.regulate_connection(acting_user, channel)
+        channel = regulate params[:channel_name].gsub(/^#{Regexp.quote(Hyperloop.channel)}\-/,'')
         salt = SecureRandom.hex
         authorization = Hyperloop.authorization(salt, channel, client_id)
         render json: {authorization: authorization, salt: salt}

data/lib/hyper-operation/transport/policy.rb

@@ -296,11 +296,8 @@ module Hyperloop
     def self.channels(session, acting_user)
       channels = ClassConnectionRegulation.connections_for(acting_user, true) +
         InstanceConnectionRegulation.connections_for(acting_user, true)
-      channels = channels.uniq
-      channels.each do |channel|
-        Connection.open(channel, session)
-      end
-      channels
+      channels << "Hyperloop::Session-#{session.split('-').last}" if Hyperloop.connect_session && session
+      channels.uniq.each { |channel| Connection.open(channel, session) }
     end
   end
 

data/lib/hyper-operation/version.rb

@@ -1,5 +1,5 @@
 module Hyperloop
   class Operation
-    VERSION = '0.5.11'
+    VERSION = '0.5.12'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hyper-operation
 version: !ruby/object:Gem::Version
-  version: 0.5.11
+  version: 0.5.12
 platform: ruby
 authors:
 - catmando
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-25 00:00:00.000000000 Z
+date: 2017-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mutations
@@ -80,34 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.0
-- !ruby/object:Gem::Dependency
-  name: pusher
-  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: pusher-fake
-  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -234,6 +206,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.3.10
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -304,6 +290,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pusher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pusher-fake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
 description: 
 email:
 - mitch@catprint.com
@@ -313,6 +341,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - CODE_OF_CONDUCT.md
+- DOCS-POLICIES.md
+- DOCS.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -619,7 +649,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Compose your business logic into isomorphic commands that sanitize and validate