deskcrew-rails 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +45 -3
  4. data/lib/deskcrew/version.rb +1 -1
  5. metadata +14 -9
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 948e98697c70fa23d2d3867beac3ef8b9b818ff6945f613529201d9493e68605
4
- data.tar.gz: 8598b9154df830408ff02afdaeac34993aa7cee6433261620efae04245a2a376
3
+ metadata.gz: '09fe40f57cae4a0712ad4f3e04127198f07113492943a0b8402115a7eb726cbc'
4
+ data.tar.gz: '09ea0d014a24fcf4057ef126f373c6827e8d66a0ad21b12d0a933c6c030906ff'
5
5
  SHA512:
6
- metadata.gz: b7c3a60b6d1a2be32b59bde4f114904805fc8bde9cff2492d84f50409cff7b7b9ac995fa929a487e1044e9acc604e0e9bb6ae96ee1ade61233151b6a481bfcee
7
- data.tar.gz: 41b3b24b5bc2166e8375c9c51dab28037cac571b1049fe6cb1105c0eb4c1379deff7c3210c3bf4ee8de9b351796252d8856a452c6dc9e4cfc863b9b20713c518
6
+ metadata.gz: b045a7de0c0851ecc47e1bb9772144896279faf4c49619facdc29c0ead0a156e86327c86889eb39667c20635ba6bd9549ba75129bcf88cc07a0c59c85494c51c
7
+ data.tar.gz: f42b5707a40daa9500eccb6a83419cfba093f1c2e472803662a8d92b228aed242fb3b0d720b97e13920d07f270a090de882fb7ee86727c70901a80b899a4742e
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.0.2
4
+
5
+ - Source, changelog and issue links point at the standalone repository github.com/webmilmind1/deskcrew-rails. No code changes.
6
+
7
+ ## 1.0.1
8
+
9
+ - README and gem description rewritten around the questions people search for (live chat for Rails, AI support chatbot, contact form to ticket, Hotwire and Turbo). No code changes.
10
+
3
11
  ## 1.0.0
4
12
 
5
13
  - First release: `deskcrew_widget_tag` view helper, opt-in `Deskcrew::Middleware` that injects the widget before `</body>`, `Deskcrew::Client` for `register_origin` and `create_ticket`, `rails g deskcrew:install`, and the `deskcrew:register_origin` rake task.
data/README.md CHANGED
@@ -2,9 +2,17 @@
2
2
 
3
3
  ![DeskCrew widget on every Rails page](https://deskcrew.io/packages/deskcrew-rails.gif)
4
4
 
5
- Add the [DeskCrew](https://deskcrew.io) AI support widget to a Ruby on Rails app, and create support tickets from your own code. DeskCrew is an AI-powered helpdesk: the widget answers visitors from your knowledge base, anything it cannot answer becomes a ticket, and you approve every reply before it sends.
5
+ **Live chat, an AI support chatbot and helpdesk ticketing for Ruby on Rails, in one gem.** deskcrew-rails adds the [DeskCrew](https://deskcrew.io) support widget to a Rails app: visitors chat with an AI that answers from your knowledge base, anything it cannot answer becomes a ticket, and a human approves every reply before it sends. It also gives you a tiny client so a contact form, a feedback form or a background job can open a ticket from Ruby.
6
6
 
7
- You need a free DeskCrew account to get a widget key: https://deskcrew.io/signup
7
+ Works with Rails 6.1 to 8, Hotwire, Turbo, Stimulus, Devise, importmap and Propshaft. Nothing to add to the asset pipeline. Free plan, no credit card: https://deskcrew.io/signup
8
+
9
+ ## Use it for
10
+
11
+ - **Live chat on a Rails app** without writing JavaScript: one helper in the layout, or one config flag for every page.
12
+ - **An AI chatbot for customer support** that only answers from your own help articles, with a human handoff when it is unsure.
13
+ - **Contact form to support ticket**: post the form fields to `Deskcrew::Client.create_ticket` and the message lands in your inbox as a ticket.
14
+ - **A help center and knowledge base** for a SaaS, an e-commerce store, a Rails API with a marketing site, or an internal tool.
15
+ - **Replacing a paid chat widget** (Intercom, Crisp, Tawk.to, Zendesk, Freshdesk, HelpScout) with one that starts free and never sends a reply you did not approve.
8
16
 
9
17
  ## Install
10
18
 
@@ -65,6 +73,40 @@ Deskcrew::Client.create_ticket(
65
73
 
66
74
  Returns `true` when DeskCrew accepted the ticket, `false` otherwise. It never raises into your request cycle, and the call takes at most ten seconds, so wrap it in a background job if you create tickets in bulk.
67
75
 
76
+ ## FAQ
77
+
78
+ ### How do I add live chat to a Ruby on Rails app?
79
+
80
+ Install this gem, run `bin/rails generate deskcrew:install`, put your widget key in the initializer, and add `<%= deskcrew_widget_tag %>` before `</body>` in `app/views/layouts/application.html.erb`. Every view that uses that layout gets the chat bubble. Set `config.auto_inject = true` instead if you would rather not touch layouts.
81
+
82
+ ### Does the widget work with Hotwire and Turbo Drive?
83
+
84
+ Yes. The widget mounts once into its own container and Turbo replaces page bodies without touching it, so an open conversation survives navigation. Turbo Frames and Streams are unaffected.
85
+
86
+ ### Do I need to add anything to the asset pipeline, importmap or Propshaft?
87
+
88
+ No. The widget is a single external script loaded from deskcrew.io, not an application asset. There is no Sprockets entry, no importmap pin and no bundling step.
89
+
90
+ ### Can I create a support ticket from a Rails controller or a background job?
91
+
92
+ Yes. `Deskcrew::Client.create_ticket(name:, email:, message:)` posts the ticket and returns true or false. It never raises into your request cycle and times out after ten seconds, so call it from a job (Sidekiq, Solid Queue, GoodJob) when you create tickets in bulk.
93
+
94
+ ### Is the AI chatbot going to make things up?
95
+
96
+ It answers only from the knowledge base you publish on DeskCrew and says so when it does not know. Anything it cannot answer becomes a ticket, and a person approves every outbound reply. The AI never emails a customer on its own.
97
+
98
+ ### Does it work with Devise, multi-tenant apps or several layouts?
99
+
100
+ Devise: yes, the widget is independent of authentication; pass `current_user` details to `create_ticket` if you want tickets tied to accounts. Several layouts: add the helper to each layout you want covered, or use `auto_inject`. Multi-tenant apps with one DeskCrew board per tenant can call `deskcrew_widget_tag` with a different key per request.
101
+
102
+ ### Is there a free plan?
103
+
104
+ Yes. The free plan includes the chat widget, ticketing, a public help center and a monthly AI answer allowance, with no credit card. Paid plans add inbound email, white-label and more AI answers: https://deskcrew.io/pricing
105
+
106
+ ### Does it work with Sinatra, Hanami or a plain Rack app?
107
+
108
+ The Rack middleware (`Deskcrew::Middleware`) and `Deskcrew::Client` do not depend on Rails, so a Sinatra or Rack app can use them directly. The view helper, generator and rake task are Rails-only.
109
+
68
110
  ## What the gem sends to DeskCrew
69
111
 
70
112
  - The widget script tag points at `https://deskcrew.io/desk.js` with your public widget key and the optional board, colour, position and greeting. Every value is validated and HTML-escaped before it reaches the page.
@@ -75,7 +117,7 @@ Nothing else leaves your app. Terms: https://deskcrew.io/terms. Privacy: https:/
75
117
 
76
118
  ## Requirements
77
119
 
78
- Ruby 3.0 or newer, Rails 6.1 or newer.
120
+ Ruby 3.0 or newer. Rails 6.1, 7.0, 7.1, 7.2 or 8.0. Tested against Rack 2.2 and Rack 3.
79
121
 
80
122
  ## License
81
123
 
data/lib/deskcrew/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Deskcrew
4
- VERSION = "1.0.0"
4
+ VERSION = "1.0.2"
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: deskcrew-rails
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - DeskCrew
@@ -37,10 +37,14 @@ dependencies:
37
37
  - - ">="
38
38
  - !ruby/object:Gem::Version
39
39
  version: '2.2'
40
- description: DeskCrew is an AI-powered helpdesk. This gem injects the DeskCrew support
41
- widget into your Rails views (a helper or an opt-in middleware), registers your
42
- site with DeskCrew so the widget works on your domain, and gives you a small client
43
- to create support tickets from your own code.
40
+ description: 'Add customer support to a Rails app in one step: live chat widget, AI
41
+ chatbot that answers from your knowledge base, a public help center, and support
42
+ tickets with human-approved replies. The gem injects the DeskCrew widget through
43
+ a view helper or an opt-in Rack middleware (works with Hotwire, Turbo, Stimulus,
44
+ Devise, importmap and Propshaft, no asset pipeline entry), registers your domain,
45
+ and ships a small client that turns contact forms, feedback forms and background
46
+ jobs into tickets. Free plan, no credit card. An alternative to Intercom, Crisp,
47
+ Tawk.to, Zendesk or Freshdesk widgets for Rails, Sinatra and Rack apps.'
44
48
  email:
45
49
  - support@deskcrew.io
46
50
  executables: []
@@ -67,8 +71,9 @@ licenses:
67
71
  metadata:
68
72
  homepage_uri: https://deskcrew.io/integrations/rails
69
73
  documentation_uri: https://deskcrew.io/board/deskcrew/kb
70
- source_code_uri: https://github.com/webmilmind1/support-tickets/tree/main/rails-gem
71
- changelog_uri: https://github.com/webmilmind1/support-tickets/blob/main/rails-gem/CHANGELOG.md
74
+ source_code_uri: https://github.com/webmilmind1/deskcrew-rails
75
+ changelog_uri: https://github.com/webmilmind1/deskcrew-rails/blob/main/CHANGELOG.md
76
+ bug_tracker_uri: https://github.com/webmilmind1/deskcrew-rails/issues
72
77
  rubygems_mfa_required: 'true'
73
78
  rdoc_options: []
74
79
  require_paths:
@@ -86,6 +91,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
86
91
  requirements: []
87
92
  rubygems_version: 3.6.9
88
93
  specification_version: 4
89
- summary: Add the DeskCrew AI support widget to a Rails app and turn form submissions
90
- into tickets.
94
+ summary: Live chat, AI support chatbot and helpdesk ticketing for Ruby on Rails apps
95
+ (DeskCrew widget, Hotwire and Turbo safe, free plan).
91
96
  test_files: []