Class: Clearbit::Base

Inherits:

Resource

• Object
• Hash
• Mash
• Resource
• Clearbit::Base

Defined in:

lib/clearbit/base.rb

Direct Known Subclasses

Audiences, Autocomplete::Company, Discovery, Enrichment::Company, Enrichment::News, Enrichment::Person, Enrichment::PersonCompany, NameDomain, Prospector, Reveal, Risk, Watchlist

Constant Summary

Constants inherited from Resource

Resource::OPTION_KEYS

Class Method Summary

• .key ⇒ Object
• .key=(value) ⇒ Object
• .version=(value) ⇒ Object

Instance Method Summary

• #pending? ⇒ Boolean

Methods inherited from Resource

delete, endpoint, get, options, parse_values, path, post, put, request, uri, #uri, url

Methods inherited from Mash

#custom_reader, #custom_writer, #deep_merge, #deep_update, #delete, #dup, #fetch, #id, #initialize, #initializing_reader, #key?, #method_missing, new, #regular_dup, #replace, #respond_to?, #shallow_merge, #shallow_update, #type, #underbang_reader

Constructor Details

This class inherits a constructor from Clearbit::Mash

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Clearbit::Mash

Class Method Details

.key ⇒ Object

# File 'lib/clearbit/base.rb', line 17

def self.key
  @key
end

.key=(value) ⇒ Object

# File 'lib/clearbit/base.rb', line 10

def self.key=(value)
  add_options auth_type: :bearer,
              password:  value

  @key = value
end

.version=(value) ⇒ Object

# File 'lib/clearbit/base.rb', line 6

def self.version=(value)
  add_options headers: {'API-Version' => value}
end

Instance Method Details

#pending? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/clearbit/base.rb', line 21

def pending?
  false
end