Lexer Identities Official Ruby Client Library

Build Status Code Climate

lexer-identity-gem is the official Ruby Client for the Lexer Identity API. The Lexer Identity API lets brands contribute and consume from Lexer's Identity database directly from their apps.

Installation

Add to your Gemfile:

gem 'lexer-identity'

or install from Rubygems:

gem install lexer-identity

Details

Have a limited list of keys which can be reviewed at: http://developer.lexer.io/ Your hash should reflect the following format:

{
  email: "[email protected]",
  phone: "61440000000",
  twitter: "camplexer"
}

Multiple values can be provided via arrays:

{
  email: ["[email protected]", "[email protected]"],
  phone: "61440000000",
  twitter: "camplexer"
}

Attributes:

Need to be defined by the valid namespace which should be provided to you along with your tokens. An attribute namespace is defined by: com.brand.* where com.brand is defined along with your tokens and * can be replaced with any A-Za-z0-9._- character.

Your attribute hash should reflect the following format:

{
  "com.brand.email" => "[email protected]",
  "com.brand.phone" => "61440000000",
  "com.brand.twitter" => "camplexer"
}

Permitted values include:

  • String
  • Numbers
  • Arrays
  • Simple Hashes

Attribute hashes are transported via JSON so any format supported by JSON is supported by Lexer.