Class: GetStreamRuby::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/getstream_ruby/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config = nil, api_key: nil, api_secret: nil, base_url: nil, timeout: nil) ⇒ Client

Returns a new instance of Client.



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/getstream_ruby/client.rb', line 20

def initialize(config = nil, api_key: nil, api_secret: nil, base_url: nil, timeout: nil)
  @configuration = config || GetStreamRuby.configuration

  # Create new configuration with overrides if any parameters provided
  if api_key || api_secret || base_url || timeout
    @configuration = Configuration.with_overrides(
      api_key: api_key,
      api_secret: api_secret,
      base_url: base_url,
      timeout: timeout,
    )
  end

  @configuration.validate!
  @connection = build_connection
end

Instance Attribute Details

#configuration ⇒ Object (readonly)

Returns the value of attribute configuration.



18
19
20
 
# File 'lib/getstream_ruby/client.rb', line 18

def configuration
  @configuration
end

Instance Method Details

#common ⇒ GetStream::Generated::CommonClient

Returns The common API client.

Returns:



44
45
46
 
# File 'lib/getstream_ruby/client.rb', line 44

def common
  @common ||= GetStream::Generated::CommonClient.new(self)
end

#feed(feed_group_id, feed_id) ⇒ GetStream::Generated::Feed

Create an individual feed instance

Parameters:

  • feed_group_id (String) —

    The feed group ID

  • feed_id (String) —

    The feed ID

Returns:



62
63
64
 
# File 'lib/getstream_ruby/client.rb', line 62

def feed(feed_group_id, feed_id)
  GetStream::Generated::Feed.new(self, feed_group_id, feed_id)
end

#feed_resource ⇒ Object 



37
38
39
 
# File 'lib/getstream_ruby/client.rb', line 37

def feed_resource
  @feed_resource ||= Resources::Feed.new(self)
end

#feeds ⇒ GetStream::Generated::FeedsClient

Returns The feeds API client.

Returns:



49
50
51
 
# File 'lib/getstream_ruby/client.rb', line 49

def feeds
  @feeds ||= GetStream::Generated::FeedsClient.new(self)
end

#make_request(method, path, query_params: nil, body: nil) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
 
# File 'lib/getstream_ruby/client.rb', line 73

def make_request(method, path, query_params: nil, body: nil)
  # Handle query parameters
  if query_params && !query_params.empty?
    query_string = query_params.map { |k, v| "#{k}=#{v}" }.join('&')
    path = "#{path}?#{query_string}"
  end

  # Make the request
  request(method, path, body)
end

#moderation ⇒ GetStream::Generated::ModerationClient

Returns The moderation API client.

Returns:



54
55
56
 
# File 'lib/getstream_ruby/client.rb', line 54

def moderation
  @moderation ||= GetStream::Generated::ModerationClient.new(self)
end

#post(path, body = {}) ⇒ GetStreamRuby::StreamResponse

Returns The API response.

Parameters:

  • path (String) —

    The API path

  • body (Hash) (defaults to: {}) —

    The request body

Returns:



69
70
71
 
# File 'lib/getstream_ruby/client.rb', line 69

def post(path, body = {})
  request(:post, path, body)
end