mobile_workflow 0.1.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '068f070743f72d5743182cd41021c33b89579ecef7182a5747c799393a1d4208'
-  data.tar.gz: 41aef887eb318cf98736112ce4aad51835af98f1d20e0d75f7810c9014f4c5e4
+  metadata.gz: a1d55314927070ee5d1b4498b99b760952214839e146ae0e271bc2ff49a1fce9
+  data.tar.gz: e666ed9c786f10335e1d30505a4f62059636034821d3e4e2d17d532929bfee93
 SHA512:
-  metadata.gz: 90ad8d639c45ff2c757a933199022a1fad59d649c815211425366c45d72a9596e516fe382835b7ffca76f1dc7bdbc85b14d35b65b723dcd751750ff10195803d
-  data.tar.gz: 8adcf9c22591e5644b484c0216a9f8d157222078f8ed37cebcdc9333560c30294f018e06cdfc26c8d3a27bfe9f7016346658ff4fe83a215d162f2a0946dbcaa6
+  metadata.gz: 80da58aa822183db3273fd34e89b9563040349bc17b60f8817f467f59561e2d7e1684ecaa48b85f88e3993ac7819538fb0515b0aeaddf513727f3f033117b5be
+  data.tar.gz: 6ad8369700ca16b92de687238fabad59f9bd695c9b8941d85beae13edd38d338a658edc5e5085439c3944d63f855f5ae3078ed4cd17467283dd121b7d4b8e848

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,95 @@
+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: 600, width: 1200), 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}
+    end
+    
+    def mw_display_video(attachment)
+      {type: :video, previewURL: preview_url(attachment, height: 600, width: 1200), 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_name:, style: :primary, on_success: :none)
+      validate_on_success!(on_success)
+      validate_button_style!(style)
+      
+      {type: :button, label: label, modalWorkflow: modal_workflow_name, 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/bin/mwf

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+require_relative '../lib/mobile_workflow/cli'
+
+# Byebug for dev
+begin
+  require 'byebug'
+rescue LoadError
+end
+
+if ARGV.empty?
+  puts "USAGE: mwf <platform> <command> [options]"
+  puts "Example: mwf rails create:app_server --help"
+  puts "Example: mwf rails destroy:app_server --help"
+  exit 0
+elsif ['-v', '--version'].include? ARGV[0]
+  puts MobileWorkflow::VERSION
+  exit 0
+elsif 'rails' == ARGV[0] && 'create:app_server' == ARGV[1]
+  ARGV.shift
+  ARGV.shift
+  
+  templates_root = File.expand_path(File.join("..", "lib", "generators", "mobile_workflow", "install", "templates"), File.dirname(__FILE__))
+  MobileWorkflow::Cli::AppServerGenerator.source_root templates_root
+  MobileWorkflow::Cli::AppServerGenerator.source_paths << Rails::Generators::AppGenerator.source_root << templates_root
+  MobileWorkflow::Cli::AppServerGenerator.start
+elsif 'rails' == ARGV[0] && 'destroy:app_server' == ARGV[1]
+  ARGV.shift
+  ARGV.shift
+  
+  ARGV.unshift(MobileWorkflow::Cli::AppServerCleaner.default_task) unless ARGV[0] == '--help'
+  MobileWorkflow::Cli::AppServerCleaner.start(ARGV)
+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

@@ -23,10 +23,6 @@ module MobileWorkflow
         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

@@ -3,22 +3,42 @@ 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 = ["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
+      class_option :interactive, 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)
@@ -29,8 +49,6 @@ module MobileWorkflow
 
       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|
@@ -40,29 +58,52 @@ module MobileWorkflow
           route "resources :#{plural_controller_name}, only: [:index, :show, :create]"
         end
       end
+      
+      def generate_seeds
+        template("seeds.rb.erb", "db/seeds.rb", force: true)
+      end
 
       private
+      def controller_names
+        @controller_names ||= oai_spec_paths.collect{|url_path| url_path.split('/')[1] }.uniq
+      end
+      
+      def oai_spec_paths
+        @oai_spec_paths ||= open_api_spec[:paths].keys
+      end
+      
       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 
+        return JSON.parse(File.read(File.join(Rails.root, open_api_spec_path))).with_indifferent_access 
       end
       
       def open_api_spec_path
         options[:open_api_spec_path]
       end
       
+      def interactive?
+        options[:interactive]
+      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 = schema["properties"].keys.collect{|key| "#{key}:#{model_property_type(schema["properties"][key])}" }.join(" ")
+        if !interactive? || 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)
+        return property["type"] unless property["type"].blank?
+        return 'attachment' if property['$ref'] == "#/components/schemas/attachment"
+        
+        raise 'Unknown property type'
+      end
     end
   end
 end

data/lib/generators/mobile_workflow/install/templates/Gemfile.erb

@@ -0,0 +1,50 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby '2.6.6'
+
+# Core Gems
+gem 'rails', '~> 6.1.0'
+gem 'puma', '~> 5.0'
+gem 'sass-rails', '>= 6'
+gem 'turbolinks', '~> 5'
+
+# Mobile Workflow
+#gem 'mobile_workflow', path: '../mobile_workflow'
+gem 'mobile_workflow', github: 'FutureWorkshops/mobile_workflow'
+
+# Authorisation / Authentication
+<%- if options[:doorkeeper_oauth] %>
+gem 'doorkeeper'
+gem 'bcrypt-ruby'
+<%- end %>
+gem 'cancancan', '~> 3.1'
+
+# Admin console
+gem 'administrate', '~> 0.13.0'
+gem 'administrate-field-active_storage'
+gem 'administrate-field-enum'
+
+<%- if options[:s3_storage] %>
+# Backend storage for S3
+gem "image_processing"
+gem 'aws-sdk-s3', '~> 1.60', '>= 1.60.1'
+gem 'aws-sdk-sns', '~> 1.23'
+<%- end %>
+
+group :development do
+  gem 'web-console', '>= 3.3.0'
+  gem 'listen', '>= 3.0.5', '< 3.2'
+end
+
+group :development, :test do
+  gem 'sqlite3'
+  gem 'rspec-rails', '~> 4.0.0'
+  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+  gem 'dotenv-rails'
+  gem 'factory_bot_rails'
+end
+
+group :production do
+  gem 'pg', '>= 0.18', '< 2.0'
+end

data/lib/generators/mobile_workflow/install/templates/Procfile

@@ -0,0 +1,2 @@
+web: bundle exec rackup config.ru -p $PORT
+release: bundle exec rake db:migrate

data/lib/generators/mobile_workflow/install/templates/Procfile.dev

@@ -0,0 +1 @@
+web: bundle exec rackup config.ru -p $PORT

data/lib/generators/mobile_workflow/install/templates/README.md.erb

@@ -0,0 +1,22 @@
+# <%= app_name.humanize %>
+
+## Prereqs
+* Ruby >= 2.5.5
+* Rails >= 6.0.0
+
+Optional
+* Heroku toolbelt
+* Heroku account
+
+## Getting Started
+
+After you have cloned this repo, run this setup script to set up your machine
+with the necessary dependencies to run and test this app:
+
+    % ./bin/setup
+
+After setting up, you can run the application using [Heroku Local]:
+
+    % heroku local
+
+[Heroku Local]: https://devcenter.heroku.com/articles/heroku-local

data/lib/generators/mobile_workflow/install/templates/ability.rb

@@ -0,0 +1,7 @@
+class Ability
+  include CanCan::Ability
+
+  def initialize(user)
+    can :manage, :all
+  end
+end

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

@@ -1,5 +1,24 @@
 class ApiController < ActionController::API
+  rescue_from CanCan::AccessDenied do |exception|
+    Rails.logger.debug "Access denied on #{exception.action} #{exception.subject.inspect}"
+    head :forbidden
+  end
+
+  <% 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&.accessible?
+  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/storage.s3.yml

@@ -0,0 +1,14 @@
+test:
+  service: Disk
+  root: <%= Rails.root.join("tmp/storage") %>
+
+local:
+  service: Disk
+  root: <%= Rails.root.join("storage") %>
+
+amazon:
+  service: S3
+  access_key_id: <%= ENV['AWS_ACCESS_ID'] %>
+  secret_access_key: <%= ENV['AWS_SECRET_KEY'] %>
+  region: <%= ENV['AWS_REGION'] %>
+  bucket: <%= ENV['AWS_BUCKET_NAME'] %>

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
@@ -23,19 +24,16 @@ class <%= controller_class_name %>Controller < ApiController
   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
+    
+    # 1. 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 %> 
+    # Do your rewriting here
   end
 
   def <%= singular_table_name.underscore %>_params
-    params.require(:<%= singular_table_name %>).permit(<%= permitted_params %>)
+    params.require(:payload).permit(<%= permitted_params %>)
   end
 end
 <% end %>

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

@@ -8,7 +8,7 @@ RSpec.describe <%= controller_class_name %>Controller do
   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 }
+    let!(:<%= controller_class_name.singularize.underscore %>) { create(:<%= controller_class_name.singularize.underscore %>) }
     before(:each) { get :index, params: params }
     
     context 'ok' do
@@ -18,7 +18,7 @@ RSpec.describe <%= controller_class_name %>Controller do
   end
   
   describe 'GET #show' do
-    let(:<%= controller_class_name.singularize.underscore %>) { <%= controller_class_name.singularize %>.create }
+    let(:<%= controller_class_name.singularize.underscore %>) { create(:<%= controller_class_name.singularize.underscore %>) }
     let(:params) { { id: <%= controller_class_name.singularize.underscore %>.id } }
     before(:each) { get :show, params: params }
     

data/lib/mobile_workflow/cli.rb

@@ -0,0 +1,9 @@
+require "mobile_workflow/version"
+
+require "mobile_workflow/cli/app_server_generator"
+require "mobile_workflow/cli/app_builder"
+require "mobile_workflow/cli/app_server_cleaner"
+
+require "mobile_workflow/cli/aws_backend"
+require "mobile_workflow/cli/heroku_backend"
+require "mobile_workflow/cli/dokku_backend"

data/lib/mobile_workflow/cli/app_builder.rb

@@ -0,0 +1,84 @@
+module MobileWorkflow::Cli
+  class AppBuilder < Rails::AppBuilder
+    def readme
+      template 'README.md.erb', 'README.md'
+    end
+    
+    def gemfile
+      template 'Gemfile.erb', 'Gemfile'
+    end
+    
+    def procfiles
+      copy_file 'Procfile', 'Procfile'
+      copy_file 'Procfile.dev', 'Procfile.dev'
+    end
+    
+    def rspec_generator
+      generate 'rspec:install'
+    end
+    
+    def ability_generator
+      copy_file 'ability.rb', 'app/models/ability.rb'
+    end
+    
+    def active_storage
+      rails_command 'active_storage:install'
+      copy_file 'storage.s3.yml', 'config/storage.yml'
+      gsub_file 'config/environments/production.rb', 'config.active_storage.service = :local', 'config.active_storage.service = :amazon'  
+    end
+    
+    def mobile_workflow_generator(open_api_spec_path)
+      copy_file open_api_spec_path, 'config/open_api_spec.json'
+      gen_opts = ""
+      gen_opts += "--doorkeeper_oauth" if options[:doorkeeper_oauth]
+      generate "mobile_workflow:install #{gen_opts}"
+      
+      # Copy user migrations if needed
+      rails_command 'mobile_workflow:install:migrations' if options[:doorkeeper_oauth]
+    end
+    
+    def s3_backend(region)
+      @region = region
+      aws_backend.create
+      aws_backend.write_env
+      
+      if options[:heroku]
+        heroku_backend.sync_dotenv
+        sleep 10 # Wait for the server to restart
+        aws_backend.create_topic_subscription(heroku_backend.notifications_endpoint)
+      elsif options[:dokku]
+        dokku_backend.sync_dotenv 
+        aws_backend.create_topic_subscription(dokku_backend.notifications_endpoint)      
+      end
+      
+    end
+    
+    def heroku
+      heroku_backend.create
+      heroku_backend.configure_activestorage if options[:s3_storage]
+      heroku_backend.deploy
+      heroku_backend.sync_dotenv
+    end
+    
+    def dokku(dokku_host)
+      @dokku_host = dokku_host
+      dokku_backend.create
+      dokku_backend.configure_activestorage if options[:s3_storage]
+      dokku_backend.deploy
+      dokku_backend.sync_dotenv
+    end
+    
+    private
+    def aws_backend
+      @aws_backend ||= AwsBackend.new(app_name: app_name, region: @region)
+    end
+    
+    def dokku_backend
+      @dokku_backend ||= DokkuBackend.new(app_name: app_name, dokku_host: @dokku_host)
+    end
+    
+    def heroku_backend
+      @heroku_backend ||= HerokuBackend.new(app_name: app_name)
+    end
+  end
+end

data/lib/mobile_workflow/cli/app_server_cleaner.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+require 'json'
+require 'active_support/core_ext/hash/indifferent_access'
+
+module MobileWorkflow::Cli
+  class AppServerCleaner < Thor    
+    class_option :version, type: :boolean, aliases: "-v", desc: "Show version number and quit"
+    class_option :help, type: :boolean, aliases: '-h', desc: "Show this help message and quit"
+    
+    class_option :heroku, type: :boolean, default: false, desc: "Clean Heroku app"
+    class_option :s3_storage, type: :boolean, default: false, desc: "Clean an s3 backend for attachment upload and storage"
+    class_option :aws_region, type: :string, default: 'us-east-1', desc: "Specify a region to create AWS resources in"
+
+    default_task :clean
+
+    desc "rails destroy:app_server APP_NAME", "Destroy App server"
+    def clean(app_name)
+      `rm -rf #{app_name}`
+      AwsBackend.new(app_name: app_name, region: options[:aws_region]).destroy if options[:s3_storage]
+      HerokuBackend.new(app_name: app_name).destroy if options[:heroku]
+    end
+  end
+end

data/lib/mobile_workflow/cli/app_server_generator.rb

@@ -0,0 +1,98 @@
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+require 'json'
+require 'active_support/core_ext/hash/indifferent_access'
+
+module MobileWorkflow::Cli
+  class AppServerGenerator < Rails::Generators::AppGenerator
+    hide!    
+    class_option :skip_test, type: :boolean, default: true, desc: "Skip Test Unit"
+    class_option :force, type: :boolean, default: true, desc: "Force overwrite"
+    class_option :skip_webpack_install, type: :boolean, default: true, desc: "Skip webpacker installation"
+    class_option :skip_bootsnap, type: :boolean, default: true, desc: "Skip Bootsnap"
+    
+    class_option :version, type: :boolean, aliases: "-v", desc: "Show version number and quit"
+    class_option :help, type: :boolean, aliases: '-h', desc: "Show this help message and quit"
+    
+    class_option :heroku, type: :boolean, default: false, desc: "Create Heroku app"
+    
+    class_option :dokku, type: :boolean, default: false, desc: "Create Dokku app"
+    class_option :dokku_host, type: :string, desc: "Specify the Dokku host machine e.g. 18.131.127.164"
+    
+    class_option :s3_storage, type: :boolean, default: false, desc: "Create an s3 backend for attachment upload and storage"
+    class_option :aws_region, type: :string, default: 'us-east-1', desc: "Specify a region to create AWS resources in"
+    
+    class_option :doorkeeper_oauth, type: :boolean, default: false, desc: "Use Doorkeeper gem for OAuth login"
+
+    def self.banner
+      "mwf rails create:app_server <directory> <OpenAPI Spec file path> [options]"
+    end
+
+    def finish_template
+      super
+      after_bundle do
+        build :procfiles
+        build :rspec_generator
+        build :ability_generator
+        build :active_storage if options[:s3_storage] 
+        build :mobile_workflow_generator, ARGV[1]
+        setup_db
+        generate_administrate
+        
+        generate_dot_env
+        initial_git_commit
+        
+        build :heroku if options[:heroku]
+        build :dokku, options[:dokku_host] if options[:dokku]
+        build :s3_backend, options[:aws_region] if options[:s3_storage]
+      end
+    end
+    
+    protected
+
+    def get_builder_class
+      MobileWorkflow::Cli::AppBuilder
+    end
+    
+    # Todo: MBS - move these methods to the builder class
+    # Ideally override RailsBuilder methods
+    private
+    def generate_administrate
+      generate 'administrate:install'
+      file 'app/assets/config/manifest.js', <<-CODE
+//= link administrate/application.css
+//= link administrate/application.js
+    CODE
+  
+      file 'app/controllers/admin/application_controller.rb', <<-CODE
+module Admin
+  class ApplicationController < Administrate::ApplicationController
+    http_basic_authenticate_with(name: ENV["ADMIN_USER"], password: ENV["ADMIN_PASSWORD"])
+  end
+end
+CODE
+      generate 'administrate:routes'
+    end
+
+    def setup_db
+      rails_command "db:drop"
+      rails_command "db:create"
+      rails_command "db:migrate"
+    end
+
+    def initial_git_commit
+      git add: "."
+      git commit: %Q{ -m 'Initial commit' }
+    end
+
+    def generate_dot_env
+      admin_user = 'admin'
+      admin_password = SecureRandom.base64(12)
+      
+      file '.env', <<-CODE
+ADMIN_USER=#{admin_user}
+ADMIN_PASSWORD=#{admin_password}
+CODE
+    end
+  end
+end

data/lib/mobile_workflow/cli/aws_backend.rb

@@ -0,0 +1,80 @@
+require 'json'
+
+module MobileWorkflow::Cli
+  class AwsBackend
+  
+    attr_accessor :access_id, :secret_key, :region, :bucket_name
+  
+    def initialize(app_name:, region:)
+      @app_name = app_name
+      @aws_name = @app_name.gsub("_", "-")
+      @region = region
+    end
+  
+    def bucket_name
+      @aws_name
+    end
+  
+    def create
+      bucket_configuration = ''
+      bucket_configuration += "--create-bucket-configuration LocationConstraint=#{@region}" unless @region.eql? 'us-east-1'
+      aws_command "aws s3api create-bucket --bucket #{@aws_name} --acl private --region #{@region} #{bucket_configuration}"
+      @topic_arn = aws_command("aws sns create-topic --name #{@aws_name} --region #{@region}")["TopicArn"]
+      aws_command "aws iam create-user --user-name #{@aws_name}"
+      aws_command "aws iam put-user-policy --user-name #{@aws_name} --policy-name s3 --policy-document '{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"s3:PutObject\",\"s3:PutObjectAcl\",\"s3:GetObject\", \"s3:DeleteObject\"],\"Resource\":[\"arn:aws:s3:::#{@aws_name}/*\"]}, {\"Effect\": \"Allow\", \"Action\": \"s3:ListBucket\", \"Resource\": \"arn:aws:s3:::#{@aws_name}\"}]}'"
+      aws_command "aws iam put-user-policy --user-name #{@aws_name} --policy-name sns --policy-document '{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"sns:ConfirmSubscription\"],\"Resource\":[\"#{@topic_arn}\"]}]}'"
+      aws_command "aws sns set-topic-attributes --topic-arn #{@topic_arn} --region #{@region} --attribute-name Policy --attribute-value '{\"Version\": \"2012-10-17\", \"Id\": \"s3\", \"Statement\": [{\"Sid\": \"#{@aws_name}-s3-sid\", \"Effect\": \"Allow\", \"Principal\": {\"AWS\": \"*\"}, \"Action\": \"SNS:Publish\", \"Resource\": \"#{@topic_arn}\", \"Condition\": {\"ArnEquals\": {\"aws:SourceArn\": \"arn:aws:s3:::#{@aws_name}\"}}}]}'"
+      aws_command "aws s3api put-bucket-notification-configuration --bucket #{@aws_name} --notification-configuration '{\"TopicConfigurations\": [{\"TopicArn\": \"#{@topic_arn}\", \"Events\": [\"s3:ObjectCreated:*\"]}]}'"
+      aws_credentials_json = aws_command("aws iam create-access-key --user-name #{@aws_name}")["AccessKey"]
+      @access_id, @secret_key = aws_credentials_json["AccessKeyId"], aws_credentials_json["SecretAccessKey"]
+      return @access_id, @secret_key
+    end
+  
+    def put_env
+      puts "AWS_ACCESS_ID=#{access_id}"
+      puts "AWS_SECRET_KEY=#{secret_key}"
+      puts "AWS_REGION=#{region}"
+      puts "AWS_BUCKET_NAME=#{bucket_name}"
+    end
+  
+    def write_env
+      open('.env', 'a') { |f|
+        f.puts "AWS_ACCESS_ID=#{access_id}"
+        f.puts "AWS_SECRET_KEY=#{secret_key}"
+        f.puts "AWS_REGION=#{region}"
+        f.puts "AWS_BUCKET_NAME=#{bucket_name}"
+      }
+    end
+  
+    def create_topic_subscription(endpoint)
+      aws_command "aws sns subscribe --topic-arn #{@topic_arn} --region #{@region} --protocol https --notification-endpoint #{endpoint}"
+    end
+  
+    def destroy
+      aws_command "aws s3api delete-bucket --bucket #{@aws_name} --region #{@region}"
+    
+      aws_command("aws sns list-topics")["Topics"].each do |topic|
+        topic_arn = topic["TopicArn"]
+        aws_command "aws sns delete-topic --topic-arn '#{topic_arn}'" if topic_arn.end_with?(@aws_name)
+      end
+    
+      aws_command "aws iam delete-user-policy --user-name #{@aws_name} --policy-name s3"
+      aws_command "aws iam delete-user-policy --user-name #{@aws_name} --policy-name sns"
+      aws_command("aws iam list-access-keys --user-name #{@aws_name}")["AccessKeyMetadata"].each do |accessKeyMetadata|
+        aws_command "aws iam delete-access-key --user-name #{@aws_name} --access-key #{accessKeyMetadata["AccessKeyId"]}"    
+      end
+      aws_command "aws iam delete-user --user-name #{@aws_name}"
+    end
+  
+    private
+    def aws_command(command)
+      puts "Running: #{command}"
+      output = `#{command}`
+      return nil if output == nil || output.strip == ""
+    
+      puts "Output: #{output}"
+      JSON.parse(output)
+    end
+  
+  end
+end

data/lib/mobile_workflow/cli/dokku_backend.rb

@@ -0,0 +1,57 @@
+module MobileWorkflow::Cli
+  class DokkuBackend
+    def initialize(dokku_host:, app_name:)
+      @dokku_host = dokku_host
+      @dokku_app_name = app_name.gsub("_", "-")
+    end
+  
+    def create
+      remote_command "dokku apps:create #{@dokku_app_name}"
+      remote_command "dokku postgres:create #{@dokku_app_name}"
+      remote_command "dokku postgres:link #{@dokku_app_name} #{@dokku_app_name}"
+      remote_command "dokku domains:enable #{@dokku_app_name}"
+      remote_command "dokku letsencrypt #{@dokku_app_name}"
+    
+      local_command "git remote add dokku dokku@#{@dokku_host}:#{@dokku_app_name}"
+    end
+  
+    def configure_activestorage
+ 
+    end
+  
+    def deploy
+      local_command "git push dokku master"
+    end
+  
+    def sync_dotenv
+      env = File.read(".env").split.join(" ")
+      puts "Setting env: #{env}"
+      local_command "dokku config:set #{env}"
+    end
+  
+    def destroy
+      remote_command "dokku apps:destroy #{@dokku_app_name}"
+    end
+  
+    def dokku_app_host
+      remote_command "dokku url #{@dokku_app_name}"
+    end
+  
+    def notifications_endpoint
+      "https://#{dokku_app_host}/sns_notifications"
+    end
+  
+    private
+    def remote_command(command)
+      command = "ssh -t ubuntu@#{@dokku_host} '#{command}'"
+      local_command(command)
+    end
+  
+    def local_command(command)
+      puts "Running: #{command}"
+      output = `#{command}`
+      puts "Output: #{output}" unless output.blank?
+      return output
+    end
+  end
+end

data/lib/mobile_workflow/cli/heroku_backend.rb

@@ -0,0 +1,47 @@
+module MobileWorkflow::Cli
+  class HerokuBackend
+    def initialize(app_name:)
+      @heroku_app_name = app_name.gsub("_", "-")
+    end
+  
+    def create
+      heroku_command "heroku create #{@heroku_app_name}"
+      heroku_command "git push --set-upstream heroku master"
+    end
+  
+    def configure_activestorage
+      heroku_command "heroku buildpacks:add -i 1 https://github.com/heroku/heroku-buildpack-activestorage-preview --app #{@heroku_app_name}"
+      heroku_command "heroku labs:enable runtime-dyno-metadata --app #{@heroku_app_name}" # Gives access to heroku variables which can be used to construct URLs
+    
+      # Force recompile after buildpacks change
+      heroku_command "git commit --allow-empty -m 'empty commit'"
+      deploy    
+    end
+  
+    def deploy
+      heroku_command "git push"
+    end
+  
+    def sync_dotenv
+      env = File.read(".env").split.join(" ")
+      puts "Setting env: #{env}"
+      heroku_command "heroku config:set #{env} --app #{@heroku_app_name}"
+    end
+  
+    def destroy
+      heroku_command "heroku destroy #{@heroku_app_name} --confirm #{@heroku_app_name}"
+    end
+  
+    def notifications_endpoint
+      "https://#{@heroku_app_name}.herokuapp.com/sns_notifications"
+    end
+  
+    private
+    def heroku_command(command)
+      puts "Running: #{command}"
+      output = `#{command}`
+      puts "Output: #{output}"
+      return output
+    end
+  end
+end

data/lib/mobile_workflow/version.rb

@@ -1,3 +1,5 @@
 module MobileWorkflow
-  VERSION = '0.1.0'
+  VERSION = '0.5.1'
+  RUBY_VERSION = '2.5.5'
+  RAILS_VERSION = '6.1.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,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mobile_workflow
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Matt Brooke-Smith
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
+date: 2020-12-28 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
+        version: 6.1.0
   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
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -58,10 +52,39 @@ 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: []
+executables:
+- mwf
 extensions: []
 extra_rdoc_files: []
 files:
@@ -70,29 +93,47 @@ 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
+- bin/mwf
 - 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/Gemfile.erb
+- lib/generators/mobile_workflow/install/templates/Procfile
+- lib/generators/mobile_workflow/install/templates/Procfile.dev
+- lib/generators/mobile_workflow/install/templates/README.md.erb
+- lib/generators/mobile_workflow/install/templates/ability.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/storage.s3.yml
+- 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
+- lib/mobile_workflow/cli.rb
+- lib/mobile_workflow/cli/app_builder.rb
+- lib/mobile_workflow/cli/app_server_cleaner.rb
+- lib/mobile_workflow/cli/app_server_generator.rb
+- lib/mobile_workflow/cli/aws_backend.rb
+- lib/mobile_workflow/cli/dokku_backend.rb
+- lib/mobile_workflow/cli/heroku_backend.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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -100,7 +141,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -108,7 +149,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

data/lib/tasks/mobile_workflow_tasks.rake

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