RubyGems - onetime - Versions diffs - 0.6.0 → 0.7.0 - Mend

onetime 0.6.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

checksums.yaml +4 -4
data/README.md +10 -240
metadata +19 -18
data/CHANGES.txt +0 -102
data/lib/onetime/client.rb +0 -100
data/lib/onetime/configuration.rb +0 -156
data/lib/onetime/errors.rb +0 -160
data/lib/onetime/resources/receipts.rb +0 -70
data/lib/onetime/resources/secrets.rb +0 -134
data/lib/onetime/response.rb +0 -72
data/lib/onetime/transport.rb +0 -224
data/lib/onetime/version.rb +0 -11
data/lib/onetime.rb +0 -33

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a9d766fe9b66ef0f5617b2447910c268af2700b7bb70c59574f62033b712ad2
-  data.tar.gz: e1737aa5ee4f29fd5a63c8951bed264c614f9fb2f747e01c73396ac8e0a4bc27
+  metadata.gz: 0220be9c2e382cae289a9c9f350a2ed9fc1541da377800216b0b06ff7e93671e
+  data.tar.gz: 6fe4dd6670c7ea344c4af9dff5826eca2d93abfe7910690d2fab465ff9310a98
 SHA512:
-  metadata.gz: 878bb56df14b1ede5daccac8f08c652c29a4eed12ea1295730f8e322bc44449b5333a8d2967db2ab52dd24908aeb77a28a73a79c9e2e7f0053ad776454e109bd
-  data.tar.gz: e27104bb9373e1f6b9e68b54f38927679f98e87e0b6730fd6bdb9621f88abe93222a4a1c2260682e8ed764c1f969bf6a00a12f637897992e19020c88b012c058
+  metadata.gz: 7704b043afd1c6f65b80f9a5f37f57ce2190afdc58750c55f6d61a6a45c9910f5fc2a6057ad5864e38e4f83303898c117492de3d15d2b01536d776942ca0362e
+  data.tar.gz: a9765b7964903cf64e013472cb3a9bb151cd6a7557da14188a2ebb012bae43bfc9532523043345064c21f51c56c172bb3498589f871a72795b15e9a5a4c55ece

data/README.md CHANGED Viewed

@@ -1,247 +1,17 @@
-# OnetimeSecret Ruby Client
+# `onetime` compatibility package
-The official Ruby client for the [OnetimeSecret](https://onetimesecret.com)
-API. Share sensitive information through a link that can only be viewed once.
+The canonical RubyGem for the OnetimeSecret Ruby client is now
+[`onetimesecret`](https://rubygems.org/gems/onetimesecret).
-The gem is **`onetime`**. This repository, **`onetime-ruby`**, is the Ruby SDK
-in the OnetimeSecret SDK family — each language has its own repository, and the
-repository name is not the package name.
-- **Zero runtime dependencies** — built entirely on the Ruby standard library
-  (`net/http`, `uri`, `json`), so it drops into any environment without pulling
-  transitive gems.
-- **Supports API v1 and v2** — pick a version per client. The same resource
-  methods exist for both, but each version returns its own response shape (they
-  are different APIs; the client does not normalize them). **v1 is deprecated**
-  and included only because the service still serves it — use v2 for new work.
-- **Ruby 3.1+**.
-> The `onetime` command-line tool has moved to a separate `onetime-cli` gem so
-> that this library stays dependency-free.
-## Installation
-```sh
-gem install onetime
-```
-Or in a Gemfile:
-```ruby
-gem "onetime", "~> 0.6"   # the constraint matters, see below
-```
-Maintainers: see [docs/releasing.md](docs/releasing.md).
-## Quick start
-```ruby
-require "onetime"
-client = Onetime::Client.new(
-  base_url:    "https://ca.onetimesecret.com", # choose your region's API host (required)
-  customer:    "ur1abc23defghijklmnop",        # customer extid (see below)
-  api_token:   ENV["ONETIME_API_TOKEN"],       # API token from your account page
-  api_version: :v2,                            # :v1 or :v2 (default)
-)
-# Conceal a secret you already have
-res = client.secrets.conceal(secret: "hunter2", ttl: 3600, passphrase: "pw12")
-res.dig("record", "receipt", "identifier")  # the receipt (creator) key
-res.dig("record", "secret", "identifier")   # the secret (recipient) key
-# Generate a random secret server-side
-client.secrets.generate(ttl: 86_400)
-# Reveal (consume) a secret — one-time only
-secret = client.secrets.reveal("abc123secretkey", passphrase: "pw12")
-secret.dig("record", "secret_value")
-# Service status (works on v1 and v2)
-client.status
-```
-### Authentication
-Authentication uses HTTP Basic, where the **customer extid** is the username
-and your **API token** is the password.
-The customer extid is a short, opaque identifier that begins with `ur` — for
-example `ur1abc23def`. It is shown, with a copy button, at the bottom of the
-user menu when you are signed in. Other identifiers the API uses are not
-interchangeable with it.
-The format is checked at construction, so a value of the wrong kind fails
-immediately rather than at the first request:
+Update your Gemfile:
 ```ruby
-Onetime::Client.new(base_url: "https://ca.onetimesecret.com",
-                    customer: "acct-123", api_token: ENV["ONETIME_API_TOKEN"])
-# => Onetime::ConfigurationError: customer "acct-123" is not a customer extid:
-#    extids begin with "ur" (e.g. "ur1abc23def"). ...
-```
-> Self-hosted servers older than
-> [onetimesecret#3945](https://github.com/onetimesecret/onetimesecret/pull/3945)
-> silently accept invalid credentials and create the secret **anonymously**
-> instead of returning 401 — the call succeeds, but the secret never appears in
-> your account. Current servers return 401.
-### Base URL (required)
-`base_url` must be the API host for your region, your self-hosted domain, or
-your custom domain. There is no default: deployments are region-isolated for
-data sovereignty, so the client cannot guess one for you.
-Regional API hosts:
-| Region | Host |
-|---|---|
-| United States | `https://us.onetimesecret.com` |
-| Europe | `https://eu.onetimesecret.com` |
-| United Kingdom | `https://uk.onetimesecret.com` |
-| Canada | `https://ca.onetimesecret.com` |
-| Aotearoa New Zealand | `https://nz.onetimesecret.com` |
-> The apex `onetimesecret.com` is the company website, not an API host, and
-> is rejected with a helpful error.
-### Configuration
-| Option         | Default                                       | Notes                                   |
-|----------------|-----------------------------------------------|-----------------------------------------|
-| `base_url`     | — (**required**)                              | Region/self-hosted/custom domain        |
-| `api_version`  | `:v2`                                          | `:v1` or `:v2`                          |
-| `customer`     | `ENV["ONETIME_CUSTOMER_EXTID"]`                | Customer extid (`ur...`)                |
-| `api_token`    | `ENV["ONETIME_API_TOKEN"]`                     | API token                               |
-| `timeout`      | `30`                                           | Read timeout (seconds)                  |
-| `open_timeout` | `10`                                           | Connect timeout (seconds)               |
-| `max_retries`  | `2`                                            | Retries for idempotent (GET) requests   |
-| `logger`       | `nil`                                          | Receives per-request `debug` lines      |
-Environment fallbacks: `base_url` ← `ONETIME_BASE_URL`; `customer` ←
-`ONETIME_CUSTOMER_EXTID`; `api_token` ← `ONETIME_API_TOKEN`.
-Clients are thread-safe: they hold only configuration and a stateless
-transport, opening a fresh connection per request.
-## Anonymous and guest usage
-A client created without credentials is anonymous and can use public and guest
-endpoints:
-```ruby
-guest = Onetime::Client.new(base_url: "https://ca.onetimesecret.com")  # no credentials
-guest.secrets.conceal(secret: "no account needed", guest: true)
-```
-## Resources
-### `client.secrets`
-| Method | v1 | v2 |
-|---|----|----|
-| `conceal(secret:, ttl:, passphrase:, recipient:, share_domain:)` | yes | yes |
-| `generate(ttl:, passphrase:, recipient:, share_domain:)` | yes | yes |
-| `reveal(key, passphrase:, continue:)` | yes | yes |
-| `show(key)` | — | yes |
-| `status(key)` | — | yes |
-| `status_list(keys)` | — | yes |
-`conceal` is also available as `share`. `reveal`/`show` accept either a bare
-key or a full secret URL.
-### `client.receipts`
-| Method | v1 | v2 |
-|---|----|----|
-| `show(key)` | yes | yes |
-| `recent` | yes | yes |
-| `burn(key, passphrase:, continue:)` | yes | yes |
-| `update(key, memo:)` | — | yes |
-### Meta
-`client.status` (v1 & v2), `client.version` / `client.supported_locales`
-(v2 only), `client.authcheck` (v1 only).
-## Responses
-Resource methods return an `Onetime::Response` with indifferent (String or
-Symbol) key access:
-```ruby
-res = client.secrets.conceal(secret: "hi")
-res["record"]                                   # Hash
-res.dig(:record, :secret, :secret_value)        # deep access
-res.success?                                     # 2xx?
-res.http_status                                  # Integer
-res.to_h                                         # the parsed body
-```
-The response shape is the API's, unchanged. v1 and v2 differ on purpose —
-v1 returns flat, all-string fields; v2 nests data under `record`/`details`
-with richer typing — and the client does not reconcile them. Read the
-[API docs](https://docs.onetimesecret.com/) for the shape of the version
-you target.
-## Errors
-HTTP errors (status >= 400) raise typed exceptions following the API's
-ADR-013 error contract (`{ error:, error_type:, ... }`):
-```ruby
-begin
-  client.secrets.reveal("missing")
-rescue Onetime::NotFoundError => e
-  e.message      # human-readable message ("error" field)
-  e.error_type   # machine-readable type ("RecordNotFound")
-  e.http_status  # 404
-rescue Onetime::RateLimitError => e
-  e.retry_after
-rescue Onetime::APIError => e
-  # any other API error
-end
-```
-| Exception | When |
-|---|---|
-| `Onetime::BadRequestError` | 400 / `FormError` (see `#field`) |
-| `Onetime::AuthenticationError` | 401 |
-| `Onetime::AccountRequiredError` | the operation needs an authenticated account (`requires_account`); subclasses `AuthenticationError`, keeps `#field` |
-| `Onetime::ForbiddenError` | 403 / `Forbidden`, `GuestRoutesDisabled` |
-| `Onetime::EntitlementError` | `EntitlementRequired` (see `#entitlement`) |
-| `Onetime::NotFoundError` | 404 / `RecordNotFound` |
-| `Onetime::RateLimitError` | 429 / `LimitExceeded` (see `#retry_after`) |
-| `Onetime::ServerError` | 5xx |
-| `Onetime::TransportError` / `TimeoutError` | network failures |
-| `Onetime::ConfigurationError` | bad `base_url`, malformed `customer` extid, incomplete credentials (raised at construction) |
-All inherit from `Onetime::Error`.
-`AccountRequiredError` exists because the service reports "this needs an
-account" inside a `400` form-error body (`field: "requires_account"`). Mapping
-that to `BadRequestError` sent people auditing their request payload for a
-problem that was never there, so it gets its own class under
-`AuthenticationError`:
-```ruby
-begin
-  client.secrets.conceal(secret: "hi")
-rescue Onetime::AccountRequiredError => e
-  e.field        # "requires_account" — preserved
-  e.http_status  # whatever the server sent (400 today)
-end
-```
-## Development
-```sh
-bundle install
-rake test
+gem "onetimesecret", "~> 0.7.0"
 ```
-## License
+The Ruby API remains under the `Onetime` namespace. Both
+`require "onetimesecret"` and `require "onetime"` are supported by the
+canonical package.
-See [LICENSE.txt](LICENSE.txt).
+This package contains no implementation files. It depends on `onetimesecret`
+so existing `onetime` users can transition without loading conflicting files.

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onetime
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Delano Mandelbaum
@@ -10,19 +10,19 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: onetimesecret
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
+        version: 0.7.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -37,26 +37,15 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-description: A dependency-free Ruby client for the OnetimeSecret API, supporting the
-  v1 and v2 API versions.
+description: The onetime gem has moved to the canonical onetimesecret package.
 email:
 - gems@onetimesecret.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGES.txt
 - LICENSE.txt
 - README.md
-- lib/onetime.rb
-- lib/onetime/client.rb
-- lib/onetime/configuration.rb
-- lib/onetime/errors.rb
-- lib/onetime/resources/receipts.rb
-- lib/onetime/resources/secrets.rb
-- lib/onetime/response.rb
-- lib/onetime/transport.rb
-- lib/onetime/version.rb
 homepage: https://github.com/onetimesecret/onetime-ruby
 licenses:
 - MIT
@@ -66,6 +55,17 @@ metadata:
   documentation_uri: https://docs.onetimesecret.com/
   changelog_uri: https://github.com/onetimesecret/onetime-ruby/blob/main/CHANGES.txt
   rubygems_mfa_required: 'true'
+post_install_message: |2+
+  The `onetime` gem has moved to `onetimesecret`.
+  Update your Gemfile:
+    gem "onetimesecret", "~> 0.7.0"
+  The Ruby namespace remains `Onetime`, and `require "onetime"` remains
+  supported by the canonical gem.
 rdoc_options: []
 require_paths:
 - lib
@@ -82,5 +82,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: Official Ruby client for the OnetimeSecret API
+summary: Compatibility package; use the onetimesecret gem
 test_files: []
+...

data/CHANGES.txt DELETED Viewed

@@ -1,102 +0,0 @@
-ONETIME, CHANGES
-#### 0.6.0 (unreleased; tag v0.6.0 to publish) #########
-  The first release of the `onetime` gem since 0.5.1 (2013): the same gem,
-  cleaned up and brought current. The API surface changes completely, and
-  the command-line tool moves out to `onetime-cli`, so treat this as a
-  rewrite rather than a drop-in upgrade. See docs/releasing.md for the
-  RubyGems publishing steps.
-* REWRITE: Modern, zero-dependency client built on stdlib Net::HTTP.
-  A clean break from 0.5.x (2013); no backward compatibility is maintained.
-* ADDED: Onetime::AccountRequiredError for responses that require an
-  authenticated account. The service reports this inside a 400 form-error
-  body (field "requires_account"), which previously surfaced as
-  BadRequestError and sent callers auditing a request body that was fine.
-  It subclasses AuthenticationError and preserves #field. Also matched via
-  error_key, code (e.g. GUEST_CONCEAL_REQUIRES_ACCOUNT) and the
-  RequiresAccount / AccountRequired error types.
-* ADDED: customer extid format validation at client construction. Values
-  that don't match the "ur..." extid shape are rejected immediately, with a
-  message that says where to find the right one.
-* ADDED: Release workflow (.github/workflows/release.yml) publishing to
-  RubyGems via Trusted Publishing on a v* tag, with a tag/version guard,
-  plus docs/releasing.md.
-* CHANGE: README installation instructions now ask for the `~> 0.6`
-  version constraint, and say why: the previous release under this gem
-  name is the 2013 command-line tool (0.5.1), which an unconstrained
-  dependency can still resolve to.
-* CHANGE: README authentication section now describes the customer extid
-  format up front, rather than contrasting it with the pre-1.0 email custid.
-* ADDED: Onetime::Client with secrets/receipts resources and meta methods.
-* ADDED: Support for the v1 and v2 APIs (selectable via api_version).
-* ADDED: Typed error hierarchy mapped to the ADR-013 wire format
-  ({ error, error_type, ... }) and legacy v1 { message } responses.
-* ADDED: Indifferent-access Onetime::Response wrapper.
-* ADDED: Anonymous / guest endpoint support for v2.
-* ADDED: Retries with exponential backoff for idempotent requests.
-* ADDED: Minitest test suite (unit + real Net::HTTP integration).
-* CHANGE: Authentication uses the customer extid (the "ur..." identifier at
-  the bottom of the user menu) as the HTTP Basic username, with the API
-  token as the password. Set it via `customer:` / ONETIME_CUSTOMER_EXTID.
-* CHANGE: base_url is now required (no default). Region-isolated deployments
-  mean there is no safe default; the apex onetimesecret.com (company website)
-  is rejected with guidance toward regional/self-hosted/custom hosts.
-* CHANGE: Requires Ruby 3.1+.
-* CHANGE: The `onetime` CLI moves to a separate `onetime-cli` gem.
-* REMOVED: httparty, drydock, jeweler, and yajl dependencies.
-* REMOVED: Legacy Onetime::API / OT::API shim, the OT top-level alias, the
-  `username:` option alias, and the old ONETIME_HOST / ONETIME_CUSTID /
-  ONETIME_APIKEY environment variables.
-* REMOVED: The drydock-based `bin/onetime` executable and the gem signing
-  certificate.
-* REMOVED: The redundant top-level VERSION file; lib/onetime/version.rb is
-  the single source of version truth.
-#### 0.5.1 (2013-02-12) ###############################
-* ADDED: global recipient parameter for 'generate' and 'share' commands.
-#### 0.5.0 (2013-02-12) ###############################
-* ADDED: Support for getting secrets based on the URI
-* ADDED: Command alias 'get' for 'secret'
-* ADDED: Explicit support for string format
-* FIXED: Confusion around csv support (there is no csv support)
-* CHANGE: Disabled checking for tty. Just assume string format.
-* CHANGE: 'secret' command returns just the secret message by default (not yaml)
-#### 0.4.1 (2013-02-12) ###############################
-* CHANGE: All releases will now be signed. See "Installation" in the readme.
-* CHANGE: json dependency upgraded from 1.6.4 to 1.6.8
-#### 0.4.0 (2012-01-07) ###############################
-* ADDED: Support for ttl, passphrase, and email recipient
-* ADDED: Better error handling
-* CHANGE: env variable ONETIME_ACCOUNT -> ONETIME_CUSTID
-* CHANGE: global option -u is now -H
-#### 0.3.1 (2012-01-06) ###############################
-* FIXED: Added httparty to gemspec dependencies
-* ADDED: X-Onetime-Client header
-#### 0.3.0 (2012-01-06) ###############################
-Initial public release

data/lib/onetime/client.rb DELETED Viewed

@@ -1,100 +0,0 @@
-# frozen_string_literal: true
-require_relative "configuration"
-require_relative "transport"
-require_relative "resources/secrets"
-require_relative "resources/receipts"
-module Onetime
-  # The main entry point for the OnetimeSecret API client.
-  #
-  #   client = Onetime::Client.new(
-  #     base_url:     "https://ca.onetimesecret.com",
-  #     customer:     "ur1abc23def", # customer extid
-  #     api_token:    ENV["ONETIME_API_TOKEN"],
-  #     api_version:  :v2,           # :v1 or :v2
-  #   )
-  #
-  #   client.secrets.conceal(secret: "hunter2", ttl: 3600)
-  #   client.receipts.recent
-  #   client.status
-  #
-  # A client is safe to share across threads: it holds configuration and a
-  # stateless transport, and creates a fresh Net::HTTP connection per request.
-  class Client
-    attr_reader :config, :transport
-    # Accepts the same keyword arguments as Onetime::Configuration, or an
-    # already-built Configuration via `config:`.
-    def initialize(config: nil, **options)
-      @config = config || Configuration.new(**options)
-      @config.validate!
-      @transport = @config.transport || Transport.new(@config)
-    end
-    def api_version
-      config.api_version
-    end
-    # Secret resource accessor (conceal/generate/reveal/show/status).
-    def secrets
-      @secrets ||= Resources::Secrets.new(self)
-    end
-    # Receipt resource accessor (show/recent/burn/update).
-    def receipts
-      @receipts ||= Resources::Receipts.new(self)
-    end
-    # --- Meta / public endpoints -------------------------------------------
-    # Service status. Available on both v1 and v2.
-    def status
-      request(:get, "/status")
-    end
-    # Service version. (v2 only)
-    def version
-      require_version!(:v2, "version")
-      request(:get, "/version")
-    end
-    # Locales supported by the service. (v2 only)
-    def supported_locales
-      require_version!(:v2, "supported_locales")
-      request(:get, "/supported-locales")
-    end
-    # Verify the configured credentials are valid. (v1 only)
-    def authcheck
-      require_version!(:v1, "authcheck")
-      request(:get, "/authcheck")
-    end
-    # --- Low-level request helper ------------------------------------------
-    # Issue a request against the configured API version. The path is
-    # relative to the version prefix (e.g. "/secret/conceal").
-    #
-    # @return [Onetime::Response]
-    def request(method, path, query: nil, body: nil, form: nil, raise_on_error: true)
-      transport.request(
-        method, full_path(path),
-        query: query, body: body, form: form, raise_on_error: raise_on_error
-      )
-    end
-    private
-    def full_path(path)
-      "#{config.api_path_prefix}#{path}"
-    end
-    def require_version!(expected, operation)
-      return if api_version == expected
-      raise UnsupportedOperationError,
-            "#{operation} is only available on API #{expected}; client is configured for #{api_version}"
-    end
-  end
-end