revirow 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd73add511621443ceb644deb1be3b596cc07155463ec3cf6297d84cd75987d3
-  data.tar.gz: e6bf48453fef9a69c620017dd02374ccb33a50925d64607ebf7f7f89234f73ea
+  metadata.gz: 17633b49a16632da3fbf1af84df34cf72f003cf68ecbc566360501700bdccc31
+  data.tar.gz: 244284eafd9ca0462ef7a40fc41b31ea42397f2bb26b36f785f2de33e76062a8
 SHA512:
-  metadata.gz: 85dc10cf13967dd10b1cdd5fdd85cef88ef85737be4dbcfe02ac95e30a2ef5ae0995fd7d390ff0aa639b71bde7e7051aa4c4ca0d9f9a1df6c98b6aa06ec4fbc7
-  data.tar.gz: ebad674beccf8d8c3a4fbbd9e00563e54fa69a4869b634a823d1ead960789f448d5d7373a54112a57044cd6185abcff3c85481fb75ab0a10a2b6e898568966a8
+  metadata.gz: c606b95de98d2f170876a285cd28308dac05723ce15460385cccf7883cd06cd63f520a523f7a0f5911f33953afc6b657602d6323dbba2adb020d9780507d7476
+  data.tar.gz: f97bf057d644bd50b4096850ae465a8ab623d31d2da8b2e60d568d5037862eb35fb641bc45bd4898b29010b8d2be7d5f223e0e81c9a6e14ad4791a19b373c2ac

data/README.md

@@ -54,14 +54,29 @@ client = Revirow::Client.new
 
 ### Changelog
 
-Fetch changelog entries with cursor-based pagination:
+List entries with cursor-based pagination:
 
 ```ruby
+# Summary (default) - lighter payload for index pages
 response = client.changelog.list(limit: 10)
 
 response['entries'].each do |entry|
+  puts entry['id']           # public_id
+  puts entry['slug']         # optional custom slug
   puts entry['title']
-  puts entry['content']
+  puts entry['summary']      # truncated plain text (~200 chars)
+  puts entry['published_at']
+end
+
+# Full content - for single-page changelog displays
+response = client.changelog.list(limit: 10, content: :full)
+
+response['entries'].each do |entry|
+  puts entry['id']
+  puts entry['slug']
+  puts entry['title']
+  puts entry['content']      # full plain text
+  puts entry['content_html'] # full HTML
   puts entry['published_at']
 end
 
@@ -74,6 +89,20 @@ if response['pagination']['has_more']
 end
 ```
 
+Fetch a single entry:
+
+```ruby
+# By public_id
+entry = client.changelog.find('abc123')
+puts entry['entry']['title']
+puts entry['entry']['content_html']
+
+# By slug (if set)
+entry = client.changelog.find_by_slug('dark-mode-launch')
+puts entry['entry']['title']
+puts entry['entry']['content_html']
+```
+
 ### Feedback
 
 Submit feedback requests to a feedback board:

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/resources/changelog.rb

@@ -7,11 +7,30 @@ module Revirow
         @client = client
       end
 
-      def list(limit: 10, cursor: nil)
-        params = { limit: limit }
+      # List changelog entries with pagination
+      # @param limit [Integer] Number of entries to return (default: 10, max: 50)
+      # @param cursor [String] Cursor for pagination (public_id of last entry)
+      # @param content [Symbol] Content detail level - :summary (default) or :full
+      # @return [Hash] Response with entries array and pagination info
+      def list(limit: 10, cursor: nil, content: :summary)
+        params = { limit: limit, content: content }
         params[:cursor] = cursor if cursor
         @client.get("/api/changelog", params)
       end
+
+      # Find a changelog entry by public_id
+      # @param id [String] The public_id of the entry
+      # @return [Hash] The changelog entry with full content
+      def find(id)
+        @client.get("/api/changelog/#{id}")
+      end
+
+      # Find a changelog entry by slug
+      # @param slug [String] The slug of the entry
+      # @return [Hash] The changelog entry with full content
+      def find_by_slug(slug)
+        @client.get("/api/changelog/by-slug/#{slug}")
+      end
     end
   end
 end

data/lib/revirow/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: revirow
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Revirow
@@ -33,6 +33,8 @@ 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
@@ -44,6 +46,8 @@ files:
 - lib/revirow/widget.rb
 - revirow-0.1.0.gem
 - revirow-0.1.1.gem
+- revirow-0.1.2.gem
+- revirow-0.1.3.gem
 - sig/revirow.rbs
 homepage: https://revirow.com
 licenses: