social-avatar-proxy 0.0.6 → 0.0.7

data/README.md

@@ -30,26 +30,26 @@ This usage is based on Rails, however it should be easily adaptable for other la
 In your `config/routes.rb` file:
 
 ```ruby
-mount SocialAvatarProxy::App, at: "/avatars"
+mount SocialAvatarProxy::App, at: "/avatars", as: :sap
 ```
 
-### COMING SOON
+Note: you must specify an `as` option above, otherwise the path helpers below won't work.
 
 In your views:
 
 ```ruby
 # for a Twitter user, by username:
-image_tag(twitter_avatar_path("username"))
+image_tag(sap.twitter_avatar_path("username"))
 # by ID:
-image_tag(twitter_avatar_path(12345))
+image_tag(sap.twitter_avatar_path(12345))
 
 # for a Facebook user, by username:
-image_tag(facebook_avatar_path("username"))
+image_tag(sap.facebook_avatar_path("username"))
 # by ID:
-image_tag(facebook_avatar_path(12345))
+image_tag(sap.facebook_avatar_path(12345))
 ```
 
-The above helper methods are provided by the `SocialAvatarProxy::Paths` module.
+The above path helper methods are provided by the `SocialAvatarProxy::PathHelpers` module. Note: `image_tag` is a Rails helper, replace with your framework's equivalent. You'll need to call `avatar_base_path=` with the mounted path prefix (in the example above we were mounted at `/avatars`, however Rails handles it automatically)
 
 ## Contributing
 

data/lib/social_avatar_proxy/app.rb

@@ -1,5 +1,6 @@
 require "social_avatar_proxy/facebook_avatar"
 require "social_avatar_proxy/twitter_avatar"
+require "social_avatar_proxy/routes"
 require "rack"
 
 module SocialAvatarProxy
@@ -28,7 +29,7 @@ module SocialAvatarProxy
     end
     
     def path_prefix
-      request.env["SCRIPT_NAME"].gsub(/\/$/, "")
+      request && request.env["SCRIPT_NAME"].gsub(/\/$/, "")
     end
     
     def response
@@ -72,6 +73,10 @@ module SocialAvatarProxy
       Rack::Response.new("Not Found", 404)
     end
     
+    def routes
+      @routes ||= Routes.new(self)
+    end
+    
     private
     def load_avatar(service, id)
       # titleize the service name

data/lib/social_avatar_proxy/path_helpers.rb

@@ -0,0 +1,27 @@
+module SocialAvatarProxy
+  module PathHelpers
+    def avatar_base_path
+      @avatar_base_path ||= ""
+    end
+    
+    def avatar_base_path=(path)
+      # strip leading / trailing slashes
+      path = path.gsub(/^\/|\/$/, "")
+      if path.empty?
+        # reset to an empty string
+        @avatar_base_path = ""
+      else
+        # set with prepended slash
+        @avatar_base_path = "/#{path}"
+      end
+    end
+    
+    def twitter_avatar_path(identifier)
+      File.join(avatar_base_path, "twitter", identifier.to_s)
+    end
+    
+    def facebook_avatar_path(identifier)
+      File.join(avatar_base_path, "facebook", identifier.to_s)
+    end
+  end
+end

data/lib/social_avatar_proxy/routes.rb

@@ -0,0 +1,13 @@
+require "social_avatar_proxy/path_helpers"
+
+module SocialAvatarProxy
+  class Routes
+    include PathHelpers
+    
+    def initialize(app)
+      if app.path_prefix
+        self.avatar_base_path = app.path_prefix
+      end
+    end
+  end
+end

data/lib/social_avatar_proxy/version.rb

@@ -1,3 +1,3 @@
 module SocialAvatarProxy
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/social_avatar_proxy/app_spec.rb

@@ -37,6 +37,15 @@ describe SocialAvatarProxy::App do
     end
   end
   
+  describe "#routes" do
+    subject { app }
+
+    it "should return a object providing the path helpers" do
+      expect(subject.routes.facebook_avatar_path("ryandtownsned")).to match(/^\/.*$/)
+      expect(subject.routes.twitter_avatar_path(2202971)).to match(/^\/.*$/)
+    end
+  end
+  
   context "given an invalid path" do
     it "should return a 404 response" do
       path = "/unknown"

data/spec/social_avatar_proxy/path_helpers_spec.rb

@@ -0,0 +1,62 @@
+require "spec_helper"
+
+describe SocialAvatarProxy::PathHelpers do
+  subject do
+    Class.new do
+      include SocialAvatarProxy::PathHelpers
+    end.new
+  end
+  
+  describe "#avatar_base_path" do
+    it "should return empty string as default" do
+      expect(subject.avatar_base_path).to eq("")
+    end
+  end
+  
+  describe "#avatar_base_path=" do
+    it "should update the #avatar_base_path" do
+      subject.avatar_base_path = "/test"
+      expect(subject.avatar_base_path).to eq("/test")
+    end
+    
+    it "should remove trailing slashes" do
+      subject.avatar_base_path = "/test/"
+      expect(subject.avatar_base_path).to eq("/test")
+    end
+    
+    it "should prepend a slash if missing" do
+      subject.avatar_base_path = "test"
+      expect(subject.avatar_base_path).to eq("/test")
+    end
+  end
+  
+  describe "#twitter_avatar_path" do
+    context "with no #avatar_base_path" do
+      it "should join the service and identifier" do
+        expect(subject.twitter_avatar_path("dave")).to eq "/twitter/dave"
+      end
+    end
+    
+    context "with a custom #avatar_base_path" do
+      it "should join the base path, service and identifier" do
+        subject.avatar_base_path = "avatars"
+        expect(subject.twitter_avatar_path("dave")).to eq "/avatars/twitter/dave"
+      end
+    end
+  end
+  
+  describe "#facebook_avatar_path" do
+    context "with no #avatar_base_path" do
+      it "should join the service and identifier" do
+        expect(subject.facebook_avatar_path("dave")).to eq "/facebook/dave"
+      end
+    end
+    
+    context "with a custom #avatar_base_path" do
+      it "should join the base path, service and identifier" do
+        subject.avatar_base_path = "avatars"
+        expect(subject.facebook_avatar_path("dave")).to eq "/avatars/facebook/dave"
+      end
+    end
+  end
+end

data/spec/social_avatar_proxy/routes_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe SocialAvatarProxy::Routes do
+  subject do
+    SocialAvatarProxy::Routes.new(app)
+  end
+
+  let(:path_prefix) { "" }
+  let(:app) { mock("app", path_prefix: path_prefix) }
+
+  describe "#avatar_base_path" do
+    context "without a path_prefix" do
+      it "should return empty string" do
+        expect(subject.avatar_base_path).to eq("")
+      end
+    end
+    
+    context "with a path_prefix" do
+      let(:path_prefix) { "/avatars" }
+      it "should return the path prefix" do
+        expect(subject.avatar_base_path).to eq("/avatars")
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: social-avatar-proxy
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-02 00:00:00.000000000 Z
+date: 2012-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -110,14 +110,18 @@ files:
 - lib/social_avatar_proxy/app.rb
 - lib/social_avatar_proxy/avatar.rb
 - lib/social_avatar_proxy/facebook_avatar.rb
+- lib/social_avatar_proxy/path_helpers.rb
 - lib/social_avatar_proxy/remote_file_resolver.rb
+- lib/social_avatar_proxy/routes.rb
 - lib/social_avatar_proxy/twitter_avatar.rb
 - lib/social_avatar_proxy/version.rb
 - social-avatar-proxy.gemspec
 - spec/social_avatar_proxy/app_spec.rb
 - spec/social_avatar_proxy/avatar_spec.rb
 - spec/social_avatar_proxy/facebook_avatar_spec.rb
+- spec/social_avatar_proxy/path_helpers_spec.rb
 - spec/social_avatar_proxy/remote_file_resolver_spec.rb
+- spec/social_avatar_proxy/routes_spec.rb
 - spec/social_avatar_proxy/twitter_avatar_spec.rb
 - spec/spec_helper.rb
 - spec/support/env.rb
@@ -136,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2654966469690672685
+      hash: -420987875933585136
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -145,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2654966469690672685
+      hash: -420987875933585136
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -156,7 +160,9 @@ test_files:
 - spec/social_avatar_proxy/app_spec.rb
 - spec/social_avatar_proxy/avatar_spec.rb
 - spec/social_avatar_proxy/facebook_avatar_spec.rb
+- spec/social_avatar_proxy/path_helpers_spec.rb
 - spec/social_avatar_proxy/remote_file_resolver_spec.rb
+- spec/social_avatar_proxy/routes_spec.rb
 - spec/social_avatar_proxy/twitter_avatar_spec.rb
 - spec/spec_helper.rb
 - spec/support/env.rb