keeper_secrets_manager 17.0.4 → 17.2.0

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: keeper_secrets_manager
 version: !ruby/object:Gem::Version
-  version: 17.0.4
+  version: 17.2.0
 platform: ruby
 authors:
 - Keeper Security
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-06-25 00:00:00.000000000 Z
-dependencies: []
+date: 2026-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby SDK for Keeper Secrets Manager - A zero-knowledge platform for managing
   and protecting infrastructure secrets
 email:
@@ -21,25 +49,14 @@ files:
 - ".rspec"
 - ".ruby-version"
 - CHANGELOG.md
-- DEVELOPER_SETUP.md
 - Gemfile
 - LICENSE
-- MANUAL_TESTING_GUIDE.md
 - README.md
-- RUBY_SDK_COMPLETE_DOCUMENTATION.md
-- RUBY_SDK_COMPREHENSIVE_SUMMARY.md
 - Rakefile
-- examples/01_quick_start.rb
-- examples/02_authentication.rb
-- examples/03_retrieve_secrets.rb
-- examples/04_create_update_delete.rb
-- examples/05_field_types.rb
-- examples/06_files.rb
-- examples/07_folders.rb
-- examples/08_notation.rb
-- examples/09_totp.rb
-- examples/README.md
+- bin/console
+- keeper_secrets_manager.gemspec
 - lib/keeper_secrets_manager.rb
+- lib/keeper_secrets_manager/cache.rb
 - lib/keeper_secrets_manager/config_keys.rb
 - lib/keeper_secrets_manager/core.rb
 - lib/keeper_secrets_manager/crypto.rb
@@ -63,7 +80,7 @@ metadata:
   homepage_uri: https://github.com/Keeper-Security/secrets-manager
   source_code_uri: https://github.com/Keeper-Security/secrets-manager
   changelog_uri: https://github.com/Keeper-Security/secrets-manager/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -71,15 +88,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Keeper Secrets Manager SDK for Ruby
 test_files: []

data/MANUAL_TESTING_GUIDE.md

@@ -1,332 +0,0 @@
-# Manual Testing Guide for Ruby SDK - Non-Ruby Developers
-
-This guide will walk you through testing the Keeper Secrets Manager Ruby SDK step-by-step, even if you're not familiar with Ruby.
-
-## Prerequisites
-
-### 1. Install Ruby
-```bash
-# Check if Ruby is installed
-ruby --version
-
-# If not installed:
-# On macOS with Homebrew:
-brew install ruby
-
-# On Ubuntu/Debian:
-sudo apt-get install ruby-full
-
-# On Windows:
-# Download from https://rubyinstaller.org/
-```
-
-**Required**: Ruby 2.7 or higher
-
-### 2. Install Dependencies
-```bash
-# Navigate to the Ruby SDK directory
-cd /Users/mustinov/Source/secrets-manager/sdk/ruby
-
-# Install bundler (Ruby's package manager)
-gem install bundler
-
-# Install SDK dependencies
-bundle install
-```
-
-### 3. Get Your Keeper Token
-You need a one-time token from Keeper. It looks like:
-```
-US:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-```
-
-## Step-by-Step Testing
-
-### Step 1: Create Test Script
-Create a new file called `my_test.rb` in the SDK directory:
-
-```ruby
-#!/usr/bin/env ruby
-
-# Load the SDK
-require_relative 'lib/keeper_secrets_manager'
-
-# Your token from Keeper
-TOKEN = 'US:YOUR_ONE_TIME_TOKEN_HERE'
-
-# Initialize the SDK
-puts "Initializing Keeper SDK..."
-sm = KeeperSecretsManager::SecretsManager.new(token: TOKEN)
-
-puts "\n=== Step 1: List All Secrets ==="
-begin
-  secrets = sm.get_secrets()
-  puts "Found #{secrets.length} secrets:"
-  secrets.each do |secret|
-    puts "  - #{secret.title} (UID: #{secret.uid})"
-  end
-rescue => e
-  puts "Error: #{e.message}"
-end
-
-# Save a secret UID for later tests
-if secrets.any?
-  test_secret_uid = secrets.first.uid
-  puts "\nUsing secret '#{secrets.first.title}' for testing"
-end
-
-puts "\n=== Step 2: Get Secret Details ==="
-if test_secret_uid
-  secret = sm.get_secrets([test_secret_uid]).first
-  puts "Title: #{secret.title}"
-  puts "Type: #{secret.type}"
-  puts "Fields:"
-  secret.fields.each do |field|
-    puts "  - #{field['type']}: #{field['value'].first rescue 'N/A'}"
-  end
-end
-
-puts "\n=== Step 3: Test Notation ==="
-# Test notation to get password
-notation = "keeper://#{test_secret_uid}/field/password"
-password = sm.get_notation(notation)
-puts "Password via notation: #{password}"
-
-puts "\n=== Step 4: List Folders ==="
-folders = sm.get_folders()
-puts "Found #{folders.length} folders:"
-folders.each do |folder|
-  puts "  - #{folder.name} (UID: #{folder.uid})"
-end
-
-# Save folder UID for record creation
-if folders.any?
-  test_folder_uid = folders.first.uid
-  puts "\nWill use folder '#{folders.first.name}' for new records"
-end
-
-puts "\n=== Step 5: Create New Secret ==="
-if test_folder_uid
-  new_record = KeeperSecretsManager::Dto::KeeperRecord.new(
-    title: "Test Record - #{Time.now.strftime('%Y-%m-%d %H:%M')}",
-    type: 'login',
-    fields: [
-      { 'type' => 'login', 'value' => ['testuser@example.com'] },
-      { 'type' => 'password', 'value' => ['MySecurePassword123!'] },
-      { 'type' => 'url', 'value' => ['https://example.com'] }
-    ],
-    notes: 'Created by Ruby SDK test'
-  )
-  
-  options = KeeperSecretsManager::Dto::CreateOptions.new
-  options.folder_uid = test_folder_uid
-  
-  new_uid = sm.create_secret(new_record, options)
-  puts "Created new secret with UID: #{new_uid}"
-  
-  # Save for cleanup
-  created_uid = new_uid
-else
-  puts "No folders found - skipping record creation"
-end
-
-puts "\n=== Step 6: Update Secret ==="
-if created_uid
-  # Fetch the created record
-  record = sm.get_secrets([created_uid]).first
-  
-  # Update password
-  record.set_field('password', 'UpdatedPassword456!')
-  record.notes = "Updated at #{Time.now}"
-  
-  sm.update_secret(record)
-  puts "Updated secret successfully"
-end
-
-puts "\n=== Step 7: File Operations ==="
-if created_uid
-  # Create a test file
-  test_content = "This is a test file created at #{Time.now}"
-  File.write('test_upload.txt', test_content)
-  
-  # Upload file
-  file_data = File.read('test_upload.txt', mode: 'rb')
-  file_uid = sm.upload_file(created_uid, 'test_upload.txt', file_data)
-  puts "Uploaded file with UID: #{file_uid}"
-  
-  # Download file
-  downloaded = sm.download_file(file_uid)
-  puts "Downloaded file: #{downloaded['name']} (#{downloaded['size']} bytes)"
-  
-  # Save downloaded file
-  File.write('test_download.txt', downloaded['data'], mode: 'wb')
-  puts "Saved to test_download.txt"
-  
-  # Cleanup
-  File.delete('test_upload.txt') if File.exist?('test_upload.txt')
-  File.delete('test_download.txt') if File.exist?('test_download.txt')
-end
-
-puts "\n=== Step 8: Test TOTP ==="
-# Look for a record with TOTP
-secrets.each do |secret|
-  totp_url = sm.get_notation("keeper://#{secret.uid}/field/oneTimeCode") rescue nil
-  if totp_url && totp_url.start_with?('otpauth://')
-    puts "Found TOTP in '#{secret.title}'"
-    params = KeeperSecretsManager::TOTP.parse_url(totp_url)
-    code = KeeperSecretsManager::TOTP.generate_code(params['secret'])
-    puts "Current TOTP code: #{code}"
-    break
-  end
-end
-
-puts "\n=== Step 9: Cleanup ==="
-if created_uid
-  print "Delete test record? (y/n): "
-  if gets.chomp.downcase == 'y'
-    sm.delete_secret([created_uid])
-    puts "Deleted test record"
-  else
-    puts "Kept test record"
-  end
-end
-
-puts "\n=== Testing Complete! ==="
-puts "All basic operations tested successfully"
-```
-
-### Step 2: Run the Test
-
-```bash
-# Make sure you're in the Ruby SDK directory
-cd /Users/mustinov/Source/secrets-manager/sdk/ruby
-
-# Run the test
-ruby my_test.rb
-```
-
-## Common Issues and Solutions
-
-### Issue 1: "No such file or directory"
-```bash
-# Make sure you're in the right directory
-pwd  # Should show: /Users/mustinov/Source/secrets-manager/sdk/ruby
-```
-
-### Issue 2: "Missing gems"
-```bash
-# Install missing gems
-bundle install
-```
-
-### Issue 3: "Invalid token"
-- Make sure your token starts with region code (e.g., `US:`)
-- Token is one-time use only - get a new one if it fails
-
-### Issue 4: "No folders found"
-- The SDK requires folders to create records
-- Create a folder in Keeper first, or use existing ones
-
-## Quick Test Commands
-
-### Test 1: Basic Connection
-```ruby
-ruby -e "require_relative 'lib/keeper_secrets_manager'; sm = KeeperSecretsManager::SecretsManager.new(token: 'YOUR_TOKEN'); puts sm.get_secrets.length"
-```
-
-### Test 2: List Secret Titles
-```ruby
-ruby -e "require_relative 'lib/keeper_secrets_manager'; sm = KeeperSecretsManager::SecretsManager.new(token: 'YOUR_TOKEN'); sm.get_secrets.each { |s| puts s.title }"
-```
-
-### Test 3: Using Config File
-First run saves config, subsequent runs use saved config:
-```ruby
-# First run with token
-ruby -e "require_relative 'lib/keeper_secrets_manager'; config = KeeperSecretsManager::FileStorage.new('my-config.json'); sm = KeeperSecretsManager::SecretsManager.new(token: 'YOUR_TOKEN', config: config); puts 'Config saved!'"
-
-# Subsequent runs without token
-ruby -e "require_relative 'lib/keeper_secrets_manager'; config = KeeperSecretsManager::FileStorage.new('my-config.json'); sm = KeeperSecretsManager::SecretsManager.new(config: config); puts sm.get_secrets.length"
-```
-
-## Interactive Ruby Console
-
-For exploring the SDK interactively:
-
-```bash
-# Start Ruby console
-irb
-
-# In the console, type:
-require_relative 'lib/keeper_secrets_manager'
-sm = KeeperSecretsManager::SecretsManager.new(token: 'YOUR_TOKEN')
-secrets = sm.get_secrets
-secrets.first.title
-secrets.first.fields
-exit
-```
-
-## What to Test
-
-1. **Authentication**: Token works and connects to Keeper
-2. **Read Operations**: Can list and read secrets
-3. **Notation**: Can use keeper:// URIs
-4. **Create**: Can create new records (requires folder)
-5. **Update**: Can modify existing records
-6. **Delete**: Can remove records
-7. **Files**: Can upload/download attachments
-8. **TOTP**: Can generate one-time codes
-9. **Folders**: Can list and manage folders
-
-## Expected Output
-
-Successful run should show:
-```
-Initializing Keeper SDK...
-
-=== Step 1: List All Secrets ===
-Found 5 secrets:
-  - My Login (UID: xxxxx)
-  - API Keys (UID: xxxxx)
-  ...
-
-=== Step 2: Get Secret Details ===
-Title: My Login
-Type: login
-Fields:
-  - login: user@example.com
-  - password: ********
-  ...
-
-[continues through all steps]
-
-=== Testing Complete! ===
-All basic operations tested successfully
-```
-
-## Cleanup
-
-After testing:
-```bash
-# Remove any test files
-rm -f my_test.rb test_upload.txt test_download.txt my-config.json
-
-# Remove any test records created in Keeper
-```
-
-## Next Steps
-
-1. Try modifying the test script to test specific features
-2. Use the examples in the `examples/` directory
-3. Check `test/integration/` for more test scenarios
-4. Review the README.md for API documentation
-
-## Need Help?
-
-- Check error messages - they usually indicate what's wrong
-- Ensure Ruby version is 2.7 or higher
-- Make sure you're in the correct directory
-- Token must be valid and unused
-- Records need to be in folders for creation
-
-Good luck with your testing!