First commit

Author: blairworkos

README.md

@@ -0,0 +1,15 @@
+# Ruby and Rails Example Applications powered by WorkOS
+
+Example applications demonstrating to use the [WorkOS Ruby SDK](https://github.com/workos-inc/workos-ruby) for SSO, Directory Sync, Admin Portal and Magic Link.
+
+## For more information, please see the following guides:
+
+* [Single Sign-On](https://workos.com/docs/sso/guide)
+* [Directory Sync](https://workos.com/docs/directory-sync/guide)
+* [Admin Portal](https://workos.com/docs/admin-portal/guide)
+* [Magic Link](https://workos.com/docs/magic-link/guide)
+* [API Reference](https://workos.com/docs/reference)
+
+## Need help?
+
+If you get stuck and aren't able to resolve the issue by reading our [WorkOS Ruby SDK documentation](https://docs.workos.com/sdk/ruby) or [API reference](https://workos.com/docs/reference), you can reach out to us at [email protected] and we'll lend a hand!

ruby-directory-sync-example/.env.example

@@ -0,0 +1 @@
+WORKOS_API_KEY=<Replace with your key>

ruby-directory-sync-example/.gitignore

@@ -0,0 +1 @@
+.env

ruby-directory-sync-example/.ruby-version

@@ -0,0 +1 @@
+2.7.1

ruby-directory-sync-example/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'dotenv'
+gem 'sinatra'
+gem 'workos'

ruby-directory-sync-example/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    dotenv (2.7.6)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    rack (2.2.3)
+    rack-protection (2.1.0)
+      rack
+    ruby2_keywords (0.0.5)
+    sinatra (2.1.0)
+      mustermann (~> 1.0)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
+      tilt (~> 2.0)
+    sorbet-runtime (0.5.9293)
+    tilt (2.0.10)
+    workos (1.6.0)
+      sorbet-runtime (~> 0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dotenv
+  sinatra
+  workos
+
+BUNDLED WITH
+   2.1.4

ruby-directory-sync-example/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 WorkOS
+
+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.

ruby-directory-sync-example/README.md

@@ -0,0 +1,32 @@
+# ruby-directory-sync-example
+
+An example Sinatra application demonstrating how Directory Sync works with WorkOS and Ruby.
+
+## Clone and Install
+
+1. Clone the main repo:
+
+```sh
+git clone https://github.com/workos-inc/ruby-example-applications.git
+```
+
+2. Navigate to the Ruby Directory Sync app within the main repo and install dependencies:
+
+```sh
+cd ruby-example-applications/ruby-directory-sync-example && bundle install
+```
+
+## Configure your environment
+
+1. Grab your [API Key](https://dashboard.workos.com/api-keys).
+2. Run `cp .env.example .env` and add your API key. The `workos` gem will read your API key from the ENV variable `WORKOS_API_KEY`. You may also set the API key yourself by adding `WorkOS.key = $YOUR_API_KEY` to `app.rb`.
+
+## Run the app
+
+```sh
+ruby app.rb
+```
+
+Head to `http://localhost:4567`!
+
+For more information, see the [WorkOS Ruby SDK documentation](https://docs.workos.com/sdk/ruby).

ruby-directory-sync-example/app.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'dotenv/load'
+require 'sinatra'
+require 'workos'
+require 'json'
+
+# Pull API key from ENV variable
+WorkOS.key = ENV['WORKOS_API_KEY']
+
+get '/' do
+  @directories = WorkOS::DirectorySync.list_directories
+
+  erb :index
+end
+
+get '/directories/:id' do
+  @groups = WorkOS::DirectorySync.list_groups(directory: params[:id])
+  @users = WorkOS::DirectorySync.list_users(directory: params[:id])
+
+  erb :directory
+end
+
+get '/users/:id' do
+  @user = WorkOS::DirectorySync.get_user(params[:id])
+  @user_groups = WorkOS::DirectorySync.list_groups(user: params[:id])
+
+  erb :user
+end
+
+get '/groups/:id' do
+  @group = WorkOS::DirectorySync.get_group(params[:id])
+  @group_users = WorkOS::DirectorySync.list_users(group: params[:id])
+
+  erb :group
+end

ruby-directory-sync-example/views/directory.erb

@@ -0,0 +1,28 @@
+<% if @users.any? %>
+  <h2>Users</h2>
+
+  <ul>
+    <% @users.each do |user| %>
+      <li>
+        <a href="/users/<%= user['id'] %>">
+          <%= user['username'] %>
+        </a>
+      </li>
+    <% end %>
+  </ul>
+<% end %>
+
+
+<% if @groups.any? %>
+  <h2>Groups</h2>
+
+  <ul>
+    <% @groups.each do |group| %>
+      <li>
+        <a href="/groups/<%= group['id'] %>">
+          <%= group['name'] %>
+        </a>
+      </li>
+    <% end %>
+  </ul>
+<% end %>