aviary 1.0.1

data/lib/aviary.rb

@@ -0,0 +1,28 @@
+# Standard library
+require 'erb'
+require 'fileutils'
+require 'open-uri'
+
+# Third pary
+require 'rubygems'
+require 'base58'
+require 'dm-core'
+require 'dm-sqlite-adapter'
+require 'dm-migrations'
+require 'dm-validations'
+require 'nokogiri'
+require 'twitter'
+
+# Internal
+require 'aviary/configuration'
+require 'aviary/generator'
+require 'aviary/image_host'
+require 'aviary/image_host/flickr'
+require 'aviary/image_host/plixi'
+require 'aviary/image_host/twitpic'
+require 'aviary/image_host/yfrog'
+require 'aviary/page'
+require 'aviary/paginator'
+require 'aviary/search'
+require 'aviary/site'
+require 'aviary/version'

data/lib/aviary/configuration.rb

@@ -0,0 +1,36 @@
+module Aviary
+  class Configuration    
+    def initialize(envrionment, config = {})
+      @config            = {}
+      @config[:source]   = config[:source] || Dir.pwd
+      @config[:dest]     = config[:dest] || File.join(@config[:source], '_site')
+      @config[:hashtag]  = config[:hashtag]
+      @config[:per_page] = config[:per_page]
+      @config[:limit]    = config[:limit]
+
+      ImageHost::Flickr.api_key(config[:flickr_api_key])
+      
+      send(envrionment)
+    end
+    
+    # Get the value for the given key.
+    #
+    # Returns value.
+    def [](key)
+      @config[key]
+    end
+    
+    protected
+    
+    def default
+      DataMapper.setup(:default, "sqlite://#{File.join(self[:source], 'db.sqlite3')}")
+      DataMapper.finalize
+    end
+    
+    def test
+      DataMapper.setup(:default, 'sqlite::memory:')
+      DataMapper.finalize
+      DataMapper.auto_migrate!
+    end
+  end
+end

data/lib/aviary/generator.rb

@@ -0,0 +1,40 @@
+module Aviary
+  class Generator
+    attr_reader :source, :hashtag
+    
+    def initialize(config)
+      @source  = config[:source]
+      @hashtag = config[:hashtag]
+    end
+    
+    def process
+      copy_template
+      migrate
+    end
+    
+    # Migrates the database for the first time.
+    #
+    # Returns nothing.
+    def migrate
+      DataMapper.auto_migrate!
+    end
+    
+    # Copies the contents of the +generator+ directory into
+    # the +source+ directory for setting up a new aviary.
+    # 
+    # Returns nothing.
+    def copy_template
+      FileUtils.mkdir_p(self.source) unless File.exists?(self.source)
+      File.open(File.join(self.source, 'template.erb'), 'w') do |file|
+        erb = File.read(File.join(generator_path, 'template.erb'))
+        erb.gsub!('{{hashtag}}', self.hashtag) if self.hashtag
+        file.write(erb)
+      end
+      FileUtils.cp_r File.join(generator_path, '_assets'), self.source
+    end
+            
+    def generator_path
+      File.join(File.dirname(__FILE__), '..', '..', 'generator')
+    end
+  end
+end

data/lib/aviary/image_host.rb

@@ -0,0 +1,74 @@
+module Aviary
+  class ImageHost
+    include DataMapper::Resource
+    
+    property :id,     Serial
+    property :type,   Discriminator                                     
+    
+    # Unique identifier to the photo
+    property :token,  String, :unique => true, :auto_validation => true 
+    
+    # Twitter status
+    property :status, Object                                           
+    
+    # Store additional data for building +href+ and +src+
+    property :meta,   Object                                          
+    
+    # Get descendants which are available for searching. Descendant 
+    # classes should implement this method if they require additional 
+    # configuration before they are available. Eg: ImageHost::Flickr
+    # requires an API key to be set.
+    #
+    # Returns array of descendants.
+    def self.available
+      @available ||= descendants.select { |d| d.available? }
+    end
+            
+    def self.available?
+      true
+    end
+
+    # Set and get regular expressions for matching against links to image 
+    # hosts. Passing an argument appends the it to the array. Passing nothing
+    # gets the regular expressions.
+    #
+    # Returns array of regular expressions.
+    def self.matches(regex = nil)
+      @matches = (@matches || []) << regex if regex
+      @matches
+    end
+    
+    # Build an array of captures from matching text. Will capture multiple
+    # times. An empty array means there were no captures.
+    #
+    # Returns array of captured strings.
+    def self.match(text)
+      text.scan(Regexp.union(matches)).flatten.compact
+    end
+    
+    # Like match, but instead of returning an array of captures strings
+    # it creates new records with the captured token. Status is an object
+    # which has a text attribute returned by Twitter.
+    #
+    # Returns nothing.
+    def self.match_and_create(status)
+      match(status.text).each do |capture| 
+        create(:token => capture, :status => status)
+      end
+    end
+
+    # Link to the original photo. Descendant classes must implement this method.
+    # 
+    # Raises exception until implemented.
+    def href
+      raise NotImplementedError
+    end
+
+    # Link to the image. Descendant classes must implement this method.
+    #
+    # Raises exception until implemented.
+    def src
+      raise NotImplementedError
+    end
+  end
+end

data/lib/aviary/image_host/flickr.rb

@@ -0,0 +1,53 @@
+module Aviary
+  class ImageHost::Flickr < ImageHost
+    before :create, :set_meta
+  
+    matches /flic\.kr\/p\/(\w+)/
+    matches /flickr\.com\/photos\/\w+\/(\d+)/
+    
+    # Get and set the API key. Passing an argument sets the
+    # API key. Passing nothing gets the API key.
+    #
+    # Returns api key. 
+    def self.api_key(key = nil)
+      @api_key = key if key
+      @api_key
+    end
+    
+    # True if the API key has been set.
+    #
+    # Returns boolean.
+    def self.available?
+      !api_key.nil?
+    end
+    
+    def self.match_and_create(status)
+      match(status.text).each do |capture|
+        create :token  => (capture =~ /^\d+$/ ? Base58.encode(capture.to_i) : capture),
+               :status => status
+      end
+    end
+        
+    def href
+      "http://flic.kr/p/#{self.token}"
+    end
+  
+    def src
+      "http://farm#{self.meta[:farm_id]}.static.flickr.com/" + 
+      "#{self.meta[:server_id]}/#{self.meta[:id]}_#{self.meta[:secret]}_z.jpg"
+    end
+            
+    def set_meta
+      uri = URI.parse "http://api.flickr.com/services/rest/?method=flickr" +
+                      ".photos.getInfo&api_key=#{self.class.api_key}" + 
+                      "&photo_id=#{Base58.decode(self.token)}"  
+      photo = Nokogiri::XML(open(uri)).css('photo')
+      self.meta = {
+        :farm_id   => photo.first['farm'],
+        :server_id => photo.first['server'],
+        :id        => photo.first['id'],
+        :secret    => photo.first['secret']
+      }
+    end
+  end
+end

data/lib/aviary/image_host/plixi.rb

@@ -0,0 +1,27 @@
+module Aviary
+  class ImageHost::Plixi < ImageHost
+    before :create, :set_meta
+    
+    matches /plixi\.com\/p\/(\d+)/
+  
+    def href
+      "http://plixi.com/p/#{self.token}"
+    end
+  
+    def src
+      self.meta[:medium_image_url]
+    end
+        
+    def set_meta
+      uri = URI.parse("http://api.plixi.com/api/tpapi.svc/photos/#{self.token}")
+      doc = Nokogiri::XML(open(uri))
+      self.meta = {
+        :big_image_url       => doc.css('BigImageUrl').text,
+        :large_image_url     => doc.css('LargeImageUrl').text,
+        :medium_image_url    => doc.css('MediumImageUrl').text,
+        :small_image_url     => doc.css('SmallImageUrl').text,
+        :thumbnail_image_url => doc.css('ThumbnailUrl').text
+      }
+    end
+  end
+end

data/lib/aviary/image_host/twitpic.rb

@@ -0,0 +1,13 @@
+module Aviary
+  class ImageHost::Twitpic < ImageHost  
+    matches /twitpic\.com\/(\w+)/
+    
+    def href
+      "http://twitpic.com/#{self.token}"
+    end
+  
+    def src
+      "http://twitpic.com/show/large/#{self.token}.jpg"
+    end
+  end
+end

data/lib/aviary/image_host/yfrog.rb

@@ -0,0 +1,13 @@
+module Aviary
+  class ImageHost::Yfrog < ImageHost
+    matches /yfrog\.com\/(\w+)/
+  
+    def href
+      "http://yfrog.com/#{self.token}"
+    end
+  
+    def src
+      "http://yfrog.com/#{self.token}:medium"
+    end
+  end
+end

data/lib/aviary/page.rb

@@ -0,0 +1,26 @@
+module Aviary
+  class Page
+    # Photos for the current page
+    attr_reader :image_hosts 
+    
+    # Next page, previous page and current page
+    attr_reader :paginator   
+        
+    def initialize(paginator)
+      @paginator   = paginator
+      @image_hosts = ImageHost.all(@paginator.query_options.merge(:order => :id.desc))
+    end
+    
+    # Escapes text by replacing < and > with their HTML character entity 
+    # reference.
+    #
+    # Returns escaped string.
+    def h(string)
+      string.gsub('<', '&lt;').gsub('>', '&gt;')
+    end
+    
+    def binding
+      super
+    end
+  end
+end

data/lib/aviary/paginator.rb

@@ -0,0 +1,54 @@
+module Aviary
+  class Paginator
+    attr_reader :per_page     # Number of photos per page
+    attr_reader :current_page # Number for the current page
+    attr_reader :first_page   # Minimum number of pages
+    attr_reader :last_page    # Maximum number of pages
+  
+    def initialize(per_page)
+      @per_page     = per_page
+      @current_page = 1
+      @first_page   = 1
+      @last_page    = ImageHost.count / self.per_page
+    end
+        
+    # True if this is not the last page.
+    # 
+    # Returns boolean.  
+    def next_page?
+      self.current_page < self.last_page
+    end
+    
+    # Get the page number for the next page.
+    #
+    # Returns page number.
+    def next_page
+      self.current_page + 1
+    end
+  
+    # Get the page number for the next page and increment the +current_page+.
+    #
+    # Returns page number.
+    def next_page!
+      @current_page = next_page
+    end
+  
+    # True if this is not the first page.
+    #
+    # Returns boolean.
+    def prev_page?
+      self.current_page > self.first_page
+    end
+    
+    # Get the page number for the previous page.
+    #
+    # Returns page number.
+    def prev_page
+      self.current_page - 1
+    end
+    
+    def query_options
+      {:limit => self.per_page, :offset => self.per_page * (self.current_page - 1)}
+    end
+  end
+end

data/lib/aviary/search.rb

@@ -0,0 +1,34 @@
+module Aviary
+  class Search
+    attr_reader :twitter, :limit, :current_page
+    
+    def initialize(config)
+      @twitter      = Twitter::Search.new.filter('links').no_retweets.per_page(100).hashtag(config[:hashtag])
+      @limit        = config[:limit] || 50
+      @current_page = 1
+    end
+    
+    def process
+      return unless next_page?
+      self.twitter.each do |status|
+        ImageHost.available.each do |image_host|
+          image_host.match_and_create(status)
+        end
+      end
+      next_page!
+      process
+    end
+    
+    # True if there is another page to fetch from Twitter and
+    # we haven't exceeded the limit.
+    #
+    # Returns boolean.            
+    def next_page?
+      self.twitter.next_page? && self.current_page < self.limit
+    end
+    
+    def next_page!
+      @current_page += 1
+    end
+  end
+end

data/lib/aviary/site.rb

@@ -0,0 +1,52 @@
+module Aviary
+  class Site
+    attr_reader :source, :dest, :paginator, :template
+    
+    def initialize(config)
+      @source    = config[:source]
+      @dest      = config[:dest]
+      @paginator = Paginator.new(config[:per_page] || 25)
+      @template  = ERB.new(File.read(File.join(self.source, 'template.erb')))
+    end    
+    
+    def process
+      render
+      if self.paginator.next_page?
+        self.paginator.next_page!
+        process
+      else
+        copy_index
+        copy_assets
+      end
+    end
+    
+    def render
+      FileUtils.mkdir_p(current_page_path) unless File.exists?(current_page_path)
+      File.open(File.join(current_page_path, "index.htm"), "w") do |file|
+        file.write self.template.result(Page.new(self.paginator).binding)
+      end
+    end
+    
+    # Copies the first page and makes it the index at the root
+    # of the +dest+ directory.
+    #
+    # Returns nothing.
+    def copy_index
+      FileUtils.cp File.join(self.dest, "page1", "index.htm"), 
+                   File.join(self.dest, "index.htm")
+    end
+    
+    # Recursively copy the contents of the +_assets+ directory into
+    # the root of the +dest+ directory. Useful for sharing CSS,
+    # JavaScript or images between pages.
+    #
+    # Returns nothing.
+    def copy_assets
+      FileUtils.cp_r File.join(self.source, '_assets', '.'), self.dest
+    end
+        
+    def current_page_path
+      File.join(self.dest, "page#{self.paginator.current_page}")
+    end    
+  end
+end