hyperb 0.2.1 → 0.2.2

data/lib/hyperb/network/fips.rb

@@ -0,0 +1,102 @@
+require 'hyperb/request'
+require 'hyperb/utils'
+require 'hyperb/auth_object'
+require 'json'
+require 'uri'
+require 'base64'
+
+module Hyperb
+  # network api wrapper
+  module Network
+    include Hyperb::Utils
+
+    # detach a floating ip from a container
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Network/fip_detach.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::NotFound] raised when container is found.
+    #
+    # @param params [Hash] A customizable set of params.
+    # @option params [String] :container container name/id
+    def fip_detach(params = {})
+      raise ArgumentError, 'Invalid Arguments' unless check_arguments(params, 'container')
+      path = '/fips/detach'
+      query = {}
+      query[:container] = params[:container] if params.key?(:container)
+      Hyperb::Request.new(self, path, query, 'post').perform
+    end
+
+    # attach a floating ip to a container
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Network/fip_attach.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::NotFound] raised when ip are not found.
+    #
+    # @param params [Hash] A customizable set of params.
+    # @option params [String] :ip
+    # @option params [String] :container
+    def fip_attach(params = {})
+      raise ArgumentError, 'Invalid Arguments' unless check_arguments(params, 'container', 'ip')
+      path = '/fips/attach'
+      query = {}
+      query[:ip] = params[:ip] if params.key?(:ip)
+      query[:container] = params[:container] if params.key?(:container)
+      Hyperb::Request.new(self, path, query, 'post').perform
+    end
+
+    # list floating ips
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Network/fip_ls.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::NotFound] raised when ips are not found.
+    #
+    # @returns [Array] array of downcased symbolized has
+    #
+    # @param params [Hash] A customizable set of params.
+    # @option params [String] :filters
+    def fips_ls(params = {})
+      path = '/fips'
+      query = {}
+      query[:filters] = params[:filters] if params.key?(:filters)
+      downcase_symbolize(JSON.parse(Hyperb::Request.new(self, path, query, 'get').perform))
+    end
+
+    # release a floating ip
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Network/fip_release.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::NotFound] raised when ips are not found.
+    #
+    # @param params [Hash] A customizable set of params.
+    # @option params [String] :ip the number of free fips to allocate
+    def fip_release(params = {})
+      path = '/fips/release'
+      query = {}
+      query[:ip] = params[:ip] if params.key?(:ip)
+      Hyperb::Request.new(self, path, query, 'post').perform
+    end
+
+    # allocate a new floating ip
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Network/fip_allocate.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    #
+    # @return [Array] Array of ips (string).
+    #
+    # @param params [Hash] A customizable set of params.
+    # @option params [String] :count the number of free fips to allocate
+    def fip_allocate(params = {})
+      raise ArgumentError, 'Invalid Arguments' unless check_arguments(params, 'count')
+      path = '/fips/allocate'
+      query = {}
+      query[:count] = params[:count] if params.key?(:count)
+      fips = JSON.parse(Hyperb::Request.new(self, path, query, 'post').perform)
+      fips
+    end
+  end
+end

data/lib/hyperb/request.rb

@@ -0,0 +1,129 @@
+require 'hyperb/error'
+require 'openssl'
+require 'time'
+require 'uri'
+require 'http'
+require 'digest'
+require 'json'
+
+module Hyperb
+  # wraps all requests, performing aws4 signature
+  class Request
+    FMT = '%Y%m%dT%H%M%SZ'.freeze
+    VERSION = 'v1.23'.freeze
+    HOST = 'us-west-1.hyper.sh'.freeze
+    REGION = 'us-west-1'.freeze
+    SERVICE = 'hyper'.freeze
+    ALGORITHM = 'HYPER-HMAC-SHA256'.freeze
+    KEYPARTS_REQUEST = 'hyper_request'.freeze
+    BASE_URL = ('https://' + HOST + '/').freeze
+
+    attr_accessor :verb, :path, :client, :date, :headers, :signed
+
+    def initialize(client, path, query = {}, verb = 'GET', body = '', optional_headers = {})
+      @client = client
+      @path = VERSION + path
+      @query = URI.encode_www_form(query)
+      @body = body.empty? ? body : body.to_json
+      @hashed_body = hexdigest(@body)
+      @verb = verb.upcase
+      @date = Time.now.utc.strftime(FMT)
+      @headers = {
+        content_type: 'application/json',
+        x_hyper_date: @date,
+        host: HOST,
+        x_hyper_content_sha256: @hashed_body
+      }
+      @headers.merge!(optional_headers) unless optional_headers.empty?
+      @signed = false
+    end
+
+    def perform
+      sign unless signed
+      final = BASE_URL + @path + '?' + @query
+      options = {}
+      options[:body] = @body unless @body.empty?
+      response = HTTP.headers(@headers).public_send(@verb.downcase.to_sym, final, options)
+      fail_or_return(response.code, response.body)
+    end
+
+    def fail_or_return(code, body)
+      error = Hyperb::Error::ERRORS[code]
+      raise(error.new(body, code)) if error
+      body
+    end
+
+    # join all headers by `;`
+    # ie:
+    # content-type;x-hyper-hmac-sha256
+    def signed_headers
+      @headers.keys.sort.map { |header| header.to_s.tr('_', '-') }.join(';')
+    end
+
+    # sorts all headers, join them by `:`, and re-join by \n
+    # ie:
+    # content-type:application\nhost:us-west-1.hyper.sh
+    def canonical_headers
+      canonical = @headers.sort.map do |header, value|
+        "#{header.to_s.tr('_', '-')}:#{value}"
+      end
+      canonical.join("\n") + "\n"
+    end
+
+    # creates Authoriatization header
+    def sign
+      credential = "#{@client.access_key}/#{credential_scope}"
+      auth = "#{ALGORITHM} Credential=#{credential}, "
+      auth += "SignedHeaders=#{signed_headers}, "
+      auth += "Signature=#{signature}"
+      @headers[:authorization] = auth
+      @signed = true
+    end
+
+    # setup signature key
+    # https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/index.html
+    def signature
+      k_date = hmac('HYPER' + @client.secret_key, @date[0, 8])
+      k_region = hmac(k_date, REGION)
+      k_service = hmac(k_region, SERVICE)
+      k_credentials = hmac(k_service, KEYPARTS_REQUEST)
+      hexhmac(k_credentials, string_to_sign)
+    end
+
+    def string_to_sign
+      [ALGORITHM, @date, credential_scope, hexdigest(canonical_request)].join("\n")
+    end
+
+    def canonical_request
+      [
+        @verb,
+        @path,
+        @query,
+        canonical_headers,
+        signed_headers,
+        @hashed_body
+      ].join("\n")
+    end
+
+    def credential_scope
+      [
+        @date[0, 8],
+        REGION,
+        SERVICE,
+        KEYPARTS_REQUEST
+      ].join("/") # rubocop:disable StringLiterals
+    end
+
+    def hexdigest(value)
+      Digest::SHA256.new.update(value).hexdigest
+    end
+
+    def hmac(key, value)
+      OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), key, value)
+    end
+
+    def hexhmac(key, value)
+      OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), key, value)
+    end
+  end
+end

data/lib/hyperb/services/services.rb

@@ -0,0 +1,59 @@
+require 'hyperb/request'
+require 'hyperb/utils'
+require 'json'
+require 'uri'
+require 'base64'
+
+module Hyperb
+  # services module
+  module Services
+    include Hyperb::Utils
+
+    # create a service
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Service/create.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    #
+    # @return [Hash] Hash containing service information.
+    #
+    # @param params [Hash] A customizable set of params.
+    # @param params image [String] service name
+    # @param params name [String] image name
+    # @param params replicas [Fixnum] numer of replicas
+    # @param params service_port [Fixnum] service port
+    # @param params container_port [Fixnum] container port
+    # @param params labels [Hash] hash containing labels
+    # @param params entrypoint [String] entrypoint
+    # @param params cmd [String] command
+    # @param params env [Array] array of envs ["env=value", ["env2=value"]]
+    # @param params algorithm [String] algorithm of the service, 'roundrobin', 'leastconn'
+    # @param params protocol [String] prot
+    # @param params workingdir [String] working directory
+    def create_service(params = {})
+      valid = check_arguments(params, 'name', 'image', 'replicas', 'service_port', 'labels')
+      raise ArgumentError, 'Invalid arguments.' unless valid
+      path = '/services/create'
+      body = {}
+      body.merge!(params)
+      downcase_symbolize(JSON.parse(Hyperb::Request.new(self, path, {}, 'post', body).perform))
+    end
+
+    # remove service
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Service/remove.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::NotFound] raised service is not found.
+    #
+    # @param params [Hash] A customizable set of params.
+    # @option params [String] :keep if true, keep containers running while removing the service.
+    def remove_service(params = {})
+      raise ArgumentError, 'Invalid arguments.' unless check_arguments(params, 'name')
+      path = '/services/' + params[:name]
+      query = {}
+      query[:keep] = params[:keep] if params.key?(:keep)
+      Hyperb::Request.new(self, path, query, 'delete').perform
+    end
+  end
+end

data/lib/hyperb/snapshots/snapshot.rb

@@ -0,0 +1,12 @@
+module Hyperb
+  # snapshot object
+  class Snapshot
+    attr_accessor :id, :name, :size, :volume
+
+    def initialize(attrs = {})
+      attrs.each do |k, v|
+        instance_variable_set("@#{k.downcase.to_sym}", v)
+      end
+    end
+  end
+end

data/lib/hyperb/snapshots/snapshots.rb

@@ -0,0 +1,39 @@
+require 'hyperb/snapshots/snapshot'
+require 'hyperb/request'
+require 'hyperb/utils'
+require 'hyperb/auth_object'
+require 'json'
+require 'uri'
+require 'base64'
+
+module Hyperb
+  # snapshots api wrapper
+  module Snapshots
+    include Hyperb::Utils
+
+    # create a snapshot
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Snapshot/create.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::InternalServerError] server error on hyper side.
+    # @raise [Hyperb::Error::NotFound] raised when volume is not found.
+    # @raise [ArgumentError] when required arguments are not provided.
+    #
+    # @return [Hash] symbolized json response.
+    #
+    # @param params [Hash] A customizable set of params.
+    #
+    # @option params [String] :volume volume id
+    # @option params [String] :name snapshot's name
+    def create_snapshot(params = {})
+      raise ArgumentError, 'Invalid arguments.' unless check_arguments(params, 'name', 'volume')
+      path = '/snapshots/create'
+      query = {}
+      query[:name] = params[:name] if params.key?(:name)
+      query[:volume] = params[:volume] if params.key?(:volume)
+      res = JSON.parse(Hyperb::Request.new(self, path, query, 'post').perform)
+      downcase_symbolize(res)
+    end
+  end
+end

data/lib/hyperb/utils.rb

@@ -0,0 +1,39 @@
+module Hyperb
+  # utils functions
+  module Utils
+    # checks if all args are keys into the hash
+    #
+    # @return [Boolean]
+    #
+    # @param params [Hash] hash to check.
+    # @option *args [String] array of strings to check against the hash
+    def check_arguments(params, *args)
+      contains = true
+      args.each do |arg|
+        contains = false unless params.key? arg.to_sym
+      end
+      contains
+    end
+
+    # hyper.sh responses are capital cased json
+    #
+    # {"Field": "value"}
+    #
+    # this fn is used to symbolize and downcase all hyper.sh api reponses
+    def downcase_symbolize(obj)
+      if obj.is_a? Hash
+        return obj.each_with_object({}) do |(k, v), memo|
+          memo.tap { |m| m[k.downcase.to_sym] = downcase_symbolize(v) }
+        end
+      end
+
+      if obj.is_a? Array
+        return obj.each_with_object([]) do |v, memo|
+          memo << downcase_symbolize(v)
+          memo
+        end
+      end
+      obj
+    end
+  end
+end

data/lib/hyperb/version.rb

@@ -0,0 +1,3 @@
+module Hyperb
+  VERSION = '0.2.2'.freeze
+end

data/lib/hyperb/volumes/volume.rb

@@ -0,0 +1,16 @@
+require 'hyperb/utils'
+
+module Hyperb
+  # volume object
+  class Volume
+    include Hyperb::Utils
+    attr_accessor :name, :driver, :mountpoint, :labels
+
+    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
+  end
+end

data/lib/hyperb/volumes/volumes.rb

@@ -0,0 +1,67 @@
+require 'hyperb/request'
+require 'hyperb/utils'
+require 'hyperb/volumes/volume'
+require 'json'
+require 'uri'
+require 'base64'
+
+module Hyperb
+  # volumes module
+  module Volumes
+    include Hyperb::Utils
+
+    # list volumes
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Volume/list.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    #
+    # @return [Hyperb::Volume] Array of Hyperb::Volume.
+    #
+    # @param params [Hash] A customizable set of params.
+    # TODO: @option params [String] :filters JSON encoded value of the filters
+    # TODO: @option params filters [Boolean] :dangling
+    def volumes(params = {})
+      path = '/volumes'
+      query = {}
+      query[:filters] = params[:filters] if params.key?(:filters)
+      response = JSON.parse(Hyperb::Request.new(self, path, query, 'get').perform)
+
+      # hyper response atm comes inside a Volumes: [], unlike the images API
+      # which is returned in a []
+      response['Volumes'].map { |vol| Hyperb::Volume.new(vol) }
+    end
+
+    # remove volume
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Volume/remove.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    #
+    # @param params [Hash] A customizable set of params.
+    # @option params [String] :id volume id or name
+    # @option params [String] :all default is true
+    # @option params [String] :filter only return image with the specified name
+    def remove_volume(params = {})
+      raise ArgumentError, 'Invalid arguments.' unless check_arguments(params, 'id')
+      path = '/volumes/' + params[:id]
+      Hyperb::Request.new(self, path, {}, 'delete').perform
+    end
+
+    # inspect a volume
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Volume/inspect.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    #
+    # @return [Hash] of downcase symbolized json response.
+    #
+    # @param params [Hash] A customizable set of params.
+    # @option params [String] :id volume id or name
+    def inspect_volume(params = {})
+      raise ArgumentError, 'Invalid arguments.' unless check_arguments(params, 'id')
+      path = '/volumes/' + params[:id]
+      downcase_symbolize(JSON.parse(Hyperb::Request.new(self, path, {}, 'get').perform))
+    end
+  end
+end