Sha256: 1b28dd5338f23277b4c6807c304214b3cb5fa757092e1580e0430b5d5cefafef

Contents?: true

Size: 1.44 KB

Versions: 11

Compression:

Stored size: 1.44 KB

Contents

#+TITLE: fuselage
#+SUBTITLE: Simplifying Concourse Resources in Ruby
#+LATEX: \pagebreak

* Overview

~fuselage~ simplifies development of resources for Concourse by providing
classes for standard resource steps, interface contracts between Concourse and
your resource, and clear errors for most failure conditions.

* Implementing a Resource

#+BEGIN_SRC ruby
  require 'concourse-fuselage'
#+END_SRC

Inherit from the appropriate class and implement the required methods.

** ~Fuselage::Check~

~Check~ is used to poll for new versions.

*** ~#latest~

Should return a ~Hash~ that describes the latest version. This will be called
when no prior version has been detected.

*** ~#since(version)~

Will be passed a ~Hash~ in the form ~Out#version~ returns.

Should return an ~Array~ of ~Hashes~, similar to what ~#latest~ would return.

** ~Fuselage::In~

~In~ is called for the ~get~ step of a resource.

*** ~#fetch!~

Fetch ~#version~ place it in ~#workdir~.

Should fail if ~#version~ is unavailable.

** ~Fuselage::Out~

~Out~ is called for the ~put~ step of a resource.

*** ~#update!~

Update the resource. All outputs from prior steps are available in ~#workdir~.

*** ~#version~

Should return a ~Hash~ that describes the resulting version.

* License

Apache 2.0 License, see ~LICENSE.txt~ for details.

* Contributors

- [[https://colstrom.github.io/][Chris Olstrom]] | [[mailto:chris@olstrom.com][e-mail]] | [[https://twitter.com/ChrisOlstrom][Twitter]]
  

Version data entries

11 entries across 11 versions & 1 rubygems

Version Path
concourse-fuselage-0.5.2 README.org
concourse-fuselage-0.5.1 README.org
concourse-fuselage-0.5.0 README.org
concourse-fuselage-0.4.1 README.org
concourse-fuselage-0.4.0 README.org
concourse-fuselage-0.3.2 README.org
concourse-fuselage-0.3.1 README.org
concourse-fuselage-0.3.0 README.org
concourse-fuselage-0.2.0 README.org
concourse-fuselage-0.1.1 README.org
concourse-fuselage-0.1.0 README.org