mirrored 0.1.0

data/History.txt

@@ -0,0 +1,2 @@
+0.1.0 - Oct 6, 2007
+			* initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 John Nunemaker
+
+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/Manifest.txt

@@ -0,0 +1,47 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/mirrored.rb
+lib/mirrored/base.rb
+lib/mirrored/connection.rb
+lib/mirrored/date.rb
+lib/mirrored/post.rb
+lib/mirrored/tag.rb
+lib/mirrored/update.rb
+lib/mirrored/version.rb
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_base.rb
+test/test_date.rb
+test/test_helper.rb
+test/test_post.rb
+test/test_tag.rb
+test/test_update.rb
+test/fixtures/xml/add_post_done.xml
+test/fixtures/xml/all_posts.xml
+test/fixtures/xml/all_posts_by_tag.xml
+test/fixtures/xml/dates.xml
+test/fixtures/xml/dates_for_tag.xml
+test/fixtures/xml/delete_post.xml
+test/fixtures/xml/delete_post_failed.xml
+test/fixtures/xml/posts.xml
+test/fixtures/xml/posts_by_date.xml
+test/fixtures/xml/posts_by_tag.xml
+test/fixtures/xml/posts_by_url.xml
+test/fixtures/xml/recent_posts.xml
+test/fixtures/xml/recent_posts_by_tag.xml
+test/fixtures/xml/recent_posts_by_tag_and_count.xml
+test/fixtures/xml/tag_rename.xml
+test/fixtures/xml/tags.xml
+website/css/common.css
+website/images
+website/index.html

data/README.txt

@@ -0,0 +1 @@
+README

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,71 @@
+require 'mirrored/version'
+
+AUTHOR             = 'John Nunemaker'  # can also be an array of Authors
+EMAIL              = "nunemaker@gmail.com"
+DESCRIPTION        = "Wrapper for delicious and magnolia mirrored apis"
+GEM_NAME           = 'mirrored' # what ppl will type to install your gem
+RUBYFORGE_PROJECT  = 'mirrored' # The unix name for your project
+HOMEPATH           = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH      = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file       = "~/.rubyforge/user-config.yml"
+@config            = nil
+RUBYFORGE_USERNAME = "jnunemaker"
+
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Mirrored::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'mirrored documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\\n\\n")
+  p.extra_deps = [['hpricot', '0.5']]     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'mirrored'

data/lib/mirrored/base.rb

@@ -0,0 +1,50 @@
+module Mirrored
+  
+  class InvalidService < Exception; end
+  class ConnectionNotSet < Exception; end
+  
+  API_URL = {:delicious => 'https://api.del.icio.us/v1/', :magnolia => 'https://ma.gnolia.com/api/mirrord/v1/'}
+  
+  class Base
+    class << self
+      # Sets up the login information for either magnolia or delicious.
+      #
+      # Usage:
+      #   Mirrored::Base.establish_connection(:delicious, 'jnunemaker', 'password')
+      #   Mirrored::Base.establish_connection(:magnolia, 'jnunemaker', 'password')
+      def establish_connection(s, u, p)
+        remove_connection
+        raise InvalidService unless valid_service?(s)
+        @@service = s
+        @@connection = Connection.new(api_url, :username => u, :password => p)
+      end
+      
+      # Removes the current connection information
+      def remove_connection
+        @@service, @@connection = nil, nil
+      end
+      
+      def valid_service?(s) #:nodoc:
+        s = s.nil? ? '' : s
+        API_URL.keys.include?(s)
+      end
+      
+      def api_url
+        API_URL[@@service]
+      end
+      
+      def service
+        @@service
+      end
+      
+      def connection
+        @@connection
+      end
+    end
+    
+    private
+      def ensure_connection_set #:nodoc:
+        raise ConnectionNotSet if self.class.connection.nil? || self.class.service.nil?
+      end
+  end
+end

data/lib/mirrored/connection.rb

@@ -0,0 +1,39 @@
+require 'net/https'
+
+module Mirrored
+	class Connection
+		def initialize(base_url, args = {})
+			@base_url = base_url
+			@username = args[:username]
+			@password = args[:password]
+		end
+
+		def get(resource, args = nil)
+			request(resource, "get", args)
+		end
+
+		def post(resource, args = nil)
+			request(resource, "post", args)
+		end
+
+		def request(resource, method = "get", args = nil)
+			url = URI.join(@base_url, resource)
+			url.query = args.map { |k,v| "%s=%s" % [URI.encode(k.to_s), URI.encode(v.to_s)] }.join("&") if args
+      
+			case method
+			when "get"
+				req = Net::HTTP::Get.new(url.request_uri)
+			when "post"
+				req = Net::HTTP::Post.new(url.request_uri)
+			end
+      
+			req.basic_auth(@username, @password) if @username && @password
+      
+			http = Net::HTTP.new(url.host, url.port)
+			http.use_ssl = (url.port == 443)
+      
+			res = http.start() { |conn| conn.request(req) }
+			res.body
+		end
+	end
+end

data/lib/mirrored/date.rb

@@ -0,0 +1,28 @@
+module Mirrored
+  class Date < Base
+    attr_accessor :count, :date
+    
+    class << self
+      def new_from_xml(xml) #:nodoc:
+        d       = Date.new
+        d.date  = ::Date.parse((xml)['date'])
+        d.count = (xml)['count']
+        d
+      end
+      
+      # Does all the hard work finding the dates you have posted and how many posts on those days.
+      #
+      # Usage:
+      #   Mirrored::Date.find(:all)                 # => finds all dates you have posted with counts for each day
+      #   Mirrored::Date.find(:all, :tag => 'ruby') # => finds all dates you have posted something tagged ruby with counts for each day
+      def find(*args)
+        raise ArgumentError, "First argument must be symbol (:all)" unless args.first.kind_of?(Symbol)
+        params = args.extract_options!
+        params = params == {} ? nil : params
+        
+        doc = Hpricot::XML(connection.get("posts/dates", params))
+        (doc/:date).inject([]) { |elements, el| elements << new_from_xml(el); elements }
+      end
+    end
+  end
+end

data/lib/mirrored/post.rb

@@ -0,0 +1,120 @@
+module Mirrored
+  class Post < Base
+    attr_accessor :href, :description, :extended, :hash, :others, :tags, :time, :code, :share
+    
+    alias :url :href
+    alias :url= :href=
+    alias :dt :time
+    alias :dt= :time=
+    
+    class << self
+      # Creates a new post from an hpricot post instance.
+      def new_from_xml(xml) #:nodoc:
+        p             = Post.new
+        p.href        = (xml)['href']
+        p.description = (xml)['description']
+        p.extended    = (xml)['extended']
+        p.hash        = (xml)['hash']
+        p.others      = (xml)['others']
+        p.tags        = (xml)['tag']
+        p.time        = Time.parse((xml)['time'])
+        p
+      end
+      
+      # Does all the hard work finding your posts by various filters and such.
+      #
+      # Usage:
+      #
+      # Valid hash options for :get are :tag, :dt and :url. All are optional and can be used in any combination.
+      #   Mirrored::Post.find(:get)                                     # => posts
+      #   Mirrored::Post.find(:get, :tag => 'ruby')                     # => posts tagged ruby
+      #   Mirrored::Post.find(:get, :tag => 'ruby', :dt => '2007-10-05')# => posts tagged ruby on oct. 5, 2007
+      #   Mirrored::Post.find(:get, :url => 'http://addictedtonew')     # => posts with url http://addictedtonew
+      #
+      # Valid hash option for :all is :tag. All are optional and can be used in any combination.
+      # Use sparingly according to magnolia and delicious.
+      #   Mirrored::Post.find(:all)                                     # => all posts
+      #   Mirrored::Post.find(:all, :tag => 'ruby')                     # => all posts for tag ruby
+      #
+      # Valid hash options for :recent are :tag and :count. All are optional and can be used in any combination.
+      #   Mirrored::Post.find(:recent)                                  # most recent posts
+      #   Mirrored::Post.find(:recent, :tag => 'ruby')                  # => most recent posts for tag ruby
+      #   Mirrored::Post.find(:recent, :tag => 'ruby', :count => '5')   # => 5 most recent posts for tag ruby
+      def find(*args)
+        raise ArgumentError, "First argument must be symbol (:all or :recent)" unless args.first.kind_of?(Symbol)
+        params = args.extract_options!
+        params = params == {} ? nil : params
+        
+        filter = case args.first
+        when :recent
+          'recent'
+        when :all
+          'all'
+        else
+          'get'
+        end
+        
+        doc = Hpricot::XML(connection.get("posts/#{filter}", params))
+        (doc/:post).inject([]) { |elements, el| elements << Post.new_from_xml(el); elements }
+      end
+      
+      # Destroys a post by url.
+      #
+      # Usage:
+      #   Mirrored::Post.destroy('http://microsoft.com')  
+      #   Mirrored::Post.delete('http://microsoft.com')   # => aliased version
+      def destroy(url)
+        doc = Hpricot::XML(connection.get('posts/delete', :url => url))
+        code = doc.at('result')['code']
+        code == 'done' ? true : false
+      end
+      alias :delete :destroy
+    end
+    
+    # Saves a post to delicious or magnolia.
+    #
+    # Usage:
+    #   p             = Mirrored::Post.new
+    #   p.url         = 'http://addictedtonew.com'
+    #   p.description = 'Addicted to New by John Nuneamker'
+    #   p.extended    = 'Really cool dude'
+    #   p.tags        = %w(cool dude ruby)
+    #   p.save        # => do not replace if post already exists
+    #   p.save(true)  # => replace post if it already exists
+    def save(replace=false)
+      attrs = to_h.merge((replace) ? {:replace => 'yes'} : {:replace => 'no'})
+      puts attrs.inspect
+      doc = Hpricot::XML(self.class.connection.get('posts/add', attrs))
+      @code = doc.at('result')['code']
+      (@code == 'done') ? true : false
+    end
+    
+    def to_h #:nodoc:
+      {
+        :url         => url, 
+        :description => description, 
+        :extended    => extended, 
+        :tags        => (tags ? tags.map { |t| t.gsub(' ', '_') }.join(' ') : ''),
+        :share       => share
+      }
+    end
+    
+    # Defaults share to yes
+    def share
+      @share ? @share : 'yes'
+    end
+    
+    # Makes it so that tags= can take a string or array.
+    #
+    # Usage:
+    #   Mirrored::Post.new.tags = %w(ruby rails sweet)  # => %w(ruby rails sweet)
+    #   Mirrored::Post.new.tags = 'ruby rails sweet'    # => %w(ruby rails sweet)
+    def tags=(string_or_array)
+      if string_or_array.kind_of?(Array)
+        @tags = string_or_array
+      else
+        @tags = string_or_array.split(' ').map { |t| t.gsub('_', ' ') }
+      end
+    end
+  end
+end

data/lib/mirrored/tag.rb

@@ -0,0 +1,34 @@
+module Mirrored
+  class Tag < Base
+    attr_accessor :count, :name
+    
+    class << self
+      def new_from_xml(xml) #:nodoc:
+        t       = Tag.new
+        t.count = (xml)['count']
+        t.name  = (xml)['tag']
+        t
+      end
+      
+      # Does all the hard work finding your tags and how much you've used them.
+      #
+      # Usage:
+      #   Mirrored::Tag.find(:get)
+      def find(*args)
+        raise ArgumentError, "Only takes a symbol as the argument (:get, :all)" unless args.first.kind_of?(Symbol)
+        doc = Hpricot::XML(connection.get('tags/get'))
+        (doc/:tag).inject([]) { |elements, el| elements << Tag.new_from_xml(el); elements }
+      end
+      
+      # Renames a tag from the old name to a new one.
+      #
+      # Usage:
+      #   Mirrored::Tag.rename('microsoft', 'suckfest')
+      def rename(old_name, new_name)
+        doc    = Hpricot::XML(connection.get('tags/rename', :old => old_name, :new => new_name))
+        result = (doc).at(:result)
+        (result && result.inner_html == 'done') ? true : false
+      end
+    end
+  end
+end

data/lib/mirrored/update.rb

@@ -0,0 +1,16 @@
+module Mirrored
+  class Update < Base
+    class << self
+      # Returns a ruby time object that is equal to the last time you posted something. If you haven't posted anything it returns an empty string (probably).
+      #
+      # Usage:
+      #   Mirrored::Update.last # => a ruby time object in UTC
+      def last
+        result = connection.get('posts/update')
+        doc    = Hpricot::XML(result)
+        update = doc.at('update')
+        update ? Time.parse(update['time']) : ''
+      end
+    end
+  end
+end

data/lib/mirrored/version.rb

@@ -0,0 +1,9 @@
+module Mirrored #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/mirrored.rb

@@ -0,0 +1,25 @@
+$:.unshift File.dirname(__FILE__)
+
+class Array
+  # Extract options from a set of arguments. Removes and returns the last element in the array if it's a hash, otherwise returns a blank hash.
+  #
+  #   def options(*args)
+  #     args.extract_options!
+  #   end
+  #
+  #   options(1, 2)           # => {}
+  #   options(1, 2, :a => :b) # => {:a=>:b}
+  def extract_options!
+    last.is_a?(::Hash) ? pop : {}
+  end
+end
+
+require 'rubygems'
+require 'hpricot'
+
+require 'mirrored/base'
+require 'mirrored/connection'
+require 'mirrored/date'
+require 'mirrored/post'
+require 'mirrored/tag'
+require 'mirrored/update'

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/txt2html

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+begin
+  require 'newgem'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + '/../lib/mirrored/version.rb'
+
+version  = Mirrored::VERSION::STRING
+download = 'http://rubyforge.org/projects/mirrored'
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.rhtml')
+  
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.rhtml] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text = fsrc.read
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)