mobile_workflow 0.7.6 → 0.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d2de8e8e58abbf48c61361f6e1f29743fb4503ea9903c2b8a262e1e8c5419f0
-  data.tar.gz: 7f4021ded5e08c6f4f1a66cc69556c47d6dc57b6f099c206dc9bdb3f892a7135
+  metadata.gz: cf9a3d0ae2752b171aea1043b7cc57a8425b80ecf086bb226faadffb936fd5ee
+  data.tar.gz: 1d0c4bf77cbbb66844a58a4d94bfb5532f4706a4a5fa2ae02f01e1e0f72e4939
 SHA512:
-  metadata.gz: 071d242cfba279223971ff929acaba7285e017b5c836be68ba5f02ad46a4571d39c98ea25de67d4b6ea586b4bdded534f6fae1cac27ebc53e3f8ba642ec01c33
-  data.tar.gz: 8d4ce06b17e4b3d4cd327c5d65f6035065e098456e39d10e420f287b5c545d8524899870c00bb893587ef4c4c72587e98193b8fdf78dde74671f32d0cf0d7083
+  metadata.gz: e3c1748bdbe2b84415e434632080968cc02fb4e6e7b5a248bf8d979868b74714ce89c0d04165207d3b67008e45b3f08e4b84f67124a128f971627ad28611591f
+  data.tar.gz: 90329d6e78a89c601fa6bb5cc62b4d856b9ba264e56d6bfe83b7e1afc5ea5d1849355ccf1beb272d2474c90b5b5ec2bca191903db9dbe465fa5141b52053dadf

data/README.md

@@ -26,6 +26,89 @@ Or install it yourself as:
 $ gem install mobile_workflow
 ```
 
+## Upgrade to version 0.7.7 or higher
+The following utility methods have changed their parameters:
+
+```ruby
+# app/models/concerns/mobile_workflow/displayable/steps/styled_content/grid.rb#20
+def mw_grid_item(id: self.id, text:, detail_text: nil, preview_url: nil)
+  raise 'Missing id' if id.nil?
+  raise 'Missing text' if text.nil?
+  
+  { id: id, text: text, type: :item, detailText: detail_text, imageURL: preview_url }.compact
+end
+
+# app/models/concerns/mobile_workflow/displayable/steps/styled_content/stack.rb#20
+def mw_stack_list_item(id:, text:, detail_text: nil, preview_url: nil)
+  raise 'Missing id' if id.nil?
+  raise 'Missing text' if text.nil?
+
+  { id: id.to_s, text: text, detailText: detail_text, type: :listItem, imageURL: preview_url }.compact
+end
+
+# app/models/concerns/mobile_workflow/displayable/steps/list.rb#5
+def mw_list_item(id: self.id, text:, detail_text: nil, sf_symbol_name: nil, material_icon_name: nil, preview_url: nil)
+  { id: id, text: text, detailText: detail_text, sfSymbolName: sf_symbol_name, materialIconName: material_icon_name, imageURL: preview_url }.compact
+end
+
+# app/models/concerns/mobile_workflow/displayable/steps/stack.rb#26
+def mw_display_video(preview_url:, attachment_url:)
+  {type: :video, previewURL: preview_url, url: attachment_url}
+end
+
+# app/models/concerns/mobile_workflow/displayable/steps/stack.rb#11
+def mw_display_image(preview_url:, attachment_url:, content_mode: :scale_aspect_fill)
+  validate_content_mode!(content_mode)
+  
+  {type: :image, contentMode: camelcase_converter(content_mode.to_s, first_letter: :lower), previewURL: preview_url, url: attachment_url}
+end
+```
+
+All URLs MUST now be explicitly sent as arguments to the above methods, which means they must be previously set. If not, the methods will not work.
+
+In order to support projects using `ActiveStorage`, there is a new model concern `MobileWorkflow::Attachable` that provides a few helpers. This is what you can do to upgrade if you use ActiveStorage (otherwise the helpers must be manually created):
+
+1. Include the concern in the `ApplicationRecord` class, together with `MobileWorkflow::Displayable`:
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  include MobileWorkflow::Attachable
+  include MobileWorkflow::Displayable
+end
+```
+
+2. Once included, the following helpers will be available, so use them to generate the intended URLs:
+
+```ruby
+def preview_url(attachment, options: { resize_to_fill: [200, 200] })
+  return nil unless attachment.attached?
+
+  if attachment.image?
+    rails_representation_url(attachment.variant(options), host: heroku_attachment_host)
+  elsif attachment.previewable?
+    rails_representation_url(attachment.preview(options), host: heroku_attachment_host)
+  else
+    return nil
+  end
+end
+
+def attachment_url(attachment)
+  return nil unless attachment.attached?
+
+  rails_blob_url(attachment, host: heroku_attachment_host)
+end
+```
+
+Example of use:
+```ruby
+# Old method call
+mw_list_item(text: 'John Doe', detail_text: 'Company Name', image_attachment: <ActiveStorage::Attached::One>, image_url: 'https://test.org/preview')
+
+# New method call
+preview_url = preview_url(<ActiveStorage::Attached::One>, options: { resize_to_fill: [200, 200] }) || 'https://test.org/preview'
+mw_list_item(text: 'John Doe', detail_text: 'Company Name', preview_url: preview_url)
+```
+
 ## Contributing
 Contribution directions go here.
 

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

@@ -1,3 +1,5 @@
+require 'aws-sdk-s3'
+
 module MobileWorkflow
   module S3Storable
     if Object.const_defined?("Aws::S3")
@@ -10,10 +12,11 @@ module MobileWorkflow
           identifier = binary[:identifier]
           object_attribute = identifier.split(".")[0] # ensure extension doesnt get added here
           extension = binary[:mimetype].split('/')[1] # i.e. image/jpg --> jpg, video/mp4 --> mp4
-      
+          metadata = binary[:metadata]
+
           {
             identifier: identifier,
-            url: presigned_url("#{object.class.name.underscore}/#{object.id}/#{object_attribute}/#{s3_object_uuid}.#{extension}"),
+            url: presigned_url("#{object.class.name.underscore}/#{object.id}/#{object_attribute}/#{s3_object_uuid}.#{extension}", metadata: metadata),
             method: "PUT"
           }
         end
@@ -24,8 +27,8 @@ module MobileWorkflow
         SecureRandom.uuid
       end
       
-      def presigned_url(key)
-        presigner.presigned_url(:put_object, bucket: ENV['AWS_BUCKET_NAME'], key: key, metadata: {})
+      def presigned_url(key, metadata: nil)
+        presigner.presigned_url(:put_object, bucket: ENV['AWS_BUCKET_NAME'], key: key, metadata: metadata)
       end
   
       def presigner
@@ -35,7 +38,6 @@ module MobileWorkflow
       def s3_client
         Aws::S3::Client.new(region: ENV['AWS_REGION'], access_key_id: ENV['AWS_ACCESS_ID'], secret_access_key: ENV['AWS_SECRET_KEY'])
       end
-      
     end
   end
 end

data/app/controllers/mobile_workflow/sns_notifications_controller.rb

@@ -1,3 +1,5 @@
+require 'aws-sdk-sns'
+
 module MobileWorkflow
   class SnsNotificationsController < ActionController::API
     if Object.const_defined?("Aws::S3") && Object.const_defined?("Aws::SNS")
@@ -10,26 +12,16 @@ module MobileWorkflow
         when 'SubscriptionConfirmation'
           confirm_subscription ? (head :ok) : (head :bad_request)
         else
-          add_attachment
+          AddAttachmentJob.perform_now(object, object_key, attribute_name)
+          head :ok
         end
+      rescue NameError => e
+        Rails.logger.warn "Error attaching object: #{e.message}"
+      rescue ActiveRecord::RecordNotFound
+        head :not_found
       end
  
       private
-      def add_attachment
-        begin
-          @object = find_object
-          @object.send("#{attribute_name}=",active_record_blob)
-          if @object.save
-            head :ok
-          else
-            Rails.logger.warn "Error saving object: #{@object} #{object.errors.full_messages}"
-            head :unprocessable_entity
-          end
-        rescue NameError => e
-          Rails.logger.warn "Error attaching object: #{e.message}"
-          head :unprocessable_entity
-        end
-      end
        
       def verify_request_authenticity
         head :unauthorized if raw_post.blank?
@@ -37,22 +29,11 @@ module MobileWorkflow
         #head :unauthorized if raw_post.blank? || !message_verifier.authentic?(raw_post) # Not working
       end
   
-      def active_record_blob
-        s3_object = s3_bucket.object(object_key)
-        checksum_base64 = checksum_base64(object_key, s3_object)
-        ActiveStorage::Blob.create! key: s3_object.key, filename: s3_object.key, byte_size: s3_object.size, checksum: checksum_base64, content_type: s3_object.content_type
-      end
-  
-      def checksum_base64(object_key, s3_object)
-        path = Tempfile.new(object_key).path
-        s3_object.download_file(path)
-        file = File.new(path)
-        Digest::MD5.file(file).base64digest
-      end
-  
-      def find_object
-        object_class_name, object_id = key_identifiers
-        object_class_name.camelcase.constantize.find(object_id.to_i)
+      def object
+        @object ||= begin
+          object_class_name, object_id = key_identifiers
+          object_class_name.camelcase.constantize.find(object_id.to_i)
+        end
       end
   
       def attribute_name
@@ -91,11 +72,7 @@ module MobileWorkflow
         Rails.logger.warn(e.message)
         return false
       end
-  
-      def s3_bucket
-        Aws::S3::Resource.new(region: ENV['AWS_REGION'], access_key_id: ENV['AWS_ACCESS_ID'], secret_access_key: ENV['AWS_SECRET_KEY']).bucket(ENV['AWS_BUCKET_NAME'])
-      end
-  
+
       def sns_client
         Aws::SNS::Client.new(region: ENV['AWS_REGION'], access_key_id: ENV['AWS_ACCESS_ID'], secret_access_key: ENV['AWS_SECRET_KEY'])
       end

data/app/jobs/mobile_workflow/add_attachment_job.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module MobileWorkflow
+  class AddAttachmentJob < ApplicationJob
+    def perform(object, object_key, attribute_name)
+      object.send("#{attribute_name}=", active_record_blob_from_s3(object_key))
+      Rails.logger.warn "Error saving object: #{object} #{object.errors.full_messages}" unless object.save
+    rescue NoMethodError => e
+      Rails.logger.warn "Error attaching object: #{e.message}"
+    end
+
+    private
+
+    def active_record_blob_from_s3(object_key)
+      # etag cannot be used as the MD5 checksum when doing multi-part uploads
+      s3_object = s3_bucket.object(object_key)
+      base64_digest = hex_to_base64_digest(s3_object.etag.delete('"'))
+      ActiveStorage::Blob.create! key: s3_object.key, filename: s3_object.key, byte_size: s3_object.size,
+                                  checksum: base64_digest, content_type: s3_object.content_type
+    end
+
+    def s3_bucket
+      Aws::S3::Resource.new(region: ENV['AWS_REGION'], access_key_id: ENV['AWS_ACCESS_ID'], secret_access_key: ENV['AWS_SECRET_KEY']).bucket(ENV['AWS_BUCKET_NAME'])
+    end
+
+    def hex_to_base64_digest(hexdigest)
+      [[hexdigest].pack('H*')].pack('m0')
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module MobileWorkflow
+  module Attachable
+    extend ActiveSupport::Concern
+    include Rails.application.routes.url_helpers
+
+    def preview_url(attachment, options: { resize_to_fill: [200, 200] })
+      return nil unless attachment.attached?
+
+      if attachment.image?
+        rails_representation_url(attachment.variant(options), host: heroku_attachment_host)
+      elsif attachment.previewable?
+        rails_representation_url(attachment.preview(options), host: heroku_attachment_host)
+      else
+        return nil
+      end
+    end
+
+    def attachment_url(attachment)
+      return nil unless attachment.attached?
+    
+      rails_blob_url(attachment, host: heroku_attachment_host)
+    end
+
+    private
+
+    def heroku_attachment_host
+      # TODO: MBS - move this to a configuration property
+      app_name = Rails.env.test? ? 'test-app' : ENV.fetch('HEROKU_APP_NAME')
+      "https://#{app_name}.herokuapp.com"
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+module MobileWorkflow
+  module Displayable
+    module Steps
+      module Form
+        def mw_form_section(label:, identifier:)
+          raise 'Missing label' if label.nil?
+          raise 'Missing identifier' if identifier.nil?
+    
+          { item_type: :section, label: label, identifier: identifier }
+        end
+    
+        def mw_form_multiple_selection(label:, identifier:, multiple_selection_options:, selection_type: :single, optional: false, show_other_option: false)
+          raise 'Missing label' if label.nil?
+          raise 'Missing identifier' if identifier.nil?
+          raise 'Missing multiple selection options' if multiple_selection_options.nil?
+    
+          { item_type: :multiple_selection, label: label, identifier: identifier, multiple_selection_options: multiple_selection_options, selection_type: selection_type, optional: optional, show_other_option: show_other_option }
+        end
+    
+        def mw_form_multiple_selection_options(text:, hint: nil, is_pre_selected: false)
+          raise 'Missing text' if text.nil?
+    
+          { text: text, hint: hint, isPreSelected: is_pre_selected }
+        end
+    
+        def mw_form_number(label:, identifier:, placeholder: nil, optional: false, symbol_position: :leading, default_text_answer: nil, hint: nil)
+          raise 'Missing label' if label.nil?
+          raise 'Missing identifier' if identifier.nil?
+    
+          { item_type: :number, number_type: :number, label: label, identifier: identifier, placeholder: placeholder, optional: optional, symbol_position: symbol_position, default_text_answer: default_text_answer, hint: hint }
+        end
+    
+        def mw_form_text(label:, identifier:, placeholder: nil, optional: false, multiline: false, default_text_answer: nil)
+          raise 'Missing label' if label.nil?
+          raise 'Missing identifier' if identifier.nil?
+    
+          { item_type: :text, label: label, identifier: identifier, placeholder: placeholder, optional: optional, multiline: multiline, default_text_answer: default_text_answer }
+        end
+    
+        def mw_form_date(label:, identifier:, optional: false, default_date_time_answer: nil)
+          raise 'Missing label' if label.nil?
+          raise 'Missing identifier' if identifier.nil?
+    
+          { item_type: :date, date_type: :calendar, label: label, identifier: identifier, optional: optional, default_date_time_answer: default_date_time_answer }
+        end
+    
+        def mw_form_time(label:, identifier:, optional: false, default_date_time_answer: nil)
+          raise 'Missing label' if label.nil?
+          raise 'Missing identifier' if identifier.nil?
+    
+          { item_type: :time, label: label, identifier: identifier, optional: optional, default_date_time_answer: default_date_time_answer }
+        end
+    
+        def mw_form_email(label:, identifier:, placeholder: nil, optional: false, default_text_answer: nil)
+          raise 'Missing label' if label.nil?
+          raise 'Missing identifier' if identifier.nil?
+    
+          { item_type: :email, label: label, identifier: identifier, placeholder: placeholder, optional: optional, default_text_answer: default_text_answer }
+        end
+    
+        def mw_form_password(label:, identifier:, placeholder: nil, optional: false, default_text_answer: nil, hint: nil)
+          raise 'Missing label' if label.nil?
+          raise 'Missing identifier' if identifier.nil?
+    
+          { item_type: :secure, label: label, identifier: identifier, placeholder: placeholder, optional: optional, default_text_answer: default_text_answer, hint: hint }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module MobileWorkflow
+  module Displayable
+    module Steps
+      module List
+        def mw_list_item(id: self.id, text:, detail_text: nil, sf_symbol_name: nil, material_icon_name: nil, preview_url: nil)
+          { id: id, text: text, detailText: detail_text, sfSymbolName: sf_symbol_name, materialIconName: material_icon_name, imageURL: preview_url }.compact
+        end
+        
+        def mw_list_search_suggestion(id: self.id, text:, section_name:, sf_symbol_name: nil)
+          {id: id.to_s, text: text, sectionName: section_name, sfSymbolName: sf_symbol_name}.compact
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module MobileWorkflow
+  module Displayable
+    module Steps
+      module Map
+        def mw_map_item(id: self.id, text:, detail_text: nil, latitude:, longitude:)
+          {id: id.to_s, text: text, detailText: detail_text, latitude: latitude, longitude: longitude}.compact
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module MobileWorkflow
+  module Displayable
+    module Steps
+      module PieChart
+        def mw_pie_chart_item(id: self.id, label:, value:)
+          {id: id, label: label, value: value}.compact
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module MobileWorkflow
+  module Displayable
+    module Steps
+      module Question
+        QUESTION_STYLES = [:single_choice, :multiple_choice]
+        
+        def mw_text_choice_question(question:, style:, text_choices:)
+          raise 'Missing question' if question.empty?
+          raise 'Text Choices should be a hash' unless text_choices.is_a?(Hash)
+
+          validate_question_style!(style)
+          
+          text_choices_a = text_choices.map{|k, v| {_class: "ORKTextChoice", exclusive: false, text: k, value: v} }.to_a
+          { question: question, answerFormat: { _class: "ORKTextChoiceAnswerFormat", style: camelcase_converter(style.to_s, first_letter: :lower), textChoices: text_choices_a}}
+        end
+
+        private
+        
+        def validate_question_style!(style)
+          raise 'Unknown style' unless QUESTION_STYLES.include?(style)      
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+module MobileWorkflow
+  module Displayable
+    module Steps
+      module Stack
+        CONTENT_MODE_OPTIONS = [:scale_aspect_fill, :scale_aspect_fit] 
+
+        def mw_display_text(text:, label: nil)
+          {type: :text, label: label, text: text.to_s}.compact
+        end
+      
+        def mw_display_image(preview_url:, attachment_url:, content_mode: :scale_aspect_fill)
+          validate_content_mode!(content_mode)
+          
+          {type: :image, contentMode: camelcase_converter(content_mode.to_s, first_letter: :lower), previewURL: preview_url, url: attachment_url}
+        end
+        
+        def mw_display_unsplash_image(image_url)
+          if image_url.start_with? "https://unsplash.com/photos"
+            unsplash_id = image_url.split('/').last
+            image_url = "https://source.unsplash.com/#{unsplash_id}/800x600"
+          end
+          
+          {type: :image, previewURL: image_url, url: image_url}.compact
+        end
+        
+        def mw_display_video(preview_url:, attachment_url:)
+          {type: :video, previewURL: preview_url, url: attachment_url}
+        end
+      
+        def mw_display_button(label:, style: :primary, on_success: :forward, sf_symbol_name: nil, material_icon_name: nil)
+          validate_on_success!(on_success)
+          validate_button_style!(style)
+          
+          {type: :button, label: label, style: style, onSuccess: on_success, sfSymbolName: sf_symbol_name, materialIconName: material_icon_name}.compact
+        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, sfSymbolName: 'trash', materialIconName: 'delete'}.compact
+        end
+            
+        def mw_display_url_button(url:, label:, method: :put, style: :primary, confirm_title: nil, confirm_text: nil, on_success: :reload, sf_symbol_name: nil, material_icon_name: nil)
+          validate_on_success!(on_success)
+          validate_button_style!(style)
+          
+          {type: :button, label: label, url: url, method: method, style: style, confirmTitle: confirm_title, confirmText: confirm_text, onSuccess: on_success, sfSymbolName: sf_symbol_name, materialIconName: material_icon_name}.compact
+        end
+        alias_method :mw_display_button_for_url, :mw_display_url_button
+        
+        def mw_display_system_url_button(label:, apple_system_url: nil, android_deep_link: nil, style: :primary, sf_symbol_name: nil, material_icon_name: nil)
+          validate_button_style!(style)
+          raise 'Invalid android_deep_link' if android_deep_link && !android_deep_link.start_with?('http')
+          
+          {type: :button, label: label, appleSystemURL: apple_system_url, androidDeepLink: android_deep_link, style: style, sfSymbolName: sf_symbol_name, materialIconName: material_icon_name}.compact
+        end
+        alias_method :mw_display_button_for_system_url, :mw_display_system_url_button
+        
+        def mw_display_modal_workflow_button(label:, modal_workflow_name:, style: :primary, on_success: :none, sf_symbol_name: nil, material_icon_name: nil)
+          validate_on_success!(on_success)
+          validate_button_style!(style)
+          
+          {type: :button, label: label, modalWorkflow: modal_workflow_name, style: style, onSuccess: on_success, sfSymbolName: sf_symbol_name, materialIconName: material_icon_name}.compact
+        end
+        alias_method :mw_display_button_for_modal_workflow, :mw_display_modal_workflow_button
+
+        private
+        def validate_content_mode!(on_success)
+          raise 'Unknown content_mode' unless CONTENT_MODE_OPTIONS.include?(on_success)
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/mobile_workflow/displayable/steps/styled_content/grid.rb

@@ -0,0 +1,30 @@
+module MobileWorkflow
+  module Displayable
+    module Steps
+      module StyledContent
+        module Grid
+          def mw_grid_large_section(id:, text:)
+            raise 'Missing id' if id.nil?
+            raise 'Missing text' if text.nil?
+            
+            { id: id, text: text, type: :largeSection }
+          end
+          
+          def mw_grid_small_section(id:, text:)
+            raise 'Missing id' if id.nil?
+            raise 'Missing text' if text.nil?
+            
+            { id: id, text: text, type: :smallSection }
+          end
+          
+          def mw_grid_item(id: self.id, text:, detail_text: nil, preview_url: nil)
+            raise 'Missing id' if id.nil?
+            raise 'Missing text' if text.nil?
+            
+            { id: id, text: text, type: :item, detailText: detail_text, imageURL: preview_url }.compact
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/mobile_workflow/displayable/steps/styled_content/stack.rb

@@ -0,0 +1,40 @@
+module MobileWorkflow
+  module Displayable
+    module Steps
+      module StyledContent
+        module Stack
+          def mw_stack_title(id:, title:)
+            raise 'Missing id' if id.nil?
+            raise 'Missing title' if title.nil?
+        
+            { id: id, title: title, type: :title }
+          end
+        
+          def mw_stack_text(id:, text:)
+            raise 'Missing id' if id.nil?
+            raise 'Missing text' if text.nil?
+        
+            { id: id, text: text, type: :text }
+          end
+        
+          def mw_stack_list_item(id:, text:, detail_text: nil, preview_url: nil)
+            raise 'Missing id' if id.nil?
+            raise 'Missing text' if text.nil?
+        
+            { id: id.to_s, text: text, detailText: detail_text, type: :listItem, imageURL: preview_url }.compact
+          end
+        
+          def mw_stack_button(id:, label:, url: nil, method: :nil, on_success: :none, style: :primary, modal_workflow_name: nil, link_url: nil, sf_symbol_name: nil, apple_system_url: nil, android_deep_link: nil, confirm_title: nil, confirm_text: nil)
+            raise 'Missing id' if id.nil?
+            raise 'Missing label' if label.nil?
+        
+            validate_on_success!(on_success)
+            validate_button_style!(style)
+        
+            { id: id, type: :button, label: label, url: url, method: method, onSuccess: on_success, style: style, modalWorkflow: modal_workflow_name, linkURL: link_url, sfSymbolName: sf_symbol_name, appleSystemURL: apple_system_url, androidDeepLink: android_deep_link, confirmTitle: confirm_title, confirmText: confirm_text }.compact
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,163 +1,34 @@
 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]  
-    CONTENT_MODE_OPTIONS = [:scale_aspect_fill, :scale_aspect_fit] 
-    QUESTION_STYLES = [:single_choice, :multiple_choice] 
-    
-    def mw_list_item(id: self.id, text:, detail_text: nil, sf_symbol_name: nil, material_icon_name: nil, image_attachment: nil)
-      mw_list_item = {id: id, text: text, detailText: detail_text, sfSymbolName: sf_symbol_name, materialIconName: material_icon_name}
-      mw_list_item[:imageURL] = preview_url(image_attachment, options: { resize_to_fill: [200, 200] }) if image_attachment
-      mw_list_item.compact
-    end
-    
-    def mw_list_search_suggestion(id: self.id, text:, section_name:, sf_symbol_name: nil)
-      {id: id.to_s, text: text, sectionName: section_name, sfSymbolName: sf_symbol_name}.compact
-    end
-    
-    def mw_map_item(id: self.id, text:, detail_text: nil, latitude:, longitude:)
-      {id: id.to_s, text: text, detailText: detail_text, latitude: latitude, longitude: longitude}.compact
-    end
-    
-    def mw_pie_chart_item(id: self.id, label:, value:)
-      {id: id, label: label, value: value}.compact
-    end
-  
-    def mw_display_text(text:, label: nil)
-      {type: :text, label: label, text: text.to_s}.compact
-    end
-  
-    def mw_display_image(attachment, content_mode: :scale_aspect_fill, options: { resize_to_fill: [1200, 600] })
-      validate_content_mode!(content_mode)
-      
-      {type: :image, contentMode: content_mode.to_s.camelize(:lower), previewURL: preview_url(attachment, options: options), url: attachment_url(attachment)}
-    end
-    
-    def mw_display_unsplash_image(image_url)
-      if image_url.start_with? "https://unsplash.com/photos"
-        unsplash_id = image_url.split('/').last
-        image_url = "https://source.unsplash.com/#{unsplash_id}/800x600"
-      end
-      
-      {type: :image, previewURL: image_url, url: image_url}.compact
-    end
-    
-    def mw_display_video(attachment, preview_options: { resize_to_fill: [600, 1200] })
-      {type: :video, previewURL: preview_url(attachment, options: preview_options), url: attachment_url(attachment)}
-    end
-  
-    def mw_display_button(label:, style: :primary, on_success: :forward, sf_symbol_name: nil, material_icon_name: nil)
-      validate_on_success!(on_success)
-      validate_button_style!(style)
-      
-      {type: :button, label: label, style: style, onSuccess: on_success, sfSymbolName: sf_symbol_name, materialIconName: material_icon_name}.compact
-    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, sfSymbolName: 'trash', materialIconName: 'delete'}.compact
-    end
-        
-    def mw_display_url_button(label:, url:, method: :put, style: :primary, confirm_title: nil, confirm_text: nil, on_success: :reload, sf_symbol_name: nil, material_icon_name: nil)
-      validate_on_success!(on_success)
-      validate_button_style!(style)
-      
-      {type: :button, label: label, url: url, method: method, style: style, confirmTitle: confirm_title, confirmText: confirm_text, onSuccess: on_success, sfSymbolName: sf_symbol_name, materialIconName: material_icon_name}.compact
-    end
-    alias_method :mw_display_button_for_url, :mw_display_url_button
-    
-    def mw_display_system_url_button(label:, apple_system_url: nil, android_deep_link: nil, style: :primary, sf_symbol_name: nil, material_icon_name: nil)
-      validate_button_style!(style)
-      raise 'Invalid android_deep_link' if android_deep_link && !android_deep_link.start_with?('http')
-      
-      {type: :button, label: label, appleSystemURL: apple_system_url, androidDeepLink: android_deep_link, style: style, sfSymbolName: sf_symbol_name, materialIconName: material_icon_name}.compact
-    end
-    alias_method :mw_display_button_for_system_url, :mw_display_system_url_button
-    
-    def mw_display_modal_workflow_button(label:, modal_workflow_name:, style: :primary, on_success: :none, sf_symbol_name: nil, material_icon_name: nil)
-      validate_on_success!(on_success)
-      validate_button_style!(style)
-      
-      {type: :button, label: label, modalWorkflow: modal_workflow_name, style: style, onSuccess: on_success, sfSymbolName: sf_symbol_name, materialIconName: material_icon_name}.compact
-    end
-    alias_method :mw_display_button_for_modal_workflow, :mw_display_modal_workflow_button
-    
-    def mw_text_choice_question(question:, style:, text_choices:)
-      raise 'Missing question' if question.blank?
-      raise 'Text Choices should be a hash' unless text_choices.is_a?(Hash)
-      validate_question_style!(style)
-      
-      text_choices_a = text_choices.map{|k, v| {_class: "ORKTextChoice", exclusive: false, text: k, value: v} }.to_a
-      { question: question, answerFormat: { _class: "ORKTextChoiceAnswerFormat", style: style.to_s.camelize(:lower), textChoices: text_choices_a}}
-    end
-    
-    def mw_grid_large_section(id:, text:)
-      raise 'Missing id' if id.nil?
-      raise 'Missing text' if text.nil?
-      
-      { id: id, text: text, type: :largeSection }
-    end
-    
-    def mw_grid_small_section(id:, text:)
-      raise 'Missing id' if id.nil?
-      raise 'Missing text' if text.nil?
-      
-      { id: id, text: text, type: :smallSection }
+    def self.included(base)
+      base.extend(Steps::Form)
     end
+
+    include Steps::List
+    include Steps::Map
+    include Steps::PieChart
+    include Steps::Question
+    include Steps::Stack
+    include Steps::StyledContent::Grid
+    include Steps::StyledContent::Stack
+
+    BUTTON_STYLES = [:primary, :outline, :danger, :textOnly]
+    ON_SUCCESS_OPTIONS = [:none, :reload, :backward, :forward]
     
-    def mw_grid_item(id: self.id, text:, image_attachment: nil, options: { resize_to_fill: [1560, 877.5] })
-      raise 'Missing id' if id.nil?
-      raise 'Missing text' if text.nil?
-      
-      item = { id: id, text: text, type: :item }
-      item[:imageURL] = preview_url(image_attachment, options: options) if image_attachment
-      item
-    end
-  
     private
     def validate_on_success!(on_success)
       raise 'Unknown on_success action' unless ON_SUCCESS_OPTIONS.include?(on_success)
     end
     
-    def validate_content_mode!(on_success)
-      raise 'Unknown content_mode' unless CONTENT_MODE_OPTIONS.include?(on_success)
-    end
-    
     def validate_button_style!(style)
       raise 'Unknown style' unless BUTTON_STYLES.include?(style)      
     end
-    
-    def validate_question_style!(style)
-      raise 'Unknown style' unless QUESTION_STYLES.include?(style)      
-    end
-    
-    def preview_url(attachment, options:)
-      return nil unless attachment.attached?
-
-      if attachment.image?
-        Rails.application.routes.url_helpers.rails_representation_url(attachment.variant(options), host: heroku_attachment_host)
-      elsif attachment.previewable?
-        Rails.application.routes.url_helpers.rails_representation_url(attachment.preview(options), host: heroku_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: heroku_attachment_host)
-    end
+    def camelcase_converter(string, first_letter: :upper)
+      string = string.split("_").map(&:capitalize).join
+      return string unless first_letter == :lower
 
-    def heroku_attachment_host
-      # TODO: MBS - move this to a configuration property
-      app_name = Rails.env.test? ? 'test-app' : ENV.fetch('HEROKU_APP_NAME')
-      "https://#{app_name}.herokuapp.com"
+      string[0].downcase + string[1..-1]
     end
   end
 end

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

@@ -67,6 +67,18 @@ module MobileWorkflow
         end
       end
 
+      def generate_deserializers
+        say "Generating deserializers"
+
+        model_name_to_properties.each_pair do |model_name, properties|
+          @deserializer_class = model_name
+          @deserializer_properties = properties.split(' ').map { |attribute| attribute.split(':').first }
+
+          template("deserializer.rb.erb", "app/services/#{model_name}_deserializer.rb")
+          template("deserializer_spec.rb.erb", "spec/services/#{model_name}_deserializer_spec.rb")
+        end
+      end
+
       def generate_controllers_and_routes
         say "Generating controllers"
         controller_name_to_actions = open_api_spec.controller_name_to_actions

data/lib/generators/mobile_workflow/install/templates/app/models/application_record.rb

@@ -1,4 +1,5 @@
 class ApplicationRecord < ActiveRecord::Base
+  include MobileWorkflow::Attachable
   include MobileWorkflow::Displayable
   
   self.abstract_class = true

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

@@ -0,0 +1,13 @@
+class <%= @deserializer_class.capitalize %>Deserializer
+  def self.parse(params)
+  <% @deserializer_properties.each do |attribute| -%>
+  <%= attribute %> = params.dig(:payload, :<%= attribute %>)
+  <% end -%>
+
+    { <%= @deserializer_class %>: {
+    <% @deserializer_properties.each do |attribute| -%>
+    <%= attribute %>: <%= attribute %>,
+    <% end -%>
+    }.compact }
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+require 'json'
+
+RSpec.describe <%= @deserializer_class.capitalize %>Deserializer do
+  let(:params) { {} }
+
+  describe 'ok' do
+    let(:params) { { payload: payload } }
+    let(:parsed_params) { { <%= @deserializer_class %>: <%= @deserializer_class %>_params } }
+    let(:payload) {
+      {
+    <% @deserializer_properties.each do |attribute| -%>
+    <%= attribute %>: 'string',
+    <% end -%>
+    }
+    }
+    let(:<%= @deserializer_class %>_params) {
+      {
+    <% @deserializer_properties.each do |attribute| -%>
+    <%= attribute %>: 'string',
+    <% end -%>
+    }
+    }
+
+    it { expect(described_class.parse(params)).to eq parsed_params }
+  end
+end

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

@@ -1,4 +1,8 @@
 class User < ApplicationRecord
   has_secure_password
+
+  has_many :access_grants, class_name: 'Doorkeeper::AccessGrant', foreign_key: :resource_owner_id, dependent: :destroy
+  has_many :access_tokens, class_name: 'Doorkeeper::AccessToken', foreign_key: :resource_owner_id, dependent: :destroy
+
   validates :email, presence: true, uniqueness: true
 end

data/lib/generators/mobile_workflow/model_generator.rb

@@ -5,11 +5,18 @@ module MobileWorkflow
 
     class ModelGenerator < ActiveRecord::Generators::ModelGenerator
       source_root File.join(File.dirname(ActiveRecord::Generators::ModelGenerator.instance_method(:create_migration_file).source_location.first), "templates")
-      
+
+      class_option :doorkeeper_oauth, type: :boolean, default: false
+
       def create_model_file
         template File.join(File.dirname(__FILE__), "templates", "model.rb.erb"), File.join('app/models', class_path, "#{file_name}.rb")
       end
-      
+
+      private
+
+      def doorkeeper_oauth?
+        options[:doorkeeper_oauth]
+      end
     end
   end
 end

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

@@ -41,11 +41,13 @@ class <%= controller_class_name %>Controller < ApiController
     # passport_id = params.dig(:payload, :choose_passport, :selected, :id)
 
     Rails.logger.debug "Pre-rewrite params: #{params}"
-    # Do your rewriting here
+
+    parsed_params = <%= controller_class_name.singularize %>Deserializer.parse(params)
+    params.merge!(parsed_params)
   end
 
   def <%= singular_table_name.underscore %>_params
-    params.require(:payload).permit(<%= permitted_params %>)
+    params.require(:<%= singular_table_name %>).permit(<%= permitted_params %>)
   end
 <% end -%>
 end

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

@@ -8,18 +8,33 @@ class <%= class_name %> < <%= parent_class_name.classify %>
 <% end -%>
 <% attributes.select(&:attachments?).each do |attribute| -%>
   has_many_attached :<%= attribute.name %>
+<% end -%>
+<% if class_name == 'User' -%>
+<% if doorkeeper_oauth? -%>
+  has_many :access_grants, class_name: 'Doorkeeper::AccessGrant', foreign_key: :resource_owner_id, dependent: :destroy
+  has_many :access_tokens, class_name: 'Doorkeeper::AccessToken', foreign_key: :resource_owner_id, dependent: :destroy
+<% end -%>
+<% attributes.each do |attribute| -%>
+<% if attribute.name == 'email' -%>
+  validates :email, presence: true, uniqueness: { case_sensitive: false }
+  before_validation :downcase_email, if: :email_changed?
+
+  def downcase_email
+    self.email = email.downcase
+  end
+<% end -%>
+<% end -%>
 <% end -%>
 
   def list_item_as_json
     mw_list_item(text: <%= attributes.first.name %>)
   end
-  
+
   def display_as_json
     [
       mw_display_text(label: 'ID', text: id.to_s),
       mw_display_text(label: 'Text', text: <%= attributes.first.name %>)
     ]
   end
-
 end
 <% end -%>

data/lib/mobile_workflow/displayable.rb

@@ -0,0 +1,9 @@
+require_relative '../../app/models/concerns/mobile_workflow/displayable/steps/styled_content/grid.rb'
+require_relative '../../app/models/concerns/mobile_workflow/displayable/steps/styled_content/stack.rb'
+require_relative '../../app/models/concerns/mobile_workflow/displayable/steps/form.rb'
+require_relative '../../app/models/concerns/mobile_workflow/displayable/steps/list.rb'
+require_relative '../../app/models/concerns/mobile_workflow/displayable/steps/map.rb'
+require_relative '../../app/models/concerns/mobile_workflow/displayable/steps/pie_chart.rb'
+require_relative '../../app/models/concerns/mobile_workflow/displayable/steps/question.rb'
+require_relative '../../app/models/concerns/mobile_workflow/displayable/steps/stack.rb'
+require_relative '../../app/models/concerns/mobile_workflow/displayable.rb'

data/lib/mobile_workflow/engine.rb

@@ -1,9 +1,11 @@
 module MobileWorkflow
-  class Engine < ::Rails::Engine
-    isolate_namespace MobileWorkflow
-    
-    config.generators do |g|
-      g.test_framework :rspec
+  if defined?(Rails)
+    class Engine < ::Rails::Engine
+      isolate_namespace MobileWorkflow
+      
+      config.generators do |g|
+        g.test_framework :rspec
+      end
     end
   end
 end

data/lib/mobile_workflow/version.rb

@@ -1,5 +1,5 @@
 module MobileWorkflow
-  VERSION = '0.7.6'
+  VERSION = '0.7.7'
   RUBY_VERSION = '2.7.3'
   RAILS_VERSION = '6.1.3.1'
 end

data/lib/mobile_workflow.rb

@@ -1,4 +1,5 @@
 require "mobile_workflow/engine"
+require "mobile_workflow/displayable"
 
 module MobileWorkflow
   require 'mobile_workflow/railtie' if defined?(Rails)

metadata

@@ -1,15 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: mobile_workflow
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.7.7
 platform: ruby
 authors:
 - Matt Brooke-Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-02 00:00:00.000000000 Z
+date: 2021-10-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.60.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.60.1
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-sns
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -97,9 +131,19 @@ files:
 - 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/add_attachment_job.rb
 - app/jobs/mobile_workflow/application_job.rb
 - app/mailers/mobile_workflow/application_mailer.rb
+- app/models/concerns/mobile_workflow/attachable.rb
 - app/models/concerns/mobile_workflow/displayable.rb
+- app/models/concerns/mobile_workflow/displayable/steps/form.rb
+- app/models/concerns/mobile_workflow/displayable/steps/list.rb
+- app/models/concerns/mobile_workflow/displayable/steps/map.rb
+- app/models/concerns/mobile_workflow/displayable/steps/pie_chart.rb
+- app/models/concerns/mobile_workflow/displayable/steps/question.rb
+- app/models/concerns/mobile_workflow/displayable/steps/stack.rb
+- app/models/concerns/mobile_workflow/displayable/steps/styled_content/grid.rb
+- app/models/concerns/mobile_workflow/displayable/steps/styled_content/stack.rb
 - app/views/layouts/mobile_workflow/application.html.erb
 - bin/mwf
 - config/routes.rb
@@ -116,6 +160,8 @@ files:
 - lib/generators/mobile_workflow/install/templates/app/views/layouts/application.html.erb
 - lib/generators/mobile_workflow/install/templates/app/views/sessions/new.html.erb
 - lib/generators/mobile_workflow/install/templates/create_users.rb
+- lib/generators/mobile_workflow/install/templates/deserializer.rb.erb
+- lib/generators/mobile_workflow/install/templates/deserializer_spec.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/spec/factories/users.rb
@@ -133,6 +179,7 @@ files:
 - lib/mobile_workflow/cli/aws_backend.rb
 - lib/mobile_workflow/cli/dokku_backend.rb
 - lib/mobile_workflow/cli/heroku_backend.rb
+- lib/mobile_workflow/displayable.rb
 - lib/mobile_workflow/engine.rb
 - lib/mobile_workflow/open_api_spec/parser.rb
 - lib/mobile_workflow/railtie.rb