ringcentral-avatars 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 547569ee523ed52da761e2bde1736dcb5f10a2aa
-  data.tar.gz: ab3a0d87fd4ea1b7a70e7137078ac5dd64c8151d
+  metadata.gz: e71805854c33ad41768b9be7fea7a4b7d0b7ef68
+  data.tar.gz: cd302971a7e19a95769569540c0f04bd57232ed7
 SHA512:
-  metadata.gz: 4524892ec62a3e60546d023b8772cc57d74763f784a4d12a7fe1353e7928f7382ffdcdf9fb387600050c3b2a63a9ceed8c7753f0192b98efbf40a5ee84108612
-  data.tar.gz: af8b99a00ed0c44b0e235b02c3368042423f06e9e776333276e4b46439f9efe682987b3b2554f380d0f7af7fd6f5dbb6caaee44838333735ba63ff31cddecde5
+  metadata.gz: d64f64d610d2bcf710645a3018946fb00a0bf036b976b8f12e81813e51c8ccfb31eac6c410a544613de95960ca0fd7f2dd471f5b3bad3491a0fc3fa4c1c15a2b
+  data.tar.gz: 7c653fd002b68e77b289803ae96889b8d88fcd0d42de0c0b66b1f45cff49390f15b467b74c50f0e43e3b147bb0a3af7a7cf6ae17c5de1d08e342eddff8da184f

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 CHANGELOG
 ---------
+- **2016-11-19**: 0.4.0
+  - Add PNG metadata support
+  - Add demo scripts in `./scripts` directory
 - **2016-11-03**: 0.3.4-0.3.1
   - Add screenshot image to `gemspec`
   - Add identicon support

data/README.md

@@ -27,6 +27,8 @@ This library uses [Avatarly](https://github.com/lucek/avatarly) to generate the
 
 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.
 
+PNG metadata is supported which can be uploaded to and downloaded from RingCentral.
+
 ## Pre-requisites
 
 * ImageMagick
@@ -64,6 +66,43 @@ avatars.create_avatar ext, overwrite: true # overwrite existing for an extension
 
 See [Avatarly](https://github.com/lucek/avatarly) for avatar customization options. The default avatar size is `600`.
 
+### Adding PNG Metadata
+
+RingCentral Avatars supports adding PNG Metadata per the [W3C PNG Specification](https://www.w3.org/TR/PNG/#11textinfo). This can be useful for tracking avatars created by this library for selective updates vs. avatars uploaded via other means.
+
+The default description is `RingCentral Default Avatar`, however it can be modified as shown below.
+
+```ruby
+avatars = RingCentral::Avatars.new client, png_metadata: { 'Description': 'RingCentral Avatar' }
+
+avatars.png_metadata['Description'] = 'Updated Description'
+```
+
+## Sample Scripts
+
+The following sample scripts are provided in the GitHub repo under the `./scripts` directory.
+
+* `update_avatar.rb` - Updates all or own avatar image with optional rewrite CLI arguments.
+* `get_avatar.rb` - Retrieve and save own avatar image to `_my_avatar.png` file.
+* `avatar_info.rb` - Parses and dumps PNG metadata for validation of `_my_avatar.png` file.
+
+To run these files, install dependencies and configure the demo with the following: 
+
+```bash
+$ cd scripts
+$ bundle
+$ cp rc_config_sample.env.txt .env
+$ vi .env
+```
+
+Run the scripts with the following:
+
+```bash
+$ ruby update_avatar.rb --overwrite
+$ ruby get_avatar.rb
+$ ruby avatar_info.rb
+```
+
 ### Change Log
 
 See [CHANGELOG.md](CHANGELOG.md)
@@ -82,6 +121,10 @@ RingCentral API Explorer
 
 * https://developer.ringcentral.com/api-explorer/latest/index.html
 
+PNG Info
+
+* https://www.w3.org/TR/PNG/#11textinfo
+
 ## Contributing
 
 1. Fork it ( http://github.com/ringcentral-ruby/ringcentral-avatars-ruby/fork )

data/lib/ringcentral-avatars.rb

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

data/lib/ringcentral-avatars/creator.rb

@@ -1,8 +1,10 @@
 require 'avatarly'
+require 'chunky_png'
+require 'ruby_identicon'
+
 require 'faraday'
 require 'mime/types'
 require 'ringcentral_sdk'
-require 'ruby_identicon'
 require 'tempfile'
 
 module RingCentral
@@ -10,11 +12,15 @@ module RingCentral
     class Creator
       DEFAULT_SIZE = 600
       DEFAULT_FORMAT = 'png'
+      PNG_DEFAULT_METADATA = {
+        'Description' => 'RingCentral Default Avatar'
+      }
 
       attr_accessor :avatar_opts
       attr_accessor :avatars
       attr_accessor :client
       attr_accessor :extensions
+      attr_accessor :png_metadata
 
       ##
       # Requires RingCentralSdk instance
@@ -24,6 +30,11 @@ module RingCentral
         if !opts.key?(:initials_opts) && opts.key?(:avatar_opts)
           opts[:initials_opts] = opts[:avatar_opts]
         end
+        if opts.key(:png_metadata)
+          opts[:png_metadata] = PNG_DEFAULT_METADATA.merge(opts[:png_metadata])
+        else
+          opts[:png_metadata] = PNG_DEFAULT_METADATA
+        end
         @avatars = RingCentral::Avatars::MultiAvatar.new opts
         load_extensions
       end
@@ -129,6 +140,7 @@ module RingCentral
         @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] : {}
       end
 
       def inflate_avatarly_opts(avatarly_opts = {})
@@ -146,6 +158,14 @@ module RingCentral
         blob = @style == 'initials' \
           ? Avatarly.generate_avatar(text, @avatarly_opts) \
           : RubyIdenticon.create(text, @identicon_opts)
+        inflate_avatar_blob_png blob
+      end
+
+      def inflate_avatar_blob_png(blob)
+        return blob unless avatar_format == 'png' && @png_metadata
+        img = ChunkyPNG::Image.from_blob blob
+        img.metadata = @png_metadata
+        img.to_blob
       end
 
       def avatar_temp_file(text, style = nil)
@@ -179,4 +199,4 @@ module RingCentral
       end
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral-avatars
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - John Wang
@@ -30,6 +30,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: chunky_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.8
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -193,7 +213,6 @@ files:
 - Rakefile
 - lib/ringcentral-avatars.rb
 - lib/ringcentral-avatars/creator.rb
-- ringcentral-avatars.gemspec
 homepage: https://github.com/grokify/
 licenses:
 - MIT
@@ -214,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: RingCentral library for auto-generating Gmail style avatars

data/ringcentral-avatars.gemspec

@@ -1,32 +0,0 @@
-lib = 'ringcentral-avatars'
-lib_file = File.expand_path("../lib/#{lib}.rb", __FILE__)
-File.read(lib_file) =~ /\bVERSION\s*=\s*["'](.+?)["']/
-version = $1
-
-Gem::Specification.new do |s|
-  s.name        = lib
-  s.version     = version
-  s.date        = '2016-11-03'
-  s.summary     = 'RingCentral library for auto-generating Gmail style avatars'
-  s.description = 'Create RingCentral avatars using Gmail-style avatars'
-  s.authors     = ['John Wang']
-  s.email       = 'johncwang@gmail.com'
-  s.homepage    = 'https://github.com/grokify/'
-  s.licenses    = ['MIT']
-  s.files       = Dir['lib/**/**/*']
-  s.files      += Dir['[A-Z]*'] + Dir['test/**/*']
-
-  s.required_ruby_version = '>= 2.2.2'
-
-  s.add_dependency 'avatarly', '~> 1.5', '>= 1.5.0'
-  s.add_dependency 'faraday', '~> 0.9', '>= 0.9'
-  s.add_dependency 'mime-types', '~> 3.0', '>= 3.1'
-  s.add_dependency 'ringcentral_sdk', '~> 1', '>= 1.3.4'
-  s.add_dependency 'ruby_identicon', '~> 0', '>= 0.0.5'
-
-  s.add_development_dependency 'coveralls', '~> 0'
-  s.add_development_dependency 'mocha', '~> 1'
-  s.add_development_dependency 'rake', '~> 11'
-  s.add_development_dependency 'simplecov', '~> 0'
-  s.add_development_dependency 'test-unit', '~> 3'
-end