image-inspector-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4da0318dd9b810deb0ddd7f19b91f4127f7864cc
+  data.tar.gz: b244d90435141d4c77526550c6580a77597de6cf
+SHA512:
+  metadata.gz: 93e4ff76ac2adb2318267a037b018065ce9114037b4c4cda7d88e5795adcf4ab158e6d55b3ac21ab4bbdd12cb58988df0c619509c6344a7381f28bf251176a75
+  data.tar.gz: 6ce7a139bfb1c62d0490b376be2a4b1ea6e726ad903e297f88adec21bfcf11904df4e891618080a37240b5e8365ae5c85af6569eaaa6e49368ca3cc70bce98ec

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,10 @@
+ClassLength:
+  Enabled: false
+MethodLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/LineLength:
+  Max: 100
+Style/FileName:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - "2.0"
+  - "2.1"
+  - "2.2"
+sudo: false
+cache: bundler

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kubeclient.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mooli Tayer
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# image-inspector-client
+a ruby client for [image-inspector](https://github.com/simon3z/image-inspector)
+
+## installing gem
+TBD
+
+## usage
+```ruby
+require 'image-inspector-client'
+ImageInspectorClient::Client.new('http://localhost:8080', 'v1')
+  .fetch_metadata
+  .ContainerConfig
+  .Cmd
+```
+
+## building from source
+fetch dependencies:
+```
+bundle install
+```
+tests:
+```
+rake test
+```
+tests and style check:
+```
+rake test rubocop
+```
+
+build and install into $GEM_HOME:
+```
+rake install
+```

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+task default: [:test, :rubocop]
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+RuboCop::RakeTask.new

data/image-inspector-client.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'image-inspector-client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'image-inspector-client'
+  spec.version       = ImageInspectorClient::VERSION
+  spec.authors       = ['Mooli Tayer']
+  spec.email         = ['mtayer@redhat.com']
+  spec.summary       = 'A client for image_inspector REST API'
+  spec.description   = 'A client for image_inspector REST API'
+  spec.homepage      = 'https://github.com/moolitayer/image-inspector-client'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'rubocop', '= 0.30.0'
+
+  spec.add_dependency 'json'
+  spec.add_dependency 'recursive-open-struct', '= 0.6.1'
+  spec.add_dependency 'rest-client'
+end

data/lib/image-inspector-client.rb

@@ -0,0 +1,91 @@
+require 'json'
+require 'rest-client'
+require 'recursive_open_struct'
+
+# Client for image inspector: https://github.com/simon3z/image-inspector
+module ImageInspectorClient
+  # module entry point
+  class Client
+    def initialize(
+      uri,
+      version = 'v1',
+      ssl_options: {
+        client_cert: nil,
+        client_key:  nil,
+        ca_file:     nil,
+        cert_store:  nil,
+        verify_ssl:  OpenSSL::SSL::VERIFY_PEER
+      },
+      auth_options: {
+        username:          nil,
+        password:          nil,
+        bearer_token:      nil
+      }
+    )
+      @endpoint = URI.parse("#{uri}/api/#{version}")
+      @auth_options = auth_options
+      @ssl_options = ssl_options
+      @headers = {}
+    end
+
+    def fetch_metadata
+      exception_handler do
+        RecursiveOpenStruct.new(
+          JSON.parse(
+            RestClient::Resource.new(@endpoint, http_options)['metadata'].get(http_headers)
+          )
+        )
+      end
+    end
+
+    private
+
+    def exception_handler
+      yield
+    rescue RestClient::Exception => e
+      begin
+        json_error_msg = JSON.parse(e.response || '') || {}
+      rescue JSON::ParserError
+        json_error_msg = {}
+      end
+      err_message = json_error_msg['message'] || e.message
+      raise InspectorClientException.new(e.http_code, err_message)
+    end
+
+    def http_options
+      {
+        ssl_client_cert: @ssl_options[:client_cert],
+        ssl_client_key:  @ssl_options[:client_key],
+        ssl_ca_file:     @ssl_options[:ca_file],
+        ssl_cert_store:  @ssl_options[:cert_store],
+        verify_ssl:      @ssl_options[:verify_ssl],
+        user:            @auth_options[:username],
+        password:        @auth_options[:password]
+      }
+    end
+
+    def http_headers
+      if @auth_options[:bearer_token]
+        {
+          Authorization: "Bearer #{@auth_options[:bearer_token]}"
+        }
+      else
+        {}
+      end
+    end
+  end
+
+  # Exception thrown by this module
+  class InspectorClientException < StandardError
+    attr_reader :error_code, :message
+
+    def initialize(error_code, message)
+      @error_code = error_code
+      @message = message
+    end
+
+    def to_s
+      'HTTP status code ' + @error_code.to_s + ', ' + @message
+    end
+  end
+end

data/lib/image-inspector-client/version.rb

@@ -0,0 +1,4 @@
+# Client for image inspector: https://github.com/simon3z/image-inspector
+module ImageInspectorClient
+  VERSION = '0.1.0'
+end

data/test/common.rb

@@ -0,0 +1,10 @@
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'json'
+require 'image-inspector-client'
+
+# Assumes test files will be in a subdirectory with the same name as the
+# file suffix.  e.g. a file named foo.json would be a "json" subdirectory.
+def open_test_file(name)
+  File.new(File.join(File.dirname(__FILE__), name.split('.').last, name))
+end

data/test/json/metadata.json

@@ -0,0 +1,27 @@
+{
+  "Id": "85f4e2af80d39fccfa3abd218732bc4fc1711665527c5fdd556fb0ff9139c789",
+  "Parent": "48ecf305d2cf7046c1f5f8fcbcd4994403173441d4a7f125b1bb0ceead9de731",
+  "Created": "2015-10-13T23:39:52.388889568Z",
+  "Container": "6513026ba0de46b0ee484fa9e505bd8b6715df06bcc617fa70ac87defe0838b0",
+  "ContainerConfig": {
+    "Hostname": "6513026ba0de",
+    "Cmd": [
+      "/bin/sh",
+      "-c",
+      "#(nop) ADD file:3d655151e60ee9ae6490fe44ec7e42f0e0117f0cd6728fd5281299c01638a492 in /"
+    ],
+    "Image": "48ecf305d2cf7046c1f5f8fcbcd4994403173441d4a7f125b1bb0ceead9de731",
+    "Entrypoint": null
+  },
+  "DockerVersion": "1.8.2",
+  "Author": "Lokesh Mandvekar \u003clsm5@fedoraproject.org\u003e",
+  "Config": {
+    "Hostname": "6513026ba0de",
+    "Cmd": null,
+    "Image": "48ecf305d2cf7046c1f5f8fcbcd4994403173441d4a7f125b1bb0ceead9de731",
+    "Entrypoint": null
+  },
+  "Architecture": "amd64",
+  "Size": 186507296,
+  "VirtualSize": 186507296
+}

data/test/test_client.rb

@@ -0,0 +1,14 @@
+require 'common'
+
+# General client tests
+class TestClient < MiniTest::Test
+  def test_unknown_host
+    stub_request(:get, %r{/metadata})
+      .to_return(status: 404)
+
+    assert_raises(ImageInspectorClient::InspectorClientException) do
+      ImageInspectorClient::Client.new('http://localhost:8080', 'v1')
+        .fetch_metadata
+    end
+  end
+end

data/test/test_metadata.rb

@@ -0,0 +1,29 @@
+require 'common'
+
+# Tests for fetch_metadata call
+class TestMetadata < MiniTest::Test
+  def test_metadata_v1
+    stub_request(:get, %r{/metadata}).to_return(
+      body: open_test_file('metadata.json'),
+      status: 200
+    )
+
+    md = ImageInspectorClient::Client.new('http://localhost:8080', 'v1')
+         .fetch_metadata
+
+    assert_instance_of(RecursiveOpenStruct, md)
+    assert_equal(md.Id, '85f4e2af80d39fccfa3abd218732bc4fc1711665527c5fdd556fb0ff9139c789')
+    assert_equal(md.DockerVersion, '1.8.2')
+    assert_equal(md.Architecture, 'amd64')
+    assert_equal(
+      md.ContainerConfig.Image,
+      '48ecf305d2cf7046c1f5f8fcbcd4994403173441d4a7f125b1bb0ceead9de731'
+    )
+
+    assert_requested(
+      :get,
+      'http://localhost:8080/api/v1/metadata',
+      times: 1
+    )
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: image-inspector-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mooli Tayer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.30.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.30.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A client for image_inspector REST API
+email:
+- mtayer@redhat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- image-inspector-client.gemspec
+- lib/image-inspector-client.rb
+- lib/image-inspector-client/version.rb
+- test/common.rb
+- test/json/metadata.json
+- test/test_client.rb
+- test/test_metadata.rb
+homepage: https://github.com/moolitayer/image-inspector-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.0
+signing_key: 
+specification_version: 4
+summary: A client for image_inspector REST API
+test_files:
+- test/common.rb
+- test/json/metadata.json
+- test/test_client.rb
+- test/test_metadata.rb