scottmotte-amazonavatar 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 scottmotte
+
+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.rdoc

@@ -0,0 +1,117 @@
+= AmazonAvatar
+
+Upload avatars to amazonS3 on a User (or other) model. Simple and opinionated. 
+
+== Notes
+
+* I'm using it with merb and mongomapper.
+* Does resizing using minimagick
+* Uploads the images to your s3 account at /avatars/user_id/[original.png,thumb.png,mini.png]
+* Resizes a thumb to 48x48, and mini to 24x24. I told you it was opinionated.
+
+== Dependencies
+
+* right_aws
+* mini_magick
+
+== Requirements
+
+You must have ImageMagick installed. 
+
+On leopard
+
+  sudo port install tiff -macosx  #disables the linkage with Apple's open gl
+  sudo port install ImageMagick
+
+On ubuntu
+
+  sudo apt-get install build-essential libmagickcore-dev imagemagick libpcre3 libfcgi-dev libfcgi0ldbl libxml2-dev libxslt1-dev -y
+
+== Installation
+
+On your computer
+
+  gem sources -a http://gems.github.com
+  sudo gem install scottmotte-amazonavatar
+  
+Or for bundling
+
+  dependency 'scottmotte-amazonavatar'
+
+== Configuration
+
+Tell AmazonAvatar your S3 information.
+
+  AmazonAvatar.access_key_id = "your_access_key_id"
+  AmazonAvatar.secret_access_key = "your_secret_access_key"
+  AmazonAvatar.bucket_name = "yourdatabase_development"
+  # I put these in init.rb in the after_app_loads block for Merb. Probably put them in your environment.rb file for Rails.
+
+In user.rb model
+
+  class User
+    include AmazonAvatar::Uploader
+    ...
+  end  
+  
+In your users.rb controller put use the put_avatar instance method. @user.put_avatar.
+
+  def update_avatar(avatar)
+    @user = @current_user
+    raise NotFound unless @user
+    if @user.put_avatar(avatar)
+      redirect resource(@user, :edit),  :message => {:notice => "Avatar was updated"}
+    else
+      redirect resource(@user, :edit),  :message => {:error => "Avatar failed to be uploaded"}
+    end
+  end
+
+In global_helpers.rb
+
+  module Merb
+    module GlobalHelpers
+      include AmazonAvatar::Helpers
+      ...
+    end
+  end
+  
+This will give you the avatar_path helper which you can use with rails', sinatra's, merb's, etc's image_tag helper. Just pass in the id of the user to render his avatar.
+
+Also, you should add a default avatar to each user when they signup. The Paperclip gem does this by pointing to the missing.png avatar by storing the path to the avatar in the user table. This simple gem does not store the path in the database. What's the point. Instead you have to generate the default thumb for each user. There's an instance method for this.
+
+  @user.generate_default_avatar
+
+You can use it like so:
+
+  def create(user)
+    # session.abandon!
+    @user = User.new(user)
+    if @user.save
+        @user.generate_default_avatar
+        send_mail(UserMailer, :signup, { :from => AppConfig.site.email, :to => @user.email, :subject => "Twinstang welcome" }, { :user => @user })
+      redirect '/login', :message => {:notice => "Signup successful. Log in."}
+    else
+      message[:error] = "Signup failed"
+      render :new
+    end
+  end
+  
+Better yet wrap it in a run_later method in merb or put it in a background job in rails.
+
+  ...
+  if @user.save
+    run_later do
+      @user.generate_default_avatar
+      send_mail(UserMailer, :signup, { :from => AppConfig.site.email, :to => @user.email, :subject => "Twinstang welcome" }, { :user => @user })
+    end
+  end
+  ...
+
+  
+== Usage
+
+AmazonAvatar.access_key_id = AppConfig.s3.access_key_id # set your key
+AmazonAvatar.secret_access_key = AppConfig.s3.secret_access_key # set your secret
+AmazonAvatar.bucket_name = AppConfig.s3.bucket # set the bucket
+@user.put_avatar(avatar) # where avatar is the file_field value
+@user.generate_default_avatar # for generating the default avatar from amazonavatar/default.png

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "amazonavatar"
+    gem.summary = %Q{Upload avatars to amazonS3 on a User (or other) model. Simple and opinionated.}
+    gem.email = "scott@scottmotte.com"
+    gem.homepage = "http://github.com/scottmotte/amazonavatar"
+    gem.authors = ["scottmotte"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "amazonavatar #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/amazonavatar.gemspec

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{amazonavatar}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["scottmotte"]
+  s.date = %q{2009-07-12}
+  s.email = %q{scott@scottmotte.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "amazonavatar.gemspec",
+     "lib/amazonavatar.rb",
+     "lib/amazonavatar/default.png",
+     "spec/amazonavatar_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/scottmotte/amazonavatar}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Upload avatars to amazonS3 on a User (or other) model. Simple and opinionated.}
+  s.test_files = [
+    "spec/amazonavatar_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/amazonavatar.rb

@@ -0,0 +1,124 @@
+require 'rubygems'
+gem 'right_aws'
+gem 'mini_magick'
+require 'right_aws'
+require 'mini_magick'
+
+# Instructions: include in your model with include S3Avatar
+#  then you can use it like @user.put_avatar(avatar)
+
+module AmazonAvatar
+  
+  def self.dir
+    @@dir ||= Pathname(__FILE__).dirname.expand_path + 'amazonavatar'
+  end
+  
+  # AmazonAvatar.access_key_id = "typeyouraccesskeyid"
+  def self.access_key_id=(key)
+    @@access_key_id ||= key
+  end
+  
+  def self.access_key_id
+    @@access_key_id
+  end
+  
+  # AmaazonAvatar.secret_access_key = "typeyoursecretaccesskey"
+  def self.secret_access_key=(secret)
+    @@secret_access_key ||= secret
+  end
+  
+  def self.secret_access_key
+    @@secret_access_key
+  end
+  
+  # Defin connection using RightAws
+  def self.connection
+    @@connection ||= RightAws::S3.new(access_key_id, secret_access_key)
+  end
+  
+  # AmazonAvatar.bucket = "bucket_name"
+  def self.bucket_name=(bucket)
+    @@bucket_name ||= bucket
+  end
+  
+  def self.bucket_name
+    @@bucket_name
+  end
+  
+
+  module Helpers
+    def avatar_path(id, style = :original)
+      "http://s3.amazonaws.com/#{AmazonAvatar.bucket_name}/avatars/#{id}/#{style.to_s}.png"
+    end
+  end
+  
+  # Adds model methods
+  #  usage: 
+  #  class User
+  #    include AmazonAvatar::Uploader
+  #  end
+  #  now you can use @user.put_avatar(avatar)
+  module Uploader
+    module InstanceMethods
+      
+      # class variables
+      @@avatars ||=  { 
+        :original => {:filename => "original.png", :content_type => "image/png"},
+        :thumb => {:filename => "thumb.png", :dimensions => "48x48", :content_type => "image/png"},
+        :mini => {:filename => "mini.png", :dimensions => "24x24", :content_type => "image/png"} 
+      }
+      
+      # Connect to bucket
+      def bucket
+        @bucket ||= AmazonAvatar.connection.bucket(AmazonAvatar.bucket_name, true, 'public-read')
+      end
+  
+      # upload to s3
+      def put_avatar(avatar)        
+        # Original
+        key1 = bucket.key("avatars/#{id}/#{@@avatars[:original][:filename]}")
+        key1.put(avatar[:tempfile].read, 'public-read')
+        
+        # data
+        data = MiniMagick::Image.from_file(avatar[:tempfile].path)
+        # thumb
+        key2 = bucket.key("avatars/#{id}/#{@@avatars[:thumb][:filename]}")
+        key2.put(resize_and_crop(data, @@avatars[:thumb][:dimensions]).to_blob, 'public-read')
+        # mini
+        key3 = bucket.key("avatars/#{id}/#{@@avatars[:mini][:filename]}")
+        key3.put(resize_and_crop(data, @@avatars[:mini][:dimensions]).to_blob, 'public-read')
+      end
+    
+      # upload default start avatars. this needs to be replaced with a default image somehow
+      def generate_default_avatar        
+        # Original
+        key1 = bucket.key("avatars/#{id}/#{@@avatars[:original][:filename]}")
+        key1.put(File.new("#{AmazonAvatar.dir}/default.png").read, 'public-read')
+        
+        # image
+        image = MiniMagick::Image.from_file("#{AmazonAvatar.dir}/default.png")
+        # thumb
+        key2 = bucket.key("avatars/#{id}/#{@@avatars[:thumb][:filename]}")
+        key2.put(resize_and_crop(image, @@avatars[:thumb][:dimensions]).to_blob, 'public-read')
+        # mini
+        key3 = bucket.key("avatars/#{id}/#{@@avatars[:mini][:filename]}")
+        key3.put(resize_and_crop(image, @@avatars[:mini][:dimensions]).to_blob, 'public-read')
+      end
+  
+  
+      def resize_and_crop(image, size)
+        if image[:width] < image[:height]
+          remove = ((image[:height] - image[:width])/2).round
+          image.shave("0x#{remove}")
+        elsif image[:width] > image[:height]
+          remove = ((image[:width] - image[:height])/2).round
+          image.shave("#{remove}x0")
+        end
+        image.resize("#{size}x#{size}")
+        return image
+      end
+    end
+  
+    include InstanceMethods
+  end
+end

data/spec/amazonavatar_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Amazonavatar" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'amazonavatar'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: scottmotte-amazonavatar
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- scottmotte
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-12 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: scott@scottmotte.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- amazonavatar.gemspec
+- lib/amazonavatar.rb
+- lib/amazonavatar/default.png
+- spec/amazonavatar_spec.rb
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/scottmotte/amazonavatar
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Upload avatars to amazonS3 on a User (or other) model. Simple and opinionated.
+test_files: 
+- spec/amazonavatar_spec.rb
+- spec/spec_helper.rb