tarpipe 0.1.1

data/History.txt

@@ -0,0 +1,31 @@
+== 0.1.1 2008-05-20
+
+* Docs change
+    * Tiago Pinto email had a typo
+
+== 0.1.0 2008-05-20
+
+* API changes
+    * The #upload method now accepts an hash with the options
+    * It allows to more API stability in the future
+    * Update docs to match the new API
+
+== 0.0.4 2008-05-20
+
+* Yet another doc update
+
+== 0.0.3 2008-05-20
+
+* Docs update:
+  * Git repository URL was wrong
+
+== 0.0.2 2008-05-19
+
+* Small adjustments:
+  * endpoints are now acessors
+  * the TarPipe#upload now returns a boolean to indicate success or failure
+
+== 0.0.1 2008-05-18
+
+* Initial release:
+  * Behaviour very similar to the Python API (by Alcides Fonseca)

data/License.txt

@@ -0,0 +1,15 @@
+Copyright (c) 2008 Ruben Fonseca
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+

data/Manifest.txt

@@ -0,0 +1,26 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/tarpipe.rb
+lib/tarpipe/version.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/tarpipe_spec.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/rspec.rake
+tasks/website.rake
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/README.txt

@@ -0,0 +1,55 @@
+= tarpipe
+
+* http://tarpipe.rubyforge.org
+
+== AUTHORS:
+
+* Ruben Fonseca <root (at) cpan (dot) org>
+* Tiago Pinto <tpinto (at) webreakstuff (dot) com>
+
+== DESCRIPTION:
+
+TarPipe - Ruby bridge to tarpipe.com's REST API
+
+== FEATURES:
+
+tarpipe is a publishing mediation and distribution platform that simplifies regular upload activities:
+
+    * Publishing content to multiple Web locations;
+    * Combining different media into a single blog post or article;
+    * Transforming documents on-the-fly;
+    * Managing repeatable upload actions.
+
+== SYNOPSIS:
+
+  require 'tarpipe'
+  t = TarPipe.new('workflow token')
+  t.upload(:title => 'title', :body => 'body', :image => 'path/to/image')
+  # Returns true or false
+
+== REQUIREMENTS:
+
+* rspec >= 1.1.3
+* shared-mime-info >= 0.1
+
+== INSTALL:
+
+* sudo gem install tarpipe
+
+== LICENSE:
+
+Copyright (c) 2008 Ruben Fonseca
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+

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,74 @@
+require 'tarpipe/version'
+
+AUTHOR = 'Ruben Fonseca'
+EMAIL = "root@cpan.org"
+DESCRIPTION = "Ruby bindings to the tarpipe.com API"
+GEM_NAME = 'tarpipe'
+RUBYFORGE_PROJECT = 'tarpipe'
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+  ['rspec', '>=1.1.3'],
+  ['shared-mime-info', '>=0.1']
+]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "rubenfonseca"
+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 = YAML.load(`svn info`)['Revision']
+VERS = Tarpipe::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'tarpipe 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.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  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 = EXTRA_DEPENDENCIES
+
+    #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')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+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]))

data/lib/tarpipe.rb

@@ -0,0 +1,113 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'shared-mime-info'
+require 'net/http'
+require 'uri'
+
+# TarPipe is a bridge to the tarpipe.com's REST API
+#
+# Author:: Ruben Fonseca (mailto:root@cpan.org)
+# Copyright:: Copyright (c) 2008 Ruben Fonseca
+# License:: GPLv3 (see License.txt)
+
+# This class encapsulates the TarPipe funcionality
+class TarPipe
+  # If we want to change the endpoint
+  attr_accessor :endpoint, :endpoint_port
+  
+  # This acessor allows the user to select the worflow key anytime
+  attr_accessor :key
+
+  # Error thrown when the user doesn't specify a workflow key
+  class NoWorkflowKey < ArgumentError; end
+
+  # The key is optional
+  def initialize(key = "")
+    @key = key
+    @endpoint = 'rest.receptor.tarpipe.net'
+    @endpoint_port = 8000
+  end
+
+  # Makes a call to a workflow. All the parameters are optional:
+  #  :title a title
+  #  :body  a body
+  #  :image a fill path for an existing file
+  def upload(params = {})
+    @key = params[:key] if params[:key]
+    raise NoWorkflowKey, "TarPipe API requires your Workflow Key" unless @key
+
+    # Filter arguments
+    args = [:title, :body].inject({}) do |res, arg|
+      res[arg] = params[arg] if params[arg]
+      res
+    end
+
+    # Filter files
+    files = [:image].inject({}) do |res, arg|
+      res[arg] = params[arg] if params[arg]
+      res
+    end
+
+    post "/?key=#{@key}", args, files
+  end
+
+  private
+  # Encapsulates the upload operation. Encodes the multipart post, sets headers and
+  # uploads the request. Returns the result from the server.
+  def post(path, args, files)
+    content_type, body = encode_multipart_formdata(args, files)
+
+    headers = {
+      'User-Agent' => 'TarPipe-Ruby',
+      'Content-Type' => content_type
+    }
+
+    http = Net::HTTP.new(@endpoint, @endpoint_port)
+    resp, data = http.post2(path, body, headers)
+
+    case resp
+    when Net::HTTPSuccess
+      true
+    else
+      false
+    end
+  end
+
+  # Constructs a multipart/form-data body from the arguments and files passed
+  # as arguments.
+  def encode_multipart_formdata(fields, files, boundary = "427e4cb4ca329_133ae40413c81ef")
+    r = fields.inject('') do |result, element|
+      result << "--" << boundary << "\r\n"
+      result << "Content-Disposition: form-data; name=\"#{element.first}\"\r\n\r\n"
+      result << element.last
+
+      result
+    end
+    
+    r << files.inject('') do |result, element|
+      result << "\r\n--" << boundary << "\r\n"
+      result << "Content-Disposition: form-data; name=\"#{element.first}\";"
+      result << "filename=\"#{element.last}\"\r\n"
+      result << "Content-Type: #{get_content_type(element.last)}\r\n\r\n"
+      result << File.new(element.last, 'r').read
+
+      result
+    end
+
+    r << "\r\n--" << boundary << "--\r\n"
+
+    content_type = 'multipart/form-data; boundary=%s' % boundary
+    return content_type, r
+  end
+
+  # Tries to guess the mime type of a file. Defaults to application/octet-stream.
+  def get_content_type(file)
+    begin
+      MIME.check(file).to_s
+    rescue Exception => e
+      'application/octet-stream'
+    end
+  end
+end

data/lib/tarpipe/version.rb

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

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/tarpipe.rb'}"
+puts "Loading tarpipe gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(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, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(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, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/txt2html

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+GEM_NAME = 'tarpipe' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'tarpipe'
+
+require 'rubygems'
+begin
+  require 'newgem'
+  require 'rubyforge'
+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/#{GEM_NAME}/version.rb"
+
+version  = Tarpipe::VERSION::STRING
+download = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+def rubyforge_project_id
+  RubyForge.new.autoconfig["group_ids"][RUBYFORGE_PROJECT]
+end
+
+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.html.erb')
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > 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_template = fsrc.read
+  body_text = ERB.new(body_text_template).result(binding)
+  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)