fastcomments 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9588e95449c3557fcbf3664870e8e52bc53b33b3dac156fcba54e374d4add258
+  data.tar.gz: 726eba5099ef896b1231e043f06a606ddb83fab59f37979d9b3bd5bdafcdc4d7
+SHA512:
+  metadata.gz: f67506f611434e52eddecbc4a351d2b198f2334d8d42e74f091627ef90dc1c5ac2f654fba43b46b0db03c4efe5855cb5677365f3f80815e25207239d83fce935
+  data.tar.gz: 0c9f4fe046a457defa69792677774e11cc9478395fda36c904ec5986344ee4a3e4a608a864ce3678a02073e17bccb781352a2637a86872b35a84053048578229

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 FastComments
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,210 @@
+# fastcomments
+The FastComments Ruby SDK. You can use this to build secure and scalable backend applications that interact with FastComments, or build reactive client applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fastcomments'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install fastcomments
+```
+
+### Library Contents
+
+This library contains the generated API client and the SSO utilities to make working with the API easier.
+
+- [API Client Library Docs](./client/README.md)
+
+### Public vs Secured APIs
+
+For the API client, there are two classes, `DefaultAPI` and `PublicAPI`. The `DefaultAPI` contains methods that require your API key, and `PublicAPI` contains api calls
+that can be made directly from a browser/mobile device/etc without authentication.
+
+## Quick Start
+
+### Using Authenticated APIs (DefaultAPI)
+
+**Important:** You must set your API key on the ApiClient before making authenticated requests. If you don't, requests will fail with a 401 error.
+
+```ruby
+require 'fastcomments-client'
+
+# Create and configure the API client
+config = FastCommentsClient::Configuration.new
+api_client = FastCommentsClient::ApiClient.new(config)
+
+# REQUIRED: Set your API key (get this from your FastComments dashboard)
+config.api_key['ApiKeyAuth'] = 'YOUR_API_KEY_HERE'
+
+# Create the API instance with the configured client
+api = FastCommentsClient::DefaultAPI.new(api_client)
+
+# Now you can make authenticated API calls
+begin
+  # Example: Add an SSO user
+  user_data = {
+    id: 'user-123',
+    email: 'user@example.com',
+    displayName: 'John Doe'
+  }
+
+  response = api.add_sso_user('YOUR_TENANT_ID', user_data)
+  puts "User created: #{response}"
+
+rescue FastCommentsClient::ApiError => e
+  puts "Error: #{e.response_body}"
+  # Common errors:
+  # - 401: API key is missing or invalid
+  # - 400: Request validation failed
+end
+```
+
+### Using Public APIs (PublicAPI)
+
+Public endpoints don't require authentication:
+
+```ruby
+require 'fastcomments-client'
+
+public_api = FastCommentsClient::PublicAPI.new
+
+begin
+  response = public_api.get_comments_public(
+    tenant_id: 'YOUR_TENANT_ID',
+    url_id: 'page-url-id'
+  )
+  puts response
+rescue FastCommentsClient::ApiError => e
+  puts e.message
+end
+```
+
+### Common Issues
+
+1. **401 "missing-api-key" error**: Make sure you set `config.api_key['ApiKeyAuth'] = 'YOUR_KEY'` before creating the DefaultAPI instance.
+2. **Wrong API class**: Use `DefaultAPI` for server-side authenticated requests, `PublicAPI` for client-side/public requests.
+3. **Null API key**: The SDK will silently skip authentication if the API key is null, leading to 401 errors.
+
+## Notes
+
+### Broadcast Ids
+
+You'll see you're supposed to pass a `broadcastId` in some API calls. When you receive events, you'll get this ID back, so you know to ignore the event if you plan to optimistically apply changes on the client
+(which you'll probably want to do since it offers the best experience). Pass a UUID here. The ID should be unique enough to not occur twice in a browser session.
+
+### SSO (Single Sign-On)
+
+For SSO examples, see below.
+
+## SSO Usage
+
+### Simple SSO
+
+```ruby
+require 'fastcomments'
+require 'fastcomments-client'
+
+# Create Simple SSO token
+user = FastComments::SSO::SimpleSSOUserData.new(
+  user_id: 'user-123',
+  email: 'user@example.com',
+  avatar: 'https://example.com/avatar.jpg'
+)
+
+sso = FastComments::SSO::FastCommentsSSO.new_simple(user)
+token = sso.create_token
+
+puts "SSO Token: #{token}"
+
+# Use the SSO token to make an authenticated API call
+config = FastCommentsClient::Configuration.new
+api_client = FastCommentsClient::ApiClient.new(config)
+public_api = FastCommentsClient::PublicAPI.new(api_client)
+
+response = public_api.get_comments_public(
+  tenant_id: 'your-tenant-id',
+  url_id: 'your-page-url-id',
+  sso: token
+)
+
+puts "Status: #{response}"
+```
+
+### Secure SSO
+
+```ruby
+require 'fastcomments'
+require 'fastcomments-client'
+
+# Create Secure SSO token
+user = FastComments::SSO::SecureSSOUserData.new(
+  user_id: 'user-123',
+  email: 'user@example.com',
+  username: 'johndoe',
+  avatar: 'https://example.com/avatar.jpg'
+)
+
+api_key = 'your-api-key'
+sso = FastComments::SSO::FastCommentsSSO.new_secure(api_key, user)
+token = sso.create_token
+
+puts "Secure SSO Token: #{token}"
+
+# Use the SSO token to make an authenticated API call
+config = FastCommentsClient::Configuration.new
+api_client = FastCommentsClient::ApiClient.new(config)
+public_api = FastCommentsClient::PublicAPI.new(api_client)
+
+response = public_api.get_comments_public(
+  tenant_id: 'your-tenant-id',
+  url_id: 'your-page-url-id',
+  sso: token
+)
+
+puts "Status: #{response}"
+```
+
+## Testing
+
+Set the required environment variables:
+
+```bash
+export FASTCOMMENTS_API_KEY="your-api-key"
+export FASTCOMMENTS_TENANT_ID="your-tenant-id"
+```
+
+Run the tests:
+
+```bash
+bundle exec rspec
+```
+
+## Development
+
+To update the generated client from the OpenAPI spec:
+
+```bash
+./update.sh
+```
+
+This will download the latest OpenAPI spec from a running FastComments server (or use a local copy) and regenerate the client code.
+
+## License
+
+MIT License - see LICENSE file for details
+
+## Support
+
+For support, please visit https://fastcomments.com/auth/my-account/help or email support@fastcomments.com

data/client/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end