gemon 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36e1563daa8590611bed955ed24257f384205248
-  data.tar.gz: beb11c4e74c83c3b1add933e3e0750fbc22edde6
+  metadata.gz: 4e96dc9e0478682243a5f542188c7d3accf45400
+  data.tar.gz: 4fdaf9eb576a40a560d5e5074e56d5e891753470
 SHA512:
-  metadata.gz: 65c52ae466f4239184699a75e202186f4e01128fec7b1f9097748786dc617c3fbaf6fe697c9d80ab57711da6da50feaacb3217fe0a2b60cb40861cff3540128f
-  data.tar.gz: 9d08098bc54ec9e8a465c7ceabd1c1c3182b75cb7743cc6fa0f04931d0ced24b360a220a1147920dea1a1487b993a15d9da4367c4fbfbefa1edec90d7767a6ec
+  metadata.gz: f55d12460952fa9b0bee854b3494aa5f094773a5d3893797159c892cd545c136f1f21585f1fa72fcdc436a39b387eccfa2776f4357ba9d8e7ec03a1e9eaf283a
+  data.tar.gz: c118a99260d6707f0d056b24d0c8ad5b95da3522fff5c996068a76657441437e37fe8720f6b59a3b751b0a0d58620e0018e6eb1598ea3514c958f05e5254335d

data/README.md

@@ -22,6 +22,23 @@ mount Gemon::Server, at: "/appstatus"
 
 In the above example the json data will be available on /appstatus in your Rails app.
 
+## Security
+
+To secure your genom endpoint, create an initializer in your Rails app eg `config/initializers/genom.rb`
+
+Add a Genom.api_key to config/initializer file.
+
+```
+Genom.api_key = "123456" # random string
+```
+
+Then when calling the endpoint add the key to the request.
+
+```
+/appstatus?key=123456
+```
+
+If the key isn't set then there is no security on the endpoint.
 
 ## Contributing
 
@@ -30,3 +47,9 @@ In the above example the json data will be available on /appstatus in your Rails
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## ToDo
+
+1. More tests
+2. A generator to generate the initializer file and fill it with a random key.
+3. More documentation on what results are returned.

data/lib/gemon.rb

@@ -4,6 +4,12 @@ require "bundler"
 require "json"
 
 module Gemon
+  class << self
+
+    attr_accessor :api_key
+
+  end
+
   class Server < Sinatra::Base
 
     dir = File.dirname(File.expand_path(__FILE__))
@@ -11,11 +17,18 @@ module Gemon
     set :static, true
 
     get '/' do
+      content_type :json
+
+      if !Gemon.api_key.nil?
+        if params[:key] != Gemon.api_key
+          return {:error => "Invalid Key"}.to_json
+        end
+      end
+
       dir = File.expand_path("..",Dir.pwd)
       dir = Dir.pwd
       gemfile = dir + "/Gemfile.lock"
       lockfile = Bundler::LockfileParser.new(Bundler.read_file(gemfile))
-      content_type :json
       {
         :ruby => ruby_version,
         :os => {

data/lib/gemon/version.rb

@@ -1,3 +1,3 @@
 module Gemon
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemon
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Rob Zolkos