sec_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f33a11ec3b8cf4f6ab7cb5e484fa24f88e5446630868f67702b1ab1336011951
+  data.tar.gz: 5d67a99ce1490136471f4a20346d57c506ea0bc75ac8ac03280f3d2690482a71
+SHA512:
+  metadata.gz: a4acdf281ce2fb6345f1cbdd52c950d8602de26816fe0437cb4d40ee6502a74cd35e31b81d864cdef8f2f5c36ba3e4d5500d056dc3ce761bc390f3c72afec676
+  data.tar.gz: d7f8800563146e2a47979364fd9f3d0302502927a201def6b37b99745b07a6b9603b5390bdefcf8afc30c1d5983faf889a9d01ef87d8a4d9db2393a998a56fa9

data/.devcontainer/Dockerfile

@@ -0,0 +1,54 @@
+# Use official Ruby image as base
+ARG RUBY_VERSION=3.1
+FROM ruby:${RUBY_VERSION}
+
+# Install system dependencies
+RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+    && apt-get -y install --no-install-recommends \
+    build-essential \
+    git \
+    curl \
+    libssl-dev \
+    libreadline-dev \
+    zlib1g-dev \
+    libyaml-dev \
+    libffi-dev \
+    libgdbm-dev \
+    libncurses5-dev \
+    libsqlite3-dev \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+
+# Create vscode user with sudo access
+ARG USERNAME=vscode
+ARG USER_UID=1000
+ARG USER_GID=$USER_UID
+
+RUN groupadd --gid $USER_GID $USERNAME \
+    && useradd --uid $USER_UID --gid $USER_GID -m $USERNAME \
+    && apt-get update \
+    && apt-get install -y sudo \
+    && echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME \
+    && chmod 0440 /etc/sudoers.d/$USERNAME
+
+# Install bundler
+RUN gem update --system && gem install bundler
+
+# Set up workspace directory
+WORKDIR /workspace
+
+# Switch to non-root user
+USER $USERNAME
+
+# Set environment variables for Ruby
+ENV GEM_HOME=/home/$USERNAME/.gem
+ENV PATH=$GEM_HOME/bin:$PATH
+
+# Install common Ruby development tools
+RUN gem install solargraph \
+    && gem install rubocop \
+    && gem install standard \
+    && gem install debug
+
+# Default command
+CMD ["/bin/bash"]

data/.devcontainer/README.md

@@ -0,0 +1,178 @@
+# DevContainer Setup for sec_api
+
+This directory contains the development container configuration for the sec_api Ruby gem.
+
+## Prerequisites
+
+- [Docker Desktop](https://www.docker.com/products/docker-desktop) or [Docker Engine](https://docs.docker.com/engine/install/)
+- [Visual Studio Code](https://code.visualstudio.com/)
+- [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) for VS Code
+
+## Quick Start
+
+1. Open this project in VS Code
+2. When prompted, click "Reopen in Container" (or use Command Palette: `Dev Containers: Reopen in Container`)
+3. Wait for the container to build and start (first time may take a few minutes)
+4. The setup scripts will run automatically:
+   - `post-create.sh` runs once when the container is first created
+   - `post-start.sh` runs every time the container starts
+
+## What's Included
+
+### Base Environment
+- Ruby 3.1 (configurable via RUBY_VERSION arg)
+- Bundler (latest)
+- Git
+- Build tools and common system dependencies
+
+### Development Tools
+- Solargraph (Ruby language server)
+- RuboCop (linter)
+- Standard (Ruby style guide)
+- Debug gem
+
+### VS Code Extensions
+- Ruby LSP (Shopify)
+- Ruby extension pack
+- EndWise (auto-close Ruby blocks)
+- Solargraph
+
+## Configuration
+
+### Ruby Version
+
+To change the Ruby version, edit `.devcontainer/Dockerfile` and `.devcontainer/docker-compose.yml`:
+
+```dockerfile
+ARG RUBY_VERSION=3.2  # Change to desired version
+```
+
+### Environment Variables
+
+Add environment variables in `.devcontainer/docker-compose.yml`:
+
+```yaml
+environment:
+  - SECAPI_API_KEY=your_key_here
+  - SECAPI_BASE_URL=https://api.sec-api.io
+```
+
+**Note:** For sensitive values like API keys, consider using a `.env` file (not committed to git) and reference it in docker-compose.yml.
+
+### Lifecycle Scripts
+
+The devcontainer uses two lifecycle scripts:
+
+**`.devcontainer/post-create.sh`** - Runs once when container is first created:
+- Installs bundle dependencies
+- Installs additional development gems (bundler-audit)
+- Creates necessary directories
+- Generates YARD documentation
+- Runs initial test suite
+
+**`.devcontainer/post-start.sh`** - Runs every time container starts:
+- Checks for outdated gems
+- Runs security vulnerability scan
+- Verifies git configuration
+- Checks API key configuration
+- Shows current git branch and status
+
+You can customize these scripts to add your own setup tasks. For example:
+
+```bash
+# In post-create.sh - one-time setup
+gem install specific_dev_tool
+bundle exec rake db:setup
+
+# In post-start.sh - every container start
+echo "Welcome back!"
+bundle outdated --only-explicit
+```
+
+### Additional Services
+
+To add services like PostgreSQL or Redis, add them to `docker-compose.yml`:
+
+```yaml
+services:
+  app:
+    # ... existing config ...
+    depends_on:
+      - postgres
+
+  postgres:
+    image: postgres:15
+    environment:
+      POSTGRES_PASSWORD: postgres
+    volumes:
+      - postgres-data:/var/lib/postgresql/data
+
+volumes:
+  postgres-data:
+```
+
+## Common Tasks
+
+Once inside the container, you can run all the usual development commands:
+
+```bash
+# Install dependencies
+bin/setup
+
+# Run tests
+bundle exec rspec
+
+# Run linter
+bundle exec standardrb
+
+# Auto-fix linting issues
+bundle exec standardrb --fix
+
+# Interactive console
+bin/console
+
+# Install gem locally
+bundle exec rake install
+```
+
+## SSH Keys
+
+Your SSH keys from `~/.ssh` are mounted read-only into the container, so git operations that require authentication will work seamlessly.
+
+## Bash History
+
+Bash history is persisted in a Docker volume, so your command history survives container rebuilds.
+
+## Rebuilding the Container
+
+If you make changes to the Dockerfile or devcontainer.json:
+
+1. Open Command Palette (Cmd+Shift+P / Ctrl+Shift+P)
+2. Run `Dev Containers: Rebuild Container`
+
+## Troubleshooting
+
+### Container won't start
+- Check Docker Desktop is running
+- Try rebuilding: `Dev Containers: Rebuild Container`
+- Check Docker logs for errors
+
+### Permission issues
+- The container runs as `vscode` user (UID 1000)
+- File ownership should match your host user
+
+### Bundle install fails
+- Ensure Docker has enough memory (4GB+ recommended)
+- Try running `bundle install` manually after container starts
+
+### VS Code extensions not working
+- Try reloading the window: `Developer: Reload Window`
+- Check extension installation in the container's Extensions panel
+
+## Benefits of This Setup
+
+1. **Consistent Environment**: Everyone uses the same Ruby version and dependencies
+2. **Isolated**: No conflicts with other Ruby projects or system Ruby
+3. **Reproducible**: Works the same on macOS, Linux, and Windows
+4. **Fast Onboarding**: New developers can get started with one click
+5. **No Local Ruby Required**: Don't need to manage rbenv, rvm, or system Ruby

data/.devcontainer/devcontainer.json

@@ -0,0 +1,46 @@
+{
+  "name": "sec_api Ruby Development",
+  "build": {
+    "dockerfile": "Dockerfile",
+    "args": {
+      "RUBY_VERSION": "3.1"
+    }
+  },
+
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "rebornix.ruby",
+        "Shopify.ruby-lsp",
+        "kaiwood.endwise",
+        "jnbt.vscode-rufo",
+        "misogi.ruby-rubocop",
+        "castwide.solargraph"
+      ],
+      "settings": {
+        "terminal.integrated.defaultProfile.linux": "bash",
+        "ruby.useLanguageServer": true,
+        "ruby.lint": {
+          "standard": true
+        },
+        "ruby.format": "standard"
+      }
+    }
+  },
+
+  "features": {
+    "ghcr.io/devcontainers/features/git:1": {}
+  },
+
+  "forwardPorts": [],
+
+  "postCreateCommand": ".devcontainer/post-create.sh",
+
+  "postStartCommand": ".devcontainer/post-start.sh",
+
+  "remoteUser": "vscode",
+
+  "mounts": [
+    "source=${localEnv:HOME}/.ssh,target=/home/vscode/.ssh,readonly,type=bind,consistency=cached"
+  ]
+}

data/.devcontainer/docker-compose.yml

@@ -0,0 +1,28 @@
+version: '3.8'
+
+services:
+  app:
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile
+      args:
+        RUBY_VERSION: "3.1"
+
+    volumes:
+      - ..:/workspace:cached
+      # Persist bash history
+      - devcontainer-bashhistory:/home/vscode/.bash_history
+
+    # Overrides default command so container stays running
+    command: sleep infinity
+
+    # Environment variables for development
+    environment:
+      # Add any default environment variables here
+      - SECAPI_BASE_URL=https://api.sec-api.io
+
+    # Use host network for easier local development
+    network_mode: host
+
+volumes:
+  devcontainer-bashhistory:

data/.devcontainer/post-create.sh

@@ -0,0 +1,51 @@
+#!/bin/bash
+set -e
+
+echo "Running post-create setup..."
+
+# Install Claude Code CLI
+echo "Installing Claude Code CLI..."
+curl -fsSL https://claude.ai/install.sh | bash
+
+# Install gem dependencies
+echo "Installing bundle dependencies..."
+bundle install
+
+# Install any additional global gems needed for development
+echo "Installing additional development gems..."
+gem install bundler-audit
+
+# Set up git hooks if needed (uncomment if you want to use them)
+# echo "Setting up git hooks..."
+# bundle exec overcommit --install
+
+# Create any necessary directories
+echo "Creating necessary directories..."
+mkdir -p tmp
+mkdir -p log
+
+# Generate YARD documentation
+echo "Generating YARD documentation..."
+bundle exec yard doc --no-progress || true
+
+# Run initial test suite to ensure everything works
+echo "Running initial test suite..."
+bundle exec rspec --fail-fast || echo "Warning: Some tests failed. You may want to investigate."
+
+# Display useful information
+echo ""
+echo "========================================="
+echo "Post-create setup complete!"
+echo "========================================="
+echo ""
+echo "Available commands:"
+echo "  bundle exec rspec       - Run tests"
+echo "  bundle exec standardrb  - Run linter"
+echo "  bin/console            - Interactive console"
+echo "  bundle exec rake       - Run default task"
+echo "  claude                 - Claude Code CLI"
+echo ""
+echo "Ruby version: $(ruby -v)"
+echo "Bundler version: $(bundle -v)"
+echo "Claude Code: $(claude --version 2>/dev/null || echo 'not found in PATH yet - restart terminal')"
+echo ""

data/.devcontainer/post-start.sh

@@ -0,0 +1,44 @@
+#!/bin/bash
+set -e
+
+echo "Running post-start tasks..."
+
+# Check for outdated gems
+echo "Checking for outdated gems..."
+bundle outdated --only-explicit || true
+
+# Check for security vulnerabilities
+echo "Checking for security vulnerabilities..."
+bundle-audit check --update || echo "Warning: Security vulnerabilities found. Run 'bundle-audit check' for details."
+
+# Verify git configuration
+echo "Verifying git configuration..."
+git config --get user.name > /dev/null || echo "Warning: Git user.name not set. Run 'git config --global user.name \"Your Name\"'"
+git config --get user.email > /dev/null || echo "Warning: Git user.email not set. Run 'git config --global user.email \"you@example.com\"'"
+
+# Check if API key is configured (if needed)
+if [ -f "config/secapi.yml" ]; then
+    echo "API configuration file found: config/secapi.yml"
+elif [ -n "$SECAPI_API_KEY" ]; then
+    echo "API key configured via environment variable"
+else
+    echo "Note: API key not configured. Set SECAPI_API_KEY environment variable if needed."
+fi
+
+# Update bundle if Gemfile.lock is stale (optional - uncomment if desired)
+# if [ Gemfile -nt Gemfile.lock ]; then
+#     echo "Gemfile is newer than Gemfile.lock, running bundle install..."
+#     bundle install
+# fi
+
+# Display current branch and status
+echo ""
+echo "Git branch: $(git rev-parse --abbrev-ref HEAD 2>/dev/null || echo 'unknown')"
+echo "Git status:"
+git status --short 2>/dev/null || echo "Not a git repository"
+
+echo ""
+echo "========================================="
+echo "Development environment ready!"
+echo "========================================="
+echo ""

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-04-18
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Lauri Jutila
+
+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.