ringcentral-avatars 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ddb51ed74a787bcf1d66710f68078c96b8ed57f
-  data.tar.gz: 9632d38f8214ceb65d443571e74d7ad784a125f6
+  metadata.gz: de1d875273729241a28c7c2b88024271c61d68ad
+  data.tar.gz: 5d2fdedfed5cbba6bd7a2d8f3815af22a980feed
 SHA512:
-  metadata.gz: d3389e05df79a6c3b8618fec0be7b55c3005147c1f9543181faa7e5939bc5f096a903d98484cca2a841be7adab0598b227c23c94b365e06a03b7e166bbd38186
-  data.tar.gz: d924730e79e29bb6e71a14f7cbf99cc25ba69c36bcb9413b047f3da49ac808cf08395e197e65ff563be747eb8ae745ad74b56410b86d9b5eeb08465087465855
+  metadata.gz: dac1b2e8fed36e6c20678e7c891d1b96de95b3e4c6b8aa563928e80c3d107289a3c253bc147406459d3167d9dde26905b1fab322d7c793b82cba8952bd293078
+  data.tar.gz: 10c8c9bd8cbbd2ac4bd1e150cb988084d23e5829eace6ab46e41d51a411d17eb9a85e512a6b46075c76d358554f99bbf613fc13dfd6c6901da54bc59882c61fb

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 CHANGELOG
 ---------
+- **2016-11-03**: 0.3.1
+  - Add screenshot image to `gemspec`
+- **2016-10-24**: 0.3.0
+  - Add identicon support
 - **2016-10-23**: 0.2.0
   - Add avatar customization options
   - Update avatar URLs method signature for options

data/README.md

@@ -12,7 +12,7 @@ RingCentral Avatars
 
 ## Overview
 
-This library will build RingCentral avatars using Gmail-like initial avatars. It can build Gmail-like avatars for the following:
+This library will build [RingCentral](https://ringcentral.com) avatars using Gmail-like default 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)
@@ -25,10 +25,12 @@ By default, the images will look like the following in the RingCentral softphone
 
 This library uses [Avatarly](https://github.com/lucek/avatarly) to generate the avatars and can pass through any avatar option for customization purposes.
 
+Experimental [Identicon](https://en.wikipedia.org/wiki/Identicon) support is also included via [ruby_identicon](https://github.com/chrisbranson/ruby_identicon). Please see the source for usage until it gets a bit more use.
+
 ## Pre-requisites
 
 * ImageMagick
-* A RingCentral account (production or sandbox)
+* A RingCentral account (production or sandbox) with [REST API access](https://developers.ringcentral.com)
 * 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.
@@ -48,13 +50,16 @@ require 'ringcentral_sdk'
 client = RingCentralSdk.new [...]
 
 avatars = RingCentral::Avatars.new client                                # Default options
-avatars = RingCentral::Avatars.new client, avatar_opts: {font_size: 250} # Avatarly 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
 ```
 
 See [Avatarly](https://github.com/lucek/avatarly) for avatar customization options. The default avatar size is `600`.

data/lib/ringcentral-avatars.rb

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

data/lib/ringcentral-avatars/creator.rb

@@ -2,14 +2,17 @@ require 'avatarly'
 require 'faraday'
 require 'mime/types'
 require 'ringcentral_sdk'
+require 'ruby_identicon'
 require 'tempfile'
 
 module RingCentral
   module Avatars
     class Creator
       DEFAULT_SIZE = 600
+      DEFAULT_FORMAT = 'png'
 
       attr_accessor :avatar_opts
+      attr_accessor :avatars
       attr_accessor :client
       attr_accessor :extensions
 
@@ -18,19 +21,11 @@ module RingCentral
       # `: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'
+        if !opts.key?(:initials_opts) && opts.key?(:avatar_opts)
+          opts[:initials_opts] = opts[:avatar_opts]
         end
-        return avatar_opts
+        @avatars = RingCentral::Avatars::MultiAvatar.new opts
+        load_extensions
       end
 
       ##
@@ -68,26 +63,16 @@ module RingCentral
       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, avatar_mime_type
+        image = @avatars.avatar_faraday_uploadio ext['name']
         @client.http.put url, image: image
       end
 
       ##
       # Determines if extension has an existing avatar
-      # Checks by looking ofr the presence of the `etag` property
+      # Checks by looking for the presence of the `etag` property
       def has_avatar(ext)
-        return ext['profileImage'].key?('etag') ? true : false
-      end
-
-      def get_avatar_tmp_file(ext)
-        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
-        avatar_temp
+        ext['profileImage'].key?('etag') ? true : false
       end
 
       def load_extensions
@@ -105,7 +90,7 @@ module RingCentral
           ext = @extensions.extensions_hash[ext_id]
           urls.push avatar_url(ext, opts)
         end
-        return urls
+        urls
       end
 
       def my_avatar_url(opts = {})
@@ -119,19 +104,78 @@ module RingCentral
         token = @client.token.to_hash[:access_token]
         url = ext['profileImage']['uri']
         url += "?access_token=#{token}" if opts[:include_token]
-        return url
+        url
+      end
+    end
+  end
+end
+
+module RingCentral
+  module Avatars
+    class MultiAvatar
+      DEFAULT_STYLE = 'initials'
+      AVATARLY_DEFAULTS = {
+        size: 600,
+        format: 'png'
+      }
+      IDENTICON_DEFAULTS = {
+        grid_size: 5,
+        square_size: 70,
+        background_color: 0xffffffff
+      }
+      IDENTICON_DEFAULT_FORMAT = 'png'
+
+      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
+      end
+
+      def inflate_avatarly_opts(avatarly_opts = {})
+        avatarly_opts = {} unless avatarly_opts.is_a? Hash
+        AVATARLY_DEFAULTS.merge avatarly_opts
+      end
+
+      def inflate_identicon_opts(identicon_opts = {})
+        identicon_opts = {} unless identicon_opts.is_a? Hash
+        IDENTICON_DEFAULTS.merge identicon_opts
+      end
+
+      def avatar_blob(text, style = nil)
+        style = @style if style.nil?
+        blob = @style == 'initials' \
+          ? Avatarly.generate_avatar(text, @avatarly_opts) \
+          : RubyIdenticon.create(text, @identicon_opts)
+      end
+
+      def avatar_temp_file(text, style = nil)
+        blob = avatar_blob text, style
+        file = Tempfile.new ['avatar', avatar_extension]
+        file.binmode
+        file.write blob
+        file.flush
+        file
+      end
+
+      def avatar_faraday_uploadio(text, style = nil)
+        file = avatar_temp_file text, style
+        image = Faraday::UploadIO.new file.path, avatar_mime_type
+      end
+
+      def avatar_format
+        @style == 'initials' ? @avatarly_opts[:format] : IDENTICON_DEFAULT_FORMAT
       end
 
       def avatar_mime_type
-        types = MIME::Types.type_for @avatar_opts[:format]
+        types = MIME::Types.type_for avatar_format
         if types.length == 0
-          raise "Unknown avatar format: #{@avatar_opts[:format]}"
+          raise "Unknown avatar format: #{avatar_format}"
         end
-        return types[0].to_s
+        types[0].to_s
       end
 
       def avatar_extension
-        ".#{@avatar_opts[:format]}"
+        ".#{avatar_format}"
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral-avatars
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-23 00:00:00.000000000 Z
+date: 2016-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avatarly
@@ -91,76 +91,96 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.3.4
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: ruby_identicon
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
     - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Create RingCentral default avatars using Gmail-style initial avatars
+        version: '3'
+description: Create RingCentral avatars using Gmail-style avatars
 email: johncwang@gmail.com
 executables: []
 extensions: []
@@ -171,6 +191,7 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- docs/images/ringcentral-avatars-softphone.png
 - lib/ringcentral-avatars.rb
 - lib/ringcentral-avatars/creator.rb
 homepage: https://github.com/grokify/