workos 0.0.2 → 0.1.0

data/docs/js/app.js

@@ -171,6 +171,7 @@ function generateTOC() {
   var counter = 0;
   var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
   var i;
+  var curli;
   if ($('#filecontents h1').length > 1) tags.unshift('h1');
   for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
   var lastTag = parseInt(tags[0][1], 10);
@@ -190,15 +191,25 @@ function generateTOC() {
     }
     if (thisTag > lastTag) {
       for (i = 0; i < thisTag - lastTag; i++) {
-        var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
+        if ( typeof(curli) == "undefined" ) {
+          curli = $('<li/>');
+          toc.append(curli);
+        }
+        toc = $('<ol/>');
+        curli.append(toc);
+        curli = undefined;
       }
     }
     if (thisTag < lastTag) {
-      for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
+      for (i = 0; i < lastTag - thisTag; i++) {
+        toc = toc.parent();
+        toc = toc.parent();
+      }
     }
     var title = $(this).attr('toc-title');
     if (typeof(title) == "undefined") title = $(this).text();
-    toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
+    curli =$('<li><a href="#' + this.id + '">' + title + '</a></li>'); 
+    toc.append(curli);
     lastTag = thisTag;
   });
   if (!show) return;

data/docs/method_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" />
     
 
     
@@ -53,6 +53,14 @@
   
 
   <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="WorkOS/Client.html#client-instance_method" title="WorkOS::Client#client (method)">#client</a></span>
+      <small>WorkOS::Client</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="WorkOS/Profile.html#connection_type-instance_method" title="WorkOS::Profile#connection_type (method)">#connection_type</a></span>
       <small>WorkOS::Profile</small>
@@ -60,6 +68,14 @@
   </li>
   
 
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="WorkOS/AuditLog.html#create_event-class_method" title="WorkOS::AuditLog.create_event (method)">create_event</a></span>
+      <small>WorkOS::AuditLog</small>
+    </div>
+  </li>
+  
+
   <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="WorkOS/Profile.html#email-instance_method" title="WorkOS::Profile#email (method)">#email</a></span>
@@ -69,6 +85,14 @@
   
 
   <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="WorkOS/Client.html#execute_request-instance_method" title="WorkOS::Client#execute_request (method)">#execute_request</a></span>
+      <small>WorkOS::Client</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="WorkOS/Profile.html#first_name-instance_method" title="WorkOS::Profile#first_name (method)">#first_name</a></span>
       <small>WorkOS::Profile</small>
@@ -76,7 +100,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="WorkOS/Profile.html#full_name-instance_method" title="WorkOS::Profile#full_name (method)">#full_name</a></span>
       <small>WorkOS::Profile</small>
@@ -84,7 +108,23 @@
   </li>
   
 
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="WorkOS/Client.html#handle_error_response-instance_method" title="WorkOS::Client#handle_error_response (method)">#handle_error_response</a></span>
+      <small>WorkOS::Client</small>
+    </div>
+  </li>
+  
+
   <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="WorkOS/WorkOSError.html#http_status-instance_method" title="WorkOS::WorkOSError#http_status (method)">#http_status</a></span>
+      <small>WorkOS::WorkOSError</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="WorkOS/Profile.html#id-instance_method" title="WorkOS::Profile#id (method)">#id</a></span>
       <small>WorkOS::Profile</small>
@@ -92,7 +132,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="WorkOS/Profile.html#idp_id-instance_method" title="WorkOS::Profile#idp_id (method)">#idp_id</a></span>
       <small>WorkOS::Profile</small>
@@ -100,6 +140,14 @@
   </li>
   
 
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="WorkOS/WorkOSError.html#initialize-instance_method" title="WorkOS::WorkOSError#initialize (method)">#initialize</a></span>
+      <small>WorkOS::WorkOSError</small>
+    </div>
+  </li>
+  
+
   <li class="even ">
     <div class="item">
       <span class='object_link'><a href="WorkOS/Profile.html#initialize-instance_method" title="WorkOS::Profile#initialize (method)">#initialize</a></span>
@@ -110,8 +158,8 @@
 
   <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>
-      <small>WorkOS::Base</small>
+      <span class='object_link'><a href="WorkOS.html#key-class_method" title="WorkOS.key (method)">key</a></span>
+      <small>WorkOS</small>
     </div>
   </li>
   
@@ -126,8 +174,8 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="WorkOS.html#key-class_method" title="WorkOS.key (method)">key</a></span>
-      <small>WorkOS</small>
+      <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>
   
@@ -157,6 +205,14 @@
   
 
   <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="WorkOS/Client.html#post_request-instance_method" title="WorkOS::Client#post_request (method)">#post_request</a></span>
+      <small>WorkOS::Client</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="WorkOS/SSO.html#profile-class_method" title="WorkOS::SSO.profile (method)">profile</a></span>
       <small>WorkOS::SSO</small>
@@ -164,6 +220,38 @@
   </li>
   
 
+  <li class="odd ">
+    <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>
+    </div>
+  </li>
+  
+
+  <li class="even ">
+    <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>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
+    <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>
+    </div>
+  </li>
+  
+
+  <li class="even ">
+    <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>
+    </div>
+  </li>
+  
+
 
       </ul>
     </div>

data/docs/top-level-namespace.html

@@ -6,15 +6,15 @@
 <title>
   Top Level Namespace
   
-    &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 = "";
   relpath = '';
 </script>
@@ -100,9 +100,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/lib/workos.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 # typed: true
 
-
 require 'workos/version'
 require 'sorbet-runtime'
 
@@ -28,9 +27,15 @@ module WorkOS
 
   autoload :Types, 'workos/types'
   autoload :Base, 'workos/base'
+  autoload :Client, 'workos/client'
+  autoload :AuditLog, 'workos/audit_log'
   autoload :Profile, 'workos/profile'
-  autoload :RequestError, 'workos/request_error'
   autoload :SSO, 'workos/sso'
 
+  # Errors
+  autoload :APIError, 'workos/errors'
+  autoload :AuthenticationError, 'workos/errors'
+  autoload :InvalidRequestError, 'workos/errors'
+
   WorkOS.key = ENV['WORKOS_KEY'] unless ENV['WORKOS_KEY'].nil?
 end

data/lib/workos/audit_log.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+# typed: true
+
+require 'net/http'
+require 'uri'
+
+module WorkOS
+  # The Audit Log module provides convenience methods for working with the
+  # WorkOS Audit Log platform. You'll need a valid API key.
+  #
+  # @see https://dashboard.workos.com/docs/audit-log/quickstart
+  module AuditLog
+    class << self
+      extend T::Sig
+      include Base
+      include Client
+
+      # Create an Audit Log event.
+      #
+      # @param [Hash] event An event hash
+      # @option event [String] group A single organization containing related
+      #  members. This will normally be the customer of a vendor's application.
+      # @option event [String] location Identifier for where the event
+      #  originated. This will be an IP address (IPv4 or IPv6), hostname, or
+      #  device ID.
+      # @option event [String] action Specific activity performed by the actor.
+      # @option event [String] action_type Corresponding CRUD category of the
+      #  event. Can be one of C, R, U, or D.
+      # @option event [String] actor_name Display name of the entity performing
+      #  the action.
+      # @option event [String] actor_id Unique identifier of the entity
+      #  performing the action.
+      # @option event [String] target_name Display name of the object or
+      #  resource that is being acted upon.
+      # @option event [String] target_id Unique identifier of the object or
+      #  resource being acted upon.
+      # @option event [String] occurred_at ISO-8601 datetime at which the event
+      #  happened, with millisecond precision.
+      # @option event [Hash] metadata Arbitrary key-value data containing
+      #  information associated with the event. Note: There is a limit of 50
+      #  keys. Key names can be up to 40 characters long, and values can be up
+      #  to 500 characters long.
+      # @param [String] idempotency_key An idempotency key
+      sig do
+        params(
+          event: Hash,
+          idempotency_key: T.nilable(String),
+        ).returns(::T.untyped)
+      end
+
+      def create_event(event:, idempotency_key: nil)
+        request = post_request(
+          path: '/events',
+          idempotency_key: idempotency_key,
+          body: event,
+        )
+
+        execute_request(request: request)
+      end
+
+      private
+
+      sig do
+        params(
+          path: String,
+          idempotency_key: T.nilable(String),
+          body: T.nilable(Hash),
+        ).returns(Net::HTTP::Post)
+      end
+      def post_request(path:, idempotency_key: nil, body: nil)
+        request = super(path: path, body: body)
+        request['Authorization'] = "Bearer #{WorkOS.key}"
+        request['Idempotency-Key'] = idempotency_key if idempotency_key
+        request
+      end
+    end
+  end
+end

data/lib/workos/base.rb

@@ -1,16 +1,15 @@
 # frozen_string_literal: true
 # typed: true
-# rubocop:disable Style/Documentation
-
 
+# rubocop:disable Style/Documentation
 module WorkOS
-  class Base
+  module Base
     attr_accessor :key
-    class << self
-      attr_writer :key
-    end
 
     class << self
+      extend T::Sig
+
+      attr_writer :key
       attr_reader :key
     end
   end

data/lib/workos/client.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+# typed: true
+
+# rubocop:disable Style/Documentation
+module WorkOS
+  module Client
+    extend T::Sig
+    include Kernel
+
+    sig { returns(Net::HTTP) }
+    def client
+      return @client if defined?(@client)
+
+      @client = Net::HTTP.new(WorkOS::API_HOSTNAME, 443)
+      @client.use_ssl = true
+
+      @client
+    end
+
+    sig { params(request: Net::HTTP::Post).returns(::T.untyped) }
+    def execute_request(request:)
+      response = client.request(request)
+
+      http_status = response.code.to_i
+      handle_error_response(response: response) if http_status >= 400
+
+      response
+    end
+
+    sig { params(path: String, body: T.nilable(Hash)).returns(Net::HTTP::Post) }
+    def post_request(path:, body: nil)
+      request = Net::HTTP::Post.new(path, 'Content-Type' => 'application/json')
+      request.body = body.to_json if body
+      request['User-Agent'] = user_agent
+      request
+    end
+
+    sig { returns(String) }
+    def user_agent
+      engine = defined?(::RUBY_ENGINE) ? ::RUBY_ENGINE : 'Ruby'
+
+      [
+        'WorkOS',
+        "#{engine}/#{RUBY_VERSION}",
+        RUBY_PLATFORM,
+        "v#{WorkOS::VERSION}"
+      ].join('; ')
+    end
+
+
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    sig { params(response: ::T.untyped).void }
+    def handle_error_response(response:)
+      http_status = response.code.to_i
+      json = JSON.parse(response.body)
+
+      case http_status
+      when 400
+        raise InvalidRequestError.new(
+          message: json['message'],
+          http_status: http_status,
+          request_id: response['x-request-id'],
+        )
+      when 401
+        raise AuthenticationError.new(
+          message: json['message'],
+          http_status: http_status,
+          request_id: response['x-request-id'],
+        )
+      when 422
+        errors = json['errors'].map do |error|
+          "#{error['field']}: #{error['code']}"
+        end.join('; ')
+
+        message = "#{json['message']} (#{errors})"
+        raise InvalidRequestError.new(
+          message: message,
+          http_status: http_status,
+          request_id: response['x-request-id'],
+        )
+      end
+    end
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+  end
+end
+# rubocop:enable Style/Documentation