eyeloupe 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a2fc3039c5a9cdcbd79a0a5639b74c52c3fc42f0c96fc569f92ce38255e7768
-  data.tar.gz: 4de09b66849266fa6e43af59a55a60ab60464bb1310f8dff5a28a8e84904dac9
+  metadata.gz: fdc0f9276e2c518c9b396f1acbc856460fb3eabdf926cbd8940bc6f33a9ec19c
+  data.tar.gz: c3fa4ae7197c7de0bcbb3790bf0b4b1eb2bd93a6bee3ecca5030b4960b5c74ce
 SHA512:
-  metadata.gz: 0c02695f8f4f26d09df3fda942691bf6729c9c1774b95acc1e9663e48c0ae25bad3d6991804a94163ff6595c8dbc8e56cb7f6dbd6f0be6eb195a2332446b5d9d
-  data.tar.gz: b61c44badf4b0713186338a76d0a246c1f87586d88e8404861931b326aafcfc8945977222e2296fc3d10aee2eb2f369df99cdcc84d4a8c9bb508453f579a6927
+  metadata.gz: c7bf1df1813f5b9791ef17c39149179b7450ba7009d61950edd1bde80edad27be1fb1ea043516dd1c51637040874e05a096c5e9a5fbe5f22379c801e9a1c8943
+  data.tar.gz: e2e24fd0d42f2e430eea07f8395e4a3a2aa6ea0ffd02a44e290339ccc1feaf92fab07af6e2e175ac7cae4a0b95ba13c2c992ecef0d9d4f55cae96085c6cca995

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.3.1
+
+- Add optional database config (thanks to @kiskoza).
+
 ## 0.3.0
 
 - Add exceptions: Framework + ActiveJob + Sidekiq Worker exceptions.
@@ -10,4 +14,4 @@
 
 ## 0.1.0
 
-- Initial release including incoming and outgoing requests.
+- Initial release including incoming and outgoing requests.

data/README.md

@@ -64,6 +64,7 @@ Eyeloupe.configure do |config|
   config.capture = Rails.env.development?
   config.openai_access_key = "your-openai-access-key"
   config.openai_model = "gpt-4"
+  config.database = 'eyeloupe'
 end
 ```
 
@@ -71,6 +72,26 @@ end
 - `capture` is a boolean to enable/disable Eyeloupe capture. By default, it's set to `true`.
 - `openai_access_key` is the access key to use the OpenAI API. You can get one [here](https://platform.openai.com/).
 - `openai_model` is the model to use for the OpenAI API. You can find the list of available models [here](https://platform.openai.com/docs/models).
+- `database` is an optional database config Eyeloupe will use ([Database](#database)).
+
+
+### Database
+
+By default, Eyeloupe uses the same database as your application. If you want to use a different database to keep your production environment clean, you can add a new database config in your `config/database.yml` file:
+
+```yml
+development:
+  primary:
+    <<: *default
+    database: db/development.sqlite3
+  eyeloupe:
+    <<: *default
+    database: db/eyeloupe.sqlite3
+    migrations_paths: <%= Gem.loaded_specs['eyeloupe'].full_gem_path + '/db/migrate' %>
+    schema_dump: false
+```
+
+Using this you can skip the `eyeloupe:install:migrations` step, but do not forget to run `rails db:migrate RAILS_ENV=eyeloupe` to setup the database.
 
 ### Exception handling
 

data/app/models/eyeloupe/application_record.rb

@@ -1,5 +1,9 @@
 module Eyeloupe
   class ApplicationRecord < ActiveRecord::Base
     self.abstract_class = true
+
+    if Eyeloupe.configuration.database
+      connects_to database: { writing: Eyeloupe.configuration.database.to_sym, reading: Eyeloupe.configuration.database.to_sym }
+    end
   end
 end

data/lib/eyeloupe/configuration.rb

@@ -5,6 +5,9 @@ module Eyeloupe
   class Configuration
     include Singleton
 
+    # @return [Symbol|Nil]
+    attr_accessor :database
+
     # @return [Array<String>]
     attr_accessor :excluded_paths
 
@@ -24,4 +27,4 @@ module Eyeloupe
     end
   end
 
-end
+end

data/lib/eyeloupe/version.rb

@@ -1,4 +1,4 @@
 module Eyeloupe
   # @return [String]
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyeloupe
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Alexandre Lion
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-17 00:00:00.000000000 Z
+date: 2023-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sprockets-rails