Module: Urbit

Defined in:

lib/urbit.rb,
lib/urbit/api.rb,
lib/urbit/fact.rb,
lib/urbit/link.rb,
lib/urbit/node.rb,
lib/urbit/ship.rb,
lib/urbit/graph.rb,
lib/urbit/group.rb,
lib/urbit/links.rb,
lib/urbit/bucket.rb,
lib/urbit/config.rb,
lib/urbit/groups.rb,
lib/urbit/parser.rb,
lib/urbit/channel.rb,
lib/urbit/message.rb,
lib/urbit/setting.rb,
lib/urbit/version.rb,
lib/urbit/receiver.rb,
lib/urbit/settings.rb,
lib/urbit/ack_message.rb,
lib/urbit/chat_channel.rb,
lib/urbit/group_parser.rb,
lib/urbit/poke_message.rb,
lib/urbit/close_message.rb,
lib/urbit/fact/base_fact.rb,
lib/urbit/fact/graph_fact.rb,
lib/urbit/fact/group_fact.rb,
lib/urbit/subscribe_message.rb,
lib/urbit/fact/metadata_fact.rb,
lib/urbit/fact/settings_fact.rb

Overview

This is the main namespace for Urbit.

It provides a method to create Ship objects.

Examples:

Helpful class method ‘.new` to create Ship objects.

ship = Urbit.new(port: 80)
conn.get '/'

Defined Under Namespace

Modules: Api, Fact Classes: AckMessage, AddGraphParser, AddGroupParser, AddNodesParser, Bucket, ChangeMemberParser, ChangeTagParser, Channel, ChatChannel, CloseMessage, Config, Graph, GraphParser, Group, GroupParser, Groups, InitialGroupGroupParser, InitialGroupParser, Link, Links, Message, Node, Parser, PokeMessage, PublishGraph, Receiver, RemoveGraphParser, Setting, Settings, Ship, SubscribeMessage

Constant Summary

VERSION =

"0.6.0"

Class Method Summary

• .connect(**config_options) ⇒ Object
• .new(**config_options) ⇒ Object

Class Method Details

.connect(**config_options) ⇒ Object

# File 'lib/urbit.rb', line 14

def connect(**config_options)
  config = Urbit::Config.new(**config_options)
  ship = Urbit::Ship.new(config: config)
  ship.login
end

.new(**config_options) ⇒ Object

# File 'lib/urbit.rb', line 20

def new(**config_options)
  config = Urbit::Config.new(**config_options)
  Urbit::Ship.new(config: config)
end