littlebluefox-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dda88c418c0ef82968640e77c993affc13df97bcca95875d75e6aa2d3ba0c47e
+  data.tar.gz: 65b4c2e42cbdc76a5c34ec9dad2b07407abcb495c3298183c87025803b63a017
+SHA512:
+  metadata.gz: f785cde27a6b713343f56f1688c8d32260b1e61f9058ee9e298a8a994e4abe893b1a7b3b16150b28b1e8d1dcbb6751ce426d97d526687b6912f9d65470f12a4d
+  data.tar.gz: eb0484eb0ba87737a0faa42bf53df3a5a9f1251fe5f0740da49e2683a7692e71056b099e046b4bc9bf52b23c198446b95a7c446bec4ba5e674c8833930b07f53

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in littlebluefox-ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    littlebluefox-ruby (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  littlebluefox-ruby!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -0,0 +1,84 @@
+# LittleBlueFox Ruby gem
+
+Push your security events on the littlebleufox.io API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+# Gemfile
+
+gem 'littlebluefox-ruby'
+```
+or
+
+```bash
+    $ gem install littlebluefox-ruby
+```
+
+## Usage
+
+With a RubyOnRails application:
+
+```ruby
+# config/initializers/littlebluefox.rb
+
+LittleBlueFoxClient =  LittleBlueFox::Client.new("...") # Access Token
+```
+
+```ruby
+# app/controllers/sessions_controller.rb
+
+class SessionsController < ApplicationController
+  # ...
+
+  def create
+    # ...
+
+    event = LittleBlueFox::Event.new(
+      :authentication_success,
+      '42',
+      'demo@demo.com',
+      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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/LittleBlueFox/littlebluefox-ruby.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "littlebluefox/core"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/littlebluefox/client.rb

@@ -0,0 +1,60 @@
+require "net/http"
+
+module LittleBlueFox
+  DefaultEndpointUrl = "https://events.littlebluefox.io/"
+  ExpectedResponseCode = 202
+
+  class Client
+    attr_reader :endpoint_url
+
+    def initialize(access_token, endpoint_url = DefaultEndpointUrl)
+      @access_token = access_token
+      @endpoint_url = endpoint_url
+    end
+
+    def push(event)
+      http = Net::HTTP.new(endpoint_uri.host, endpoint_uri.port)
+      http.use_ssl = true if endpoint_uri.port == 443
+
+      req = Net::HTTP::Post.new("/")
+      req["Content-Type"] = "application/json"
+      req["Authorization"] = "Bearer: #{@access_token}"
+
+      req.body = event.to_json
+
+      resp = http.request(req)
+
+      if resp.code == ''
+        raise UnexpectedResponseCode.new(ExpectedResponseCode, nil)
+      end
+
+      status_code = resp.code.to_i
+
+      case status_code
+      when 200..299
+        return true
+      else
+        raise UnexpectedResponseCode.new(ExpectedResponseCode, status_code)
+      end
+    end
+
+    private
+
+    def endpoint_uri
+      @endpoint_uri ||= URI.parse(@endpoint_url)
+    end
+  end
+
+  class UnexpectedResponseCode < StandardError
+    attr_reader :expected_code,
+                :received_code
+
+    def initialize(expected_code, received_code)
+      @expected_code, @received_code = expected_code, received_code
+    end
+
+    def to_s
+      "Unexpected response code from LittleBlueFox.io (expected: #{@expected_code}, got: #{@received_code})"
+    end
+  end
+end

data/lib/littlebluefox/core.rb

@@ -0,0 +1,4 @@
+require "littlebluefox/version"
+require "littlebluefox/event"
+require "littlebluefox/client"
+

data/lib/littlebluefox/event.rb

@@ -0,0 +1,46 @@
+require "json"
+
+module LittleBlueFox
+  class Event
+    attr_accessor :event_type,
+                  :uref,
+                  :email,
+                  :remote_ip,
+                  :http_headers
+
+    def initialize(event_type, uref, email, remote_ip, http_headers)
+      @event_type, @uref, @email, @remote_ip, @http_headers = event_type, uref, email, remote_ip, http_headers
+    end
+
+    def to_json
+      JSON.dump({
+        event_type: event_type,
+        uref: uref,
+        email: email,
+        remote_ip: remote_ip,
+        http_headers: normalized_http_headers,
+      })
+    end
+
+    private
+
+    def normalized_http_headers
+      @http_headers.inject({}) do |acc, (k, v)|
+        acc[k] = v if v.kind_of?(String)
+        acc
+      end
+    end
+  end
+
+  AllowedEventTypes = %w(authentication_request
+  authentication_failure
+  authentication_success
+  password_update_request
+  password_update_failure
+  password_update_success
+  account_creation_success
+  account_creation_failure
+  access_sensitive_data
+  sensitive_data_updated
+  payment_failure)
+end

data/lib/littlebluefox/version.rb

@@ -0,0 +1,3 @@
+module LittleBlueFox
+  VERSION = "1.0.0"
+end

data/littlebluefox-ruby.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "littlebluefox/core"
+
+Gem::Specification.new do |spec|
+  spec.name          = "littlebluefox-ruby"
+  spec.version       = LittleBlueFox::VERSION
+  spec.authors       = ["Sam"]
+  spec.email         = ["sam@littlebluefox.io"]
+
+  spec.summary       = %q{Offical gem of LittleBlueFox.io API}
+  spec.description   = %q{Push your security events on LittleBlueFox API}
+  spec.homepage      = "https://github.com/littlebluefox/littlebluefox-ruby"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  #   spec.metadata["homepage_uri"] = spec.homepage
+  #   spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #   spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: littlebluefox-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sam
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Push your security events on LittleBlueFox API
+email:
+- sam@littlebluefox.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/littlebluefox/client.rb
+- lib/littlebluefox/core.rb
+- lib/littlebluefox/event.rb
+- lib/littlebluefox/version.rb
+- littlebluefox-ruby.gemspec
+homepage: https://github.com/littlebluefox/littlebluefox-ruby
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Offical gem of LittleBlueFox.io API
+test_files: []