mangoapps-ex-sdk-ruby 0.15.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6cccec279a1fc70385a5657b014077dca6e721739b282e3096c11ec2467c7e4f
+  data.tar.gz: ed85a35c6f145897ea30fc2896cdedb1d6bb2ee8c56011cbe6d1a8159b7728c8
+SHA512:
+  metadata.gz: be17b124f42a6b0c9fd0b4e30c76111265cc384d31c8f4ba3653500660375e885b9912f6c8c74533f558403fdd800f5a50fa6fbe636b76317bfbb7a6b31ebbe5
+  data.tar.gz: e2bd7e5d0658323d56314fbff29711f07a8b860f53a2eaf041465340565e77b94d81c2efaaf8ac8edbdd015531a7eac5c104a25082ac3d7ac3f9fa76c76d6a0c

data/CHANGELOG.md

@@ -0,0 +1,506 @@
+# Changelog
+
+All notable changes to the MangoApps Ruby SDK will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.15.1] - 2024-12-19
+
+### Added
+- **Pagination Support** - Optional page and limit parameters for all list APIs
+  - Added `page` and `limit` parameters to all list APIs for efficient data retrieval
+  - Default pagination values: `page: 1, limit: 20` for most APIs
+  - Special defaults: `limit: 5` for tasks, `filter_by: "all"` for posts
+  - Maintains backward compatibility with existing `params` parameter
+  - Enhanced data retrieval efficiency for large datasets
+  - Comprehensive test coverage for pagination functionality
+
+- **Enhanced Automatic Detection** - Improved `MangoApps::Config.new` behavior
+  - Shows clear feedback about which authentication method is being used
+  - Displays domain, API key (masked), and test header for Internal API
+  - Displays domain, client ID (masked), and redirect URI for OAuth
+  - Works seamlessly with all existing scripts and test frameworks
+  - Enhanced user experience with immediate authentication method feedback
+
+### Updated
+- **Documentation** - Comprehensive updates across all documentation
+  - Updated README with automatic detection examples and priority system
+  - Enhanced DEVELOPER.md with authentication system documentation
+  - Updated RAILS_OAUTH_GUIDE.md with Internal API usage examples
+  - Updated .cursorrules with automatic detection features
+  - Added clear examples of automatic detection behavior
+
+## [0.15.0] - 2024-12-19
+
+### Added
+- **Internal API Authentication** - Alternative authentication method using API keys
+  - `Internal-Api-Key` and `Internal-Api-Secret` header authentication
+  - Optional `Test` header support for testing environments
+  - Automatic header injection for all API requests
+  - Server-to-server communication without OAuth flow
+  - Clean dot notation access: `response.name`, `response.email`, `response.id`
+  - Comprehensive test coverage with internal API validation
+  - Enhanced configuration validation supporting both OAuth and Internal API
+  - Updated README with internal API authentication examples
+
+- **Automatic Authentication Detection** - Smart authentication method detection
+  - `MangoApps::Config.new` automatically detects available authentication methods
+  - Prioritizes Internal API credentials over OAuth credentials
+  - Shows clear feedback about which authentication method is being used
+  - Works seamlessly with all existing scripts and test frameworks
+  - Enhanced user experience with automatic method selection
+  - Updated all documentation with automatic detection examples
+
+## [0.14.0] - 2024-12-19
+
+### Added
+- **OAuth Userinfo API** in OAuth Module
+  - `client.get_userinfo` - Get user information from OAuth userinfo endpoint
+  - Access to OAuth user data including sub, name, email, and preferred_username
+  - Clean dot notation access: `response.name`, `response.email`, `response.preferred_username`
+  - Comprehensive test coverage with OAuth userinfo validation
+  - Enhanced Rails OAuth guide with userinfo integration
+
+## [0.13.0] - 2024-12-19
+
+### Added
+- **Notifications API** in Notifications Module
+  - `client.notifications` - Get user's notifications with unread counts and detailed notification information
+  - Access to comprehensive notification data including IDs, sender information, and notification content
+  - Access to unread counts including what's new, unread feeds, mentions, and direct messages
+  - Access to notification metadata including types, categories, timestamps, and read status
+  - Access to mention tags and client metadata for enhanced notification handling
+  - Clean dot notation access: `response.notifications` with comprehensive notification data
+  - Comprehensive test coverage with real API validation
+
+### Enhanced
+- **Test Coverage** - Added comprehensive test for notifications API (2 total notifications tests)
+- **Documentation** - Updated README with notifications examples and complete workflow
+- **API Completeness** - Notifications module now includes 2 comprehensive endpoints for complete notification management
+
+## [0.12.0] - 2024-12-19
+
+### Removed
+- **Tango Gift Cards API** from Recognitions Module
+  - Removed `client.tango_gift_cards` endpoint and related functionality
+  - Removed tango gift cards module file and test coverage
+  - Updated recognitions module to exclude tango gift cards functionality
+  - Updated documentation to remove tango gift cards references
+
+### Enhanced
+- **API Cleanup** - Streamlined recognitions module by removing unused tango gift cards functionality
+- **Documentation** - Updated README and CHANGELOG to reflect tango gift cards removal
+- **Module Efficiency** - Recognitions module now includes 8 focused endpoints for recognition management
+
+## [0.11.0] - 2024-12-19
+
+### Added
+- **Get Award Feeds API** in Recognitions Module
+  - `client.get_award_feeds` - Get award feeds with comprehensive recognition data
+  - Access to comprehensive award feeds including IDs, types, categories, and recognition points
+  - Access to feed properties including titles, labels, image URLs, and status information
+  - Access to user information including from users, to users, and feed story users
+  - Access to feed interactions including reactions, comments, attachments, and core value tags
+  - Access to feed metadata including creation/update dates, platform, and visibility settings
+  - Access to unread counts including direct messages, mentions, and notification counts
+  - Access to system information including MangoApps version, moderation settings, and mobile pin options
+  - Clean dot notation access: `response.feeds` with comprehensive award feed data
+  - Comprehensive test coverage with real API validation
+
+### Enhanced
+- **Test Coverage** - Added comprehensive test for get award feeds API (8 total recognitions tests)
+- **Documentation** - Updated README with get award feeds examples and complete workflow
+- **API Completeness** - Recognitions module now includes 8 comprehensive endpoints for complete recognition management
+
+## [0.10.0] - 2024-12-19
+
+### Added
+- **Get Wiki Details API** in Wikis Module
+  - `client.get_wiki_details(wiki_id)` - Get detailed information for a specific wiki by ID
+  - Access to comprehensive wiki details including IDs, titles, descriptions, and metadata
+  - Access to wiki properties including status, platform, creation/update dates, and user information
+  - Access to wiki permissions including edit, delete, rename, move, and duplicate capabilities
+  - Access to wiki content including descriptions, banner URLs, and icon properties
+  - Access to wiki interactions including reactions, comments, attachments, and hashtags
+  - Access to wiki structure including TOC, governance, and archival information
+  - Clean dot notation access: `response.wiki` with comprehensive wiki details
+  - Comprehensive test coverage with real API validation
+
+### Enhanced
+- **Test Coverage** - Added comprehensive test for get wiki details API (2 total wikis tests)
+- **Documentation** - Updated README with get wiki details examples and complete workflow
+- **API Completeness** - Wikis module now includes 2 comprehensive endpoints for complete wiki management
+
+## [0.9.0] - 2024-12-19
+
+### Added
+- **Wikis Module** - New module for wiki management
+  - `client.get_wikis(mode: "my", limit: 20, offset: 0)` - Get user's wikis with filtering, pagination, and detailed wiki information
+  - Access to comprehensive wiki data including IDs, titles, children counts, and update dates
+  - Access to wiki properties including conversation details, edit permissions, and draft status
+  - Access to wiki metadata including icon properties, PDF access, and governance settings
+  - Access to wiki context including user information, status, and image URLs
+  - Clean dot notation access: `response.wikis` with comprehensive wiki data
+  - Comprehensive test coverage with real API validation
+
+### Enhanced
+- **Test Coverage** - Added comprehensive test for wikis module (1 total wikis test)
+- **Documentation** - Updated README with wikis examples and complete workflow
+- **Module Architecture** - Added new wikis module following established patterns
+- **Test Runner** - Updated run_tests.sh to include wikis module testing
+
+## [0.8.0] - 2024-12-19
+
+### Added
+- **Get Task Details API** in Tasks Module
+  - `client.get_task_details(task_id)` - Get detailed information for a specific task by ID
+  - Access to comprehensive task details including IDs, titles, status, assignments, and due dates
+  - Access to task properties including overdue status, milestones, projects, and priorities
+  - Access to task metadata including reviewers, next actions, attachments, and links
+  - Access to task timeline including started, finished, delivered, reopened, and restarted dates
+  - Access to task content including task description and notes
+  - Clean dot notation access: `response.task` with comprehensive task details
+  - Comprehensive test coverage with real API validation
+
+### Enhanced
+- **Test Coverage** - Added comprehensive test for get task details API (2 total tasks tests)
+- **Documentation** - Updated README with get task details examples and complete workflow
+- **API Completeness** - Tasks module now includes 2 comprehensive endpoints for complete task management
+
+## [0.7.0] - 2024-12-19
+
+### Added
+- **Tasks Module** - New module for task management
+  - `client.get_tasks(filter: "Pending_Tasks", page: 1, limit: 5)` - Get user's tasks with filtering, pagination, and detailed task information
+  - Access to comprehensive task data including IDs, titles, status, assignments, and due dates
+  - Access to task properties including overdue status, milestones, projects, and priorities
+  - Access to task metadata including reviewers, next actions, attachments, and links
+  - Clean dot notation access: `response.tasks.task` with comprehensive task data
+  - Comprehensive test coverage with real API validation
+
+### Enhanced
+- **Test Coverage** - Added comprehensive test for tasks module (1 total tasks test)
+- **Documentation** - Updated README with tasks examples and complete workflow
+- **Module Architecture** - Added new tasks module following established patterns
+- **Test Runner** - Updated run_tests.sh to include tasks module testing
+
+## [0.6.0] - 2024-12-19
+
+### Added
+- **Get Folder Files API** in Attachments Module
+  - `client.get_folder_files(folder_id, include_folders: "Y")` - Get files and folders inside a specific folder
+  - Access to comprehensive file and folder data including names, IDs, sizes, uploaders, and permissions
+  - Access to file properties including pinned status, liked status, visibility, and role permissions
+  - Access to folder metadata including total counts, role names, and domain suspension status
+  - Clean dot notation access: `response.files` with comprehensive file/folder data
+  - Comprehensive test coverage with real API validation
+
+### Enhanced
+- **Test Coverage** - Added comprehensive test for get folder files API (2 total attachments tests)
+- **Documentation** - Updated README with get folder files examples and complete workflow
+- **API Completeness** - Attachments module now includes 2 comprehensive endpoints for complete file management
+
+## [0.5.0] - 2024-12-19
+
+### Added
+- **Attachments Module** - New module for file and folder management
+  - `client.get_folders` - Get user's file folders with permissions and metadata
+  - Access to folder data including names, IDs, paths, child counts, and permissions
+  - Access to folder properties including pinned status, virtual folders, and upload/move permissions
+  - Clean dot notation access: `response.folders` with comprehensive folder data
+  - Comprehensive test coverage with real API validation
+
+### Enhanced
+- **Test Coverage** - Added comprehensive test for attachments module (1 total attachments test)
+- **Documentation** - Updated README with attachments examples and complete workflow
+- **Module Architecture** - Added new attachments module following established patterns
+- **Test Runner** - Updated run_tests.sh to include attachments module testing
+
+## [0.4.0] - 2024-12-19
+
+### Added
+- **Trackers Module** - New module for tracker management
+  - `client.get_trackers` - Get user's trackers with submission dates and conversation details
+  - Access to tracker data including names, IDs, submission dates, pinned status, and conversation info
+  - Access to tracker icon information with color codes and icon URLs
+  - Clean dot notation access: `response.trackers` with comprehensive tracker data
+  - Comprehensive test coverage with real API validation
+
+### Enhanced
+- **Test Coverage** - Added comprehensive test for trackers module (1 total trackers test)
+- **Documentation** - Updated README with trackers examples and complete workflow
+- **Module Architecture** - Added new trackers module following established patterns
+- **Test Runner** - Updated run_tests.sh to include trackers module testing
+
+## [0.3.2] - 2024-12-19
+
+### Added
+- **Get Library Items API** in Libraries Module
+  - `client.get_library_items(library_id, category_id)` - Get library items by library ID and category ID
+  - Access to library items including external links and attachments with full metadata
+  - Support for different link types (ExternalLink, Attachment) with specific properties
+  - Clean dot notation access: `response.library_items` with comprehensive item data
+  - Comprehensive test coverage with real API validation
+
+### Enhanced
+- **Test Coverage** - Added comprehensive test for get library items API (3 total libraries tests)
+- **Documentation** - Updated README with get library items examples and complete workflow
+- **API Completeness** - Libraries module now includes 3 comprehensive endpoints for complete library management
+
+## [0.3.1] - 2024-12-19
+
+### Added
+- **Get Library Categories API** in Libraries Module
+  - `client.get_library_categories(library_id)` - Get detailed library information and categories by library ID
+  - Access to comprehensive library details including properties, metadata, and all categories
+  - Clean dot notation access: `response.library` with detailed library data and categories
+  - Comprehensive test coverage with real API validation
+
+### Enhanced
+- **Test Coverage** - Added comprehensive test for get library categories API (2 total libraries tests)
+- **Documentation** - Updated README with get library categories examples and complete workflow
+- **API Completeness** - Libraries module now includes 2 comprehensive endpoints for complete library management
+
+## [0.3.0] - 2024-12-19
+
+### Added
+- **Libraries Module** - New module for document library management
+  - `client.get_libraries` - Get user's document libraries with categories and items
+  - Access to library data including names, types, view modes, descriptions, edit access, and positions
+  - Access to library categories with item counts, ranks, and system flags
+  - Clean dot notation access: `response.libraries` with comprehensive library data
+  - Comprehensive test coverage with real API validation
+
+### Enhanced
+- **Test Coverage** - Added comprehensive test for libraries module (1 total libraries test)
+- **Documentation** - Updated README with libraries examples and complete workflow
+- **Module Architecture** - Added new libraries module following established patterns
+- **Test Runner** - Updated run_tests.sh to include libraries module testing
+
+## [0.2.9] - 2024-12-19
+
+### Added
+- **Get Post By ID API** in Posts Module
+  - `client.get_post_by_id(post_id, full_description: "Y")` - Get detailed post information by ID
+  - Access to comprehensive post details including creator info, permissions, tiles, and full descriptions
+  - Clean dot notation access: `response.post` with detailed post data and metadata
+  - Comprehensive test coverage with real API validation
+
+### Enhanced
+- **Test Coverage** - Added comprehensive test for get post by ID API (2 total posts tests)
+- **Documentation** - Updated README with get post by ID examples and complete workflow
+- **API Completeness** - Posts module now includes 2 comprehensive endpoints for complete post management
+
+## [0.2.8] - 2024-12-19
+
+### Added
+- **Posts Module** - New module for post management
+  - `client.get_all_posts(filter_by: "all")` - Get all posts with filtering options
+  - Access to post data including titles, authors, groups, view counts, comments, and tiles
+  - Clean dot notation access: `response.feeds`, `response.post_view_count_visibility`, and `response.post_view_count_link_config`
+  - Comprehensive test coverage with real API validation
+
+### Enhanced
+- **Test Coverage** - Added comprehensive test for posts module (1 total posts test)
+- **Documentation** - Updated README with posts examples and complete workflow
+- **Module Architecture** - Added new posts module following established patterns
+- **Test Runner** - Updated run_tests.sh to include posts module testing
+
+## [0.2.7] - 2024-12-19
+
+### Added
+- **Feeds Module** - New module for user activity feeds
+  - `client.feeds` - Get user's activity feeds with unread counts and feed details
+  - Access to feed data including titles, authors, groups, timestamps, and content
+  - Clean dot notation access: `response.feeds`, `response.unread_counts`, and `response.limit`
+  - Comprehensive test coverage with real API validation
+
+### Enhanced
+- **Test Coverage** - Added comprehensive test for feeds module (1 total feeds test)
+- **Documentation** - Updated README with feeds examples and complete workflow
+- **Module Architecture** - Added new feeds module following established patterns
+- **Test Runner** - Updated run_tests.sh to include feeds module testing
+
+## [0.2.6] - 2024-12-19
+
+### Added
+- **Notifications Module** - New module for user notifications and priority items
+  - `client.my_priority_items` - Get user's priority items including requests, events, quizzes, surveys, tasks, and todos
+  - Access to priority item details with counts, action types, icons, and descriptions
+  - Clean dot notation access: `response.data`, `response.success`, and `response.display_type`
+  - Comprehensive test coverage with real API validation
+
+### Enhanced
+- **Test Coverage** - Added comprehensive test for notifications module (1 total notifications test)
+- **Documentation** - Updated README with notifications examples and complete workflow
+- **Module Architecture** - Added new notifications module following established patterns
+- **Test Runner** - Updated run_tests.sh to include notifications module testing
+
+## [0.2.5] - 2024-12-19
+
+### Added
+- **Get Team Awards API** in Recognitions Module
+  - `client.get_team_awards(project_id: id)` - Get team awards for a specific project/team
+  - Access to team award feeds, core value tags, and notification counts
+  - Clean dot notation access: `response.feeds`, `response.core_value_tags`, and `response.unread_counts`
+  - Comprehensive test coverage with real API validation using All Users team
+
+### Enhanced
+- **Test Coverage** - Added comprehensive test for get team awards API (8 total recognitions tests)
+- **Documentation** - Updated README with get team awards examples and complete recognition workflow
+- **API Completeness** - Recognitions module now includes 8 comprehensive endpoints for complete recognition management
+
+## [0.2.4] - 2024-12-19
+
+### Added
+- **Get Awards List API** in Recognitions Module
+  - `client.get_awards_list(category_id: id)` - Get awards for a specific category
+  - Access to award details including name, description, points, reward points, and attachment URLs
+  - Clean dot notation access: `response.get_awards_list` with comprehensive award data
+  - Comprehensive test coverage with real API validation using Safety & Quality category
+
+### Enhanced
+- **Test Coverage** - Added comprehensive test for get awards list API (6 total recognitions tests)
+- **Documentation** - Updated README with get awards list examples and complete recognition workflow
+- **API Completeness** - Recognitions module now includes 6 comprehensive endpoints for complete recognition management
+
+## [0.2.3] - 2024-12-19
+
+### Added
+- **Gift Cards API** in Recognitions Module
+  - `client.gift_cards` - Get available gift cards for recognition rewards
+  - Access to gift card brands, descriptions, and availability status
+  - Clean dot notation access: `response.cards` with `brand_name`, `brand_key`, `description`, and `enabled` fields
+  - Comprehensive test coverage with real API validation
+
+### Enhanced
+- **Test Coverage** - Added comprehensive test for gift cards API (5 total recognitions tests)
+- **Documentation** - Updated README with gift cards examples and complete recognition management workflow
+- **API Completeness** - Recognitions module now includes 5 comprehensive endpoints
+
+## [0.2.2] - 2024-12-19
+
+### Added
+- **Tango Gift Cards API** in Recognitions Module
+  - `client.tango_gift_cards` - Get tango gift cards information and available points
+  - Access to gift card terms and available points for recognition rewards
+  - Clean dot notation access: `response.tango_cards.available_points` and `response.tango_cards.terms`
+- **Enhanced Test Runner** with module-specific testing
+  - `./run_tests.sh [module]` - Run tests for specific modules (learn, users, recognitions)
+  - `./run_tests.sh all` - Run all tests (default behavior)
+  - `./run_tests.sh help` - Show usage help and available modules
+  - Improved error handling and user-friendly output
+
+### Enhanced
+- **Test Coverage** - Added comprehensive test for tango gift cards API
+- **Documentation** - Updated README with tango gift cards examples and new test runner usage
+- **Developer Experience** - Faster development with module-specific testing capabilities
+
+## [0.2.1] - 2024-12-19
+
+### Added
+- **Course Details API** in Learn Module
+  - `client.course_details(course_id)` - Get detailed course information by course ID
+  - Comprehensive course data including description, instructors, fields, and URLs
+  - Support for course metadata like certification details and skill requirements
+
+## [0.2.0] - 2024-12-19
+
+### Added
+- **Recognitions Module** with comprehensive recognition management APIs
+  - `client.award_categories` - Get recognition award categories
+  - `client.core_value_tags` - Get core value tags for recognition
+  - `client.leaderboard_info` - Get user and team leaderboard information
+- **Enhanced Learn Module** with user learning progress tracking
+  - `client.my_learning` - Get user's learning progress and course information
+- **Improved Response API** with clean dot notation access for all endpoints
+- **Robust Error Handling** for APIs that may return empty data (e.g., leaderboard)
+
+### Enhanced
+- **Modular Architecture** - Recognitions module uses folder structure like Learn module
+- **Comprehensive Testing** - All new APIs tested with real OAuth integration
+- **Documentation** - Complete README examples for all recognition features
+- **Test Coverage** - 7 comprehensive API tests covering all modules
+
+### Technical Improvements
+- **Folder Structure** - Recognitions module organized with sub-modules for scalability
+- **Error Resilience** - Tests handle both populated and empty API responses gracefully
+- **Clean API Design** - Consistent method naming and response handling across all modules
+
+## [0.1.0] - 2024-12-19
+
+### Added
+- **Initial Release** of MangoApps Ruby SDK
+- **OAuth2/OpenID Connect** authentication with automatic token refresh
+- **Modular Architecture** for easy API organization and extension
+- **Real TDD Testing** with actual MangoApps API integration (no mocking)
+- **Comprehensive Error Handling** with detailed request/response logging
+- **Environment Variable Configuration** for secure credential management
+
+### Features
+- **Users Module**
+  - `client.me` - Get current user profile information
+  - User authentication validation
+  - Detailed error logging for failed requests
+
+- **Learn Module**
+  - `client.course_catalog` - Get available courses
+  - `client.course_categories` - Get course categories
+  - `client.course_category(id)` - Get specific category details
+
+### Development Tools
+- **Separated Scripts** for OAuth and testing workflows
+  - `./run_auth.sh` - Interactive OAuth token acquisition
+  - `./run_tests.sh` - Fast API testing with token validation
+- **Module Generator** (`generate_module.rb`) for automated module creation
+- **Shared Test Helpers** for consistent testing patterns
+- **Development Documentation** (`MODULES.md`)
+
+### Technical Implementation
+- **Faraday HTTP Client** with retry middleware and JSON handling
+- **PKCE Support** for secure OAuth2 flows
+- **Token Management** with automatic refresh capabilities
+- **Structured Error Classes** for different API error scenarios
+- **Request/Response Logging** for debugging failed API calls
+
+### Testing
+- **Real API Integration Tests** using actual MangoApps endpoints
+- **Comprehensive Test Coverage** for all implemented modules
+- **Error Scenario Testing** with detailed logging
+- **OAuth Flow Testing** with token validation
+
+### Documentation
+- **Complete README** with setup instructions and examples
+- **API Documentation** with usage examples for each module
+- **Development Guidelines** for adding new modules
+- **Configuration Examples** for different use cases
+
+### Security
+- **Environment Variable** configuration for sensitive data
+- **PKCE OAuth2** implementation for public clients
+- **Secure Token Storage** and management
+- **Input Validation** and sanitization
+
+---
+
+## Development Notes
+
+### Architecture Decisions
+- **Modular Design**: Each API area (Users, Learn, etc.) is organized into separate modules
+- **Real TDD**: All tests use actual MangoApps API calls for authentic validation
+- **Error Handling**: Comprehensive error logging with full request/response details
+- **Scalability**: Easy to add new modules using the generator script
+
+### Future Roadmap
+- **Files Module**: File upload/download and management
+- **Posts Module**: Social posts and announcements
+- **Groups Module**: User groups and permissions
+- **Projects Module**: Project management features
+- **Tasks Module**: Task tracking and management
+- **Events Module**: Calendar and event management
+- **Documents Module**: Document management
+- **Announcements Module**: Company announcements
+
+### Contributing
+See [MODULES.md](MODULES.md) for guidelines on adding new modules and APIs.