RubyGems - workos - Versions diffs - 0.0.2 → 0.1.0 - Mend

workos 0.0.2 → 0.1.0

Files changed (79) hide show

checksums.yaml +4 -4
data/.rubocop.yml +5 -2
data/Gemfile.lock +6 -2
data/README.md +179 -8
data/bin/docs +2 -2
data/codecov.yml +1 -0
data/docs/WorkOS.html +22 -26
data/docs/WorkOS/APIError.html +160 -0
data/docs/WorkOS/AuditLog.html +235 -0
data/docs/WorkOS/AuthenticationError.html +160 -0
data/docs/WorkOS/Base.html +27 -32
data/docs/WorkOS/Client.html +493 -0
data/docs/WorkOS/InvalidRequestError.html +160 -0
data/docs/WorkOS/Profile.html +80 -17
data/docs/WorkOS/RequestError.html +6 -6
data/docs/WorkOS/SSO.html +118 -74
data/docs/WorkOS/Types.html +9 -10
data/docs/WorkOS/Types/ProfileStruct.html +6 -6
data/docs/WorkOS/Types/Provider.html +135 -0
data/docs/WorkOS/WorkOSError.html +447 -0
data/docs/class_list.html +3 -3
data/docs/css/style.css +2 -2
data/docs/file.README.html +173 -13
data/docs/file_list.html +2 -2
data/docs/frames.html +2 -2
data/docs/index.html +77 -16
data/docs/js/app.js +14 -3
data/docs/method_list.html +96 -8
data/docs/top-level-namespace.html +6 -6
data/lib/workos.rb +7 -2
data/lib/workos/audit_log.rb +78 -0
data/lib/workos/base.rb +5 -6
data/lib/workos/client.rb +86 -0
data/lib/workos/errors.rb +48 -0
data/lib/workos/sso.rb +49 -27
data/lib/workos/types.rb +2 -1
data/lib/workos/types/provider_enum.rb +14 -0
data/lib/workos/version.rb +2 -2
data/sorbet/rbi/hidden-definitions/errors.txt +22108 -4368
data/sorbet/rbi/hidden-definitions/hidden.rbi +32490 -6059
data/sorbet/rbi/sorbet-typed/lib/rainbow/all/rainbow.rbi +1 -1
data/sorbet/rbi/todo.rbi +5 -0
data/spec/lib/workos/audit_log_spec.rb +140 -0
data/spec/lib/workos/base_spec.rb +30 -0
data/spec/lib/workos/sso_spec.rb +131 -36
data/spec/spec_helper.rb +21 -1
data/spec/support/fixtures/vcr_cassettes/audit_log/create_event.yml +65 -0
data/spec/support/fixtures/vcr_cassettes/audit_log/create_event_custom_idempotency_key.yml +67 -0
data/spec/support/fixtures/vcr_cassettes/audit_log/create_event_invalid.yml +68 -0
data/spec/support/fixtures/vcr_cassettes/audit_log/create_events_duplicate_idempotency_key_and_payload.yml +131 -0
data/spec/support/fixtures/vcr_cassettes/audit_log/create_events_duplicate_idempotency_key_different_payload.yml +134 -0
data/spec/support/fixtures/vcr_cassettes/base/execute_request_unauthenticated.yml +66 -0
data/workos.gemspec +2 -0
metadata +57 -27
data/lib/workos/request_error.rb +0 -5
data/sorbet/rbi/gems/addressable.rbi +0 -198
data/sorbet/rbi/gems/ast.rbi +0 -47
data/sorbet/rbi/gems/codecov.rbi +0 -19
data/sorbet/rbi/gems/crack.rbi +0 -47
data/sorbet/rbi/gems/docile.rbi +0 -31
data/sorbet/rbi/gems/hashdiff.rbi +0 -65
data/sorbet/rbi/gems/jaro_winkler.rbi +0 -14
data/sorbet/rbi/gems/parallel.rbi +0 -81
data/sorbet/rbi/gems/parser.rbi +0 -856
data/sorbet/rbi/gems/public_suffix.rbi +0 -102
data/sorbet/rbi/gems/rack.rbi +0 -103
data/sorbet/rbi/gems/rainbow.rbi +0 -117
data/sorbet/rbi/gems/rake.rbi +0 -632
data/sorbet/rbi/gems/rspec-core.rbi +0 -1661
data/sorbet/rbi/gems/rspec-expectations.rbi +0 -388
data/sorbet/rbi/gems/rspec-mocks.rbi +0 -823
data/sorbet/rbi/gems/rspec-support.rbi +0 -266
data/sorbet/rbi/gems/rspec.rbi +0 -14
data/sorbet/rbi/gems/rubocop.rbi +0 -7083
data/sorbet/rbi/gems/ruby-progressbar.rbi +0 -304
data/sorbet/rbi/gems/simplecov-html.rbi +0 -30
data/sorbet/rbi/gems/simplecov.rbi +0 -225
data/sorbet/rbi/gems/unicode-display_width.rbi +0 -16
data/sorbet/rbi/gems/webmock.rbi +0 -526

@@ -6,15 +6,15 @@
 <title>
   Module: WorkOS::Types
-    &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 = "WorkOS::Types";
   relpath = '../';
 </script>
@@ -79,7 +79,7 @@
   <dl>
     <dt>Defined in:</dt>
     <dd>lib/workos/types.rb<span class="defines">,<br />
-  lib/workos/types/profile_struct.rb</span>
+  lib/workos/types/provider_enum.rb,<br /> lib/workos/types/profile_struct.rb</span>
 </dd>
   </dl>
@@ -88,8 +88,7 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-<p>WorkOS believes strongly in typed languages, so we&#39;re using Sorbet
-throughout this Ruby gem.</p>
+<p>WorkOS believes strongly in typed languages, so we&#39;re using Sorbet throughout this Ruby gem.</p>
   </div>
@@ -103,7 +102,7 @@ throughout this Ruby gem.</p>
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Types/ProfileStruct.html" title="WorkOS::Types::ProfileStruct (class)">ProfileStruct</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Types/ProfileStruct.html" title="WorkOS::Types::ProfileStruct (class)">ProfileStruct</a></span>, <span class='object_link'><a href="Types/Provider.html" title="WorkOS::Types::Provider (class)">Provider</a></span>
 </p>
@@ -119,9 +118,9 @@ throughout this Ruby gem.</p>
 </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/WorkOS/Types/ProfileStruct.html CHANGED

@@ -6,15 +6,15 @@
 <title>
   Class: WorkOS::Types::ProfileStruct
-    &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 = "WorkOS::Types::ProfileStruct";
   relpath = '../../';
 </script>
@@ -125,9 +125,9 @@
 </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/WorkOS/Types/Provider.html ADDED

@@ -0,0 +1,135 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: WorkOS::Types::Provider
+    &mdash; Documentation by YARD 0.9.22
+</title>
+  <link rel="stylesheet" href="../../css/style.css" type="text/css" />
+  <link rel="stylesheet" href="../../css/common.css" type="text/css" />
+<script type="text/javascript">
+  pathId = "WorkOS::Types::Provider";
+  relpath = '../../';
+</script>
+  <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="../../_index.html">Index (P)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../WorkOS.html" title="WorkOS (module)">WorkOS</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Types.html" title="WorkOS::Types (module)">Types</a></span></span>
+     &raquo;
+    <span class="title">Provider</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../../class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Class: WorkOS::Types::Provider
+</h1>
+<div class="box_info">
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">T::Enum</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">T::Enum</li>
+            <li class="next">WorkOS::Types::Provider</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+    </dd>
+  </dl>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/workos/types/provider_enum.rb</dd>
+  </dl>
+</div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>The ProviderEnum is type-safe declarations of a fixed set of values for SSO Providers.</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+</div>
+      <div id="footer">
+  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.22 (ruby-2.6.5).
+</div>
+    </div>
+  </body>
+</html>

data/docs/WorkOS/WorkOSError.html ADDED

@@ -0,0 +1,447 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Exception: WorkOS::WorkOSError
+    &mdash; Documentation by YARD 0.9.22
+</title>
+  <link rel="stylesheet" href="../css/style.css" type="text/css" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" />
+<script type="text/javascript">
+  pathId = "WorkOS::WorkOSError";
+  relpath = '../';
+</script>
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="../_index.html">Index (W)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../WorkOS.html" title="WorkOS (module)">WorkOS</a></span></span>
+     &raquo;
+    <span class="title">WorkOSError</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Exception: WorkOS::WorkOSError
+</h1>
+<div class="box_info">
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">StandardError</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">StandardError</li>
+            <li class="next">WorkOS::WorkOSError</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+    </dd>
+  </dl>
+  <dl>
+      <dt>Extended by:</dt>
+      <dd>T::Sig</dd>
+  </dl>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/workos/errors.rb</dd>
+  </dl>
+</div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>rubocop:disable Style/Documentation</p>
+  </div>
+</div>
+<div class="tags">
+</div><div id="subclasses">
+  <h2>Direct Known Subclasses</h2>
+  <p class="children"><span class='object_link'><a href="APIError.html" title="WorkOS::APIError (class)">APIError</a></span>, <span class='object_link'><a href="AuthenticationError.html" title="WorkOS::AuthenticationError (class)">AuthenticationError</a></span>, <span class='object_link'><a href="InvalidRequestError.html" title="WorkOS::InvalidRequestError (class)">InvalidRequestError</a></span></p>
+</div>
+  <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
+  <ul class="summary">
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#http_status-instance_method" title="#http_status (instance method)">#<strong>http_status</strong>  &#x21d2; Object </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute http_status.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#request_id-instance_method" title="#request_id (instance method)">#<strong>request_id</strong>  &#x21d2; Object </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute request_id.</p>
+</div></span>
+</li>
+  </ul>
+    <h2>
+      Instance Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(message: nil, http_status: nil, request_id: nil)  &#x21d2; WorkOSError </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of WorkOSError.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+    </ul>
+  <div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+    #<strong>initialize</strong>(message: nil, http_status: nil, request_id: nil)  &#x21d2; <tt><span class='object_link'><a href="" title="WorkOS::WorkOSError (class)">WorkOSError</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns a new instance of WorkOSError.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+19
+20
+21
+22
+23</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/workos/errors.rb', line 19</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>
+  <span class='ivar'>@http_status</span> <span class='op'>=</span> <span class='id identifier rubyid_http_status'>http_status</span>
+  <span class='ivar'>@request_id</span> <span class='op'>=</span> <span class='id identifier rubyid_request_id'>request_id</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+      <span id=""></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="http_status-instance_method">
+    #<strong>http_status</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute http_status.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+9
+10
+11</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/workos/errors.rb', line 9</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_http_status'>http_status</span>
+  <span class='ivar'>@http_status</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="request_id-instance_method">
+    #<strong>request_id</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute request_id.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+10
+11
+12</pre>
+    </td>
+    <td>
+      <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_request_id'>request_id</span>
+  <span class='ivar'>@request_id</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="to_s-instance_method">
+    #<strong>to_s</strong>  &#x21d2; <tt>Object</tt>
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+26
+27
+28
+29
+30</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/workos/errors.rb', line 26</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>
+  <span class='id identifier rubyid_id_string'>id_string</span> <span class='op'>=</span> <span class='ivar'>@request_id</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'> - request ID: </span><span class='embexpr_beg'>#{</span><span class='ivar'>@request_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+  <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_status_string'>status_string</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='ivar'>@message</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id_string'>id_string</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+      <div id="footer">
+  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.22 (ruby-2.6.5).
+</div>
+    </div>
+  </body>
+</html>