jagg 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cad2ab2e9fca8656974b6348bbfbf7889c083824
+  data.tar.gz: 62a6b23ae9ad5e7a760825d6c3d7252fa1ae41ff
+SHA512:
+  metadata.gz: 36868c4227ec13ef3ca9ebc3f21682de1fe1212ff44dd28c4ebb5f1879dacfb304ae019e6361038147247d190516975851b19307bd96709a45fe3e03458567a5
+  data.tar.gz: 8eb5b1e1cbe564f8f3d6de2c0225055e2d922557e5dc87f286e818fe3be6759c67363213397c38a26273fc6e70b680458d1d78e68fe79ec5d68d8de027ad8e8d

data/.gitignore

@@ -0,0 +1,45 @@
+# Packages #
+############
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Logs #
+########
+*.log
+
+# Databases #
+#############
+*.sql
+*.sqlite
+
+# OS Files #
+############
+.DS_Store
+.Trashes
+ehthumbs.db
+Icon?
+Thumbs.db
+
+# Vagrant #
+###########
+.vagrant
+
+# Ruby Files #
+##############
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle/
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format doc
+--require spec_helper

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,17 @@
+# JAGG
+
+Just Another Gravatar Gem!
+
+This gem uses the Gravatar API to provide you with both profile and image data.
+
+## Installation
+
+You can install **JAGG** using the following command:
+
+    $ gem install jagg
+
+## Development
+
+After checking out the repo, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/Vagrantfile

@@ -0,0 +1,22 @@
+# Get the name of the gem
+name = File.basename(File.expand_path('..', __FILE__))
+raise 'Could not determine gem name' unless name
+
+# Configure Vagrant
+Vagrant.configure(2) do |config|
+  config.vm.box = 'ubuntu/xenial64'
+  config.vm.synced_folder './', "/opt/#{name}"
+  config.vm.provision 'shell', inline: <<-SHELL
+    locale-gen en_GB.UTF-8
+    apt-get update
+    apt-get dist-upgrade -y
+    apt-get install build-essential git software-properties-common -y
+    apt-add-repository ppa:brightbox/ruby-ng -y
+    apt-get update
+    apt-get install ruby2.3 ruby2.3-dev -y
+    echo 'export PATH="$PATH:$HOME/.gem/ruby/2.3.0/bin"' | su vagrant -l -c 'tee -a ~/.bash_profile'
+    echo 'gem: --no-document --user-install' | su vagrant -l -c 'tee -a ~/.gemrc'
+    su vagrant -l -c 'gem install bundle'
+    su vagrant -l -c "cd /opt/#{name}; bundle install"
+  SHELL
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'jagg'
+require 'irb'
+
+IRB.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/jagg.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jagg/constants'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jagg'
+  spec.version       = JAGG::VERSION
+  spec.authors       = ['Nialto Services']
+  spec.email         = ['support@nialtoservices.co.uk']
+
+  spec.summary       = %q{Just Another Gravatar Gem}
+  spec.description   = %q{This gem uses the Gravatar API to provide you with both profile and image data.}
+  spec.homepage      = 'https://github.com/nialtoservices/jagg'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'argspec', '~> 0.3', '>= 0.3.3'
+  spec.add_dependency 'httpclient', '~> 2.8', '>= 2.8.2.4'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake',    '~> 10.0'
+  spec.add_development_dependency 'rspec',   '~> 3.0'
+end

data/lib/jagg.rb

@@ -0,0 +1,23 @@
+module JAGG
+  class << self
+    # Load the gem's dependencies
+    #
+    # @api private
+    #
+    def load!
+      require 'argspec'
+      require 'digest/md5'
+      require 'httpclient'
+      require 'json'
+      require 'uri'
+
+      require 'jagg/constants'
+      require 'jagg/helpers/string'
+      require 'jagg/gravatar'
+      require 'jagg/gravatar/image'
+      require 'jagg/gravatar/profile'
+    end
+  end
+end
+
+JAGG.load!

data/lib/jagg/constants.rb

@@ -0,0 +1,3 @@
+module JAGG
+  VERSION = '0.1.0'
+end

data/lib/jagg/gravatar.rb

@@ -0,0 +1,22 @@
+module JAGG
+  # The Gravatar class (and it's namespaces) are used to convert the data from
+  # Gravatar's API into objects.
+  #
+  class Gravatar
+    class << self
+      # Get the HTTP Client.
+      #
+      # @return [HTTPClient] A HTTPClient instance.
+      # @example
+      #   JAGG::Gravatar.http_client
+      #
+      def http_client
+        return @client if @client
+
+        @client = HTTPClient.new
+        @client.redirect_uri_callback = Proc.new { |uri, result| result.header['location'][0] }
+        @client
+      end
+    end
+  end
+end

data/lib/jagg/gravatar/image.rb

@@ -0,0 +1,105 @@
+module JAGG
+  class Gravatar
+    # This class holds an image contained within the profile data.
+    #
+    class Image
+      class << self
+        include ArgumentSpecification::DSL
+
+        # Get the Gravatar image URL for an email.
+        #
+        # @param email [String] The user's email address.
+        # @param size [Integer] The size of the image (in pixels).
+        # @return [String] The URL to the gravatar image.
+        # @example Get a Thumbnail
+        #   JAGG::Gravatar::Image.url('user@example.com') #=> "https://www.gravatar.com/avatar/b58996c504c5638798eb6b511e6f49af"
+        # @example Get a custom size
+        #   JAGG::Gravatar::Image.url('user@example.com', 256) #=> "https://www.gravatar.com/avatar/b58996c504c5638798eb6b511e6f49af?size=256"
+        #
+        def url(email, size = nil)
+          argument(email) { should be_a(String) }
+          argument(size) { should be_an(Integer) } if size
+
+          uri = URI.parse('https://www.gravatar.com/')
+          uri.path = '/avatar/' + email.to_md5
+          uri.query = 'size=' + size.to_s if size
+          uri.to_s
+        end
+
+        # Get a Gravatar image object for an email.
+        #
+        # @param email [String] The user's email address.
+        # @return [JAGG::Gravatar::Image] A gravatar image object.
+        # @example
+        #   JAGG::Gravatar::Image.for('user@example.com') #=> #<JAGG::Gravatar::Image:0x00000000000000 ...>
+        #
+        def for(email)
+          new(url(email))
+        end
+      end
+
+      include ArgumentSpecification::DSL
+
+      # The URL to the image.
+      #
+      attr_reader :url
+
+      # The type/kind of image (optional).
+      #
+      attr_reader :kind
+
+      # Create a new image object.
+      #
+      # @param url [String] The url to the image.
+      # @param kind [Symbol] The type/kind of image.
+      # @example
+      #   JAGG::Gravatar::Image.new(url, kind) #=> #<JAGG::Gravatar::Image:0x00000000000000 ...>
+      #
+      def initialize(url, kind = nil)
+        uri = URI.parse(url)
+        uri.query = nil
+        @url = uri.to_s
+        @kind = kind
+      end
+
+      # Get the URL for the image at a specific size.
+      #
+      # @param size [Integer] The size of the image (in pixels).
+      # @return [String] The URL of the image at the specified size.
+      # @example
+      #   image.url_of_size(256) #=> "https://www.gravatar.com/avatar/b58996c504c5638798eb6b511e6f49af?size=256"
+      #
+      def url_of_size(size)
+        return nil unless @url
+
+        argument(size) do
+          should be_an(Integer)
+          should be_within_range(1..2048)
+        end
+
+        uri = URI.parse(@url)
+        uri.query = 'size=' + size.to_s
+        uri.to_s
+      end
+
+      # Fetch the image data.
+      #
+      # @param size [Integer] The size of the image (in pixels).
+      # @return [String] The raw image data.
+      # @example
+      #   image.fetch #=> "..."
+      #
+      def fetch(size = nil)
+        return nil unless @url
+
+        url = size ? url_of_size(size) : @url
+
+        response = Gravatar.http_client.get(url, follow_redirect: true)
+
+        return nil unless response.ok?
+
+        response.body
+      end
+    end
+  end
+end

data/lib/jagg/gravatar/profile.rb

@@ -0,0 +1,127 @@
+module JAGG
+  class Gravatar
+    # This class is responsible for fetching and parsing a user's profile.
+    #
+    class Profile
+      class << self
+        include ArgumentSpecification::DSL
+
+        # Get the Gravatar profile URL for an email.
+        #
+        # @param email [String] The user's email address.
+        # @param format [Symbol] The format to render the profile in.
+        # @return [String] The URL to the gravatar profile.
+        # @example HTML Format (default)
+        #   JAGG::Gravatar::Profile.url('user@example.com') #=> "https://www.gravatar.com/b58996c504c5638798eb6b511e6f49af"
+        # @example JSON Format
+        #   JAGG::Gravatar::Profile.url('user@example.com', :json) #=> "https://www.gravatar.com/b58996c504c5638798eb6b511e6f49af.json"
+        # @example XML Format
+        #   JAGG::Gravatar::Profile.url('user@example.com', :xml) #=> "https://www.gravatar.com/b58996c504c5638798eb6b511e6f49af.xml"
+        #
+        def url(email, format = nil)
+          argument(email) { should be_a(String) }
+          argument(format) { should be_one_of(:json, :xml) } if format
+
+          uri = URI.parse('https://www.gravatar.com/')
+          uri.path = '/' + email.to_md5
+          uri.path += '.' + format.to_s if format
+          uri.to_s
+        end
+
+        # Get a Gravatar profile object for an email.
+        #
+        # @param email [String] The user's email address.
+        # @return [JAGG::Gravatar::Profile] A gravatar profile object.
+        # @example
+        #   JAGG::Gravatar::Profile.for('user@example.com') #=> #<JAGG::Gravatar::Profile:0x00000000000000 ...>
+        #
+        def for(email)
+          response = Gravatar.http_client.get(url(email, :json), follow_redirect: true)
+
+          return nil unless response.ok?
+          return nil unless response = JSON.parse(response.body)
+          return nil unless response = response['entry'][0] rescue nil
+
+          new(response)
+        end
+      end
+
+      # The user's gravatar identifier.
+      #
+      attr_reader :gravatar_id
+
+      # The user's first name.
+      #
+      attr_reader :first_name
+
+      # The user's last name.
+      #
+      attr_reader :last_name
+
+      # The user's formatted name (usually full name).
+      #
+      attr_reader :formatted_name
+
+      # The user's display name.
+      #
+      attr_reader :display_name
+
+      # The user's preferred username.
+      #
+      attr_reader :preferred_username
+
+      # The user's thumbnail image.
+      #
+      attr_reader :thumbnail
+
+      # An array of the user's images.
+      #
+      attr_reader :images
+
+      private
+      # Create a new profile instance
+      #
+      # @param raw [Hash] A hash containins raw profile data.
+      # @example
+      #   Profile.new(raw) #=> #<JAGG::Gravatar::Profile:0x00000000000000 ...>
+      #
+      def initialize(raw)
+        @gravatar_id = raw['id']
+
+        if display_name = raw['displayName']
+          @display_name = display_name
+        end
+
+        if preferred_username = raw['preferredUsername']
+          @preferred_username = preferred_username
+        end
+
+        if thumbnail_url = raw['thumbnailUrl']
+          @thumbnail = Gravatar::Image.new(thumbnail_url, :thumbnail)
+        end
+
+        if raw['photos'].is_a?(Array)
+          @images = raw['photos'].map do |data|
+            Gravatar::Image.new(data['value'], data['type'].to_sym)
+          end
+        else
+          @images = []
+        end
+
+        if raw['name'].is_a?(Hash)
+          if first_name = raw['name']['givenName']
+            @first_name = first_name
+          end
+
+          if last_name = raw['name']['familyName']
+            @last_name = last_name
+          end
+
+          if formatted_name = raw['name']['formatted']
+            @formatted_name = formatted_name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jagg/helpers/string.rb

@@ -0,0 +1,10 @@
+class ::String
+  # Convert the string into an MD5 hash
+  #
+  # @example
+  #   "Hello, World!".to_md5 #=> "65a8e27d8879283831b664bd8b7f0ad4"
+  #
+  def to_md5
+    Digest::MD5.hexdigest(self)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'jagg'

data/spec/unit/jagg/gravatar/image_spec.rb

@@ -0,0 +1,2 @@
+describe JAGG::Gravatar::Image do
+end

data/spec/unit/jagg/gravatar/profile_spec.rb

@@ -0,0 +1,2 @@
+describe JAGG::Gravatar::Profile do
+end

data/spec/unit/jagg/helpers/string_spec.rb

@@ -0,0 +1,10 @@
+describe String do
+  context 'a string' do
+    subject { 'Hello, World!' }
+    let(:md5) { '65a8e27d8879283831b664bd8b7f0ad4' }
+
+    it '.to_md5' do
+      expect(subject.to_md5).to eq(md5)
+    end
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: jagg
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nialto Services
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: argspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.2.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This gem uses the Gravatar API to provide you with both profile and image
+  data.
+email:
+- support@nialtoservices.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- Vagrantfile
+- bin/console
+- bin/setup
+- jagg.gemspec
+- lib/jagg.rb
+- lib/jagg/constants.rb
+- lib/jagg/gravatar.rb
+- lib/jagg/gravatar/image.rb
+- lib/jagg/gravatar/profile.rb
+- lib/jagg/helpers/string.rb
+- spec/spec_helper.rb
+- spec/unit/jagg/gravatar/image_spec.rb
+- spec/unit/jagg/gravatar/profile_spec.rb
+- spec/unit/jagg/helpers/string_spec.rb
+homepage: https://github.com/nialtoservices/jagg
+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.6.7
+signing_key: 
+specification_version: 4
+summary: Just Another Gravatar Gem
+test_files:
+- spec/spec_helper.rb
+- spec/unit/jagg/gravatar/image_spec.rb
+- spec/unit/jagg/gravatar/profile_spec.rb
+- spec/unit/jagg/helpers/string_spec.rb