ringcentral-avatars 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b81a6e0a914a3dd91979611efbdccf01ff20777b
-  data.tar.gz: a552c45e8d29216d21811f875b92fa0e1bf9e115
+  metadata.gz: 36141cadb78befc9afe2c8383721e8645d9e320a
+  data.tar.gz: 55e6cc5ed25ab49f57391a51c65e92450c813f13
 SHA512:
-  metadata.gz: 63170405d21dd1a21526405b70a3c5404b2914b05516d9455232a0cb32ff9f8037d878a39bea8d9bca3637cf032ccd0c784cb0e339e4f1fa96b3060114a89a9e
-  data.tar.gz: c9524a420f36a8c2f888c4ea16c194521454fe3f57802f16254e77999130a007cf69774718f8ba131ae887628286da23443626135a69a1f3b9f4e033d1e66313
+  metadata.gz: ff2d64ea6868369971ebb40ce485118416c8ef7052c9b0421bda7d1c98e41e48147b6a501bfc1f1494e07d8e13fe696528de97cffc5fe50fa572d684ff5ce36c
+  data.tar.gz: 9734754fe66688298036dd7c5fd08ec67ec564f4e9732c27462475c230bcaf7364e054023d8cb04a0b92dcba7ee80e1b3d379053ff490b43c541b01e95ab56d1

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 CHANGELOG
 ---------
+- **2016-12-28**: 0.5.0
+  - Add auto-retry for `429` and `503` errors.
+  - Add test script to try PNG, JPG, and GIF filetypes
+  - Add article `NEWS.md`
+- **2016-11-19**: 0.4.1
+  - Fix RubyDoc.info documentation rendering
 - **2016-11-19**: 0.4.0
   - Add PNG metadata support
   - Add demo scripts in `./scripts` directory

data/Gemfile.lock

@@ -0,0 +1,164 @@
+PATH
+  remote: .
+  specs:
+    ringcentral-avatars (0.5.0)
+      avatarly (~> 1.5, >= 1.5.0)
+      chunky_png (~> 1.3, >= 1.3.8)
+      faraday (~> 0.9, >= 0.9)
+      mime-types (~> 3.0, >= 3.1)
+      ringcentral_sdk (~> 2, >= 2.0.2)
+      ruby_identicon (~> 0, >= 0.0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    avatarly (1.5.0)
+      rfc822
+      rmagick
+      unicode_utils
+    celluloid (0.17.3)
+      celluloid-essentials
+      celluloid-extras
+      celluloid-fsm
+      celluloid-pool
+      celluloid-supervision
+      timers (>= 4.1.1)
+    celluloid-essentials (0.20.5)
+      timers (>= 4.1.1)
+    celluloid-extras (0.20.5)
+      timers (>= 4.1.1)
+    celluloid-fsm (0.20.5)
+      timers (>= 4.1.1)
+    celluloid-pool (0.20.5)
+      timers (>= 4.1.1)
+    celluloid-supervision (0.20.6)
+      timers (>= 4.1.1)
+    chunky_png (1.3.8)
+    concurrent-ruby (1.0.3)
+    coveralls (0.8.17)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.12.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6)
+    docile (1.1.5)
+    dotenv (2.1.1)
+    dry-configurable (0.5.0)
+      concurrent-ruby (~> 1.0)
+    dry-container (0.6.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.2.1)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.2.0)
+    dry-logic (0.4.0)
+      dry-container (~> 0.2, >= 0.2.6)
+      dry-core (~> 0.1)
+      dry-equalizer (~> 0.2)
+    dry-types (0.9.3)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1)
+      dry-container (~> 0.3)
+      dry-core (~> 0.2, >= 0.2.1)
+      dry-equalizer (~> 0.2)
+      dry-logic (~> 0.4, >= 0.4.0)
+      inflecto (~> 0.0.0, >= 0.0.2)
+    dry-validation (0.10.4)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+      dry-container (~> 0.2, >= 0.2.8)
+      dry-core (~> 0.2, >= 0.2.1)
+      dry-equalizer (~> 0.2)
+      dry-logic (~> 0.4, >= 0.4.0)
+      dry-types (~> 0.9, >= 0.9.0)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.10.1)
+      faraday (>= 0.7.4, < 1.0)
+    faraday_middleware-oauth2_refresh (0.0.3)
+      faraday (~> 0.9, >= 0.9)
+      faraday_middleware (~> 0, >= 0)
+    faraday_middleware-request-retry (0.2.0)
+      faraday (~> 0, >= 0)
+      faraday_middleware (~> 0, >= 0)
+    hitimes (1.2.4)
+    httpclient (2.8.3)
+    inflecto (0.0.2)
+    json (2.0.2)
+    jsondoc (0.1.3)
+    jwt (1.5.6)
+    logger (1.2.8)
+    metaclass (0.0.4)
+    mime (0.4.3)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mime_builder (0.0.4)
+      mime (~> 0.4, >= 0.4.3)
+      mime-types (~> 3.1)
+      multi_json (~> 1, >= 1.12.1)
+    mocha (1.2.1)
+      metaclass (~> 0.0.1)
+    multi_json (1.12.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    oauth2 (1.2.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    power_assert (0.4.1)
+    pubnub (4.0.17)
+      celluloid (~> 0.17)
+      dry-validation (~> 0.10)
+      httpclient (~> 2.8)
+      json (>= 1.8, < 3)
+    rack (2.0.1)
+    rake (11.3.0)
+    rfc822 (0.1.5)
+    ringcentral_sdk (2.0.3)
+      dotenv (~> 2.1, >= 2.1.0)
+      faraday (~> 0, >= 0)
+      faraday_middleware (~> 0, >= 0)
+      faraday_middleware-oauth2_refresh (~> 0)
+      faraday_middleware-request-retry (~> 0.1, >= 0.1.0)
+      jsondoc (~> 0.1, >= 0.1.0)
+      logger (~> 1)
+      mime (~> 0.4, >= 0.4.3)
+      mime-types (~> 3.1)
+      mime_builder (~> 0, >= 0.0.4)
+      multi_json (~> 1.3)
+      oauth2 (~> 1.0, >= 1.0.0)
+      pubnub (~> 4.0)
+    rmagick (2.16.0)
+    ruby_identicon (0.0.5)
+      chunky_png (~> 1.3.5)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    term-ansicolor (1.4.0)
+      tins (~> 1.0)
+    test-unit (3.2.3)
+      power_assert
+    thor (0.19.4)
+    timers (4.1.2)
+      hitimes
+    tins (1.13.0)
+    unicode_utils (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls (~> 0)
+  mocha (~> 1)
+  rake (~> 11)
+  ringcentral-avatars!
+  simplecov (~> 0)
+  test-unit (~> 3)
+
+BUNDLED WITH
+   1.13.6

data/NEWS.md

@@ -0,0 +1,278 @@
+Using The Profile Image API and Default Images
+==============================================
+
+The RingCentral Profile Image API is a powerful API that can be used to upload images that are used in the corporate address book both individually and administratively across users. Some popular use cases include:
+
+1. Syncing images from Active Directory or Okta
+2. Uploading images from mobile apps
+3. Setting default images for users
+
+For this article, we'll cover API basics and then discuss how to set default images using either user initials like Gmail/Office 365 or Identicons. The initials will look like the following in the RingCentral for Desktop softphone. The avatars will update in the softphone in real-time as they are changed on the backend:
+
+![](https://raw.githubusercontent.com/ringcentral-ruby/ringcentral-avatars-ruby/master/docs/images/ringcentral-avatars-softphone.png)
+
+We will cover:
+
+1. API basics
+  1. User profile image information
+    1. Example user object
+  2. Update user profile image
+    1. Example request
+  3. Subscribing for avatar updates
+    1. Example request
+    2. Example response
+    3. Retrieving the user image
+2. Default images recipe
+  1. Getting a list of extensions without avatars
+  2. Creating the default image
+  3. Identifying auto-generated default images
+  4. Wrapping it up
+1. Notes
+  2. Throttling
+
+This article uses the Ruby language and leverages the community [`ringcentral_sdk`](https://rubygems.org/gems/ringcentral_sdk) SDK gem. It presents code which is implemented in a similar way in the [`ringcentral-avatars`](https://rubygems.org/gems/ringcentral-avatars) Ruby gem for discussion purposes. If you just want to use the functionality, you can use the Ruby gem directly.
+
+## API basics
+
+When working with the Profile API, there are a few basic APIs to use:
+
+| method | endpoint | notes |
+|--------|----------|-------|
+| `GET` | `account/~/extension/~` | Get your own extension info with profile image information. |
+| `GET` | `account/~/extension` | Get a list of extension with profile image information. |
+| `PUT` | `account/~/extension/~/profile-image` | Update the user's profile image with a binary image file. |
+| n/a | `account/~/extension` | Event filter for webhook and PubNub-based subscriptions |
+
+### User profile image information
+
+To retrieve the extension `profileImage` information for a user, retrieve the user's `account/~/extension/~` endpoint.
+
+#### Example user object
+
+```json
+{
+  "uri": "https://platform.devtest.ringcentral.com/restapi/v1.0/account/11111111/extension/22222222",
+  "id": 22222222,
+  "extensionNumber": "102",
+  "contact": {
+    "firstName": "Alice"
+    "businessPhone": "+6505550102"
+  },
+  "name": "Alice",
+  "type": "User",
+  "status": "Enabled",
+  "permissions": {
+    "admin": {
+      "enabled": false
+    },
+    "internationalCalling": {
+      "enabled": false
+    }
+  },
+  "profileImage": {
+    "uri": "https://media.devtest.ringcentral.com/restapi/v1.0/account/11111111/extension/22222222/profile-image",
+    "etag": "0123456789abcdef0123456789abcdef",
+    "contentType": "image/png",
+    "lastModified": "2016-11-01T00:00:00.000Z",
+    "scales": [
+      {
+        "uri": "https://media.devtest.ringcentral.com/restapi/v1.0/account/11111111/extension/22222222/profile-image/90x90"
+      },
+      {
+        "uri": "https://media.devtest.ringcentral.com/restapi/v1.0/account/11111111/extension/22222222/profile-image/195x195"
+      },
+      {
+        "uri": "https://media.devtest.ringcentral.com/restapi/v1.0/account/11111111/extension/22222222/profile-image/584x584"
+      }
+    ]
+  }
+}
+```
+
+### Update user profile image
+
+To update an image make a `PUT` request to the user's `account/~/extension/~/profile-image` endpoint using `multipart/formdata` and the `image` attribute. 
+
+#### Example request
+
+Using the Ruby SDK, you can do the following:
+
+```ruby
+url = 'account/~/extension/~/profile-image'
+file = Faraday::UploadIO.new '/path/to/myimage.png', 'image/png'
+
+client.http.put url, image: file
+```
+
+### Subscribing for avatar updates
+
+Client applications can subscribe for updates by using the Subscription API using either webhooks or PubNub using the `account/~/extension` event filter. The app will be notified of changes in real time and can retrieve the relevant images. This type of client-side update is implemented in the RingCentral for Desktop softphone app.
+
+#### Example request
+
+```ruby
+# Create an observable subscription and add your observer
+sub = client.create_subscription()
+sub.subscribe([ "/restapi/v1.0/account/~/extension" ])
+sub.add_observer MyObserver.new()
+```
+
+#### Example event
+
+When a user's extension has changed for any reason, including, profile image updates, an event is fired that matches `account/~/extension` filter mentioned above with the following example format. Once you have the `extensionId` you can retrieve the user extension if to see if the `etag` has changed. If so, you can retrieve and update the image in your app.
+
+```ruby
+{
+  "uuid":"11112222-0000-0000-0000-333344445555",
+  "event":"/restapi/v1.0/account/11111111/extension",
+  "timestamp":"2016-11-23T16:42:08.482Z",
+  "subscriptionId":"11112222-1111-1111-1111-333344445555",
+  "body": {
+    "extensions":[
+      {"extensionId":"22222222","eventType":"Update"}
+    ]
+  }
+}
+```
+
+## Default images recipe
+
+To create default images we want to do a few things:
+
+1. Get a list of all extensions which do not have avatars
+2. Create and upload default images for extensions
+
+### Getting a list of extensions without avatars
+
+To get a list of extensions without avatars, we need to get a list of all extensions and then filter for users without avatars. Since we do not have a way to do this server-side, we will retrieve all extensions and then filter client-side.
+
+For the client-side filter, we will look for the `profileImage.etag` property. The `etag` property will not exist if there is no avatar which is an easy way to identify users that need a default avatar.
+
+For example:
+
+```ruby
+require 'ringcentral_sdk'
+
+client = RingCentralSdk.new ...
+client.authorize ...
+
+# Retrieve up to 1000 extensions
+res = client.http.get do |req|
+  req.url 'account/~/extension'
+  req.params['perPage'] = 1000
+end
+
+# Filter for users without avatars
+res.body['records'].each do |ext|
+  next unless ext['profileImage'].key? 'etag'
+end
+```
+
+The above will work with up to 1000 users. For over 1000 users, you will need to either follow the `navigation.nextPage` property yourself or use the `RingCentralSdk::REST::Cache::Extensions` gem. `RingCentral::Avatars` uses the extension cache similar to the following:
+
+```ruby
+# Load the cache
+cache = RingCentralSdk::REST::Cache::Extensions.new client
+cache.retrieve_all
+
+# Cycle through the users
+cache.extensions_hash.each do |ext_id, ext|
+  next unless ext['profileImage'].key? 'etag'
+end
+```
+
+### Creating the default image
+
+The default image can be created in one of several ways that including:
+
+1. User initials, like Gmail, Office 365, etc.
+2. Identicons, like GitHub, Stack Overflow, Wordpress, etc.
+
+Both of these are supported directly within `ringcentral-avatars` using `avatarly` and `ruby_identicon` to generate default images. They also both generate blobs:
+
+```ruby
+# Using Initials
+require 'avatarly'
+blob = Avatarly.generate_avatar 'AZ'
+
+# Using Identicons
+require 'ruby_identicon'
+blob = RubyIdenticon.create 'AZ'
+```
+
+More information can be found for these particular libraries:
+
+* [`avatarly`](https://rubygems.org/gems/avatarly)
+* [`ruby_identicon`](https://rubygems.org/gems/ruby_identicon)
+
+### Identifying auto-generated default images
+
+Sometimes there may be a need to identify and overwrite only auto-generated images. The code above will not do this because auto-generated images will have an `etag` like user submitted images.
+
+To resolve this, you can add a tag to the image itself which means each image will need to be retrieved and inspected. `ringcentral-avatars` supports setting PNG metadata attributes that can be used to identify default avatars. This can be done using [`chunky_png`](https://rubygems.org/gems/chunky_png):
+
+```ruby
+require 'chunky_png'
+
+img = ChunkyPNG::Image.from_blob blob
+img.metadata = { 'Description' => 'My Default Avatar' }
+blob = img.to_blob
+```
+
+For JPEG, Exif can be implemented and is left as a future exercise.
+
+### Wrapping it up
+
+Much of this code has been implemented in the [`ringcentral-avatars`](https://rubygems.org/gems/ringcentral-avatars) gem and can be inspected in the gem's source code on GitHub. To use the gem to update your avatar, you can simply use the following commands:
+
+```ruby
+require 'ringcentral-avatars'
+require 'ringcentral_sdk'
+
+client = RingCentralSdk.new [...]
+
+avatars = RingCentral::Avatars.new client                                # Default options
+avatars = RingCentral::Avatars.new client, avatar_opts: {font_size: 275} # Avatarly options
+
+avatars.create_defaults             # create default avatars only
+avatars.create_all                  # create all avatars, overwriting existing avatars
+
+avatars.create_mine                 # does not overwrite existing user avatar
+avatars.create_mine overwrite: true # overwrite existing user avatar
+
+avatars.create_avatar ext                  # create a default for an extension hash
+avatars.create_avatar ext, overwrite: true # overwrite existing for an extension hash
+```
+
+## Notes
+
+### Throttling
+
+When retrieving and uploading many images, your application can be throttled if it is making API requests above the rate specified in your usage plan. To resolve this, you can make calls one at a time and examine the response status and headers. For example:
+
+1. A `429` status will indicate your app is being throttled. It should wait the specified amount of seconds specified in the `Retry-After` header and then retry the request.
+2. A `X-Rate-Limit-Remaining` of `0` will indicate that the app has used up its allotment of API calls for the window and should wait the amount of seconds specified in the `X-Rate-Limit-Window` header.
+
+Pseudo code for this is:
+
+```ruby
+if res.status == 429
+  // Wait for the specified time
+  sleep res.headers['Retry-After'].to_i
+  // Retry the request
+  client.http.get ...
+elsif res.headers['X-Rate-Limit-Remaining'].to_i == 0
+  sleep res.headers['X-Rate-Limit-Window'].to_i
+end
+```
+
+In a future release, this type of throttling should be automatically built into the Ruby SDK.
+
+## Summary
+
+The RingCentral Profile Image API is a useful way to upload corporate address book images individually and administratively. It can be used for exciting use cases like directory sync, upload from mobile phones and setting default images.
+
+If you have questions on this API or this gem, please feel free to ask on the following sites:
+
+* [Stack Overflow](http://stackoverflow.com/questions/tagged/ringcentral)
+* [GitHub](https://github.com/ringcentral-ruby/ringcentral-avatars-ruby/issues)

data/README.md

@@ -4,6 +4,7 @@ RingCentral Avatars
 [![Gem Version][gem-version-svg]][gem-version-link]
 [![Build Status][build-status-svg]][build-status-link]
 [![Dependency Status][dependency-status-svg]][dependency-status-link]
+[![Codacy Badge][codacy-svg]][codacy-link]
 [![Code Climate][codeclimate-status-svg]][codeclimate-status-link]
 [![Scrutinizer Code Quality][scrutinizer-status-svg]][scrutinizer-status-link]
 [![Downloads][downloads-svg]][downloads-link]
@@ -49,7 +50,7 @@ $ gem install ringcentral-avatars
 require 'ringcentral-avatars'
 require 'ringcentral_sdk'
 
-client = RingCentralSdk.new [...]
+client = RingCentralSdk::REST::Client.new [...]
 
 avatars = RingCentral::Avatars.new client                                # Default options
 avatars = RingCentral::Avatars.new client, avatar_opts: {font_size: 275} # Avatarly options
@@ -64,7 +65,8 @@ avatars.create_avatar ext                  # create a default for an extension h
 avatars.create_avatar ext, overwrite: true # overwrite existing for an extension hash
 ```
 
-See [Avatarly](https://github.com/lucek/avatarly) for avatar customization options. The default avatar size is `600`.
+* For batch operations, consider using [RingCentral SDK's] `config.retry = true` option for automatic handling of rate limiting using 429 headers.
+* For avatar customization, see [Avatarly](https://github.com/lucek/avatarly) options. The default avatar size is `600`.
 
 ### Adding PNG Metadata
 
@@ -103,10 +105,36 @@ $ ruby get_avatar.rb
 $ ruby avatar_info.rb
 ```
 
+## Test Uploads
+
+The `scripts` directory contains test images for `png`, `jpg`, and `gif` file types: `test_filetype_png.png`, `test_filetype_jpg.jpg`, and `test_filetype_gif.gif`.
+
+### Test Upload Script
+
+This repo also includes test scripts to upload PNG, JPG, and GIF format images.
+
+```bash
+$ cd ringcentral-avatars-ruby/scripts
+$ vi .env
+$ ruby test_filetype.rb --filetype=png
+$ ruby test_filetype.rb --filetype=jpg
+$ ruby test_filetype.rb --filetype=gif
+```
+
+### Test cURL Command
+
+```bash
+$ curl -v -H 'Authorization: Bearer <MY_ACCESS_TOKEN>' -F image=@test_filetype_gif.gif 'https://platform.devtest.ringcentral.com/restapi/v1.0/account/~/extension/~/profile-image'
+```
+
 ### Change Log
 
 See [CHANGELOG.md](CHANGELOG.md)
 
+## Credits
+
+Test icons files are adapted from freeware [Filetype Icons](http://www.iconarchive.com/show/filetype-icons-by-graphicloads.html) by [GraphicLoads](http://www.iconarchive.com/artist/graphicloads.html).
+
 ## Links
 
 Project Repo
@@ -145,6 +173,8 @@ RingCentral Avatars &copy; 2016 by John Wang
  [downloads-link]: https://rubygems.org/gems/ringcentral-avatars
  [build-status-svg]: https://api.travis-ci.org/ringcentral-ruby/ringcentral-avatars-ruby.svg?branch=master
  [build-status-link]: https://travis-ci.org/ringcentral-ruby/ringcentral-avatars-ruby
+ [codacy-svg]: https://api.codacy.com/project/badge/Grade/e82eac58a42d4463885627f78098bbb0
+ [codacy-link]: https://www.codacy.com/app/johncwang/ringcentral-avatars-ruby
  [coverage-status-svg]: https://coveralls.io/repos/ringcentral-ruby/ringcentral-avatars-ruby/badge.svg?branch=master
  [coverage-status-link]: https://coveralls.io/r/ringcentral-ruby/ringcentral-avatars-ruby?branch=master
  [dependency-status-svg]: https://gemnasium.com/ringcentral-ruby/ringcentral-avatars-ruby.svg

data/lib/ringcentral-avatars.rb

@@ -2,7 +2,7 @@ require 'ringcentral-avatars/creator'
 
 module RingCentral
   module Avatars
-    VERSION = '0.4.1'
+    VERSION = '0.5.0'.freeze
 
     class << self
       def new(client, opts = {})

data/lib/ringcentral-avatars/creator.rb

@@ -3,6 +3,8 @@ require 'chunky_png'
 require 'ruby_identicon'
 
 require 'faraday'
+require 'faraday_middleware-request-retry'
+require 'logger'
 require 'mime/types'
 require 'ringcentral_sdk'
 require 'tempfile'
@@ -11,16 +13,17 @@ module RingCentral
   module Avatars
     class Creator
       DEFAULT_SIZE = 600
-      DEFAULT_FORMAT = 'png'
+      DEFAULT_FORMAT = 'png'.freeze
       PNG_DEFAULT_METADATA = {
         'Description' => 'RingCentral Default Avatar'
-      }
+      }.freeze
 
       attr_accessor :avatar_opts
       attr_accessor :avatars
       attr_accessor :client
       attr_accessor :extensions
       attr_accessor :png_metadata
+      attr_accessor :retry
 
       ##
       # Requires RingCentralSdk instance
@@ -30,12 +33,16 @@ module RingCentral
         if !opts.key?(:initials_opts) && opts.key?(:avatar_opts)
           opts[:initials_opts] = opts[:avatar_opts]
         end
-        if opts.key(:png_metadata)
+        if opts.key? :png_metadata
           opts[:png_metadata] = PNG_DEFAULT_METADATA.merge(opts[:png_metadata])
         else
           opts[:png_metadata] = PNG_DEFAULT_METADATA
         end
+        opts[:logger] = @client.config.logger
+        @retry = opts.key?(:retry) && opts[:retry] ? true : false
+        opts[:retry] = @retry
         @avatars = RingCentral::Avatars::MultiAvatar.new opts
+        @retry_util = FaradayMiddleware::Request::RetryUtil.new logger: client.config.logger
         load_extensions
       end
 
@@ -52,7 +59,7 @@ module RingCentral
       # Defaults to overwriting existing avatar
       def create_all(opts = {})
         opts[:overwrite] = true unless opts.key?(:overwrite)
-        @extensions.extensions_hash.each do |ext_id, ext|
+        @extensions.extensions_hash.each do |_ext_id, ext|
           create_avatar ext, opts
         end
         load_extensions
@@ -62,10 +69,13 @@ module RingCentral
       # Convenience method for creating avatar for authorized extension
       # Defaults to not overwriting existing avatar
       def create_mine(opts = {})
-        res_ext = @client.http.get 'account/~/extension/~'
-        res_av = create_avatar res_ext.body, opts
-        load_extensions
-        res_av
+        try_req = true
+        while try_req
+          res_ext = @client.http.get 'account/~/extension/~'
+          try_req = retry_status res_ext
+        end
+        res_avt = create_avatar res_ext.body, opts
+        res_avt
       end
 
       ##
@@ -73,16 +83,29 @@ module RingCentral
       # Defaults to not overwriting existing avatar
       def create_avatar(ext, opts = {})
         opts[:overwrite] = false unless opts.key?(:overwrite)
-        return if has_avatar(ext) && !opts[:overwrite]
+        if avatar?(ext) && !opts[:overwrite]
+          return nil
+        end
         url = "account/~/extension/#{ext['id']}/profile-image"
-        image = @avatars.avatar_faraday_uploadio ext['name']
-        @client.http.put url, image: image
+        res_avt = nil
+        try_req = true
+        while try_req
+          image = @avatars.avatar_faraday_uploadio ext['name']
+          res_avt = @client.http.put url, image: image
+          try_req = retry_status res_avt
+        end
+        res_avt
+      end
+
+      def retry_status(res)
+        return false unless @retry
+        @retry_util.retry_status(res.status, res.headers['Retry-After'])
       end
 
       ##
       # Determines if extension has an existing avatar
       # Checks by looking for the presence of the `etag` property
-      def has_avatar(ext)
+      def avatar?(ext)
         ext['profileImage'].key?('etag') ? true : false
       end
 
@@ -124,23 +147,24 @@ end
 module RingCentral
   module Avatars
     class MultiAvatar
-      DEFAULT_STYLE = 'initials'
+      DEFAULT_STYLE = 'initials'.freeze
       AVATARLY_DEFAULTS = {
         size: 600,
         format: 'png'
-      }
+      }.freeze
       IDENTICON_DEFAULTS = {
         grid_size: 5,
         square_size: 70,
         background_color: 0xffffffff
-      }
-      IDENTICON_DEFAULT_FORMAT = 'png'
+      }.freeze
+      IDENTICON_DEFAULT_FORMAT = 'png'.freeze
 
       def initialize(opts = {})
         @avatarly_opts =  inflate_avatarly_opts opts[:initials_opts]
         @identicon_opts = inflate_identicon_opts opts[:identicon_opts]
         @style = opts.key?(:style) ? opts[:style] : DEFAULT_STYLE
         @png_metadata = opts.key?(:png_metadata) ? opts[:png_metadata] : {}
+        @logger = opts.key?(:logger) ? opts[:logger] : Logger.new(STDOUT)
       end
 
       def inflate_avatarly_opts(avatarly_opts = {})
@@ -155,7 +179,7 @@ module RingCentral
 
       def avatar_blob(text, style = nil)
         style = @style if style.nil?
-        blob = @style == 'initials' \
+        blob = style == 'initials' \
           ? Avatarly.generate_avatar(text, @avatarly_opts) \
           : RubyIdenticon.create(text, @identicon_opts)
         inflate_avatar_blob_png blob
@@ -179,7 +203,8 @@ module RingCentral
 
       def avatar_faraday_uploadio(text, style = nil)
         file = avatar_temp_file text, style
-        image = Faraday::UploadIO.new file.path, avatar_mime_type
+        @logger.debug "Building Avatar Temp File: #{file.path}"
+        Faraday::UploadIO.new file.path, avatar_mime_type
       end
 
       def avatar_format
@@ -188,7 +213,7 @@ module RingCentral
 
       def avatar_mime_type
         types = MIME::Types.type_for avatar_format
-        if types.length == 0
+        if types.empty?
           raise "Unknown avatar format: #{avatar_format}"
         end
         types[0].to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral-avatars
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-19 00:00:00.000000000 Z
+date: 2016-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avatarly
@@ -96,20 +96,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.4
+        version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.4
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: ruby_identicon
   requirement: !ruby/object:Gem::Requirement
@@ -164,14 +164,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -208,7 +208,9 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.md
+- NEWS.md
 - README.md
 - Rakefile
 - lib/ringcentral-avatars.rb
@@ -233,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: RingCentral library for auto-generating Gmail style avatars