class Lisk::Client

A simple HTTP client connecting to a Lisk Core API node.

Attributes

active[RW]

Host and port of the API endpoint.

host[RW]

Host and port of the API endpoint.

port[RW]

Host and port of the API endpoint.

ssl[RW]

Host and port of the API endpoint.

Public Class Methods

new(host = "127.0.0.1", port = 7000) click to toggle source

Initializes the Lisk HTTP client and defaults to localhost port 7000.

# File lib/lisk/client.rb, line 15
def initialize host = "127.0.0.1", port = 7000
  @host = host
  @port = port
  @ssl = false
  if self.is_alive?
    @active = true
    return self
  else
    @active = false
    return nil
  end
end

Public Instance Methods

configure(host, port) click to toggle source

Allows reconfiguring of the Lisk HTTP client's host and port.

# File lib/lisk/client.rb, line 29
def configure host, port
  if not host.empty? or not port.empty?
    @host = host
    @port = port
    @ssl = false
    if self.is_alive?
      @active = true
      return self
    else
      @active = false
      return nil
    end
  else
    @active = false
    return nil
  end
end

is_alive?() click to toggle source

Get the status of last received block. Returns true if block was received in the past 120 seconds.

# File lib/lisk/client.rb, line 49
def is_alive?
  connected = self.query_get "loader/status/ping"
  @active = connected["success"]
end

method_missing(name, *args, &block) click to toggle source

Handles unimplemented methods

# File lib/lisk/client.rb, line 135
def method_missing name, *args, &block
  todo "#{self}::#{name} METHOD MISSING"
end

query_get(endpoint, params = nil) click to toggle source

Handles GET requests to the given Lisk Core API endpoint

# File lib/lisk/client.rb, line 55
def query_get endpoint, params = nil
  if not @ssl
    # fixme "#{self}::#{__method__} Allow HTTPS requests"
    begin
      node = ::Net::HTTP.new @host, @port
      uri = URI.parse "http://#{host}:#{port}/api/#{endpoint}"
      if not params.nil?
        uri.query = URI.encode_www_form params
      end
      request = ::Net::HTTP::Get.new uri
      response = node.request request
      @active = true
      result = JSON::parse response.body
    rescue Timeout::Error => e
      @active = false
      p "Can't connect to the Lisk node: Timeout!"
    rescue Errno::EHOSTUNREACH => e
      @active = false
      p "Can't connect to the Lisk node: Host Unreachable!"
    rescue Errno::ECONNREFUSED => e
      @active = false
      p "Can't connect to the Lisk node: Connection Refused!"
    end
  end
end

query_post(endpoint, params) click to toggle source

Handles POST requests to the given Lisk Core API endpoint

# File lib/lisk/client.rb, line 82
def query_post endpoint, params
  if not @ssl
    # fixme "#{self}::#{__method__} Allow HTTPS requests"
    begin
      node = ::Net::HTTP.new @host, @port
      header = {'Content-Type': 'application/json'}
      uri = URI.parse "http://#{host}:#{port}/api/#{endpoint}"
      request = ::Net::HTTP::Post.new uri, header
      request.body = params.to_json
      response = node.request request
      @active = true
      result = JSON::parse response.body
    rescue Timeout::Error => e
      @active = false
      p "Can't connect to the Lisk node: Timeout!"
    rescue Errno::EHOSTUNREACH => e
      @active = false
      p "Can't connect to the Lisk node: Host Unreachable!"
    rescue Errno::ECONNREFUSED => e
      @active = false
      p "Can't connect to the Lisk node: Connection Refused!"
    end
  end
end

query_put(endpoint, params) click to toggle source

Handles PUT requests to the given Lisk Core API endpoint

# File lib/lisk/client.rb, line 108
def query_put endpoint, params
  if not @ssl
    # fixme "#{self}::#{__method__} Allow HTTPS requests"
    begin
      node = ::Net::HTTP.new @host, @port
      header = {'Content-Type': 'application/json'}
      uri = URI.parse "http://#{host}:#{port}/api/#{endpoint}"
      uri.query = URI.encode_www_form params
      request = ::Net::HTTP::Put.new uri, header
      request.body = params.to_json
      response = node.request request
      @active = true
      result = JSON::parse response.body
    rescue Timeout::Error => e
      @active = false
      p "Can't connect to the Lisk node: Timeout!"
    rescue Errno::EHOSTUNREACH => e
      @active = false
      p "Can't connect to the Lisk node: Host Unreachable!"
    rescue Errno::ECONNREFUSED => e
      @active = false
      p "Can't connect to the Lisk node: Connection Refused!"
    end
  end
end