doc_juan 1.0.0

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+Gemfile.lock
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in doc_juan.gemspec
+gemspec
+
+group :test do
+  gem 'rake'
+  gem 'minitest', '~> 3.1.0'
+  gem 'minitest-reporters', '~> 0.7.1'
+  gem 'mocha', '~> 0.11.4', require: false
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Joel Junström, Oktavilla
+
+MIT License
+
+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.md

@@ -0,0 +1,63 @@
+# Doc-Juan's Helper
+
+A small helper class to generate urls to a Doc-Juan instance.
+
+Give a url, a filename and options the DocJuan to generate a url to a DocJuan server including the calculated hmac key.
+
+## Usage
+
+### Required configuration
+
+You need to provide your secret key and the host of the Doc-Juan instance.
+
+    DocJuan.configure do |config|
+      config.host = 'doc-juan.it'
+      config.secret = 'my-special-secret'
+    end
+
+If you are using Rails an initializer would be the appropriate place for this.
+
+
+### Generating urls
+
+The `DocJuan.url` method generates a url to your Doc-Juan instance. It takes an url and a filename as the required arguments. You can supply an (optional) hash of options as the third argument.
+
+Valid options are:
+
+* `title` - PDF title, defaults to the title of the HTML document.
+* `print_stylesheet` - If set to `true` the print stylesheet of the resource will be used.
+* `width` - Page width in millimeters.
+* `height` - Page height in millimeters.
+* `size` - a4, letter etc. This will be ignored if width and height is set. [List of sizes](http://stackoverflow.com/questions/6394905/wkhtmltopdf-what-paper-sizes-are-valid).
+* `orientation` - `landscape` or `portrait`. Defaults to portrait.
+* `lowquality` - Renders the pdf in low quality if set to `true`
+
+#### Example
+
+    url = DocJuan.url 'http://example.com', 'example.pdf'
+    
+    url = DocJuan.url 'http://example.com', 'le-pdf.pdf', title: 'My PDF-version', size: 'A5'
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'doc_juan'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install doc_juan
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |test|
+  test.libs      << 'lib' << 'spec'
+  test.pattern   = 'spec/**/*_spec.rb'
+  test.verbose   = true
+end

data/doc_juan.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/doc_juan/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Joel Junström"]
+  gem.email         = ["joel.junstrom@oktavilla.se"]
+  gem.description   = %q{A small helper class to generate urls to a Doc-Juan instance}
+  gem.summary       = %q{Given a url and options the DocJuan generates a url to a DocJuan server including the calculated hmac key}
+  gem.homepage      = "https://github.com/Oktavilla/Doc-Juan-Helper"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "doc_juan"
+  gem.require_paths = ["lib"]
+  gem.version       = DocJuan::VERSION
+end

data/lib/doc_juan/config.rb

@@ -0,0 +1,15 @@
+module DocJuan
+
+  def self.configure
+    yield config
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  class Configuration
+    attr_accessor :host, :secret
+  end
+
+end

data/lib/doc_juan/url_generator.rb

@@ -0,0 +1,62 @@
+require 'openssl'
+require 'cgi'
+
+require_relative 'config'
+
+module DocJuan
+  class NoHostGivenError < StandardError; end
+  class NoSecretGivenError < StandardError; end
+
+  class UrlGenerator
+    attr_reader :url, :filename, :options
+
+    def initialize url, filename, options = {}
+      @url = url
+      @filename = filename.to_s
+      @options = Hash[(options || {}).sort]
+
+      raise NoSecretGivenError if secret_key == ''
+      raise NoHostGivenError if host == ''
+    end
+
+    def generate
+      params = []
+      params << "url=#{CGI.escape(url)}"
+      params << "filename=#{CGI.escape(filename)}"
+      options.each do |k,v|
+        params << "options[#{CGI.escape(k.to_s)}]=#{CGI.escape v}"
+      end
+      params << "key=#{public_key}"
+
+      "#{host}/render?#{params.join('&')}"
+    end
+
+    def public_key
+      sha1 = OpenSSL::Digest::Digest.new 'sha1'
+      OpenSSL::HMAC.hexdigest sha1, secret_key, seed_string
+    end
+
+    def seed_string
+      seed = []
+      seed << "filename:#{filename}"
+      options.each do |k,v|
+        seed << "options_#{k}:#{v}"
+      end
+      seed << "url:#{url}"
+
+      seed.join '-'
+    end
+
+    def host
+      @host ||= DocJuan.config.host.to_s.strip.tap do |host|
+        if host != '' && ! host.start_with?('http')
+          host.replace "http://#{host}"
+        end
+      end
+    end
+
+    def secret_key
+      DocJuan.config.secret.to_s.strip
+    end
+  end
+end

data/lib/doc_juan/url_helper.rb

@@ -0,0 +1,8 @@
+require_relative 'url_generator'
+
+module DocJuan
+  def self.url url, filename, options = {}
+    generator = UrlGenerator.new url, filename, options
+    generator.generate
+  end
+end

data/lib/doc_juan/version.rb

@@ -0,0 +1,3 @@
+module DocJuan
+  VERSION = "1.0.0"
+end

data/lib/doc_juan.rb

@@ -0,0 +1,4 @@
+require "doc_juan/version"
+require "doc_juan/config"
+require "doc_juan/url_generator"
+require "doc_juan/url_helper"

data/spec/configuration_spec.rb

@@ -0,0 +1,15 @@
+require_relative 'spec_helper'
+
+require_relative '../lib/doc_juan/config.rb'
+
+describe DocJuan::Configuration do
+  it 'is configurable with a block' do
+    DocJuan.configure do |config|
+      config.secret = 'very-secret'
+      config.host = 'http://my-doc-juan-host.com'
+    end
+
+    DocJuan.config.secret.must_equal 'very-secret'
+    DocJuan.config.host.must_equal 'http://my-doc-juan-host.com'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+ENV['RACK_ENV'] = 'test'
+
+require 'minitest/autorun'
+require 'minitest/reporters'
+
+MiniTest::Unit.runner = MiniTest::SuiteRunner.new
+MiniTest::Unit.runner.reporters << MiniTest::Reporters::SpecReporter.new

data/spec/url_generator_spec.rb

@@ -0,0 +1,73 @@
+require_relative 'spec_helper'
+
+require_relative '../lib/doc_juan/config.rb'
+require_relative '../lib/doc_juan/url_generator.rb'
+
+describe DocJuan::UrlGenerator do
+  before :each do
+    DocJuan.config.host = 'doc-juan.example.com'
+    DocJuan.config.secret = 'zecret'
+  end
+
+  subject do
+    DocJuan::UrlGenerator.new('http://example.com', 'file.pdf', {
+      title: 'The Site',
+      size: 'A4'
+    })
+  end
+
+  it 'generates the url' do
+    url = subject.generate
+
+    expected = 'http://doc-juan.example.com/render?'
+    expected << "url=#{CGI.escape subject.url}"
+    expected << "&filename=#{CGI.escape subject.filename}"
+    expected << "&options[size]=A4"
+    expected << "&options[title]=#{CGI.escape 'The Site'}"
+    expected << "&key=#{subject.public_key}"
+
+    url.must_equal expected
+  end
+
+  it 'has the host' do
+    DocJuan.config.host = 'example.com'
+
+    subject.host.must_equal 'http://example.com'
+  end
+
+  it 'fails with NoHostGivenError unless there is a host set' do
+    DocJuan.config.host = nil
+
+    proc {
+      subject
+    }.must_raise DocJuan::NoHostGivenError
+  end
+
+  it 'has the secret key' do
+    subject.secret_key.must_equal 'zecret'
+  end
+
+  it 'fails with NoSecretGivenError unless there is a secret set' do
+    DocJuan.config.secret = nil
+
+    proc {
+      subject
+    }.must_raise DocJuan::NoSecretGivenError
+  end
+
+  it 'compiles into a seed string for the public key computation' do
+    subject.seed_string.must_equal 'filename:file.pdf-options_size:A4-options_title:The Site-url:http://example.com'
+  end
+
+  it 'calculates the public key' do
+    subject.public_key.must_equal 'df9515da45dd0cd445a678928bc3e575cc106793'
+  end
+
+  it 'calculates the public key with no options given' do
+    url_generator = DocJuan::UrlGenerator.new 'http://example.com', 'file.pdf'
+    key = url_generator.public_key
+
+    key.must_equal '539ebb1f6cd3fec40591acdc756e9b047e7093b3'
+  end
+
+end

data/spec/url_helper_spec.rb

@@ -0,0 +1,24 @@
+require_relative 'spec_helper'
+require 'mocha'
+
+require_relative '../lib/doc_juan/url_helper'
+
+describe 'DocJuan#url' do
+  before :each do
+    DocJuan.config.host = 'doc-juan.example.com'
+    DocJuan.config.secret = 'zecret'
+  end
+
+  it 'passes its arguments to a UrlGenerator instance and uses it to generate the url' do
+    generator = stub
+    generator.expects(:generate).returns 'generated-url'
+    DocJuan::UrlGenerator.expects(:new).
+      with('http://example.com', 'the_file.pdf', size: 'A4').
+      returns(generator)
+
+    url = DocJuan.url 'http://example.com', 'the_file.pdf', size: 'A4'
+
+    url.must_equal 'generated-url'
+  end
+
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: doc_juan
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Joel Junström
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-28 00:00:00.000000000 Z
+dependencies: []
+description: A small helper class to generate urls to a Doc-Juan instance
+email:
+- joel.junstrom@oktavilla.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- doc_juan.gemspec
+- lib/doc_juan.rb
+- lib/doc_juan/config.rb
+- lib/doc_juan/url_generator.rb
+- lib/doc_juan/url_helper.rb
+- lib/doc_juan/version.rb
+- spec/configuration_spec.rb
+- spec/spec_helper.rb
+- spec/url_generator_spec.rb
+- spec/url_helper_spec.rb
+homepage: https://github.com/Oktavilla/Doc-Juan-Helper
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3357457256720695940
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3357457256720695940
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Given a url and options the DocJuan generates a url to a DocJuan server including
+  the calculated hmac key
+test_files:
+- spec/configuration_spec.rb
+- spec/spec_helper.rb
+- spec/url_generator_spec.rb
+- spec/url_helper_spec.rb