This app provides multiple samples on using the Autodesk Forge Web Services APIs:
The first sample demonstrates how to use the OAuth, Data Management and Model Derivative Forge APIs, as well as the Forge Viewer JavaScript library in Automated mode.
It shows the following workflow:
- Create a 2-legged authentication token
- Create a bucket (an arbitrary space to store objects)
- Upload a file to the bucket
- Prepare the file for displaying in the Viewer (translate the file into SVF format)
- Show the translated file in the Viewer
It is based on the forge-ruby-sample-app but runs as a Rails App
The second sample focuses on 3-legged OAuth authentication and Data Management.
It:
- Generate 3-legged authentication token from user authorization
- Explore user hubs from different Autodesk services (BIM360 Team hub, a Fusion Team hub, an A360 Personal hub or a BIM360 Docs account)
- Display all projects in a selected hub
- Display all elements (folders/files) inside a project with their properties and links
- Download files
- Upload a file to project folder
- Prepare the file for displaying in the Viewer (translate the file into SVF format)
- Show files in the Viewer
The third sample is similar to the first sample, but in an Interactive way, it demonstrates how to use the 2-legged OAuth, Data Management and Model Derivative Forge APIs, as well as the Forge Viewer JavaScript library.
It:
- Create a 2-legged authentication token
- Explore App-owned buckets
- Create a bucket
- Display all objects (files) inside a bucket with their properties and links
- Upload a sample file to the bucket (not user-defined for security reasons)
- Prepare the file for displaying in the Viewer (translate the file into SVF format)
- Show the translated file in the Viewer
The forth sample focuses on the Forge Viewer, it demonstrates the capabilities of the Forge Viewer client-side functionality and how the Viewer can manipulate the translated design files to extract and display various info about the displayed model and sheets.
On the server-side, it is very similar to Sample 1, but uses the functions already implemented in Samples 2 and 3 instead to minimize code duplication and better reuse. It's role is to upload a sample 2D DWG file (in addition to the already uploaded 3D OBJ file) to an App Bucket and initiate translation service (Model derivative) to generate SVF files for it.
On the client side we start with the basic Viewer functionality then move to more advanced samples.
The app is based on Rails 5.1.1, Ruby 2.4.0, jQuery 1.12.4 and Bootstrap 3.3.7, no compatibility checks have been made on earlier releases.
$ bundle install
Create an app on the Forge Developer portal, and ensure that you select the Data Management and Model Derivative APIs. Note the client ID and client secret.
Open the config/secrets.yml file, and replace FORGE_CLIENT_ID and FORGE_CLIENT_SECRET with the client ID and client secret generated when creating the app, or create 2 environment variables with the same name.
export FORGE_CLIENT_ID=abcd...
export FORGE_CLIENT_SECRET=efgh...
$ rails server
To deploy this application to Heroku, the Callback URL & redirect_uri must use your .herokuapp.com address. After clicking on the button below, at the Heroku Create New App page, set FORGE_CLIENT_ID and FORGE_CLIENT_SECRET config vars.
