Sha256: 24830a7396fe7e6381a9056d7e7ebc8c87d37dcdde5ef83054c2d7eccb69120f

Contents?: true

Size: 1.3 KB

Versions: 7

Compression:

Stored size: 1.3 KB

Contents

require 'ably/rest/channel'
require 'ably/rest/channels'
require 'ably/rest/client'
require 'ably/rest/presence'

Dir.glob(File.expand_path("models/*.rb", File.dirname(__FILE__))).each do |file|
  require file
end

require 'ably/models/message_encoders/base'

module Ably
  # Rest provides the top-level class to be instanced for the Ably Rest library
  #
  # @example
  #   client = Ably::Rest.new("xxxxx")
  #   channel = client.channel("test")
  #   channel.publish "greeting", "data"
  #
  module Rest
    # Convenience method providing an alias to {Ably::Rest::Client} constructor.
    #
    # @param (see Ably::Rest::Client#initialize)
    # @option options (see Ably::Rest::Client#initialize)
    #
    # @yield (see Ably::Rest::Client#initialize)
    # @yieldparam (see Ably::Rest::Client#initialize)
    # @yieldreturn (see Ably::Rest::Client#initialize)
    #
    # @return [Ably::Rest::Client]
    #
    # @example
    #    # create a new client authenticating with basic auth
    #    client = Ably::Rest.new('key.id:secret')
    #
    #    # create a new client authenticating with basic auth and a client_id
    #    client = Ably::Rest.new(api_key: 'key.id:secret', client_id: 'john')
    #
    def self.new(options, &token_request_block)
      Ably::Rest::Client.new(options, &token_request_block)
    end
  end
end

Version data entries

7 entries across 7 versions & 2 rubygems

Version Path
ably-rest-0.7.5 lib/submodules/ably-ruby/lib/ably/rest.rb
ably-0.7.5 lib/ably/rest.rb
ably-0.7.4 lib/ably/rest.rb
ably-rest-0.7.3 lib/submodules/ably-ruby/lib/ably/rest.rb
ably-0.7.2 lib/ably/rest.rb
ably-0.7.1 lib/ably/rest.rb
ably-0.7.0 lib/ably/rest.rb