lsa_tdx_feedback 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5896d4658c9650d7701c7d01749c6711ce587e96c24359e782ff9c0389a2519c
+  data.tar.gz: 939f0bf40ef322b8f2476a7ec7b2a5c352a7cfdfee4f56529a7d6c2b9e779515
+SHA512:
+  metadata.gz: fff2fe97da072eb680cfaad57ada3ab31875424005fc9e85c90c664b5802e2d0be4145649b7bb6cea8d68eae1ae4fcd0626aa0146a8a05119492e4e7abf82a1f
+  data.tar.gz: 785ff50bf9f04c511bbaf223212986ee98c6861b196b4a1ab22c9de8ebc5b2050231c728aa18bf6b86cba68f28eb409f77f750ad8d260538e01c4d02f1fab4be

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,49 @@
+# Changelog
+
+All notable changes to this project 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).
+
+## [Unreleased]
+
+### Fixed
+- **TDX API Integration Issues**: Resolved HTTP 422 errors when creating tickets
+  - Fixed invalid Classification value (changed from 300 to 46)
+  - Updated configuration validation to handle both string and integer values for `default_classification`
+  - Simplified ticket payload structure to include only essential fields
+  - Fixed string interpolation in `build_description` method
+  - Changed description format from HTML to plain text to avoid parsing issues
+  - Removed unnecessary fields that were causing 500 errors
+
+### Technical Improvements
+- Enhanced configuration validation for better error handling
+- Streamlined ticket payload to include only required TDX API fields:
+  - TypeID, Classification, Title, Description
+  - RequestorEmail, SourceID, ServiceID
+  - ResponsibleGroupID, AccountID
+- Improved error handling and debugging capabilities
+
+## [0.1.0] - 2024-01-XX
+
+### Added
+- Initial release of FeedbackGem
+- Self-contained feedback modal with responsive design
+- TDX API integration for ticket creation
+- OAuth client credentials flow authentication
+- Zero-configuration setup with Rails credentials support
+- Automatic context capture (URL, user agent, user email)
+- Smart token caching for optimal performance
+- Mobile-responsive design
+- Framework-agnostic CSS and JavaScript
+- Comprehensive documentation and examples
+
+### Features
+- Beautiful, accessible feedback modal
+- Multiple feedback categories with automatic priority mapping
+- Real-time form validation and submission
+- Loading states and error handling
+- Keyboard navigation support (ESC to close)
+- CSRF protection for secure form submission
+- Automatic asset pipeline integration
+- View helpers for easy integration

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lsa_tdx_feedback.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 1.21'

data/Gemfile.lock

@@ -0,0 +1,328 @@
+PATH
+  remote: .
+  specs:
+    lsa_tdx_feedback (1.0.0)
+      httparty (~> 0.22)
+      rails (>= 6.0)
+      redis (>= 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (8.0.2.1)
+      actionpack (= 8.0.2.1)
+      activesupport (= 8.0.2.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (8.0.2.1)
+      actionpack (= 8.0.2.1)
+      activejob (= 8.0.2.1)
+      activerecord (= 8.0.2.1)
+      activestorage (= 8.0.2.1)
+      activesupport (= 8.0.2.1)
+      mail (>= 2.8.0)
+    actionmailer (8.0.2.1)
+      actionpack (= 8.0.2.1)
+      actionview (= 8.0.2.1)
+      activejob (= 8.0.2.1)
+      activesupport (= 8.0.2.1)
+      mail (>= 2.8.0)
+      rails-dom-testing (~> 2.2)
+    actionpack (8.0.2.1)
+      actionview (= 8.0.2.1)
+      activesupport (= 8.0.2.1)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actiontext (8.0.2.1)
+      actionpack (= 8.0.2.1)
+      activerecord (= 8.0.2.1)
+      activestorage (= 8.0.2.1)
+      activesupport (= 8.0.2.1)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (8.0.2.1)
+      activesupport (= 8.0.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (8.0.2.1)
+      activesupport (= 8.0.2.1)
+      globalid (>= 0.3.6)
+    activemodel (8.0.2.1)
+      activesupport (= 8.0.2.1)
+    activerecord (8.0.2.1)
+      activemodel (= 8.0.2.1)
+      activesupport (= 8.0.2.1)
+      timeout (>= 0.4.0)
+    activestorage (8.0.2.1)
+      actionpack (= 8.0.2.1)
+      activejob (= 8.0.2.1)
+      activerecord (= 8.0.2.1)
+      activesupport (= 8.0.2.1)
+      marcel (~> 1.0)
+    activesupport (8.0.2.1)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.3)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.3)
+    builder (3.3.0)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.4)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    crass (1.0.6)
+    csv (3.3.5)
+    date (3.4.1)
+    diff-lcs (1.6.2)
+    drb (2.2.3)
+    erb (5.0.2)
+    erubi (1.13.1)
+    factory_bot (6.5.5)
+      activesupport (>= 6.1.0)
+    factory_bot_rails (6.5.1)
+      factory_bot (~> 6.5)
+      railties (>= 6.1.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    hashdiff (1.2.1)
+    httparty (0.23.1)
+      csv
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    io-console (0.8.1)
+    irb (1.15.2)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.15.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    loofah (2.24.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.1.0)
+    mini_mime (1.1.5)
+    minitest (5.25.5)
+    multi_xml (0.7.2)
+      bigdecimal (~> 3.1)
+    net-imap (0.5.10)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
+    nio4r (2.7.4)
+    nokogiri (1.18.10-aarch64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.10-aarch64-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.10-arm-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.10-arm-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.10-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.10-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.10-x86_64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.10-x86_64-linux-musl)
+      racc (~> 1.4)
+    parallel (1.27.0)
+    parser (3.3.9.0)
+      ast (~> 2.4.1)
+      racc
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.5.1)
+    psych (5.2.6)
+      date
+      stringio
+    public_suffix (6.0.2)
+    racc (1.8.1)
+    rack (3.2.1)
+    rack-session (2.1.1)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails (8.0.2.1)
+      actioncable (= 8.0.2.1)
+      actionmailbox (= 8.0.2.1)
+      actionmailer (= 8.0.2.1)
+      actionpack (= 8.0.2.1)
+      actiontext (= 8.0.2.1)
+      actionview (= 8.0.2.1)
+      activejob (= 8.0.2.1)
+      activemodel (= 8.0.2.1)
+      activerecord (= 8.0.2.1)
+      activestorage (= 8.0.2.1)
+      activesupport (= 8.0.2.1)
+      bundler (>= 1.15.0)
+      railties (= 8.0.2.1)
+    rails-dom-testing (2.3.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (8.0.2.1)
+      actionpack (= 8.0.2.1)
+      activesupport (= 8.0.2.1)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.3.0)
+    rdoc (6.14.2)
+      erb
+      psych (>= 4.0.0)
+    redis (5.4.1)
+      redis-client (>= 0.22.0)
+    redis-client (0.25.3)
+      connection_pool
+    regexp_parser (2.11.3)
+    reline (0.6.2)
+      io-console (~> 0.5)
+    rexml (3.4.4)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.5)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-rails (5.1.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.13.6)
+    rubocop (1.80.2)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.46.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.47.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-capybara (2.22.1)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    rubocop-factory_bot (2.27.1)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    rubocop-rails (2.33.3)
+      activesupport (>= 4.2.0)
+      lint_roller (~> 1.1)
+      rack (>= 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+    rubocop-rspec (2.31.0)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.29.1)
+      rubocop (~> 1.61)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    stringio (3.1.7)
+    thor (1.4.0)
+    timeout (0.4.3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
+    uri (1.0.3)
+    useragent (0.16.11)
+    vcr (6.3.1)
+      base64
+    webmock (3.25.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    websocket-driver (0.8.0)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.7.3)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  factory_bot_rails (~> 6.0)
+  lsa_tdx_feedback!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rspec-rails (~> 5.0)
+  rubocop (~> 1.21)
+  rubocop-rails (~> 2.0)
+  rubocop-rspec (~> 2.0)
+  vcr (~> 6.0)
+  webmock (~> 3.0)
+
+BUNDLED WITH
+   2.6.9

data/INSTALLATION.md

@@ -0,0 +1,244 @@
+# Installation and Setup Guide
+
+This guide will walk you through setting up LsaTdxFeedback in your Rails application.
+
+## Prerequisites
+
+- Rails 6.0 or higher
+- Redis (for token caching)
+- TDX API credentials from your administrator
+
+## Step 1: Add the Gem
+
+Add LsaTdxFeedback to your Gemfile:
+
+```ruby
+gem 'lsa_tdx_feedback'
+```
+
+Run bundle install:
+
+```bash
+bundle install
+```
+
+## Step 2: Configure TDX Credentials
+
+### Option A: Rails Credentials (Recommended)
+
+Edit your Rails credentials:
+
+```bash
+rails credentials:edit
+```
+
+Add your TDX configuration:
+
+```yaml
+lsa_tdx_feedback:
+  # Required OAuth Configuration
+  oauth_url: 'https://your-tdx-instance.com/oauth2'  # Note: Do NOT include /token
+  api_base_url: 'https://your-tdx-instance.com/api'
+  client_id: your_tdx_client_id_here
+  client_secret: your_tdx_client_secret_here
+
+  # Required TDX Configuration
+  app_id: 31
+  account_id: 456
+  service_offering_id: 789
+
+  # Required Ticket Configuration
+  default_type_id: 100
+  default_form_id: 200
+  default_classification: '300'
+  default_status_id: 400
+  default_priority_id: 500
+  default_source_id: 600
+  default_responsible_group_id: 700
+  default_service_id: 800
+```
+
+**Note**: The gem will automatically configure itself from these credentials - no additional setup required!
+
+### Option B: Environment Variables
+
+Create an initializer file:
+
+```ruby
+# config/initializers/lsa_tdx_feedback.rb
+LsaTdxFeedback.configure do |config|
+  config.client_id = ENV['TDX_CLIENT_ID']
+  config.client_secret = ENV['TDX_CLIENT_SECRET']
+  config.default_responsible_group_id = ENV['TDX_RESPONSIBLE_GROUP_ID'].to_i
+end
+```
+
+Then set your environment variables:
+
+```bash
+export TDX_CLIENT_ID="your_client_id"
+export TDX_CLIENT_SECRET="your_client_secret"
+export TDX_RESPONSIBLE_GROUP_ID="123"
+```
+
+## Step 3: Mount the Engine Routes
+
+Add the feedback gem routes to your application's `config/routes.rb`:
+
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  # Your existing routes...
+
+  # Mount the feedback gem engine
+  mount LsaTdxFeedback::Engine => "/lsa_tdx_feedback", as: "lsa_tdx_feedback"
+end
+```
+
+## Step 4: Add to Your Layout
+
+Add the feedback modal to your application layout:
+
+```erb
+<!-- app/views/layouts/application.html.erb -->
+<!DOCTYPE html>
+<html>
+  <head>
+    <!-- Your existing head content -->
+    <%= lsa_tdx_feedback_css %>
+  </head>
+
+  <body>
+    <!-- Your existing body content -->
+
+    <!-- Add the feedback modal -->
+    <%= lsa_tdx_feedback_modal %>
+
+    <!-- Add the JavaScript before closing body tag -->
+    <%= lsa_tdx_feedback_js %>
+  </body>
+</html>
+```
+
+Or use the all-in-one helper:
+
+```erb
+<!-- app/views/layouts/application.html.erb -->
+<!DOCTYPE html>
+<html>
+  <head>
+    <!-- Your existing head content -->
+  </head>
+
+  <body>
+    <!-- Your existing body content -->
+
+    <!-- Add feedback gem (includes both assets and modal) -->
+    <%= lsa_tdx_feedback %>
+  </body>
+</html>
+```
+
+## Step 5: Customize User Email (Optional)
+
+Override the user email detection in your ApplicationController:
+
+```ruby
+# app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  private
+
+  def current_user_email_for_feedback
+    current_user&.email # Adjust based on your user model
+  end
+end
+```
+
+## Step 6: Test the Installation
+
+1. Start your Rails server:
+   ```bash
+   rails server
+   ```
+
+2. Navigate to any page in your application
+
+3. Look for the blue "Feedback" button in the bottom-right corner
+
+4. Click it to open the feedback modal
+
+5. Submit a test feedback to verify it creates a ticket in TDX
+
+## Troubleshooting
+
+### Common Issues
+
+**1. Modal doesn't appear or form submission fails**
+- Check that you've included the gem in your layout
+- **Verify you've mounted the engine routes** in your `config/routes.rb`
+- Check browser console for JavaScript errors
+- Ensure CSS is loading properly
+- Verify the `/lsa_tdx_feedback/feedback` endpoint is accessible
+
+**2. "client_id is required" error**
+- Verify your credentials are configured correctly
+- Check Rails credentials with `rails credentials:show`
+- Ensure environment variables are set if using that approach
+
+**3. OAuth/API errors**
+- Verify your TDX credentials are correct
+- **Ensure oauth_url does NOT include /token** (e.g., use `https://your-tdx.com/oauth2` not `https://your-tdx.com/oauth2/token`)
+- Check that your responsible group ID exists in TDX
+- Ensure your TDX instance URLs are correct (default is UMich test environment)
+
+**4. Styling conflicts**
+- All LsaTdxFeedback styles are prefixed with `feedback-gem-`
+- Use browser dev tools to identify conflicts
+- Override styles in your application CSS if needed
+
+### Debug Mode
+
+Enable debug logging in your Rails environment:
+
+```ruby
+# config/environments/development.rb
+config.log_level = :debug
+```
+
+This will log OAuth requests and API calls for troubleshooting.
+
+## Advanced Configuration
+
+### Custom TDX Instance
+
+If you're using a different TDX instance than University of Michigan:
+
+```ruby
+LsaTdxFeedback.configure do |config|
+  config.oauth_url = "https://your-tdx-oauth-url"
+  config.api_base_url = "https://your-tdx-api-url"
+  # ... other config
+end
+```
+
+### Custom Ticket Defaults
+
+Override default ticket values:
+
+```ruby
+LsaTdxFeedback.configure do |config|
+  config.default_type_id = 28
+  config.default_priority_id = 20
+  config.default_status_id = 77
+  # ... other defaults
+end
+```
+
+## Support
+
+If you encounter issues:
+
+1. Check the troubleshooting section above
+2. Review the main README.md for detailed documentation
+3. Check the GitHub issues page
+4. Contact your TDX administrator for API-related questions

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Your Name
+
+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.