mobile_workflow 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '068f070743f72d5743182cd41021c33b89579ecef7182a5747c799393a1d4208'
-  data.tar.gz: 41aef887eb318cf98736112ce4aad51835af98f1d20e0d75f7810c9014f4c5e4
+  metadata.gz: 256261333d1969340beeb74ed09a0578f550e44f8be36e0dc78353c8dc9ba9d6
+  data.tar.gz: 895641f2f4ccffd872e944e516a97917c412390c5eb505192284ba1dc0b56eca
 SHA512:
-  metadata.gz: 90ad8d639c45ff2c757a933199022a1fad59d649c815211425366c45d72a9596e516fe382835b7ffca76f1dc7bdbc85b14d35b65b723dcd751750ff10195803d
-  data.tar.gz: 8adcf9c22591e5644b484c0216a9f8d157222078f8ed37cebcdc9333560c30294f018e06cdfc26c8d3a27bfe9f7016346658ff4fe83a215d162f2a0946dbcaa6
+  metadata.gz: a3b4dd40132e7ac6dd1e3314bc958cd9b1e2ee8b0aa0e9adcbb7e35e57ec933b57f18cb79927acebc8ae2d155895a958885c897c05d54b8b9460b22fc25bc85a
+  data.tar.gz: 37f3c7fce459451c57b9fc8eb2b1f1331c0ab840372ce651fe768abfbf4a2dc3f1f0de389f73add39b13b9d0d3e591edec008dcc39a7dc64326580ecd821ee7b

data/app/controllers/concerns/mobile_workflow/param_parser.rb

@@ -0,0 +1,17 @@
+module MobileWorkflow
+  module ParamParser
+    def mw_rewrite_payload_properties(model:, properties:)
+      properties.each {|property| mw_rewrite_payload_property(model: model, model_property: property, params_property: property)}
+    end
+
+    def mw_rewrite_payload_property(model:, model_property:, params_property:)
+      params[model][model_property] = params.dig(:payload, params_property, :answer)
+    end
+
+    def mw_rewrite_payload_array(model:, model_property:, params_property:)
+      answer = params.dig(:payload, params_property, :answer)
+      params[model][model_property] = answer[0] if answer
+    end    
+  end
+end
+

data/app/controllers/concerns/mobile_workflow/s3_storable.rb

@@ -7,11 +7,11 @@ module MobileWorkflow
         return unless params["binaries"]
     
         params["binaries"].collect do |binary|
-          property = binary["identifier"].split('/')[0] # i.e. image/jpg --> image, video/mp4 --> video
+          extension = binary["mimetype"].split('/')[1] # i.e. image/jpg --> image, video/mp4 --> video
       
           {
             "identifier" => binary["identifier"],
-            "url" => presigned_url("#{object.class.name.underscore}/#{object.id}/#{property}"),
+            "url" => presigned_url("#{object.class.name.underscore}/#{object.id}/#{binary["identifier"]}.#{extension}"),
             "method" => "PUT"
           }
         end

data/app/controllers/mobile_workflow/sns_notifications_controller.rb

@@ -46,6 +46,10 @@ module MobileWorkflow
       end
   
       def attribute_name
+        file_name.split(".")[0] # remove the extension
+      end
+      
+      def file_name
         key_identifiers[2]
       end
   

data/app/models/concerns/mobile_workflow/displayable.rb

@@ -0,0 +1,86 @@
+module MobileWorkflow
+  module Displayable
+    extend ActiveSupport::Concern
+    include Rails.application.routes.url_helpers
+    
+    ON_SUCCESS_OPTIONS = [:none, :reload, :backward, :forward]
+    BUTTON_STYLES = [:primary, :outline, :danger]
+      
+    def mw_list_item(id: self.id, text:, detail_text: nil, sf_symbol_name: nil, image_attachment: nil)
+      mw_list_item = {id: id, text: text, detailText: detail_text, sfSymbolName: sf_symbol_name}
+      mw_list_item[:imageURL] = preview_url(image_attachment, height: 100, width: 100) if image_attachment
+      mw_list_item.compact   
+    end
+  
+    def mw_display_text(text:, label: nil)
+      {type: :text, label: label, text: text.to_s}.compact
+    end
+  
+    def mw_display_image(attachment)
+      {type: :image, previewURL: preview_url(attachment, height: 300, width: 600), url: attachment_url(attachment)}
+    end
+    
+    def mw_display_video(attachment)
+      {type: :video, previewURL: preview_url(attachment, height: 300, width: 600), url: attachment_url(attachment)}
+    end
+  
+    def mw_display_button(label:, style: :primary, on_success: :forward)
+      validate_on_success!(on_success)
+      validate_button_style!(style)
+      
+      {type: :button, label: label, style: style, onSuccess: on_success}
+    end
+  
+    def mw_display_delete_button(url:, label: "Delete", method: :delete, style: :danger, on_success: :backward)
+      validate_on_success!(on_success)
+      validate_button_style!(style)
+      
+      {type: :button, label: label, url: url, method: method, style: style, onSuccess: on_success}
+    end
+    
+    def mw_display_button_for_url(label:, url:, method: :put, style: :primary, on_success: :reload)
+      validate_on_success!(on_success)
+      validate_button_style!(style)
+      
+      {type: :button, label: label, url: url, method: method, style: style, onSuccess: on_success}
+    end
+    
+    def mw_display_button_for_modal_workflow(label:, modal_workflow:, style: :primary, on_success: :none)
+      validate_on_success!(on_success)
+      validate_button_style!(style)
+      
+      {type: :button, label: label, modalWorkflow: modal_workflow, style: style, onSuccess: on_success}
+    end
+  
+    private
+    def validate_on_success!(on_success)
+      raise 'Unknown on_success action' unless ON_SUCCESS_OPTIONS.include?(on_success)
+    end
+    
+    def validate_button_style!(style)
+      raise 'Unknown style' unless BUTTON_STYLES.include?(style)      
+    end
+  
+    def preview_url(attachment, height:, width:, options: { resize_to_fill: [height, width]} )
+      return nil unless attachment.attached?
+
+      if attachment.image?
+        Rails.application.routes.url_helpers.rails_representation_url(attachment.variant(combine_options: options), host: attachment_host)
+      elsif attachment.previewable?
+        Rails.application.routes.url_helpers.rails_representation_url(attachment.preview(options), host: attachment_host)
+      else
+        return nil
+      end
+    end
+
+    def attachment_url(attachment)
+      return nil unless attachment.attached?
+    
+      Rails.application.routes.url_helpers.rails_blob_url(attachment, host: attachment_host)
+    end
+
+    def attachment_host
+      "https://#{ENV['HEROKU_APP_NAME']}.herokuapp.com"
+    end
+  end
+end

data/config/routes.rb

@@ -1,2 +1,3 @@
 MobileWorkflow::Engine.routes.draw do
+  resources :sns_notifications, only: :create
 end

data/db/migrate/20200823174210_create_users.rb

@@ -0,0 +1,11 @@
+class CreateUsers < ActiveRecord::Migration[6.0]
+  def change
+    create_table :users do |t|
+      t.string :email
+      t.string :password_digest
+
+      t.timestamps
+    end
+    add_index :users, :email
+  end
+end

data/lib/generators/mobile_workflow/controller_generator.rb

@@ -25,7 +25,11 @@ module MobileWorkflow
       end
       
       def rewrite_params
-        attributes_names.map {|name| "params[:#{singular_table_name}][:#{name}] = params[:payload][:#{name}][:answer]" }.join("\n\t\t")
+        if attributes_names
+          init_params = "\n\t\tparams[:#{singular_table_name}] = {}\n"
+          rewrite_params = attributes_names.map {|name| "params[:#{singular_table_name}][:#{name}] = params.dig(:payload, :#{name}, :answer)" }.join("\n\t\t")
+          init_params + rewrite_params
+        end
       end
     end
   end

data/lib/generators/mobile_workflow/install/install_generator.rb

@@ -3,22 +3,41 @@ require "rails/generators/base"
 module MobileWorkflow
   module Generators
     class InstallGenerator < Rails::Generators::Base
+      
+      # Schemas to avoid generating models for (static items from MW)
+      SKIP_SCHEMAS = ["answer", "attachment", "ListItem", "DisplayItem", "DisplayText", "DisplayButton", "DisplayImage", "DisplayVideo"]
+      
       source_root File.expand_path("../templates", __FILE__)
 
       class_option :open_api_spec_path, type: :string, default: "config/open_api_spec.json"
+      class_option :doorkeeper_oauth, type: :boolean, default: false
 
       def create_api_controller
-        template(
-          "api_controller.rb.erb",
-          "app/controllers/api_controller.rb",
-        )
+        template("api_controller.rb.erb", "app/controllers/api_controller.rb")
+      end
+      
+      def mount_engine
+        route "mount MobileWorkflow::Engine => '/'"
+      end
+      
+      def generate_doorkeeper
+        return unless options[:doorkeeper_oauth]
+        say "Generating Doorkeeper OAuth"
+        
+        generate 'doorkeeper:install'
+        gsub_file 'config/initializers/doorkeeper.rb', 'raise "Please configure doorkeeper resource_owner_authenticator block located in #{__FILE__}"', 'User.find_by_id(session[:user_id]) || redirect_to(new_session_url(return_to: request.fullpath))'
+        generate 'doorkeeper:migration'
+        generate 'doorkeeper:pkce'
+        template("user.rb.erb", "app/models/user.rb")
+        template("sessions_controller.rb.erb", "app/controllers/sessions_controller.rb")
+        route "resources :sessions, only: [:new, :create]"
       end
       
       def generate_models
         say "Generating models"
         @model_properties = {}
         open_api_spec[:components][:schemas].each_pair do |model_name, schema|
-          next if ["answer", "attachment"].include? model_name # Don't generate schemas for MW schemas
+          next if SKIP_SCHEMAS.include? model_name # Don't generate schemas for MW schemas
         
           model_name = model_name.underscore
           model_properties = model_properties(model_name, schema)
@@ -40,6 +59,10 @@ module MobileWorkflow
           route "resources :#{plural_controller_name}, only: [:index, :show, :create]"
         end
       end
+      
+      def generate_seeds
+        template("seeds.rb.erb", "db/seeds.rb")
+      end
 
       private
       def open_api_spec
@@ -48,7 +71,7 @@ module MobileWorkflow
       
       def read_openapi_spec
         say "Loading OpenAPI Spec: #{open_api_spec_path}" 
-        return JSON.parse(File.read(open_api_spec_path)).with_indifferent_access 
+        return JSON.parse(File.read(File.join(Rails.root, open_api_spec_path))).with_indifferent_access 
       end
       
       def open_api_spec_path
@@ -56,13 +79,24 @@ module MobileWorkflow
       end
       
       def model_properties(name, schema)
-        generated_properties_args = schema["properties"].keys.collect{|key| "#{key}:string" }.join(" ")
+        generated_properties_args = schema["properties"].keys.collect{|key| "#{key}:#{model_property_type(schema["properties"][key])}" }.join(" ")
         if yes?("Use generated schema #{name}(#{generated_properties_args})[yn]?")
           generated_properties_args
         else
           ask "Specify schema for #{name}: (e.g. text:string image:attachment region:reference)"
         end      
       end
+      
+      def model_property_type(property)
+        case property['$ref']
+        when "#/components/schemas/answer"
+          'string'
+        when "#/components/schemas/attachment"
+          'attachment'
+        else
+          'string'
+        end
+      end
     end
   end
 end

data/lib/generators/mobile_workflow/install/templates/api_controller.rb.erb

@@ -1,5 +1,19 @@
 class ApiController < ActionController::API
+  <% if options[:doorkeeper_oauth] %>
+  before_action :doorkeeper_authorize!, unless: :anonymous_action?
+  
+  def current_resource_owner
+    User.find(doorkeeper_token.resource_owner_id) if doorkeeper_token
+  end
+  alias_method :current_user, :current_resource_owner
+  
+  protected
+  def anonymous_action?
+    false
+  end
+  <% else %>
   def current_user
     nil
   end
+  <% end %>
 end

data/lib/generators/mobile_workflow/install/templates/seeds.rb.erb

@@ -0,0 +1,3 @@
+<%- if options[:doorkeeper_oauth] %>
+Doorkeeper::Application.create! name: 'Main App', redirect_uri: 'mww://callback', scopes: 'public'
+<%- end %>

data/lib/generators/mobile_workflow/install/templates/sessions_controller.rb.erb

@@ -0,0 +1,20 @@
+class SessionsController < ApplicationController
+  def new
+  end
+
+  def create
+    @user = User.find_by(email: params[:email])
+    if @user && @user.authenticate(params[:password])
+      session[:user_id] = @user.id
+      redirect_to params[:return_to] || root_url, notice: "Logged in!"
+    else
+      flash[:warning] = "You have entered incorrect email and/or password."
+      render :new
+    end
+  end
+
+  def destroy
+    session.delete(:user_id)
+    redirect_to root_path
+  end
+end

data/lib/generators/mobile_workflow/install/templates/user.rb.erb

@@ -0,0 +1,4 @@
+class User < ApplicationRecord
+  has_secure_password
+  validates :email, presence: true
+end

data/lib/generators/mobile_workflow/templates/controller.rb.erb

@@ -1,5 +1,6 @@
 <% module_namespacing do -%>
 class <%= controller_class_name %>Controller < ApiController
+  # include MobileWorkflow::S3Storable
   before_action :rewrite_payload, only: :create
 
   load_and_authorize_resource

data/lib/mobile_workflow/version.rb

@@ -1,3 +1,3 @@
 module MobileWorkflow
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/templates/active_record/model/model.rb.erb

@@ -1,7 +1,6 @@
 <% module_namespacing do -%>
 class <%= class_name %> < <%= parent_class_name.classify %>
-  # Enable if you need to generate attachment URLs
-  # include Rails.application.routes.url_helpers
+  include MobileWorkflow::Displayable
   
 <% attributes.select(&:reference?).each do |attribute| -%>
   belongs_to :<%= attribute.name %><%= ', polymorphic: true' if attribute.polymorphic? %>
@@ -14,43 +13,12 @@ class <%= class_name %> < <%= parent_class_name.classify %>
 <% end -%>
 
   def list_item_as_json
-    {
-      id: id,
-      text: text,
-      # detailText: nil,
-      # sfSymbolName: nil,
-      # imageURL: preview_url(image, height: 100, width: 100)
-    }
+    mw_list_item(text: text)
   end
   
   def display_as_json
-    [
-      {label: "ID", text: text, mimeType: 'text/plain'},
-      {label: "Text", text: text, mimeType: 'text/plain'}
-    ]
+    [mw_display_text(label: 'ID', text: id.to_s)]
   end
-  
-  # private
-  # include Rails.application.routes.url_helpers # for attachment URLs
-  # def preview_url(attachment, height:, width:, options: { resize_to_fill: [height, width]} )
-  #   return nil unless attachment.attached?
-  #
-  #   if attachment.image?
-  #     Rails.application.routes.url_helpers.rails_representation_url(attachment.variant(combine_options: options), host: attachment_host)
-  #   elsif attachment.previewable?
-  #     Rails.application.routes.url_helpers.rails_representation_url(attachment.preview(options), host: attachment_host)
-  #   else
-  #     return nil
-  #   end
-  # end
-  #
-  # def attachment_url(attachment)
-  #   Rails.application.routes.url_helpers.rails_blob_url(attachment, host: attachment_host)
-  # end
-  #
-  # def attachment_host
-  #   "https://#{ENV['HEROKU_APP_NAME']}.herokuapp.com"
-  # end
 
 end
 <% end -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mobile_workflow
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Matt Brooke-Smith
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
+date: 2020-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -58,7 +58,35 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  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: byebug
+  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'
+description:
 email:
 - matt@futureworkshops.com
 executables: []
@@ -70,17 +98,22 @@ files:
 - Rakefile
 - app/assets/config/mobile_workflow_manifest.js
 - app/assets/stylesheets/mobile_workflow/application.css
+- app/controllers/concerns/mobile_workflow/param_parser.rb
 - app/controllers/concerns/mobile_workflow/s3_storable.rb
 - app/controllers/mobile_workflow/sns_notifications_controller.rb
 - app/helpers/mobile_workflow/application_helper.rb
 - app/jobs/mobile_workflow/application_job.rb
 - app/mailers/mobile_workflow/application_mailer.rb
-- app/models/mobile_workflow/application_record.rb
+- app/models/concerns/mobile_workflow/displayable.rb
 - app/views/layouts/mobile_workflow/application.html.erb
 - config/routes.rb
+- db/migrate/20200823174210_create_users.rb
 - lib/generators/mobile_workflow/controller_generator.rb
 - lib/generators/mobile_workflow/install/install_generator.rb
 - lib/generators/mobile_workflow/install/templates/api_controller.rb.erb
+- lib/generators/mobile_workflow/install/templates/seeds.rb.erb
+- lib/generators/mobile_workflow/install/templates/sessions_controller.rb.erb
+- lib/generators/mobile_workflow/install/templates/user.rb.erb
 - lib/generators/mobile_workflow/templates/controller.rb.erb
 - lib/generators/mobile_workflow/templates/controller_spec.rb.erb
 - lib/mobile_workflow.rb
@@ -92,7 +125,7 @@ homepage: https://github.com/futureworkshops/mobile_workflow
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -108,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.8
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A Rails engine to provide API support for Mobile Workflow Apps.
 test_files: []

data/app/models/mobile_workflow/application_record.rb

@@ -1,5 +0,0 @@
-module MobileWorkflow
-  class ApplicationRecord < ActiveRecord::Base
-    self.abstract_class = true
-  end
-end