regiment 0.0.3 → 0.0.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MGNhZmJkZjI0YmUwY2ZjNTI3MDQ5NTBmYjc2NGRjNzZlNWJjMWY1NA==
+    MTQ3MmQ2MmNkZmJmNmNmMWIxMTdmN2JhNjE2MTE4ZDdlODU5ZWViOQ==
   data.tar.gz: !binary |-
-    NThmMTIwZDlhZWVlMzlmZmU3NzM1MmQ5OWJlYWNiZTMyNzBjZjliYw==
+    ZGFiYTNkZjY5MDk0MmE5OGU3MDkzOTMzZGEzMjJkMTk1ZTU3MGRhMg==
 SHA512:
   metadata.gz: !binary |-
-    YzM5OTU1ODljZTUyMWExZmFlZDVlNTg3ZjA2NGMyNjVjYWVkY2Q2YzQ0YmZi
-    NjEzY2I2Nzc1ODc4YTMxOTY0ZWZiYTgwZWI1NmEwNTllZGU2MWY4YjczZGNh
-    ZWY2MTU1ODgyYzM3ZTdkZWI2ZmE2MjcyMjU5ZTY5MGVjMTAzYWY=
+    N2VkYzhmOTVhYjI0Y2E2MGJkOTQ4MGRjMjUxMTA0YzI2YmVhNjE4NDZjNjBh
+    YjE5NTkyNWE3YjVhNjY4YTM1ZTk0OWMxYjc0MTRiZmQ2M2Y1NTY3Y2IxZTk4
+    NmY0ZTM4ZDBhNmQ2MTNjNWRmZTVjZThmNDU5MmI0ZjVmMzdmYzU=
   data.tar.gz: !binary |-
-    MzIxYTZjZmM4NTFiMGQwMTZhZmE2OTJjMGY5OGEzMTg5YThmNWU2MzJkMDNk
-    ZTE1ZjIwNThkNzM1ODVhZDA3ZTg1NjU4ZTE1ZDk1MTVhYzFiNDgxMjIzOTVh
-    MWZkZmVkNTQxMDU4ZWEzNjA2NDg0MTJlMWM3ZTRmNWViMzU5MjY=
+    YTlkMzVhNzg4ZjcxYzY3ZjNjMjNiOGNhMDk0ZDI1Y2FkNjgxZjliNmZjNDc2
+    Mzk1YjllZDcxZmVmMGI3OWFhOWRiMTI3ZWVkZDQ4NjFhNDhlM2I2YTZlNWMx
+    MWU1OGE1ZDA1MWI4MTIyNTA4MjQ4MGM0ZjA2Yjk2ZjQzMzYwNTY=

data/README.md

@@ -1,8 +1,30 @@
-# regiment
-A simple RESTful script/job management framework in Ruby.
+# Regiment
+A simple, self-contained, RESTful script/job management framework in Ruby.
 
 ## 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.
+
+## CLI ##
+
+Regiment comes with a tool `regiment` that implements the interface of the API on your command line to squeeze yet more efficiency out of your workflow.
+
+### Sub Commands ###
+
+`version` - Returns the version of Regiment used by the client and the version used by the endpoint.
+
+### Options ###
+
+`--regiment` - String - The hostname(including port) of your Regiment endpoint e.g. `localhost:1234`
+
+## Contributing ##
+
+### Rake ###
+
+To build and install the gem locally during development ensure you are in the root of the repository and run:
+
+`rake buildinstall`

data/bin/regiment

@@ -1,2 +1,20 @@
 #! /usr/bin/env ruby
 require 'regiment/client'
+require 'regiment/service/version'
+require 'thor'
+
+class RegimentCLI < Thor
+  desc 'version', 'Get version of regiment client and endpoint'
+  option :regiment
+  
+  def version
+    client_verison = Regiment::Service::VERSION
+    
+    client = Regiment::Client.new(options[:regiment])
+    endpoint_verison = client.version
+    
+    puts "Client: #{client_verison}, Endpoint: #{endpoint_verison}"
+  end
+end
+
+RegimentCLI.start(ARGV)

data/lib/regiment/api.rb

@@ -1,7 +1,7 @@
 require 'regiment/service/version'
 
 module Regiment
-  class API
+  class API 
     def initialize
     
     end

data/lib/regiment/client.rb

@@ -0,0 +1,21 @@
+require 'regiment/service/version'
+require 'rest-client'
+require 'uri'
+ 
+module Regiment
+  class Client 
+    def initialize(endpoint)
+      combined = endpoint.split(":")
+      @host = combined[0]
+      @port = combined[1].to_i
+    end
+
+    def build_uri(path)
+      return URI::HTTP.build({:host => @host, :port => @port, :path => path}).to_s
+    end
+    
+    def version
+      return RestClient.get(build_uri("/version"))
+    end
+  end
+end

data/lib/regiment/service/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: regiment
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Josh McGhee