ruby_fly 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55f06ac3ecbfb72364c48953f73b46619d1937ee
-  data.tar.gz: e266ff7f151957e273f9b804cf88c30e459a1c46
+  metadata.gz: a8ea251b06d2d70cb0127363df0ca4a50bebcadd
+  data.tar.gz: 8e97b3aef74ed646434768292218191134067824
 SHA512:
-  metadata.gz: 0e215a82abc9987016c0e1403f7777d85042b6a3795a13c0a422407b5a31e657d9b524d503acae16a36296bd10e37a6bf19aebf59b01918cbae2ab675d7523b6
-  data.tar.gz: 2082b22b3d3caf662ad2d80cfc579829ae4b40b7b96401935af03b96847554c2a9e308289241c44c7559291c9fd0db350d65802633b460cce7afa178ac7695ab
+  metadata.gz: 94d53292baaf092f5efa3c049c8f00d2051f5605086d6885d68c129822b111f0ea323cf36813b72fbab7519beefd0a63aea29b0a5bd6b2a1f4df070e6d053be8
+  data.tar.gz: b8f3c7961612ceafe8e60fcda48df6513898dcd6ba55ebba7a31159595870f5394e94e5ea51b61b2ce82bb3972aa08bf8a39d8a8d8521703019d1b7732a3ce56

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby_fly (0.4.0)
+    ruby_fly (0.4.1)
       lino (~> 1.1)
 
 GEM

data/README.md

@@ -21,7 +21,108 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Binary Location
+
+RubyFly needs to know where the fly binary is located before it can do anything.
+By default, RubyFly looks on the path however this can be configured with:
+
+```ruby
+RubyFly.configure do |config|
+  config.binary = 'vendor/fly/bin/fly'
+end
+```
+
+In addition, each command takes a `binary` keyword argument at initialisation
+that overrides the global configuration value.
+
+### Login
+
+Currently the library doesn't support logging in to a Concourse instance so if
+the target instance requires authentication, a session must be manually 
+established before any commands are executed. If there are recommendations for
+a good approach to automatic login, please raise an issue or a pull request.
+
+### Commands
+
+Currently, there is partial support for the following commands:
+* `RubyFly::Commands::GetPipeline`: fetches the current configuration of a 
+  pipeline from a target Concourse (`fly get-pipeline`)
+* `RubyFly::Commands::SetPipeline`: submits a pipeline configuration to
+  a target Concourse (`fly set-pipeline`)
+* `RubyFly::Commands::UnpausePipeline`: unpauses a pipeline on a target
+  Concourse (`fly unpause-pipeline`)
+* `RubyFly::Commands::Version`: returns the version of the fly binary
+
+#### `RubyFly::Commands::GetPipeline`
+
+The get-pipeline command can be called in the following ways:
+
+```ruby
+RubyFly.get_pipeline(
+    target: 'supercorp-ci', 
+    pipeline: 'supercorp-service')
+RubyFly::Commands::GetPipeline.new.execute(
+    target: 'supercorp-ci',
+    pipeline: 'supercorp-service')
+```
+
+The get-pipeline command supports the following options passed as keyword 
+arguments (as in the example above):
+* `target`: the Concourse instance to target
+* `pipeline`: the pipeline for which to get configuration
+
+#### `RubyFly::Commands::SetPipeline`
+
+The set-pipeline command can be called in the following ways:
+
+```ruby
+RubyFly.set_pipeline(
+    target: 'supercorp-ci', 
+    pipeline: 'supercorp-service',
+    config: 'ci/pipeline.yml')
+RubyFly::Commands::SetPipeline.new.execute(
+    target: 'supercorp-ci',
+    pipeline: 'supercorp-service',
+    config: 'ci/pipeline.yml')
+```
+
+The set-pipeline command supports the following options passed as keyword 
+arguments (as in the example above):
+* `target`: the Concourse instance to target
+* `pipeline`: the pipeline for which to set configuration
+* `config`: the local file containing the pipeline configuration
+* `vars`: an hash of variables to be accessible as interpolations
+* `var_files`: an array of paths to files containing variables to be accessible
+  as interpolations
+* `non_interactive`: if `false`, any missing variables will be prompted for,
+  if `true`, any missing variables will cause the command to fail
+
+#### `RubyFly::Commands::UnpausePipeline`
+
+The unpause-pipeline command can be called in the following ways:
+
+```ruby
+RubyFly.unpause_pipeline(
+    target: 'supercorp-ci', 
+    pipeline: 'supercorp-service')
+RubyFly::Commands::UnpausePipeline.new.execute(
+    target: 'supercorp-ci',
+    pipeline: 'supercorp-service')
+```
+
+The get-pipeline command supports the following options passed as keyword 
+arguments (as in the example above):
+* `target`: the Concourse instance to target
+* `pipeline`: the pipeline to unpause
+
+#### `RubyFly::Commands::Version`
+
+The version command can be called in the following ways:
+
+```ruby
+version = RubyFly.version
+version = RubyFly::Commands::Version.new.execute
+```
 
 ## Development
 

data/lib/ruby_fly.rb

@@ -29,7 +29,7 @@ module RubyFly
     end
 
     def version
-      Commands::Version.new.execute()
+      Commands::Version.new.execute
     end
   end
   extend ClassMethods

data/lib/ruby_fly/version.rb

@@ -1,3 +1,3 @@
 module RubyFly
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_fly
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Toby Clemson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-20 00:00:00.000000000 Z
+date: 2017-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lino