revirow 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d964e2566cd2be44b64c0138ec3c873dce7541b3f0e9e38c6cd20d8bc3a3a4b
-  data.tar.gz: a7d99e718b3298bd8437e6160aea34720b627e999b7bb984d5e3bf306723d200
+  metadata.gz: b11db5a0914298ea819aacb7a1547f115656865cd55ef7333d640d1fe9b4aab2
+  data.tar.gz: 11a9af71ae8d13098638409f407e0469cc5db5fc61655e8e5bad8c62f761a177
 SHA512:
-  metadata.gz: 39f9be4f8c68093593e07300a70a32dc03f66b11f6c0c2654a85995ec6403c3d2d97fe08638119dfa4011f02576b85224f6316956b248e8cf7aa8cb6ff9fc2dc
-  data.tar.gz: cbbd94e80bc9d3b70475d185c0873b786da78e9bddbab33d278843eba285c7ae3d882c48de05793f43544ef0e58a5c65a6d0be6cc3d4a78784d2a41d24780c92
+  metadata.gz: 4efde37c03482f9e883882b3679179699bc94021b911dd74626d394bb0c258cb3d0a3ef8a5dbdbc053c882b1a02172f0a3335e96939aaa31233fb75e171b007b
+  data.tar.gz: 0b82b836b84ab396263711614dd5c3f0f92f51167037c818ca97b5d2cca22ec3735329de2b0a01c14301910952192c4c1c84c715c1838a98b6ff6fa4bf0e8316

data/README.md

@@ -1,32 +1,54 @@
 # Revirow Ruby Gem
 
-Official Ruby client for the Revirow API. Integrate changelog and feedback collection into your Ruby applications.
+Official Ruby client for the Revirow API. Integrate changelog, feedback collection, and the Revirow widget into your Ruby applications.
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
-
 ```bash
 bundle add revirow
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+## Widget (Rails)
+
+Run the generator:
 
 ```bash
-gem install revirow
+rails generate revirow:install
 ```
 
-## Configuration
+Add to your environment:
 
-Add your API key as an environment variable `REVIROW_KEY`. The gem will automatically use this key.
-
-## Usage
+```bash
+REVIROW_APP_ID=your_app_id
+REVIROW_KEY=your_key
+```
 
-### Initialize Client
+Configure the customer context in `config/initializers/revirow.rb`:
 
 ```ruby
-require 'revirow'
+Revirow.config do |config|
+  config.customer = Proc.new {
+    {
+      email: Current.user&.email_address,
+      id: Current.user&.id
+    }
+  }
+end
+```
 
+Add to your layout:
+
+```erb
+<%= revirow_widget %>
+```
+
+Done. The widget loads automatically with authenticated customer data.
+
+## API Client
+
+For server-side API calls, set `REVIROW_KEY` and use the client:
+
+```ruby
 client = Revirow::Client.new
 ```
 
@@ -35,17 +57,15 @@ client = Revirow::Client.new
 Fetch changelog entries with cursor-based pagination:
 
 ```ruby
-# Get latest changelog entries
 response = client.changelog.list(limit: 10)
 
-# Access entries
 response['entries'].each do |entry|
   puts entry['title']
   puts entry['content']
   puts entry['published_at']
 end
 
-# Paginate through more entries
+# Paginate
 if response['pagination']['has_more']
   next_page = client.changelog.list(
     limit: 10,
@@ -59,14 +79,12 @@ end
 Submit feedback requests to a feedback board:
 
 ```ruby
-# Create a feedback request
 response = client.feedback.create(
   feedback_board_public_id: 'board_abc123',
   description: 'Would love to see dark mode support!',
   title: 'Dark Mode Feature Request' # optional
 )
 
-# Response includes the created feedback request
 puts response['id']           # public_id
 puts response['title']        # title (if provided)
 puts response['description']  # description

data/lib/generators/revirow/install_generator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Revirow
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Creates a Revirow initializer file"
+
+      def copy_initializer
+        template "initializer.rb", "config/initializers/revirow.rb"
+      end
+
+      def show_readme
+        say ""
+        say "Revirow installed!", :green
+        say ""
+        say "Next steps:"
+        say "  1. Add REVIROW_APP_ID and REVIROW_KEY to your environment"
+        say "  2. Update config/initializers/revirow.rb with your customer data"
+        say "  3. Add <%= revirow_widget %> to your layout"
+        say ""
+      end
+    end
+  end
+end

data/lib/generators/revirow/templates/initializer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+Revirow.config do |config|
+  # Define your customer context for the widget.
+  # This is called on each request to get the current customer data for JWT.
+  # config.customer = Proc.new {
+  #   {
+  #     email: Current.user&.email_address,
+  #     id: Current.user&.id
+  #   }
+  # }
+
+  # Optional: Override if not using environment variables
+  # config.app_id = "your_app_id"
+  # config.secret = "your_secret"
+end

data/lib/revirow/configuration.rb

@@ -2,11 +2,20 @@
 
 module Revirow
   class Configuration
-    attr_accessor :api_url, :api_key
+    attr_accessor :api_url, :api_key, :app_id, :secret, :customer
 
     def initialize
       @api_url = "https://api.revirow.com"
       @api_key = ENV["REVIROW_KEY"]
+      @app_id = ENV["REVIROW_APP_ID"]
+      @secret = ENV["REVIROW_KEY"]
+      @customer = nil
+    end
+
+    def customer_data
+      return {} unless @customer.is_a?(Proc)
+      result = @customer.call
+      result.is_a?(Hash) ? result : {}
     end
   end
 
@@ -21,6 +30,8 @@ module Revirow
       yield(configuration)
     end
 
+    alias_method :config, :configure
+
     def reset_configuration!
       @configuration = Configuration.new
     end

data/lib/revirow/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Revirow
+  class Railtie < Rails::Railtie
+    initializer "revirow.view_helpers" do
+      ActiveSupport.on_load(:action_view) do
+        include Revirow::ViewHelpers
+      end
+    end
+  end
+end

data/lib/revirow/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Revirow
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/revirow/view_helpers.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Revirow
+  module ViewHelpers
+    def revirow_widget
+      Revirow::Widget.script_tag.html_safe
+    end
+  end
+end

data/lib/revirow/widget.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "jwt"
+
+module Revirow
+  class Widget
+    class << self
+      def script_tag
+        config = Revirow.configuration
+        raise Error, "REVIROW_APP_ID not set" unless config.app_id
+
+        jwt = generate_jwt(config)
+
+        <<~HTML
+          <script src="https://client.revirow.com/loader.js"></script>
+          <script>
+            Revirow("boot", {
+              appId: "#{config.app_id}"#{jwt ? %Q(,\n      jwt: "#{jwt}") : ""}
+            });
+          </script>
+        HTML
+      end
+
+      private
+
+      def generate_jwt(config)
+        return nil unless config.secret
+        payload = config.customer_data
+        return nil if payload.empty?
+
+        JWT.encode(payload, config.secret, "HS256")
+      end
+    end
+  end
+end

data/lib/revirow.rb

@@ -5,7 +5,11 @@ require_relative "revirow/configuration"
 require_relative "revirow/resources/changelog"
 require_relative "revirow/resources/feedback"
 require_relative "revirow/client"
+require_relative "revirow/widget"
+require_relative "revirow/view_helpers"
 
 module Revirow
   class Error < StandardError; end
 end
+
+require_relative "revirow/railtie" if defined?(Rails::Railtie)

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: revirow
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Revirow
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 email:
 - development@revirow.com
 executables: []
@@ -19,13 +33,20 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/revirow/install_generator.rb
+- lib/generators/revirow/templates/initializer.rb
 - lib/revirow.rb
 - lib/revirow/client.rb
 - lib/revirow/configuration.rb
+- lib/revirow/railtie.rb
 - lib/revirow/resources/changelog.rb
 - lib/revirow/resources/feedback.rb
 - lib/revirow/version.rb
+- lib/revirow/view_helpers.rb
+- lib/revirow/widget.rb
 - revirow-0.1.0.gem
+- revirow-0.1.1.gem
+- revirow-0.1.2.gem
 - sig/revirow.rbs
 homepage: https://revirow.com
 licenses:
@@ -46,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby client for the Revirow API.
 test_files: []