jobly 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ad67b7e96a1ee27e3034c812d05026f922b72585d70d0c8085f9173f8e70d04
-  data.tar.gz: 9614bb05c9da5bf17a9e2d25e3aafdd859bf811828f71c6a511557dc926985ae
+  metadata.gz: efd28d722eeb4dc40024eda54bcc5f302a61db6a0036ce836435aeeafb6402e0
+  data.tar.gz: 949714c32284267a829dd32be6277739e3fb097a4343cbcecd3aa6805a03065f
 SHA512:
-  metadata.gz: c891c3bbff7c1c37180fdc186b22f63a50730f978125546e48a2231ebeab630bb27312016c3d47fa39afcc48dd79bb0e59bb96c1abafebbc16804f77eec8da42
-  data.tar.gz: f021ecf23d579f53fc713b4657ca2613b429da6e7ff2e503e21bf9edb3d4b9f18bf48362349deafd0e1fab36324d51f029ea2d4e9f8dc5d38b43912ce63dce42
+  metadata.gz: e7438be9408c00d912ea9ebf1f80cbb38e74463c37a87da2b2e85c491dec526450e8d22f15f8a65e6ee45a1daf98df2f7955a5bcd59068102b5f38b4c976727f
+  data.tar.gz: 852d6c6a6b0d3f224856a5c027f83d417bc9431edb766dc80ae653afd4d5eecba4cf6e0e3c71b720382fe5ffe98a42fbb3203802bb1a4989bfd11d8202215bbb

data/README.md

@@ -1,12 +1,17 @@
+<div align='center'>
+
+<img src='/assets/logo.svg' width=300>
+
 Jobly
 ==================================================
 
+Compact job server with API, CLI, Web UI and a Sidekiq heart.
+
 [![Gem Version](https://badge.fury.io/rb/jobly.svg)](https://badge.fury.io/rb/jobly)
 [![Build Status](https://travis-ci.com/DannyBen/jobly.svg?branch=master)](https://travis-ci.com/DannyBen/jobly)
+[![Maintainability](https://api.codeclimate.com/v1/badges/b3932ebd153d831583e2/maintainability)](https://codeclimate.com/github/DannyBen/jobly/maintainability)
 
----
-
-Job server toolbelt with API, CLI, Web UI and a Sidekiq heart.
+</div>
 
 ---
 
@@ -16,6 +21,7 @@ Installation
     $ gem install jobly
 
 
+
 What's in the Box
 --------------------------------------------------
 
@@ -27,15 +33,19 @@ sidekiq backgronud jobs system. It includes the following components:
 - **Web API** - for executing jobs.
 - **Web Dashboard** - including job progress and status.
 
-Getting Started
+
+
+Quick Start
 --------------------------------------------------
 
-TODO
+Follow one of these annotated [examples](/examples).
+
 
 
 Usage
 --------------------------------------------------
 
+
 ### Server
 
 To start the server run `jobly server` and open <http://localhost:3000/> 
@@ -44,7 +54,7 @@ in your browser.
 This will start a webserver with two primary entrypoints:
 
 - `/` (root) - a dashboard for your background job processes.
-- `/do/:job?param=value` - an API for executing jobs
+- `/do/JobName?param=value` - an API for executing jobs
 
 
 ### Worker
@@ -59,18 +69,43 @@ There are three ways to run a job from the command line:
 Run the job locally, without going through any of the background job 
 processing chain:
 
-```ruby    
-jobly run JobName param:value
-```
+    $ jobly run JobName param:value
+
 
 Run the job locally, but wait for a worker to process it.
 
-```ruby
-jobly run --later JobName param:value
-```
+    $ jobly run --later JobName param:value
+
 
 Send a job through the API (either localhost or remote).
 
-```ruby
-jobly send JobName param:value
+    $ jobly send JobName param:value
+
+
+### Running jobs through the API
+
+The API supports running jobs either by GET or by POST in the following URL
+structure:
+
+<http://localhost:3000/do/JobName>
+
+Using GET:
+
+```
+$ curl localhost:3000/do/Build?deploy=no
+# => {"status":"received","job":"Build","params":{"deploy":"no"}}
+```
+
+Using POST:
+
+```
+$ curl -XPOST localhost:3000/do/Build -d deploy=yes
+{"status":"received","job":"Build","params":{"deploy":"yes"}}
 ```
+
+
+Building Jobs
+--------------------------------------------------
+
+TODO
+

data/lib/jobly/commands/config.rb

@@ -8,7 +8,7 @@ module Jobly
       usage "jobly config (-h|--help)"
 
       def run
-        line "custom config file", short_config_path, Jobly.custom_config?
+        line "custom config file", short_config_path, !Jobly.custom_config?
         Jobly.options.each do |key, value|
           if key.to_s.end_with? '_path'
             line key, value, !Dir.exist?(value)

data/lib/jobly/commands/run.rb

@@ -20,7 +20,7 @@ module Jobly
         job_class = Jobs.get_class! job
 
         if args['--later']
-          say "!txtgrn!Scheduling"
+          say "Scheduling !txtgrn!#{job_class}"
           if params.empty?
             job_class.perform_async
           else
@@ -28,7 +28,7 @@ module Jobly
           end
         
         else
-          say "!txtgrn!Running"
+          say "Running !txtgrn!#{job_class}"
           job_class.new.perform params
         end
       end

data/lib/jobly/jobs.rb

@@ -1,11 +1,11 @@
 module Jobly
   module Jobs
     def self.get_class(job)
-      Object.const_get namespaced_job(job) rescue nil
+      Object.const_get full_job_name(job) rescue nil
     end
 
     def self.get_class!(job)
-      Object.const_get namespaced_job(job)
+      Object.const_get full_job_name(job)
     rescue NameError
       raise JobNotFound, job
     end
@@ -15,7 +15,8 @@ module Jobly
       Dir["#{Jobly.full_jobs_path}/**/*.rb"].each { |file| require file }
     end
 
-    def self.namespaced_job(job)
+    def self.full_job_name(job)
+      job = job.gsub '/', '::'
       if Jobly.jobs_namespace
         "#{Jobly.jobs_namespace}::#{job}"
       else

data/lib/jobly/server.rb

@@ -29,13 +29,15 @@ module Jobly
       }.to_json
     end
 
-    get '/:job' do
-      job = params.delete :job
+    get '/*' do
+      job = params[:splat].first
+      params.delete :splat
       add_job job, params
     end
 
-    post '/:job' do
-      job = params.delete :job
+    post '/*' do
+      job = params[:splat].first
+      params.delete :splat
       add_job job, params
     end
 

data/lib/jobly/version.rb

@@ -1,3 +1,3 @@
 module Jobly
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jobly
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-08 00:00:00.000000000 Z
+date: 2019-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mister_bin
@@ -204,7 +204,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="