hyperb 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a274a2e8e2d64607cde734b988c25be8f6c3af0a
-  data.tar.gz: cb8e39bf87b74eaafe30c575d0e3e720a8ece385
+  metadata.gz: 6cfd1df42e8e7a70e5da8139a47a333c132f55ec
+  data.tar.gz: 42211756c1e2fac4844f38b02f245f91f2a98ca5
 SHA512:
-  metadata.gz: f7d11de4a362dd270fcc75afaf4b5c7bfb140c042b3f767349cb7ddac1bcecf2114315ee9885b7e434d3b85555e059e773c5fe8dfc19d21fbdbed611eb659e79
-  data.tar.gz: c7f4ba000e628c45acef4ee26df573b51e1fb064f56e06f9de95fe4eee4b0105e1ed660e63b6819c37dfe66fae864e3571a12155ee282209c503f9f5f749ae16
+  metadata.gz: 839af760aa8293c023623b92b475e975dbb436a195f90b1afd0ecc5efcdc717cffb25569e46be3d87fa08f842112a52d1fbf2bcb2037f46c609f5a53bbd7e233
+  data.tar.gz: 8645b548c23c76ffe182e32ae77746ebfb10de08fa93a2c1319244152702553112518b0c6f372aba388eb3a90231dfc539126ff1deab6b6a8995d416220b18e1

data/.gitignore

@@ -10,3 +10,6 @@
 
 # rspec failure tracking
 .rspec_status
+
+# annoying mac stuff
+.DS_Store

data/.rubocop.yml

@@ -39,3 +39,6 @@ Metrics/LineLength:
 
 Metrics/ParameterLists:
   Max: 6
+
+Metrics/AbcSize:
+  Max: 15.80

data/Makefile

@@ -1,7 +1,8 @@
 .PHONY: test
 
-r:
-	docker run --rm -it -v $(PWD):/usr/src hyperb bundle exec ruby test.rb
+b:
+	docker run --rm -v $(PWD):/usr/src hyperb bundle exec ruby t.rb
+
 
 build:
 	docker build -t hyperb .

data/README.md

@@ -4,6 +4,7 @@
   <p align="center">
     <a href="https://circleci.com/gh/drish/hyperb"><img src="https://circleci.com/gh/drish/hyperb.svg?style=svg"></a>
     <a href="https://github.com/drish/hyperb/blob/master/LICENSE.txt"><img src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
+    <a href="https://rubygems.org/gems/hyperb"><img src="https://img.shields.io/gem/dt/hyperb.svg?style=flat-square"></a>
     <a href="https://coveralls.io/github/drish/hyperb?branch=master"><img src="https://coveralls.io/repos/github/drish/hyperb/badge.svg?branch=master"></a>
 		<a href="https://codeclimate.com/github/drish/hyperb"><img src="https://codeclimate.com/github/drish/hyperb/badges/gpa.svg" /></a>
 		<a href="https://badge.fury.io/rb/hyperb"><img src="https://badge.fury.io/rb/hyperb.svg"</></a>

data/examples/README.md

@@ -71,13 +71,13 @@ response = client.remove_image(name: 'busybox', force: true)
 returns a Hash containing information about the inspected image
 
 ```ruby
-info = client.inspect_image(id: 'busybox')
+info = client.inspect_image(name: 'busybox')
 puts info
 ```
 
-## Containers API
+## [Containers API](https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Container)
 
-#### create_container
+#### [create_container](https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Container/create.html)
 
 Return a hash containing downcased symbolized container info.
 
@@ -106,7 +106,7 @@ res = client.create_container name: 'nginx-c', image: 'nginx', hostname: 'hostny
 With custom mounts
 
 ```ruby
-res = client.create_container name: 'nginx-c', image: 'nginx', mounts: ['./path/to/mount']'
+res = client.create_container name: 'nginx-c', image: 'nginx', mounts: ['./path/to/mount']
 ```
 
 With custom network mode
@@ -121,6 +121,28 @@ Exposing ports
 res = client.create_container name: 'nginx-c', image: 'nginx', exposedports: { '22/tcp': {} }
 ```
 
+Configurations such as:
+
+Binds, Links, PublishAllPorts,  PortBindings, ReadonlyRootfs, VolumesFrom, RestartPolicy, NetworkMode, LogConfig, VolumeDriver
+
+Are setup through Hyperb::HostConfig.
+
+see examples below:
+
+```ruby
+# you can either create host configurations through Hyperb::HostConfig
+# or with a Hash
+
+client.create_container name: 'mysql-1', image: 'mysql', host_config: Hyperb::HostConfig.new(binds: ['/path'] )}
+
+client.create_container name: 'mysql-1', image: 'mysql', host_config: { binds: ['/path/'] }
+client.create_container name: 'mysql-1', image: 'mysql', host_config: { links: ['container1:link_alias'] }
+client.create_container name: 'mysql-1', image: 'mysql', host_config: { publish_all_ports: true }
+client.create_container name: 'mysql-1', image: 'mysql', host_config: { readonly_rootfs: true }
+client.create_container name: 'mysql-1', image: 'mysql', host_config: { restart_policy: { name: 'unless-stopped' }}
+client.create_container name: 'mysql-1', image: 'mysql', host_config: { network_mode: 'host' }
+```
+
 #### start_container
 
 ```ruby
@@ -408,4 +430,4 @@ client.version
   "Arch"=>"amd64",
   "KernelVersion"=>"4.0.0"
 }
-```
+```

data/lib/hyperb/containers/containers.rb

@@ -1,5 +1,6 @@
 require 'hyperb/request'
 require 'hyperb/containers/container'
+require 'hyperb/containers/host_config'
 require 'hyperb/utils'
 require 'json'
 require 'uri'
@@ -103,21 +104,28 @@ module Hyperb
     # @option params [String] :networkmode network mode, ie 'bridge'.
     # @option params [Hash] :exposedports ports to expose.
     #
+    # @option params [Hash] :exposedports ports to expose.
+    #
     # @option params [Hash] :labels hash containing key: value
     # @option params labels [String] :sh_hyper_instancetype container size: s1, s2, s3 ...
     def create_container(params = {})
       raise ArgumentError, 'Invalid arguments.' unless check_arguments(params, 'image')
       path = '/containers/create'
       query = {}
-
-      # set a default size, otherwise container can't be started
+      # set default size, otherwise container can't be started
       body = { labels: { sh_hyper_instancetype: 's1' } }
+
+      # parse host_config options
+      if params.key?(:host_config)
+        body[camelize(:host_config)] = setup_host_config(params)
+        params.delete(:host_config)
+      end
+
       query[:name] = params[:name] if params.key?(:name)
       params.delete(:name)
       body.merge!(params)
 
-      response = JSON.parse(Hyperb::Request.new(self, path, query, 'post', body).perform)
-      downcase_symbolize(response)
+      downcase_symbolize(JSON.parse(Hyperb::Request.new(self, path, query, 'post', body).perform))
     end
 
     # inspect a container
@@ -247,5 +255,15 @@ module Hyperb
       query[:name] = params[:name] if params.key?(:name)
       Hyperb::Request.new(self, path, query, 'post').perform
     end
+
+    private
+
+    def setup_host_config(params)
+      if params[:host_config].is_a?(Hash)
+        HostConfig.new(params[:host_config]).fmt
+      elsif params[:host_config].is_a?(HostConfig)
+        params[:host_config].fmt
+      end
+    end
   end
 end

data/lib/hyperb/containers/host_config.rb

@@ -0,0 +1,46 @@
+require 'hyperb/utils'
+
+module Hyperb
+  # helper for managing creating proper container host configs
+  # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Container/create.html
+  class HostConfig
+    include Hyperb::Utils
+
+    attr_accessor :binds, :links, :port_bindings, :publish_all_ports,
+                  :network_mode, :restart_policy, :volume_driver, :log_config,
+                  :readonly_rootfs, :volumes_from
+
+    def initialize(params = {})
+      params.each do |att, value|
+        value = downcase_symbolize(value) if value.is_a?(Hash)
+        instance_variable_set("@#{att.downcase.to_sym}", value)
+      end
+    end
+
+    # returns a hash containing formated host config data
+    #
+    # @returns [Hash]
+    def fmt
+      formated = {}
+      attrs.keys.each do |key|
+        formated[camelize(key)] = attrs[key]
+      end
+      formated
+    end
+
+    def attrs
+      {
+        binds: binds,
+        links: links,
+        port_bindings: port_bindings,
+        publish_all_ports: publish_all_ports,
+        network_mode: network_mode,
+        restart_policy: restart_policy,
+        volume_driver: volume_driver,
+        log_config: log_config,
+        readonly_rootfs: readonly_rootfs,
+        volumes_from: volumes_from
+      }
+    end
+  end
+end

data/lib/hyperb/images/images.rb

@@ -45,12 +45,10 @@ module Hyperb
     # @required @option params [String] :from_image image name to be pulled
     # @option params [String] :tag image tag name
     #
-    # @option params [Hash] :x-registry-auth object containing either login information, or a token
-    # @option params x-registry-auth [String] :username
-    # @option params x-registry-auth [String] :email
-    # @option params x-registry-auth [String] :password
-    #
-    # TODO: @option params [Boolean] :stdout print stream to stdout
+    # @option params [Hash] :x_registry_auth object containing either login information.
+    # @option params x_registry_auth [String] :username
+    # @option params x_registry_auth [String] :email
+    # @option params x_registry_auth [String] :password
     def create_image(params = {})
       raise ArgumentError, 'Invalid arguments.' unless check_arguments(params, 'from_image')
       path = '/images/create'
@@ -101,6 +99,7 @@ module Hyperb
     # @param params [Hash] A customizable set of params.
     # @option params [String] :name image name to be removed
     def inspect_image(params = {})
+      raise ArgumentError, 'Invalid arguments.' unless check_arguments(params, 'name')
       path = '/images/' + params[:name] + '/json'
       res = JSON.parse(Hyperb::Request.new(self, path, {}, 'get').perform)
       downcase_symbolize(res)

data/lib/hyperb/utils.rb

@@ -1,6 +1,12 @@
 module Hyperb
   # utils functions
   module Utils
+    # converts from Symbol or String to CamelCase
+    # @return String
+    def camelize(value)
+      value.to_s.split('_').collect(&:capitalize).join
+    end
+
     # checks if all args are keys into the hash
     #
     # @return [Boolean]

data/lib/hyperb/version.rb

@@ -1,3 +1,3 @@
 module Hyperb
-  VERSION = '0.4.1'.freeze
+  VERSION = '0.5.0'.freeze
 end

data/spec/containers_spec.rb

@@ -263,6 +263,118 @@ RSpec.describe Hyperb::Containers do
       expect(a_request(:post, path)
             .with(body: { image: 'image', workingdir: '/path/', labels: { sh_hyper_instancetype: 's1' } })).to have_been_made
     end
+
+    it 'correct request should be made with Hyperb::HostConfig class' do
+      path = @create_container_path
+
+      hc = Hyperb::HostConfig.new(binds: ['/path/to/mount'])
+
+      stub_request(:post, path)
+      .with(body: { image: 'image', labels: { sh_hyper_instancetype:'s1' }, 'HostConfig': hc.fmt })
+      .to_return(body: fixture('create_container.json'))
+
+      @client.create_container(image: 'image', host_config: hc)
+      expect(a_request(:post, path)
+            .with(body: { image: 'image',
+              labels: { sh_hyper_instancetype:'s1' },
+              'HostConfig': hc.fmt })).to have_been_made
+    end
+
+    it 'correct request should be made with host_configs:binds' do
+      path = @create_container_path
+
+      hc = Hyperb::HostConfig.new(binds: ['/path/to/mount'])
+
+      stub_request(:post, path)
+      .with(body: { image: 'image', labels: { sh_hyper_instancetype:'s1' }, 'HostConfig': hc.fmt })
+      .to_return(body: fixture('create_container.json'))
+
+      @client.create_container(image: 'image', host_config: { binds: ['/path/to/mount'] })
+      expect(a_request(:post, path)
+            .with(body: { image: 'image',
+              labels: { sh_hyper_instancetype:'s1' },
+              'HostConfig': hc.fmt })).to have_been_made
+    end
+
+    it 'correct request should be made with host_configs:links' do
+      path = @create_container_path
+
+      hc = Hyperb::HostConfig.new(links: ['container2:alias'])
+
+      stub_request(:post, path)
+      .with(body: { image: 'image', labels: { sh_hyper_instancetype:'s1' }, 'HostConfig': hc.fmt })
+      .to_return(body: fixture('create_container.json'))
+
+      @client.create_container(image: 'image', host_config: { links: ['container2:alias'] })
+      expect(a_request(:post, path)
+            .with(body: { image: 'image',
+              labels: { sh_hyper_instancetype:'s1' },
+              'HostConfig': hc.fmt })).to have_been_made
+    end
+
+    it 'correct request should be made with host_configs:publish_all_ports' do
+      path = @create_container_path
+
+      hc = Hyperb::HostConfig.new(publish_all_ports: false)
+
+      stub_request(:post, path)
+      .with(body: { image: 'image', labels: { sh_hyper_instancetype:'s1' }, 'HostConfig': hc.fmt })
+      .to_return(body: fixture('create_container.json'))
+
+      @client.create_container(image: 'image', host_config: { publish_all_ports: false })
+      expect(a_request(:post, path)
+            .with(body: { image: 'image',
+              labels: { sh_hyper_instancetype:'s1' },
+              'HostConfig': hc.fmt })).to have_been_made
+    end
+
+    it 'correct request should be made with host_configs:readonly_rootfs' do
+      path = @create_container_path
+
+      hc = Hyperb::HostConfig.new(readonly_rootfs: false)
+
+      stub_request(:post, path)
+      .with(body: { image: 'image', labels: { sh_hyper_instancetype:'s1' }, 'HostConfig': hc.fmt })
+      .to_return(body: fixture('create_container.json'))
+
+      @client.create_container(image: 'image', host_config: { readonly_rootfs: false })
+      expect(a_request(:post, path)
+            .with(body: { image: 'image',
+              labels: { sh_hyper_instancetype:'s1' },
+              'HostConfig': hc.fmt })).to have_been_made
+    end
+
+    it 'correct request should be made with host_configs:restart_policy' do
+      path = @create_container_path
+
+      hc = Hyperb::HostConfig.new(restart_policy: { name: 'unless-stopped' })
+
+      stub_request(:post, path)
+      .with(body: { image: 'image', labels: { sh_hyper_instancetype:'s1' }, 'HostConfig': hc.fmt })
+      .to_return(body: fixture('create_container.json'))
+
+      @client.create_container(image: 'image', host_config: { restart_policy: { name: 'unless-stopped' }})
+      expect(a_request(:post, path)
+            .with(body: { image: 'image',
+              labels: { sh_hyper_instancetype:'s1' },
+              'HostConfig': hc.fmt })).to have_been_made
+    end
+
+    it 'correct request should be made with host_configs:network_mode' do
+      path = @create_container_path
+
+      hc = Hyperb::HostConfig.new(network_mode: 'host')
+
+      stub_request(:post, path)
+      .with(body: { image: 'image', labels: { sh_hyper_instancetype:'s1' }, 'HostConfig': hc.fmt })
+      .to_return(body: fixture('create_container.json'))
+
+      @client.create_container(image: 'image', host_config: { network_mode: 'host' })
+      expect(a_request(:post, path)
+            .with(body: { image: 'image',
+              labels: { sh_hyper_instancetype:'s1' },
+              'HostConfig': hc.fmt })).to have_been_made
+    end
   end
 
   describe '#start_container' do

data/spec/host_config_spec.rb

@@ -0,0 +1,18 @@
+require 'helper'
+
+RSpec.describe Hyperb::HostConfig do
+
+  it '#fmt' do
+    host_config = Hyperb::HostConfig.new(binds: ['path/to/binds'], publish_all_ports: false)
+    formated = host_config.fmt
+    expect(formated).to be_a Hash
+    expect(formated.key?('Binds')).to be true
+    expect(formated.key?('PublishAllPorts')).to be true
+  end
+
+  it '#attrs' do
+    host_config = Hyperb::HostConfig.new(binds: 'path/to/binds')
+    expect(host_config.attrs).to be_a Hash
+    expect(host_config.attrs[:binds]).to be_a String
+  end
+end

data/spec/images_spec.rb

@@ -120,6 +120,10 @@ RSpec.describe Hyperb::Images do
       .to_return(body: fixture('inspect_image.json'))
     end
 
+    it 'should raise ArgumentError when name is not provided' do
+      expect { @client.inspect_image }.to raise_error(ArgumentError)
+    end
+
     it 'request to the correct path should be made' do
       @client.inspect_image name: 'busybox'
       expect(a_request(:get, @inspect_image_path)).to have_been_made

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hyperb
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - drish
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-22 00:00:00.000000000 Z
+date: 2017-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -146,6 +146,7 @@ files:
 - lib/hyperb/compose/compose.rb
 - lib/hyperb/containers/container.rb
 - lib/hyperb/containers/containers.rb
+- lib/hyperb/containers/host_config.rb
 - lib/hyperb/error.rb
 - lib/hyperb/hyper_version.rb
 - lib/hyperb/images/image.rb
@@ -187,6 +188,7 @@ files:
 - spec/fixtures/services.json
 - spec/fixtures/volumes.json
 - spec/helper.rb
+- spec/host_config_spec.rb
 - spec/image_spec.rb
 - spec/images_spec.rb
 - spec/network_spec.rb
@@ -215,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: The Hyper.sh Ruby Gem