blipit 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f949d1c6a29c26aea5036c4cb3298cd599f14f2ca5019946e72003fb9a53e87
-  data.tar.gz: b1e38bd23ac52d4fe74f5ec0b44e3b5c2f0d6b30a5ad6e092af833f49bbc006c
+  metadata.gz: 26c9f309ac743a11246ec29e103453393f9de8090a776825084447ab62b65a70
+  data.tar.gz: 5478afcc59b160311c19bd95979c5e199c7b24450923df33915d5ee073c308ef
 SHA512:
-  metadata.gz: 601637f0986ab8b4da74b5d6c7b656da8cb9c47193da167510c587185d66fa138610db8273fdf13e39bf886e5392c28ddd55f6fdfe21b32786c13d6ce8d5e7f0
-  data.tar.gz: 4ec6d0bafe9bd2dc3c186b43ee4a9c63becbe4351bf5bd30cd447b8abc5f94224d2cba1fe6812bb188aa32ede4f0e246a99459b39a0e2b4847e0df69514153a9
+  metadata.gz: 7645f41801bf2e2bde5f645ac1388f28f8b8cb9497c423792b1f0c4857e0dd06dd65724e48f79d7ba7659dc5ce17efebb73925feab767fc357698c9c7441f0ff
+  data.tar.gz: c81edf9b9a303104f76da895e5d02698a4dd66936e121f1a47a69ab24a364fe054ac8bb811572fb79d4c885a8bf208a8e2e56657687d281ed760d0390f821b17

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.2.0
+
+- `Blipit.init` with an empty key or project id prints a warning, returns false and leaves Blipit off instead of raising ArgumentError.
+- Rails: `sentry-rails` is loaded automatically when it is in the Gemfile, so controller and job errors are reported; without it `Blipit.init` warns that controller errors will not be sent.
+- `capture_security` takes `kind` and `actor` positionally or as keywords; a missing actor prints a warning instead of raising.

data/README.md

@@ -20,11 +20,24 @@ require "blipit"
 Blipit.init(key: "<public key>", project: <project id>, environment: "production", release: "myapp@1.4.2")
 ```
 
-Both values are on the project's Keys page at app.blipit.io. Unhandled exceptions are reported on their own.
+Both values are on the project's Keys page at app.blipit.io. Unhandled exceptions are reported on their own. If the key or project id is empty (for example an unset environment variable), `init` prints a warning, returns `false` and Blipit stays off; it never raises, so a missing key cannot stop the app from booting.
 
 ## Rails
 
-Put the `Blipit.init` call in `config/initializers/blipit.rb`. If you want the Rails integration (controller and job context, ActiveRecord breadcrumbs), add `gem "sentry-rails"` instead and set `config.dsn = "https://<public key>@in.blipit.io/<project id>"` in its initializer.
+Rails rescues controller and job errors before they reach Ruby, so Rails apps need `sentry-rails` next to `blipit`:
+
+```ruby
+gem "blipit"
+gem "sentry-rails"
+```
+
+Then put the `Blipit.init` call in `config/initializers/blipit.rb`:
+
+```ruby
+Blipit.init(key: ENV["BLIPIT_KEY"], project: ENV["BLIPIT_PROJECT"], environment: Rails.env, release: ENV["GIT_SHA"])
+```
+
+`blipit` loads `sentry-rails` on its own when Rails is running, and `Blipit.init` configures it, so controller errors, job errors and request context are reported. Without `sentry-rails` in the Gemfile, `Blipit.init` prints a warning saying controller errors will not be sent.
 
 ## Manual capture
 
@@ -40,9 +53,12 @@ Blipit.add_breadcrumb("cache cleared", category: "cache")
 
 ```ruby
 Blipit.capture_security("login_failed", email, outcome: "wrong password", ip: request.remote_ip, user_agent: request.user_agent)
+Blipit.capture_security(kind: "login_failed", actor: email, ip: request.remote_ip)
 ```
 
-`kind` is one of `login_failed`, `login_blocked`, `login_succeeded`, `password_reset` or any short name you choose. Failed and blocked logins are reported as warnings.
+Both forms work. Without a kind or an actor it prints a warning and sends nothing instead of raising.
+
+`kind` is one of `login_failed`, `login_blocked`, `login_succeeded`, `password_reset_requested` or `privilege_granted`; any other kind arrives as a plain message. Login attempts need the project's secret key (init with it on the server) and the Scale plan; with the public key ingest refuses them with 403 `security_needs_secret_key`.
 
 ## Performance
 

data/lib/blipit/version.rb

@@ -1,3 +1,3 @@
 module Blipit
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/blipit.rb

@@ -1,9 +1,29 @@
 require "sentry-ruby"
 require_relative "blipit/version"
 
+if defined?(::Rails::Railtie)
+  begin
+    require "sentry-rails"
+  rescue LoadError
+    nil
+  end
+end
+
 module Blipit
   DEFAULT_ENDPOINT = "https://in.blipit.io"
   WARNING_KINDS = %w[login_failed login_blocked].freeze
+  PUBLIC_KEY_WARNING = "[blipit] login attempts need the project's secret key (blipit_sk_...). " \
+                       "This SDK was started with the public key, so capture_security sends nothing. " \
+                       "Use the secret key on the server."
+  MISSING_KEY_WARNING = "[blipit] Blipit.init got no key, so Blipit is off and nothing is sent. " \
+                        "Pass the project's key (app.blipit.io, Keys), for example from ENV[\"BLIPIT_KEY\"]; " \
+                        "with Rails config caching, check that the value is set where the app boots."
+  MISSING_PROJECT_WARNING = "[blipit] Blipit.init got no project id, so Blipit is off and nothing is sent. " \
+                            "Pass project: with the id from the project's Keys page at app.blipit.io."
+  RAILS_WARNING = "[blipit] Rails is loaded but sentry-rails is not, so errors raised in controllers and jobs are not reported " \
+                  "(Rails rescues them before they reach Ruby). Add gem \"sentry-rails\" to your Gemfile next to gem \"blipit\" " \
+                  "and run bundle install."
+  MISSING_ACTOR_WARNING = "[blipit] capture_security needs a kind and an actor, so this login attempt was not sent."
 
   class << self
     def dsn(key, project, endpoint = DEFAULT_ENDPOINT)
@@ -13,8 +33,16 @@ module Blipit
     end
 
     def init(key:, project:, environment: nil, release: nil, traces_sample_rate: 0.0, endpoint: DEFAULT_ENDPOINT, **options)
-      raise ArgumentError, "Blipit.init needs the project's public key" if key.nil? || key.to_s.empty?
-      raise ArgumentError, "Blipit.init needs the project id" if project.nil? || project.to_s.empty?
+      if key.nil? || key.to_s.strip.empty?
+        warn(MISSING_KEY_WARNING)
+        return false
+      end
+      if project.nil? || project.to_s.strip.empty?
+        warn(MISSING_PROJECT_WARNING)
+        return false
+      end
+      @public_key = key.to_s.start_with?("blipit_pk_")
+      warn(RAILS_WARNING) if defined?(::Rails::Railtie) && !defined?(::Sentry::Rails)
 
       Sentry.init do |config|
         config.dsn = dsn(key, project, endpoint)
@@ -25,6 +53,7 @@ module Blipit
         options.each { |name, value| config.public_send("#{name}=", value) }
         yield config if block_given?
       end
+      true
     end
 
     def capture_exception(error, **options)
@@ -47,7 +76,18 @@ module Blipit
       Sentry.add_breadcrumb(Sentry::Breadcrumb.new(message: message, category: category, level: level, data: data))
     end
 
-    def capture_security(kind, actor, outcome: nil, actor_id: nil, ip: nil, user_agent: nil, target: nil)
+    def capture_security(kind_arg = nil, actor_arg = nil, kind: nil, actor: nil, outcome: nil, actor_id: nil, ip: nil, user_agent: nil, target: nil)
+      kind ||= kind_arg
+      actor ||= actor_arg
+      if kind.to_s.empty? || actor.to_s.strip.empty?
+        warn(MISSING_ACTOR_WARNING)
+        return
+      end
+      if @public_key
+        warn(PUBLIC_KEY_WARNING) unless @public_key_warned
+        @public_key_warned = true
+        return
+      end
       payload = {
         kind: kind,
         actor: actor,

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blipit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Louward Labs
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -72,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - README.md
 - lib/blipit.rb
 - lib/blipit/version.rb
@@ -83,6 +85,7 @@ metadata:
   documentation_uri: https://docs.blipit.io/ruby
   changelog_uri: https://blipit.io/changelog
   rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -97,7 +100,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.20
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Blipit error monitoring for Ruby and Rails
 test_files: []