regiment 0.0.4 → 0.0.6

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTQ3MmQ2MmNkZmJmNmNmMWIxMTdmN2JhNjE2MTE4ZDdlODU5ZWViOQ==
+    NTE1MGVlMjg5ZmJiMjVhZTdhOTBkNTFiZjIwYjU0OTIyODZkNGUzZg==
   data.tar.gz: !binary |-
-    ZGFiYTNkZjY5MDk0MmE5OGU3MDkzOTMzZGEzMjJkMTk1ZTU3MGRhMg==
+    ZGJiNjc1MDgxNjI4YjRjMGUyMGY1N2RlYzNhMmI5NDMxZWU1MzljYg==
 SHA512:
   metadata.gz: !binary |-
-    N2VkYzhmOTVhYjI0Y2E2MGJkOTQ4MGRjMjUxMTA0YzI2YmVhNjE4NDZjNjBh
-    YjE5NTkyNWE3YjVhNjY4YTM1ZTk0OWMxYjc0MTRiZmQ2M2Y1NTY3Y2IxZTk4
-    NmY0ZTM4ZDBhNmQ2MTNjNWRmZTVjZThmNDU5MmI0ZjVmMzdmYzU=
+    Y2YwYzIyNTkxOGI5YTQ2ZmE1ODNiMmUzNzUxOWYzYzA0NmNkZDRkZmNhOTgy
+    NmQ1ZmU2ZDhjOTZlOWZmMDYyMjBjMDJlZTUxMmI2MTY1N2QwNzkxNjFhMWEx
+    NzE0M2I0MzYxMTZiNDBhNmQ3NzdkYmQ1MjM4YTJlODBjM2I4M2Y=
   data.tar.gz: !binary |-
-    YTlkMzVhNzg4ZjcxYzY3ZjNjMjNiOGNhMDk0ZDI1Y2FkNjgxZjliNmZjNDc2
-    Mzk1YjllZDcxZmVmMGI3OWFhOWRiMTI3ZWVkZDQ4NjFhNDhlM2I2YTZlNWMx
-    MWU1OGE1ZDA1MWI4MTIyNTA4MjQ4MGM0ZjA2Yjk2ZjQzMzYwNTY=
+    MGZkNzQ4Zjk2OTYxYjliM2FjMjgyMGRjMzAzYjVkMzM5ZjE4OTM4NWFiZTEw
+    YTM1Y2RiZjEyNjkwODBjMDliZWJhYmEwMzY0OTMwM2M2MjI4NzNhYjdlOTZm
+    NDgwZTBmOTVjMzNlZWE1ODE0MzUxYmNhYzc2ZmNkMTBkYjgxNzA=

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.md

@@ -1,13 +1,37 @@
 # Regiment
 A simple, self-contained, RESTful script/job management framework in Ruby.
 
+## Script Library ##
+
+The vision for Regiment is a world where one-off, un-monitored, snowflake scripts are a thing of the past. As such, Regiment implements a standard structure for scripts(orders) and how we store them:
+
+- All orders must inherit from the Regiment::Order class and should override the `Regiment::Order.execute` function.
+- All orders must inhabit a similarly named directory with a README.
+- Any custom output(report) format should be defined by overriding the `Regiment::Order.report` function.
+
+The directory structure for your orders library should look like this:
+
+```
+/etc/regiment/orders
+|- scriptOne/
+|-- scriptOne.rb
+|-- README
+|- scriptTwo/
+|-- scriptTwo.rb
+|-- README
+```
+
 ## API ##
 
 Regiment implements an API through which you can trigger scripts(orders), view which orders are in progress and various other useful actions. The API can be started with the command `regiment-api`.
 
 ### Endpoints ###
 
-`/version` - This returns the version of Regiment you have running.
+`GET /version` - This returns the version of Regiment you have running.
+
+`GET /execute/<order>` - Executes the specified order and reports back.
+
+`GET /about/<order>` - Displays the README for the specified order. 
 
 ## CLI ##
 
@@ -17,6 +41,10 @@ Regiment comes with a tool `regiment` that implements the interface of the API o
 
 `version` - Returns the version of Regiment used by the client and the version used by the endpoint.
 
+`execute <order>` - Executes the specified order and reports back.
+
+`about <order>` - Displays the README for the specified order.
+
 ### Options ###
 
 `--regiment` - String - The hostname(including port) of your Regiment endpoint e.g. `localhost:1234`

data/bin/regiment

@@ -5,7 +5,7 @@ require 'thor'
 
 class RegimentCLI < Thor
   desc 'version', 'Get version of regiment client and endpoint'
-  option :regiment
+  class_option :regiment
   
   def version
     client_verison = Regiment::Service::VERSION
@@ -15,6 +15,29 @@ class RegimentCLI < Thor
     
     puts "Client: #{client_verison}, Endpoint: #{endpoint_verison}"
   end
+
+  desc 'execute', 'Execute an order'
+  def execute(order)
+    client = Regiment::Client.new(options[:regiment])
+    puts client.execute(order)
+  end
+
+  desc 'about', 'Returns the README for an order. It should hopefully describe how and when it should be used.'
+  def about(order)
+    client = Regiment::Client.new(options[:regiment])
+    puts client.about(order)
+  end
+
+  desc 'create', 'Creates new script directory at the desired path'
+  def create(name ,path)
+    Dir.mkdir "#{path}/#{name}"
+    readme = File.new("#{path}/#{name}/README", 'w+')
+    order =  File.new("#{path}/#{name}/#{name}.rb", 'w+')
+
+    readme.write("TODO: The README for #{name}.")
+    order.write("require 'regiment/order'\n\nclass #{name} < Regiment::Order\n\s\sdef initialize\n\s\s\s\ssuper\n\s\send\n\n\s\sdef execute\n\s\s\s\s# TODO: #{name} script\n\s\send\nend\n")
+  end
+
 end
 
 RegimentCLI.start(ARGV)

data/bin/regiment-api

@@ -5,11 +5,17 @@ require 'json'
 
 class RegimentAPI < Sinatra::Base
   
+  configure do
+    set :bind, '0.0.0.0'
+    set :port, '8585'
+  end
+
   helpers do
     def api 
       @api = Regiment::API.new
     end
   end
+
   #use Rack::Auth::Basic, "Regiment Auth" do |username, password|
   #  credentials = JOSN.parse(File.new("/etc/regiment/access.json"))
   #  username == credentials[:username] and password == credentials[:password]
@@ -19,6 +25,14 @@ class RegimentAPI < Sinatra::Base
     return api.version 
   end
 
+  get "/execute/:order" do
+    return api.execute(params[:order])
+  end
+
+  get "/about/:order" do
+    return api.about(params[:order])
+  end
+
 end
 
 RegimentAPI.run!

data/conf/regiment.json

@@ -0,0 +1,13 @@
+{
+  "endpoint": {
+    "host" : "localhost",
+    "port" : 8585
+  },
+  "library": {
+    "directory": "/etc/regiment/orders"
+  },
+  "auth": {
+    "username": "user",
+    "token": "p8NTuv0q97Yb0vQ497"
+  }
+}

data/lib/regiment/api.rb

@@ -1,13 +1,39 @@
 require 'regiment/service/version'
+require 'pathname'
 
 module Regiment
-  class API 
+  class API
+     
+    ORDER_PATH = "/etc/regiment/orders/"
+
     def initialize
-    
     end
 
     def version
       return Regiment::Service::VERSION
     end
+
+    def execute(order, options={})
+      path = Pathname.new(ORDER_PATH).join(Pathname.new("#{order}/#{order}.rb")).to_s
+      
+      # Classes have caps yo!
+      order[0] = order[0].capitalize
+
+      # Load our order, instantiate it and call do_execute
+      Kernel.load(path)
+      o = Object.const_get(order.to_sym).new
+
+      return o.do_execute
+    end
+
+    def about(order, options={})
+      begin
+        info = File.new(Pathname.new(ORDER_PATH).join(Pathname.new("#{order}/README")).to_s)
+      rescue IOError => e
+        return e
+      end
+      return info
+    end
+
   end
 end

data/lib/regiment/client.rb

@@ -17,5 +17,14 @@ module Regiment
     def version
       return RestClient.get(build_uri("/version"))
     end
+   
+    def execute(order, options={})
+      return RestClient.get(build_uri("/execute/#{order}"))
+    end
+
+    def about(order, options={})
+      return RestClient.get(build_uri("/about/#{order}"))
+    end
+
   end
 end

data/lib/regiment/order.rb

@@ -1,8 +1,32 @@
+# Regiment::Order
+# The super-class of all orders.
+
 module Regiment
   class Order
-  
-    def initialize
+    # Keep track of state
+    @state = :initializing 
+    
+    def initialize(options={})
+    end
+
+    # do_thing methods wrap methods to be overriden in order imlpementation
+    def do_execute(options={})
+      @state = :executing
+      results = execute
+      return do_report(results)
+    end
+
+    def execute(options={})
+    end
+
+    def do_report(result, options={})
+      @state = :reporting
+      @report = result
+      return report(result)
+    end
 
+    def report(result ,options={})
+      return result
     end
   end
 end

data/lib/regiment/service/version.rb

@@ -1,5 +1,5 @@
 module Regiment
   class Service
-    VERSION = '0.0.4'
+    VERSION = '0.0.6'
   end
 end

data/regiment.gemspec

@@ -15,4 +15,7 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split($/)
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]
+  s.add_dependency "sinatra"
 end
+
+

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: regiment
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Josh McGhee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-01 00:00:00.000000000 Z
-dependencies: []
+date: 2015-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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'
 description: ! 'Regiment: A simple RESTful script/job management framework in Ruby.'
 email: joshua@spaceapegames.com
 executables:
@@ -18,11 +32,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - LICENSE
 - README.md
 - Rakefile
 - bin/regiment
 - bin/regiment-api
+- conf/regiment.json
 - lib/regiment/api.rb
 - lib/regiment/client.rb
 - lib/regiment/order.rb