workos 0.0.2 → 0.1.0

data/docs/class_list.html

@@ -4,9 +4,9 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta charset="utf-8" />
     
-      <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
+      <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
     
-      <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+      <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
     
 
     
@@ -43,7 +43,7 @@
 
       <ul id="full_list" class="class">
         <li id="object_" class="odd"><div class="item" style="padding-left:30px"><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></div></li>
-<li id='object_WorkOS' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="WorkOS.html" title="WorkOS (module)">WorkOS</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_WorkOS::Base' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/Base.html" title="WorkOS::Base (class)">Base</a></span> &lt; Object<small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::Profile' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/Profile.html" title="WorkOS::Profile (class)">Profile</a></span> &lt; Object<small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::RequestError' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/RequestError.html" title="WorkOS::RequestError (class)">RequestError</a></span> &lt; StandardError<small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::SSO' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/SSO.html" title="WorkOS::SSO (module)">SSO</a></span><small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::Types' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="WorkOS/Types.html" title="WorkOS::Types (module)">Types</a></span><small class='search_info'>WorkOS</small></div><ul><li id='object_WorkOS::Types::ProfileStruct' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="WorkOS/Types/ProfileStruct.html" title="WorkOS::Types::ProfileStruct (class)">ProfileStruct</a></span> &lt; Struct<small class='search_info'>WorkOS::Types</small></div></li></ul></li></ul></li>
+<li id='object_WorkOS' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="WorkOS.html" title="WorkOS (module)">WorkOS</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_WorkOS::APIError' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/APIError.html" title="WorkOS::APIError (class)">APIError</a></span> &lt; WorkOSError<small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::AuditLog' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/AuditLog.html" title="WorkOS::AuditLog (module)">AuditLog</a></span><small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::AuthenticationError' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/AuthenticationError.html" title="WorkOS::AuthenticationError (class)">AuthenticationError</a></span> &lt; WorkOSError<small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::Base' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/Base.html" title="WorkOS::Base (module)">Base</a></span><small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::Client' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/Client.html" title="WorkOS::Client (module)">Client</a></span><small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::InvalidRequestError' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/InvalidRequestError.html" title="WorkOS::InvalidRequestError (class)">InvalidRequestError</a></span> &lt; WorkOSError<small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::Profile' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/Profile.html" title="WorkOS::Profile (class)">Profile</a></span> &lt; Object<small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::SSO' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/SSO.html" title="WorkOS::SSO (module)">SSO</a></span><small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::Types' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="WorkOS/Types.html" title="WorkOS::Types (module)">Types</a></span><small class='search_info'>WorkOS</small></div><ul><li id='object_WorkOS::Types::ProfileStruct' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="WorkOS/Types/ProfileStruct.html" title="WorkOS::Types::ProfileStruct (class)">ProfileStruct</a></span> &lt; Struct<small class='search_info'>WorkOS::Types</small></div></li><li id='object_WorkOS::Types::Provider' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="WorkOS/Types/Provider.html" title="WorkOS::Types::Provider (class)">Provider</a></span> &lt; Enum<small class='search_info'>WorkOS::Types</small></div></li></ul></li><li id='object_WorkOS::WorkOSError' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/WorkOSError.html" title="WorkOS::WorkOSError (class)">WorkOSError</a></span> &lt; StandardError<small class='search_info'>WorkOS</small></div></li></ul></li>
 
       </ul>
     </div>

data/docs/css/style.css

@@ -422,8 +422,8 @@ li.r2 { background: #fafafa; }
 #toc ol { padding-left: 1.8em; }
 #toc li { font-size: 1.1em; line-height: 1.7em; }
 #toc > ol > li { font-size: 1.1em; font-weight: bold; }
-#toc ol > ol { font-size: 0.9em; }
-#toc ol ol > ol { padding-left: 2.3em; }
+#toc ol > li > ol { font-size: 0.9em; }
+#toc ol ol > li > ol { padding-left: 2.3em; }
 #toc ol + li { margin-top: 0.3em; }
 #toc.hidden { padding: 10px; background: #fefefe; box-shadow: none; }
 #toc.hidden:hover { background: #fafafa; }

data/docs/file.README.html

@@ -6,15 +6,15 @@
 <title>
   File: README
   
-    &mdash; Documentation by YARD 0.9.20
+    &mdash; Documentation by YARD 0.9.22
   
 </title>
 
-  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = "README";
   relpath = '';
 </script>
@@ -58,33 +58,193 @@
       </div>
 
       <div id="content"><div id='filecontents'>
-<h1 id="label-workos-rb">workos-rb</h1>
+<h1 id="label-workos-ruby+rdoc-image-3Ahttps-3A-2F-2Fcodecov.io-2Fgh-2Fworkos-inc-2Fworkos-ruby-2Fbranch-2Fmaster-2Fgraph-2Fbadge.svg">workos-ruby <a href="https://codecov.io/gh/workos-inc/workos-ruby"><img src="https://codecov.io/gh/workos-inc/workos-ruby/branch/master/graph/badge.svg"></a></h1>
 
 <p>WorkOS official Ruby gem for interacting with WorkOS APIs</p>
 
+<h2 id="label-Documentation">Documentation</h2>
+
+<p>Complete documentation for the latest version of WorkOS Ruby Gem can be found <a href="https://workos-inc.github.io/workos-ruby/">here</a>.</p>
+
 <h2 id="label-Installation">Installation</h2>
 
-<p>You don&#39;t need this source code unless you want to modify the gem. If
-you just want to use the package, just run:</p>
+<p>To get started, you can install the WorkOS gem via RubyGems with:</p>
 
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_workos'>workos</span>
 </code></pre>
 
-<p>If you want to build the gem from source:</p>
+<p>If you&#39;re using Bundler to manage your application&#39;s gems, add the WorkOS gem to your Gemfile:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_source'>source</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://rubygems.org</span><span class='tstring_end'>&#39;</span></span>
+
+<span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>workos</span><span class='tstring_end'>&#39;</span></span>
+</code></pre>
+
+<h2 id="label-Configuration">Configuration</h2>
+
+<p>To use the SDK you must first provide your API key from the <a href="https://dashboard.workos.com/api-keys">WorkOS Developer Dashboard</a>.</p>
+
+<p>You can do this through the <code>WORKOS_KEY</code> environment variable or by calling <code>WorkOS.key = [your API key]</code>.</p>
+
+<p>The WorkOS Gem will read the environment variable <code>WORKOS_KEY</code>:</p>
+
+<pre class="code ruby"><code class="ruby">$ WORKOS_KEY=[your api key] ruby app.rb
+</code></pre>
+
+<p>Alternatively, you may set the key yourself, such as in an initializer in your application load path:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='comment'># /config/initializers/workos.rb
+</span>
+<span class='const'><span class='object_link'><a href="WorkOS.html" title="WorkOS (module)">WorkOS</a></span></span><span class='period'>.</span><span class='id identifier rubyid_key'><span class='object_link'><a href="WorkOS.html#key-class_method" title="WorkOS.key (method)">key</a></span></span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>[your api key]</span><span class='tstring_end'>&#39;</span></span>
+</code></pre>
+
+<h2 id="label-The+Audit+Log+Module">The Audit Log Module</h2>
+
+<p>The Audit Log Module provides methods for creating Audit Log events on WorkOS.</p>
+
+<p>See our <a href="https://dashboard.workos.com/docs/audit-log/quickstart">Audit Log Quickstart</a> for more information.</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='lbrace'>{</span>
+  <span class='label'>group:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Foo Corp</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+  <span class='label'>location:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>127.0.0.1</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+  <span class='label'>action:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>user.created</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+  <span class='label'>action_type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>C</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+  <span class='label'>actor_name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Foo</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+  <span class='label'>actor_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>user_12345</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+  <span class='label'>target_name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Bar</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+  <span class='label'>target_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>user_67890</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+  <span class='label'>occurred_at:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>2020-01-10T15:30:00-05:00</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+  <span class='label'>metadata:</span> <span class='lbrace'>{</span>
+    <span class='label'>source:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Email</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+  <span class='rbrace'>}</span>
+<span class='rbrace'>}</span>
+
+<span class='const'><span class='object_link'><a href="WorkOS.html" title="WorkOS (module)">WorkOS</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="WorkOS/AuditLog.html" title="WorkOS::AuditLog (module)">AuditLog</a></span></span><span class='period'>.</span><span class='id identifier rubyid_create_event'><span class='object_link'><a href="WorkOS/AuditLog.html#create_event-class_method" title="WorkOS::AuditLog.create_event (method)">create_event</a></span></span><span class='lparen'>(</span><span class='label'>event:</span> <span class='id identifier rubyid_payload'>payload</span><span class='rparen'>)</span>
+</code></pre>
+
+<h3 id="label-Idempotency">Idempotency</h3>
+
+<p>To perform an idempotent request, provide an additional idempotency_key parameter to the <code>create_event</code> options.</p>
+
+<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="WorkOS.html" title="WorkOS (module)">WorkOS</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="WorkOS/AuditLog.html" title="WorkOS::AuditLog (module)">AuditLog</a></span></span><span class='period'>.</span><span class='id identifier rubyid_create_event'><span class='object_link'><a href="WorkOS/AuditLog.html#create_event-class_method" title="WorkOS::AuditLog.create_event (method)">create_event</a></span></span><span class='lparen'>(</span><span class='label'>event:</span> <span class='id identifier rubyid_payload'>payload</span><span class='comma'>,</span> <span class='label'>idempotency_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>key123456</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+</code></pre>
+
+<p>See our <a href="https://dashboard.workos.com/docs/api-reference#idempotency">API Reference</a> for more information on idempotency keys.</p>
+
+<h2 id="label-The+SSO+Module">The SSO Module</h2>
+
+<p>The SSO Module provides convenience methods for authenticating a Single Sign On (SSO) user via WorkOS. WorkOS SSO follows the Oauth 2.0 specification.</p>
+
+<p>First, you&#39;ll direct your SSO users to an <code>authorization_url</code>. They will sign in to their SSO account with their Identity Provider, and be redirected to a callback URL that you set in your WorkOS Dashboard. The user will be redirected with a <code>code</code> URL parameter, which you can then exchange for a WorkOS::Profile using the <code>WorkOS::SSO.get_profile</code> method.</p>
+
+<p>See our Ruby SSO example app for a <a href="https://github.com/workos-inc/ruby-sso-example">complete example</a>.</p>
+
+<pre class="code ruby"><code class="ruby">WorkOS::SSO.authorization_url(domain:, project_id:, redirect_uri:, state: {})
+</code></pre>
+
+<blockquote>
+<p>Generate an authorization URL to intitiate the WorkOS OAuth2 workflow.</p>
+</blockquote>
+
+<p><code>WorkOS::SSO.authorization_url</code> accepts four arguments:</p>
+<ul><li>
+<p><code>domain</code> (string) — the authenticating user&#39;s company domain, without protocol (ex. <code>example.com</code>)</p>
+</li><li>
+<p><code>project_id</code> (string) — your application&#39;s WorkOS <a href="https://dashboard.workos.com/sso/configuration">Project ID</a> (ex. <code>project_01JG3BCPTRTSTTWQR4VSHXGWCQ</code>)</p>
+</li><li>
+<p><code>state</code> (optional, hash) — an optional hash used to manage state across authorization transactions (ex. <code>{ next_page: &#39;/docs&#39;}</code>)</p>
+</li><li>
+<p><code>redirect_uri</code> (string) — a callback URL where your application redirects the user-agent after an authorization code is granted (ex. <code>workos.dev/callback</code>). This must match one of your configured callback URLs for the associated project on your WorkOS dashboard.</p>
+</li></ul>
+
+<p>This method will return an OAuth2 query string of the form:</p>
+
+<p><code>https://${domain}/sso/authorize?response_type=code&client_id=${projectID}&redirect_uri=${redirectURI}&state=${state}</code></p>
 
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_build'>build</span> <span class='id identifier rubyid_workos'>workos</span><span class='period'>.</span><span class='id identifier rubyid_gemspec'>gemspec</span>
+<p>For example, when used in a <a href="http://sinatrarb.com/">Sinatra app</a>:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='const'>DOMAIN</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>example.com</span><span class='tstring_end'>&#39;</span></span>
+<span class='const'>PROJECT_ID</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>{projectId}</span><span class='tstring_end'>&#39;</span></span>
+<span class='const'>REDIRECT_URI</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>http://localhost:4567/callback</span><span class='tstring_end'>&#39;</span></span>
+
+<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/auth</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>do</span>
+  <span class='id identifier rubyid_authorization_url'>authorization_url</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="WorkOS.html" title="WorkOS (module)">WorkOS</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="WorkOS/SSO.html" title="WorkOS::SSO (module)">SSO</a></span></span><span class='period'>.</span><span class='id identifier rubyid_authorization_url'><span class='object_link'><a href="WorkOS/SSO.html#authorization_url-class_method" title="WorkOS::SSO.authorization_url (method)">authorization_url</a></span></span><span class='lparen'>(</span>
+    <span class='label'>domain:</span> <span class='const'>DOMAIN</span><span class='comma'>,</span>
+    <span class='label'>project_id:</span> <span class='const'>PROJECT_ID</span><span class='comma'>,</span>
+    <span class='label'>redirect_uri:</span> <span class='const'>REDIRECT_URI</span><span class='comma'>,</span>
+  <span class='rparen'>)</span>
+
+  <span class='id identifier rubyid_redirect'>redirect</span> <span class='id identifier rubyid_authorization_url'>authorization_url</span>
+<span class='kw'>end</span>
 </code></pre>
 
-<h3 id="label-Requirements">Requirements</h3>
+<p>The user would be redirected to:</p>
+
+<p><code>https://api.workos.com/sso/authorize?response_type=code&client_id={projectID}&redirect_uri=http://localhost:4567/callback</code></p>
+
+<p>WorkOS takes over from here, sending the user to authenticate with their IDP, and on successful login, returns the user to your callback URL with a <code>code</code> parameter. You&#39;ll use <code>WorkOS::SSO.profile</code> to exchange the code for a <code>WorkOS::Profile</code>.</p>
+
+<pre class="code ruby"><code class="ruby">WorkOS::SSO.profile(code:, project_id:)&lt;/h4&gt;
+</code></pre>
+
+<blockquote>
+<p>Fetch a WorkOS::Profile for an authorized user.</p>
+</blockquote>
+
+<p><code>WorkOS::SSO.profile</code> accepts two arguments:</p>
 <ul><li>
-<p>Ruby 2.3+.</p>
+<p><code>code</code> (string) — an opaque string provided by the authorization server; will be exchanged for an Access Token when the user&#39;s profile is sent</p>
+</li><li>
+<p><code>project_id</code> (string) — your application&#39;s WorkOS <a href="https://dashboard.workos.com/sso/configuration">Project ID</a> (ex. <code>project_01JG3BCPTRTSTTWQR4VSHXGWCQ</code>)</p>
 </li></ul>
+
+<p>This method will return an instance of a <code>WorkOS::Profile</code> with the following attributes:</p>
+
+<pre class="code ruby"><code class="ruby">&lt;WorkOS::Profile:0x00007fb6e4193d20
+  @id=&quot;prof_01DRA1XNSJDZ19A31F183ECQW5&quot;,
+  @email=&quot;demo@workos-okta.com&quot;,
+  @first_name=&quot;WorkOS&quot;,
+  @connection_type=&quot;OktaSAML&quot;,
+  @last_name=&quot;Demo&quot;,
+  @idp_id=&quot;00u1klkowm8EGah2H357&quot;,
+&gt;
+</code></pre>
+
+<p>Our Sintatra app can be extended to use this method:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='const'>DOMAIN</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>example.com</span><span class='tstring_end'>&#39;</span></span>
+<span class='const'>PROJECT_ID</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>{projectId}</span><span class='tstring_end'>&#39;</span></span>
+<span class='const'>REDIRECT_URI</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>http://localhost:4567/callback</span><span class='tstring_end'>&#39;</span></span>
+
+<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/auth</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>do</span>
+  <span class='id identifier rubyid_authorization_url'>authorization_url</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="WorkOS.html" title="WorkOS (module)">WorkOS</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="WorkOS/SSO.html" title="WorkOS::SSO (module)">SSO</a></span></span><span class='period'>.</span><span class='id identifier rubyid_authorization_url'><span class='object_link'><a href="WorkOS/SSO.html#authorization_url-class_method" title="WorkOS::SSO.authorization_url (method)">authorization_url</a></span></span><span class='lparen'>(</span>
+    <span class='label'>domain:</span> <span class='const'>DOMAIN</span><span class='comma'>,</span>
+    <span class='label'>project_id:</span> <span class='const'>PROJECT_ID</span><span class='comma'>,</span>
+    <span class='label'>redirect_uri:</span> <span class='const'>REDIRECT_URI</span><span class='comma'>,</span>
+  <span class='rparen'>)</span>
+
+  <span class='id identifier rubyid_redirect'>redirect</span> <span class='id identifier rubyid_authorization_url'>authorization_url</span>
+<span class='kw'>end</span>
+
+<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/callback</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>do</span>
+  <span class='id identifier rubyid_profile'>profile</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="WorkOS.html" title="WorkOS (module)">WorkOS</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="WorkOS/SSO.html" title="WorkOS::SSO (module)">SSO</a></span></span><span class='period'>.</span><span class='id identifier rubyid_profile'><span class='object_link'><a href="WorkOS/SSO.html#profile-class_method" title="WorkOS::SSO.profile (method)">profile</a></span></span><span class='lparen'>(</span>
+    <span class='label'>code:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>code</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
+    <span class='label'>project_id:</span> <span class='const'>PROJECT_ID</span><span class='comma'>,</span>
+  <span class='rparen'>)</span>
+
+  <span class='id identifier rubyid_session'>session</span><span class='lbracket'>[</span><span class='symbol'>:user</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_profile'>profile</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
+
+  <span class='id identifier rubyid_redirect'>redirect</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/</span><span class='tstring_end'>&#39;</span></span>
+<span class='kw'>end</span>
+</code></pre>
+
+<p>Given the <code>WorkOS::Profile</code>, you can now sign the user in according to your own authentication setup.</p>
 </div></div>
 
       <div id="footer">
-  Generated on Wed Dec 18 08:33:35 2019 by
+  Generated on Thu Jan 30 09:12:47 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.20 (ruby-2.4.9).
+  0.9.22 (ruby-2.6.5).
 </div>
 
     </div>

data/docs/file_list.html

@@ -4,9 +4,9 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta charset="utf-8" />
     
-      <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
+      <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
     
-      <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+      <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
     
 
     

data/docs/frames.html

@@ -2,9 +2,9 @@
 <html>
 <head>
   <meta charset="utf-8">
-	<title>Documentation by YARD 0.9.20</title>
+	<title>Documentation by YARD 0.9.22</title>
 </head>
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   var match = unescape(window.location.hash).match(/^#!(.+)/);
   var name = match ? match[1] : 'index.html';
   name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');

data/docs/index.html

@@ -4,15 +4,15 @@
     <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <title>
-  Documentation by YARD 0.9.20
+  Documentation by YARD 0.9.22
   
 </title>
 
-  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = null;
   relpath = '';
 </script>
@@ -52,7 +52,7 @@
         <div class="clear"></div>
       </div>
 
-      <div id="content"><h1 class="noborder title">Documentation by YARD 0.9.20</h1>
+      <div id="content"><h1 class="noborder title">Documentation by YARD 0.9.22</h1>
 <div id="listing">
   <h1 class="alphaindex">Alphabetic Index</h1>
   
@@ -76,12 +76,41 @@
     <td valign='top' width="33%">
       
         
+        <ul id="alpha_A" class="alpha">
+          <li class="letter">A</li>
+          <ul>
+            
+              <li>
+                <span class='object_link'><a href="WorkOS/APIError.html" title="WorkOS::APIError (class)">APIError</a></span>
+                
+                  <small>(WorkOS)</small>
+                
+              </li>
+            
+              <li>
+                <span class='object_link'><a href="WorkOS/AuditLog.html" title="WorkOS::AuditLog (module)">AuditLog</a></span>
+                
+                  <small>(WorkOS)</small>
+                
+              </li>
+            
+              <li>
+                <span class='object_link'><a href="WorkOS/AuthenticationError.html" title="WorkOS::AuthenticationError (class)">AuthenticationError</a></span>
+                
+                  <small>(WorkOS)</small>
+                
+              </li>
+            
+          </ul>
+        </ul>
+      
+        
         <ul id="alpha_B" class="alpha">
           <li class="letter">B</li>
           <ul>
             
               <li>
-                <span class='object_link'><a href="WorkOS/Base.html" title="WorkOS::Base (class)">Base</a></span>
+                <span class='object_link'><a href="WorkOS/Base.html" title="WorkOS::Base (module)">Base</a></span>
                 
                   <small>(WorkOS)</small>
                 
@@ -91,21 +120,29 @@
         </ul>
       
         
-        <ul id="alpha_P" class="alpha">
-          <li class="letter">P</li>
+        <ul id="alpha_C" class="alpha">
+          <li class="letter">C</li>
           <ul>
             
               <li>
-                <span class='object_link'><a href="WorkOS/Profile.html" title="WorkOS::Profile (class)">Profile</a></span>
+                <span class='object_link'><a href="WorkOS/Client.html" title="WorkOS::Client (module)">Client</a></span>
                 
                   <small>(WorkOS)</small>
                 
               </li>
             
+          </ul>
+        </ul>
+      
+        
+        <ul id="alpha_I" class="alpha">
+          <li class="letter">I</li>
+          <ul>
+            
               <li>
-                <span class='object_link'><a href="WorkOS/Types/ProfileStruct.html" title="WorkOS::Types::ProfileStruct (class)">ProfileStruct</a></span>
+                <span class='object_link'><a href="WorkOS/InvalidRequestError.html" title="WorkOS::InvalidRequestError (class)">InvalidRequestError</a></span>
                 
-                  <small>(WorkOS::Types)</small>
+                  <small>(WorkOS)</small>
                 
               </li>
             
@@ -113,17 +150,31 @@
         </ul>
       
         
-        <ul id="alpha_R" class="alpha">
-          <li class="letter">R</li>
+        <ul id="alpha_P" class="alpha">
+          <li class="letter">P</li>
           <ul>
             
               <li>
-                <span class='object_link'><a href="WorkOS/RequestError.html" title="WorkOS::RequestError (class)">RequestError</a></span>
+                <span class='object_link'><a href="WorkOS/Profile.html" title="WorkOS::Profile (class)">Profile</a></span>
                 
                   <small>(WorkOS)</small>
                 
               </li>
             
+              <li>
+                <span class='object_link'><a href="WorkOS/Types/ProfileStruct.html" title="WorkOS::Types::ProfileStruct (class)">ProfileStruct</a></span>
+                
+                  <small>(WorkOS::Types)</small>
+                
+              </li>
+            
+              <li>
+                <span class='object_link'><a href="WorkOS/Types/Provider.html" title="WorkOS::Types::Provider (class)">Provider</a></span>
+                
+                  <small>(WorkOS::Types)</small>
+                
+              </li>
+            
           </ul>
         </ul>
       
@@ -158,6 +209,9 @@
         </ul>
       
         
+          </td><td valign='top' width="33%">
+          
+        
         <ul id="alpha_W" class="alpha">
           <li class="letter">W</li>
           <ul>
@@ -167,6 +221,13 @@
                 
               </li>
             
+              <li>
+                <span class='object_link'><a href="WorkOS/WorkOSError.html" title="WorkOS::WorkOSError (class)">WorkOSError</a></span>
+                
+                  <small>(WorkOS)</small>
+                
+              </li>
+            
           </ul>
         </ul>
       
@@ -179,9 +240,9 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Dec 18 08:33:35 2019 by
+  Generated on Thu Jan 30 09:12:46 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.20 (ruby-2.4.9).
+  0.9.22 (ruby-2.6.5).
 </div>
 
     </div>