littlebluefox-ruby

LittleBlueFox Ruby gem

Push your security events on the LittleBlueFox.io API.

Installation

Add this line to your application's Gemfile:

# Gemfile

gem 'littlebluefox-ruby'

or

    $ gem install littlebluefox-ruby

Usage

With a RubyOnRails application:

# config/initializers/littlebluefox.rb

require 'littlebluefox/core'
LittleBlueFoxClient =  LittleBlueFox::Client.new("...") # Access Token

# app/controllers/sessions_controller.rb

class SessionsController < ApplicationController
  # ...

  def create
    # ...

    event = LittleBlueFox::Event.new(
      :authentication_success,
      '42',
      '[e-mail]',
      request.remote_ip,
      request.headers,
    )

    if user.authenticate(session_params)
      event.event_type = :authentication_success
      push_security_event(event)

      # redirect_to hompage_path 
    else
      event.event_type = :authentication_failure
      push_security_event(event)

      # ...
      # render :new
    end
  end

  private

  def push_security_event(event)
    begin
      LittleBlueFoxClient.push(event)
    rescue => e
      Rails.logger.info(e)
    end
  end

  # ...
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

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 tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/LittleBlueFox/littlebluefox-ruby.