concourse-fuselage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 975402edab7f41d684ccf38764222e64c329697f
+  data.tar.gz: b04adc7c4b1fda6d307c4523a3806c0a73cfcec7
+SHA512:
+  metadata.gz: 136fc2d48953ec7ca86e76b26d2de562356f3c2b607fc1d5178bbb13e2710bf6d2900f2544d9fcf98b10e7151c41e5fe11403d7288b33f91d6c32a40158b4a04
+  data.tar.gz: 5e367ca85563d78961de384a4d66dcfaaf5abeb71bf2b0fb11e2b9f31d7d020170fbb818ad94d090c28b0364bd00e30939185cbac186537aa46e3e32c4e08b66

data/.gitignore

@@ -0,0 +1,3 @@
+.bundle/**
+auto/**
+vendor/**

data/Gemfile

@@ -0,0 +1,3 @@
+source ENV.fetch 'RUBYGEMS_MIRROR', 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    concourse-fuselage (0.1.0)
+      contracts (~> 0.13, >= 0.13.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    contracts (0.13.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  concourse-fuselage!
+
+BUNDLED WITH
+   1.11.2

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2016 Chris Olstrom <chris@olstrom.com>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.org

@@ -0,0 +1,63 @@
+#+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]]
+  

data/concourse-fuselage.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |gem|
+  gem.name          = 'concourse-fuselage'
+  gem.version       = '0.1.0'
+  gem.authors       = ['Chris Olstrom']
+  gem.email         = 'chris@olstrom.com'
+  gem.license       = 'MIT'
+  gem.summary       = 'Helpers for Concourse Resources'
+  gem.description   = 'Helper classes and methods for implementing Concourse Resources'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'contracts', '~> 0.13', '>= 0.13.0'
+end

data/lib/concourse-fuselage/check.rb

@@ -0,0 +1,31 @@
+require 'json'
+require_relative 'step'
+
+module Fuselage
+  class Check < Step
+    Contract None => Maybe[HashOf[String, String]]
+    def version
+      config['version']
+    end
+
+    Contract None => HashOf[String, String]
+    def latest
+      fail NotImplementedError
+    end
+
+    Contract HashOf[String, String] => ArrayOf[HashOf[String, String]]
+    def since(version)
+      fail NotImplementedError
+    end
+
+    Contract None => ArrayOf[HashOf[String, String]]
+    def output
+      version.nil? ? [latest] : since(version)
+    end
+
+    Contract None => String
+    def run
+      JSON.dump output
+    end
+  end
+end

data/lib/concourse-fuselage/in.rb

@@ -0,0 +1,41 @@
+require 'json'
+require_relative 'step'
+require_relative 'support/build_metadata'
+require_relative 'support/params'
+require_relative 'support/work_dir'
+
+module Fuselage
+  class In < Step
+    include Support::BuildMetadata
+    include Support::Params
+    include Support::WorkDir
+
+    Contract None => HashOf[String, String]
+    def version
+      @version ||= config.fetch 'version'
+    rescue KeyError
+      STDERR.puts 'Configuration payload is missing version'
+    end
+
+    Contract None => ArrayOf[Maybe[HashOf[String, String]]]
+    def metadata
+      []
+    end
+
+    Contract None => String
+    def output
+      JSON.dump version: version, metadata: metadata
+    end
+
+    Contract None => Any
+    def fetch!
+      fail NotImplementedError
+    end
+
+    Contract None => String
+    def run
+      fetch!
+      output
+    end
+  end
+end

data/lib/concourse-fuselage/out.rb

@@ -0,0 +1,39 @@
+require 'json'
+require_relative 'step'
+require_relative 'support/build_metadata'
+require_relative 'support/params'
+require_relative 'support/work_dir'
+
+module Fuselage
+  class Out < Step
+    include Support::BuildMetadata
+    include Support::Params
+    include Support::WorkDir
+
+    Contract None => HashOf[String, String]
+    def version
+      fail NotImplementedError
+    end
+
+    Contract None => ArrayOf[Maybe[HashOf[String, String]]]
+    def metadata
+      []
+    end
+
+    Contract None => String
+    def output
+      JSON.dump version: version, metadata: metadata
+    end
+
+    Contract None => Any
+    def update!
+      fail NotImplementedError
+    end
+
+    Contract None => String
+    def run
+      update!
+      output
+    end
+  end
+end

data/lib/concourse-fuselage/step.rb

@@ -0,0 +1,10 @@
+require 'contracts'
+require_relative 'support/source'
+
+module Fuselage
+  class Step
+    include ::Contracts::Core
+    include ::Contracts::Builtin
+    include Support::Source
+  end
+end

data/lib/concourse-fuselage/support/build_metadata.rb

@@ -0,0 +1,50 @@
+require 'contracts'
+
+module Fuselage
+  module Support
+    module BuildMetadata
+      include ::Contracts::Core
+      include ::Contracts::Builtin
+
+      Contract None => Maybe[String]
+      def build_id
+        ENV.fetch 'BUILD_ID'
+      rescue KeyError
+        STDERR.puts 'Environment is missing BUILD_ID'
+        abort
+      end
+
+      Contract None => Maybe[String]
+      def build_name
+        ENV.fetch 'BUILD_NAME'
+      rescue KeyError
+        STDERR.puts 'Environment is missing BUILD_NAME'
+        abort
+      end
+
+      Contract None => Maybe[String]
+      def build_job_name
+        ENV.fetch 'BUILD_JOB_NAME'
+      rescue KeyError
+        STDERR.puts 'Environment is missing BUILD_JOB_NAME'
+        abort
+      end
+
+      Contract None => Maybe[String]
+      def build_pipeline_name
+        ENV.fetch 'BUILD_PIPELINE_NAME'
+      rescue KeyError
+        STDERR.puts 'Environment is missing BUILD_PIPELINE_NAME'
+        abort
+      end
+
+      Contract None => Maybe[String]
+      def atc_external_url
+        ENV.fetch 'ATC_EXTERNAL_URL'
+      rescue KeyError
+        STDERR.puts 'Environment is missing ATC_EXTERNAL_URL'
+        abort
+      end
+    end
+  end
+end

data/lib/concourse-fuselage/support/config.rb

@@ -0,0 +1,16 @@
+require 'contracts'
+require 'json'
+
+module Fuselage
+  module Support
+    module Config
+      include ::Contracts::Core
+      include ::Contracts::Builtin
+
+      Contract None => Hash
+      def config
+        @config ||= JSON.load STDIN || {}
+      end
+    end
+  end
+end

data/lib/concourse-fuselage/support/params.rb

@@ -0,0 +1,17 @@
+require 'contracts'
+require_relative 'config'
+
+module Fuselage
+  module Support
+    module Params
+      include ::Contracts::Core
+      include ::Contracts::Builtin
+      include Config
+
+      Contract None => Hash
+      def params
+        @params ||= config.fetch 'params', {}
+      end
+    end
+  end
+end

data/lib/concourse-fuselage/support/source.rb

@@ -0,0 +1,17 @@
+require 'contracts'
+require_relative 'config'
+
+module Fuselage
+  module Support
+    module Source
+      include ::Contracts::Core
+      include ::Contracts::Builtin
+      include Config
+
+      Contract None => Hash
+      def source
+        @source ||= config.fetch 'source', {}
+      end
+    end
+  end
+end

data/lib/concourse-fuselage/support/work_dir.rb

@@ -0,0 +1,20 @@
+require 'contracts'
+
+module Fuselage
+  module Support
+    module WorkDir
+      include ::Contracts::Core
+      include ::Contracts::Builtin
+
+      Contract None => String
+      def workdir
+        @workdir ||= ARGV.first.tap do |workdir|
+          fail ArgumentError if workdir.nil?
+        end
+      rescue ArgumentError
+        STDERR.puts 'Working directory missing, expected as first argument'
+        abort
+      end
+    end
+  end
+end

data/lib/concourse-fuselage.rb

@@ -0,0 +1,3 @@
+require_relative 'concourse-fuselage/check'
+require_relative 'concourse-fuselage/in'
+require_relative 'concourse-fuselage/out'

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: concourse-fuselage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Olstrom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: contracts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+description: Helper classes and methods for implementing Concourse Resources
+email: chris@olstrom.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.org
+- concourse-fuselage.gemspec
+- lib/concourse-fuselage.rb
+- lib/concourse-fuselage/check.rb
+- lib/concourse-fuselage/in.rb
+- lib/concourse-fuselage/out.rb
+- lib/concourse-fuselage/step.rb
+- lib/concourse-fuselage/support/build_metadata.rb
+- lib/concourse-fuselage/support/config.rb
+- lib/concourse-fuselage/support/params.rb
+- lib/concourse-fuselage/support/source.rb
+- lib/concourse-fuselage/support/work_dir.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Helpers for Concourse Resources
+test_files: []
+has_rdoc: