kibana-rack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c84229a0b4a7242afe5be57e2f6f1d2cc4ea87ed
+  data.tar.gz: a16c4495954ff43258e0a0af39219d1de082cfe8
+SHA512:
+  metadata.gz: d3a4c177193bfb9d395b76d813872e9395789ca2b1fde6d265f3d516e1871d0413de59c51df0a6cee072e2b9314f70474ab6abf54b34d0cb2e4bcaf50d409f93
+  data.tar.gz: 7bc37e75f0a1a97187e9e8b742494d545bdd66381306f00e3035f10ae025abccaba1d5622d722586397c020f9c73a75229801c9e4fa90aa5092799c2b23ca209

checksums.yaml.gz.sig

@@ -0,0 +1 @@
+q�H1>��k����G
�'�M�T��i�>�9���M\Z��q�V�o�ǵM4$2���믃9�

data/.editorconfig

@@ -0,0 +1,13 @@
+# See http://editorconfig.org/ for more information.
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitattributes

@@ -0,0 +1,2 @@
+* text=auto
+*.yml text

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+*.log
+.bundle/
+.config/
+.yardoc/
+Gemfile.lock
+coverage/
+doc/
+pkg/
+tmp/

data/.overcommit.yml

@@ -0,0 +1,11 @@
+---
+PreCommit:
+  Rubocop:
+    enabled: true
+    include:
+      - '*.gemspec'
+      - 'bin/*'
+      - 'lib/**/*.{rake,rb}'
+      - 'spec/**/*.rb'
+      - 'Gemfile'
+      - 'Rakefile'

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,24 @@
+---
+AllCops:
+  Include:
+    - '**/*.gemspec'
+    - '**/config.ru'
+    - '**/Gemfile'
+    - '**/Rakefile'
+  Exclude:
+    - '.bundle/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+
+# Handled via inch.
+Style/Documentation:
+  Enabled: false
+
+Style/FileName:
+  Exclude:
+    - !ruby/regexp /(\d+)-(\w+)\.rb$/
+    - Gemfile
+    - Rakefile
+
+Style/LineLength:
+  Max: 120

data/.simplecov

@@ -0,0 +1,12 @@
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start do
+  SimpleCov.minimum_coverage 95
+
+  add_filter '.bundle'
+  add_filter 'spec'
+end

data/.travis.yml

@@ -0,0 +1,5 @@
+---
+language: ruby
+rvm:
+  - 2.1.2
+bundler_args: --without debugger docs

data/.yardopts

@@ -0,0 +1,13 @@
+--charset utf-8
+--embed-mixin ClassMethods
+--markup-provider redcarpet
+--markup markdown
+--no-private
+--quiet
+--protected
+--readme README.md
+lib/**/*.rb
+-
+CHANGELOG.md
+CONTRIBUTING.md
+LICENSE.txt

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change history for kibana-rack
+
+## [v0.1.0](https://github.com/tabolario/kibana-rack/releases/tag/v0.1.0)
+
+* Initial release

data/CONTRIBUTING.md

@@ -0,0 +1,105 @@
+# Contributing to kibana-rack
+
+Thank you for interest in contributing to kibana-rack!
+
+kibana-rack uses GitHub issues for discussion, issues, and contributions. There are two main ways to contribute to kibana-rack:
+
+One of the goals of kibana-rack is to make it easy for the community to contribute changes. To that end, here are detailed guidelines on how to contribute to kibana-rack.
+
+* Report an issue or make a feature request at kibana-rack's [issue tracker](https://github.com/tabolario/kibana-rack/issues)
+* Contribute features and fix bugs yourself by contributing code to kibana-rack (see below).
+
+## Issues
+
+Issue tracking for kibana-rack happens on GitHub Issues. If you've found a bug or have a feature that you'd like to see implemented, please report it on the issue tracker. [Discussion-only issues](#discussions) are also welcome.
+
+### Bug reports
+
+To minimize the time spent by maintainers in diagnosing and fixing bugs, please use the following template when filing a bug report:
+
+```markdown
+### Version
+
+[Version of kibana-rack installed, or commit SHA if installed from Git]
+
+### Environment
+
+Operating system: [Your operating system and version, (e.g. Mac OS X 10.9)
+Ruby version: [Version of Ruby installed (run `ruby --version`)
+Rails version: [Version of Rails installed if mounting kibana-rack in a Rails application (run `bundle show rails`)]
+Sinatra version: [Version of Sinatra installed if mounting kibana-rack in a Sinatra application (run `bundle show sinatra`)]
+
+[Include any other information about your environment that might be helpful]
+
+### Scenario
+
+[What are you attempting to do that isn't working?]
+
+### Steps to reproduce
+
+[What are the things we need to do in order to reproduce the problem?]
+
+### Expected result:
+
+[What are you expecting to happen when the above steps to reproduce are performed?]
+
+### Actual result:
+
+[What actually happens when the above steps to reproduce are performed?]
+```
+
+### Security issues
+
+If you have discovered an issue with kibana-rack of a sensitive nature that could compromise the security of kibana-rack users, **please report it securely by sending a GPG-encrypted message instead of filing an issue on GitHub**. Please use the following key and send your report to [tony@tabolario.com](mailto:tony@tabolario.com).
+
+[https://raw.github.com/tabolario/kibana-rack/tabolario.gpg](https://raw.github.com/tabolario/kibana-rack/tabolario.gpg)
+
+The fingerprint of the key should be:
+
+    6EED 2359 968F 7734 06A4 AB56 D90E 487A 60F1 0579
+
+### Discussions
+
+Issues to discuss the architecture, design, and functionality of kibana-rack are welcome on the issue tracker, and this is where these discussions are preferred so that we can track them and associate them with issues if necessary.
+
+## Pull requests
+
+### Getting started
+
+* [Fork](https://github.com/tabolario/kibana-rack/fork) the repository on GitHub.
+* Install development dependencies: `bundle`
+* Install the pre-commit hook: `bundle exec rake overcommit --install`
+* Make sure the existing test suite runs for you: `bundle exec rake`
+
+### Making changes
+
+* Create a topic branch for your work.
+  - Prefer to target `master` for new topic branches (`git checkout -b feature/my-new-feature master`).
+  - Only target release branches if your change *must* be for that release.
+  - Avoid working directly on the `master` branch.
+* Make atomic commits of logical units.
+* Check to make sure your changes adhere to the project style guide and linter configuration with `bundle exec rake lint`. (This is done automatically if you have the pre-commit hook installed.)
+* Write unit and integration tests as necessary for your changes. **Pull requests will not be accepted for non-trivial changes without tests.**
+* Ensure that the entire test suite passes with `bundle exec rake spec`.
+* Create a pull request on GitHub for your contribution.
+* Check [Travis CI](https://travis-ci.org/tabolario/kibana-rack/pull_requests) for your pull request. **Only green pull requests will be merged.**
+
+### Trivial changes
+
+Certain types of changes do not need to undergo the same process as changes involving the functionality of kibana-rack (e.g. running tests and static analysis tools). These types of changes include:
+
+* Changes to "root documentation" like `README.md`, `CHANGELOG.md`, and this document
+* Changes to build scripts, and other development configuration files
+* Comment cleanup
+* Formatting cleanup
+* Spelling/grammar fixes
+* Typo corrections
+
+Trivial changes **do** need to pass the Ruby linter (`bundle exec rake lint:ruby`) if they make changes to any Ruby code.
+
+## Getting help
+
+A number of support channels are available for getting help with kibana-rack:
+
+* Email: [tony@tabolario.com](mailto:tony@tabolario.com)
+* Twitter: [@tabolario](https://twitter.com/tabolario)

data/Gemfile

@@ -0,0 +1,30 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'overcommit', '~> 0.16'
+  gem 'rails', '~> 4.1'
+  gem 'rake', '~> 10.3'
+end
+
+group :lint do
+  gem 'inch', '~> 0.4'
+  gem 'rubocop', '~> 0.24'
+end
+
+group :test do
+  gem 'coveralls', '~> 0.7', require: false
+  gem 'rspec', '~> 3.0'
+  gem 'webmock', '~> 1.18', require: false
+end
+
+group :debugger do
+  gem 'pry-byebug', '~> 1.3'
+end
+
+group :docs do
+  gem 'github-markup', '~> 1.2'
+  gem 'redcarpet', '~> 3.1'
+  gem 'yard', github: 'lsegal/yard'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tony Burns
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,269 @@
+# kibana-rack [![Kibana Version](https://img.shields.io/badge/kibana%20version-3.1.0-orange.svg)](http://www.elasticsearch.org/overview/kibana/)
+
+[![Gem Version](https://img.shields.io/gem/v/kibana-rack.svg)](https://rubygems.org/gems/kibana-rack)
+[![Dependency Status](https://gemnasium.com/tabolario/kibana-rack.svg)](https://gemnasium.com/tabolario/kibana-rack)
+[![Build Status](https://travis-ci.org/tabolario/kibana-rack.svg?branch=master)](https://travis-ci.org/tabolario/kibana-rack)
+[![Code Climate](https://img.shields.io/codeclimate/github/tabolario/kibana-rack.svg)](https://codeclimate.com/github/tabolario/kibana-rack)
+[![Coverage Status](https://img.shields.io/coveralls/tabolario/kibana-rack.svg)](https://coveralls.io/r/tabolario/kibana-rack?branch=master)
+[![Inline docs](http://inch-ci.org/github/tabolario/kibana-rack.svg)](http://inch-ci.org/github/tabolario/kibana-rack)
+
+Embed [Kibana](http://www.elasticsearch.org/overview/kibana/) as a [Rack](http://rack.github.io/) application.
+
+Kibana is a beautiful and powerful dashboard built on top of [Elasticsearch](http://www.elasticsearch.org/). It's great for viewing logs indexed by tools like [logstash](http://logstash.net/) and exploring data on Elasticsearch in general.
+
+kibana-rack tracks the latest version of Kibana (currently 3.1.0) and embeds it directly in your application, along with a proxy for the Elasticsearch API endpoints that Kibana needs.
+
+Kibana dashboards can be created using ERB-processed JSON files in the directory specified by your kibana-rack configuration.
+
+## Requirements
+
+* Ruby 2.1+ (kibana-rack is developed and tested with Ruby 2.1.2)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kibana-rack', '~> 0.1.0'
+
+And then execute:
+
+    $ bundle
+
+### Rails
+
+**Note: kibana-rails is coming soon!**
+
+Create an initializer at `config/initializers/kibana.rb` to configure kibana-rack:
+
+```ruby
+Kibana.configure do |config|
+  config.elasticsearch_host = 'localhost'
+  config.elasticsearch_port = 9200
+  config.kibana_dashboards_path = Rails.root.join('app/kibana')
+  config.kibana_default_route = '/dashboard/file/default.json'
+  config.kibana_index = 'kibana-int'
+end
+```
+
+Modify `config/routes.rb`:
+
+```ruby
+Rails.application.routes.draw do
+  mount Kibana::Rack::Web => '/kibana'
+end
+```
+
+### Sinatra and other Rack applications
+
+Configure kibana-rack:
+
+```ruby
+Kibana.configure do |config|
+  config.elasticsearch_host = 'localhost'
+  config.elasticsearch_port = 9200
+  config.kibana_dashboards_path = File.expand_path('../path/to/dashboards', __FILE__)
+  config.kibana_default_route = '/dashboard/file/default.json'
+  config.kibana_index = 'kibana-int'
+end
+```
+
+Mount kibana-rack with [Rack::Builder](http://rubydoc.info/github/rack/rack/master/Rack/Builder):
+
+```ruby
+class MyRackApplication < Sinatra::Base
+  ...
+end
+
+app = Rack::Builder.new do
+  map('/kibana') { use Kibana::Rack::Web }
+  run MyRackApplication
+end
+
+run app
+```
+
+## Usage
+
+See the [Kibana documentation](http://www.elasticsearch.org/guide/en/kibana/current/index.html) for information on how to use Kibana.
+
+## Configuration
+
+kibana-rack is configured by default to serve the dashboards that come in the gem (see the [dashboards](https://github.com/tabolario/kibana-rack/tree/master/dashboards) directory), and proxy to Elasticsearch on `localhost:9200`. It is recommended that you maintain your own dashboards directory inside of the application that kibana-rack is mounted in. Production deployments will also most likely need to configure the address of Elasticsearch.
+
+The following settings are available as accessors on the object yielded to from `Kibana.configure`:
+
+```ruby
+Kibana.configure do |config|
+  config.elasticsearch_host = '10.0.8.9'
+  ...
+end
+```
+
+| Name                     | Description                                                                                     |
+| ------------------------ | ----------------------------------------------------------------------------------------------- |
+| `elasticsearch_host`     | The host of the Elasticsearch instance to proxy to. Default: `localhost`                        |
+| `elasticsearch_port`     | The port of the Elasticsearch instance to proxy to. Default: `9200`                             |
+| `kibana_dashboards_path` | The directory to look for dashboards in. Default: `dashboards` directory inside of kibana-rack  |
+| `kibana_default_route`   | The default path that Kibana will load. Default: `/dashboard/file/default.json`                 |
+| `kibana_index`           | The name of the Elasticsearch index Kibana will use for internal storage. Default: `kibana-int` |
+
+## Securing the `/kibana` endpoint
+
+Kibana is very useful to have in production for things like searching logs and exploring Elasticsearch indexes. When using kibana-rack in a production environment, be sure to secure it from unauthorized access.
+
+### Devise
+
+In `config/routes.rb`:
+
+```ruby
+authenticate :user do
+  mount Kibana::Rack::Web => '/kibana'
+end
+```
+
+Or authenticate only if `User#admin?` returns true for `current_user`:
+
+```ruby
+authenticate :user, ->(user) { user.admin? } do
+  mount Kibana::Rack::Web => '/kibana'
+end
+```
+
+### Rack with HTTP basic authentication
+
+```ruby
+require 'kibana/rack'
+
+map '/kibana' do
+  use Rack::Auth::Basic, 'Restricted Access' do |username, password|
+    username == 'kibana' && password == 'kibana'
+  end
+
+  run Kibana::Rack::Web
+end
+```
+
+## Documentation
+
+See the [examples](https://github.com/tabolario/kibana-rack/tree/master/examples) directory for installation and configuration examples.
+
+See the [YARD documentation](http://rdoc.info/github/tabolario/kibana-rack) for the latest API documentation.
+
+Generate local documentation with YARD (output to the `doc` directory):
+
+    $ bundle exec rake yard
+
+## Support
+
+* [GitHub Issues](https://github.com/tabolario/kibana-rack/issues)
+* Email: [tony@tabolario.com](mailto:tony@tabolario.com)
+* Twitter: [@tabolario](https://twitter.com/tabolario)
+
+## Development and testing
+
+kibana-rack follows the [Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide) for style conventions, with a few exceptions. See [.rubocop.yml](https://github.com/tabolario/kibana-rack/blob/master/.rubocop.yml) for the details.
+
+Run linters ([RuboCop](https://github.com/bbatsov/rubocop) and [Inch](https://github.com/rrrene/inch)):
+
+    $ bundle exec rake lint
+
+Run tests:
+
+    $ bundle exec rake spec
+
+Install pre-commit hooks for [overcommit](https://github.com/causes/overcommit) (configuration is in [.overcommit.yml](https://github.com/tabolario/kibana-rack/blob/master/.overcommit.yml)):
+
+    $ gem install overcommit
+    $ overcommit --install
+
+## Security
+
+### Installation
+
+kibana-rack is cryptographically signed. To be sure the gem you install hasn't been tampered with, add my public key (if you haven't already) as a trusted certificate:
+
+    $ gem cert --add <(curl -Ls https://raw.github.com/tabolario/kibana-rack/master/tabolario.pem)
+
+Installing the gem with the MediumSecurity trust profile will verify all signed gems, but allow the installation of unsigned dependencies:
+
+    $ gem install kibana-rack -P MediumSecurity
+
+You can also set the trust file for Bundler:
+
+    $ bundle --trust-policy MediumSecurity
+
+Using the MediumSecurity policy is often necessary because not all of your dependencies may not be signed, so HighSecurity is not an option.
+
+### Reporting Security Issues
+
+If you have discovered an issue with kibana-rack of a sensitive nature that could compromise the security of kibana-rack users, **please report it securely by sending a GPG-encrypted message instead of filing an issue on GitHub**. Please use the following key and send your report to [tony@tabolario.com](mailto:tony@tabolario.com).
+
+[https://raw.github.com/tabolario/kibana-rack/tabolario.gpg](https://raw.github.com/tabolario/kibana-rack/tabolario.gpg)
+
+The fingerprint of the key should be:
+
+    6EED 2359 968F 7734 06A4 AB56 D90E 487A 60F1 0579
+
+## Contributing
+
+See [CONTRIBUTING.md](https://github.com/tabolario/kibana-rack/blob/master/CONTRIBUTING.md) for full information on how to contribute to kibana-rack.
+
+## Release process
+
+kibana-rack follows [Semver 2.0.0](http://semver.org/spec/v2.0.0.html) for release versioning. The version number components X.Y.Z have the following meanings:
+
+* X for **Major** releases that may contain backwards-incompatible changes.
+* Y for **Minor** releases that may contain features, bug fixes, and backwards-compatible changes.
+* Z for **Patch** releases that only contain bug fixes and trivial changes.
+
+**Pre-release** versions like `X.Y.Z.alpha.0` and `X.Y.Z.beta.1` will be made before **Major**, and **Minor** versions. Pre-release versions are well-tested, but not as thoroughly as the versions that they precede.
+
+Whenever a new version is made, it will be tagged as a release on [GitHub Releases](https://github.com/tabolario/kibana-rack/releases) and pushed to [RubyGems](https://rubygems.org/gems/kibana-rack). Entries in [CHANGELOG.md](https://github.com/tabolario/kibana-rack/blob/master/CHANGELOG.md) will be made incrementally up to the release. An announcement will also be made on Twitter.
+
+When a new **Major** version is made, a corresponding branch will be created named `X-0-0` for further **Minor** and **Patch** releases on that version.
+
+## Todo
+
+* kibana-rails gem for easy integration with Ruby on Rails applications
+* A Ruby DSL for defining dashboards
+* Example dashboards for common use cases
+
+## License
+
+### kibana-rack
+
+|               |                                                                           |
+| ------------- | ------------------------------------------------------------------------- |
+| **Author**    | Tony Burns <[tony@tabolario.com](mailto:tony@tabolario.com)>              |
+| **Copyright** | Copyright (c) 2014 Tony Burns                                             |
+| **License**   | [MIT License](http://opensource.org/licenses/MIT)                         |
+
+```text
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+```
+
+### Kibana
+
+|               |                                                                           |
+| ------------- | ------------------------------------------------------------------------- |
+| **Copyright** | Copyright 2012-2013 Elasticsearch BV                                      |
+| **License**   | [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) |