bugwatch-ruby 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9d4ff0ad03b9ab70f5f37f3a4656f7b1746a86c22ee33e429242c08c0527036
-  data.tar.gz: 0a9c5bc904036439926f2e7097d07db78d8e5139ed3d2df81a57c98836661a97
+  metadata.gz: 21032d38b9ffee6bf1dbef68e9ce7c39b56c28b0eb2369d76bdf684b4ed25df3
+  data.tar.gz: 052521dd770495c7bd271313788d71e9b1d0fd8dede69f1d2fa86603bd25eccc
 SHA512:
-  metadata.gz: 59abfb1a125beba2a9aff1676e0299625e6b352cb4b71005b6e4a2854cff3d19758578ce6a91addadbd64f8a7656449e3766da0b3edc5659dc6f49a3953ce733
-  data.tar.gz: 579309e1a64318f07275fc4139481021d94cd01fb816f36b42cd5b8f8a0eac273d6e690b920649cd8787eee59b555b371592fe308f16396b91c84c118b2925df
+  metadata.gz: 9895be8ecb3c5db57f8996b1d702f75da6658d8370a470b72b88b6b12dc5da8690461208991cd14980bb5a996b70a19854c6747e4f460b9a868a75b3da0aaae8
+  data.tar.gz: a51dd3a8af6502533474624b1c1352661e0a5ce047b25d5f30dd693810cce7fd7532af83b7071a6987760a6bd61cce485fc4b6700c8f2b5f9d3d5366ef9a1ee2

data/README.md

@@ -121,6 +121,66 @@ release: bundle exec rails db:migrate && bundle exec rails bugwatch:track_deploy
 
 The build will write the commit SHA to `REVISION`, and the release phase will read it back and report the deploy to BugWatch.
 
+## User Feedback Widget
+
+Drop a feedback form into any view so users can report issues directly from your app. The form submits to BugWatch's feedback API — no controller code needed.
+
+```erb
+<%%= bugwatch_feedback_widget %>
+```
+
+The helper renders a plain, unstyled HTML form with CSS classes you can target:
+
+| Class | Element |
+|-------|---------|
+| `.bugwatch-feedback-form` | The `<form>` wrapper |
+| `.bugwatch-feedback-field` | Each field's `<div>` |
+| `.bugwatch-feedback-label` | `<label>` elements |
+| `.bugwatch-feedback-input` | Text/email `<input>` |
+| `.bugwatch-feedback-textarea` | The message `<textarea>` |
+| `.bugwatch-feedback-submit` | Submit `<button>` |
+| `.bugwatch-feedback-success` | Success message (hidden by default) |
+| `.bugwatch-feedback-error` | Error message (hidden by default) |
+
+### Options
+
+```erb
+<%%= bugwatch_feedback_widget(
+  user_email: current_user&.email,
+  user_name:  current_user&.name,
+  placeholder: "Describe the issue...",
+  submit_text: "Report Issue",
+  success_message: "We got it — thanks!",
+  issue_id: @issue_id,        # optional: link to a specific BugWatch issue
+  metadata: { page: "checkout" }
+) %>
+```
+
+### Styling example (Tailwind)
+
+```css
+.bugwatch-feedback-form { @apply space-y-4 max-w-md; }
+.bugwatch-feedback-label { @apply block text-sm font-medium text-gray-700; }
+.bugwatch-feedback-input,
+.bugwatch-feedback-textarea { @apply w-full border rounded-lg px-3 py-2 text-sm; }
+.bugwatch-feedback-submit { @apply bg-blue-600 text-white px-4 py-2 rounded-lg text-sm; }
+.bugwatch-feedback-success { @apply text-green-600 text-sm; }
+.bugwatch-feedback-error { @apply text-red-600 text-sm; }
+```
+
+### Server-side feedback
+
+You can also send feedback from Ruby (e.g. from a controller that handles your own form):
+
+```ruby
+Bugwatch.send_feedback(
+  params[:message],
+  email: current_user.email,
+  name:  current_user.name,
+  url:   request.original_url
+)
+```
+
 ## How it works
 
 1. `Bugwatch::Middleware` wraps your entire Rack stack.

data/lib/bugwatch/feedback_helper.rb

@@ -0,0 +1,86 @@
+module Bugwatch
+  module FeedbackHelper
+    # Renders a minimal, unstyled feedback widget form.
+    #
+    # The form submits via fetch to the BugWatch feedback API.
+    # All markup uses "bugwatch-feedback-*" CSS classes so you
+    # can style it however you want without collisions.
+    #
+    # Options:
+    #   :user_email  - Pre-fill email (e.g. current_user.email)
+    #   :user_name   - Pre-fill name  (e.g. current_user.name)
+    #   :issue_id    - Link feedback to a specific BugWatch issue
+    #   :metadata    - Hash of extra data to attach
+    #   :placeholder - Textarea placeholder text
+    #   :submit_text - Submit button label (default: "Send Feedback")
+    #   :success_message - Message shown after successful submit
+    #
+    def bugwatch_feedback_widget(user_email: nil, user_name: nil, issue_id: nil, metadata: {}, placeholder: "What happened? Tell us about the issue...", submit_text: "Send Feedback", success_message: "Thanks for your feedback!")
+      config   = Bugwatch.configuration
+      endpoint = "#{config.endpoint&.chomp("/")}/api/v1/feedback"
+      api_key  = config.api_key
+      widget_id = "bugwatch-feedback-#{SecureRandom.hex(4)}"
+
+      html = <<~HTML
+        <form id="#{widget_id}" class="bugwatch-feedback-form" data-bugwatch-feedback>
+          <div class="bugwatch-feedback-field">
+            <label for="#{widget_id}-name" class="bugwatch-feedback-label">Name</label>
+            <input type="text" id="#{widget_id}-name" name="name" value="#{ERB::Util.html_escape(user_name.to_s)}" class="bugwatch-feedback-input" />
+          </div>
+          <div class="bugwatch-feedback-field">
+            <label for="#{widget_id}-email" class="bugwatch-feedback-label">Email</label>
+            <input type="email" id="#{widget_id}-email" name="email" value="#{ERB::Util.html_escape(user_email.to_s)}" class="bugwatch-feedback-input" />
+          </div>
+          <div class="bugwatch-feedback-field">
+            <label for="#{widget_id}-message" class="bugwatch-feedback-label">Message</label>
+            <textarea id="#{widget_id}-message" name="message" required class="bugwatch-feedback-textarea" placeholder="#{ERB::Util.html_escape(placeholder)}"></textarea>
+          </div>
+          <button type="submit" class="bugwatch-feedback-submit">#{ERB::Util.html_escape(submit_text)}</button>
+          <div class="bugwatch-feedback-success" style="display:none">#{ERB::Util.html_escape(success_message)}</div>
+          <div class="bugwatch-feedback-error" style="display:none"></div>
+        </form>
+        <script>
+          (function() {
+            var form = document.getElementById("#{widget_id}");
+            form.addEventListener("submit", function(e) {
+              e.preventDefault();
+              var btn     = form.querySelector(".bugwatch-feedback-submit");
+              var success = form.querySelector(".bugwatch-feedback-success");
+              var error   = form.querySelector(".bugwatch-feedback-error");
+              success.style.display = "none";
+              error.style.display   = "none";
+              btn.disabled = true;
+
+              var body = {
+                api_key: #{api_key.to_json},
+                message: form.querySelector("[name=message]").value,
+                name:    form.querySelector("[name=name]").value || undefined,
+                email:   form.querySelector("[name=email]").value || undefined,
+                url:     window.location.href
+              };
+              #{issue_id ? "body.issue_id = #{issue_id.to_json};" : ""}
+              #{metadata.any? ? "body.metadata = #{metadata.to_json};" : ""}
+
+              fetch(#{endpoint.to_json}, {
+                method: "POST",
+                headers: { "Content-Type": "application/json" },
+                body: JSON.stringify(body)
+              }).then(function(r) {
+                if (!r.ok) throw new Error("Request failed");
+                form.querySelector("[name=message]").value = "";
+                success.style.display = "";
+                btn.disabled = false;
+              }).catch(function(err) {
+                error.textContent = "Something went wrong. Please try again.";
+                error.style.display = "";
+                btn.disabled = false;
+              });
+            });
+          })();
+        </script>
+      HTML
+
+      html.html_safe
+    end
+  end
+end

data/lib/bugwatch/feedback_sender.rb

@@ -0,0 +1,58 @@
+require "net/http"
+require "uri"
+require "json"
+
+module Bugwatch
+  class FeedbackSender
+    TIMEOUT = 3
+
+    def initialize(message:, email: nil, name: nil, url: nil, issue_id: nil, metadata: {}, config: Bugwatch.configuration)
+      @message  = message
+      @email    = email
+      @name     = name
+      @url      = url
+      @issue_id = issue_id
+      @metadata = metadata
+      @config   = config
+    end
+
+    def deliver
+      return unless @config.api_key
+      return unless @config.endpoint
+
+      Thread.new do
+        post_feedback
+      rescue StandardError
+        # Fire-and-forget: never affect the host app
+      end
+    end
+
+    private
+
+    def post_feedback
+      uri = URI.parse("#{@config.endpoint.chomp("/")}/api/v1/feedback")
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl       = uri.scheme == "https"
+      http.open_timeout  = TIMEOUT
+      http.read_timeout  = TIMEOUT
+      http.write_timeout = TIMEOUT
+
+      request = Net::HTTP::Post.new(uri.path)
+      request["Content-Type"]    = "application/json"
+      request["X-Api-Key"]       = @config.api_key
+      request["X-BugWatch-Ruby"] = Bugwatch::VERSION
+
+      payload = { message: @message }
+      payload[:email]    = @email    if @email
+      payload[:name]     = @name     if @name
+      payload[:url]      = @url      if @url
+      payload[:issue_id] = @issue_id if @issue_id
+      payload[:metadata] = @metadata if @metadata.any?
+
+      request.body = JSON.generate(payload)
+
+      http.request(request)
+    end
+  end
+end

data/lib/bugwatch/railtie.rb

@@ -19,6 +19,12 @@ module Bugwatch
       end
     end
 
+    initializer "bugwatch.view_helpers" do
+      ActiveSupport.on_load(:action_view) do
+        include Bugwatch::FeedbackHelper
+      end
+    end
+
     initializer "bugwatch.error_subscriber" do
       if defined?(Rails.error) && Rails.error.respond_to?(:subscribe)
         Rails.error.subscribe(Bugwatch::ErrorSubscriber.new)

data/lib/bugwatch/version.rb

@@ -1,3 +1,3 @@
 module Bugwatch
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/bugwatch.rb

@@ -11,6 +11,8 @@ require_relative "bugwatch/report_builder"
 require_relative "bugwatch/notification"
 require_relative "bugwatch/transaction_sender"
 require_relative "bugwatch/transaction_buffer"
+require_relative "bugwatch/feedback_sender"
+require_relative "bugwatch/feedback_helper"
 require_relative "bugwatch/middleware"
 require_relative "bugwatch/active_job_handler"
 require_relative "bugwatch/error_subscriber"
@@ -43,6 +45,15 @@ module Bugwatch
       Notification.new(payload).deliver
     end
 
+    def send_feedback(message, email: nil, name: nil, url: nil, issue_id: nil, metadata: {})
+      return if message.to_s.strip.empty?
+
+      FeedbackSender.new(
+        message: message, email: email, name: name,
+        url: url, issue_id: issue_id, metadata: metadata
+      ).deliver
+    end
+
     def set_user(id: nil, email: nil, name: nil, **custom)
       UserContext.set(id: id, email: email, name: name, **custom)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bugwatch-ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - BugWatch
@@ -54,6 +54,8 @@ files:
 - lib/bugwatch/configuration.rb
 - lib/bugwatch/error_builder.rb
 - lib/bugwatch/error_subscriber.rb
+- lib/bugwatch/feedback_helper.rb
+- lib/bugwatch/feedback_sender.rb
 - lib/bugwatch/middleware.rb
 - lib/bugwatch/notification.rb
 - lib/bugwatch/railtie.rb