social-avatar-proxy 1.1.0 → 1.2.0

data/README.md

@@ -27,7 +27,7 @@ Or install it yourself as:
 
 ## Usage
 
-# Rails
+### Rails
 
 In your `config/routes.rb` file:
 
@@ -51,7 +51,18 @@ image_tag(facebook_avatar_path("username"))
 image_tag(facebook_avatar_path(12345))
 ```
 
-# Rack
+You might wish to configure a default image which will be rendered if an avatar could not be found, or if the remote service has an error (e.g. times out or has a redirect loop), this is simple with an initializer:
+
+```ruby
+require "social_avatar_proxy/config"
+
+# choose our image
+image_path = Rails.root.join("public", "default_avatar.jpg")
+# set the config
+SocialAvatarProxy::Config.default_image = image_path
+```
+
+### Rack
 
 The Rack app is available at: SocialAvatarProxy::App.
 

data/lib/social_avatar_proxy.rb

@@ -1,4 +1,5 @@
 require "social_avatar_proxy/version"
+require "social_avatar_proxy/config"
 require "social_avatar_proxy/app"
 require "social_avatar_proxy/avatar"
 require "social_avatar_proxy/facebook_avatar"

data/lib/social_avatar_proxy/app.rb

@@ -1,3 +1,4 @@
+require "social_avatar_proxy/config"
 require "social_avatar_proxy/facebook_avatar"
 require "social_avatar_proxy/twitter_avatar"
 require "social_avatar_proxy/routes"
@@ -54,25 +55,13 @@ module SocialAvatarProxy
       if avatar.exist?
         # render the avatar to the response
         Rack::Response.new do |response|
-          # set the last modified header
-          response["Last-Modified"] = avatar.last_modified
-          # set the content type header
-          response["Content-Type"] = avatar.content_type
-          # if we want to expire in a set time, calculate the header
-          if options[:expires]
-            response["Expires"] = (Time.now + options[:expires]).httpdate
-          end
-          # if we want to set cache control settings
-          if cc = options[:cache_control]
-            directives = []
-            directives << "no-cache" if cc[:no_cache]
-            directives << "max-stale=#{cc[:max_stale]}" if cc[:max_stale]
-            directives << "max-age=#{cc[:max_age]}" if cc[:max_age]
-            directives << (cc[:public] ? "public" : "private")
-            response["Cache-Control"] = directives.join(", ")
-          end
-          # set the data
+          # set the response data
           response.write(avatar.body)
+          # set the response headers
+          response = set_avatar_headers(response, avatar)
+          response = set_caching_headers(response)
+          # return the response
+          response
         end
       # if the avatar doesn't exist
       else
@@ -81,15 +70,39 @@ module SocialAvatarProxy
     end
     
     def not_found
-      Rack::Response.new("Not Found", 404)
+      Rack::Response.new([], 404) do |response|
+        # if we have a custom default image
+        if Config.default_image
+          render_default_image(response)
+        # without a default image
+        else
+          response.write "Not Found"
+        end
+      end
     end
     
     def timeout
-      Rack::Response.new("Remote server timeout", 504)
+      Rack::Response.new([], 504) do |response|
+        # if we have a custom default image
+        if Config.default_image
+          render_default_image(response)
+        # without a default image
+        else
+          response.write "Remote server timeout"
+        end
+      end
     end
     
     def bad_gateway
-      Rack::Response.new("Bad response from remote server", 502)
+      Rack::Response.new([], 502) do |response|
+        # if we have a custom default image
+        if Config.default_image
+          render_default_image(response)
+        # without a default image
+        else
+          response.write "Bad response from remote server"
+        end
+      end
     end
     
     def routes
@@ -97,6 +110,44 @@ module SocialAvatarProxy
     end
     
     private
+    def render_default_image(response)
+      # render the image
+      response.write(Config.default_image_data)
+      # set the content type
+      response["Content-Type"] = Config.default_image_content_type
+      # set expiry
+      response = set_caching_headers(response)
+      # return the response
+      response
+    end
+  
+    def set_avatar_headers(response, avatar)
+      # set the last modified header
+      response["Last-Modified"] = avatar.last_modified
+      # set the content type header
+      response["Content-Type"] = avatar.content_type
+      # return the response
+      response
+    end
+    
+    def set_caching_headers(response)
+      # if we want to expire in a set time, calculate the header
+      if options[:expires]
+        response["Expires"] = (Time.now + options[:expires]).httpdate
+      end
+      # if we want to set cache control settings
+      if cc = options[:cache_control]
+        directives = []
+        directives << "no-cache" if cc[:no_cache]
+        directives << "max-stale=#{cc[:max_stale]}" if cc[:max_stale]
+        directives << "max-age=#{cc[:max_age]}" if cc[:max_age]
+        directives << (cc[:public] ? "public" : "private")
+        response["Cache-Control"] = directives.join(", ")
+      end
+      # return the response
+      response
+    end
+    
     def load_avatar(service, id)
       # titleize the service name
       service = service.gsub(/[\_\-]/, " ").gsub(/\b([a-z])/) do |match|

data/lib/social_avatar_proxy/config.rb

@@ -0,0 +1,30 @@
+module SocialAvatarProxy
+  class Config
+    class << self
+      attr_accessor :default_image
+      
+      def default_image_file
+        default_image && File.new(default_image)
+      end
+      
+      def default_image_data
+        default_image_file.read
+      end
+      
+      def default_image_content_type
+        case File.extname(default_image).downcase
+        when /^\.jpe?g$/
+          "image/jpeg"
+        when /^\.png$/
+          "image/png"
+        when /^\.gif$/
+          "image/gif"
+        when /^\.svg$/
+          "image/svg+xml"
+        else
+          "application/octet-stream"
+        end
+      end
+    end
+  end
+end

data/lib/social_avatar_proxy/version.rb

@@ -1,3 +1,3 @@
 module SocialAvatarProxy
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/spec/social_avatar_proxy/app_spec.rb

@@ -57,10 +57,22 @@ describe SocialAvatarProxy::App do
   end
   
   context "given an invalid path" do
+    let(:path) { "/unknown" }
+
     it "should return a 404 response" do
-      path = "/unknown"
       expect(subject.get(path).status).to eq(404)
     end
+    
+    context "with a custom image" do
+      before(:each) do
+        image_path = File.join(File.dirname(__FILE__), "../fixtures/image.jpg")
+        SocialAvatarProxy::Config.default_image = image_path
+      end
+      
+      it "should render the image" do
+        expect(subject.get(path)["Content-Type"]).to eq("image/jpeg")
+      end
+    end
   end
   
   context "given a valid path" do

data/spec/social_avatar_proxy/config_spec.rb

@@ -0,0 +1,57 @@
+require "spec_helper"
+
+describe SocialAvatarProxy::Config do
+  subject { SocialAvatarProxy::Config }
+  
+  after(:each) do
+    subject.default_image = nil
+  end
+
+  describe "::default_image" do
+    it "should default to nil" do
+      expect(subject.default_image).to be_nil
+    end
+
+    it "should store a path" do
+      subject.default_image = "/test.jpg"
+      expect(subject.default_image).to eq "/test.jpg"
+    end
+  end
+  
+  describe "::default_image_content_type" do
+    context "with a JPEG" do
+      it "should return image/jpeg" do
+        subject.default_image = "/test.JPG"
+        expect(subject.default_image_content_type).to eq "image/jpeg"
+      end
+    end
+    
+    context "with a PNG" do
+      it "should return image/png" do
+        subject.default_image = "/test.png"
+        expect(subject.default_image_content_type).to eq "image/png"
+      end
+    end
+    
+    context "with a GIF" do
+      it "should return image/gif" do
+        subject.default_image = "/test.gif"
+        expect(subject.default_image_content_type).to eq "image/gif"
+      end
+    end
+    
+    context "with a SVG" do
+      it "should return image/svg+xml" do
+        subject.default_image = "/test.svg"
+        expect(subject.default_image_content_type).to eq "image/svg+xml"
+      end
+    end
+    
+    context "with an unknown type" do
+      it "should return application/octet-stream" do
+        subject.default_image = "/test"
+        expect(subject.default_image_content_type).to eq "application/octet-stream"
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: social-avatar-proxy
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -126,6 +126,7 @@ files:
 - lib/social_avatar_proxy.rb
 - lib/social_avatar_proxy/app.rb
 - lib/social_avatar_proxy/avatar.rb
+- lib/social_avatar_proxy/config.rb
 - lib/social_avatar_proxy/engine.rb
 - lib/social_avatar_proxy/facebook_avatar.rb
 - lib/social_avatar_proxy/path_helpers.rb
@@ -136,9 +137,11 @@ files:
 - lib/social_avatar_proxy/twitter_avatar.rb
 - lib/social_avatar_proxy/version.rb
 - social-avatar-proxy.gemspec
+- spec/fixtures/image.jpg
 - spec/internal/config/routes.rb
 - spec/social_avatar_proxy/app_spec.rb
 - spec/social_avatar_proxy/avatar_spec.rb
+- spec/social_avatar_proxy/config_spec.rb
 - spec/social_avatar_proxy/engine_spec.rb
 - spec/social_avatar_proxy/facebook_avatar_spec.rb
 - spec/social_avatar_proxy/path_helpers_spec.rb
@@ -173,9 +176,11 @@ signing_key:
 specification_version: 3
 summary: This gem acts as a proxy for avatars on Twitter & Facebook.
 test_files:
+- spec/fixtures/image.jpg
 - spec/internal/config/routes.rb
 - spec/social_avatar_proxy/app_spec.rb
 - spec/social_avatar_proxy/avatar_spec.rb
+- spec/social_avatar_proxy/config_spec.rb
 - spec/social_avatar_proxy/engine_spec.rb
 - spec/social_avatar_proxy/facebook_avatar_spec.rb
 - spec/social_avatar_proxy/path_helpers_spec.rb