ringcentral-avatars 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e54f32761102a609bd4076cf6ffbe88261ac5ee0
-  data.tar.gz: ccdf57695c53e2662927b203ae10705369574c6c
+  metadata.gz: d0de1fd59ec9b1ea838bf6e84407c95945ad7c3a
+  data.tar.gz: b1bc23a2801a87ef5a69b8e88c1afe8b7ac26a9e
 SHA512:
-  metadata.gz: 55588a39b9a842c70aaa38611d6f7dc2e0fc61dbe62af89425815e644db2c9b9fed4189b4b4b0ff3a5c3915344707c9e0805907e31f98e58fe67181d0f774dcd
-  data.tar.gz: f59211bf0735da463841934547afc1deb3ca4f0760729e893ba166567654936ebec566fa3d1dc4b3e94a1f5433d6e73a10d0dbbcd69ee85f519f7f9b536e22b4
+  metadata.gz: 7ab6a4431c749a1ddd8b209c5c79dda7b77742b15ae9add3fbe3db4d2eebe68bcdc21e4c8c74bdf2ab055a06f8413bdbd2574546ed91c143fcb30f5a6874109c
+  data.tar.gz: aafb64c078b6484f52bcb3f7ca7fb0872139406814338136fc10cb2349a31771229a19c0e042db7b2d05d4b3535bd44254212255275e9aec43bd42f855bd0b14

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 CHANGELOG
 ---------
-- **2016-10-22**: 0.0.2
+- **2016-10-22**: 0.1.0
+  - Update module name
+  - Update method signatures for options
+- **2016-10-22**: 0.0.1
   - Initial release
   - Add ability to create Gmail-like avatars
   - Add ability to create defaults-only and optionally overwrite all

data/README.md

@@ -7,13 +7,33 @@ RingCentral Avatars
 [![Code Climate][codeclimate-status-svg]][codeclimate-status-link]
 [![Scrutinizer Code Quality][scrutinizer-status-svg]][scrutinizer-status-link]
 [![Downloads][downloads-svg]][downloads-link]
-[![Docs][docs-readthedocs-svg]][docs-readthedocs-link]
 [![Docs][docs-rubydoc-svg]][docs-rubydoc-link]
 [![License][license-svg]][license-link]
 
 ## Overview
 
-This library will build RingCentral avatars using Gmail-like initial avatars. It requires ImageMagick.
+This library will build RingCentral avatars using Gmail-like initial avatars. It can build Gmail-like avatars for the following:
+
+* all RingCentral users (extensions) without images
+* all RingCentral users, overwriting existing images (useful for testing in Sandbox accounts)
+* specific extensions
+* authorized user extension only
+
+The images will look like the following in the RingCentral softphone:
+
+![](docs/images/ringcentral-avatars-softphone.png)
+
+## Pre-requisites
+
+* This library requires ImageMagick
+* This library requires a RingCentral account
+* A RingCentral administrator account is necessary to update profile images for others
+
+## Installation
+
+```bash
+$ gem install ringcentral-avatars
+```
 
 ## Usage
 
@@ -23,12 +43,13 @@ require 'ringcentral_sdk'
 
 client = RingCentralSdk.new [...]
 
-avatars = RingCentralAvatars.new client
+avatars = RingCentral::Avatars.new client
 
-avatars.create_all       # create defaults only
-avatars.create_all  true # overwrite existing avatars
+avatars.create_defaults             # create default avatars only
+avatars.create_all                  # create all avatars, overwriting existing avatars
 
-avatars.create_mine      # create for authorized user only
+avatars.create_mine                 # does not overwrite user avatar
+avatars.create_mine overwrite: true # overwrite existing user avatars
 ```
 
 ### Change Log
@@ -47,7 +68,7 @@ RingCentral Ruby SDK
 
 RingCentral API Explorer
 
-* http://ringcentral.github.io/api-explorer
+* https://developer.ringcentral.com/api-explorer/latest/index.html
 
 ## Contributing
 
@@ -77,8 +98,6 @@ RingCentral Avatars © 2016 by John Wang
  [codeclimate-status-link]: https://codeclimate.com/github/ringcentral-ruby/ringcentral-avatars-ruby
  [scrutinizer-status-svg]: https://scrutinizer-ci.com/g/ringcentral-ruby/ringcentral-avatars-ruby/badges/quality-score.png?b=master
  [scrutinizer-status-link]: https://scrutinizer-ci.com/g/ringcentral-ruby/ringcentral-avatars-ruby/?branch=master
- [docs-readthedocs-svg]: https://img.shields.io/badge/docs-readthedocs-blue.svg
- [docs-readthedocs-link]: http://ringcentral-avatars-ruby.readthedocs.org/
  [docs-rubydoc-svg]: https://img.shields.io/badge/docs-rubydoc-blue.svg
  [docs-rubydoc-link]: http://www.rubydoc.info/gems/ringcentral-avatars/
  [license-svg]: https://img.shields.io/badge/license-MIT-blue.svg

data/lib/ringcentral-avatars.rb

@@ -1,11 +1,13 @@
 require 'ringcentral-avatars/creator'
 
-module RingCentralAvatars
-  VERSION = '0.0.1'
+module RingCentral
+  module Avatars
+    VERSION = '0.1.0'
 
-  class << self
-    def new(client)
-      RingCentralAvatars::Creator.new client
+    class << self
+      def new(client)
+        RingCentral::Avatars::Creator.new client
+      end
     end
   end
-end
+end

data/lib/ringcentral-avatars/creator.rb

@@ -3,76 +3,103 @@ require 'faraday'
 require 'ringcentral_sdk'
 require 'tempfile'
 
-module RingCentralAvatars
-  class Creator
-    DEFAULT_SIZE = 600
+module RingCentral
+  module Avatars
+    class Creator
+      DEFAULT_SIZE = 600
 
-    attr_accessor :client
-    attr_accessor :extensions
+      attr_accessor :client
+      attr_accessor :extensions
 
-    def initialize(client)
-      @client = client
-      load_extensions
-    end
+      def initialize(client)
+        @client = client
+        load_extensions
+      end
 
-    def create_all(overwrite = false)
-      @extensions.extensions_hash.each do |ext_id, ext|
-        create_avatar ext, overwrite
+      ##
+      # Convenience method for creating default avatars for all extensions
+      # Defaults to not overwriting existing avatars
+      def create_defaults(opts = {})
+        opts[:overwrite] = false
+        create_all opts
       end
-      load_extensions
-    end
 
-    def create_mine(overwrite = false)
-      res = @client.http.get 'account/~/extension/~'
-      create_avatar res.body, overwrite
-      load_extensions
-    end
+      ##
+      # Convenience method for creating avatars for all extensions
+      # Defaults to overwriting existing avatar
+      def create_all(opts = {})
+        opts[:overwrite] = true unless opts.key?(:overwrite)
+        @extensions.extensions_hash.each do |ext_id, ext|
+          create_avatar ext, opts
+        end
+        load_extensions
+      end
 
-    def create_avatar(ext, overwrite = false)
-      return if has_avatar(ext) && !overwrite
-      avatar_temp = get_avatar_tmp_file ext
-      url = "account/~/extension/#{ext['id']}/profile-image"
-      image = Faraday::UploadIO.new(avatar_temp.path, 'image/png')
-      @client.http.put url, image: image
-    end
+      ##
+      # Convenience method for creating avatar for authorized extension
+      # Defaults to not overwriting existing avatar
+      def create_mine(opts = {})
+        res = @client.http.get 'account/~/extension/~'
+        create_avatar res.body, opts
+        load_extensions
+      end
 
-    def has_avatar(ext)
-      return ext['profileImage'].key?('etag') ? true : false
-    end
+      ##
+      # Create the avatar for the extension.
+      # 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]
+        avatar_temp = get_avatar_tmp_file ext
+        url = "account/~/extension/#{ext['id']}/profile-image"
+        image = Faraday::UploadIO.new(avatar_temp.path, 'image/png')
+        @client.http.put url, image: image
+      end
 
-    def get_avatar_tmp_file(ext)
-      avatar_blob = Avatarly.generate_avatar(ext['name'], size: DEFAULT_SIZE)
-      avatar_temp = Tempfile.new(['avatar', '.png'])
-      avatar_temp.binmode
-      avatar_temp.write(avatar_blob)
-      avatar_temp.flush
-      avatar_temp
-    end
+      ##
+      # Determines if extension has an existing avatar
+      # Checks by looking ofr the presence of the `etag` property
+      def has_avatar(ext)
+        return ext['profileImage'].key?('etag') ? true : false
+      end
 
-    def load_extensions
-      @extensions = RingCentralSdk::REST::Cache::Extensions.new client
-      @extensions.retrieve_all
-    end
+      def get_avatar_tmp_file(ext)
+        avatar_blob = Avatarly.generate_avatar(ext['name'], size: DEFAULT_SIZE)
+        avatar_temp = Tempfile.new(['avatar', '.png'])
+        avatar_temp.binmode
+        avatar_temp.write(avatar_blob)
+        avatar_temp.flush
+        avatar_temp
+      end
 
-    def avatar_urls(include_token = false)
-      urls = []
-      @extensions.extensions_hash.keys.sort.each do |ext_id|
-        ext = @extensions.extensions_hash[ext_id]
-        urls.push avatar_url(ext, include_token)
+      def load_extensions
+        @extensions = RingCentralSdk::REST::Cache::Extensions.new client
+        @extensions.retrieve_all
       end
-      return urls
-    end
 
-    def my_avatar_url(include_token = false)
-      res = @client.http.get 'account/~/extension/~'
-      avatar_url(res.body, include_token)
-    end
+      ##
+      # Returns a list of avatar URLs which can be useful for testing purposes
+      # Adding the current access token is optional
+      def avatar_urls(include_token = false)
+        urls = []
+        @extensions.extensions_hash.keys.sort.each do |ext_id|
+          ext = @extensions.extensions_hash[ext_id]
+          urls.push avatar_url(ext, include_token)
+        end
+        return urls
+      end
+
+      def my_avatar_url(include_token = false)
+        res = @client.http.get 'account/~/extension/~'
+        avatar_url(res.body, include_token)
+      end
 
-    def avatar_url(ext, include_token = false)
-      token = @client.token.to_hash[:access_token]
-      url = ext['profileImage']['uri']
-      url += "?access_token=#{token}" if include_token
-      return url
+      def avatar_url(ext, include_token = false)
+        token = @client.token.to_hash[:access_token]
+        url = ext['profileImage']['uri']
+        url += "?access_token=#{token}" if include_token
+        return url
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral-avatars
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - John Wang