superset 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 063136fe3a4d039c48ce40c5cf060f212af35a3833c6d24ce9315f5465931c5d
-  data.tar.gz: 4310dc351ea932247d997ac2c2a48078c900ca7023845a1859140e4372d1cd8c
+  metadata.gz: b8b34598d228f19ee769e3381bb25efdef9104659d5fabce8109521d0344a860
+  data.tar.gz: a1f4cb502c1e6c11b1c7f965f4d185c155e9a1201398a87915087c8dc12033f4
 SHA512:
-  metadata.gz: e21a7c945bfc292fe86e444b65c14c90dc6a2090554dfe3e2a9a01dd7810a4e3dcaf05aaee39a958523a2343797277163ebcc60d6ff1e3e1e6933fd0355e4a2b
-  data.tar.gz: ad56b23990af5c6823c098bcc4798bcb0dff1e2d2a02ee3f41bdec46e7ca637bf57811d0dcee2938ded9ef55c1efc5fd44cda860c9feb649f2cd39db5c941dd4
+  metadata.gz: 9dd45b812b5883faf48b48fd4a111c7baacafee441cdc3da96a8da16f7ddf2a874824cdff178554509da49ae914549a53cafa1e3949909683b6ab7ef43c69174
+  data.tar.gz: abd065a21a68e4364484f226e5bf58ce78fd0619827b8b1f4ca28e3c6bfac2586c23a14ce0683b95346763b870c7e86ee6c4d57c800377202d8080709e4aa998

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 ## Changelog
 
+## 0.5.3 - 2026-09-23
+
+* **Fix:** make the gem actually work on Faraday 2. 0.5.2 loosened the `faraday` constraint from `~> 1.10` to `>= 1.10` but adapted none of the code, so any consumer resolving Faraday 2 hit `NoMethodError: undefined method 'authorization' for an instance of Faraday::Connection` on every request through `Superset::Client` and `Superset::GuestToken`. Replaced `f.authorization :Bearer, token` with `f.request :authorization, 'Bearer', token`, which works on both Faraday 1.10+ and 2.x
+* **Fix:** `require 'faraday/multipart'` in `Superset::Client` and `Superset::Dashboard::Import`. Faraday stopped autoloading faraday-multipart in 2.0, so `f.request :multipart` raised ":multipart is not registered on Faraday::Request"; it resolved only because happi happened to require it first — the same transitive-dependency trap as the `FaradayMiddleware::ParseJson` bug in 0.5.1. This gem declares faraday-multipart itself, so it now requires it itself
+* Use `Faraday::Multipart::FilePart` instead of `Faraday::UploadIO` in `Dashboard::Import#payload`. Not a live break (faraday-multipart 1.x still aliases `UploadIO` to the same class once loaded), but FilePart is the maintained name and does not depend on that legacy alias
+* Add `Dashboard::Import#payload` specs. Every existing import example stubbed `#response`, so `#payload` had never executed under test
+* **Fix:** `require 'ostruct'` in `Dashboard::List` and `Services::DashboardLoader`. Both use `OpenStruct` but it only ever loaded transitively via activesupport <= 7.1; on activesupport 8.x the gem failed to load at all. Also declared as a gemspec dependency, since ostruct becomes a bundled gem in Ruby 3.5
+* Stop tracking `Gemfile.lock`. This is a library; the committed lockfile pinned faraday 1.10.3 and is the direct reason the widened constraint was never exercised locally
+* **Fix:** declare `happi` (`~> 1.0`) as a runtime dependency in the gemspec. `Superset::Client` subclasses `Happi::Client`, but happi was declared only in the `Gemfile` as a git ref — so the published gem listed no happi at all and raised `NameError` on first require for anyone installing it from a package host. happi 1.0.0 is on RubyGems and is byte-identical to the git tag this gem was developed against; the `Gemfile` git pin is now redundant and has been removed
+* **Fix:** declare and require `activesupport` (`>= 7.1`). `lib/` calls it in ~96 places — `present?`, `blank?`, `with_indifferent_access`, `deep_symbolize_keys`, and `humanize` in `Display#table` — but the gem neither declared nor required it; it loaded only because happi depends on activesupport. Requires the four core extensions actually used rather than `active_support/all`
+* Raise `required_ruby_version` from `>= 3` to `>= 3.2`. The old floor was never true: `Superset::Client` subclasses `Happi::Client`, and happi v1.0.0 requires ruby >= 3.2, so a bundle cannot resolve on 3.0 or 3.1. Nothing in `lib/` needs syntax newer than 3.0 — the floor is entirely happi's
+* Make eight specs ruby-version agnostic. They hardcoded ruby 3.4's `Hash#inspect` output (`"k" => v`, not `"k"=>v`), so the suite only passed on the one ruby the strings were pasted from — leaving the declared `>= 3.2` floor untested. Expectations are now derived from the same source data the code stringifies
+* Add `.github/workflows/ci.yml`, running the suite across ruby 3.2/3.3/3.4 and both ends of the declared faraday range (`gemfiles/faraday_1.gemfile`, `gemfiles/faraday_2.gemfile`). Buildkite already ran rspec on every PR, but against the committed `Gemfile.lock`, so CI only ever exercised faraday 1.10.3 — a single point inside the declared `>= 1.10` range, which is how 0.5.2 shipped a Faraday 2 break with a green build
+* **Fix:** `Superset::Client#raise_error` no longer `puts` to stdout on every failed API call. A library should not write to its consumer's console, and the message is already carried by the raised exception; it now goes to `Superset.logger` (configurable since 0.5.0). The dead `binding.pry` comment beside it is gone, and `#raise_error` has specs for the first time
+* Populate gem metadata (`homepage_uri`, `source_code_uri`, `changelog_uri`, `bug_tracker_uri`, `documentation_uri`, `rubygems_mfa_required`) — these were all commented out, so the rubygems.org page showed no links
+* Stop shipping development scaffolding in the packaged gem. Installs previously included `Dockerfile`, `docker-compose*.yml`, `.buildkite/`, `.github/`, `gemfiles/`, `Rakefile`, `AGENTS.md`, `CLAUDE.md`, `RELEASING.md` and `env.sample`; the gem now contains `lib/`, the docs, README, CHANGELOG and LICENSE
+
 ## 0.5.2 - 2026-08-28
 
 * Add tag-triggered release workflow (`.github/workflows/release.yml`) that publishes to RubyGems.org via OIDC trusted publishing and to GitHub Packages via the Actions `GITHUB_TOKEN` — no long-lived credentials stored anywhere. Refuses to publish unless the pushed tag's commit is reachable from `develop`. See `RELEASING.md` for the release steps and one-time RubyGems.org Trusted Publisher setup

data/lib/superset/client.rb

@@ -1,3 +1,4 @@
+require 'faraday/multipart'
 require 'faraday-cookie_jar'
 
 module Superset
@@ -48,8 +49,7 @@ module Superset
         response.body
       end
 
-      puts "API Error: #{message}"  # display the error message for console debugging
-      # binding.pry                 # helpfull to debug the response
+      Superset.logger.error("API Error: #{message}")
 
       raise errors[response.status].new(message, response)  # message is not being surfaced from Happi correctly, :(
     end
@@ -75,7 +75,7 @@ module Superset
 
     def connection
       @connection ||= Faraday.new(superset_host) do |f|
-        f.authorization :Bearer, access_token
+        f.request :authorization, 'Bearer', access_token
         f.use :cookie_jar  # persist the Flask session cookie across the csrf_token GET and the write
         f.response :json, content_type: 'application/json'
 

data/lib/superset/dashboard/import.rb

@@ -20,6 +20,8 @@
 # Superset::Dashboard::Import.new(source: '/tmp/dashboard').perform
 #
 
+require 'faraday/multipart'
+
 module Superset
   module Dashboard
     class Import < Request
@@ -58,7 +60,7 @@ module Superset
 
       def payload
         {
-          formData: Faraday::UploadIO.new(source_zip_file, "application/zip"),
+          formData: Faraday::Multipart::FilePart.new(source_zip_file, "application/zip"),
           overwrite: overwrite.to_s
         }
       end

data/lib/superset/dashboard/list.rb

@@ -2,6 +2,8 @@
 # Usage: Superset::Dashboard::List.new(page_num: 1, title_contains: 'Test').list
 # Usage: Superset::Dashboard::List.new(tags_equal: ['embedded', 'product:acme']).list
 
+require 'ostruct'
+
 module Superset
   module Dashboard
     class List < Superset::Request

data/lib/superset/guest_token.rb

@@ -73,7 +73,7 @@ module Superset
 
     def connection
       @connection ||= Faraday.new(authenticator.superset_host) do |f|
-        f.authorization :Bearer, access_token
+        f.request :authorization, 'Bearer', access_token
         f.use :cookie_jar  # replay the Flask session cookie from the csrf_token GET on the POST
         f.response :json, content_type: 'application/json'
         f.request :json

data/lib/superset/services/dashboard_loader.rb

@@ -1,6 +1,7 @@
 # Given a path, load all yaml files
 
 require 'superset/file_utilities'
+require 'ostruct'
 require 'yaml'
 
 module Superset

data/lib/superset/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Superset
-  VERSION = "0.5.2"
+  VERSION = "0.5.3"
 end

data/lib/superset.rb

@@ -6,6 +6,11 @@ require 'happi'
 require 'logger'
 require 'json'
 
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/string/inflections'
+
 require_relative "superset/configuration"
 require_rel "superset/credential"
 require_relative "superset/authenticator"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: superset
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - jbat
@@ -9,6 +9,34 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: happi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -23,6 +51,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
@@ -197,26 +239,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".buildkite/pipeline.yml"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
-- AGENTS.md
 - CHANGELOG.md
-- CLAUDE.md
-- Dockerfile
 - LICENSE
 - README.md
-- RELEASING.md
-- Rakefile
 - doc/duplicate_dashboards.md
 - doc/migrating_dashboards_across_environments.md
 - doc/publishing.md
 - doc/setting_up_personal_api_credentials.md
 - doc/usage.md
-- docker-compose.override.yml
-- docker-compose.yml
-- env.sample
 - lib/superset.rb
 - lib/superset/authenticator.rb
 - lib/superset/base_put_request.rb
@@ -290,11 +320,16 @@ files:
 - lib/superset/tag/get.rb
 - lib/superset/tag/list.rb
 - lib/superset/version.rb
-- log/README.md
 homepage: https://github.com/rdytech/superset-client
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/rdytech/superset-client
+  source_code_uri: https://github.com/rdytech/superset-client/tree/develop
+  changelog_uri: https://github.com/rdytech/superset-client/blob/develop/CHANGELOG.md
+  bug_tracker_uri: https://github.com/rdytech/superset-client/issues
+  documentation_uri: https://github.com/rdytech/superset-client/blob/develop/README.md
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -302,7 +337,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.buildkite/pipeline.yml

@@ -1,16 +0,0 @@
-steps:
-  - label: ":rspec:"
-    command: bin/setup && bundle exec rspec
-    plugins:
-      docker-compose#v3.0.3:
-        run: app
-        volumes:
-          - ./coverage:/app/coverage
-          - ./log:/app/log
-    timeout: 10
-    agents:
-      queue: docker-heavy
-    artifact_paths:
-      - "coverage/.resultset*.json"
-      - "log/*.log"
-      - "log/*.xml"

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,13 +0,0 @@
-AllCops:
-  TargetRubyVersion: 3.0
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120

data/.ruby-version

@@ -1 +0,0 @@
-3.4.4

data/AGENTS.md

@@ -1,105 +0,0 @@
-# Agents
-
-This file provides guidance to AI coding agents working with code in this repository.
-
-## Commands
-
-```bash
-# Install dependencies
-bundle install
-
-# Open interactive console (auto-loads .env)
-bin/console
-
-# Run full test suite
-rspec
-
-# Run a single test file
-rspec spec/path/to/test_spec.rb
-
-# Run a single test by line number
-rspec spec/path/to/test_spec.rb:42
-
-# Lint
-rubocop
-
-# Run specs + rubocop together
-rake
-```
-
-Docker equivalents: prefix commands with `docker-compose run --rm app`.
-
-### Environment Setup
-
-Copy `env.sample` to `.env` and fill in:
-- `SUPERSET_HOST` — API base URL (required)
-- `SUPERSET_API_USERNAME` / `SUPERSET_API_PASSWORD` — API credentials (required)
-- `SUPERSET_ENVIRONMENT` — optional; loads `.env-{ENVIRONMENT}` instead
-- `CONSOLE_TIMEOUT` — seconds before auto-logout in console (default 1800)
-
-## Architecture
-
-### Request Framework
-
-All API interactions inherit from `Superset::Request` (`lib/superset/request.rb`). Subclasses implement:
-- `route` — returns the API path (e.g., `"dashboard/#{id}"`)
-- `filters` — returns a filter query string or `""`
-- `list_attributes` — array of field names used for terminal table display
-
-**Patterns by HTTP verb:**
-- **GET/LIST** — inherit `Superset::Request`, implement `route` and `filters`
-- **PUT** — inherit `Superset::BasePutRequest`, takes `target_id:` and `params:`, implement `route`
-- **DELETE/POST** — call `client.delete(route)` or `client.post(route, params)` directly
-
-Pagination is built into `Superset::Request` (default page size: 100, max: 1000). List classes accept `page_num:` and `page_size:` kwargs.
-
-### Authentication Flow
-
-1. `Superset::Client` (extends `Happi::Client`) includes `Credential::ApiUser` and creates a `Superset::Authenticator`
-2. `Authenticator` POSTs to `api/v1/security/login` and extracts `access_token`
-3. `Client#connection` builds a Faraday connection with Bearer token; supports both JSON and multipart modes (`config.use_json`)
-
-### Query Filter Syntax
-
-Superset uses an ORM-like filter string format:
-```
-filters:!((col:column_name,opr:operation,value:value)),
-```
-Common operations: `ct` (contains), `eq` (equals), `neq` (not equals), `rel_o_m`, `rel_m_m`, `dashboard_tags`.
-
-### Service Layer
-
-`lib/superset/services/` contains complex multi-step workflows. The main one is `DuplicateDashboard`, which:
-1. Validates source/target IDs, schema existence, and data sovereignty rules (all chart datasets must share the same DB schema)
-2. Copies the dashboard and its charts
-3. Duplicates datasets pointing to the target schema
-4. Rewires chart JSON metadata and filter configs to the new dataset IDs
-5. Optionally sets embedded config, tags, and publishes
-6. **Rolls back all created objects on failure**
-
-`ImportDashboardAcrossEnvironment` handles cross-environment migration via export/import ZIP files.
-
-### Display Mixin
-
-`Superset::Display` (`lib/superset/display.rb`) is included in `Superset::Request` and provides `list`, `rows`, `to_h`, and `ids`. Requires `list_attributes` and `result` to be implemented by the subclass.
-
-### Resource–Relationship Model
-
-- **Dashboards** contain **Charts**
-- **Charts** reference **Datasets** (datasources)
-- **Dashboard JSON metadata** stores layout, chart positions, and filter configurations
-- **Filters** reference Datasets for filter values
-- Duplication/migration requires updating all these cross-references
-
-### Conventions
-
-- Namespace: `Superset::<ResourceType>::<Action>` (e.g., `Superset::Dashboard::List`)
-- `perform` — executes a state-changing action, returns `self`
-- `response` — raw (cached) HTTP response
-- `result` — extracts `response['result']`
-- Constructor filter params follow naming: `title_contains:`, `title_equals:`, etc.
-- Logging goes through `Superset.logger`; by default writes to `log/superset-client.log`. Consumers can inject any `::Logger`-compatible object via `Superset.configure { |c| c.logger = your_logger }`.
-
-### Console Helpers
-
-In `bin/console`: `sshelp` (alias: `superset_class_list`) lists all available `Superset::` classes. On startup, `Superset::Database::List.call` prints available DB connections.

data/CLAUDE.md

@@ -1 +0,0 @@
-See [AGENTS.md](AGENTS.md) for project context and development instructions.

data/Dockerfile

@@ -1,17 +0,0 @@
-# 1: Use ruby 3.4.4 as base:
-FROM ruby:3.4.4
-
-RUN apt-get update && \
-    apt-get install -y --no-install-recommends \
-    build-essential
-
-ENV BUNDLER_VERSION='2.4.22'
-RUN gem install bundler -v ${BUNDLER_VERSION}
-
-# 2: We'll set the application path as the working directory
-WORKDIR /app
-
-# 3: We'll add the app's binaries path to $PATH:
-ENV PATH=$PATH:/app/bin
-
-ENV BUNDLE_GITHUB__HTTPS=true BUNDLE_MAJOR_DEPRECATIONS=true

data/RELEASING.md

@@ -1,32 +0,0 @@
-# Releasing superset
-
-Publishing is only ever done by GitHub Actions (`.github/workflows/release.yml`), triggered by
-a `vX.Y.Z` tag whose commit is reachable from `develop`. Tags on any other branch are rejected by
-the workflow before anything is built. No one needs local publishing credentials — the workflow
-authenticates to RubyGems.org via OIDC trusted publishing and to GitHub Packages via the
-Actions-provided `GITHUB_TOKEN`.
-
-## Cutting a release
-
-1. Bump `Superset::VERSION` in `lib/superset/version.rb`.
-2. Add a new `## X.Y.Z - YYYY-MM-DD` entry to the top of `CHANGELOG.md` describing the changes.
-3. Commit both changes and get them onto `develop` (PR + merge, as normal).
-4. From an up-to-date `develop`, tag the commit and push the tag:
-
-   ```bash
-   git tag vX.Y.Z
-   git push origin vX.Y.Z
-   ```
-
-5. Watch the "Release" workflow run in the Actions tab.
-6. Confirm the new version shows up on [rubygems.org](https://rubygems.org/gems/superset) and on
-   [GitHub Packages](https://github.com/rdytech/superset-client/pkgs/rubygems/superset).
-
-## One-time setup
-
-- **RubyGems.org**: an existing owner of the `superset` gem must add a Trusted Publisher for
-  `rdytech/superset-client`, workflow `release.yml` (no environment). See
-  [Trusted Publishing: adding a publisher](https://guides.rubygems.org/trusted-publishing/adding-a-publisher/).
-  Until this is done, the "Publish to RubyGems.org" step will fail.
-- **GitHub Packages**: nothing to configure — the workflow's `packages: write` permission is
-  sufficient.

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]

data/docker-compose.override.yml

@@ -1,10 +0,0 @@
-version: '3'
-
-volumes:
-  bundle-data:
-    driver: local
-
-services:
-  app:
-    volumes:
-      - bundle-data:/usr/local/bundle

data/docker-compose.yml

@@ -1,8 +0,0 @@
-version: '3'
-
-services:
-  app:
-    build: .
-    command: setup
-    volumes:
-      - .:/app

data/env.sample

@@ -1,9 +0,0 @@
-SUPERSET_HOST="http://localhost:8080/"
-
-# general api calls
-SUPERSET_API_USERNAME="USERNAME"
-SUPERSET_API_PASSWORD="PASSWORD"
-
-# embedded user guest token api calls
-# SUPERSET_EMBEDDED_USERNAME="EMBEDDED-USERNAME"
-# SUPERSET_EMBEDDED_PASSWORD="EMBEDDED-PASSWORD"

data/log/README.md

@@ -1,4 +0,0 @@
-Log outputs of specific superset scription processes to be sent here.
-
-Dashboard Duplication Logs current logged to
-- log/superset-client.log