social-avatar-proxy 0.0.7 → 0.0.8

data/.gitignore

@@ -15,4 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-**.DS_Store
+**.DS_Store
+spec/internal/log/test.log

data/README.md

@@ -25,32 +25,34 @@ Or install it yourself as:
 
 ## Usage
 
-This usage is based on Rails, however it should be easily adaptable for other languages:
+# Rack
+
+The Rack app is available at: SocialAvatarProxy::App
+
+# Rails
 
 In your `config/routes.rb` file:
 
 ```ruby
-mount SocialAvatarProxy::App, at: "/avatars", as: :sap
+mount SocialAvatarProxy::Engine, at: "/avatars"
 ```
 
-Note: you must specify an `as` option above, otherwise the path helpers below won't work.
+The engine is basically a proxy for the Rack app, it also adds the path helpers below:
 
 In your views:
 
 ```ruby
 # for a Twitter user, by username:
-image_tag(sap.twitter_avatar_path("username"))
+image_tag(twitter_avatar_path("username"))
 # by ID:
-image_tag(sap.twitter_avatar_path(12345))
+image_tag(twitter_avatar_path(12345))
 
 # for a Facebook user, by username:
-image_tag(sap.facebook_avatar_path("username"))
+image_tag(facebook_avatar_path("username"))
 # by ID:
-image_tag(sap.facebook_avatar_path(12345))
+image_tag(facebook_avatar_path(12345))
 ```
 
-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
 
 1. Fork it

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize!
+run Combustion::Application

data/lib/social_avatar_proxy.rb

@@ -2,4 +2,8 @@ require "social_avatar_proxy/version"
 require "social_avatar_proxy/app"
 require "social_avatar_proxy/avatar"
 require "social_avatar_proxy/facebook_avatar"
-require "social_avatar_proxy/twitter_avatar"
+require "social_avatar_proxy/twitter_avatar"
+
+if defined?(Rails) && defined?(Rails::Engine)
+  require "social_avatar_proxy/engine"
+end

data/lib/social_avatar_proxy/app.rb

@@ -73,10 +73,6 @@ 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/engine.rb

@@ -0,0 +1,36 @@
+require "social_avatar_proxy/app"
+require "social_avatar_proxy/path_helpers"
+
+module SocialAvatarProxy
+  class Engine < ::Rails::Engine
+    endpoint App
+    
+    def self.mounted_at
+      @mounted_at ||= calculate_mounted_at
+    end
+    
+    def self.calculate_mounted_at
+      route ||= Rails.application.routes.routes.detect do |route|
+        route.app == self
+      end
+      # if it's not found, it's not mounted
+      unless route
+        raise "#{self} is not yet mounted."
+      end
+      # return the route with it's slashes stripped
+      route.path.spec.to_s.gsub(/^\/|\/$/, "")
+    end
+    
+    module Helpers
+      def twitter_avatar_path(identifier)
+        "/#{SocialAvatarProxy::Engine.mounted_at}/twitter/#{identifier}"
+      end
+      
+      def facebook_avatar_path(identifier)
+        "/#{SocialAvatarProxy::Engine.mounted_at}/facebook/#{identifier}"
+      end
+    end
+    
+    ActionController::Base.send(:include, Helpers)
+  end
+end

data/lib/social_avatar_proxy/version.rb

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

data/social-avatar-proxy.gemspec

@@ -21,8 +21,9 @@ Gem::Specification.new do |s|
   
   s.add_dependency "rack"
 
+  s.add_development_dependency "combustion"
   s.add_development_dependency "rake"
-  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec-rails"
   s.add_development_dependency "simplecov"
   s.add_development_dependency "foreman"
 end

data/spec/internal/config/routes.rb

@@ -0,0 +1,5 @@
+require "social_avatar_proxy/engine"
+
+Rails.application.routes.draw do
+  mount SocialAvatarProxy::Engine, at: "/avatars/test", as: :sap
+end

data/spec/social_avatar_proxy/app_spec.rb

@@ -37,15 +37,6 @@ 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/engine_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+require "social_avatar_proxy/engine"
+
+describe SocialAvatarProxy::Engine do
+  subject do
+    SocialAvatarProxy::Engine
+  end
+
+  describe "#mounted_at" do
+    it "should match what is in the routes file" do
+      expect(subject.mounted_at).to eq("avatars/test")
+    end
+  end
+  
+  describe "routing" do
+    subject do
+      ActionController::Base.new
+    end
+
+    it "should define #twitter_avatar_path on ApplicationController" do
+      path = subject.twitter_avatar_path("ryantownsend")
+      expect(path).to eq "/avatars/test/twitter/ryantownsend"
+    end
+    
+    it "should define #facebook_avatar_path on ApplicationController" do
+      path = subject.facebook_avatar_path("ryandtownsend")
+      expect(path).to eq "/avatars/test/facebook/ryandtownsend"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -6,4 +6,9 @@ end
 require "bundler"
 Bundler.require
 
+require "combustion"
+Combustion.initialize! :action_controller
+
+require "rspec/rails"
+
 Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each { |f| require f }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: social-avatar-proxy
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -44,7 +60,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -105,10 +121,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- config.ru
 - lib/social-avatar-proxy.rb
 - lib/social_avatar_proxy.rb
 - lib/social_avatar_proxy/app.rb
 - lib/social_avatar_proxy/avatar.rb
+- lib/social_avatar_proxy/engine.rb
 - lib/social_avatar_proxy/facebook_avatar.rb
 - lib/social_avatar_proxy/path_helpers.rb
 - lib/social_avatar_proxy/remote_file_resolver.rb
@@ -116,8 +134,10 @@ files:
 - lib/social_avatar_proxy/twitter_avatar.rb
 - lib/social_avatar_proxy/version.rb
 - social-avatar-proxy.gemspec
+- spec/internal/config/routes.rb
 - spec/social_avatar_proxy/app_spec.rb
 - spec/social_avatar_proxy/avatar_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
 - spec/social_avatar_proxy/remote_file_resolver_spec.rb
@@ -140,7 +160,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -420987875933585136
+      hash: -3423004338528291902
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -149,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -420987875933585136
+      hash: -3423004338528291902
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -157,8 +177,10 @@ signing_key:
 specification_version: 3
 summary: This gem acts as a proxy for avatars on Twitter & Facebook.
 test_files:
+- spec/internal/config/routes.rb
 - spec/social_avatar_proxy/app_spec.rb
 - spec/social_avatar_proxy/avatar_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
 - spec/social_avatar_proxy/remote_file_resolver_spec.rb