Class: PritunlApiClient::Key

Inherits:
Object
  • Object
show all
Defined in:
lib/pritunl_api_client/key.rb

Overview

Interact with /key api’s

Instance Method Summary collapse

Constructor Details

#initialize(api) ⇒ Key

Returns a new instance of Key.

Parameters:



7
8
9
 
# File 'lib/pritunl_api_client/key.rb', line 7

def initialize( api )
  @api = api
end

Instance Method Details

#download_chromebook_profile(organization_id:, user_id:, path:) ⇒ String

Download a users onc key (Chromebook profile) as a zip archive

Parameters:

  • organization_id (String)
  • user_id (String)
  • path (String) —

    Local path to save downloaded file

Returns:

  • (String) —

    Local path to downloaded file



41
42
43
44
45
 
# File 'lib/pritunl_api_client/key.rb', line 41

def download_chromebook_profile( organization_id:, user_id:, path: )
  data = @api.get( "/key_onc/#{organization_id}/#{user_id}.zip" )
  File.write( path, data.force_encoding( 'utf-8' ) )
  path
end

#download_tar(organization_id:, user_id:, path:) ⇒ String

Download a users key tar archive

Parameters:

  • organization_id (String)
  • user_id (String)
  • path (String) —

    Local path to save downloaded file

Returns:

  • (String) —

    Local path to downloaded file



17
18
19
20
21
 
# File 'lib/pritunl_api_client/key.rb', line 17

def download_tar( organization_id:, user_id:, path: )
  data = @api.get( "/key/#{organization_id}/#{user_id}.tar" )
  File.write( path, data.force_encoding( 'utf-8' ) )
  path
end

#download_zip(organization_id:, user_id:, path:) ⇒ String

Download a users key zip archive

Parameters:

  • organization_id (String)
  • user_id (String)
  • path (String) —

    Local path to save downloaded file

Returns:

  • (String) —

    Local path to downloaded file



29
30
31
32
33
 
# File 'lib/pritunl_api_client/key.rb', line 29

def download_zip( organization_id:, user_id:, path: )
  data = @api.get( "/key/#{organization_id}/#{user_id}.zip" )
  File.write( path, data.force_encoding( 'utf-8' ) )
  path
end

#temporary_url(organization_id:, user_id:) ⇒ Hash

Generate a temporary url to download a users key archive

Parameters:

  • organization_id (String)
  • user_id (String)

Returns:

  • (Hash) 


52
53
54
 
# File 'lib/pritunl_api_client/key.rb', line 52

def temporary_url( organization_id:, user_id: )
  @api.get( "/key/#{organization_id}/#{user_id}" )
end