blipit 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 725f1f7935b92f07ead1f9c8dc944077671d90708857ad933b56f3f99898803e
-  data.tar.gz: 30cc8ca3193055b99770d4ec0120baa128b3b10ee30c4a379cec1a6ab8cc176f
+  metadata.gz: e3b3f5df2c1e54476b7900840749686a2fb0d3428f41722ccfe507431d52bbf7
+  data.tar.gz: 509a9d7e0673ea9a82600a798e6f4f71e8d5341633b46754b1e6292a2e4d94b2
 SHA512:
-  metadata.gz: e6808a51c08d76b523c739fdba9b5ed1539ea4a2638daa18a9e4f35c4142ca454d4f8140f5dabeab73f084247107465eaac95b48fb31f7db2b409927aede1533
-  data.tar.gz: 316d73b300b658fb392e2af61049fadc48acc6f593dbbed58490019c03d5d48d4ec83358d766bb5a07337a96d2f3100f6ea1c7251e745a2b951b1df3613aa5a9
+  metadata.gz: 8039c976e246061ceb6144765687e628708c7b317d414fc0e5cc6aa33231f4f857fe8d0b284457ace8abdaf11c8ab9eb974216ceabcbadfc1da4b7ac4513719b
+  data.tar.gz: 554c68f653f4c30640355ffc67353e386d81a0271a62aa699780d9af6446543305a381d188c6d8f2c0ae72f3344cc5aee9557dfe79cd33c8872b919e1b7b1bdb

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## 0.2.1
+
+- Events carry the `gem:blipit` package and version, so the dashboard can show when this project runs an old Blipit SDK. A `before_send` you set still runs after it.
+- In development (`environment: "development"` or `debug: true`) the SDK warns once per process when a newer version is out: `[blipit] 0.2.2 is available (you have 0.2.1) — <why> — bundle update blipit`. It reads a header on the responses to events it already sends (no extra request); a custom `transport_class` is left alone. Nothing is printed in production.
+
+## 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,8 +53,11 @@ 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)
 ```
 
+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
@@ -49,3 +65,7 @@ Blipit.capture_security("login_failed", email, outcome: "wrong password", ip: re
 Pass `traces_sample_rate: 0.2` to `init` and requests show up on the Performance page.
 
 Docs: https://docs.blipit.io/ruby
+
+## Updates
+
+In development Blipit prints one line when a newer version is out, with the reason and the command. Update with `bundle update blipit`. Details: https://docs.blipit.io/updates

data/lib/blipit/version.rb

@@ -1,3 +1,3 @@
 module Blipit
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

data/lib/blipit.rb

@@ -1,12 +1,43 @@
 require "sentry-ruby"
+require "json"
+require "uri"
 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."
+  UPDATE_COMMAND = "bundle update blipit"
+  PACKAGE = { "name" => "gem:blipit", "version" => VERSION }.freeze
+
+  if Sentry::HTTPTransport.method_defined?(:do_request)
+    class NoticeTransport < Sentry::HTTPTransport
+      def do_request(*args)
+        response = super
+        Blipit.notice(response)
+        response
+      end
+    end
+  end
 
   class << self
     def dsn(key, project, endpoint = DEFAULT_ENDPOINT)
@@ -16,9 +47,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?
+      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_")
-      raise ArgumentError, "Blipit.init needs the project id" if project.nil? || project.to_s.empty?
+      warn(RAILS_WARNING) if defined?(::Rails::Railtie) && !defined?(::Sentry::Rails)
 
       Sentry.init do |config|
         config.dsn = dsn(key, project, endpoint)
@@ -28,7 +66,51 @@ module Blipit
         config.send_default_pii = false
         options.each { |name, value| config.public_send("#{name}=", value) }
         yield config if block_given?
+        user_before_send = config.before_send
+        config.before_send = lambda do |event, hint|
+          with_identity(event)
+          user_before_send ? user_before_send.call(event, hint) : event
+        end
+        if (config.environment == "development" || config.debug) && config.transport.transport_class.nil? && defined?(NoticeTransport)
+          config.transport.transport_class = NoticeTransport
+        end
       end
+      true
+    end
+
+    def update_notice(header, current = VERSION)
+      latest = JSON.parse(URI.decode_www_form_component(header.to_s.gsub("+", "%2B")))
+      version = latest.is_a?(Hash) ? latest["version"] : nil
+      return nil unless version.is_a?(String) && !version.empty? && version != current
+
+      note = latest["note"].is_a?(String) ? latest["note"].strip : ""
+      why = note.empty? ? "" : " — #{note}"
+      "[blipit] #{version} is available (you have #{current})#{why} — #{UPDATE_COMMAND}"
+    rescue StandardError
+      nil
+    end
+
+    def notice(response)
+      return if @noticed
+
+      header = response["x-blipit-latest"]
+      line = header && update_notice(header)
+      return unless line
+
+      @noticed = true
+      warn(line)
+    rescue StandardError
+      nil
+    end
+
+    def with_identity(event)
+      sdk = event.sdk.is_a?(Hash) ? event.sdk : {}
+      packages = Array(sdk["packages"] || sdk[:packages])
+      return if packages.any? { |p| p.is_a?(Hash) && (p["name"] || p[:name]) == PACKAGE["name"] }
+
+      event.sdk = sdk.merge("packages" => packages + [PACKAGE.dup])
+    rescue StandardError
+      nil
     end
 
     def capture_exception(error, **options)
@@ -51,7 +133,13 @@ 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

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blipit
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Louward Labs
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-10-12 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: []