easy_gravatar 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b929302dc73502d843f02364106af88ad8657333
+  data.tar.gz: 009514eca04c69c4526aca0946b3eea80835e942
+SHA512:
+  metadata.gz: c6d673b61090d30fdeaa40c5dc88cc206b0a8d375a38e6afec0d0b7ab5d8e6dde2dc88de957864339373b8654ac4e2c41bfcfafabd33743235dc4e24c7e809bf
+  data.tar.gz: 94ac8c8136a144fcb9e0120436e42663e806ddab92452c399adff7a22c6efc353cff25b6e331f7b5b9b0092fe2d4ad87053104e2cc8c4ffe7f392a32cd82439d

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in easy_gravatar.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Dennis van de Hoef
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# EasyGravatar
+
+Gravatar.com, mainly known for its avatar hosting. But users can store more than only an avatar at gravatar.
+
+This gem also allows you to easily access it all (accounts at other social networks, more photo's, the name of the user, saved websites, cryptocurrency accounts and more)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'easy_gravatar'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy_gravatar
+
+## Usage
+
+Creating an instance is easy:
+```ruby
+user = EasyGravatar::Gravatar.new("foo@bar.com")
+```
+
+Or use the even shorter class Gravatar:
+```ruby
+user = Gravatar.new("foo@bar.com")
+```
+
+After creating an instance you can get some basics fast using
+```ruby
+user.full_name # => the full name of the user
+user.avatar # => the avatar from the user, in the default gravatar width of 80 pixels
+user.avatar(150) # => the avatar from the user, in with a width of 150 pixels
+```
+Feel free to contribute to the project and add your own "short getters".
+
+All the available information is saved in a hash. Use `user.hash` to get the hash. As an alternative it is also possible to easily read from the hash.
+```ruby
+user.get_value(:formattedName) # => also gives the full name
+user.get_value(:currency, :bitcoin) # => gives the users bitcoin address
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/dennisvandehoef/easy_gravatar/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+# easy_gravatar

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task :default => :spec

data/easy_gravatar.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easy_gravatar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "easy_gravatar"
+  spec.version       = EasyGravatar::VERSION
+  spec.authors       = ["Dennis van de Hoef"]
+  spec.email         = ["dennisvdhoef@gmail.com"]
+  spec.summary       = %q{A simple gem that gives you -all- the data avalabile for the user on gravatar.com}
+  spec.description   = %q{Gravatar.com, mainly known for its avatar hosting. But users can store more than only an avatar at gravatar. This gem also allows you to easily access it all (accounts at other social networks, more photo's, the name of the user, saved websites, cryptocurrency accounts and more)}
+  spec.homepage      = "http://hoefweb.nl/ruby/easy_gravatar/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rspec",   "~> 3.2.0"
+end

data/lib/easy_gravatar.rb

@@ -0,0 +1,7 @@
+require "easy_gravatar/version"
+require "easy_gravatar/gravatar"
+require "easy_gravatar/json_parser"
+
+class Gravatar < EasyGravatar::Gravatar
+  #bridge to module
+end

data/lib/easy_gravatar/gravatar.rb

@@ -0,0 +1,53 @@
+require 'digest/md5'
+require 'net/http'
+require 'uri'
+
+module EasyGravatar
+  class Gravatar
+
+    attr_reader :md5
+
+    def initialize(email)
+     @md5 = Digest::MD5.hexdigest(email.downcase)
+    end
+
+    def hash
+      @hash ||= EasyGravatar::JsonParser.for(get_hash).parse
+    end
+
+    def full_name
+      get_value :formattedName
+    end
+
+    def avatar(width = 80)
+      "#{get_value(:thumbnailUrl)}?w=#{width}"
+    end
+
+    def get_value(key, subkey = nil)
+      return '' unless hash[key]
+      return '' if subkey and !hash[key][subkey]
+
+      return hash[key][subkey] if subkey
+
+      hash[key]
+    end
+
+    private
+
+    def get_hash
+      Net::HTTP.get(URI.parse(profile_url))
+    end
+
+    def profile_url(url = "https://www.gravatar.com/#{@md5}.json")
+      response = Net::HTTP.get_response(URI.parse(url))
+
+      case response
+      when Net::HTTPSuccess then
+        url
+      when Net::HTTPRedirection then
+        new_url = response['location']
+        profile_url(new_url)
+      end
+    end
+  end
+end

data/lib/easy_gravatar/json_parser.rb

@@ -0,0 +1,91 @@
+require 'json'
+
+module EasyGravatar
+  class JsonParser
+
+    def self.for(json)
+      new json
+    end
+
+    def initialize(json = '')
+      @json = remove_first_layers(json)
+    end
+
+    def parse
+      hash = strip_basic_fields
+      hash.merge! strip_name_data
+      hash.merge! strip_ims
+      hash.merge! strip_profileBackground
+      hash.merge! strip_phoneNumbers
+      hash.merge! strip_emails
+      hash.merge! strip_currency
+    end
+
+    private
+
+    def remove_first_layers(json)
+      JSON.parse(json)['entry'][0]
+    end
+
+    def strip_basic_fields
+      hash = Hash.new
+      @json.keys.each do |key|
+        hash[key.to_sym] = @json[key] if @json[key].class == String
+      end
+      hash
+    end
+
+    def strip_ims
+      strip_basic_group('ims')
+    end
+
+    def strip_phoneNumbers
+      strip_basic_group('phoneNumbers')
+    end
+
+    def strip_currency
+      strip_basic_group('currency')
+    end
+
+    def strip_name_data
+      hash = Hash.new
+      return hash unless @json['name']
+      @json['name'].keys.each do |key|
+        new_key = key
+        new_key = "#{key}Name" if key == 'formatted'
+        hash[new_key.to_sym] = @json['name'][key]
+      end
+      hash
+    end
+
+    def strip_profileBackground
+      hash = Hash.new
+      return hash unless @json['profileBackground']
+      hash[:profileBackgroundColor] = @json['profileBackground']['color']
+      hash
+    end
+
+    def strip_emails
+      hash = Hash.new
+      return hash unless @json['emails']
+      array = Array.new
+      @json['emails'].each do |h|
+        array.push(h['value'])
+      end
+      hash[:email] = array
+      hash
+    end
+
+    def strip_basic_group(group)
+      hash = Hash.new
+      return hash unless @json[group]
+
+      hash[group.to_sym] = Hash.new
+      @json[group].each do |j|
+        hash[group.to_sym][j['type'].to_sym] = j['value']
+      end
+      hash
+    end
+
+  end
+end

data/lib/easy_gravatar/version.rb

@@ -0,0 +1,3 @@
+module EasyGravatar
+  VERSION = "1.0.0"
+end

data/spec/easy_gravatar/gravatar_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe EasyGravatar::Gravatar do
+
+  before(:each) do
+    @gravatar_user = EasyGravatar::Gravatar.new('foo@bar.com')
+  end
+
+  it 'can make a vallid md5 hash' do
+    expect(@gravatar_user.md5).to eq('f3ada405ce890b6f8204094deb12d8a8')
+  end
+
+end

data/spec/easy_gravatar/json_parser_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe EasyGravatar::JsonParser do
+  before(:each) do
+    j = '{"entry":[{"id":"67473678","hash":"274096d1a68cf5740240b6ffb789c5c7","requestHash":"18d25970791c7cfaa521824b83600570","profileUrl":"http:\/\/gravatar.com\/dvdhoef88","preferredUsername":"dvdhoef88","thumbnailUrl":"https:\/\/secure.gravatar.com\/avatar\/274096d1a68cf5740240b6ffb789c5c7","photos":[{"value":"https:\/\/secure.gravatar.com\/avatar\/274096d1a68cf5740240b6ffb789c5c7","type":"thumbnail"},{"value":"https:\/\/secure.gravatar.com\/userimage\/67473678\/7c60b54ff484fcb807e82d77dd28563f"},{"value":"https:\/\/secure.gravatar.com\/userimage\/67473678\/d00f82088e7833d44208731f999d5246"}],"profileBackground":{"color":"#82cef7"},"name":{"givenName":"Dennis","familyName":"van de Hoef","formatted":"Dennis van de Hoef"},"displayName":"dvdhoef88","aboutMe":"A dutch man living in Berlin","currentLocation":"Berlin","phoneNumbers":[{"type":"home","value":"0123456789"},{"type":"work","value":"9876543210"},{"type":"mobile","value":"0147258369"}],"emails":[{"primary":"true","value":"foo@bar.com"}],"ims":[{"type":"aim","value":"fakeAim"},{"type":"yahoo","value":"FakeYahoo"},{"type":"icq","value":"fakeICQ"},{"type":"gtalk","value":"fakeGtalk"},{"type":"skype","value":"fakeSkype"}],"accounts":[{"domain":"facebook.com","display":"View Profile","url":"http:\/\/www.facebook.com\/100001859633067","username":"100001859633067","verified":"true","shortname":"facebook"},{"domain":"linkedin.com","display":"dvdhoef","url":"https:\/\/www.linkedin.com\/in\/dvdhoef","username":"dvdhoef","verified":"true","shortname":"linkedin"},{"domain":"twitter.com","display":"@DvdHoef88","url":"http:\/\/twitter.com\/DvdHoef88","username":"DvdHoef88","verified":"true","shortname":"twitter"}],"currency":[{"type":"bitcoin","value":"14Z6yNjuqnTRevmqe5jHiNYFWfvsRaFBGm"},{"type":"litecoin","value":"LgzvJPZEiZynEs2JFdoqRSwgMELVmRpvb8"},{"type":"dogecoin","value":"DEE13B32ZHfWu4EYuZUHYRdVF3DXi42ECg"}],"urls":[{"value":"http:\/\/www.hoefweb.nl","title":"Hoefweb.nl"},{"value":"http:\/\/github.com\/dennisvandehoef","title":"Profile on github"}]}]}'
+    @parsed = EasyGravatar::JsonParser.for(j).parse
+  end
+
+  it 'removes the first layers' do
+    expect(@parsed[:id]).to eq('67473678')
+    expect(@parsed[:hash]).to eq('274096d1a68cf5740240b6ffb789c5c7')
+    expect(@parsed[:requestHash]).to eq('18d25970791c7cfaa521824b83600570')
+    expect(@parsed[:profileUrl]).to eq('http://gravatar.com/dvdhoef88')
+    expect(@parsed[:preferredUsername]).to eq('dvdhoef88')
+    expect(@parsed[:thumbnailUrl]).to eq('https://secure.gravatar.com/avatar/274096d1a68cf5740240b6ffb789c5c7')
+    expect(@parsed[:displayName]).to eq('dvdhoef88')
+    expect(@parsed[:aboutMe]).to eq('A dutch man living in Berlin')
+    expect(@parsed[:currentLocation]).to eq('Berlin')
+  end
+
+  it 'adds name data to the first layer' do
+    expect(@parsed[:givenName]).to eq('Dennis')
+    expect(@parsed[:familyName]).to eq('van de Hoef')
+    expect(@parsed[:formattedName]).to eq('Dennis van de Hoef')
+  end
+
+  it 'adds the backgroundColor to the first layer' do
+    expect(@parsed[:profileBackgroundColor]).to eq('#82cef7')
+  end
+
+  it 'reorganises the phone numbers' do
+    expect(@parsed[:phoneNumbers][:home]).to eq('0123456789')
+    expect(@parsed[:phoneNumbers][:work]).to eq('9876543210')
+    expect(@parsed[:phoneNumbers][:mobile]).to eq('0147258369')
+  end
+
+  it 'reorganises the ims' do
+    expect(@parsed[:ims][:aim]).to eq('fakeAim')
+    expect(@parsed[:ims][:yahoo]).to eq('FakeYahoo')
+    expect(@parsed[:ims][:icq]).to eq('fakeICQ')
+    expect(@parsed[:ims][:gtalk]).to eq('fakeGtalk')
+    expect(@parsed[:ims][:skype]).to eq('fakeSkype')
+  end
+
+  it 'parses the email adresses to an array' do
+    expect(@parsed[:email][0]).to eq('foo@bar.com')
+  end
+
+  it 'reorganises the currencies' do
+    expect(@parsed[:currency][:bitcoin]).to eq('14Z6yNjuqnTRevmqe5jHiNYFWfvsRaFBGm')
+    expect(@parsed[:currency][:litecoin]).to eq('LgzvJPZEiZynEs2JFdoqRSwgMELVmRpvb8')
+    expect(@parsed[:currency][:dogecoin]).to eq('DEE13B32ZHfWu4EYuZUHYRdVF3DXi42ECg')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'easy_gravatar'
+
+RSpec.configure do |config|
+ config.order = 'random'
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: easy_gravatar
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dennis van de Hoef
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Gravatar.com, mainly known for its avatar hosting. But users can store
+  more than only an avatar at gravatar. This gem also allows you to easily access
+  it all (accounts at other social networks, more photo's, the name of the user, saved
+  websites, cryptocurrency accounts and more)
+email:
+- dennisvdhoef@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- easy_gravatar.gemspec
+- lib/easy_gravatar.rb
+- lib/easy_gravatar/gravatar.rb
+- lib/easy_gravatar/json_parser.rb
+- lib/easy_gravatar/version.rb
+- spec/easy_gravatar/gravatar_spec.rb
+- spec/easy_gravatar/json_parser_spec.rb
+- spec/spec_helper.rb
+homepage: http://hoefweb.nl/ruby/easy_gravatar/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: A simple gem that gives you -all- the data avalabile for the user on gravatar.com
+test_files:
+- spec/easy_gravatar/gravatar_spec.rb
+- spec/easy_gravatar/json_parser_spec.rb
+- spec/spec_helper.rb
+has_rdoc: