moonshot-rails 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 267a4749786b23adbc02bc666be3043bb2f3a29a27b9fc811c2d6bcd558ed7a8
-  data.tar.gz: 1274e6d80f830c37ae7800e42338d887516cea203c813b0c047b6cf5e558f6e6
+  metadata.gz: 80ae99ac2e3300a7795f3612397bb4c338c3fe4641392ba83bc2d6910f14cdd6
+  data.tar.gz: 0b20b0277be40bc1ac7bb57a2c49e5da29726e4d7a400b1777759ad11c8e74d8
 SHA512:
-  metadata.gz: b0eebc47467f82c19e79e059041d8d488d01cf30dd890ccba7b41cf6ec63c8a66f0a31e6d2c56012821a7c51c73bd25524fb093e3d69006cd3c7529b47610f8b
-  data.tar.gz: 96bd0210245d379cfb1f5c8935d27fbb07b4f31fa7ea5dd71c16ef1375aca59f10db77adf1f173dbd95dd9949860e1883433ac95c3ff910a7aa0fc62aafbc88b
+  metadata.gz: a53608e24e4cabd49d5c426124774e526e1f898f1535615a1bb104384a8088f88197550be8a20f62c714565397d6ce3f82ebe494244c03c0a09971ebd28d63d9
+  data.tar.gz: 4813fce7da2d850201bfe19e084f7e3371d8e51370be47539d34a239cf6d9a6415d00bb5f78429dc558b28c4ba56e2f549ebb538894bac1c4446a1a6375c55b8

data/README.md

@@ -1,12 +1,84 @@
 # Moonshot Rails
 
+A collection of Stimulus controllers and other helpers enabling faster building of SaaS applications using modern Rails and Stimulus. Most of these are heavily opinionated.
+
+1. [Post Hog Analytics Stimulusjs wrapper](#1-post-hog-analytics-stimulusjs-wrapper)
+2. [Shepherdjs Stimulusjs wrapper](#2-shepherdjs-stimulusjs-wrapper)
+3. [Crisp Chat Stimulusjs wrapper](#3-crisp-chat-stimulusjs-wrapper)
+
 ## Installation
 
 ```bash
   bundle add moonshot-rails
   yarn add moonshot-rails
+
 ```
 
+### Include all the stimulus controllers
+
+```bash
+  # append this to `app/javascript/controllers/index.js`
+
+  import { registerControllers } from 'moonshot-rails'
+  registerControllers(application)
+```
+
+### You can also pick and choose which controllers to include
+
+```bash
+  # append this to `app/javascript/controllers/index.js`
+
+  import { PostHogController } from 'moonshot-rails'
+  application.register('post-hog', PostHogController)
+
+  # see the full list at https://github.com/cionescu/moonshot-rails/blob/main/app/assets/javascripts/moonshot/index.js
+```
+
+## Contents
+
+### 1. Post Hog Analytics Stimulusjs wrapper
+
+I tend to use [PostHog](https://posthog.com/) for session tracking and product usage analytics.
+
+#### Usage:
+
+In your layout file, add the following:
+
+```erb
+  = post_hog_tracker user: @user, enabled: Rails.env.production?, api_key: Settings.post_hog.api_key
+```
+
+Your `User` model needs to implement the following methods:
+* `id` - used to uniquely identify the user. I usually use the `id` column.
+* `tracker_name` - the display name for the user object. Could be `User#full_name`.
+* `tracker_email` - another way to identify the user.
+
+### 2. Shepherdjs Stimulusjs wrapper
+
+*TODO*
+
+### 3. Crisp Chat Stimulusjs wrapper
+
+[Crisp](https://crisp.chat/) is one of the options for a live chat/support widget. I tend to like to like it because it comes with an npm package, meaning I can wrap it in a Stimulus controller.
+
+In the layout file, add the following:
+
+```erb
+  = crisp_chat user: current_user, enabled: Rails.env.production?, wrapper: :div, api_key: Settings.crisp.api_key
+```
+
+If you want to activate (open) the chat widget when clicking a link on the page, you can follow this pattern:
+
+```erb
+  You can reach out to us via the
+  = crisp_chat(user: current_user, enabled: Rails.env.production?, wrapper: :span, api_key: Settings.crisp.api_key) do
+    = link_to 'in-app chat', '#', data: { action: 'click->crisp#open' }, class: 'btn-link text-primary'
+```
+
+Similarly to the PostHog wrapper, the `User` model needs to implement the following methods:
+* `tracker_name` - the display name for the user object. Could be `User#full_name`.
+* `tracker_email` - another way to identify the user.
+
 ## Release
 
 ### Ruby Gem

data/app/assets/javascripts/moonshot/crisp_controller.js

@@ -0,0 +1,24 @@
+import { Crisp } from "crisp-sdk-web"
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static values = {
+    websiteId: String,
+    identification: Object
+  }
+
+  connect() {
+    Crisp.configure(this.websiteIdValue)
+    if (Object.keys(this.identificationValue).length) {
+      const { email, name } = this.identificationValue
+
+      Crisp.user.setEmail(email)
+      Crisp.user.setNickname(name)
+    }
+  }
+
+  open(e) {
+    e.preventDefault()
+    Crisp.chat.open()
+  }
+}

data/app/assets/javascripts/moonshot/index.js

@@ -1,11 +1,13 @@
 import PostHogController from './post_hog_controller'
 import ShepherdController from './shepherd_controller'
+import CrispController from './crisp_controller'
 
 export {
-  PostHogController, ShepherdController
+  PostHogController, ShepherdController, CrispController
 }
 
 export function registerControllers(application) {
   application.register('shepherd', ShepherdController)
   application.register('post-hog', PostHogController)
+  application.register('crisp', CrispController)
 }