omnijack 0.1.0

data/lib/omnijack/metadata.rb

@@ -0,0 +1,244 @@
+# Encoding: UTF-8
+#
+# Author:: Jonathan Hartman (<j@p4nt5.com>)
+#
+# Copyright (C) 2014, Jonathan Hartman
+#
+# 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.
+
+require 'ohai'
+require 'open-uri'
+require_relative 'config'
+require_relative '../omnijack'
+require_relative '../../vendor/chef/lib/chef/exceptions'
+require_relative '../../vendor/chef/lib/chef/mixin/params_validate'
+
+class Omnijack
+  # A class for representing an Omnitruck metadata object
+  #
+  # @author Jonathan Hartman <j@p4nt5.com>
+  class Metadata < Omnijack
+    include ::Chef::Mixin::ParamsValidate
+    include Config
+
+    def initialize(name, args = {})
+      super
+      args.each { |k, v| send(k, v) unless v.nil? } unless args.nil?
+    end
+
+    #
+    # Set up an accessor method for each piece of metadata
+    #
+    METADATA_ATTRIBUTES.each do |a|
+      define_method(a) { to_h[a] }
+    end
+    define_method(:filename) { to_h[:filename] }
+
+    #
+    # Make metadata accessible via hash keys
+    #
+    # @param [Symbol] key
+    # @return [String, NilClass]
+    #
+    def [](key)
+      to_h[key]
+    end
+
+    #
+    # Offer a hash representation of the metadata
+    #
+    # @return [Hash]
+    #
+    def to_h
+      raw_metadata.split("\n").each_with_object({}) do |line, hsh|
+        key = line.split[0].to_sym
+        val = case line.split[1]
+              when 'true' then true
+              when 'false' then false
+              else line.split[1]
+              end
+        hsh[key] = val
+        hsh[:filename] = val.split('/')[-1] if key == :url
+      end
+    end
+
+    #
+    # Use the raw metadata string as a string representation
+    #
+    define_method(:to_s) { raw_metadata }
+
+    #
+    # The version of the project
+    #
+    # @param [String, NilClass] arg
+    # @return [String]
+    #
+    def version(arg = nil)
+      set_or_return(:version,
+                    arg,
+                    kind_of: String,
+                    default: 'latest',
+                    callbacks: {
+                      'Invalid version string' => ->(a) { valid_version?(a) }
+                    })
+    end
+
+    #
+    # Whether to enable prerelease and/or nightly packages
+    #
+    # @param [TrueClass, FalseClass, NilClass] arg
+    # @return [TrueClass, FalseClass]
+    #
+    [:prerelease, :nightlies].each do |m|
+      define_method(m) do |arg = nil|
+        set_or_return(m, arg, kind_of: [TrueClass, FalseClass], default: false)
+      end
+    end
+
+    #
+    # The name of the desired platform
+    #
+    # @param [String, NilClass]
+    # @return [String]
+    #
+    def platform(arg = nil)
+      set_or_return(:platform, arg, kind_of: String, default: node[:platform])
+    end
+
+    #
+    # The version of the desired platform
+    #
+    # @param [String, NilClass] arg
+    # @return [String]
+    #
+    def platform_version(arg = nil)
+      # TODO: The platform version parser living in `node` means passing e.g.
+      # '10.9.2' here won't result in it being shortened to '10.9'
+      set_or_return(:platform_version,
+                    arg,
+                    kind_of: String,
+                    default: node[:platform_version])
+    end
+
+    #
+    # The machine architecture of the desired platform
+    #
+    # @param [String, NilClass]
+    # @return [String]
+    #
+    def machine_arch(arg = nil)
+      set_or_return(:machine_arch,
+                    arg,
+                    kind_of: String,
+                    default: node[:kernel][:machine])
+    end
+
+    private
+
+    #
+    # Fetch the raw metadata from the configured URI
+    #
+    # @return [String]
+    #
+    def raw_metadata
+      @raw_metadata ||= api_url.open.read
+    end
+
+    #
+    # Construct the full API query URL from base + endpoint + params
+    #
+    # @return [URI::HTTP, URI::HTTPS]
+    #
+    def api_url
+      @api_url ||= URI.parse(
+        File.join(base_url, "#{endpoint}?#{URI.encode_www_form(query_params)}")
+      )
+    end
+
+    #
+    # Convert all the metadata attrs into params Omnitruck understands
+    #
+    # @return [Hash]
+    #
+    def query_params
+      { v: version,
+        prerelease: prerelease,
+        nightlies: nightlies,
+        p: platform,
+        pv: platform_version,
+        m: machine_arch }
+    end
+
+    #
+    # Return the API endpoint for the metadata of this project
+    #
+    # @return [String]
+    #
+    def endpoint
+      OMNITRUCK_PROJECTS[name][:endpoints][:metadata]
+    end
+
+    #
+    # Fetch and return node data from Ohai
+    #
+    # @return [Mash]
+    #
+    def node
+      unless @node
+        @node = Ohai::System.new.all_plugins('platform')[0].data
+        case @node[:platform]
+        when 'mac_os_x'
+          @node[:platform_version] = platform_version_mac_os_x
+        when 'windows'
+          @node[:platform_version] = platform_version_windows
+        end
+      end
+      @node
+    end
+
+    #
+    # Apply special logic for the version of an OS X platform
+    #
+    # @return [String]
+    #
+    def platform_version_mac_os_x
+      node[:platform_version].match(/^[0-9]+\.[0-9]+/).to_s
+    end
+
+    #
+    # Apply special logic for the version of a Windows platform
+    #
+    # @return [String]
+    #
+    def platform_version_windows
+      # Make a best guess and assume a server OS
+      # See: http://msdn.microsoft.com/en-us/library/windows/
+      #      desktop/ms724832(v=vs.85).aspx
+      {
+        '6.3' => '2012r2', '6.2' => '2012', '6.1' => '2008r2', '6.0' => '2008',
+        '5.2' => '2003r2', '5.1' => 'xp', '5.0' => '2000'
+      }[node[:platform_version].match(/^[0-9]+\.[0-9]+/).to_s]
+    end
+
+    #
+    # Determine whether a string is a valid version string
+    #
+    # @param [String] arg
+    # @return [TrueClass, FalseClass]
+    #
+    def valid_version?(arg)
+      return true if arg == 'latest'
+      arg.match(/^[0-9]+\.[0-9]+\.[0-9]+(-[0-9]+)?$/) ? true : false
+    end
+  end
+end

data/lib/omnijack/platforms.rb

@@ -0,0 +1,96 @@
+# Encoding: UTF-8
+#
+# Author:: Jonathan Hartman (<j@p4nt5.com>)
+#
+# Copyright (C) 2014, Jonathan Hartman
+#
+# 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.
+
+require 'json'
+require 'open-uri'
+require_relative 'config'
+require_relative '../omnijack'
+
+class Omnijack
+  # A class for representing an Omnitruck list of platform names
+  #
+  # @author Jonathan Hartman <j@p4nt5.com>
+  class Platforms < Omnijack
+    include Config
+
+    # TODO: Lots of duplicate code in platforms and list
+
+    #
+    # Make list items accessible via methods
+    #
+    # @param [Symbol] method_id
+    #
+    def method_missing(method_id, args = nil)
+      args.nil? && to_h[method_id] || super
+    end
+
+    #
+    # Make list items accessible via hash keys
+    #
+    # @param [Symbol] key
+    # @return [String, NilClass]
+    #
+    def [](key)
+      to_h[key]
+    end
+
+    #
+    # Offer a hash representation of the list
+    #
+    # @return [Hash]
+    #
+    def to_h
+      # TODO: Use a Mash -- some keys are better off addressed as strings
+      JSON.parse(raw_data, symbolize_names: true)
+    end
+
+    #
+    # Use the raw data string as a string representation
+    #
+    define_method(:to_s) { raw_data }
+
+    private
+
+    #
+    # Fetch the raw list from the configured URI
+    #
+    # @return [String]
+    #
+    def raw_data
+      @raw_data ||= api_url.open.read
+    end
+
+    #
+    # Construct the full API query URL from base + endpoint
+    #
+    # @return [URI::HTTP, URI::HTTPS]
+    #
+    def api_url
+      @api_url ||= URI.parse(::File.join(base_url, endpoint))
+    end
+
+    #
+    # Return the API endpoint for the package list of this project
+    #
+    # @return [String]
+    #
+    def endpoint
+      OMNITRUCK_PROJECTS[name][:endpoints][:platform_names]
+    end
+  end
+end

data/lib/omnijack/project/metaprojects.rb

@@ -0,0 +1,38 @@
+# Encoding: UTF-8
+#
+# Author:: Jonathan Hartman (<j@p4nt5.com>)
+#
+# Copyright (C) 2014, Jonathan Hartman
+#
+# 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.
+
+require_relative '../config'
+require_relative '../project'
+
+class Omnijack
+  class Project < Omnijack
+  end
+end
+
+# Dynamically define classes for each configured project
+#
+# @author Jonathan Hartman <j@p4nt5.com>
+Omnijack::Config::OMNITRUCK_PROJECTS.each do |project_name, _|
+  klass = Class.new(Omnijack::Project) do
+    define_method(:initialize) do |args = {}|
+      super(project_name, args)
+    end
+  end
+  class_name = project_name.to_s.split('_').map(&:capitalize).join
+  Omnijack::Project.const_set(class_name, klass)
+end

data/lib/omnijack/project.rb

@@ -0,0 +1,63 @@
+# Encoding: UTF-8
+#
+# Author:: Jonathan Hartman (<j@p4nt5.com>)
+#
+# Copyright (C) 2014, Jonathan Hartman
+#
+# 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.
+
+require_relative '../omnijack'
+require_relative 'config'
+require_relative 'list'
+require_relative 'metadata'
+require_relative 'platforms'
+require_relative 'project/metaprojects'
+require_relative '../../vendor/chef/lib/chef/exceptions'
+require_relative '../../vendor/chef/lib/chef/mixin/params_validate'
+
+class Omnijack
+  # A parent project that can contain metadata, a pkg list, and platforms
+  #
+  # @author Jonathan Hartman <j@p4nt5.com>
+  class Project < Omnijack
+    include Config
+
+    #
+    # The Metadata instance for the project
+    #
+    # @return [Omnijack::Metadata]
+    #
+    def metadata
+      # TODO: This requires too much knowledge of the Metadata class
+      @metadata ||= Metadata.new(name, args)
+    end
+
+    #
+    # The full list instance for the project
+    #
+    # @return [Omnijack::List]
+    #
+    def list
+      @list ||= List.new(name, args)
+    end
+
+    #
+    # The platform names instance for the project
+    #
+    # @return [Omnijack::Platforms]
+    #
+    def platforms
+      @platforms ||= Platforms.new(name, args)
+    end
+  end
+end

data/lib/omnijack/version.rb

@@ -0,0 +1,24 @@
+# Encoding: UTF-8
+#
+# Author:: Jonathan Hartman (<j@p4nt5.com>)
+#
+# Copyright (C) 2014, Jonathan Hartman
+#
+# 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.
+
+# Version string for Chef::Package::Metadata
+#
+# @author Jonathan Hartman <j@p4nt5.com>
+class Omnijack
+  VERSION = '0.1.0'
+end

data/lib/omnijack.rb

@@ -0,0 +1,54 @@
+# Encoding: UTF-8
+#
+# Author:: Jonathan Hartman (<j@p4nt5.com>)
+#
+# Copyright (C) 2014, Jonathan Hartman
+#
+# 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.
+
+require_relative '../vendor/chef/lib/chef/exceptions'
+require_relative '../vendor/chef/lib/chef/mixin/params_validate'
+require_relative 'omnijack/config'
+require_relative 'omnijack/project'
+require_relative 'omnijack/list'
+require_relative 'omnijack/metadata'
+require_relative 'omnijack/platforms'
+require_relative 'omnijack/version'
+
+# Provide a base class with some commons everyone can inherit
+#
+# @author Jonathan Hartman <j@p4nt5.com>
+class Omnijack
+  include ::Chef::Mixin::ParamsValidate
+  include Config
+
+  def initialize(name, args = {})
+    @name = name.to_sym
+    @args = args
+    base_url(args[:base_url]) if args && args[:base_url]
+  end
+  attr_reader :name, :args
+
+  #
+  # The base URL of the Omnitruck API
+  #
+  # @param [String, NilClass] arg
+  # @return [String]
+  #
+  def base_url(arg = nil)
+    # TODO: Better URL validation
+    set_or_return(:base_url, arg, kind_of: String, default: DEFAULT_BASE_URL)
+  end
+
+  # TODO: Every class' `endpoint` method is similar enough they could go here
+end

data/omnijack.gemspec

@@ -0,0 +1,37 @@
+# Encoding: UTF-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omnijack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'omnijack'
+  spec.version       = Omnijack::VERSION
+  spec.authors       = ['Jonathan Hartman']
+  spec.email         = %w(j@p4nt5.com)
+  spec.summary       = 'A pallet jack to unload data from the Omnitruck'
+  spec.description   = 'A pallet jack to unload data from the Omnitruck'
+  spec.homepage      = 'https://rubygems.org/gems/omnijack'
+  spec.license       = 'Apache v2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = %w(lib)
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_dependency 'ohai'
+  spec.add_dependency 'json'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'cane'
+  spec.add_development_dependency 'countloc'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-console'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'cucumber'
+end

data/spec/omnijack/config_spec.rb

@@ -0,0 +1,55 @@
+# Encoding: UTF-8
+#
+# Author:: Jonathan Hartman (<j@p4nt5.com>)
+#
+# Copyright (C) 2014, Jonathan Hartman
+#
+# 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.
+
+require_relative '../spec_helper'
+require_relative '../../lib/omnijack/config'
+
+describe Omnijack::Config do
+  describe 'DEFAULT_BASE_URL' do
+    it 'uses the official Chef API' do
+      expected = 'https://www.getchef.com/chef'
+      expect(described_class::DEFAULT_BASE_URL).to eq(expected)
+    end
+  end
+
+  describe 'OMNITRUCK_PROJECTS' do
+    it 'recognizes all the valid Omnitruck projects' do
+      expected = [:angry_chef, :chef, :chef_dk, :chef_container, :chef_server]
+      expect(described_class::OMNITRUCK_PROJECTS.keys).to eq(expected)
+    end
+
+    described_class::OMNITRUCK_PROJECTS.each do |project, attrs|
+      attrs[:endpoints].each do |name, endpoint|
+        it "uses a valid #{project}::#{name} endpoint" do
+          url = "http://www.getchef.com/chef#{endpoint}"
+          url << '?v=latest&p=ubuntu&pv=12.04&m=x86_64' if name == :metadata
+
+          # Some endpoints aren't available on Chef's public Omnitruck API
+          if [:angry_chef, :chef_dk, :chef_container].include?(project) && \
+            [:package_list, :platform_names].include?(name)
+            expected = 404
+          else
+            expected = 200
+          end
+
+          expect(Net::HTTP.get_response(URI(url)).code.to_i).to eq(expected)
+        end
+      end
+    end
+  end
+end