info 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 31e53f7a9fe86770c1708f0d3d1569a8d968e970
+  data.tar.gz: 4888fed4ece7745dfc387e35a61af05cc288b1d8
+SHA512:
+  metadata.gz: 4589e198dd442e17426264078078fb73efb47427fa71fe39dc1abf256b1c09ee73f2a58da99bc026160354805d042187ccdf17491dd2d69792097558bd3bbf50
+  data.tar.gz: 9579c661cdc76ab5dc30af2f0cb0744ef61dbae5219edc67601a91affc13cf56af8fa00a48302c7910b10e011f56329c0979bcf8c16a55bbfc484953d0e82029

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,83 @@
+# Info
+
+[![Build Status](https://travis-ci.org/fnando/info.svg)](https://travis-ci.org/fnando/info)
+[![Code Climate](https://codeclimate.com/github/fnando/info.png)](https://codeclimate.com/github/fnando/info)
+
+Info a library that allows you collecting info about your application in a simple JSON endpoint.
+
+## Installation
+
+Just the following line to your Gemfile:
+
+    gem "info"
+
+## Usage
+
+To add your own collectors, just use the method `Info::Configuration#add`.
+
+```ruby
+Info.setup do
+  add 'Rails', Rails.version
+end
+```
+
+You can also use `Info.add 'Rails', Rails.version`.
+
+Info comes with some default information; just load the `info/rails` file. You can do it on a initializer file (`config/initializers/info.rb`) or your Gemfile.
+
+```ruby
+gem 'info', require: 'info/rails'
+```
+
+Rubygems that your app is using can be collected by loading the file `info/rubygems`.
+
+You may need to clear all collectors; in this case just use `Info.collectors.clear`.
+
+To view your collected info, just visit `/application/info`. This endpoint is public, so you can set authorization with two strategies: token and basic auth.
+
+### Authorization
+
+To authorize the endpoint access with basic authentication, just provide a block that requires two arguments.
+
+```ruby
+Info.setup do
+  authorize {|email, password| AdminUser.find_by_email(email).authenticate(password) }
+end
+```
+
+To authorize the endpoint access with token authentication, just provide a block that requires one argument.
+
+```ruby
+Info.setup do
+  authorize {|token| AdminUser.find_by_token(token).present? }
+end
+```
+
+You can also use `Info.authorize(&block)`.
+
+## Maintainer
+
+* Nando Vieira (<http://simplesideias.com.br>)
+
+## License:
+
+(The 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/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/setup'
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks

data/app/controllers/info_controller.rb

@@ -0,0 +1,27 @@
+class InfoController < ActionController::Base
+  if respond_to?(:before_action, true)
+    before_action :authorize
+  else
+    before_filter :authorize
+  end
+
+  def show
+    if Info.configuration.enabled
+      render json: Info.collect
+    else
+      render nothing: true
+    end
+  end
+
+  private
+
+  def authorize
+    authorizer = Info.configuration.authorizer
+    return unless authorizer
+
+    arity = authorizer.arity
+
+    authenticate_or_request_with_http_basic(&authorizer) if arity == 2
+    authenticate_or_request_with_http_token(&authorizer) if arity == 1
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  get 'application/info', to: 'info#show'
+end

data/lib/info.rb

@@ -0,0 +1,22 @@
+require 'forwardable'
+
+require 'info/version'
+require 'info/engine'
+require 'info/configuration'
+
+module Info
+  class << self
+    extend Forwardable
+
+    def_delegators :configuration,
+      :enabled?, :collect, :add, :enable!, :disable!, :authorize, :collectors
+  end
+
+  def self.setup(&block)
+    configuration.instance_eval(&block)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+end

data/lib/info/configuration.rb

@@ -0,0 +1,48 @@
+module Info
+  class Configuration
+    attr_accessor :enabled
+    attr_accessor :authorizer
+
+    def collect(request = nil)
+      collectors.each_with_object({}) do |collector, buffer|
+        buffer[collector[:name]] = collect_value request, collector[:value]
+      end
+    end
+
+    def collectors
+      @collectors ||= []
+    end
+
+    def authorize(&block)
+      @authorizer = block
+    end
+
+    def enabled?
+      @enabled
+    end
+
+    def disable!
+      @enabled = false
+    end
+
+    def enable!
+      @enabled = true
+    end
+
+    def add(name, value)
+      collectors << {name: name, value: value}
+    end
+
+    private
+
+    def collect_value(request, value)
+      return value unless value.respond_to?(:call)
+
+      if value.arity == 0
+        value.call
+      else
+        value.call(request)
+      end
+    end
+  end
+end

data/lib/info/engine.rb

@@ -0,0 +1,4 @@
+module Info
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/info/rails.rb

@@ -0,0 +1,8 @@
+require 'info'
+
+Info.setup do
+  add 'Rails', Rails.version
+  add 'Database', ActiveRecord::Base.connection.adapter_name
+  add 'SSL', -> r { r.ssl? }
+  add 'Application Server', -> r { r.env['SERVER_SOFTWARE'] }
+end

data/lib/info/rubygems.rb

@@ -0,0 +1,7 @@
+require 'info'
+
+Info.setup do
+  add 'Rubygems', Gem.loaded_specs.map {|(_, spec)|
+    {name: spec.name, version: spec.version.to_s}
+  }
+end

data/lib/info/version.rb

@@ -0,0 +1,3 @@
+module Info
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: info
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nando Vieira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-meta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A JSON endpoint with your Rails application info
+email:
+- fnando.vieira@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/info_controller.rb
+- config/routes.rb
+- lib/info.rb
+- lib/info/configuration.rb
+- lib/info/engine.rb
+- lib/info/rails.rb
+- lib/info/rubygems.rb
+- lib/info/version.rb
+homepage: http://github.com/fnando/info
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A JSON endpoint with your Rails application info
+test_files: []