gromit 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3af444898dfcaac1bfcaa106def438caafb97f2668bdf631847fa128a9d3a741
-  data.tar.gz: 7ce00d2776eda91d2e43cf6b0bca71065507097c7f54d20c8e610af1e0acf828
+  metadata.gz: 4c08834b2d4ab44b913db4ab7d38b09570afe1e379fe52c1cd0c373509b5bfd4
+  data.tar.gz: 603cbadb8f17fe8dea16ab04404f0f1fd619f0e13f1c400d66b1292906667b69
 SHA512:
-  metadata.gz: d8d7267e931fc77cde96a23cb69777e801bb6ba523ccafc175484b6959b674301106e0a780976847f3fdf9d9c7f30c65df416e7402bbee768fdef306db6f855c
-  data.tar.gz: bd40e1cc12be3992fa54bfdfd9ac31ba47a7266190da7a3dccae9d1568b71cad136afc81856c880963653fdaf068c276ea6862a50f2b76a332e86d437e5ecbc5
+  metadata.gz: 503038957680864be947e60e00e2194f13fec7f4a6f64f40084d0adf4cc5fde72fd3016d23dfeb465a703bc870d4c1c952b5c3c8bf827f1bed5b1fffb3d29e06
+  data.tar.gz: 3fe22ab62a45597fc02cf9111deee1a23b29ecf906fd75c0c6026c1c51086bc70ab58f08af3de6605f505ddb7b1dd835ce2390990e6c61c98f49cf34c697ef0f

data/README.md

@@ -1,14 +1,19 @@
 # Gromit
+
 Your documentation search assitant
 
 ## Usage
 
-Make sure to provide your OpenAI key in a `.env` file
-```
-OPENAPI_ACCESS_TOKEN=your-openai-token
+Make sure to provide your OpenAI token using the `OPENAPI_ACCESS_TOKEN` environment variable.
+
+To mount the Gromit engine in Rails 7, require the engine from your `Gemfile`:
+
+```ruby
+gem "gromit", require: "gromit/engine"
 ```
 
-To mount the Gromit engine in Rails 7 add this line to your routes:
+And add this line to your routes:
+
 ```ruby
 Rails.application.routes.draw do
   mount Gromit::Engine => "/"
@@ -16,6 +21,7 @@ end
 ```
 
 Gromit provides the following routes:
+
 ```
 Routes for Gromit::Engine:
 healthcheck GET  /healthcheck(.:format) gromit/gromit#healthcheck {:format=>:json}
@@ -24,11 +30,13 @@ healthcheck GET  /healthcheck(.:format) gromit/gromit#healthcheck {:format=>:jso
 ```
 
 To index your documentation locally you can use `gromit-reindexer`. This will update `redis-stack-server` running on your machine.
+
 ```bash
 bundle exec gromit-reindexer -s /path/to/your/docs
 ```
 
 To remotely upsert your documentation you can use `gromit-uploader`.
+
 ```bash
 BASE_URL=https://gromit-rails.example.com bundle exec gromit-uploader -s /path/to/your/docs
 ```
@@ -37,6 +45,7 @@ For a working example of a Rails 7 application using Gromit check out:
 https://github.com/releasehub-com/gromit-example
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -44,17 +53,24 @@ gem "gromit"
 ```
 
 And then execute:
+
 ```bash
 $ bundle
 ```
 
 Or install it yourself as:
+
 ```bash
 $ gem install gromit
 ```
 
 ## Contributing
+
 Contribution directions go here.
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+---
+Made with love by the folks @ [release.com](https://release.com)

data/Rakefile

@@ -1,6 +1,6 @@
 require "bundler/setup"
 
-APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+APP_RAKEFILE = File.expand_path("spec/fixtures/dummy/Rakefile", __dir__)
 load "rails/tasks/engine.rake"
 
 load "rails/tasks/statistics.rake"

data/app/controllers/gromit/gromit_controller.rb

@@ -2,6 +2,8 @@ require 'rejson'
 
 module Gromit
   class GromitController < ApplicationController
+    IM_A_TEAPOT = 418
+
     skip_before_action :verify_authenticity_token
 
     def healthcheck
@@ -16,14 +18,19 @@ module Gromit
 
           # create the index if it's not already there
           gromit.create_index
+          render json: { status: 'healthy', message: 'Redis connection is healthy' }
         else
-          render json: { status: 'unhealthy', message: 'Redis connection is unhealthy' }
+          render json: { status: 'unhealthy', message: 'Redis connection is unhealthy' }, status: IM_A_TEAPOT
         end
       rescue Redis::CommandError, Redis::CannotConnectError => e
-        if e.message == "Index already exists"
-          render json: { status: 'healthy', message: 'Redis connection is healthy' }
+        if e.is_a?(Redis::CommandError)
+          if e.message == "Index already exists" 
+            render json: { status: 'healthy', message: 'Redis connection is healthy' }
+          else
+            render json: { status: 'unhealthy', message: "Unknown command error" }, status: IM_A_TEAPOT
+          end
         else
-          render json: { status: 'unhealthy', message: "Redis connection error: #{e.message}" }
+          render json: { status: 'unhealthy', message: "Redis connection error: #{e.message}" }, status: IM_A_TEAPOT
         end
       end
     end
@@ -31,7 +38,7 @@ module Gromit
     def search
       gromit = Gromit::Search.new
       result = gromit.find_by_embedding(params[:embedding])
-      render json: result
+      render json: { data: result }
     end
 
     def upsert
@@ -43,8 +50,10 @@ module Gromit
       # Extract the key and value from the request data
       id = params[:id]
 
+      data = params.to_unsafe_h.deep_stringify_keys
+
       # Upsert the record into the Redis database
-      gromit.redis.json_set("item:#{id}", Rejson::Path.root_path, params.to_unsafe_h.deep_stringify_keys)
+      gromit.redis.json_set("item:#{id}", Rejson::Path.root_path.str_path, data.except("action", "controller"))
 
       # Return a success response
       render json: { status: 'success', message: "Record upserted successfully", key: "item:#{id}" }

data/lib/gromit/engine.rb

@@ -1,3 +1,4 @@
+require "gromit"
 require "rails"
 
 module Gromit

data/lib/gromit/markdown_parser.rb

@@ -1,8 +1,9 @@
+require 'active_support/inflector/methods'
 
 class Gromit::MarkdownParser
   attr_reader :sections, :file_path
 
-  class << self 
+  class << self
 
     def redis
       @@redis ||= Redis.new(host: ENV.fetch("REDIS_HOST") { "127.0.0.1" }, port: ENV.fetch("REDIS_PORT") { "6379" }.to_i)
@@ -89,14 +90,14 @@ class Gromit::MarkdownParser
 
       # remove the .md extension from the end of the URLs from gitbook
       file.gsub!(/(\[[^\]]+?\])\((.*?)\.md([#a-z0-9]*)\)/) do |match|
-        "#{$1}(#{$2}#{$3})" 
+        "#{$1}(#{$2}#{$3})"
       end
 
-      # handle "mentions" 
+      # handle "mentions"
       file.gsub!(/\[([^\]]+?).md\]\((.*?)\.md([#a-z0-9]*) "mention"\)/) do |match|
         link = "#{$2}#{$3}"
-        title = $1.gsub("-", ' ').titleize
-        "[#{title}](#{link})" 
+        title = ActiveSupport::Inflector.titleize($1.gsub("-", ' '))
+        "[#{title}](#{link})"
       end
 
       # convert gitbook hints to admonitions

data/lib/gromit/reindexer.rb

@@ -1,16 +1,10 @@
 require 'bundler/setup'
 require 'openai'
-require 'dotenv'
 require 'optparse'
 require 'redis'
 require 'rejson'
-require 'active_support/all'
-
 require_relative 'markdown_parser'
 
-Dotenv.load
-
-
 class Gromit::Reindexer
   attr_accessor :redis
 
@@ -24,7 +18,7 @@ class Gromit::Reindexer
           options[:source_dir] = source_dir
         end
 
-        opts.on('-d', '--drop', 'Drop and create index before reindexing') do 
+        opts.on('-d', '--drop', 'Drop and create index before reindexing') do
           options[:drop] = true
         end
 
@@ -38,14 +32,14 @@ class Gromit::Reindexer
 
       # Instantiate the ToMkDocs class and perform the conversion
       reindexer = Gromit::Reindexer.new
-      reindexer.run(options[:source_dir], drop: options[:drop]) 
+      reindexer.run(options[:source_dir], drop: options[:drop])
 
       puts "Reindexer completed successfully."
     end
   end
 
   def initialize
-    @redis ||= Redis.new(host: ENV.fetch("REDIS_HOST") { "127.0.0.1" }, port: ENV.fetch("REDIS_PORT") { "6379" }.to_i)
+    @redis ||= Gromit::MarkdownParser.redis
   end
 
   def run(directory = nil, drop: false)
@@ -55,11 +49,12 @@ class Gromit::Reindexer
       gromit.recreate_index
     end
 
+    #TODO do we really want david's examples as the default here?
     directory ||= ENV.fetch("DOCS_DIRECTORY") { "/Users/david/development/docs/examples" }
     sections = Gromit::MarkdownParser.process(directory)
     sections.each do |section|
       puts "indexing: #{section[:file]} section: #{section[:section_title]}"
-      data = section.stringify_keys
+      data = section.transform_keys(&:to_s)
       id = data['id']
       gromit.redis.json_set("item:#{id}", Rejson::Path.root_path, data)
     end

data/lib/gromit/uploader.rb

@@ -1,15 +1,11 @@
 require 'bundler/setup'
 require 'openai'
 require 'httparty'
-require 'dotenv'
 require 'pathname'
 require 'optparse'
 
 require_relative 'markdown_parser'
 
-Dotenv.load
-
-
 class Gromit::Uploader
 
   class << self
@@ -25,7 +21,7 @@ class Gromit::Uploader
       end.parse!
 
       path = Pathname.new(options.fetch(:source_dir, ''))
-      
+
       unless path.exist?
         puts "Error: The source directory (-s or --source) doesn't exist or is not specified."
         exit 1

data/lib/gromit/version.rb

@@ -1,3 +1,3 @@
 module Gromit
-  VERSION = "0.1.4"
+  VERSION = "0.1.6"
 end

data/lib/gromit.rb

@@ -1,5 +1,4 @@
 require "gromit/version"
-require "gromit/engine"
 require "gromit/markdown_parser"
 
 module Gromit

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: gromit
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - David Giffin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-08 00:00:00.000000000 Z
+date: 2023-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 7.0.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 7.0.1
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement