revirow 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b8aad536825b4fd30fafb55b524eb41818078e2afc40d7600d7a125758196c6
-  data.tar.gz: b22386d8e3a405c0fa138699070b94dda5bba3b79ab27cb3f1389d078721ca9e
+  metadata.gz: bd73add511621443ceb644deb1be3b596cc07155463ec3cf6297d84cd75987d3
+  data.tar.gz: e6bf48453fef9a69c620017dd02374ccb33a50925d64607ebf7f7f89234f73ea
 SHA512:
-  metadata.gz: 45bd145f6b69dac9c96c2d3d24f3eebfc928900d0329d86ea8ab4c5a92fb859475df60708b06ec1831b199e17c943b41039e20e14c798a805f6156414f004c71
-  data.tar.gz: 86a401e3c53b89b323319acc7c5bd49686d50f87dca7e284da9ea4539273937374c62479fe4b1cc369b89e57eb5bd2cc89a34ae7e48e189fad85f30beb7bf535
+  metadata.gz: 85dc10cf13967dd10b1cdd5fdd85cef88ef85737be4dbcfe02ac95e30a2ef5ae0995fd7d390ff0aa639b71bde7e7051aa4c4ca0d9f9a1df6c98b6aa06ec4fbc7
+  data.tar.gz: ebad674beccf8d8c3a4fbbd9e00563e54fa69a4869b634a823d1ead960789f448d5d7373a54112a57044cd6185abcff3c85481fb75ab0a10a2b6e898568966a8

data/README.md

@@ -1,39 +1,98 @@
-# Revirow
+# Revirow Ruby Gem
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/revirow`. To experiment with that code, run `bin/console` for an interactive prompt.
+Official Ruby client for the Revirow API. Integrate changelog, feedback collection, and the Revirow widget into your Ruby applications.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+```bash
+bundle add revirow
+```
 
-Install the gem and add to the application's Gemfile by executing:
+## Widget (Rails)
+
+Run the generator:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+rails generate revirow:install
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Add to your environment:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+REVIROW_APP_ID=your_app_id
+REVIROW_KEY=your_key
 ```
 
-## Usage
+Configure the customer context in `config/initializers/revirow.rb`:
+
+```ruby
+Revirow.config do |config|
+  config.customer = Proc.new {
+    {
+      email: Current.user&.email_address,
+      id: Current.user&.id
+    }
+  }
+end
+```
 
-TODO: Write usage instructions here
+Add to your layout:
 
-## Development
+```erb
+<%= revirow_widget %>
+```
+
+Done. The widget loads automatically with authenticated customer data.
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## API Client
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+For server-side API calls, set `REVIROW_KEY` and use the client:
+
+```ruby
+client = Revirow::Client.new
+```
 
-## Contributing
+### Changelog
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/revirow.
+Fetch changelog entries with cursor-based pagination:
 
-## License
+```ruby
+response = client.changelog.list(limit: 10)
+
+response['entries'].each do |entry|
+  puts entry['title']
+  puts entry['content']
+  puts entry['published_at']
+end
+
+# Paginate
+if response['pagination']['has_more']
+  next_page = client.changelog.list(
+    limit: 10,
+    cursor: response['pagination']['next_cursor']
+  )
+end
+```
+
+### Feedback
+
+Submit feedback requests to a feedback board:
+
+```ruby
+response = client.feedback.create(
+  feedback_board_public_id: 'board_abc123',
+  description: 'Would love to see dark mode support!',
+  title: 'Dark Mode Feature Request' # optional
+)
+
+puts response['id']           # public_id
+puts response['title']        # title (if provided)
+puts response['description']  # description
+puts response['status']       # 'open'
+puts response['created_at']   # timestamp
+```
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+**Parameters:**
+- `feedback_board_public_id` (required): The public ID of the feedback board
+- `description` (required): The feedback content/description
+- `title` (optional): A title for the feedback request

data/lib/revirow/client.rb

@@ -17,6 +17,10 @@ module Revirow
       @changelog ||= Resources::Changelog.new(self)
     end
 
+    def feedback
+      @feedback ||= Resources::Feedback.new(self)
+    end
+
     def get(path, params = {})
       uri = URI("#{@base_url}#{path}")
       uri.query = URI.encode_www_form(params) unless params.empty?

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Revirow
+  module Resources
+    class Feedback
+      def initialize(client)
+        @client = client
+      end
+
+      def create(feedback_board_public_id:, description:, title: nil)
+        body = {
+          feedback_board_public_id: feedback_board_public_id,
+          feedback_request: {
+            description: description
+          }
+        }
+        body[:feedback_request][:title] = title if title
+
+        @client.post("/api/feedback", body)
+      end
+    end
+  end
+end

data/lib/revirow/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Revirow
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 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

@@ -3,8 +3,13 @@
 require_relative "revirow/version"
 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.0
+  version: 0.1.2
 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: []
@@ -22,8 +36,14 @@ files:
 - 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
 - sig/revirow.rbs
 homepage: https://revirow.com
 licenses:
@@ -44,7 +64,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: []