omnijack 0.2.0 → 1.0.0.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc253a8a3bc6dae6c9ab5ca28a1af127cbf8ca98
-  data.tar.gz: 2886b763948b3e3b01d4ca1843b15588f1ee2717
+  metadata.gz: 9da3ed386e954d9cec3fe7af1ed98ffd922293f6
+  data.tar.gz: 557a27f54cda7880d16735dd6e342dc5d21a1a8c
 SHA512:
-  metadata.gz: 8abff1f3f1bd23af2a420c9718425afc7b2adb65df2e42c5d585d56b3209a8b00a1c78bc69886ccddd1af29206ca8f29d5e2cd402b28ffa8cb43d2c5f243302d
-  data.tar.gz: 085621d8d7d5cce42cc519b56847cfab0a80df7446a8f755adbf2d2f0ddcf8c0e458a1a3922f78cd4f48db3b1489f1c3fa656de10640fe9bb0a0e6228189ecd0
+  metadata.gz: 6ba750e4a5473fc133617fc87476c20e95025246de83b08b461313e9cbbe7ee284b70c790f86c7db5509adfe42a48bf4987a27ff99bb2ee270545264e87cf1f7
+  data.tar.gz: 2768872e886d0369fdce3b58e7f018c0a95fe2f26c32419d73f878a3c6202a5a67b1287c1df646f4f23c6687606948ec8613b17c702c063f47dc80e0ffb3fc65

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Omnijack Gem CHANGELOG
 ======================
 
+v1.0.0 (????-??-??)
+-------------------
+- Remove dependency on `ohai`; require platform arguments for metadata
+- Swap out `json` dependency for `multi_json`
+
 v0.2.0 (2014-09-19)
 -------------------
 - Calculate and expose version and build numbers as part of metadata

data/README.md

@@ -3,7 +3,7 @@ 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]
+[![Code Climate](http://img.shields.io/codeclimate/github/RoboticCheese/omnijack-ruby.svg)][codeclimate]
 [![Coverage Status](http://img.shields.io/coveralls/RoboticCheese/omnijack-ruby.svg)][coveralls]
 [![Dependency Status](http://img.shields.io/gemnasium/RoboticCheese/omnijack-ruby.svg)][gemnasium]
 
@@ -36,12 +36,21 @@ Or install it yourself as:
 Usage
 -----
 
-Getting Chef-DK package metadata from the official Chef API:
+Getting Chef-DK project data from the official Chef API:
 
 ```ruby
 require 'omnijack'
 
 chef_dk = Omnijack::Project::ChefDk.new
+```
+
+Getting Chef-DK package metadata (requires additional target platform
+information):
+
+```ruby
+chef_dk = Omnijack::Project::ChefDk.new(platform: 'ubuntu',
+                                        platform_version: '14.04',
+                                        machine_arch: 'x86_64')
 metadata = chef_dk.metadata
 
 puts metadata
@@ -62,6 +71,7 @@ puts metadata[:yolo]
 puts metadata[:version]
 puts metadata[:build]
 ```
+
 Getting Chef-DK project data from an unofficial Omnitruck API:
 
 ```ruby
@@ -80,16 +90,6 @@ Omnijack::Project::ChefDk.new(
 )
 ```
 
-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 the Chef project's list of packages:
 
 ```ruby
@@ -132,6 +132,7 @@ 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
+3. Add tests for any new code and ensure all tests pass (`rake`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -13,7 +13,7 @@ RuboCop::RakeTask.new
 desc 'Display LOC stats'
 task :loc do
   puts "\n## LOC Stats"
-  sh 'countloc -r lib/kitchen'
+  sh 'countloc -r lib/omnijack'
 end
 
 RSpec::Core::RakeTask.new(:spec)

data/features/step_definitions/project.rb

@@ -1,18 +1,17 @@
 # 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)
+  @args = { platform: platform.split.join('_').downcase,
+            platform_version: version,
+            machine_arch: 'x86_64' }
 end
 
 Given(/^no special arguments$/) do
-  @args = {}
+  @args ||= {}
 end
 
 Given(/^nightlies enabled$/) do
-  @args = { nightlies: true }
+  @args.merge!(nightlies: true)
 end
 
 When(/^I create a(n)? (\w+) project$/) do |_, project|

data/lib/omnijack/config.rb

@@ -26,36 +26,36 @@ class Omnijack
       angry_chef: {
         endpoints: {
           metadata: '/metadata-angrychef',
-          package_list: '/full_angrychef_list',
-          platform_names: '/angrychef_platform_names'
+          list: '/full_angrychef_list',
+          platforms: '/angrychef_platform_names'
         }
       },
       chef: {
         endpoints: {
           metadata: '/metadata',
-          package_list: '/full_client_list',
-          platform_names: '/chef_platform_names'
+          list: '/full_client_list',
+          platforms: '/chef_platform_names'
         }
       },
       chef_dk: {
         endpoints: {
           metadata: '/metadata-chefdk',
-          package_list: '/full_chefdk_list',
-          platform_names: '/chefdk_platform_names'
+          list: '/full_chefdk_list',
+          platforms: '/chefdk_platform_names'
         }
       },
       chef_container: {
         endpoints: {
           metadata: '/metadata-container',
-          package_list: '/full_container_list',
-          platform_names: '/chef_container_platform_names'
+          list: '/full_container_list',
+          platforms: '/chef_container_platform_names'
         }
       },
       chef_server: {
         endpoints: {
           metadata: '/metadata-server',
-          package_list: '/full_server_list',
-          platform_names: '/chef_server_platform_names'
+          list: '/full_server_list',
+          platforms: '/chef_server_platform_names'
         }
       }
     }

data/lib/omnijack/endpoint/list.rb

@@ -0,0 +1,29 @@
+# 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 '../endpoint'
+
+class Omnijack
+  class Endpoint < Omnijack
+    # A class for representing an Omnitruck full list object
+    #
+    # @author Jonathan Hartman <j@p4nt5.com>
+    class List < Endpoint
+    end
+  end
+end

data/lib/omnijack/endpoint/metadata.rb

@@ -0,0 +1,189 @@
+# 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 'open-uri'
+require_relative '../config'
+require_relative '../endpoint'
+
+class Omnijack
+  class Endpoint < Omnijack
+    # A class for representing an Omnitruck metadata object
+    #
+    # @author Jonathan Hartman <j@p4nt5.com>
+    class Metadata < Endpoint
+      include ::Chef::Mixin::ParamsValidate
+      include Config
+
+      def initialize(name, args)
+        super
+        [:platform, :platform_version, :machine_arch].each do |i|
+          send(i, args[i])
+          args.delete(i)
+        end
+        args.each { |k, v| send(k, v) unless v.nil? } unless args.nil?
+        to_h
+      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] }
+      define_method(:build) { to_h[:build] }
+
+      #
+      # Offer a hash representation of the metadata
+      #
+      # @return [Hash]
+      #
+      def to_h
+        raw_data.split("\n").each_with_object({}) do |line, hsh|
+          key = line.split[0].to_sym
+          val = line.split[1]
+          val = true if val == 'true'
+          val = false if val == 'false'
+          hsh[key] = val
+          key == :url && hsh.merge!(parse_url_data(val)) && \
+            version(hsh[:version])
+        end
+      end
+
+      #
+      # 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')
+      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, required: true)
+      end
+
+      #
+      # The version of the desired platform
+      #
+      # @param [String, NilClass] arg
+      # @return [String]
+      #
+      def platform_version(arg = nil)
+        !arg.nil? && arg = case platform
+                           when 'mac_os_x' then platform_version_mac_os_x(arg)
+                           when 'windows' then platform_version_windows(arg)
+                           else arg
+                           end
+        set_or_return(:platform_version, arg, kind_of: String, required: true)
+      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, required: true)
+      end
+
+      private
+
+      #
+      # Construct the full API query URL from base + endpoint + params
+      #
+      # @return [URI::HTTP, URI::HTTPS]
+      #
+      def api_url
+        @api_url ||= URI.parse("#{super}?#{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
+
+      #
+      # Apply special logic for the version of an OS X platform
+      #
+      # @param [String] arg
+      # @return [String]
+      #
+      def platform_version_mac_os_x(arg)
+        arg.match(/^[0-9]+\.[0-9]+/).to_s
+      end
+
+      #
+      # Apply special logic for the version of a Windows platform
+      #
+      # @param [String] arg
+      # @return [String]
+      #
+      def platform_version_windows(arg)
+        # 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'
+        }[arg.match(/^[0-9]+\.[0-9]+/).to_s]
+      end
+
+      #
+      # Extract a filename, package version, and build from a package URL
+      #
+      # @param [String] url
+      # @return [[String] filename, [String] version, [String] build]
+      #
+      def parse_url_data(url)
+        filename = URI.decode(url).split('/')[-1]
+        { filename: filename,
+          version: filename.split('-')[-2].split('_')[-1],
+          build: filename.split('-')[-1].split('.')[0].split('_')[0] }
+      end
+    end
+  end
+end

data/lib/omnijack/endpoint/platforms.rb

@@ -0,0 +1,29 @@
+# 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 '../endpoint'
+
+class Omnijack
+  class Endpoint < Omnijack
+    # A class for representing an Omnitruck list of platform names
+    #
+    # @author Jonathan Hartman <j@p4nt5.com>
+    class Platforms < Endpoint
+    end
+  end
+end

data/lib/omnijack/{platforms.rb → endpoint.rb}

@@ -16,22 +16,32 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'json'
+require 'multi_json'
 require 'open-uri'
-require_relative 'config'
+unless Module.const_defined?(:Chef)
+  require_relative '../../vendor/chef/lib/chef/exceptions'
+  require_relative '../../vendor/chef/lib/chef/mixin/params_validate'
+end
 require_relative '../omnijack'
+require_relative 'endpoint/list'
+require_relative 'endpoint/metadata'
+require_relative 'endpoint/platforms'
 
 class Omnijack
-  # A class for representing an Omnitruck list of platform names
+  # A parent class for Omnijack API endpoints
   #
   # @author Jonathan Hartman <j@p4nt5.com>
-  class Platforms < Omnijack
+  class Endpoint < Omnijack
+    include ::Chef::Mixin::ParamsValidate
     include Config
 
-    # TODO: Lots of duplicate code in platforms and list
+    def initialize(name, args = {})
+      super
+      base_url(args[:base_url])
+    end
 
     #
-    # Make list items accessible via methods
+    # Make class items accessible via methods
     #
     # @param [Symbol] method_id
     #
@@ -40,9 +50,9 @@ class Omnijack
     end
 
     #
-    # Make list items accessible via hash keys
+    # Make class items accessible via hash keys
     #
-    # @param [Symbol] key
+    # @param[Symbol] key
     # @return [String, NilClass]
     #
     def [](key)
@@ -50,13 +60,13 @@ class Omnijack
     end
 
     #
-    # Offer a hash representation of the list
+    # Offer a hash representation of the object
     #
     # @return [Hash]
     #
     def to_h
       # TODO: Use a Mash -- some keys are better off addressed as strings
-      JSON.parse(raw_data, symbolize_names: true)
+      MultiJson.load(raw_data, symbolize_names: true)
     end
 
     #
@@ -64,10 +74,21 @@ class Omnijack
     #
     define_method(:to_s) { raw_data }
 
+    #
+    # 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
+
     private
 
     #
-    # Fetch the raw list from the configured URI
+    # Fetch the raw data from the configured URI
     #
     # @return [String]
     #
@@ -90,7 +111,8 @@ class Omnijack
     # @return [String]
     #
     def endpoint
-      OMNITRUCK_PROJECTS[name][:endpoints][:platform_names]
+      cl = self.class.to_s.split(':')[-1].downcase.to_sym
+      OMNITRUCK_PROJECTS[name][:endpoints][cl]
     end
   end
 end

data/lib/omnijack/project.rb

@@ -18,9 +18,7 @@
 
 require_relative '../omnijack'
 require_relative 'config'
-require_relative 'list'
-require_relative 'metadata'
-require_relative 'platforms'
+require_relative 'endpoint'
 require_relative 'project/metaprojects'
 
 class Omnijack
@@ -37,7 +35,7 @@ class Omnijack
     #
     def metadata
       # TODO: This requires too much knowledge of the Metadata class
-      @metadata ||= Metadata.new(name, args)
+      @metadata ||= Endpoint::Metadata.new(name, args)
     end
 
     #
@@ -46,7 +44,7 @@ class Omnijack
     # @return [Omnijack::List]
     #
     def list
-      @list ||= List.new(name, args)
+      @list ||= Endpoint::List.new(name, args)
     end
 
     #
@@ -55,7 +53,7 @@ class Omnijack
     # @return [Omnijack::Platforms]
     #
     def platforms
-      @platforms ||= Platforms.new(name, args)
+      @platforms ||= Endpoint::Platforms.new(name, args)
     end
   end
 end

data/lib/omnijack/version.rb

@@ -20,5 +20,5 @@
 #
 # @author Jonathan Hartman <j@p4nt5.com>
 class Omnijack
-  VERSION = '0.2.0'
+  VERSION = '1.0.0.rc.1'
 end

data/lib/omnijack.rb

@@ -16,41 +16,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-unless Module.const_defined?(:Chef)
-  require_relative '../vendor/chef/lib/chef/exceptions'
-  require_relative '../vendor/chef/lib/chef/mixin/params_validate'
-end
+require 'open-uri'
 require_relative 'omnijack/config'
+require_relative 'omnijack/endpoint'
 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

@@ -21,8 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 1.9.3'
 
-  spec.add_dependency 'ohai'
-  spec.add_dependency 'json'
+  spec.add_dependency 'multi_json'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

data/spec/omnijack/config_spec.rb

@@ -41,7 +41,7 @@ describe Omnijack::Config do
 
           # 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)
+            [:list, :platforms].include?(name)
             expected = 301
           else
             expected = 200

data/spec/omnijack/endpoint/list_spec.rb

@@ -0,0 +1,33 @@
+# 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/endpoint/list'
+
+describe Omnijack::Endpoint::List do
+  let(:name) { :chef_dk }
+  let(:obj) { described_class.new(name) }
+
+  describe '#endpoint' do
+    let(:name) { :chef_container }
+
+    it 'returns the appropriate metadata endpoint' do
+      expect(obj.send(:endpoint)).to eq('/full_container_list')
+    end
+  end
+end