mobile_workflow 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '068f070743f72d5743182cd41021c33b89579ecef7182a5747c799393a1d4208'
+  data.tar.gz: 41aef887eb318cf98736112ce4aad51835af98f1d20e0d75f7810c9014f4c5e4
+SHA512:
+  metadata.gz: 90ad8d639c45ff2c757a933199022a1fad59d649c815211425366c45d72a9596e516fe382835b7ffca76f1dc7bdbc85b14d35b65b723dcd751750ff10195803d
+  data.tar.gz: 8adcf9c22591e5644b484c0216a9f8d157222078f8ed37cebcdc9333560c30294f018e06cdfc26c8d3a27bfe9f7016346658ff4fe83a215d162f2a0946dbcaa6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Matt Brooke-Smith
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# MobileWorkflow
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mobile_workflow'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install mobile_workflow
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,22 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MobileWorkflow'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/assets/config/mobile_workflow_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/mobile_workflow .css

data/app/assets/stylesheets/mobile_workflow/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

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

@@ -0,0 +1,35 @@
+module MobileWorkflow
+  module S3Storable
+    if Object.const_defined?("Aws::S3")
+      extend ActiveSupport::Concern
+      
+      def binary_urls(object)
+        return unless params["binaries"]
+    
+        params["binaries"].collect do |binary|
+          property = binary["identifier"].split('/')[0] # i.e. image/jpg --> image, video/mp4 --> video
+      
+          {
+            "identifier" => binary["identifier"],
+            "url" => presigned_url("#{object.class.name.underscore}/#{object.id}/#{property}"),
+            "method" => "PUT"
+          }
+        end
+      end
+  
+      private
+      def presigned_url(key)
+        presigner.presigned_url(:put_object, bucket: ENV['AWS_BUCKET_NAME'], key: key, metadata: {})
+      end
+  
+      def presigner
+        Aws::S3::Presigner.new(client: s3_client)
+      end
+  
+      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

@@ -0,0 +1,97 @@
+module MobileWorkflow
+  class SnsNotificationsController < ApiController
+    if Object.const_defined?("Aws::S3") && Object.const_defined?("Aws::SNS")
+      before_action :verify_request_authenticity
+ 
+      def create
+        Rails.logger.info("Message body: #{message_body}")
+    
+        case message_body['Type']
+        when 'SubscriptionConfirmation'
+          confirm_subscription ? (head :ok) : (head :bad_request)
+        else
+          @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}"
+          end
+        end
+      end
+ 
+      private 
+      def verify_request_authenticity
+        head :unauthorized if raw_post.blank?
+    
+        #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)
+      end
+  
+      def attribute_name
+        key_identifiers[2]
+      end
+  
+      def key_identifiers
+        object_class_name, object_id, attribute_name = object_key.split("/")
+        return object_class_name, object_id, attribute_name
+      end
+  
+      def object_key
+        @object_key ||= message['Records'][0]['s3']['object']['key']
+      end
+  
+      def message
+        message = JSON.parse(message_body['Message'])
+      end
+ 
+      def message_body
+        @message_body ||= JSON.parse(raw_post)
+      end
+  
+      def raw_post
+        @raw_post ||= request.raw_post
+      end
+ 
+      def message_verifier
+        @message_verifier ||= Aws::SNS::MessageVerifier.new
+      end
+ 
+      def confirm_subscription
+        sns_client.confirm_subscription(
+          topic_arn: message_body['TopicArn'],
+          token: message_body['Token']
+        )
+        return true
+      rescue Aws::SNS::Errors::ServiceError => e
+        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
+    end
+  end  
+end

data/app/helpers/mobile_workflow/application_helper.rb

@@ -0,0 +1,4 @@
+module MobileWorkflow
+  module ApplicationHelper
+  end
+end

data/app/jobs/mobile_workflow/application_job.rb

@@ -0,0 +1,4 @@
+module MobileWorkflow
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/mobile_workflow/application_mailer.rb

@@ -0,0 +1,6 @@
+module MobileWorkflow
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/mobile_workflow/application_record.rb

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

data/app/views/layouts/mobile_workflow/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Mobile workflow</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "mobile_workflow/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+MobileWorkflow::Engine.routes.draw do
+end

data/lib/generators/mobile_workflow/controller_generator.rb

@@ -0,0 +1,32 @@
+module MobileWorkflow
+  module Generators
+    # Custom scaffolding generator
+    # https://github.com/rails/rails/blob/master/railties/lib/rails/generators/rails/scaffold_controller/scaffold_controller_generator.rb
+    class ControllerGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::ResourceHelpers
+      source_root File.expand_path("../templates", __FILE__)
+      
+      class_option :attributes, type: :array, default: [], banner: "field:type field:type"
+      class_option :actions, type: :array, default: [], banner: "index create update destroy"
+      
+      def copy_controller_and_spec_files
+        template "controller.rb.erb", File.join("app/controllers", controller_class_path, "#{controller_file_name}_controller.rb")
+        template "controller_spec.rb.erb", File.join("spec/controllers", controller_class_path, "#{controller_file_name}_controller_spec.rb")
+      end
+      
+      private  
+      def attributes_names
+        options[:attributes].map{ |attribute| attribute.split(":").first }
+      end
+          
+      def permitted_params
+        params = attributes_names.map{ |name| ":#{name}" }
+        params.join(", ")
+      end
+      
+      def rewrite_params
+        attributes_names.map {|name| "params[:#{singular_table_name}][:#{name}] = params[:payload][:#{name}][:answer]" }.join("\n\t\t")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+require "rails/generators/base"
+
+module MobileWorkflow
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      class_option :open_api_spec_path, type: :string, default: "config/open_api_spec.json"
+
+      def create_api_controller
+        template(
+          "api_controller.rb.erb",
+          "app/controllers/api_controller.rb",
+        )
+      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
+        
+          model_name = model_name.underscore
+          model_properties = model_properties(model_name, schema)
+          generate(:model, "#{model_name} #{model_properties}")
+          @model_properties[model_name] = model_properties
+        end
+      end
+
+      def generate_controllers_and_routes
+        say "Generating controllers"
+        controller_names = open_api_spec[:paths].keys.collect{|url_path| url_path.split('/').last }
+      
+        route "root to: 'admin/#{controller_names.first}#index'"
+        
+        controller_names.each do |plural_controller_name|
+          controller_name = plural_controller_name.singularize
+          model_properties = @model_properties[controller_name]
+          generate "mobile_workflow:controller #{controller_name} --attributes #{model_properties}"
+          route "resources :#{plural_controller_name}, only: [:index, :show, :create]"
+        end
+      end
+
+      private
+      def open_api_spec
+        @open_api_spec ||= read_openapi_spec
+      end
+      
+      def read_openapi_spec
+        say "Loading OpenAPI Spec: #{open_api_spec_path}" 
+        return JSON.parse(File.read(open_api_spec_path)).with_indifferent_access 
+      end
+      
+      def open_api_spec_path
+        options[:open_api_spec_path]
+      end
+      
+      def model_properties(name, schema)
+        generated_properties_args = schema["properties"].keys.collect{|key| "#{key}:string" }.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
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+class ApiController < ActionController::API
+  def current_user
+    nil
+  end
+end

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

@@ -0,0 +1,41 @@
+<% module_namespacing do -%>
+class <%= controller_class_name %>Controller < ApiController
+  before_action :rewrite_payload, only: :create
+
+  load_and_authorize_resource
+
+  def index
+    render json: @<%= plural_table_name %>.collect(&:list_item_as_json)
+  end
+
+  def show
+    render json: @<%= singular_table_name %>.display_as_json
+  end
+
+  def create
+    if @<%= singular_table_name %>.save
+      render json: { binary_urls: binary_urls(@<%= singular_table_name %>), response: @<%= singular_table_name %> }, status: :created
+    else
+      head :unprocessable_entity 
+    end
+  end
+
+  private
+  def rewrite_payload
+    # Use this method to make any changes to params to make them compatible with ActiveRecord
+  
+    # 1. Example to get properties from question
+    # params[:payload][:name] = params.dig(:payload, :name, :answer)
+  
+    # 2. Example to get selected id from a list
+    # passport_id = params.dig(:payload, :choose_passport, :selected, :id)
+
+    Rails.logger.debug "Pre-rewrite params: #{params}"
+    <%= rewrite_params %> 
+  end
+
+  def <%= singular_table_name.underscore %>_params
+    params.require(:<%= singular_table_name %>).permit(<%= permitted_params %>)
+  end
+end
+<% end %>

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+require 'json'
+
+RSpec.describe <%= controller_class_name %>Controller do
+  let(:params) { {} }
+  let(:json_response) { JSON.parse(response.body, symbolize_names: true) }
+  
+  describe 'GET #index' do
+    let!(:<%= controller_class_name.singularize.underscore %>) { <%= controller_class_name.singularize %>.create }
+    before(:each) { get :index, params: params }
+    
+    context 'ok' do
+      it { expect(json_response[0][:id]).to eq <%= controller_class_name.singularize.underscore %>.id }               
+      it { expect(response.status).to eq 200 }
+    end
+  end
+  
+  describe 'GET #show' do
+    let(:<%= controller_class_name.singularize.underscore %>) { <%= controller_class_name.singularize %>.create }
+    let(:params) { { id: <%= controller_class_name.singularize.underscore %>.id } }
+    before(:each) { get :show, params: params }
+    
+    context 'ok' do                
+      it { expect(response.status).to eq 200 }
+    end
+  end
+  
+  describe 'POST #create' do
+    let(:payload_params) { {text: 'OK'} }
+    let(:params) { { payload: payload_params, binaries: [{identifier: 'record', mimetype: 'video/mp4'}] } }
+    before(:each) { post :create, params: params }
+    
+    context 'ok' do
+      it { expect(<%= controller_class_name.singularize %>.count).to eq 1 }          
+      it { expect(response.status).to eq 201 }
+      it { expect(json_response[:binary_urls]).to_not be_nil }
+    end
+  end
+end

data/lib/mobile_workflow.rb

@@ -0,0 +1,5 @@
+require "mobile_workflow/engine"
+
+module MobileWorkflow
+  # Your code goes here...
+end

data/lib/mobile_workflow/engine.rb

@@ -0,0 +1,9 @@
+module MobileWorkflow
+  class Engine < ::Rails::Engine
+    isolate_namespace MobileWorkflow
+    
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/mobile_workflow/version.rb

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

data/lib/tasks/mobile_workflow_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :mobile_workflow do
+#   # Task goes here
+# end

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

@@ -0,0 +1,56 @@
+<% module_namespacing do -%>
+class <%= class_name %> < <%= parent_class_name.classify %>
+  # Enable if you need to generate attachment URLs
+  # include Rails.application.routes.url_helpers
+  
+<% attributes.select(&:reference?).each do |attribute| -%>
+  belongs_to :<%= attribute.name %><%= ', polymorphic: true' if attribute.polymorphic? %>
+<% end -%>
+<% attributes.select(&:attachment?).each do |attribute| -%>
+  has_one_attached :<%= attribute.name %>
+<% end -%>
+<% attributes.select(&:attachments?).each do |attribute| -%>
+  has_many_attached :<%= attribute.name %>
+<% end -%>
+
+  def list_item_as_json
+    {
+      id: id,
+      text: text,
+      # detailText: nil,
+      # sfSymbolName: nil,
+      # imageURL: preview_url(image, height: 100, width: 100)
+    }
+  end
+  
+  def display_as_json
+    [
+      {label: "ID", text: text, mimeType: 'text/plain'},
+      {label: "Text", text: text, mimeType: 'text/plain'}
+    ]
+  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

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: mobile_workflow
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Brooke-Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.2
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: rspec-rails
+  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: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/mobile_workflow_manifest.js
+- app/assets/stylesheets/mobile_workflow/application.css
+- 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/views/layouts/mobile_workflow/application.html.erb
+- config/routes.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/templates/controller.rb.erb
+- lib/generators/mobile_workflow/templates/controller_spec.rb.erb
+- lib/mobile_workflow.rb
+- lib/mobile_workflow/engine.rb
+- lib/mobile_workflow/version.rb
+- lib/tasks/mobile_workflow_tasks.rake
+- lib/templates/active_record/model/model.rb.erb
+homepage: https://github.com/futureworkshops/mobile_workflow
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: A Rails engine to provide API support for Mobile Workflow Apps.
+test_files: []