omnijack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5cadaf238bfb0ff5f33ed95b1329043182bd8151
+  data.tar.gz: 890034875797b786f1fcda49430aff51ad5e7abc
+SHA512:
+  metadata.gz: 703d6eca87963b31a99564b84c80f709621fde3440b9c8254ebe8d4260560c49ec7e6ded97d2151564c822fa9a0d24651f71c1bef7d828ca2d71c2e693bc1cf7
+  data.tar.gz: 1eed214f4e432ba6b1c70191a48cefd63a7ca1d1cddb369bf99eb11b4a6566ec693084d5f4e588b6b2df082f752d5faa997d19f11993b91ade3027eecf7d8cf3

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+Omnijack Gem CHANGELOG
+======================
+
+v0.1.0 (2014-09-12)
+-------------------
+- Initial release!
+
+
+v0.0.1 (2014-09-02)
+-------------------
+- Development started

data/Gemfile

@@ -0,0 +1,6 @@
+# Encoding: UTF-8
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omnijack.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,15 @@
+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.

data/NOTICE

@@ -0,0 +1,5 @@
+Omnijack NOTICE
+===============
+
+Omnijack incorporates code from Chef (http://www.getchef.com), which is
+Copyright (c) 2008-2014 Opscode/Chef.

data/README.md

@@ -0,0 +1,119 @@
+Omnijack
+========
+
+[![Gem Version](https://badge.fury.io/rb/omnijack.png)][fury]
+[![Build Status](http://img.shields.io/travis/RoboticCheese/omnijack-ruby.svg)][travis]
+[![Code Climate](http://img.shields.io/codeclimate/github/kabisaict/flow.svg)][codeclimate]
+[![Coverage Status](http://img.shields.io/coveralls/RoboticCheese/omnijack-ruby.svg)][coveralls]
+[![Dependency Status](http://img.shields.io/gemnasium/RoboticCheese/omnijack.svg)][gemnasium]
+
+[fury]: http://badge.fury.io/rb/omnijack
+[travis]: http://travis-ci.org/RoboticCheese/omnijack-ruby
+[codeclimate]: https://codeclimate.com/github/RoboticCheese/omnijack-ruby
+[coveralls]: https://coveralls.io/r/RoboticCheese/omnijack-ruby
+[gemnasium]: https://gemnasium.com/RoboticCheese/omnijack-ruby
+
+A Ruby client interface to Chef's
+[Omnitruck](https://github.com/opscode/opscode-omnitruck) API.
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omnijack'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omnijack
+
+Usage
+-----
+
+Getting Chef-DK package metadata from the official Chef API:
+
+```ruby
+require 'omnijack'
+
+chef_dk = Omnijack::Project::ChefDk.new
+metadata = chef_dk.metadata
+
+puts metadata
+
+puts metadata.url
+puts metadata.filename
+puts metadata.md5
+puts metadata.sha256
+puts metadata.yolo
+
+puts metadata[:url]
+puts metadata[:filename]
+puts metadata[:md5]
+puts metadata[:sha256]
+puts metadata[:yolo]
+```
+Getting Chef-DK project data from an unofficial Omnitruck API:
+
+```ruby
+Omnijack::Project::ChefDk.new(
+  base_url: 'https://some.custom.chef.api/endpoint'
+)
+```
+
+Getting Chef-DK project data for a version other than the latest release:
+
+```ruby
+Omnijack::Project::ChefDk.new(
+  version: '1.2.3',
+  prerelease: true,
+  nightlies: true
+)
+```
+
+Getting Chef-DK project data for a platform other than the one running:
+
+```ruby
+Omnijack::Project::ChefDk.new(
+  platform: 'ubuntu',
+  platform_version: '14.04',
+  machine_arch: 'x86_64'
+)
+```
+
+Getting AngryChef project data:
+
+```ruby
+Omnijack::Project::AngryChef.new
+```
+Getting Chef project data:
+
+```ruby
+Omnijack::Project::Chef.new
+```
+
+Getting Chef-Container project data:
+
+```ruby
+Omnijack::Project::Container.new
+```
+
+Getting Chef Server project data:
+
+```ruby
+Omnijack::Project::Server.new
+```
+
+Contributing
+------------
+
+1. Fork it ( https://github.com/[my-github-username]/omnijack/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,23 @@
+# Encoding: UTF-8
+
+require 'bundler/setup'
+require 'rubocop/rake_task'
+require 'cane/rake_task'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+Cane::RakeTask.new
+
+RuboCop::RakeTask.new
+
+desc 'Display LOC stats'
+task :loc do
+  puts "\n## LOC Stats"
+  sh 'countloc -r lib/kitchen'
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+Cucumber::Rake::Task.new(:features)
+
+task default: [:cane, :rubocop, :loc, :spec, :features]

data/features/list.feature

@@ -0,0 +1,19 @@
+# Encoding: UTF-8
+
+Feature: Package lists
+  In order to see what all packages are available
+  As an Omnitruck API consumer
+  I want to access package list data
+
+  Scenario Outline: All default <Project>
+    Given no special arguments
+    When I create a <Project> project
+    Then the list has a section for Ubuntu 12.04 x86_64
+    Examples:
+    # Some endpoints aren't served by Chef's public Omnitruck API
+      | Project       |
+    # | AngryChef     |
+      | Chef          |
+    # | ChefDk        |
+    # | ChefContainer |
+      | ChefServer    |

data/features/metadata.feature

@@ -0,0 +1,43 @@
+# Encoding: UTF-8
+
+Feature: Metadata
+  In order to find out what package to download
+  As an Omnitruck API consumer
+  I want to access package metadata
+
+  Scenario Outline: All default <Project>
+    Given a Ubuntu 12.04 node
+    And no special arguments
+    When I create a <Project> project
+    Then the metadata has a url attribute
+    And the metadata has a filename attribute
+    And the metadata has an md5 attribute
+    And the metadata has a sha256 attribute
+    And the metadata doesn't have a yolo attribute
+    Examples:
+      | Project       |
+      | AngryChef     |
+      | Chef          |
+      | ChefDk        |
+      | ChefContainer |
+      | ChefServer    |
+
+  Scenario Outline: <Project> with nightlies enabled
+    Given a Ubuntu 12.04 node
+    And nightlies enabled
+    When I create a <Project> project
+    Then the metadata has a url attribute
+    And the metadata has a filename attribute
+    And the metadata has an md5 attribute
+    And the metadata has a sha256 attribute
+    And the metadata has a yolo attribute
+    Examples:
+      | Project       |
+    # | AngryChef     | There are no nightly builds for AngryChef(?)
+      | Chef          |
+      | ChefDk        |
+      | ChefContainer |
+      | ChefServer    |
+
+  # We can't quite be guaranteed of a prerelease version of anything existing
+  # Scenario Outline: <Project> with prerelease enabled

data/features/platforms.feature

@@ -0,0 +1,23 @@
+# Encoding: UTF-8
+
+Feature: Package platforms
+  In order to see what all packages are available
+  As an Omnitruck API consumer
+  I want to access package list data
+
+  Scenario Outline: All default <Project>
+    Given no special arguments
+    When I create a <Project> project
+    Then the platforms maps the following items:
+      | Nickname | FullName         |
+      | el       | Enterprise Linux |
+      | debian   | Debian           |
+      | freebsd  | FreeBSD          |
+    Examples:
+    # Some endpoints aren't served by Chef's public Omnitruck API
+      | Project       |
+      | AngryChef     |
+      | Chef          |
+      | ChefDk        |
+      | ChefContainer |
+      | ChefServer    |

data/features/step_definitions/list.rb

@@ -0,0 +1,12 @@
+# Encoding: UTF-8
+
+Then(/^the list has a section for ([\w ]+) ([0-9\.]+) x86_64$/) do |p, v|
+  platform = p.split.join('_').downcase.to_sym
+  version = v.to_sym
+  [
+    @project.list.send(platform)[version][:x86_64],
+    @project.list[platform][version][:x86_64]
+  ].each do |i|
+    expect(i).to be_an_instance_of(Hash)
+  end
+end

data/features/step_definitions/metadata.rb

@@ -0,0 +1,20 @@
+# Encoding: UTF-8
+
+Then(/^the metadata (has|doesn't have) a(n)? (\w+) attribute$/) do |has, _, a|
+  case has
+  when 'has'
+    regex = case a
+            when 'url'
+              %r{^https://opscode-omnibus-packages\.s3\.amazonaws\.com.*$}
+            when 'filename'
+              /^[A-Za-z0-9_\.\-%]+\.(rpm|deb|pkg|msi)$/
+            when 'md5'
+              /^\w{32}$/
+            when 'sha256'
+              /^\w{64}$/
+            end
+    expect(@project.metadata.send(a)).to match(regex)
+  else
+    expect(@project.metadata.send(a)).to eq(nil)
+  end
+end

data/features/step_definitions/platforms.rb

@@ -0,0 +1,8 @@
+# Encoding: UTF-8
+
+Then(/^the platforms maps the following items:$/) do |platforms|
+  puts platforms.hashes.each do |hsh|
+    expect(@project.platforms.send(hsh['Nickname'])).to eq(hsh['FullName'])
+    expect(@project.platforms[hsh['Nickname']]).to eq(hsh['FullName'])
+  end
+end

data/features/step_definitions/project.rb

@@ -0,0 +1,20 @@
+# Encoding: UTF-8
+
+Given(/^a(n)? ([\w ]+) ([0-9\.]+) node$/) do |_, platform, version|
+  node = { platform: platform.split.join('_').downcase,
+           platform_version: version,
+           kernel: { machine: 'x86_64' } }
+  allow_any_instance_of(Omnijack::Metadata).to receive(:node).and_return(node)
+end
+
+Given(/^no special arguments$/) do
+  @args = {}
+end
+
+Given(/^nightlies enabled$/) do
+  @args = { nightlies: true }
+end
+
+When(/^I create a(n)? (\w+) project$/) do |_, project|
+  @project = Omnijack::Project.const_get(project).new(@args)
+end

data/features/support/env.rb

@@ -0,0 +1,4 @@
+# Encoding: UTF-8
+
+require 'cucumber/rspec/doubles'
+require_relative '../../lib/omnijack'

data/lib/omnijack/config.rb

@@ -0,0 +1,67 @@
+# 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'
+
+class Omnijack
+  # Offer a config to base all the metaruby off of
+  #
+  # @author Jonathan Hartman <j@p4nt5.com>
+  module Config
+    DEFAULT_BASE_URL ||= 'https://www.getchef.com/chef'
+    OMNITRUCK_PROJECTS ||= {
+      angry_chef: {
+        endpoints: {
+          metadata: '/metadata-angrychef',
+          package_list: '/full_angrychef_list',
+          platform_names: '/angrychef_platform_names'
+        }
+      },
+      chef: {
+        endpoints: {
+          metadata: '/metadata',
+          package_list: '/full_client_list',
+          platform_names: '/chef_platform_names'
+        }
+      },
+      chef_dk: {
+        endpoints: {
+          metadata: '/metadata-chefdk',
+          package_list: '/full_chefdk_list',
+          platform_names: '/chefdk_platform_names'
+        }
+      },
+      chef_container: {
+        endpoints: {
+          metadata: '/metadata-container',
+          package_list: '/full_container_list',
+          platform_names: '/chef_container_platform_names'
+        }
+      },
+      chef_server: {
+        endpoints: {
+          metadata: '/metadata-server',
+          package_list: '/full_server_list',
+          platform_names: '/chef_server_platform_names'
+        }
+      }
+    }
+    METADATA_ATTRIBUTES ||= [:url, :md5, :sha256, :yolo]
+  end
+end

data/lib/omnijack/list.rb

@@ -0,0 +1,94 @@
+# 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 full list object
+  #
+  # @author Jonathan Hartman <j@p4nt5.com>
+  class List < Omnijack
+    include Config
+
+    #
+    # 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][:package_list]
+    end
+  end
+end