Class: OctaSpace::Transport::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/octaspace/transport/base.rb

Overview

Abstract base class for HTTP transports

Concrete implementations: FaradayTransport (standard) and PersistentTransport (keep-alive with connection pooling).

Direct Known Subclasses

FaradayTransport

Instance Method Summary collapse

Instance Method Details

#delete(path, params: {}, headers: {}) ⇒ OctaSpace::Response

Parameters:

  • path (String)
  • params (Hash) (defaults to: {})
  • headers (Hash) (defaults to: {})

Returns:

Raises:

  • (NotImplementedError) 


46
47
48
 
# File 'lib/octaspace/transport/base.rb', line 46

def delete(path, params: {}, headers: {})
  raise NotImplementedError, "#{self.class}#delete not implemented"
end

#get(path, params: {}, headers: {}) ⇒ OctaSpace::Response

Parameters:

  • path (String)
  • params (Hash) (defaults to: {})
  • headers (Hash) (defaults to: {})

Returns:

Raises:

  • (NotImplementedError) 


14
15
16
 
# File 'lib/octaspace/transport/base.rb', line 14

def get(path, params: {}, headers: {})
  raise NotImplementedError, "#{self.class}#get not implemented"
end

#patch(path, body: nil, headers: {}) ⇒ OctaSpace::Response

Parameters:

  • path (String)
  • body (Hash, nil) (defaults to: nil)
  • headers (Hash) (defaults to: {})

Returns:

Raises:

  • (NotImplementedError) 


38
39
40
 
# File 'lib/octaspace/transport/base.rb', line 38

def patch(path, body: nil, headers: {})
  raise NotImplementedError, "#{self.class}#patch not implemented"
end

#post(path, body: nil, headers: {}) ⇒ OctaSpace::Response

Parameters:

  • path (String)
  • body (Hash, nil) (defaults to: nil)
  • headers (Hash) (defaults to: {})

Returns:

Raises:

  • (NotImplementedError) 


22
23
24
 
# File 'lib/octaspace/transport/base.rb', line 22

def post(path, body: nil, headers: {})
  raise NotImplementedError, "#{self.class}#post not implemented"
end

#put(path, body: nil, headers: {}) ⇒ OctaSpace::Response

Parameters:

  • path (String)
  • body (Hash, nil) (defaults to: nil)
  • headers (Hash) (defaults to: {})

Returns:

Raises:

  • (NotImplementedError) 


30
31
32
 
# File 'lib/octaspace/transport/base.rb', line 30

def put(path, body: nil, headers: {})
  raise NotImplementedError, "#{self.class}#put not implemented"
end