minicron 0.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b6939554f2e620783856cad085a5caebb87d70c
-  data.tar.gz: 3384f8536105f764031a7035c9a3fea95b985bcf
+  metadata.gz: 35de796bf50cd82b589cc12e51a66b2362115a31
+  data.tar.gz: 62f8e00109bdbe0183cdfada35edeca291644763
 SHA512:
-  metadata.gz: f9420b0503c77643198a875eda7a194630186dd9809f90574b1c234eff524ffc9a1f6b925dc5e766ad775f2d9f89e94e3450c3c810347157d55de6745f9b8287
-  data.tar.gz: d4ffe62daecf9ae0abab5b85baf68d40da45a6c1b89a68b20793c4256a7488c8b1e875e4827ab5bcf0856d455c2260d5ed5cf1359b5d41e60d4d9fdc70b487b7
+  metadata.gz: e0bf079a5c2d51f8c978b7e68c4b5790c4a6c1a81bc963f8d2a6955ad95947539f66209ad05678e49bcde1428a554753789ab6d7b0ceb0eeb32a15150322b87b
+  data.tar.gz: e353f032490d9432c5ceee70ae52068a9d9fda2bff02320436e546ffb5f4ff274fa7686d4c6dec8dd6b934ae2a1ebdba89090f460b1324b72085edd42c85d732

data/README.md

@@ -11,15 +11,15 @@ minicron
 minicron aims to complement ````cron```` by making it easier to manage and monitor cron jobs, it can largely be
 thought of as two components that interact together, the CLI and the Hub. The CLI is what is installed on your
 server(s) and executes your cron command and reports the status back to the Hub. The Hub is the central point
-where data from one or many instances of the CLI are is recieved and stored in a database. The Hub also provides
+where data from one or many instances of the CLI is recieved and stored in a database. The Hub also provides
 a web interface to the data and makes it easy to manage your cron jobs.
 
-- [Screenshots](#screenshots)
 - [Background](#background)
 - [Features](#goals)
 - [Requirements](#requirements)
 - [Installation](#installation)
 - [Usage](#usage)
+- [Security](#security)
 - [Documentation](#documentation)
 - [Versioning](#versioning)
 - [Contributing](#contributing)
@@ -29,9 +29,10 @@ a web interface to the data and makes it easy to manage your cron jobs.
 Screenshots
 ------------
 
-<img src="http://f.cl.ly/items/2o3q3x1N1X3n2t180H1u/Image%202014-04-12%20at%2010.54.39%20pm.png" height="100"/>
-
-More coming..
+<img src="http://f.cl.ly/items/1k1h3n2A3Z3P3v2o0733/Image%202014-04-15%20at%2012.50.56%20am.png" height="175"/>
+<img src="http://f.cl.ly/items/0c27341m2l1E230B0q1l/Image%202014-04-15%20at%2012.40.42%20am.png" height="175"/>
+<img src="http://f.cl.ly/items/0Y2O0P0j012s3C3t3a3E/Image%202014-04-15%20at%2012.39.19%20am.png" height="175"/>
+<img src="http://f.cl.ly/items/2R1f2m350W46423c220D/Image%202014-04-15%20at%2012.32.41%20am.png" height="175"/>
 
 Background
 -----------
@@ -53,7 +54,7 @@ Features
   - SMS ([using Twilio](https://www.twilio.com))
   - [PagerDuty](http://www.pagerduty.com) (SMS, Phone, Mobile Push Notifications and Email)
 
-Lots more is planned for the future, see [open issues](issues?state=open) or if you don't see the feature you want there add it!
+Lots more is planned for the future, see [open issues](https://github.com/jamesrwhite/minicron/issues?state=open) or if you don't see the feature you want there add it!
 
 Requirements
 -------------
@@ -66,12 +67,13 @@ Requirements
 #### Database
 
 - MySQL
-- Support for PostgreSQL and SQlite is planned in the future
+- SQlite >= 3.6.16
+- Support for PostgreSQL is planned in the future
 
 #### Web Server / Reverse Proxy
 
 If you want to run minicron behind a web server or proxy it needs to support the web socket protocol.
-nginx for example supports web sockets from version 1.3.13 and up. I've included an [example config](sample.nginx.conf) for nginx.
+nginx for example supports web sockets from version 1.3.13 and up. I've included an [example config](https://github.com/jamesrwhite/minicron/blob/master/sample.nginx.conf) for nginx.
 
 #### Browser
 
@@ -92,10 +94,10 @@ but I encourage you to give it a try in a non critical environment and help me t
 
 2. On some distributions you may need to install the ````ruby-dev```` and ````build-essential```` packages
 
-3. To install the latest release (currently 0.4) you can ````gem install minicron````, depending on your ruby setup
+3. To install the latest release (currently 0.5) you can ````gem install minicron````, depending on your ruby setup
    you may need to run this with ````sudo````
 
-4. Set your database configuration options in ````/etc/minicron.toml````, you can use the [default.config.toml](default.config.toml) as a guide on what options are configurable
+4. Set your database configuration options in ````/etc/minicron.toml````, you can use the [default.config.toml](https://github.com/jamesrwhite/minicron/blob/master/default.config.toml) as a guide on what options are configurable
 
 5. Make sure you have created an empty database with the name you set in ````/etc/minicron.toml````
 
@@ -107,7 +109,7 @@ but I encourage you to give it a try in a non critical environment and help me t
   > ````
 
 6. You can then ````minicron db setup```` to create the database schema, alternatively you can use
-   the [schema dump provided](lib/minicron/hub/db/schema.sql)
+   the [schema dump provided](https://github.com/jamesrwhite/minicron/blob/master/lib/minicron/hub/db/schema.sql)
 
 7. Done! See the usage section below for more details on how to use minicron now you have it installed
 
@@ -157,7 +159,7 @@ you can also use the ````stop```` and ````status```` commands to control the ser
 To run the server in debug mode, i.e not as a daemon so you can see its output you can pass the ````--debug````
 option.
 
-See [sample.nginx.conf](sample.nginx.conf) for an example of
+See [sample.nginx.conf](https://github.com/jamesrwhite/minicron/blob/master/sample.nginx.conf) for an example of
 how to run minicron behind a reverse proxy.
 
 #### Connecting to a host via SSH
@@ -165,8 +167,13 @@ how to run minicron behind a reverse proxy.
 To be able to perform CRUD operations on the crontab minicron needs to connect via SSH to the host.
 When you set up a host minicron automatically creates a public/private key pair for you and stores it
 in ````~/.ssh```` on the host the minicron server is being run on using the naming schema ````minicron_host_*HOST_ID*_rsa(.pub)````.
-To be able edit the crontab on a host minicron *needs* to connect to the host as the root user so you will
-need to to copy the public key to the hosts authorized_keys file e.g ````/root/.ssh/authorized_keys```` on
+To be able edit the crontab on a host minicron needs to have permission to edit ````/etc/crontab```` and write and
+execute permissions on the ````/etc```` directory so it can move files there (the crontab). This will most
+likely mean allowing minicron to connect to the host as the root user although you could alter your permissions
+to allow for this not to be the case.
+
+As an example, to setup minicron SSH for the root user on a host copy the public key to the hosts
+authorized_keys file e.g ````/root/.ssh/authorized_keys```` on
 most linux distributions or ````/var/root/.ssh/authorized_keys```` on OSX.
 
 #### Version
@@ -178,15 +185,28 @@ or ````--version```` are passed to the CLI.
 
 Some configuration options can be passed in manually but the recommend way to configure minicron is through the use
 of a config file. You can specify the path to the file using the ````--config```` global option. The file is expected
-to be in the [toml](https://github.com/mojombo/toml "toml") format. The default options are specified in the
-[default.config.toml](default.config.toml "default.config.toml")
+to be in the [toml](https://github.com/mojombo/toml) format. The default options are specified in the
+[default.config.toml](https://github.com/jamesrwhite/minicron/blob/master/default.config.toml)
 file and minicron will parse a config located in ````/etc/minicron.toml```` if it exists. Options specified via
 the command line will take precedence over those taken from a config file.
 
+Security
+---------
+
+As mentioned previously minicron is still under development and as such is missing some essential features as far as
+security is concerned. For example authentication still needs to be added to the Web UI, API and Faye (the websocket
+server that jobs use to communicate their status updates).
+  
+  > **It is not recommended that you allow your minicron host to be accessible via the public internet!**
+  
+Obviously without authentication anyone who knew the address of your minicron host would be able to set up
+a potentialyl malicious job on one of your servers! Future versions may be secure enough to expose publically but personally I still would not recommend it, minicron is designed to be an internal tool and should be behind a
+firewall that only allows connections from an internal network and/or a VPN.
+
 Documentation
 -------------
 
-minicron uses [Yard](http://yardoc.org/ "Yard") for its code documentation (currently the only *usage* documentation is what you're reading right now), you can either generate it and view
+minicron uses [Yard](http://yardoc.org/) for its code documentation (currently the only *usage* documentation is what you're reading right now), you can either generate it and view
 it locally using the following commands:
 
 ````bash
@@ -194,13 +214,14 @@ yard doc
 yard server
 ````
 
-or view the most up to date version online at [RubyDoc.info](http://rdoc.info/github/jamesrwhite/minicron/master/frames "RubyDoc.info").
+or view the most up to date version online at [RubyDoc.info](http://rdoc.info/github/jamesrwhite/minicron/master/frames).
 
 Versioning
 -----------
 
-All stable releases will follow the [semantic versioning](http://semver.org/) guidelines. Until 1.0 hits I will try to document any
-major breaking changes in the release descriptions.
+All stable releases will follow the [semantic versioning](http://semver.org/) guidelines. Until 1.0 hits I will try
+to document any breaking changes in the release descriptions but you should proceed with caution before relying
+on anything etc etc
 
 Releases will be numbered with the following format:
 
@@ -215,19 +236,18 @@ Based on the following guidelines:
 Contributing
 ------------
 
-Feedback and pull requests are welcome, please see [CONTRIBUTING.md](CONTRIBUTING.md "CONTRIBUTING.md") for more info.
+Feedback and pull requests are welcome, please see [CONTRIBUTING.md](https://github.com/jamesrwhite/minicron/blob/master/CONTRIBUTING.md) for more info.
 
 Areas that I would love some help with:
 
-- Any of the unassigned [issues here](issues?state=open).
+- Any of the unassigned [issues here](https://github.com/jamesrwhite/minicron/issues?state=open).
 - General testing of the system, let me know what you think and create issues for any bugs you find!
 - Tests!!
 - Validation and error handling improvements
-- Documentation improvements. If you find something confusing or unexpected let me know and I'll add or improve
-  documentation for it!
-- Look for '[TODO:](search?q=TODO%3A)' notices littered around the code,
+- Documentation improvements.
+- Look for '[TODO:](https://github.com/jamesrwhite/minicron/search?q=TODO%3A)' notices littered around the code,
   I'm trying to convert them all to issues but there are a lot..
-- Code refactoring, I had a reasonably tight deadline to have the main concept done by so some parts are a bit rushed
+- Code refactoring, I had a deadline to meet for the initial versions so some parts are a tad rushed
 - UI improvements
 
 Support
@@ -243,4 +263,4 @@ Or feel free to open an issue and I'll do my best to help.
 License
 --------
 
-minicron is licensed under the GPL v3, [see here for the full license](LICENSE "see here")
+minicron is licensed under the GPL v3, [see here for the full license](https://github.com/jamesrwhite/minicron/blob/master/LICENSE)

data/lib/minicron.rb

@@ -26,11 +26,7 @@ module Minicron
       'debug' => false
     },
     'database' => {
-      'type' => 'mysql',
-      'host' => '127.0.0.1',
-      'database' => 'minicron',
-      'username' => 'minicron',
-      'password' => 'password'
+      'type' => 'sqlite'
     },
     'cli' => {
       'mode' => 'line',

data/lib/minicron/cli/commands.rb

@@ -162,7 +162,6 @@ module Minicron
                 yield output[:output] unless output[:type] == :status
               end
             rescue Exception => e
-              p e
               # Send the exception message to the server and yield it
               unless Minicron.config['cli']['dry_run']
                 faye.send(:job_id => ids[:job_id], :execution_id => ids[:execution_id], :type => :output, :message => e.message)

data/lib/minicron/constants.rb

@@ -1,6 +1,6 @@
 # The minicron module
 module Minicron
-  VERSION = '0.4'
+  VERSION = '0.5'
   DEFAULT_CONFIG_FILE = '/etc/minicron.toml'
   BASE_PATH = File.expand_path('../../../', __FILE__)
   LIB_PATH = File.expand_path('../../', __FILE__)

data/lib/minicron/hub/app.rb

@@ -27,6 +27,9 @@ module Minicron::Hub
       # Used to enable asset compression, currently nothing else
       # relies on this
       set :environment, :production
+
+      # Force the encoding to be UTF-8 to prevent assetpack encoding issues
+      Encoding.default_external = Encoding::UTF_8
     end
 
     # Configure how we server assets
@@ -96,7 +99,10 @@ module Minicron::Hub
             :database => Minicron.config['database']['database'],
             :username => Minicron.config['database']['username'],
             :password => Minicron.config['database']['password']
-
+      when 'sqlite'
+        set :database,
+            :adapter => 'sqlite3',
+            :database => Minicron::HUB_PATH + '/db/minicron.sqlite3' # TODO: Allow configuring this but default to this value
       else
         fail Exception, "The database #{Minicron.config['database']['type']} is not supported"
       end

data/lib/minicron/hub/db/schema.rb

@@ -21,7 +21,7 @@ ActiveRecord::Schema.define(version: 0) do
     t.datetime "sent_at",                             null: false
   end
 
-  add_index "alerts", ["execution_id"], name: "execution_id", using: :btree
+  add_index "alerts", ["execution_id"], name: "alerts_execution_id", using: :btree
   add_index "alerts", ["expected_at"], name: "expected_at", using: :btree
   add_index "alerts", ["kind"], name: "kind", using: :btree
   add_index "alerts", ["medium"], name: "medium", using: :btree
@@ -35,9 +35,9 @@ ActiveRecord::Schema.define(version: 0) do
     t.integer  "exit_status"
   end
 
-  add_index "executions", ["created_at"], name: "created_at", using: :btree
+  add_index "executions", ["created_at"], name: "executions_created_at", using: :btree
   add_index "executions", ["finished_at"], name: "finished_at", using: :btree
-  add_index "executions", ["job_id"], name: "job_id", using: :btree
+  add_index "executions", ["job_id"], name: "executions_job_id", using: :btree
   add_index "executions", ["started_at"], name: "started_at", using: :btree
 
   create_table "hosts", force: true do |t|
@@ -60,7 +60,7 @@ ActiveRecord::Schema.define(version: 0) do
     t.datetime "timestamp",    null: false
   end
 
-  add_index "job_execution_outputs", ["execution_id"], name: "execution_id", using: :btree
+  add_index "job_execution_outputs", ["execution_id"], name: "job_execution_outputs_execution_id", using: :btree
   add_index "job_execution_outputs", ["seq"], name: "seq", using: :btree
 
   create_table "jobs", force: true do |t|
@@ -73,7 +73,7 @@ ActiveRecord::Schema.define(version: 0) do
     t.datetime "updated_at",                         null: false
   end
 
-  add_index "jobs", ["created_at"], name: "created_at", using: :btree
+  add_index "jobs", ["created_at"], name: "jobs_created_at", using: :btree
   add_index "jobs", ["host_id"], name: "host_id", using: :btree
   add_index "jobs", ["job_hash"], name: "job_hash", unique: true, using: :btree
 
@@ -92,7 +92,7 @@ ActiveRecord::Schema.define(version: 0) do
   add_index "schedules", ["day_of_the_month"], name: "day_of_the_month", using: :btree
   add_index "schedules", ["day_of_the_week"], name: "day_of_the_week", using: :btree
   add_index "schedules", ["hour"], name: "hour", using: :btree
-  add_index "schedules", ["job_id"], name: "job_id", using: :btree
+  add_index "schedules", ["job_id"], name: "schedules_job_id", using: :btree
   add_index "schedules", ["minute"], name: "minute", using: :btree
   add_index "schedules", ["month"], name: "month", using: :btree
   add_index "schedules", ["special"], name: "special", using: :btree

data/lib/minicron/monitor.rb

@@ -25,6 +25,11 @@ module Minicron
           :username => Minicron.config['database']['username'],
           :password => Minicron.config['database']['password']
         )
+      when 'sqlite'
+       ActiveRecord::Base.establish_connection(
+          :adapter => 'sqlite3',
+          :database => Minicron::HUB_PATH + '/db/minicron.sqlite3' # TODO: Allow configuring this but default to this value
+        )
       else
         fail Exception, "The database #{Minicron.config['database']['type']} is not supported"
       end
@@ -41,6 +46,10 @@ module Minicron
       # Set the start time of the monitir
       @start_time = Time.now
 
+      # Kill the thread when exceptions arne't caught so we can see the message
+      # TODO: should this be removed?
+      Thread.abort_on_exception = true
+
       # Start a thread for the monitor
       @thread = Thread.new do
         # While the monitor is active run it in a loop ~every minute

data/spec/minicron_spec.rb

@@ -80,11 +80,7 @@ describe Minicron do
             'debug' => false
           },
           'database' => {
-            'type' => 'mysql',
-            'host' => '127.0.0.1',
-            'database' => 'minicron',
-            'username' => 'minicron',
-            'password' => 'password'
+            'type' => 'sqlite'
           },
           'cli' => {
             'mode' => 'line',

data/spec/valid_config.toml

@@ -22,11 +22,12 @@ debug = false
 
 # Database options
 [database]
-type = "mysql" # [mysql]
-host = "127.0.0.1"
-database = "minicron"
-username = "minicron"
-password = "password"
+type = "sqlite" # [mysql, sqlite]
+# The options below are for mysql only
+# host = "127.0.0.1"
+# database = "minicron"
+# username = "minicron"
+# password = "password"
 
 # CLI options
 [cli]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minicron
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.5'
 platform: ruby
 authors:
 - James White
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-14 00:00:00.000000000 Z
+date: 2014-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -388,6 +388,26 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.8
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -527,6 +547,7 @@ files:
 - lib/minicron/hub/controllers/api/jobs.rb
 - lib/minicron/hub/controllers/api/schedule.rb
 - lib/minicron/hub/controllers/index.rb
+- lib/minicron/hub/db/minicron.sqlite3
 - lib/minicron/hub/db/schema.rb
 - lib/minicron/hub/db/schema.sql
 - lib/minicron/hub/models/alert.rb