avatar-me/lib/AvatarMe.js

Simple node module to retrieves a user avatar given an email or a user name Edit

const async = require('async')
const gravatar = require('gravatar')
const validator = require('validator')
const request = require('request')

const Cache = require('./Cache')

class AvatarMe {
  constructor () {
    this.defaultAvatar = 'default.png'
    this.defaultAvatarPath = '/static/images/avatar_tiles/v1/'
    this.cache = null
    this.shouldFetchGmail = true
    this.shouldFetchGravatar = true
  }

  configure (config) {
    if (config) {
      this.defaultAvatar = config.defaultAvatar ? config.defaultAvatar : this.defaultAvatar
      this.defaultAvatarPath = config.defaultAvatarPath ? config.defaultAvatarPath : this.defaultAvatarPath
      this.cache = config.cache ? new Cache(config.cache) : null
      this.shouldFetchGmail = config.shouldFetchGmail !== undefined ? config.shouldFetchGmail : this.shouldFetchGmail
      this.shouldFetchGravatar = config.shouldFetchGravatar !== undefined ? config.shouldFetchGravatar : this.shouldFetchGravatar
    }
  }

  fetchAvatar (email, username, callback) {
    if (!email) {
      return callback(new Error('No email provided'), null)
    }
    if (!username) {
      return callback(new Error('No username provided'), null)
    }
    if (!this.isValidEmail(email)) {
      return callback(new Error('No valid email'), null)
    }

    if (this.cache) {
      return this.cache.getCachedValue(email).then(avatar => {
        return callback(null, avatar)
      })
      .catch((error) => { // Cache fails. Try to fetch avatar from the APIS
        return this.fetchAvatarFromApis(email, username, (err, avatar) => {
          if (err) return callback(err, null)
          this.cache.setCachedValue(email, avatar) // CACHE RESULT!
          return callback(null, avatar)
        })
      })
    }

    this.fetchAvatarFromApis(email, username, (err, avatar) => {
      if (err) return callback(err, null)
      return callback(null, avatar)
    })
  }

  /**
  * Fetch an avatar in multiple websites.
  * Returns a Promise
  */
  fetchAvatarFromApis (email, username, callback) {
    async.parallel({
      gmail: (nextCb) => {
        console.log(this.shouldFetchGmail)
        if (this.shouldFetchGmail === false) {
          return nextCb(null, null)
        }

        this.fetchGoogleAvatar(email, (err, googleImage) => {
          if (err) return nextCb(null, null)
          return nextCb(null, googleImage)
        })
      },
      gravatar: (nextCb) => {
        console.log(this.shouldFetchGravatar)
        if (this.shouldFetchGravatar  === false) {
          return nextCb(null, null)
        }

        this.fethGravatarImage(email, (err, gravatarImage) => {
          if (err) return nextCb(null, null)
          return nextCb(null, gravatarImage)
        })
      },
      default: (nextCb) => {
        return nextCb(null, this.fetchDefaultImage(username))
      }
    }, (err, results) => {
      if (err) return callback(err, null)
      if (results.gmail) return callback(null, results.gmail)
      if (results.gravatar) return callback(null, results.gravatar)
      return callback(null, results.default)
    })
  }

  isValidEmail (email) {
    return validator.isEmail(email)
  }

  fetchGoogleAvatar (email, callback) {
    const googleAvatarApi = 'https://picasaweb.google.com/data/entry/api/user/'
    const avatarUrl = googleAvatarApi + email + '?alt=json'

    request({
      method: 'GET',
      url: avatarUrl,
      gzip: true
    }, (e, r, response) => {
      try {
        if (!response || response.includes('Unable to find')) {
          return callback(new Error('Unable to find'), null)
        }
        const user = JSON.parse(String(response))
        const image = user.entry.gphoto$thumbnail.$t
        return callback(null, image)
      } catch (err) {
        return callback(new Error('Unable to find'), null)
      }
    })
  }

  fethGravatarImage (email, callback) {
    const gravatarUrl = gravatar.url(email, { protocol: 'https', s: '100', r: 'x', d: '404' })

    request({
      method: 'GET',
      url: gravatarUrl,
      format: 'json'
    }, (e, r, response) => {
      if (response === '404 Not Found') {
        return callback(null, null)
      }
      return callback(null, gravatarUrl)
    })
  }

  // Returns an image with the initial letter of the user

  fetchDefaultImage (username) {
    if (!username || username.length === 0) return this.defaultAvatarPath + 'default.png'

    const initialLetter = String(username[0]).toLowerCase()
    const defaultAvatarUrl = this.defaultAvatarPath + `${initialLetter}.png`

    return defaultAvatarUrl
  }
}

module.exports = AvatarMe