pdf-my-url 1.0.0 → 1.0.1

data/Gemfile

@@ -0,0 +1 @@
+source 'http://rubygems.org'

data/README.rdoc

@@ -1,17 +1,29 @@
 = PDFmyURL
 
-A basic ruby-on-rails interface to http://pdfmyurl.com/
+PDFmyURL is a basic ruby-on-rails view helper for the online web service http://pdfmyurl.com/. It allows for easy PDF creation from URLs without having to install any conversion tools.
+
+== Requirements
+
+The gem has only been tested with Ruby 1.9.2 and Rails 3.0.3 but may well work with other versions of Ruby or Rails.
+
+== Installation
+
+  gem install pdf-my-url
 
 == Example
  
   <%= pdf_my_url 'CBC', 'http://www.cbc.ca/' %>
-
-  <%= pdf_my_url 'BBC', 'http://www.bbc.co.uk/', :filename => 'BBC.pdf' %>
-
-  <%= pdf_my_url 'NY Times', 'http://www.nytimes.com/', :filename => 'NY-Times.pdf',
-	  :page_height => 200, :page_width => 100,
-  	:margin_top => 10, :margin_left => 5, :margin_right => 5, :margin_bottom => 10 %>
+  
+  <%= pdf_my_url 'CBC', 'http://www.cbc.ca/', :filename => 'CBC.pdf' %>
+  
+  <%= pdf_my_url 'CBC', 'http://www.cbc.ca/', :orientation => :portrait %>
+  
+  <%= pdf_my_url 'CBC', 'http://www.cbc.ca/', :orientation => :landscape %>
+  
+  <%= pdf_my_url 'CBC', 'http://www.cbc.ca/', :page => { :height => 200, :width => 200 } %>
+  
+  <%= pdf_my_url 'CBC', 'http://www.cbc.ca/', :margin => { :top => 10, :left => 5, :right => 5, :bottom => 10 } %>
 
 == Copyright
 
-Copyright (c) 2010 Kevin Sylvestre, released under the MIT license
+Copyright (c) 2010 Kevin Sylvestre. See LICENSE for details.

data/lib/pdf-my-url.rb

@@ -1,32 +1,59 @@
-module ActionView
-  module Helpers
-      
-    def pdf_my_url(name, url, options = {})
-      
-      parameters = ""
-      
-      parameters += "&--filename=#{options[:filename]}" if options[:filename]
-      
-      parameters += "&--orientation=Portrait" if options[:orientation] == :portrait
-      parameters += "&--orientation=Landscape" if options[:orientation] == :landscape
-      
-      parameters += "&--page-size=#{options[:page_size]}" if options[:page_size]
-      
-      parameters += "&--proxy=#{options[:proxy]}" if options[:proxy]
-      parameters += "&--username=#{options[:username]}" if options[:username]
-      parameters += "&--password=#{options[:password]}" if options[:password]
-      
-      parameters += "&--page-width=#{options[:page_width]}" if options[:page_width]
-      parameters += "&--page-height=#{options[:page_height]}" if options[:page_height]
-      
-      parameters += "&--margin-top=#{options[:margin_top]}" if options[:margin_top]
-      parameters += "&--margin-left=#{options[:margin_left]}" if options[:margin_left]
-      parameters += "&--margin-right=#{options[:margin_right]}" if options[:margin_right]
-      parameters += "&--margin-bottom=#{options[:margin_bottom]}" if options[:margin_bottom]
-      
-      link_to name, "http://pdfmyurl.com/?url=#{url}#{parameters}"
-      
-    end
-      
+require 'pdf-my-url/railtie'
+
+module PdfMyUrl
+    
+  
+  # Create a link with the approriate parameters to the service.
+  #
+  # Options: 
+  #
+  # * :protocol    - set a custom protocol (the default is 'http' and 'https' is supported)
+  # * :filename    - set a custom name to download (the default is the filename made from the url)
+  # * :orientation - set a document orientation to landscape (:landscape) or portrait (:portrait)
+  # * :proxy       - set a custom proxy to access the url
+  # * :username    - set a http authentication username used when accessing the url
+  # * :password    - set a http authentication password used when accessing the url
+  # * :page
+  #   * :size      - set a page size (for example: 'A4' or 'Letter')
+  #   * :width     - set a page width (for example: '200mm') with a default unit of millimeters
+  #   * :height    - set a page height (for example: '300mm') with a default unit of millimeters
+  # * :margin
+  #   * :top       - set a margin (for example: '10mm') or use the default 10mm
+  #   * :left      - set a margin (for example: '10mm') or use the default 10mm
+  #   * :right     - set a margin (for example: '10mm') or use the default 10mm
+  #   * :bottom    - set a margin (for example: '10mm') or use the default 10mm
+  
+  def pdf_my_url(name, url, options = {})
+    
+    protocol = options[:protocol] || 'http'
+    
+    options[:page  ] ||= {}
+    options[:margin] ||= {}
+    
+    parameters = "?url=#{url}"
+    
+    parameters += "&--filename=#{options[:filename]}" if options[:filename]
+    
+    parameters += "&--orientation=Portrait"  if options[:orientation] == :portrait
+    parameters += "&--orientation=Landscape" if options[:orientation] == :landscape
+    
+    parameters += "&--proxy=#{options[:proxy]}" if options[:proxy]
+    
+    parameters += "&--username=#{options[:username]}" if options[:username]
+    parameters += "&--password=#{options[:password]}" if options[:password]
+    
+    parameters += "&--page-size=#{options[:page][:size]}"     if options[:page][:size  ]
+    parameters += "&--page-width=#{options[:page][:width]}"   if options[:page][:width ]
+    parameters += "&--page-height=#{options[:page][:height]}" if options[:page][:height]
+    
+    parameters += "&--margin-top=#{options[:margin][:top]}"       if options[:margin][:top   ]
+    parameters += "&--margin-left=#{options[:margin][:left]}"     if options[:margin][:left  ]
+    parameters += "&--margin-right=#{options[:margin][:right]}"   if options[:margin][:right ]
+    parameters += "&--margin-bottom=#{options[:margin][:bottom]}" if options[:margin][:bottom]
+    
+    link_to name, "#{protocol}://pdfmyurl.com#{parameters}"
+    
   end
+  
+  
 end

data/lib/pdf-my-url/railtie.rb

@@ -0,0 +1,10 @@
+require 'pdf-my-url'
+require 'rails'
+
+module PdfMyUrl
+  class Railtie < Rails::Railtie
+    initializer 'pdf-my-url.initialize' do
+      ActionView::Helpers.send :include, PdfMyUrl
+    end
+  end
+end

data/lib/pdf-my-url/version.rb

@@ -0,0 +1,3 @@
+module PdfMyUrl
+  VERSION = "1.0.1"
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: pdf-my-url
 version: !ruby/object:Gem::Version 
-  hash: 23
   prerelease: false
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Kevin Sylvestre
@@ -15,33 +14,33 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-19 00:00:00 -04:00
+date: 2010-12-29 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
-description: 
+description: PDF my URL is a Ruby on Rails view helper for easily creating attachments from the online web service with the same name.
 email: 
+- kevin@ksylvest.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
-- MIT-LICENSE
-- README.rdoc
-- Rakefile
-- VERSION
-- init.rb
+- lib/pdf-my-url/railtie.rb
+- lib/pdf-my-url/version.rb
 - lib/pdf-my-url.rb
-- pdf-my-url.gemspec
+- README.rdoc
+- LICENSE
+- Gemfile
 has_rdoc: true
 homepage: http://github.com/ksylvest/pdf-my-url
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -49,7 +48,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -58,7 +56,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"

data/Rakefile

@@ -1,14 +0,0 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "pdf-my-url"
-    gemspec.summary = "A basic ruby-on-rails interface to http://pdfmyurl.com/"
-    gemspec.homepage = "http://github.com/ksylvest/pdf-my-url"
-    gemspec.author = "Kevin Sylvestre"
-  end
-rescue LoadError
-  puts "Jeweler not available. Install it with: gem install jeweler"
-end

data/VERSION

@@ -1 +0,0 @@
-1.0.0

data/init.rb

@@ -1 +0,0 @@
-require 'pdf-my-url'

data/pdf-my-url.gemspec

@@ -1,41 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{pdf-my-url}
-  s.version = "1.0.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Kevin Sylvestre"]
-  s.date = %q{2010-07-19}
-  s.extra_rdoc_files = [
-    "README.rdoc"
-  ]
-  s.files = [
-    "MIT-LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "init.rb",
-     "lib/pdf-my-url.rb",
-     "pdf-my-url.gemspec"
-  ]
-  s.homepage = %q{http://github.com/ksylvest/pdf-my-url}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{A basic ruby-on-rails interface to http://pdfmyurl.com/}
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
-end
-