hyperb 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ae75607b923ea1b252f58a6e058e5b1d7367561
-  data.tar.gz: 374b395b9113f4b56f0d527cb9d9b5d7806b5209
+  metadata.gz: 451eaa5bd6d96d215b204e67b80b087048cf5b91
+  data.tar.gz: c4b03081daa2592a264504f31028cb94fc49d813
 SHA512:
-  metadata.gz: 3f800705d76ac6d24ec11c842a1187a9c094c16d86252f9250cbeb0e03536547c344465cd6a61a05e2a3b4a71a9cdf67aa2204f92dfbe4a73d0614813a9aff1d
-  data.tar.gz: 121b440458d5c8600509698b8a0faa5fc5ca075e9c710fdbcbd8b0c4e9a2c778dbf91e1fc31a1760d548abb58fad88508fba3597bfd25a011e73ad410f6c5430
+  metadata.gz: c23a4d03fb11785c4beb7529adf6342df4c2ad04fac7cd36a953626c4ab8dbef8c380fe2cebfc96e2251e3540fd64bac83c5b6c1af1bed3ea406f3d6d0941848
+  data.tar.gz: 94ca447128b1273a91449c32cef90d20f414ab5e7ce2c5337f799c63d96b1095a38704dccbf625bd3a41b7f621bb01abea6d29f34a8bdf49c86e708caf536f5c

data/.codeclimate.yml

@@ -0,0 +1,12 @@
+engines:
+  rubocop:
+    enabled: true
+
+ratings:
+  paths:
+  - "**.rb"
+
+exclude_paths:
+  - etc/**/*
+  - examples/**/*
+  - spec/**/*

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,41 @@
+AllCops:
+  Exclude:
+    - 'spec/*'
+    - 'Rakefile'
+    - 'Gemfile'
+    - '*.gemspec'
+  TargetRubyVersion: 2.3
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Layout/IndentHeredoc:
+  EnforcedStyle: powerpack
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/*'
+
+Lint/UselessAccessModifier:
+  MethodCreatingMethods:
+    - 'def_matcher'
+    - 'def_node_matcher'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - 'spec/**/*.rb'
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 15
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/ParameterLists:
+  Max: 6

data/Dockerfile

@@ -0,0 +1,7 @@
+FROM ruby:2.3
+
+WORKDIR /usr/src
+COPY . /usr/src
+#COPY hyperb.gemspec /usr/src/hyperb.gemspec
+RUN bundle install
+

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+  "https://github.com/#{repo_name}.git"
+end
+
+gem 'yard'
+
+group :test do
+  gem 'coveralls'
+  gem 'rubocop', '>= 0.46'
+  gem 'yardstick'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 drish
+
+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/Makefile

@@ -0,0 +1,16 @@
+.PHONY: test
+
+build:
+	docker build -t hyperb .
+
+test:
+	docker run --rm -v $(PWD):/usr/src hyperb bundle exec rake spec
+
+pry:
+	docker run --rm -it -v $(PWD):/usr/src hyperb bundle exec pry
+
+rake:
+	docker run --rm -it -v $(PWD):/usr/src hyperb bundle exec rake
+
+rubocop:
+	docker run --rm -it -v $(PWD):/usr/src hyperb bundle exec rake rubocop

data/README.md

@@ -0,0 +1,188 @@
+<p align="center">
+  <h1 align="center">Hyperb</h1>
+  <p align="center">Hyperb is a <a href="https://hyper.sh">Hyper.sh</a> API ruby gem.</p>
+  <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://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>
+  </p>
+</p>
+
+---
+
+This gem is under active development.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hyperb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hyperb
+
+
+## Configuration
+
+Hyper.sh requires you to create credentials on their [dashboard](https://console.hyper.sh/account/credential), after that you can configure your client as following:
+
+```ruby
+client = Hyperb::Client.new(access_key: 'ak', secret_key: 'sk')
+```
+
+## Usage Examples
+
+After configuring a `client`, you can run the following examples.
+
+**get api version**
+
+```ruby
+client.version
+```
+**fetch all images**
+
+```ruby
+client.images
+```
+**remove an image**
+
+```ruby
+client.remove_image id: 'id-or-name'
+```
+**create an image (pull)**
+
+```ruby
+client.create_image from_image: 'busybox'
+```
+**pull an image from gcr (using service account)**
+
+```ruby
+client.create_image from_image: 'gcr.io/project/owner/gcr', x_registry_auth: { username: '_json_key', password: File.new('./path/service-account.json'), email: 'e@e.com', serveraddress: 'https://gcr.io' }
+```
+
+**create container (defaults to s1 size)**
+
+```ruby
+client.create_container name: 'nginx-container', image: 'nginx'
+```
+
+**create container with specific size**
+
+```ruby
+client.create_container name: 'nginx-container', image: 'nginx', labels: { sh_hyper_instancetype: 'm1' }
+```
+
+**start container**
+
+```ruby
+client.start_container name: 'nginx-container'
+```
+
+**container logs**
+
+```ruby
+logs = client.container_logs id: 'nginx', stdout: true, stderr: true, follow: true
+
+while body = logs.readpartial(1024)
+  puts body
+end
+```
+
+**allocate an floating ip**
+
+```ruby
+ips = client.fip_allocate count: 2
+puts ips
+#['8.8.8.8', '5.5.5.5']
+```
+
+For more usage examples, please see the full [documentation]().
+
+## APIs (v1.23) Covered
+
+[API](https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/index.html)
+
+### Images
+
+* inspect image
+* create image
+* list images
+* remove images
+
+### Volumes
+
+* list volumes
+* inspect volume
+* remove volume
+
+### Containers
+
+* create container (not all arguments supported yet)
+* start container
+* stop container
+* kill container
+* get container logs
+* get container stats
+* remove containers
+* rename container
+
+### Network
+
+* floating ip allocate
+* floating ip release
+* floating ip list
+* floating ip attach
+* floating ip detach
+
+### Compose
+
+* compose create
+* compose up
+* compose down
+* compose rm
+
+### Snapshot
+
+* create snapshot
+
+### Service
+
+* create service
+* remove service
+
+### Misc.
+
+* Version
+
+### Security Groups
+
+wip
+
+### Event
+
+wip
+
+### Func (beta)
+
+wip
+
+### Cron (beta)
+
+wip
+
+## Contributing
+
+Bug reports and pull requests are welcome at https://github.com/drish/hyperb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,24 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task test: :spec
+
+RuboCop::RakeTask.new
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+require 'yardstick/rake/measurement'
+Yardstick::Rake::Measurement.new do |measurement|
+  measurement.output = 'measurement/report.txt'
+end
+
+require 'yardstick/rake/verify'
+Yardstick::Rake::Verify.new do |verify|
+  verify.threshold = 50.0
+end
+
+task default: [:spec, :rubocop]

data/circle.yml

@@ -0,0 +1,13 @@
+dependencies:
+  override:
+    - 'rvm-exec 2.2.0 bundle install'
+    - 'rvm-exec 2.3.0 bundle install'
+    - 'rvm-exec 2.4.0 bundle install'
+    - 'rvm-exec ruby-head bundle install'
+
+test:
+  override:
+    - 'rvm-exec 2.2.0 bundle exec rake'
+    - 'rvm-exec 2.3.0 bundle exec rake'
+    - 'rvm-exec 2.4.0 bundle exec rake'
+    - 'rvm-exec ruby-head bundle exec rake'

data/examples/README.md

@@ -0,0 +1,367 @@
+# API
+
+Other examples: [Authenticating in GCR](https://github.com/drish/hyperb/blob/master/examples/auth-gcr-registry.md), [Streaming Logs](https://github.com/drish/hyperb/blob/master/examples/streaming-logs.md), [Streaming stats](https://github.com/drish/hyperb/blob/master/examples/streaming-stats.md)
+
+## Images API
+
+#### images
+
+returns an Array of Hyperb::Image
+
+```ruby
+images = client.images
+images.each do |image|
+  image.is_a?(Hyperb::Image)
+  puts image
+end
+```
+
+#### create_image
+
+return a [HTTP::Response::Body](http://www.rubydoc.info/gems/http/HTTP/Response/Body), which can be streamed.
+
+```ruby
+response = client.create_image from_image: 'busybox'
+puts response
+```
+
+```ruby
+response = client.create_image(from_image: 'busybox')
+while body = response.readpartial(1024)
+  puts body
+end
+```
+
+Authenticating in a third party docker registry, you must provide a AuthObject.
+
+Example with gcr, [service account](https://cloud.google.com/container-registry/docs/advanced-authentication) :
+
+```ruby
+
+x_registry_auth = {
+  username: '_json_key',
+  password: File.new('./path/to/service-account.json'),
+  email: 'email@email.com',
+  serveraddress: 'https://gcr.io'
+}
+
+response = client.create_image(from_image: 'gcr.io/private/repo/image', x_registry_auth: x_registry_auth)
+puts response
+
+```
+
+#### remove_image
+
+returns an Array of hashes containing information about the deleted image
+
+```ruby
+response = client.remove_image(name: 'busybox')
+=> [{:untagged=>"busybox:latest"}, {:deleted=>"sha256:efe10ee6727fe52d2db2eb5045518fe98d8e31fdad1cbdd5e1f737018c349ebb"}]
+```
+
+Force delete
+
+```ruby
+response = client.remove_image(name: 'busybox', force: true)
+=> [{:untagged=>"busybox:latest"}, {:deleted=>"sha256:efe10ee6727fe52d2db2eb5045518fe98d8e31fdad1cbdd5e1f737018c349ebb"}]
+```
+
+#### inspect_image
+
+returns a Hash containing information about the inspected image
+
+```ruby
+info = client.inspect_image(id: 'busybox')
+puts info
+```
+
+## Containers API
+
+#### create_container
+
+Return a hash containing downcased symbolized container info.
+
+```ruby
+res = client.create_container name: 'nginx-c', image: 'nginx', labels: { sh_hyper_instancetype: 'm1' }
+```
+
+With hostname
+
+```ruby
+res = client.create_container name: 'nginx-c', image: 'nginx', hostname: 'nginx-hostname'
+```
+
+With custom cmd
+
+```ruby
+res = client.create_container name: 'nginx-c', image: 'nginx', cmd: "echo 'something'"
+```
+
+With custom entrypoint
+
+```ruby
+res = client.create_container name: 'nginx-c', image: 'nginx', hostname: 'hostny', entrypoint: './entrypoint.sh'
+```
+
+With custom mounts
+
+```ruby
+res = client.create_container name: 'nginx-c', image: 'nginx', mounts: ['./path/to/mount']'
+```
+
+With custom network mode
+
+```ruby
+res = client.create_container name: 'nginx-c', image: 'nginx', networkmode: 'bridge'
+```
+
+Exposing ports
+
+```ruby
+res = client.create_container name: 'nginx-c', image: 'nginx', exposedports: { '22/tcp': {} }
+```
+
+#### start_container
+
+```ruby
+client.start_container id: 'nginx'
+```
+
+#### stop_container
+
+```ruby
+client.stop_container id: 'nginx'
+```
+
+```ruby
+client.stop_container id: 'nginx', t: 30
+```
+
+#### remove_container
+
+Simple remove
+
+```ruby
+client.remove_container id: 'nginx'
+```
+
+Force remove, and remove all attached volumes.
+
+```ruby
+client.remove_container id: 'nginx', force: true, v: true
+```
+
+#### inspect_container
+
+Return a hash containing downcased symbolized container info.
+
+```ruby
+data = client.inspect_container id: 'rails-server'
+puts data
+```
+
+Include size information
+
+```ruby
+data = client.inspect_container id: 'rails-server', size: true
+puts data
+```
+
+#### container_logs
+
+Returns a streamable [HTTP:Response::Body](http://www.rubydoc.info/gems/http/HTTP/Response/Body) object
+
+Simple logs
+
+```ruby
+logs = client.container_logs id: 'rails-server', stderr: true, stdout: true, tail: 100
+puts logs
+```
+
+Streaming
+
+```ruby
+logs = client.container_logs id: 'rails-server', stdout: true, follow: true
+
+while body = logs.readpartial(1024)
+  puts body
+end
+```
+
+Include size information
+
+```ruby
+data = client.inspect_container id: 'rails-server', size: true
+puts data
+```
+
+#### container_stats
+
+Returns a streamable [HTTP:Response::Body](http://www.rubydoc.info/gems/http/HTTP/Response/Body) object
+
+Get stats at the time of the request
+
+```ruby
+stats = client.container_stats id: 'django-server'
+puts stats
+```
+
+Streaming stats at real time
+
+```ruby
+logs = client.container_logs id: 'rails-server', stream: true
+
+while body = logs.readpartial(1024)
+  puts body
+end
+```
+
+#### kill_container
+
+```ruby
+client.kill_container id: 'django-server'
+```
+
+```ruby
+client.kill_container id: 'django-server', signal: 'sigterm'
+```
+
+#### rename_container
+
+```ruby
+client.rename_container id: 'django-server', name: 'its-actually-a-rails-server'
+```
+
+## Volumes API
+
+#### remove_volume
+
+```ruby
+client.remove_volume id: 'volume-name'
+```
+
+#### inspect_volume
+
+Return a Hash of downcase symbolized json response.
+
+```ruby
+volume_info = client.inspect_volume id: 'volume-id'
+puts volume_info
+```
+
+#### volumes
+
+returns an Array of Hyperb::Volume
+
+```ruby
+volumes = client.volumes
+puts volumes
+```
+
+## Network API
+
+#### fip_allocate
+
+Returns an array of allocated ips
+
+Allocate `count` ips.
+
+```ruby
+client.fip_allocate count: 1
+```
+
+#### fip_release
+
+```ruby
+client.fip_release ip: '8.8.8.8'
+```
+
+#### fips_ls
+
+Returns an array of floating ip objects
+
+```ruby
+client.fips_ls
+```
+
+#### fip_detach
+
+```ruby
+client.fip_detach container: 'nginx'
+```
+
+#### fip_attach
+
+```ruby
+client.fip_attach ip: '8.8.8.8', container: 'nginx'
+```
+
+## Events API
+
+wip
+
+## Compose API
+
+See [compose API examples](https://github.com/drish/hyperb/blob/master/examples/compose.md)
+
+## Services API
+
+#### create_service
+
+Returns a Hash of downcased symbolized json response
+
+```ruby
+options = {
+	name: 'srvc1', # required
+	image: 'nginx', # required
+	replicas: 1, # required
+	service_port: 80, # required
+	container_port: 80,
+	labels: { # required
+    'app': 'web1'
+  },
+	cmd: 'command',
+	entrypoint: 'entry.sh',
+	env: ['env=123', 'env2=456'],
+	protocol: 'https',
+	algorithm: 'roundrobin'
+}
+
+srvc = client.create_service(options)
+puts srvc
+````
+
+#### remove_service
+
+```ruby
+client.remove_service name: 'srvc1'
+````
+
+```ruby
+client.remove_service name: 'srvc1', keep: true
+````
+
+## Snapshot API
+
+Return hash containing snapshot information
+
+```ruby
+snapshot = client.create_snapshot name: 'snappy', volume: 'volumeId'
+```
+
+## Misc.
+
+#### Version
+
+```ruby
+client.version
+=> {
+  "Version"=>"Hyper.sh Public Service",
+  "ApiVersion"=>"1.23",
+  "GitCommit"=>"",
+  "GoVersion"=>"go1.8.1",
+  "Os"=>"linux",
+  "Arch"=>"amd64",
+  "KernelVersion"=>"4.0.0"
+}
+```