v1 client

Author: winrid

.gitignore

@@ -0,0 +1,17 @@
+# Gem files
+*.gem
+.bundle/
+vendor/bundle
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+
+# RSpec
+.rspec_status

Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    fastcomments-ruby (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.6.2)
+    rake (13.3.1)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.7)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.6)
+
+PLATFORMS
+  x86_64-linux-gnu
+
+DEPENDENCIES
+  fastcomments-ruby!
+  rake (~> 13.0)
+  rspec (~> 3.12)
+
+BUNDLED WITH
+   2.4.20

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.

README.md

@@ -0,0 +1,210 @@
+# fastcomments-ruby
+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-ruby'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install fastcomments-ruby
+```
+
+### 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: '[email protected]',
+    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: '[email protected]',
+  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: '[email protected]',
+  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 [email protected]

Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

client/.gitignore

@@ -0,0 +1,39 @@
+# Generated by: https://openapi-generator.tech
+#
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

client/.gitlab-ci.yml

@@ -0,0 +1,26 @@
+.ruby: &ruby
+  variables:
+    LANG: "C.UTF-8"
+  before_script:
+    - ruby -v
+    - bundle config set --local deployment true
+    - bundle install -j $(nproc)
+  parallel:
+    matrix:
+      - RUBY_VERSION: ['2.7', '3.0', '3.1']
+  image: "ruby:$RUBY_VERSION"
+  cache:
+    paths:
+      - vendor/ruby
+    key: 'ruby-$RUBY_VERSION'
+
+gem:
+  extends: .ruby
+  script:
+    - bundle exec rspec
+    - bundle exec rake build
+    - bundle exec rake install
+  artifacts:
+    paths:
+      - pkg/*.gem
+

client/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md