hyperb 0.2.1 → 0.2.2

data/lib/hyperb/containers/container.rb

@@ -0,0 +1,27 @@
+require 'hyperb/utils'
+
+module Hyperb
+  # container object
+  class Container
+    include Hyperb::Utils
+    attr_accessor :id, :names, :image, :imageid,
+                  :created, :command, :ports, :labels,
+                  :sizerw, :sizerootfs, :state, :hostconfig,
+                  :networksettings
+
+    def initialize(attrs = {})
+      attrs.each do |att, value|
+        value = downcase_symbolize(value) if value.is_a?(Hash)
+        instance_variable_set("@#{att.downcase.to_sym}", value)
+      end
+    end
+
+    def name
+      names.first
+    end
+
+    def running?
+      state == 'running'
+    end
+  end
+end

data/lib/hyperb/containers/containers.rb

@@ -0,0 +1,251 @@
+require 'hyperb/request'
+require 'hyperb/containers/container'
+require 'hyperb/utils'
+require 'json'
+require 'uri'
+require 'base64'
+
+module Hyperb
+  # wrapper for containers api
+  module Containers
+    include Hyperb::Utils
+
+    # list existing containers
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Container/list.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::InternalServerError] raised when 5xx is returned from hyper.
+    #
+    # @return [Hyperb::Container] Array of Hyperb::Container.
+    #
+    # @param params [Hash] A customizable set of params.
+    #
+    # @option params [Boolean] :all show all containers, false by default
+    # @option params [Boolean] :size show containers size
+    # @option params [String] :limit show `limit` last created containers.
+    # @option params [String] :since show only containers created since Id.
+    # @option params [String] :before only containers created before Id.
+    # TODO: @option params [Hash] :filters JSON encoded value of the filters.
+    def containers(params = {})
+      path = '/containers/json'
+      query = {}
+      query.merge!(params)
+      response = JSON.parse(Hyperb::Request.new(self, path, query, 'get').perform)
+      response.map { |container| Hyperb::Container.new(container) }
+    end
+
+    # stop the container id
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Container/stop.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::NotFound] raised when container can't be found.
+    # @raise [Hyperb::Error::Conflict] raised when container is running and can't be removed.
+    # @raise [Hyperb::Error::InternalServerError] raised when a 5xx is returned.
+    #
+    # @param params [Hash] A customizable set of params.
+    #
+    # @option params [Boolean] :t number of seconds to wait before killing the container.
+    def stop_container(params = {})
+      raise ArgumentError, 'Invalid arguments.' unless check_arguments(params, 'id')
+      path = '/containers/' + params[:id] + '/stop'
+      query = {}
+      query[:t] = params[:t] if params.key?(:t)
+      Hyperb::Request.new(self, path, query, 'post').perform
+    end
+
+    # remove the container id
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Container/delete.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::NotFound] raised when container can't be found.
+    # @raise [Hyperb::Error::Conflict] raised when container is running and can't be removed.
+    # @raise [Hyperb::Error::InternalServerError] raised when a 5xx is returned.
+    #
+    # @return [Hash] downcased symbolized json response.
+    #
+    # @param params [Hash] A customizable set of params.
+    #
+    # @option params [Boolean] :v remove volumes attached. default false
+    # @option params [Boolean] :force force remove. default false
+    def remove_container(params = {})
+      raise ArgumentError, 'Invalid arguments.' unless check_arguments(params, 'id')
+      path = '/containers/' + params[:id]
+      query = {}
+      query[:v] = params[:v] if params.key?(:v)
+      query[:force] = params[:force] if params.key?(:force)
+      response = JSON.parse(Hyperb::Request.new(self, path, query, 'delete').perform)
+      downcase_symbolize(response)
+    end
+
+    # create a container
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Container/create.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::Conflict] raised container with the same name is already created.
+    # @raise [Hyperb::Error::InternalServerError] raised when a 5xx is returned
+    #
+    # @return [Hash] hash containing downcased symbolized json response.
+    #
+    # @param params [Hash] A customizable set of params.
+    #
+    # @option params [String] :name container name
+    # @option params [String] :image image to be used
+    # @option params [String] :hostname container hostname
+    # @option params [String] :entrypoint container entrypoint
+    # @option params [String] :cmd container command
+    # @option params [String] :user add user to container
+    # @option params [String] :workingdir working directory for commands to run in.
+    # @option params [Array] :mounts array of strings with mount directories.
+    # @option params [String] :networkmode network mode, ie 'bridge'.
+    # @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
+      body = { labels: { sh_hyper_instancetype: 's1' } }
+      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)
+    end
+
+    # inspect a container
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Container/inspect.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::NotFound] raised when the container can't be found.
+    # @raise [Hyperb::Error::InternalServerError] raised when 5xx is returned.
+    #
+    # @return [Hash] Array of downcased symbolized json response.
+    #
+    # @param params [Hash] A customizable set of params.
+    #
+    # @option params [String] :id container's name or id
+    # @option params [String] :size include container's size on response
+    def inspect_container(params = {})
+      raise ArgumentError, 'Invalid arguments.' unless check_arguments(params, 'id')
+      path = '/containers/' + params[:id] + '/json'
+      query = {}
+      query[:size] = params[:size] if params.key?(:size)
+      response = JSON.parse(Hyperb::Request.new(self, path, query, 'get').perform)
+      downcase_symbolize(response)
+    end
+
+    # start a container
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Container/start.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::NotFound] raised when the container can't be found.
+    # @raise [Hyperb::Error::BadRequest] raised when request is invalid.
+    # @raise [Hyperb::Error::InternalServerError] raised when a 5xx is returned.
+    #
+    # @param params [Hash] A customizable set of params.
+    # @option params [String] :id container's name or id
+    def start_container(params = {})
+      raise ArgumentError, 'Invalid arguments.' unless check_arguments(params, 'id')
+      path = '/containers/' + params[:id] + '/start'
+      Hyperb::Request.new(self, path, {}, 'post').perform
+    end
+
+    # container logs
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Container/logs.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::NotFound] raised when the container can't be found.
+    # @raise [Hyperb::Error::BadRequest] raised when request is invalid.
+    # @raise [Hyperb::Error::InternalServerError] raised when a 5xx is returned.
+    #
+    # @return [HTTP::Response::Body] a streamable http response body object
+    #
+    # @param params [Hash] A customizable set of params.
+    # @option params [String] :id container's name or id
+    # @option params [String] :follow stream output
+    # @option params [String] :stderr stream stderr
+    # @option params [String] :stdout stream stdout
+    # @option params [String] :since stream outputs since id
+    # @option params [String] :timestamps include timestamps on stdouts, default false
+    # @option params [String] :tail tail number
+    def container_logs(params = {})
+      raise ArgumentError, 'Invalid arguments.' unless check_arguments(params, 'id')
+      path = '/containers/' + params[:id] + '/logs'
+      query = {}
+      params.delete(:id)
+      query.merge!(params)
+      Hyperb::Request.new(self, path, query, 'get').perform
+    end
+
+    # container stats
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Container/logs.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::NotFound] raised when the container can't be found.
+    # @raise [Hyperb::Error::BadRequest] raised when request is invalid.
+    # @raise [Hyperb::Error::InternalServerError] raised when 5xx is returned.
+    #
+    # @return [HTTP::Response::Body] a streamable http response body object
+    #
+    # @param params [Hash] A customizable set of params.
+    # @option params [String] :id container's name or id
+    # @option params [String] :stream stream output
+    def container_stats(params = {})
+      raise ArgumentError, 'Invalid arguments.' unless check_arguments(params, 'id')
+      path = '/containers/' + params[:id] + '/stats'
+      query = {}
+      query[:stream] = params[:stream] if params.key?(:stream)
+      Hyperb::Request.new(self, path, query, 'get').perform
+    end
+
+    # kill a container
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Container/kill.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::NotFound] raised when the container can't be found.
+    # @raise [Hyperb::Error::InternalServerError] raised when 5xx is returned.
+    #
+    # @param params [Hash] A customizable set of params.
+    # @option params [String] :id container's name or id
+    # @option params [String] :signal stream output
+    def kill_container(params = {})
+      raise ArgumentError, 'Invalid arguments.' unless check_arguments(params, 'id')
+      path = '/containers/' + params[:id] + '/kill'
+      query = {}
+      query[:signal] = params[:signal] if params.key?(:signal)
+      Hyperb::Request.new(self, path, query, 'post').perform
+    end
+
+    # rename a container
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Container/rename.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::NotFound] raised when the container can't be found.
+    # @raise [Hyperb::Error::InternalServerError] raised when 5xx is returned.
+    #
+    # @param params [Hash] A customizable set of params.
+    # @option params [String] :id new name
+    # @option params [String] :name new name
+    def rename_container(params = {})
+      raise ArgumentError, 'Invalid arguments.' unless check_arguments(params, 'name', 'id')
+      path = '/containers/' + params[:id] + '/rename'
+      query = {}
+      query[:name] = params[:name] if params.key?(:name)
+      Hyperb::Request.new(self, path, query, 'post').perform
+    end
+  end
+end

data/lib/hyperb/error.rb

@@ -0,0 +1,44 @@
+module Hyperb
+  # representation of Hyper errors
+  class Error < StandardError
+    attr_reader :code, :msg
+
+    # 4xx HTTP status code
+    ClientError = Class.new(self)
+
+    # 5xx HTTP status code
+    ServerError = Class.new(self)
+
+    # hyper uses code 304 as a server representation for some operations
+    NotModified = Class.new(ClientError)
+
+    # code 400
+    BadRequest = Class.new(ClientError)
+
+    # code 401
+    Unauthorized = Class.new(ClientError)
+
+    # code 404
+    NotFound = Class.new(ClientError)
+
+    # code 409
+    Conflict = Class.new(ClientError)
+
+    # code 500
+    InternalServerError = Class.new(ServerError)
+
+    ERRORS = {
+      304 => Hyperb::Error::NotModified,
+      400 => Hyperb::Error::BadRequest,
+      401 => Hyperb::Error::Unauthorized,
+      404 => Hyperb::Error::NotFound,
+      409 => Hyperb::Error::Conflict,
+      500 => Hyperb::Error::InternalServerError
+    }.freeze
+
+    def initialize(msg, code)
+      super(msg)
+      @code = code
+    end
+  end
+end

data/lib/hyperb/hyper_version.rb

@@ -0,0 +1,12 @@
+require 'hyperb/request'
+require 'json'
+
+module Hyperb
+  # simple wrapper for the version endpoint
+  module HyperVersion
+    # returns current version of hyper.sh api
+    def version
+      JSON.parse(Hyperb::Request.new(self, '/version', {}, 'get').perform)
+    end
+  end
+end

data/lib/hyperb/images/image.rb

@@ -0,0 +1,13 @@
+module Hyperb
+  # image object
+  class Image
+    attr_accessor :id, :parent_id, :repo_tags, :repo_digests,
+                  :created, :size, :labels, :virtual_size
+
+    def initialize(attrs = {})
+      attrs.each do |k, v|
+        instance_variable_set("@#{k.downcase.to_sym}", v)
+      end
+    end
+  end
+end

data/lib/hyperb/images/images.rb

@@ -0,0 +1,108 @@
+require 'hyperb/images/image'
+require 'hyperb/request'
+require 'hyperb/utils'
+require 'hyperb/auth_object'
+require 'json'
+require 'uri'
+require 'base64'
+
+module Hyperb
+  # images api wrapper
+  module Images
+    include Hyperb::Utils
+    # list images
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Image/list.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    #
+    # @return [Hyperb::Image] Array of Images.
+    #
+    # @param params [Hash] A customizable set of params.
+    # @option params [String] :all default is true
+    # @option params [String] :filter only return image with the specified name
+    def images(params = {})
+      path = '/images/json'
+      query = {}
+      query[:all] = params[:all] || true
+      query[:filter] = params[:filter] if params.key?(:filter)
+      response = JSON.parse(Hyperb::Request.new(self, path, query, 'get').perform)
+      response.map { |image| Hyperb::Image.new(image) }
+    end
+
+    # create (pull) an image
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Image/create.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::InternalServerError] server error on hyper side.
+    # @raise [ArgumentError] when required arguments are not provided.
+    #
+    # @return [HTTP::Response::Body] a streamable response object.
+    #
+    # @param params [Hash] A customizable set of params.
+    #
+    # @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
+    def create_image(params = {})
+      raise ArgumentError, 'Invalid arguments.' unless check_arguments(params, 'from_image')
+      path = '/images/create'
+      query = { fromImage: params[:from_image] }
+      query[:tag] = params[:tag] if params.key?(:tag)
+      additional_headers = {}
+      if params.key?(:x_registry_auth)
+        auth = params[:x_registry_auth]
+        additional_headers[:x_registry_auth] = Hyperb::AuthObject.new(auth).encode
+      end
+      res = Hyperb::Request.new(self, path, query, 'post', '', additional_headers).perform
+      res
+    end
+
+    # remove an image
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Image/remove.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::NotFound] raised when tag is not found.
+    # @raise [Hyperb::Error::Conflict] raised when the image will only be removed with force.
+    # @raise [Hyperb::Error::InternalServerError] server error.
+    #
+    # @return [Array] array of downcase symbolized json response.
+    #
+    # @param params [Hash] A customizable set of params.
+    # @option params [String] :name image name to be removed
+    # @option params [Boolean] :force force image to be removed
+    def remove_image(params = {})
+      path = '/images/' + params[:name]
+      query = {}
+      query[:force] = true if params.key?(:force)
+      res = JSON.parse(Hyperb::Request.new(self, path, query, 'delete').perform)
+      downcase_symbolize(res)
+    end
+
+    # inspect an image
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Image/inspect.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::NotFound] raised when tag is not found.
+    # @raise [Hyperb::Error::InternalServerError] server error on hyper side.
+    #
+    # @return [Hash] downcased symbolized `inspect` json response.
+    #
+    # @param params [Hash] A customizable set of params.
+    # @option params [String] :name image name to be removed
+    def inspect_image(params = {})
+      path = '/images/' + params[:name] + '/json'
+      res = JSON.parse(Hyperb::Request.new(self, path, {}, 'get').perform)
+      downcase_symbolize(res)
+    end
+  end
+end