Class: Io::Flow::V0::Clients::Tokens

Inherits:
Object
  • Object
show all
Defined in:
lib/flow_commerce/flow_api_v0_client.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Tokens

Returns a new instance of Tokens.



4419
4420
4421
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4419

def initialize(client)
  @client = HttpClient::Preconditions.assert_class('client', client, ::Io::Flow::V0::Client)
end

Instance Method Details

#delete_by_id(id) ⇒ Object 



4455
4456
4457
4458
4459
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4455

def delete_by_id(id)
  HttpClient::Preconditions.assert_class('id', id, String)
  r = @client.request("/tokens/#{CGI.escape(id)}").delete
  nil
end

#get(incoming = {}) ⇒ Object

Get all tokens that you are authorized to view. Note that the cleartext token value is never sent. To view the API token itself, see the resource path /tokens/:id/cleartext



4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4426

def get(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  query = {
    :id => (x = opts.delete(:id); x.nil? ? nil : HttpClient::Preconditions.assert_class('id', x, Array).map { |v| HttpClient::Preconditions.assert_class('id', v, String) }),
    :organization => (x = opts.delete(:organization); x.nil? ? nil : HttpClient::Preconditions.assert_class('organization', x, String)),
    :partner => (x = opts.delete(:partner); x.nil? ? nil : HttpClient::Preconditions.assert_class('partner', x, String)),
    :mine => (x = opts.delete(:mine); x.nil? ? nil : HttpClient::Preconditions.assert_boolean('mine', x)),
    :limit => HttpClient::Preconditions.assert_class('limit', (x = opts.delete(:limit); x.nil? ? 25 : x), Integer),
    :offset => HttpClient::Preconditions.assert_class('offset', (x = opts.delete(:offset); x.nil? ? 0 : x), Integer),
    :sort => HttpClient::Preconditions.assert_class('sort', (x = opts.delete(:sort); x.nil? ? "-created_at" : x), String)
  }.delete_if { |k, v| v.nil? }
  r = @client.request("/tokens").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::Token.from_json(x) }
end

#get_by_id(id) ⇒ Object

Get metadata for the token with this ID



4449
4450
4451
4452
4453
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4449

def get_by_id(id)
  HttpClient::Preconditions.assert_class('id', id, String)
  r = @client.request("/tokens/#{CGI.escape(id)}").get
  ::Io::Flow::V0::Models::Token.from_json(r)
end

#get_cleartext_by_id(id) ⇒ Object

Retrieves the token with the actual string token in cleartext



4462
4463
4464
4465
4466
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4462

def get_cleartext_by_id(id)
  HttpClient::Preconditions.assert_class('id', id, String)
  r = @client.request("/tokens/#{CGI.escape(id)}/cleartext").get
  ::Io::Flow::V0::Models::Cleartext.new(r)
end

#post(token_form) ⇒ Object

Create a new token for the requesting user



4442
4443
4444
4445
4446
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4442

def post(token_form)
  (x = token_form; x.is_a?(::Io::Flow::V0::Models::TokenForm) ? x : ::Io::Flow::V0::Models::TokenForm.from_json(x))
  r = @client.request("/tokens").with_json(token_form.to_json).post
  ::Io::Flow::V0::Models::Token.from_json(r)
end

#post_authentications(token_authentication_form) ⇒ Object

Preferred method to validate a token, obtaining specific information if the token is valid (or a 404 if the token does not exist). We use an HTTP POST with a form body to enusre that the token itself is not logged in the request logs.



4472
4473
4474
4475
4476
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4472

def post_authentications(token_authentication_form)
  (x = token_authentication_form; x.is_a?(::Io::Flow::V0::Models::TokenAuthenticationForm) ? x : ::Io::Flow::V0::Models::TokenAuthenticationForm.new(x))
  r = @client.request("/tokens/authentications").with_json(token_authentication_form.to_json).post
  ::Io::Flow::V0::Models::TokenReference.from_json(r)
end