ringcentral-avatars 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0de1fd59ec9b1ea838bf6e84407c95945ad7c3a
-  data.tar.gz: b1bc23a2801a87ef5a69b8e88c1afe8b7ac26a9e
+  metadata.gz: 6ddb51ed74a787bcf1d66710f68078c96b8ed57f
+  data.tar.gz: 9632d38f8214ceb65d443571e74d7ad784a125f6
 SHA512:
-  metadata.gz: 7ab6a4431c749a1ddd8b209c5c79dda7b77742b15ae9add3fbe3db4d2eebe68bcdc21e4c8c74bdf2ab055a06f8413bdbd2574546ed91c143fcb30f5a6874109c
-  data.tar.gz: aafb64c078b6484f52bcb3f7ca7fb0872139406814338136fc10cb2349a31771229a19c0e042db7b2d05d4b3535bd44254212255275e9aec43bd42f855bd0b14
+  metadata.gz: d3389e05df79a6c3b8618fec0be7b55c3005147c1f9543181faa7e5939bc5f096a903d98484cca2a841be7adab0598b227c23c94b365e06a03b7e166bbd38186
+  data.tar.gz: d924730e79e29bb6e71a14f7cbf99cc25ba69c36bcb9413b047f3da49ac808cf08395e197e65ff563be747eb8ae745ad74b56410b86d9b5eeb08465087465855

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 CHANGELOG
 ---------
-- **2016-10-22**: 0.1.0
+- **2016-10-23**: 0.2.0
+  - Add avatar customization options
+  - Update avatar URLs method signature for options
+- **2016-10-23**: 0.1.0
   - Update module name
   - Update method signatures for options
 - **2016-10-22**: 0.0.1

data/README.md

@@ -19,16 +19,20 @@ This library will build RingCentral avatars using Gmail-like initial avatars. It
 * specific extensions
 * authorized user extension only
 
-The images will look like the following in the RingCentral softphone:
+By default, the images will look like the following in the RingCentral softphone:
 
 ![](docs/images/ringcentral-avatars-softphone.png)
 
+This library uses [Avatarly](https://github.com/lucek/avatarly) to generate the avatars and can pass through any avatar option for customization purposes.
+
 ## Pre-requisites
 
-* This library requires ImageMagick
-* This library requires a RingCentral account
+* ImageMagick
+* A RingCentral account (production or sandbox)
 * A RingCentral administrator account is necessary to update profile images for others
 
+Test first in sandbox. Your app needs to be graduated in order to run against your production account.
+
 ## Installation
 
 ```bash
@@ -43,15 +47,18 @@ require 'ringcentral_sdk'
 
 client = RingCentralSdk.new [...]
 
-avatars = RingCentral::Avatars.new client
+avatars = RingCentral::Avatars.new client                                # Default options
+avatars = RingCentral::Avatars.new client, avatar_opts: {font_size: 250} # Avatarly options
 
 avatars.create_defaults             # create default avatars only
 avatars.create_all                  # create all avatars, overwriting existing avatars
 
-avatars.create_mine                 # does not overwrite user avatar
-avatars.create_mine overwrite: true # overwrite existing user avatars
+avatars.create_mine                 # does not overwrite existing user avatar
+avatars.create_mine overwrite: true # overwrite existing user avatar
 ```
 
+See [Avatarly](https://github.com/lucek/avatarly) for avatar customization options. The default avatar size is `600`.
+
 ### Change Log
 
 See [CHANGELOG.md](CHANGELOG.md)

data/lib/ringcentral-avatars.rb

@@ -2,11 +2,11 @@ require 'ringcentral-avatars/creator'
 
 module RingCentral
   module Avatars
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
 
     class << self
-      def new(client)
-        RingCentral::Avatars::Creator.new client
+      def new(client, opts = {})
+        RingCentral::Avatars::Creator.new client, opts
       end
     end
   end

data/lib/ringcentral-avatars/creator.rb

@@ -1,5 +1,6 @@
 require 'avatarly'
 require 'faraday'
+require 'mime/types'
 require 'ringcentral_sdk'
 require 'tempfile'
 
@@ -8,14 +9,30 @@ module RingCentral
     class Creator
       DEFAULT_SIZE = 600
 
+      attr_accessor :avatar_opts
       attr_accessor :client
       attr_accessor :extensions
 
-      def initialize(client)
+      ##
+      # Requires RingCentralSdk instance
+      # `:avatar_opts` is optional to pass-through options for Avatarly
+      def initialize(client, opts = {})
         @client = client
+        @avatar_opts = build_avatar_opts opts[:avatar_opts]
         load_extensions
       end
 
+      def build_avatar_opts(avatar_opts = {})
+        avatar_opts = {} unless avatar_opts.is_a? Hash
+        unless avatar_opts.key? :size
+          avatar_opts[:size] = DEFAULT_SIZE
+        end
+        unless avatar_opts.key? :format
+          avatar_opts[:format] = 'png'
+        end
+        return avatar_opts
+      end
+
       ##
       # Convenience method for creating default avatars for all extensions
       # Defaults to not overwriting existing avatars
@@ -39,9 +56,10 @@ module RingCentral
       # 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
+        res_ext = @client.http.get 'account/~/extension/~'
+        res_av = create_avatar res_ext.body, opts
         load_extensions
+        res_av
       end
 
       ##
@@ -52,7 +70,7 @@ module RingCentral
         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')
+        image = Faraday::UploadIO.new avatar_temp.path, avatar_mime_type
         @client.http.put url, image: image
       end
 
@@ -64,8 +82,8 @@ module RingCentral
       end
 
       def get_avatar_tmp_file(ext)
-        avatar_blob = Avatarly.generate_avatar(ext['name'], size: DEFAULT_SIZE)
-        avatar_temp = Tempfile.new(['avatar', '.png'])
+        avatar_blob = Avatarly.generate_avatar(ext['name'], @avatar_opts)
+        avatar_temp = Tempfile.new(['avatar', avatar_extension])
         avatar_temp.binmode
         avatar_temp.write(avatar_blob)
         avatar_temp.flush
@@ -80,26 +98,41 @@ module RingCentral
       ##
       # 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)
+      def avatar_urls(opts = {})
+        opts[:include_token] = false unless opts.key? :include_token
         urls = []
         @extensions.extensions_hash.keys.sort.each do |ext_id|
           ext = @extensions.extensions_hash[ext_id]
-          urls.push avatar_url(ext, include_token)
+          urls.push avatar_url(ext, opts)
         end
         return urls
       end
 
-      def my_avatar_url(include_token = false)
+      def my_avatar_url(opts = {})
+        opts[:include_token] = false unless opts.key? :include_token
         res = @client.http.get 'account/~/extension/~'
-        avatar_url(res.body, include_token)
+        avatar_url(res.body, opts)
       end
 
-      def avatar_url(ext, include_token = false)
+      def avatar_url(ext, opts = {})
+        opts[:include_token] = false unless opts.key? :include_token
         token = @client.token.to_hash[:access_token]
         url = ext['profileImage']['uri']
-        url += "?access_token=#{token}" if include_token
+        url += "?access_token=#{token}" if opts[:include_token]
         return url
       end
+
+      def avatar_mime_type
+        types = MIME::Types.type_for @avatar_opts[:format]
+        if types.length == 0
+          raise "Unknown avatar format: #{@avatar_opts[:format]}"
+        end
+        return types[0].to_s
+      end
+
+      def avatar_extension
+        ".#{@avatar_opts[:format]}"
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral-avatars
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-22 00:00:00.000000000 Z
+date: 2016-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avatarly
@@ -50,6 +50,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: ringcentral_sdk
   requirement: !ruby/object:Gem::Requirement