Module: Ey::Core::Client::Shared

Included in:
Mock, Real
Defined in:
lib/ey-core/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#authentication ⇒ Object (readonly)

Returns the value of attribute authentication.



297
298
299
 
# File 'lib/ey-core/client.rb', line 297

def authentication
  @authentication
end

#cache ⇒ Object (readonly)

Returns the value of attribute cache.



297
298
299
 
# File 'lib/ey-core/client.rb', line 297

def cache
  @cache
end

#url ⇒ Object (readonly)

Returns the value of attribute url.



297
298
299
 
# File 'lib/ey-core/client.rb', line 297

def url
  @url
end

Instance Method Details

#metadata ⇒ Object

Deprecated.

will be removed in 3.x

See Also:

  • Ey::Core::Client::Shared.{{#services}


400
401
402
 
# File 'lib/ey-core/client.rb', line 400

def metadata
  services.get("core")
end

#require_argument(_params, *_requirements) ⇒ Object 



375
376
377
378
379
380
381
382
 
# File 'lib/ey-core/client.rb', line 375

def require_argument(_params, *_requirements)
  params       = Cistern::Hash.stringify_keys(_params)
  requirements = _requirements.map(&:to_s)

  values = params.values_at(*requirements)
  values.all?(&:nil?) && raise(ArgumentError.new("argument is missing or the value is empty: #{requirement}"))
  values.size == 1 ? values.first : values
end

#require_argument!(_params, *_requirements) ⇒ Object 



384
385
386
387
388
389
390
391
392
 
# File 'lib/ey-core/client.rb', line 384

def require_argument!(_params, *_requirements)
  params       = Cistern::Hash.stringify_keys(_params)
  requirements = _requirements.map(&:to_s)

  values = params.values_at(*requirements)
  values.all?(&:nil?) && raise(ArgumentError.new("argument is missing or the value is empty: #{requirement}"))
  requirements.each { |r| params.delete(r) }
  values.size == 1 ? values.first : values
end

#require_arguments(_params, *_requirements) ⇒ Object 



362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/ey-core/client.rb', line 362

def require_arguments(_params, *_requirements)
  params       = Cistern::Hash.stringify_keys(_params)
  requirements = _requirements.map(&:to_s)

  values = requirements.map do |requirement|
    if params[requirement].nil?
      raise ArgumentError, "argument is missing or the value is empty: #{requirement}"
    end
    params[requirement]
  end
  [params, *values]
end

#require_parameters(_params, *_requirements) ⇒ Object

strong parameter emulation



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/ey-core/client.rb', line 343

def require_parameters(_params, *_requirements)
  params       = Cistern::Hash.stringify_keys(_params)
  requirements = _requirements.map(&:to_s)

  requirements.each do |requirement|
    unless !params[requirement].nil?
      if self.class == Ey::Core::Client::Real
        raise ArgumentError, "param is missing or the value is empty: #{requirement}"
      else
        response(
          :status => 400,
          :body   => "param is missing or the value is empty: #{requirement}")
      end
    end
  end
  values = params.values_at(*requirements)
  values.size == 1 ? values.first : values
end

#setup(options) ⇒ Object 



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/ey-core/client.rb', line 299

def setup(options)
  token_dotfile = begin
                    if options[:config_file]
                      YAML.load_file(options[:config_file]) || {} # if the file is empty, yaml returns false
                    else
                      YAML.load_file(File.expand_path("~/.ey-core"))
                    end
                  rescue Errno::ENOENT
                    {}
                  end

  resolved_url = options[:url] || ENV["CORE_URL"] || "https://api.engineyard.com/"
  @url   = File.join(resolved_url, "/") # trailing slash # consistency # hash tag you're welcome
  @cache = if options[:cache] == true
             Ey::Core::MemoryCache
           else options[:cache]
           end

  @authentication = nil
  @token = if options.has_key?(:token) && options[:token].nil?
             @authentication = :none
           else
             options[:token] || token_dotfile[@url] || token_dotfile[@url.gsub(/\/$/, "")] # matching with or without trailing slash
           end

  # For HMAC
  @auth_id  = options[:auth_id]
  @auth_key = options[:auth_key]

  unless @authentication == :none
    if !@auth_id && !@auth_key && !@token
      raise "Missing token. Use Ey::Core::Client.new(token: mytoken) or add \"'#{@url}': mytoken\" to your ~/.ey-core file" unless @token
    elsif options[:token] || (@token && !@auth_id) # token was explicitly provided
      @authentication = :token
    else
      @authentication = :hmac
      @token = nil
    end
  end

  @logger = options[:logger] || Logger.new(nil)
end

#url_for(*args) ⇒ Object 



394
395
396
 
# File 'lib/ey-core/client.rb', line 394

def url_for(*args)
  File.join(@url.to_s, *args.map(&:to_s))
end