buddies_avatar 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Lin He
+
+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,53 @@
+## UNDER DEVELOPMENT
+
+## What does it do?
+
+Part of the 'buddies' gem that aims to bring some common social features to a rails site. Buddies avatar gem provides user avatar and cropping feature. Image cropping technique is credited to railscasts.com
+
+## Setup to use rackspace
+
+* Add `fog` gem
+* Overwrite user
+  
+user.rb
+
+    class User ...
+
+      # For crop only, avatar_geometry opens it
+      def avatar_rackspace_path
+        "http://#{RACKSPACE_CONFIG[:uploads_url]}/" + avatar.current_path
+      end
+    
+      def avatar_upload_path
+        if Rails.env.test? or Rails.env.cucumber?
+          super
+        else
+          avatar_rackspace_path
+        end
+      end
+      
+    end
+
+* Setup carrierwave initializer
+
+Load rackspace.yml
+
+    RACKSPACE_CONFIG = YAML.load(File.read("#{Rails.root}/config/rackspace.yml"))[Rails.env].symbolize_keys
+
+config/initializers/carrierwave.rb
+
+    CarrierWave.configure do |config|
+      config.fog_credentials = {
+        :provider           => 'Rackspace',
+        :rackspace_username => RACKSPACE_CONFIG[:username],
+        :rackspace_api_key  => RACKSPACE_CONFIG[:api_key]
+      }
+      config.fog_directory = RACKSPACE_CONFIG[:uploads_dir]
+      config.fog_host = "http://#{RACKSPACE_CONFIG[:uploads_url]}"
+    end
+
+avatar_uploader
+
+    storage :fog unless Rails.env.test? or Rails.env.cucumber?
+    
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,39 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BuddiesAvatar'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/controllers/avatars_controller.rb

@@ -0,0 +1,28 @@
+class AvatarsController < ApplicationController
+  before_filter :assign_user
+  
+  def show
+  end
+  
+  def update
+    if @user.update_attributes(params[:user])
+      if params[:user][:avatar].blank?
+        redirect_to avatar_url
+      else
+        redirect_to crop_avatar_url
+      end
+    else
+      flash.now.alert = "Invalid image format"
+      render :show
+    end
+  end
+  
+  def crop
+  end
+  
+private
+  
+  def assign_user
+    @user = current_user
+  end
+end

data/app/uploaders/avatar_uploader.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+class AvatarUploader < CarrierWave::Uploader::Base
+  include CarrierWave::MiniMagick
+
+  storage :file
+  # storage :fog unless Rails.env.test? or Rails.env.cucumber?
+
+  def store_dir
+    "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+  end
+
+  def default_url
+    "/images/avatar_missing.png"
+  end
+  
+  process :resize_to_limit => [500, 500]
+  
+  version :thumb do
+    process :crop_and_resize => [100, 100]
+  end
+  
+  def cache_dir
+    "#{Rails.root}/tmp/uploads"
+  end
+
+  def extension_white_list
+    %w(jpg jpeg gif png)
+  end
+  
+  def crop_and_resize(width, height)
+    return if !model.cropping?
+    manipulate! do |img|
+      img.crop   model.crop_string
+      img.resize "#{width}x#{height}"
+      img = yield(img) if block_given?
+      img
+    end
+    [:crop_x, :crop_y, :crop_w, :crop_h].each { |field| model.update_attribute field, nil }
+  end
+
+  # Override the filename of the uploaded files:
+  # Avoid using model.id or version_name here, see uploader/store.rb for details.
+  # def filename
+  #   "something.jpg" if original_filename
+  # end
+end

data/app/views/avatars/crop.html.erb

@@ -0,0 +1,51 @@
+<%= content_for :head do %>
+  <%= stylesheet_link_tag    "jquery.Jcrop" %>
+  <%= javascript_include_tag "jquery.Jcrop.min" %>
+  <script type="text/javascript" charset="utf-8">
+  $(function() {
+    $('#cropbox').Jcrop({
+      onChange: update_crop,
+      onSelect: update_crop,
+      setSelect: [0, 0, 500, 500],
+      aspectRatio: 1
+    });
+  });
+
+  function update_crop(coords) {
+    var rx = 100/coords.w;
+    var ry = 100/coords.h;
+    var lw = $('#cropbox').width();
+    var lh = $('#cropbox').height();
+    
+    var ratio = <%= @user.avatar_geometry[:width] %> / lw;
+    
+    $('#preview').css({
+      width:      Math.round(rx * lw) + 'px',
+      height:     Math.round(ry * lh) + 'px',
+      marginLeft: '-' + Math.round(rx * coords.x) + 'px',
+      marginTop:  '-' + Math.round(ry * coords.y) + 'px'
+    });
+    
+    $("#crop_x").val(Math.round(coords.x * ratio));
+    $("#crop_y").val(Math.round(coords.y * ratio));
+    $("#crop_w").val(Math.round(coords.w * ratio));
+    $("#crop_h").val(Math.round(coords.h * ratio));
+  }
+  </script>
+<% end %>
+
+<div id="avatar_box">
+  <%= image_tag @user.avatar.url, id: "cropbox" %>
+</div>
+
+<div id="avatar_preview" style="width:100px; height:100px; overflow:hidden">
+  <%= image_tag @user.avatar.url, id: "preview" %>
+</div>
+
+<%= form_for @user, url: avatar_path do |f| %>
+  <% for attribute in [:crop_x, :crop_y, :crop_w, :crop_h] %>
+    <%= f.hidden_field attribute, :id => attribute %>
+  <% end %>
+  <p><%= f.submit "Crop" %></p>
+<% end %>
+

data/app/views/avatars/show.html.erb

@@ -0,0 +1,8 @@
+<div id='user_avatar_box'>
+  <%= image_tag @user.avatar.thumb.url %>
+</div>
+<%= form_for @user, url: avatar_path, html: { multipart: true } do |f| %>
+  <%= f.file_field   :avatar, id: 'avatar_field' %>
+  <%= f.hidden_field :avatar_cache %>
+  <%= f.submit "Upload" %>
+<% end %>

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  resource :avatar do
+    member { get :crop }
+  end
+end

data/db/migrate/20110916040104_add_avatar_to_users.rb

@@ -0,0 +1,5 @@
+class AddAvatarToUsers < ActiveRecord::Migration
+  def change
+    add_column :users, :avatar, :string
+  end
+end

data/lib/buddies_avatar.rb

@@ -0,0 +1,8 @@
+require "buddies_avatar/engine"
+
+module BuddiesAvatar
+  module ORM
+    autoload :Base,         'buddies_avatar/orm/base'
+    autoload :ActiveRecord, 'buddies_avatar/orm/active_record'
+  end
+end

data/lib/buddies_avatar/engine.rb

@@ -0,0 +1,4 @@
+module BuddiesAvatar
+  class Engine < Rails::Engine
+  end
+end

data/lib/buddies_avatar/orm/active_record.rb

@@ -0,0 +1,24 @@
+module BuddiesAvatar
+  module ORM
+    module ActiveRecord
+      extend ActiveSupport::Concern
+      include Base
+    
+      included do
+        attr_accessor :crop_x, :crop_y, :crop_w, :crop_h
+      end
+    
+      def cropping?
+        !crop_x.blank? && !crop_y.blank? && !crop_w.blank? && !crop_h.blank?
+      end
+    
+      def crop_string
+        "#{crop_w}x#{crop_h}+#{crop_x}+#{crop_y}"
+      end
+    
+      def clean_crop_fields
+        [:crop_x, :crop_y, :crop_w, :crop_h].each { |field| update_attribute field, nil }
+      end
+    end
+  end
+end

data/lib/buddies_avatar/orm/base.rb

@@ -0,0 +1,37 @@
+module BuddiesAvatar
+  module ORM
+    module Base
+      extend ActiveSupport::Concern
+    
+      included do
+        after_update :reprocess_avatar, if: :cropping?
+        mount_uploader :avatar, AvatarUploader
+      end
+    
+      def cropping?
+        raise NotImplementedError
+      end
+    
+      def crop_string
+        raise NotImplementedError
+      end
+    
+      def avatar_geometry
+        img = MiniMagick::Image.open avatar_upload_path
+        @geometry = { width: img[:width], height: img[:height] }
+      end
+    
+    protected
+    
+      def avatar_upload_path
+        avatar.current_path
+      end
+
+    private
+
+      def reprocess_avatar
+        avatar.recreate_versions!
+      end
+    end
+  end
+end

data/lib/buddies_avatar/version.rb

@@ -0,0 +1,3 @@
+module BuddiesAvatar
+  VERSION = "0.0.1"
+end

data/lib/tasks/buddies-imager_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :buddies-imager do
+#   # Task goes here
+# end

data/test/buddies_avatar_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class BuddiesAvatarTest < ActiveSupport::TestCase
+end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,7 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+  
+  def current_user
+    User.last
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  include BuddiesAvatar::ORM::ActiveRecord
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application" %>
+  <%= javascript_include_tag "application" %>
+  <%= yield :head %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<div id="flash_messages">
+  <% flash.each do |name, msg| %>
+    <%= msg %>
+  <% end %>
+</div>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+require "buddies_avatar"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+