lsa_tdx_feedback 1.0.0

data/lib/lsa_tdx_feedback/oauth_client.rb

@@ -0,0 +1,81 @@
+require 'httparty'
+require 'base64'
+
+module LsaTdxFeedback
+  class OAuthClient
+    include HTTParty
+
+    def initialize(configuration = LsaTdxFeedback.configuration)
+      @configuration = configuration
+      @configuration.validate!
+
+      self.class.base_uri(@configuration.oauth_url)
+      self.class.headers({
+        'Content-Type' => 'application/x-www-form-urlencoded',
+        'Accept' => 'application/json'
+      })
+    end
+
+    def get_access_token
+      # Check cache first
+      cached_token = Rails.cache.read(cache_key)
+      return cached_token if cached_token
+
+      # Get new token
+      token_response = fetch_new_token
+
+      if token_response.success?
+        token_data = token_response.parsed_response
+        access_token = token_data['access_token']
+        expires_in = token_data['expires_in'].to_i
+
+        # Cache the token with some buffer time (subtract 5 minutes)
+        cache_duration = [expires_in - 300, 300].max
+        Rails.cache.write(cache_key, access_token, expires_in: cache_duration)
+
+        access_token
+      else
+        handle_error_response(token_response)
+      end
+    end
+
+    private
+
+    def fetch_new_token
+      auth_header = Base64.strict_encode64("#{@configuration.client_id}:#{@configuration.client_secret}")
+
+      response = self.class.post('/token',
+        headers: {
+          'Authorization' => "Basic #{auth_header}"
+        },
+        body: {
+          grant_type: @configuration.grant_type,
+          scope: @configuration.oauth_scope
+        }.to_query
+      )
+
+      response
+    end
+
+    def handle_error_response(response)
+      error_data = response.parsed_response
+
+      Rails.logger.error "LsaTdxFeedback: OAuth Error - HTTP #{response.code}"
+      Rails.logger.error "LsaTdxFeedback: OAuth Error Response: #{response.body}"
+
+      error_message = if error_data.is_a?(Hash) && error_data['errorMessage']
+                       "OAuth Error: #{error_data['errorMessage']} (Code: #{error_data['errorCode']})"
+                     elsif error_data.is_a?(Hash) && error_data['error']
+                       "OAuth Error: #{error_data['error']} - #{error_data['error_description']}"
+                     else
+                       "OAuth Error: HTTP #{response.code} - #{response.message}"
+                     end
+
+      raise Error, error_message
+    end
+
+    def cache_key
+      "lsa_tdx_feedback:oauth_token:#{Digest::MD5.hexdigest(@configuration.client_id)}"
+    end
+  end
+end

data/lib/lsa_tdx_feedback/ticket_client.rb

@@ -0,0 +1,106 @@
+require 'httparty'
+
+module LsaTdxFeedback
+  class TicketClient
+    include HTTParty
+
+    def initialize(configuration = LsaTdxFeedback.configuration)
+      @configuration = configuration
+      @configuration.validate!
+      @oauth_client = OAuthClient.new(configuration)
+
+      self.class.base_uri(@configuration.api_base_url)
+      self.class.headers({
+        'Content-Type' => 'application/json',
+        'Accept' => 'application/json'
+      })
+    end
+
+    def create_feedback_ticket(feedback_data)
+      ticket_payload = build_ticket_payload(feedback_data)
+
+      response = self.class.post("/#{@configuration.app_id}/tickets",
+        headers: {
+          'Authorization' => "Bearer #{@oauth_client.get_access_token}"
+        },
+        body: ticket_payload.to_json
+      )
+
+      if response.success?
+        response.parsed_response
+      else
+        handle_error_response(response)
+      end
+    end
+
+    private
+
+    def build_ticket_payload(feedback_data)
+      {
+        TypeID: @configuration.default_type_id,
+        Classification: @configuration.default_classification,
+        Title: feedback_data[:title] || 'User Feedback',
+        Description: build_description(feedback_data),
+        RequestorEmail: feedback_data[:email],
+        SourceID: @configuration.default_source_id,
+        ServiceID: @configuration.default_service_id,
+        ResponsibleGroupID: @configuration.default_responsible_group_id,
+        AccountID: @configuration.account_id
+      }.compact
+    end
+
+    def build_description(feedback_data)
+      description_parts = []
+
+      description_parts << 'User Feedback'
+      description_parts << ''
+      description_parts << "Feedback: #{feedback_data[:feedback]}"
+
+      if feedback_data[:category].present?
+        description_parts << "Category: #{feedback_data[:category]}"
+      end
+
+      if feedback_data[:url].present?
+        description_parts << "Page URL: #{feedback_data[:url]}"
+      end
+
+      if feedback_data[:user_agent].present?
+        description_parts << "Browser: #{feedback_data[:user_agent]}"
+      end
+
+      if feedback_data[:additional_info].present?
+        description_parts << ''
+        description_parts << 'Additional Information:'
+        description_parts << feedback_data[:additional_info]
+      end
+
+      description_parts.join('\n')
+    end
+
+    def sanitize_html(text)
+      return '' unless text
+
+      # Basic HTML escaping
+      text.to_s
+          .gsub('&', '&amp;')
+          .gsub('<', '&lt;')
+          .gsub('>', '&gt;')
+          .gsub('"', '&quot;')
+          .gsub("'", '&#x27;')
+          .gsub('/', '&#x2F;')
+    end
+
+    def handle_error_response(response)
+      error_data = response.parsed_response
+      error_message = if error_data.is_a?(Hash) && error_data['errorMessage']
+                       "TDX API Error: #{error_data['errorMessage']} (Code: #{error_data['errorCode']})"
+                     elsif error_data.is_a?(Hash) && error_data['Message']
+                       "TDX API Error: #{error_data['Message']}"
+                     else
+                       "TDX API Error: HTTP #{response.code} - #{response.message} - #{response.body}"
+                     end
+
+      raise Error, error_message
+    end
+  end
+end

data/lib/lsa_tdx_feedback/version.rb

@@ -0,0 +1,3 @@
+module LsaTdxFeedback
+  VERSION = '1.0.0'
+end

data/lib/lsa_tdx_feedback/view_helpers.rb

@@ -0,0 +1,37 @@
+module LsaTdxFeedback
+  module ViewHelpers
+    # Simple test method to verify helper is working
+    def lsa_tdx_feedback_test
+      "HELPER IS WORKING!".html_safe
+    end
+
+    # Renders the feedback modal and trigger button
+    def lsa_tdx_feedback_modal
+      render(partial: 'lsa_tdx_feedback/shared/feedback_modal')
+    end
+
+    # Includes the feedback gem CSS
+    def lsa_tdx_feedback_css
+      stylesheet_link_tag 'lsa_tdx_feedback', 'data-turbo-track': 'reload', preload: false
+    end
+
+    # Includes the feedback gem JavaScript
+    def lsa_tdx_feedback_js
+      javascript_include_tag 'lsa_tdx_feedback', 'data-turbo-track': 'reload', defer: true
+    end
+
+    # Includes both CSS and JavaScript assets
+    def lsa_tdx_feedback_assets
+      css = lsa_tdx_feedback_css
+      js = lsa_tdx_feedback_js
+      (css + js).html_safe
+    end
+
+    # All-in-one helper that includes both modal and assets
+    def lsa_tdx_feedback
+      assets = lsa_tdx_feedback_assets
+      modal = lsa_tdx_feedback_modal
+      (assets + modal).html_safe
+    end
+  end
+end

data/lib/lsa_tdx_feedback.rb

@@ -0,0 +1,31 @@
+require_relative 'lsa_tdx_feedback/version'
+require_relative 'lsa_tdx_feedback/configuration'
+require_relative 'lsa_tdx_feedback/oauth_client'
+require_relative 'lsa_tdx_feedback/ticket_client'
+require_relative 'lsa_tdx_feedback/application_controller_extensions'
+require_relative 'lsa_tdx_feedback/view_helpers'
+
+# Only require the engine when Rails is available
+if defined?(Rails)
+  require_relative 'lsa_tdx_feedback/engine'
+end
+
+module LsaTdxFeedback
+  class Error < StandardError; end
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
+end

metadata

@@ -0,0 +1,223 @@
+--- !ruby/object:Gem::Specification
+name: lsa_tdx_feedback
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- LSA Rails Team
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: LsaTdxFeedback provides a zero-configuration solution for collecting
+  user feedback in Rails applications. It includes a modal interface that integrates
+  with TeamDynamix (TDX) API for ticket creation, requiring no additional setup or
+  configuration from the host application.
+email:
+- lsa-was-rails-admins@umich.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- INSTALLATION.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/lsa_tdx_feedback.js
+- app/assets/stylesheets/lsa_tdx_feedback.css
+- app/controllers/lsa_tdx_feedback/feedback_controller.rb
+- app/views/lsa_tdx_feedback/shared/_feedback_modal.html.erb
+- config/routes.rb
+- example_application_tests.rb
+- lib/lsa_tdx_feedback.rb
+- lib/lsa_tdx_feedback/application_controller_extensions.rb
+- lib/lsa_tdx_feedback/configuration.rb
+- lib/lsa_tdx_feedback/engine.rb
+- lib/lsa_tdx_feedback/oauth_client.rb
+- lib/lsa_tdx_feedback/ticket_client.rb
+- lib/lsa_tdx_feedback/version.rb
+- lib/lsa_tdx_feedback/view_helpers.rb
+homepage: https://github.com/lsa-mis/lsa_feedback
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lsa-mis/lsa_feedback
+  source_code_uri: https://github.com/lsa-mis/lsa_feedback
+  changelog_uri: https://github.com/lsa-mis/lsa_feedback/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A self-contained Rails gem for collecting user feedback via TDX API for LSA
+  applications
+test_files: []