Add Autodesk Viewer integration

README.md

@@ -16,6 +16,11 @@ Authors use Markdown to write articles on KnewHub. In addition to regular Markdo
 - Collapsing elements (HTML details and summary tags)
     + Syntax: `[details Hint]content[/details]`
     + Example: `[details Click Here to Display Content]Content[/details]`
+- Viewing 3D files using Autodesk viewer
+    + Syntax: `[3d-viewer <relative_path>]`
+    + Example: `[3d-viewer ./some-model.stp]` 
+
+Note that `relative_path` cannot use underscores (_). Only alphanumeric characters and hyphens (-) are allowed.
 
 ## Development
 

app/assets/stylesheets/application.scss

@@ -16,6 +16,7 @@
 @import "layout/sidebar";
 @import "layout/swiper-slide";
 
+@import "components/autodesk-viewer";
 @import "components/answer";
 @import "components/flash";
 @import "components/form-block";

app/assets/stylesheets/components/_autodesk-viewer.sass

@@ -0,0 +1,7 @@
+// autodesk-viewer
+
+.autodesk-viewer
+  &:has(div.adsk-viewing-viewer)
+    position: relative
+    min-height: 50rem
+    margin: 2rem 0

app/controllers/proxy/autodesk_controller.rb

@@ -0,0 +1,14 @@
+module Proxy
+  class AutodeskController < ApplicationController
+    before_action :authenticate_user!
+
+    def show
+      autodesk_service = Autodesk.new
+      response = autodesk_service.call_viewer(params[:request_type], params[:path], params[:format])
+
+      head :bad_request and return unless response.status == 200
+
+      send_data response.body
+    end
+  end
+end

app/javascript/controllers/autodesk_viewer_controller.js

@@ -0,0 +1,69 @@
+import { Controller } from '@hotwired/stimulus'
+
+export default class extends Controller {
+  static targets = ['viewerDiv', 'displayBtn', 'hideBtn']
+
+  static values = {
+    urn: String
+  }
+
+  viewer
+  options = {
+    shouldInitializeAuth: false,
+    endpoint: window.location.origin + "/autodesk/viewer-proxy",
+    env: 'AutodeskProduction',
+    api: 'derivativeV2'
+  }
+
+  documentId = 'urn:' + this.urnValue
+
+  connect () {
+    this.createViewer()
+  }
+
+  createViewer () {
+    Autodesk.Viewing.Initializer(this.options, () => {
+      this.viewer = new Autodesk.Viewing.GuiViewer3D(this.viewerDivTarget)
+      const startedCode = this.viewer.start()
+      if (startedCode > 0) {
+        console.error('Failed to create a Viewer: WebGL not supported.')
+        return
+      }
+      console.log('Initialization complete, loading a model next...')
+      this.displayBtnTarget.classList.add('hide')
+    })
+
+    this.loadDocument()
+  }
+
+  loadDocument () {
+    const onDocumentLoadSuccess = (viewerDocument) => {
+      const defaultModel = viewerDocument.getRoot().getDefaultGeometry()
+      this.viewer.loadDocumentNode(viewerDocument, defaultModel)
+    }
+
+    const onDocumentLoadFailure = (viewerErrorCode) => {
+      console.error('Failed fetching Forge manifest. Error code: ' + viewerErrorCode)
+    }
+
+    Autodesk.Viewing.Document.load(this.documentId, onDocumentLoadSuccess, onDocumentLoadFailure)
+  }
+
+  display () {
+    this.hideBtnTarget.classList.remove('hide')
+    this.displayBtnTarget.classList.add('hide')
+    this.createViewer()
+  }
+
+  hide () {
+    this.displayBtnTarget.classList.remove('hide')
+    this.hideBtnTarget.classList.add('hide')
+    this.destroyViewer()
+  }
+
+  destroyViewer () {
+    this.viewer.finish()
+    this.viewer = null
+    Autodesk.Viewing.shutdown()
+  }
+}

app/jobs/upload_autodesk_files_job.rb

@@ -0,0 +1,69 @@
+class UploadAutodeskFilesJob
+  include Sidekiq::Job
+  include SplitMarkdownHelper
+
+  def perform(build_id)
+    build = Build.find(build_id)
+    _repository, directory = RepositoryDirectory.define(build.repository.id)
+
+    perform_for_each_repository(build, directory)
+    build.finished_uploading_autodesk_files
+  end
+
+  private
+
+  def list_markdown_file_paths(directory)
+    Dir.glob("#{directory}/**/*.md")
+  end
+
+  def list_autodesk_files_for_markdown_file(markdown_file_path)
+    markdown_path_name = Pathname.new(markdown_file_path)
+    directory_path_name = markdown_path_name.dirname
+
+    _front_matter, markdown_content = split_markdown(markdown_file_path)
+    autodesk_file_relative_paths = markdown_content.scan(/\[3d-viewer (.+)\]/).flatten
+    # ["./3d-files/nist-ctc-01-asme1-rd.stp", "./3d-files/nist-ctc-02-asme1-rc.stp""]
+
+    return if autodesk_file_relative_paths.empty?
+
+    autodesk_file_relative_paths.map do |relative_path|
+      directory_path_name.join(relative_path).relative_path_from(Rails.root).to_s
+    end
+    # ["repos/author/repo_owner/name/chapter-1/3d-files/nist-ctc-01-asme1-rd.stp",
+    #  "repos/author/repo_owner/name/chapter-1/3d-files/nist-ctc-02-asme1-rc.stp"]
+  end
+
+  def list_autodesk_files_for_directory(directory, autodesk_files = [])
+    markdown_file_paths = list_markdown_file_paths(directory)
+    markdown_file_paths.each do |markdown_file_path|
+      autodesk_files_for_markdown_file = list_autodesk_files_for_markdown_file(markdown_file_path)
+      autodesk_files << autodesk_files_for_markdown_file if autodesk_files_for_markdown_file
+    end
+    autodesk_files = autodesk_files.flatten
+  end
+
+  def perform_for_each_repository(build, directory)
+    autodesk_files = list_autodesk_files_for_directory(directory)
+
+    if autodesk_files.empty?
+      build.logs.create(content: 'No Autodesk files were found in this repository.')
+    else
+      build.logs.create(content: 'Autodesk files found in this repository. Uploading...')
+      autodesk_files.each do |filepath|
+        perform_for_each_file(build, build.repository.id, filepath)
+      end
+    end
+  end
+
+  def perform_for_each_file(build, repository_id, filepath)
+    autodesk_file = AutodeskFile.find_by(repository_id:, filepath:)
+    autodesk_file ||= AutodeskFile.create!(repository_id:, filepath:)
+
+    autodesk_service = AutodeskFileUpload.new(filepath, build)
+    urn = autodesk_service.upload_file_for_viewer
+
+    return if urn.nil?
+
+    autodesk_file.update(urn:)
+  end
+end

app/models/autodesk_file.rb

@@ -0,0 +1,5 @@
+class AutodeskFile < ApplicationRecord
+  belongs_to :repository
+
+  validates :filepath, presence: true
+end

app/models/build.rb

@@ -21,6 +21,7 @@ def repository_author
           :getting_repo_description,
           :parsing_questions,
           :creating_repo_index,
+          :uploading_autodesk_files,
           :completed
 
     event :receive_webhook, after_commit: :schedule_receive_webhook do
@@ -47,8 +48,12 @@ def repository_author
       transitions from: :parsing_questions, to: :creating_repo_index
     end
 
+    event :upload_autodesk_files, after_commit: :schedule_upload_autodesk_files do
+      transitions from: :creating_repo_index, to: :uploading_autodesk_files
+    end
+
     event :complete, after_commit: :complete_build do
-      transitions from: :creating_repo_index, to: :completed
+      transitions from: :uploading_autodesk_files, to: :completed
     end
   end
 
@@ -99,6 +104,10 @@ def schedule_create_repo_index
     CreateRepoIndexJob.perform_async(id)
   end
 
+  def schedule_upload_autodesk_files
+    UploadAutodeskFilesJob.perform_async(id)
+  end
+
   def complete_build
     update(status: 'Complete', completed_at: DateTime.current)
   end
@@ -130,6 +139,10 @@ def finished_parsing_questions
   end
 
   def finished_creating_repo_index
+    upload_autodesk_files!
+  end
+
+  def finished_uploading_autodesk_files
     complete!
   end
 

app/models/repository.rb

@@ -2,6 +2,7 @@ class Repository < ApplicationRecord
   belongs_to :github_installation
   has_many :builds, dependent: :destroy
   has_many :questions, dependent: :destroy
+  has_many :autodesk_files, dependent: :destroy
 
   before_save :set_branch
 

app/services/autodesk.rb

@@ -0,0 +1,52 @@
+class Autodesk
+  attr_reader :access_token, :access_token_error_msg
+
+  def initialize(scope: 'viewables:read')
+    @conn = Faraday.new(url: 'https://developer.api.autodesk.com')
+    @bucket_key = Rails.application.credentials.dig(:autodesk, :upload, :bucket_key)
+    @scope = scope
+    create_access_token
+  end
+
+  def call_viewer(request_type, path, format)
+    @conn.get(
+      "derivativeservice/v2/#{request_type}/#{request_path(path, format)}",
+      nil,
+      { Authorization: "Bearer #{@access_token}" }
+    )
+  end
+
+  private
+
+  def create_access_token
+    response = @conn.post(
+      '/authentication/v2/token',
+      { grant_type: 'client_credentials', scope: @scope },
+      { 'Content-Type': 'application/x-www-form-urlencoded',
+        Accept: 'application/json',
+        Authorization: "Basic #{base64_client_info}" }
+    )
+    handle_response(response)
+  end
+
+  def handle_response(response)
+    response_body = JSON.parse(response.body)
+    if response.status == 200
+      @access_token = response_body['access_token']
+    else
+      @access_token_error_msg = response_body.values.join('. ')
+    end
+  end
+
+  def base64_client_info
+    client_id = Rails.application.credentials.dig(:autodesk, :upload, :client_id)
+    client_secret = Rails.application.credentials.dig(:autodesk, :upload, :client_secret)
+    Base64.strict_encode64("#{client_id}:#{client_secret}")
+  end
+
+  def request_path(path, format)
+    result = CGI.escape(path)
+    result.concat(".#{format}") unless format.nil?
+    result
+  end
+end

app/services/autodesk_bucket.rb

@@ -0,0 +1,24 @@
+class AutodeskBucket < Autodesk
+  def initialize
+    super(scope: 'data:read bucket:create')
+  end
+
+  def query_storage_bucket_objects
+    response = @conn.get(
+      "/oss/v2/buckets/#{@bucket_key}/objects",
+      nil,
+      { 'Content-Type': 'application/json', Authorization: "Bearer #{@access_token}" }
+    )
+    JSON.parse(response.body)
+  end
+
+  def create_storage_bucket
+    request_params = { bucketKey: @bucket_key, access: 'full', policyKey: 'persistent' }
+    response = @conn.post(
+      '/oss/v2/buckets',
+      request_params.to_json,
+      { 'Content-Type': 'application/json', Authorization: "Bearer #{@access_token}" }
+    )
+    JSON.parse(response.body)
+  end
+end