speakeasy_ruby_sdk 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a5c7142f13bf9e5fe0b870f84fbde001a0dc208b88274c95af17c224cd026b11
+  data.tar.gz: 150c305a6072b82d34012ee990cd00e7bba4692a05a3afd9c18e060c9afcbf86
+SHA512:
+  metadata.gz: 5e4701dc4f70b099babe9c44c1f4d0083c582de5397cb8d92509824402809a19db505dde9c7b0fdd44aa04a70dbe01fbe1134266c2f9b10085cb3bd8de38b04b
+  data.tar.gz: a9c69ed3438cd68bbe36242087f06f2912d6c1ad3372a1a8260a9417aca7cab6e4530eafa166ac48b681256acacb72deea604b58b59908afd029612081934af0

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,184 @@
+
+![180100416-b66263e6-1607-4465-b45d-0e298a67c397](https://user-images.githubusercontent.com/68016351/181640742-31ab234a-3b39-432e-b899-21037596b360.png)
+
+Speakeasy is your API Platform team as a service. Use our drop in SDK to manage all your API Operations including embeds for request logs and usage dashboards, test case generation from traffic, and understanding API drift.
+
+The Speakeasy Ruby SDK for evaluating API requests/responses. Compatible with any HTTP framework implemented on top of rack.
+
+## Supported Frameworkds
+
+Tested and supported Frameworks include:
+
+* rails
+* sinatra
+
+The Speakeasy Ruby SDK depends only upon Rack, however, so other frameworks should work.
+
+## Installation
+
+Simply install the Speakeasy Ruby SDK gem
+
+```
+  gem install speakeasy_ruby_sdk
+```
+
+or install using bundler
+
+```
+  bundle add speakeasy_ruby_sdk
+```
+
+### Minimum configuration
+
+[Sign up for free on our platform](https://www.speakeasyapi.dev/). After you've created a workspace and generated an API key enable Speakeasy in your API as follows:
+
+For a rails project, configure Speakeasy along with your other Middlewares in your `config/application.rb` function:
+
+```ruby
+    speakeasy_config = {
+      ingestion_server_url: "localhost:443",
+      api_key: "YOUR API KEY HERE",
+      api_id: "YOUR API ID HERE",
+      version_id: "YOUR API VERSION HERE"
+    }
+
+    config.middleware.insert_before 0, SpeakeasyRubySdk::Middleware, speakeasy_config
+```
+
+Build and deploy your app and that's it. Your API is being tracked in the Speakeasy workspace you just created
+and will be visible on the dashboard next time you log in. Visit our [docs site](https://docs.speakeasyapi.dev/) to
+learn more.
+
+**warning** Some common middlewares, like `ActionDispatch::Cookies` remove or rewrite headers in order to provide additional functionality to your app.  In order to capture the original headers, we recommend using the `insert_before` rather than `use`ing so that it will be inserted at the front of the middleware stack.  The middleware will function at any position in the middleware stack, but may not be able to report all information to Speakeasy.
+
+### Tracking Multiple APIs configuration
+
+The Speakeasy SDK is confirgurable using a config parameter. If you want to use the SDK to track multiple Apis or Versions from the same service you can configure individual instances of the SDK, like so:
+
+```ruby
+    speakeasy_config_1 = {
+      api_key: "YOUR API KEY HERE",
+      api_id: "YOUR API ID HERE",
+      version_id: "YOUR API VERSION HERE"
+    }
+    speakeasy_config_2 = {
+      api_key: "YOUR API KEY HERE",
+      api_id: "YOUR API ID HERE",
+      version_id: "YOUR API VERSION HERE"
+    }
+
+    config.middleware.insert_before 0, SpeakeasyRubySdk::Middleware, speakeasy_config_1
+    config.middleware.insert_before 0, SpeakeasyRubySdk::Middleware, speakeasy_config_2
+```
+
+This allows multiple instances of the SDK to be associated with different routers or routes within your service.
+
+### Only Tracking Some Routes
+ 
+We recommend using the approach native to your framework to limit the application of the Speakeasy middleware.  In Rails, that approach is [Engines](https://guides.rubyonrails.org/engines.html), in Sinatra, middleware are `use`'d by controllers, so add the directive to a Controller which is the parent of those routes you wish to track.
+
+## Request Matching
+
+The Speakeasy SDK out of the box will do its best to match requests to your provided OpenAPI Schema. It does this by extracting the path template used by one of the supported routers or frameworks above for each request captured and attempting to match it to the paths defined in the OpenAPI Schema.  In order to enable this functionality include a `routes` directive in your speakeasy configuration - for example in Rails:
+
+```ruby
+  config = {
+    routes: Application.routes,
+    ..snip/..
+  }
+    config.middleware.use SpeakeasyRubySdk::Middleware, config
+
+```
+This isn't always successful or even possible, meaning requests received by Speakeasy will be marked as unmatched, and potentially not associated with your Api, Version or  in the Speakeasy DashApiEndpointsboard.
+
+To help the SDK in these situations you can provide path hints per request handler that match the paths in your OpenAPI Schema:
+
+```ruby
+class YourController < ApplicationController 
+    def action
+      request.env[:path_hint] = '/api/v1/<resource>'
+      ..snip..
+    end
+    ..snip..
+end
+
+```
+
+## Capturing Customer IDs
+
+To help associate requests with customers/users of your APIs you can provide a customer ID from any controller or route:
+
+```ruby
+  def index
+    request.env[:customer_id] = customer_id
+  end
+```
+
+To easily set the `customer_id` on all requests from a Rails controller, use this standard pattern
+
+```ruby
+class MyController < ApplicationController
+    before_action set_customer_id
+
+    def index
+      ..snip..
+    end
+    
+    private
+    
+      def set_customer_id
+        req.env[:customer_id] = @session[:customer_id]
+      end
+end
+```
+
+Note: This is not required, but is highly recommended. By setting a customer ID you can easily associate requests with your customers/users in the Speakeasy Dashboard, powering filters in the Request Viewer.
+
+## Masking sensitive data
+
+Speakeasy can mask sensitive data in the query string parameters, headers, cookies and request/response bodies captured by the SDK. This is useful for maintaining sensitive data isolation, and retaining control over the data that is captured.
+
+Using the Only Tracking Some Routes section above you can completely ignore certain routes, causing the SDK to not selectively capture requests.
+
+But if you would like to be more selective you can mask certain sensitive data using our middleware controller allowing you to mask fields as needed in different handlers:
+
+```ruby
+  config = {
+    ...
+    masking: [
+        SpeakeasyRubySdk::MaskConfig.new(:request_header, ['Authorization'])
+      ],
+  }
+```
+The `masking` section of the config map takes an array of different masking options
+
+  - `SpeakeasyRubySdk::MaskConfig.new(:query_params, attributes, mask_strings)` will mask the specified query params with the optional string mask
+  - `SpeakeasyRubySdk::MaskConfig.new(:request_headers, attributes, mask_strings)` will mask the specified request_headers with the optional string mask
+  - `SpeakeasyRubySdk::MaskConfig.new(:response_headers, attributes, mask_strings)` will mask the specified response headers with the optional string mask
+  - `SpeakeasyRubySdk::MaskConfig.new(:request_cookies, attributes, mask_strings)` will mask the specified request cookies with the optional string mask
+  - `SpeakeasyRubySdk::MaskConfig.new(:response_cookies, attributes, mask_strings)` will mask the specified response cookies with the optional string mask
+  - `SpeakeasyRubySdk::MaskConfig.new(:request_body_string, attributes, mask_strings)` specified request body fields with an optional mask. Supports string fields only. Matches using regex.
+  - `SpeakeasyRubySdk::MaskConfig.new(:request_body_number, attributes, mask_strings)` specified request body fields with an optional mask. Supports numeric fields only. Matches using regex.
+  - `SpeakeasyRubySdk::MaskConfig.new(:response_body_string, attributes, mask_strings)` specified response body fields with an optional mask. Supports string fields only. Matches using regex.
+  - `SpeakeasyRubySdk::MaskConfig.new(:response_body_number, attributes, mask_strings)` specified response body fields with an optional mask. Supports numeric fields only. Matches using regex.
+
+In all of the above instances, you may optionally provide an array of mask strings.  If you leave this field out, or pass an empty array, the system will mask with our default mask value "__masked__" (-12321 for numbers).  If you provide an array with a single value, then the system will mask all matches with that value.  If you provide more than one value, then each match will be replaced by the corresponding mask values (if there are too few, then the remaining matches will receive our default mask value).
+
+You may provide as many MaskConfig objects as you desire.
+
+## Embedded Request Viewer Access Tokens
+
+The Speakeasy SDK can generate access tokens for the [https://docs.speakeasyapi.dev/speakeasy-user-guide/request-viewer/embedded-request-viewer](Embedded Request Viewer) that can be used to view requests captured by the SDK.
+
+For documentation on how to configure filters, find that [https://docs.speakeasyapi.dev/speakeasy-user-guide/request-viewer/embedded-request-viewer](HERE).
+
+You are able to request an `EmbeddedAccessToken` from any location in your application, but most likely you will make such a request inside of a `Controller` method.
+
+```rb
+class MyController < ApplicationController
+
+  def action
+    access_token = SpeakeasyRubySdk::get_embedded_access_token 'customer_id', '=', <some_customer_id>, {api_key: '..snip..'}
+  end
+end
+```

data/lib/speakeasy_ruby_sdk/config.rb

@@ -0,0 +1,60 @@
+module SpeakeasyRubySdk
+  class Middleware
+    class Config
+      attr_accessor :ingestion_server_url, :speakeasy_version, :api_key, :api_id, :version_id, :routes, :masking, :max_capture_size
+      @@max_id_size = 128
+      @@valid_char_re = /[^a-zA-Z0-9.\-_~]/
+
+      def self.default
+        c = Config.new
+        c.ingestion_server_url = "grpc.prod.speakeasyapi.dev:443"
+        c.speakeasy_version = "1.5.0"
+        c.max_capture_size = 1 * 1024 * 1024
+        c
+      end
+
+      def validate
+        errors = []
+        if self.api_key.nil? || self.api_key.empty?
+          errors << "`api_key` is required"
+        end
+
+        if self.api_id.nil? || self.api_id.empty?
+          errors << "`api_id` is required"
+        end
+
+        if !self.api_id.nil? && self.api_id.length > @@max_id_size
+          errors << "`api_id` is too long. Max length is #{@@max_id_size}"
+        end
+
+        if !self.api_id.nil? && @@valid_char_re.match(self.api_id)
+          errors << "`api_id` contains invalid characters."
+        end
+
+        if self.version_id.nil? || self.version_id.empty?
+          errors << "`version_id` is required"
+        end
+
+        if !self.version_id.nil? && self.version_id.length > @@max_id_size
+          errors << "`version_id` is too long. Max length is #{@@max_id_size}"
+        end
+
+        if !self.version_id.nil? && @@valid_char_re.match(self.version_id)
+          errors << "`version_id` contains invalid characters."
+        end
+
+        errors
+      end
+
+      def merge(config)
+        if config
+          if config.class == Hash
+            config.each { |k, v| instance_variable_set "@#{k}", v }
+          end
+        end
+        self
+      end
+
+    end
+  end
+end