workos 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70741b6fe93402cbd090a16e41cf7ea2cb6df08073f1bdb95c0fc8ab06f7e5b5
-  data.tar.gz: 0a2726acf7ca96b490c4c66585dd3cf9ad0f70f89ec00991d69460ec8ec4907d
+  metadata.gz: 13b44f46640b8e437a8202d958cc545ddbb95f04d9ab1ae2e56153531c5c0cef
+  data.tar.gz: 538208b90831666360053a2cbb7b732c43a64299523c5649858e16f4a2553cde
 SHA512:
-  metadata.gz: 2d3d401843a2d5a19adf7a1ebb9e6c8cdf49228702cd93bf82fe5c2cb368ad9770bffe0a567d9e2e94772df4dad4ecbb2f594a37de9ddba3f8334648a270ec9e
-  data.tar.gz: a0a7f900ad0d0a60ccfb3aa8f5ac20e2f19dd0577cd27d9ecde782b4740ad50ef4bc2fbc326bca03fa7b7a55950bdfc73ef91db59c05904097ee753b79e09f59
+  metadata.gz: 4699ed5040947a19c420caaca3f1bd3bf5443398ec2cdcfda1aed6e03ac05c874158e139cdce87f8dd44e26804b62fa0786700c8c156e3f1cf1457e7bf3174a3
+  data.tar.gz: 8c65f6603e50ccf76b0179c9bee721ca3aaae64ce749fe91b5daa3c9c0f57db74049944f1d0cf89b2755dfd38ddbbd4e8dfc3d3f7cdf3e99cb88077c54fac9f9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (0.1.0)
+    workos (0.1.1)
       sorbet-runtime (~> 0.5)
 
 GEM
@@ -56,7 +56,7 @@ GEM
     simplecov-html (0.10.2)
     sorbet (0.5.5181)
       sorbet-static (= 0.5.5181)
-    sorbet-runtime (0.5.5182)
+    sorbet-runtime (0.5.5373)
     sorbet-static (0.5.5181-universal-darwin-14)
     unicode-display_width (1.6.0)
     url (0.3.2)

data/docs/WorkOS.html

@@ -88,7 +88,7 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
     
-<p>typed: strict</p>
+<p>Use the WorkOS module to authenticate your requests to the WorkOS API. The gem will read your API key automatically from the ENV var `WORKOS_KEY`. Alternatively, you can set the key yourself with `WorkOS.key = [your api key]` somewhere in the load path of your application, such as an initializer.</p>
 
 
   </div>
@@ -120,12 +120,12 @@
         <dt id="API_HOSTNAME-constant" class="">API_HOSTNAME =
           
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>api.workos.com</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+        <dd><pre class="code"><span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>WORKOS_API_HOSTNAME</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>api.workos.com</span><span class='tstring_end'>&#39;</span></span></pre></dd>
       
         <dt id="VERSION-constant" class="">VERSION =
           
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.1.0</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.1.1</span><span class='tstring_end'>&#39;</span></span></pre></dd>
       
     </dl>
   
@@ -314,7 +314,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jan 30 09:12:47 2020 by
+  Generated on Mon Mar  2 13:26:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.22 (ruby-2.6.5).
 </div>

data/docs/WorkOS/APIError.html

@@ -150,7 +150,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jan 30 09:12:47 2020 by
+  Generated on Mon Mar  2 13:26:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.22 (ruby-2.6.5).
 </div>

data/docs/WorkOS/AuditLog.html

@@ -225,7 +225,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jan 30 09:12:47 2020 by
+  Generated on Mon Mar  2 13:26:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.22 (ruby-2.6.5).
 </div>

data/docs/WorkOS/AuthenticationError.html

@@ -150,7 +150,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jan 30 09:12:47 2020 by
+  Generated on Mon Mar  2 13:26:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.22 (ruby-2.6.5).
 </div>

data/docs/WorkOS/Base.html

@@ -93,7 +93,18 @@
   
 </div>
 
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>The Base class handles setting and reading the WorkOS API Key for authentication</p>
+
 
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
 
 
 
@@ -197,12 +208,12 @@
       <pre class="lines">
 
 
-13
-14
-15</pre>
+15
+16
+17</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/workos/base.rb', line 13</span>
+      <pre class="code"><span class="info file"># File 'lib/workos/base.rb', line 15</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_key'>key</span>
   <span class='ivar'>@key</span>
@@ -245,12 +256,12 @@
       <pre class="lines">
 
 
-7
-8
-9</pre>
+9
+10
+11</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/workos/base.rb', line 7</span>
+      <pre class="code"><span class="info file"># File 'lib/workos/base.rb', line 9</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_key'>key</span>
   <span class='ivar'>@key</span>
@@ -266,7 +277,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jan 30 09:12:47 2020 by
+  Generated on Mon Mar  2 13:26:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.22 (ruby-2.6.5).
 </div>

data/docs/WorkOS/Client.html

@@ -98,7 +98,18 @@
   
 </div>
 
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>A Net::HTTP based API client for interacting with the WorkOS API</p>
+
 
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
 
 
 
@@ -249,17 +260,17 @@
       <pre class="lines">
 
 
-11
 12
 13
 14
 15
 16
 17
-18</pre>
+18
+19</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/workos/client.rb', line 11</span>
+      <pre class="code"><span class="info file"># File 'lib/workos/client.rb', line 12</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
   <span class='kw'>return</span> <span class='ivar'>@client</span> <span class='kw'>if</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='rparen'>)</span>
@@ -289,17 +300,17 @@
       <pre class="lines">
 
 
-21
 22
 23
 24
 25
 26
 27
-28</pre>
+28
+29</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/workos/client.rb', line 21</span>
+      <pre class="code"><span class="info file"># File 'lib/workos/client.rb', line 22</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_execute_request'>execute_request</span><span class='lparen'>(</span><span class='label'>request:</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
@@ -329,7 +340,6 @@
       <pre class="lines">
 
 
-53
 54
 55
 56
@@ -358,10 +368,11 @@
 79
 80
 81
-82</pre>
+82
+83</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/workos/client.rb', line 53</span>
+      <pre class="code"><span class="info file"># File 'lib/workos/client.rb', line 54</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_handle_error_response'>handle_error_response</span><span class='lparen'>(</span><span class='label'>response:</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_http_status'>http_status</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
@@ -413,15 +424,15 @@
       <pre class="lines">
 
 
-31
 32
 33
 34
 35
-36</pre>
+36
+37</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/workos/client.rb', line 31</span>
+      <pre class="code"><span class="info file"># File 'lib/workos/client.rb', line 32</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_post_request'>post_request</span><span class='lparen'>(</span><span class='label'>path:</span><span class='comma'>,</span> <span class='label'>body:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_request'>request</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Post</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
@@ -449,7 +460,6 @@
       <pre class="lines">
 
 
-39
 40
 41
 42
@@ -458,10 +468,11 @@
 45
 46
 47
-48</pre>
+48
+49</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/workos/client.rb', line 39</span>
+      <pre class="code"><span class="info file"># File 'lib/workos/client.rb', line 40</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_user_agent'>user_agent</span>
   <span class='id identifier rubyid_engine'>engine</span> <span class='op'>=</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='op'>::</span><span class='const'>RUBY_ENGINE</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='op'>::</span><span class='const'>RUBY_ENGINE</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Ruby</span><span class='tstring_end'>&#39;</span></span>
@@ -483,7 +494,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jan 30 09:12:47 2020 by
+  Generated on Mon Mar  2 13:26:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.22 (ruby-2.6.5).
 </div>

data/docs/WorkOS/InvalidRequestError.html

@@ -150,7 +150,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jan 30 09:12:47 2020 by
+  Generated on Mon Mar  2 13:26:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.22 (ruby-2.6.5).
 </div>

data/docs/WorkOS/Profile.html

@@ -778,7 +778,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jan 30 09:12:47 2020 by
+  Generated on Mon Mar  2 13:26:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.22 (ruby-2.6.5).
 </div>

data/docs/WorkOS/SSO.html

@@ -187,6 +187,30 @@
 <p>Fetch the profile details for the authenticated SSO user.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#promote_draft_connection-class_method" title="promote_draft_connection (class method)">.<strong>promote_draft_connection</strong>(token:)  &#x21d2; Bool </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Promote a DraftConnection created via IdP Link Embed such that the Enterprise users can begin signing into your application.</p>
+</div></span>
+  
 </li>
 
       
@@ -538,6 +562,118 @@
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="promote_draft_connection-class_method">
+  
+    .<strong>promote_draft_connection</strong>(token:)  &#x21d2; <tt>Bool</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Promote a DraftConnection created via IdP Link Embed such that the Enterprise users can begin signing into your application.</p>
+
+<p>you by the IdP Link Embed</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+  <div class="examples">
+    <p class="tag_title">Examples:</p>
+    
+      
+      <pre class="example code"><code>WorkOS::SSO.promote_draft_connection(
+  token: &#39;draft_conn_429u59js&#39;,
+)
+=&gt; true</code></pre>
+    
+  </div>
+<p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>token</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The draft connection token that&#39;s been provided to</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Bool</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><ul><li>
+<p>returns `true` if successful, `false` otherwise.</p>
+</li></ul>
+</div>
+      
+    </li>
+  
+</ul>
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><a href="https://github.com/workos-inc/ruby-idp-link-example" target="_parent" title="https://github.com/workos-inc/ruby-idp-link-example">https://github.com/workos-inc/ruby-idp-link-example</a></li>
+    
+  </ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+142
+143
+144
+145
+146
+147
+148
+149
+150</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/workos/sso.rb', line 142</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_promote_draft_connection'>promote_draft_connection</span><span class='lparen'>(</span><span class='label'>token:</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_request'>request</span> <span class='op'>=</span> <span class='id identifier rubyid_bearer_post_request'>bearer_post_request</span><span class='lparen'>(</span>
+    <span class='label'>path:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/draft_connections/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_token'>token</span><span class='embexpr_end'>}</span><span class='tstring_content'>/activate</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
+  <span class='rparen'>)</span>
+
+  <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
+
+  <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTPSuccess</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
   </div>
@@ -545,7 +681,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jan 30 09:12:47 2020 by
+  Generated on Mon Mar  2 13:26:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.22 (ruby-2.6.5).
 </div>

data/docs/WorkOS/Types.html

@@ -118,7 +118,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jan 30 09:12:47 2020 by
+  Generated on Mon Mar  2 13:26:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.22 (ruby-2.6.5).
 </div>

data/docs/WorkOS/Types/ProfileStruct.html

@@ -125,7 +125,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jan 30 09:12:47 2020 by
+  Generated on Mon Mar  2 13:26:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.22 (ruby-2.6.5).
 </div>

data/docs/WorkOS/Types/Provider.html

@@ -125,7 +125,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jan 30 09:12:47 2020 by
+  Generated on Mon Mar  2 13:26:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.22 (ruby-2.6.5).
 </div>

data/docs/WorkOS/WorkOSError.html

@@ -109,7 +109,7 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
     
-<p>rubocop:disable Style/Documentation</p>
+<p>Parent class for WorkOS related errors</p>
 
 
   </div>
@@ -281,14 +281,14 @@
       <pre class="lines">
 
 
-19
 20
 21
 22
-23</pre>
+23
+24</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/workos/errors.rb', line 19</span>
+      <pre class="code"><span class="info file"># File 'lib/workos/errors.rb', line 20</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>message:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>http_status:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>request_id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
   <span class='ivar'>@message</span> <span class='op'>=</span> <span class='id identifier rubyid_message'>message</span>
@@ -333,12 +333,12 @@
       <pre class="lines">
 
 
-9
 10
-11</pre>
+11
+12</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/workos/errors.rb', line 9</span>
+      <pre class="code"><span class="info file"># File 'lib/workos/errors.rb', line 10</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_http_status'>http_status</span>
   <span class='ivar'>@http_status</span>
@@ -376,12 +376,12 @@
       <pre class="lines">
 
 
-10
 11
-12</pre>
+12
+13</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/workos/errors.rb', line 10</span>
+      <pre class="code"><span class="info file"># File 'lib/workos/errors.rb', line 11</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_request_id'>request_id</span>
   <span class='ivar'>@request_id</span>
@@ -413,14 +413,14 @@
       <pre class="lines">
 
 
-26
 27
 28
 29
-30</pre>
+30
+31</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/workos/errors.rb', line 26</span>
+      <pre class="code"><span class="info file"># File 'lib/workos/errors.rb', line 27</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
   <span class='id identifier rubyid_status_string'>status_string</span> <span class='op'>=</span> <span class='ivar'>@http_status</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Status </span><span class='embexpr_beg'>#{</span><span class='ivar'>@http_status</span><span class='embexpr_end'>}</span><span class='tstring_content'>, </span><span class='tstring_end'>&quot;</span></span>
@@ -437,7 +437,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jan 30 09:12:47 2020 by
+  Generated on Mon Mar  2 13:26:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.22 (ruby-2.6.5).
 </div>

data/docs/file.README.html

@@ -242,7 +242,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Thu Jan 30 09:12:47 2020 by
+  Generated on Mon Mar  2 13:26:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.22 (ruby-2.6.5).
 </div>

data/docs/index.html

@@ -240,7 +240,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jan 30 09:12:46 2020 by
+  Generated on Mon Mar  2 13:26:47 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.22 (ruby-2.6.5).
 </div>

data/docs/method_list.html

@@ -166,7 +166,7 @@
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="WorkOS/Base.html#key-instance_method" title="WorkOS::Base#key (method)">#key</a></span>
+      <span class='object_link'><a href="WorkOS/Base.html#key-class_method" title="WorkOS::Base.key (method)">key</a></span>
       <small>WorkOS::Base</small>
     </div>
   </li>
@@ -174,7 +174,7 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="WorkOS/Base.html#key-class_method" title="WorkOS::Base.key (method)">key</a></span>
+      <span class='object_link'><a href="WorkOS/Base.html#key-instance_method" title="WorkOS::Base#key (method)">#key</a></span>
       <small>WorkOS::Base</small>
     </div>
   </li>
@@ -221,6 +221,14 @@
   
 
   <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="WorkOS/SSO.html#promote_draft_connection-class_method" title="WorkOS::SSO.promote_draft_connection (method)">promote_draft_connection</a></span>
+      <small>WorkOS::SSO</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="WorkOS/WorkOSError.html#request_id-instance_method" title="WorkOS::WorkOSError#request_id (method)">#request_id</a></span>
       <small>WorkOS::WorkOSError</small>
@@ -228,7 +236,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="WorkOS/Profile.html#to_json-instance_method" title="WorkOS::Profile#to_json (method)">#to_json</a></span>
       <small>WorkOS::Profile</small>
@@ -236,7 +244,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="WorkOS/WorkOSError.html#to_s-instance_method" title="WorkOS::WorkOSError#to_s (method)">#to_s</a></span>
       <small>WorkOS::WorkOSError</small>
@@ -244,7 +252,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="WorkOS/Client.html#user_agent-instance_method" title="WorkOS::Client#user_agent (method)">#user_agent</a></span>
       <small>WorkOS::Client</small>

data/docs/top-level-namespace.html

@@ -100,7 +100,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jan 30 09:12:47 2020 by
+  Generated on Mon Mar  2 13:26:48 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.22 (ruby-2.6.5).
 </div>

data/lib/workos.rb

@@ -11,7 +11,7 @@ require 'sorbet-runtime'
 # `WorkOS.key = [your api key]` somewhere in the load path of
 # your application, such as an initializer.
 module WorkOS
-  API_HOSTNAME = 'api.workos.com'
+  API_HOSTNAME = ENV['WORKOS_API_HOSTNAME'] || 'api.workos.com'
 
   def self.key=(value)
     Base.key = value

data/lib/workos/base.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 # typed: true
 
-# rubocop:disable Style/Documentation
+
 module WorkOS
+  ## The Base class handles setting and reading the WorkOS
+  ## API Key for authentication
   module Base
     attr_accessor :key
 
@@ -14,4 +16,3 @@ module WorkOS
     end
   end
 end
-# rubocop:enable Style/Documentation

data/lib/workos/client.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 # typed: true
 
-# rubocop:disable Style/Documentation
+
 module WorkOS
+  # A Net::HTTP based API client for interacting with the WorkOS API
   module Client
     extend T::Sig
     include Kernel
@@ -83,4 +84,3 @@ module WorkOS
     # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
   end
 end
-# rubocop:enable Style/Documentation

data/lib/workos/errors.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 # typed: true
 
+
 module WorkOS
-  # rubocop:disable Style/Documentation
+  # Parent class for WorkOS related errors
   class WorkOSError < StandardError
     extend T::Sig
 
@@ -43,6 +44,4 @@ module WorkOS
   # InvalidRequestError is raised when a request is initiated with invalid
   # parameters.
   class InvalidRequestError < WorkOSError; end
-
-  # rubocop:enable Style/Documentation
 end

data/lib/workos/sso.rb

@@ -119,6 +119,36 @@ module WorkOS
         WorkOS::Profile.new(response.body)
       end
 
+      sig do
+        params(
+          token: String,
+        ).returns(T::Boolean)
+      end
+
+      # Promote a DraftConnection created via IdP Link Embed such that the
+      # Enterprise users can begin signing into your application.
+      #
+      # @param [String] token The draft connection token that's been provided to
+      # you by the IdP Link Embed
+      #
+      # @example
+      #   WorkOS::SSO.promote_draft_connection(
+      #     token: 'draft_conn_429u59js',
+      #   )
+      #   => true
+      #
+      # @return [Bool] - returns `true` if successful, `false` otherwise.
+      # @see https://github.com/workos-inc/ruby-idp-link-example
+      def promote_draft_connection(token:)
+        request = bearer_post_request(
+          path: "/draft_connections/#{token}/activate",
+        )
+
+        response = client.request(request)
+
+        response.is_a? Net::HTTPSuccess
+      end
+
       private
 
       sig do
@@ -158,6 +188,12 @@ module WorkOS
         )
       end
       # rubocop:enable Metrics/MethodLength
+
+      def bearer_post_request(path:, body: nil)
+        request = post_request(path: path, body: body)
+        request['Authorization'] = "Bearer #{WorkOS.key!}"
+        request
+      end
     end
   end
 end

data/lib/workos/types.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# typed: strong
+# typed: strict
 
 
 module WorkOS

data/lib/workos/types/provider_enum.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 # typed: strict
 
+
 module WorkOS
   module Types
     # The ProviderEnum is type-safe declarations of a

data/lib/workos/version.rb

@@ -3,5 +3,5 @@
 
 
 module WorkOS
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/spec/lib/workos/sso_spec.rb

@@ -210,4 +210,41 @@ describe WorkOS::SSO do
       end
     end
   end
+
+  describe '.promote_draft_connection' do
+    let(:token) { 'draft_conn_id' }
+    let(:project_id) { 'proj_0239u590h' }
+
+    context 'with a valid request' do
+      before do
+        stub_request(
+          :post,
+          "https://api.workos.com/draft_connections/#{token}/activate",
+        ).to_return(status: 200)
+      end
+      it 'returns true' do
+        response = described_class.promote_draft_connection(
+          token: token,
+        )
+
+        expect(response).to be(true)
+      end
+    end
+
+    context 'with an invalid request' do
+      before do
+        stub_request(
+          :post,
+          "https://api.workos.com/draft_connections/#{token}/activate",
+        ).to_return(status: 403)
+      end
+      it 'returns true' do
+        response = described_class.promote_draft_connection(
+          token: token,
+        )
+
+        expect(response).to be(false)
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: workos
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - WorkOS
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-31 00:00:00.000000000 Z
+date: 2020-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime