revirow 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b8aad536825b4fd30fafb55b524eb41818078e2afc40d7600d7a125758196c6
-  data.tar.gz: b22386d8e3a405c0fa138699070b94dda5bba3b79ab27cb3f1389d078721ca9e
+  metadata.gz: 3d964e2566cd2be44b64c0138ec3c873dce7541b3f0e9e38c6cd20d8bc3a3a4b
+  data.tar.gz: a7d99e718b3298bd8437e6160aea34720b627e999b7bb984d5e3bf306723d200
 SHA512:
-  metadata.gz: 45bd145f6b69dac9c96c2d3d24f3eebfc928900d0329d86ea8ab4c5a92fb859475df60708b06ec1831b199e17c943b41039e20e14c798a805f6156414f004c71
-  data.tar.gz: 86a401e3c53b89b323319acc7c5bd49686d50f87dca7e284da9ea4539273937374c62479fe4b1cc369b89e57eb5bd2cc89a34ae7e48e189fad85f30beb7bf535
+  metadata.gz: 39f9be4f8c68093593e07300a70a32dc03f66b11f6c0c2654a85995ec6403c3d2d97fe08638119dfa4011f02576b85224f6316956b248e8cf7aa8cb6ff9fc2dc
+  data.tar.gz: cbbd94e80bc9d3b70475d185c0873b786da78e9bddbab33d278843eba285c7ae3d882c48de05793f43544ef0e58a5c65a6d0be6cc3d4a78784d2a41d24780c92

data/README.md

@@ -1,39 +1,80 @@
-# 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 and feedback collection 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.
-
 Install the gem and add to the application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add revirow
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install revirow
 ```
 
+## Configuration
+
+Add your API key as an environment variable `REVIROW_KEY`. The gem will automatically use this key.
+
 ## Usage
 
-TODO: Write usage instructions here
+### Initialize Client
+
+```ruby
+require 'revirow'
+
+client = Revirow::Client.new
+```
+
+### Changelog
+
+Fetch changelog entries with cursor-based pagination:
 
-## Development
+```ruby
+# Get latest changelog entries
+response = client.changelog.list(limit: 10)
 
-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.
+# Access entries
+response['entries'].each do |entry|
+  puts entry['title']
+  puts entry['content']
+  puts entry['published_at']
+end
 
-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).
+# Paginate through more entries
+if response['pagination']['has_more']
+  next_page = client.changelog.list(
+    limit: 10,
+    cursor: response['pagination']['next_cursor']
+  )
+end
+```
+
+### Feedback
 
-## Contributing
+Submit feedback requests to a feedback board:
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/revirow.
+```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
+)
 
-## License
+# Response includes the created feedback request
+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/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.1"
 end

data/lib/revirow.rb

@@ -3,6 +3,7 @@
 require_relative "revirow/version"
 require_relative "revirow/configuration"
 require_relative "revirow/resources/changelog"
+require_relative "revirow/resources/feedback"
 require_relative "revirow/client"
 
 module Revirow

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: revirow
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Revirow
@@ -23,7 +23,9 @@ files:
 - lib/revirow/client.rb
 - lib/revirow/configuration.rb
 - lib/revirow/resources/changelog.rb
+- lib/revirow/resources/feedback.rb
 - lib/revirow/version.rb
+- revirow-0.1.0.gem
 - sig/revirow.rbs
 homepage: https://revirow.com
 licenses: