hyperb 0.2.1 → 0.2.2

data/examples/auth-gcr-registry.md

@@ -0,0 +1,19 @@
+## Authenticating in GCR
+
+Assuming you already setup google cloud and you have in hands a [service account](https://cloud.google.com/container-registry/docs/advanced-authentication)
+
+Example:
+
+```ruby
+
+x_registry_auth = {
+  username: '_json_key',
+  password: File.new('./path/to/service-account.json'),
+  email: 'email@email.com',
+  serveraddress: 'https://gcr.io'
+}
+
+image = client.create_image(from_image: 'gcr.io/private/repo/image', x_registry_auth)
+puts image
+
+```

data/examples/compose.md

@@ -0,0 +1,75 @@
+## Usage examples of compose
+
+Assuming you already configured your client.
+
+All compose methods returns a streamable [HTTP::Response::Body]() object
+
+**Create a Hash representing a [compose file](https://docs.hyper.sh/Reference/compose_file_ref.html) services block**
+
+```ruby
+services = {
+  'db': {
+    'environment': [
+      "MYSQL_ROOT_PASSWORD=my-secret-pw"
+    ],
+    'external_links': nil,
+    'image': 'mysql:latest'
+  },
+  'web': {
+    'depends_on': [
+			'db'
+		],
+		'external_links': nil,
+		'image': 'wordpress:latest',
+		'links': ['db:mysql']
+	}
+}
+```
+
+after setting up a service hash, you may use up, or create.
+
+```ruby
+up = client.compose_up project: 'wp', serviceconfigs: services
+
+while body = up.readpartial(1024)
+	puts body
+end
+
+create = client.compose_create project: 'wp2', serviceconfigs: services
+create = client.compose_create project: 'wp2', serviceconfigs: services, norecreate: true
+create = client.compose_create project: 'wp2', serviceconfigs: services, forcerecreate: true
+
+while body = create.readpartial(1024)
+	puts body
+end
+```
+
+**Stoping and removing a compose project (down)**
+
+```ruby
+client.compose_down project: 'wp'
+```
+
+```ruby
+client.compose_down project: 'wp', rmi: true
+```
+
+```ruby
+client.compose_down project: 'wp', rmorphans: true
+```
+
+```ruby
+client.compose_down project: 'wp', vol: true
+```
+
+**Deleting a compose project**
+
+```ruby
+client.compose_rm project: 'wp'
+```
+
+**remove all attached volumes**
+
+```ruby
+client.compose_rm project: 'wp', rmvol: true
+```

data/examples/handling-errors.md

@@ -0,0 +1,54 @@
+## Handling errors
+
+Hyperb has set of exceptions representing Hyper.sh errors.
+
+#### Hyperb::Errors::Unauthorized
+
+raised when credentials are invalid
+
+#### Hyperb::Errors::NotFound
+
+raised when resource can't be found
+
+#### Hyperb::Errors::InternalServerError
+
+raised when hyper.sh server returns 500
+
+#### Hyperb::Errors::Conflict
+
+usually when a container or image can't be deleted or stopped for some reason.
+
+#### Hyperb::Errors::NotModified
+
+usually when a container can't be stopped because it was already stopped.
+
+Examples:
+
+```ruby
+
+begin
+  stats = client.container_stats id: 'nginxy', stream: true
+
+  while body = stats.readpartial(1024)
+    puts body
+  end
+
+rescue Exception => e
+  puts 'got something'
+  puts e.message
+end
+```
+
+```ruby
+
+begin
+  stats = client.container_stats id: 'nginxy', stream: true
+
+  while body = stats.readpartial(1024)
+    puts body
+  end
+
+rescue Hyperb::Errors::NotFound => e
+  puts 'container not found'
+end
+```

data/examples/streaming-logs.md

@@ -0,0 +1,28 @@
+## Streaming container_logs
+
+Assuming you already configured your client, and you have a running container.
+
+Hyperb uses [httprb](https://github.com/httprb/http) as the underlying http client, it supports streaming by default,
+by calling the `readpartial`
+
+For continuous streaming of the logs, use `follow: true`
+
+Example:
+
+```ruby
+
+logs = client.container_logs id: 'nginx', stdout: true, stderr: true, follow: true
+
+while body = logs.readpartial(1024)
+  puts body
+end
+
+```
+
+```ruby
+
+logs = client.container_logs id: 'nginx', stdout: true, stderr: true, tail: 30
+
+puts logs
+
+```

data/examples/streaming-stats.md

@@ -0,0 +1,25 @@
+## Streaming container_stats
+
+Assuming you already configured your client, and you have a running container.
+
+For continuous streaming of the stats, use `stream: true`
+
+Examples:
+
+```ruby
+# stream by default
+stats = client.container_stats id: 'nginx'
+
+while body = stats.readpartial(1024)
+  puts body
+end
+
+```
+
+```ruby
+
+stats = client.container_stats id: 'nginx', stream: false
+
+puts stats
+
+```

data/hyperb.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hyperb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hyperb'
+  spec.version       = Hyperb::VERSION
+  spec.authors       = ['drish']
+  spec.email         = ['carlosderich@gmail.com']
+
+  spec.description   = %q{The Hyper.sh Ruby Gem}
+  spec.homepage      = 'https://github.com/drish/hyperb'
+  spec.summary       = spec.description
+  spec.license       = 'MIT'
+
+  spec.require_paths = ['lib']
+  spec.files         = `git ls-files`.split("\n")
+
+  spec.add_dependency 'http', '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'webmock', '~> 3.0', '>= 3.0.1'
+  spec.add_development_dependency 'simplecov', '~> 0.9'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.10.4'
+
+  spec.required_ruby_version = '>= 2.2'
+end

data/lib/hyperb.rb

@@ -0,0 +1,4 @@
+require 'hyperb/version'
+require 'hyperb/client'
+require 'hyperb/auth_object'
+require 'hyperb/hyper_version'

data/lib/hyperb/api.rb

@@ -0,0 +1,22 @@
+require 'hyperb/images/images'
+require 'hyperb/containers/containers'
+require 'hyperb/snapshots/snapshots'
+require 'hyperb/services/services'
+require 'hyperb/volumes/volumes'
+require 'hyperb/network/fips'
+require 'hyperb/compose/compose'
+require 'hyperb/hyper_version'
+
+module Hyperb
+  # wrapper for apis
+  module API
+    include Hyperb::Images
+    include Hyperb::Containers
+    include Hyperb::Volumes
+    include Hyperb::HyperVersion
+    include Hyperb::Network
+    include Hyperb::Snapshots
+    include Hyperb::Services
+    include Hyperb::Compose
+  end
+end

data/lib/hyperb/auth_object.rb

@@ -0,0 +1,42 @@
+require 'base64'
+
+module Hyperb
+  # helper for managing auth objects
+  # used to authenticate into third party docker registries
+  class AuthObject
+    attr_accessor :username, :password, :email, :serveraddress
+
+    def initialize(options = {})
+      @username = options[:username] || ''
+      @email = options[:email] || ''
+      @serveraddress = options[:serveraddress] || ''
+      @password = options[:password].is_a?(File) ? options[:password].read : options[:password]
+    end
+
+    # preserve this order
+    def attrs
+      {
+        username: username,
+        password: password,
+        email: email,
+        serveraddress: serveraddress
+      }
+    end
+
+    def valid?
+      attrs.values.none? { |atr| blank?(atr) }
+    end
+
+    def blank?(val)
+      val.respond_to?(:empty?) ? val.empty? : !val
+    end
+
+    def encode
+      Base64.urlsafe_encode64(attrs.to_json)
+    end
+
+    def build
+      { x_registry_auth: encode }
+    end
+  end
+end

data/lib/hyperb/client.rb

@@ -0,0 +1,32 @@
+require 'hyperb/api'
+
+module Hyperb
+  # client class
+  class Client
+    include Hyperb::API
+
+    attr_accessor :secret_key, :access_key
+
+    def initialize(options = {})
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+      yield(self) if block_given?
+    end
+
+    def credentials
+      {
+        secret_key: secret_key,
+        access_key: access_key
+      }
+    end
+
+    def credentials?
+      credentials.values.none? { |cred| blank?(cred) }
+    end
+
+    def blank?(val)
+      val.respond_to?(:empty?) ? val.empty? : !val
+    end
+  end
+end

data/lib/hyperb/compose/compose.rb

@@ -0,0 +1,116 @@
+require 'hyperb/request'
+require 'hyperb/utils'
+require 'hyperb/auth_object'
+require 'json'
+require 'uri'
+require 'base64'
+
+module Hyperb
+  # compose api wrapper
+  module Compose
+    include Hyperb::Utils
+
+    # stop and remove a compose project
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Compose/compose_down.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::NotFound] raised ips are not found.
+    #
+    # @returns [HTTP::Response::Body] a streamable response object
+    #
+    # @param params [Hash] A customizable set of params.
+    # @option params [String] :project project name
+    # @option params [Boolean] :rmorphans rm containers for services not defined in the compose file
+    # @option params [String] :rmi remove images, all/local
+    # @option params [Boolean] :vol remove data volumes
+    def compose_down(params = {})
+      raise ArgumentError, 'Invalid arguments.' unless check_arguments(params, 'project')
+      path = '/compose/down'
+      query = {}
+      query[:project] = params[:project] if params.key?(:project)
+      query[:vol] = params[:vol] if params.key?(:vol)
+      query[:rmi] = params[:rmi] if params.key?(:rmi)
+      query[:rmorphans] = params[:rmorphans] if params.key?(:rmorphans)
+      Hyperb::Request.new(self, path, query, 'post').perform
+    end
+
+    # remove a compose project
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Compose/compose_rm.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::NotFound] raised ips are not found.
+    #
+    # @returns [HTTP::Response::Body] a streamable response object
+    #
+    # @param params [Hash] A customizable set of params.
+    # @option params [String] :project project name
+    # @option params [String] :rmvol project name
+    def compose_rm(params = {})
+      raise ArgumentError, 'Invalid arguments.' unless check_arguments(params, 'project')
+      path = '/compose/rm'
+      query = {}
+      query[:project] = params[:project] if params.key?(:project)
+      query[:rmvol] = params[:rmvol] if params.key?(:rmvol)
+      Hyperb::Request.new(self, path, query, 'post').perform
+    end
+
+    # create and run a compose project
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Compose/compose_up.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::NotFound] raised ips are not found.
+    #
+    # @returns [HTTP::Response::Body] a streamable response object
+    #
+    # @param params [Hash] A customizable set of params.
+    # @option params [String] :project project name
+    # @option params [Hash] :serviceconfigs a hash representing a docker compose file services block
+    # @option params [Hash] :networkconfigs
+    # @option params [Hash] :volumeconfigs
+    def compose_up(params = {})
+      raise ArgumentError, 'Invalid arguments.' unless check_arguments(params, 'project')
+      path = '/compose/up'
+      query = {}
+      body = {}
+      query[:project] = params[:project] if params.key?(:project)
+
+      body[:serviceconfigs] = { 'M': {} } # inherited from libcompose
+      body[:serviceconfigs][:M] = params[:serviceconfigs] if params.key?(:serviceconfigs)
+      params.delete(:serviceconfigs)
+      body.merge!(params)
+      Hyperb::Request.new(self, path, query, 'post', body).perform
+    end
+
+    # create a compose project
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/
+    # Compose/compose_create.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::NotFound] raised ips are not found.
+    #
+    # @returns [HTTP::Response::Body] a streamable response object
+    #
+    # @param params [Hash] A customizable set of params.
+    # @option params [String] :project project name
+    # @option params [Hash] :serviceconfigs a hash representing a docker compose file services block
+    # @option params [Hash] :networkconfigs
+    # @option params [Hash] :volumeconfigs
+    def compose_create(params = {})
+      raise ArgumentError, 'Invalid arguments.' unless check_arguments(params, 'project')
+      path = '/compose/create'
+      query = {}
+      body = {}
+      query[:project] = params[:project] if params.key?(:project)
+
+      body[:serviceconfigs] = { 'M': {} } # inherited from libcompose
+      body[:serviceconfigs][:M] = params[:serviceconfigs]
+      params.delete(:serviceconfigs)
+      body.merge!(params)
+      Hyperb::Request.new(self, path, query, 'post', body).perform
+    end
+  end
+end