Class: Avataaars

Inherits:

Object

• Object
• Avataaars

Defined in:

lib/avataaars.rb,
lib/avataaars/utils.rb,
lib/avataaars/errors.rb,
lib/avataaars/version.rb,
lib/avataaars/processor.rb

Overview

Avataaars interface for creating avatar SVGs from feature traits

Defined Under Namespace

Modules: JavaScript Classes: Processor, Utils

Constant Summary

Error =

Error classes for calling out to Avataaars NodeJS library

Heavily based on the Schmooze library github.com/Shopify/schmooze

Class.new(StandardError)

DependencyError =

Class.new(Error)

VERSION =

'0.2.3'

Instance Method Summary

• #create_avatar ⇒ String

  Call to avatar creation processor and return rendered SVG.

• #initialize(**options) ⇒ Avataaars constructor

  A new instance of Avataaars.

Constructor Details

#initialize(**options) ⇒ Avataaars

Returns a new instance of Avataaars.

Parameters:

• options (Hash) —

  Optional parameters to pass to avatar processor see github.com/fangpenlin/avataaars

# File 'lib/avataaars.rb', line 17

def initialize(**options)
  @root_path = options.delete :root_path
  @options = options
end

Instance Method Details

#create_avatar ⇒ String

Call to avatar creation processor and return rendered SVG

Returns:

• (String) —

  The resulting SVG data

# File 'lib/avataaars.rb', line 27

def create_avatar
  normalised_options = Utils.normalize_object(@options)
  processor.create_avatar(**normalised_options)
end