doc_juan 1.1.0 → 1.2.0

data/Gemfile

@@ -8,4 +8,5 @@ group :test do
   gem 'minitest', '~> 3.1.0'
   gem 'minitest-reporters', '~> 0.7.1'
   gem 'mocha', '~> 0.11.4', require: false
+  gem 'addressable', '~> 2.2.8', require: false
 end

data/README.md

@@ -17,6 +17,11 @@ You need to provide your secret key and the host of the Doc-Juan instance.
 
 If you are using Rails an initializer would be the appropriate place for this.
 
+### Authentication
+
+If your site is behind HTTP Basic Authentication `DocJuan.config.username` and `DocJuan.config.password` is your friends.
+
+**BEWARE!** Setting these will append your credentials to every DocJuan url generated and, depending on how you use them, can be _fully visible to your users_. The authentication credentials is foremost available for testing in your staging environment.
 
 ### Generating urls
 
@@ -30,7 +35,8 @@ Valid options are:
 * `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`
+* `lowquality` - Renders the pdf in low quality if set to `true`.
+* `format` - Output file format, `pdf` or `jpg`. Defaults to `pdf`.
 
 #### Example
 

data/lib/doc_juan/token.rb

@@ -0,0 +1,36 @@
+require 'openssl'
+require_relative 'config.rb'
+
+module DocJuan
+  class NoSecretGivenError < StandardError; end
+
+  class Token
+    def initialize url_generator
+      @url_generator = url_generator
+
+      raise NoSecretGivenError if secret == ''
+    end
+
+    def key
+      sha1 = OpenSSL::Digest::Digest.new 'sha1'
+      OpenSSL::HMAC.hexdigest sha1, secret, seed
+    end
+
+    def secret
+      DocJuan.config.secret.to_s.strip
+    end
+
+    def seed
+      seed = []
+      seed << "filename:#{@url_generator.filename}"
+      seed << "format:#{@url_generator.format}"
+      Hash[(@url_generator.options).sort].each do |k,v|
+        seed << "options_#{k}:#{v}"
+      end
+      seed << "url:#{@url_generator.url}"
+
+      seed.join '-'
+    end
+
+  end
+end

data/lib/doc_juan/url_generator.rb

@@ -1,24 +1,23 @@
-require 'openssl'
 require 'cgi'
 
+require_relative 'token'
 require_relative 'config'
 
 module DocJuan
   class NoHostGivenError < StandardError; end
-  class NoSecretGivenError < StandardError; end
 
   class UrlGenerator
-    attr_reader :url, :filename, :options
+    attr_reader :url, :filename, :format, :options
 
-    def initialize url, filename, options = {}
+    def initialize url, filename, format = 'pdf', options = {}
       @url = url
       @filename = filename.to_s
+      @format = format
 
       options = {} unless options
       options = options.merge authentication_credentials if has_authentication_credentials?
-      @options = Hash[(options || {}).sort]
+      @options = options
 
-      raise NoSecretGivenError if secret_key == ''
       raise NoHostGivenError if host == ''
     end
 
@@ -26,6 +25,7 @@ module DocJuan
       params = []
       params << "url=#{CGI.escape(url)}"
       params << "filename=#{CGI.escape(filename)}"
+      params << "format=#{CGI.escape(format)}"
       options.each do |k,v|
         params << "options[#{CGI.escape(k.to_s)}]=#{CGI.escape v.to_s}"
       end
@@ -35,19 +35,7 @@ module DocJuan
     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 '-'
+      @public_key ||= DocJuan::Token.new(self).key
     end
 
     def host
@@ -58,10 +46,6 @@ module DocJuan
       end
     end
 
-    def secret_key
-      DocJuan.config.secret.to_s.strip
-    end
-
     def authentication_credentials
       {
         username: DocJuan.config.username,

data/lib/doc_juan/url_helper.rb

@@ -2,7 +2,6 @@ require_relative 'url_generator'
 
 module DocJuan
   def self.url url, filename, options = {}
-    generator = UrlGenerator.new url, filename, options
-    generator.generate
+    UrlGenerator.new(url, filename, options.delete(:format), options).generate
   end
 end

data/lib/doc_juan/version.rb

@@ -1,3 +1,3 @@
 module DocJuan
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/spec/token_spec.rb

@@ -0,0 +1,48 @@
+require_relative 'spec_helper'
+require_relative '../lib/doc_juan/token.rb'
+require 'mocha'
+
+describe DocJuan::Token do
+  before :each do
+    DocJuan.config.secret = 'zecret'
+  end
+
+  let(:url_generator) do
+    stub(url: 'http://example.com', filename: 'file', format: 'pdf', options: {
+      title: 'The Site',
+      size: 'A4',
+      print_stylesheet: true
+    })
+  end
+
+  subject { DocJuan::Token.new(url_generator) }
+
+  it 'compiles into a seed string for the public key computation' do
+    subject.seed.must_equal 'filename:file-format:pdf-options_print_stylesheet:true-options_size:A4-options_title:The Site-url:http://example.com'
+  end
+
+  it 'calculates the public key' do
+    subject.key.must_equal 'b55142f9fdb148e8844e37e064e8eb2af6aabac6'
+  end
+
+  it 'calculates the public key with no options given' do
+    url_generator = stub url: 'http://example.com', filename: 'file', format: 'pdf', options: {}
+    token = DocJuan::Token.new(url_generator)
+
+    token.key.must_equal '539ebb1f6cd3fec40591acdc756e9b047e7093b3'
+  end
+
+  it 'has the secret key' do
+    subject.secret.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
+
+
+end

data/spec/url_generator_spec.rb

@@ -1,8 +1,12 @@
+require 'addressable/uri'
+
 require_relative 'spec_helper'
 
 require_relative '../lib/doc_juan/config.rb'
 require_relative '../lib/doc_juan/url_generator.rb'
 
+require 'mocha'
+
 describe DocJuan::UrlGenerator do
   before :each do
     DocJuan.config.host = 'doc-juan.example.com'
@@ -10,7 +14,7 @@ describe DocJuan::UrlGenerator do
   end
 
   subject do
-    DocJuan::UrlGenerator.new('http://example.com', 'file.pdf', {
+    DocJuan::UrlGenerator.new('http://example.com', 'file', 'pdf', {
       title: 'The Site',
       size: 'A4',
       print_stylesheet: true
@@ -18,32 +22,22 @@ describe DocJuan::UrlGenerator do
   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[print_stylesheet]=true"
-    expected << "&options[size]=A4"
-    expected << "&options[title]=#{CGI.escape 'The Site'}"
-    expected << "&key=#{subject.public_key}"
-
-    url.must_equal expected
-  end
+    uri = Addressable::URI.parse subject.generate
+    query = CGI.parse uri.query
 
-  it 'generates the url with no options' do
-    subject.stubs(:options).returns Hash.new
-    url = subject.generate
+    uri.host.must_equal 'doc-juan.example.com'
+    uri.path.must_equal '/render'
 
-    expected = 'http://doc-juan.example.com/render?'
-    expected << "url=#{CGI.escape subject.url}"
-    expected << "&filename=#{CGI.escape subject.filename}"
-    expected << "&key=#{subject.public_key}"
+    query['url'].first.must_equal subject.url
+    query['filename'].first.must_equal subject.filename
+    query['key'].first.must_equal subject.public_key
+    query['format'].first.must_equal subject.format
 
-    url.must_equal expected
+    subject.options.each do |k, v|
+      query["options[#{k}]"].first.must_equal v.to_s
+    end
   end
 
-
   it 'has the host' do
     DocJuan.config.host = 'example.com'
 
@@ -58,16 +52,9 @@ describe DocJuan::UrlGenerator do
     }.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
+  it 'uses the token class to calculate the key' do
+    DocJuan::Token.expects(:new).with(subject).returns stub(key: 'verypublickey')
+    subject.public_key.must_equal 'verypublickey'
   end
 
   describe '#authentication' do
@@ -92,7 +79,6 @@ describe DocJuan::UrlGenerator do
       subject.has_authentication_credentials?.must_equal false
     end
 
-
     it 'appends username and password to options if set as config variables' do
       subject.options[:username].must_equal 'xkcd'
       subject.options[:password].must_equal 'correct horse battery staple'
@@ -100,19 +86,4 @@ describe DocJuan::UrlGenerator do
 
   end
 
-  it 'compiles into a seed string for the public key computation' do
-    subject.seed_string.must_equal 'filename:file.pdf-options_print_stylesheet:true-options_size:A4-options_title:The Site-url:http://example.com'
-  end
-
-  it 'calculates the public key' do
-    subject.public_key.must_equal 'b55142f9fdb148e8844e37e064e8eb2af6aabac6'
-  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

@@ -13,12 +13,22 @@ describe 'DocJuan#url' do
     generator = stub
     generator.expects(:generate).returns 'generated-url'
     DocJuan::UrlGenerator.expects(:new).
-      with('http://example.com', 'the_file.pdf', size: 'A4').
+      with('http://example.com', 'the_file', nil, size: 'A4').
       returns(generator)
 
-    url = DocJuan.url 'http://example.com', 'the_file.pdf', size: 'A4'
+    url = DocJuan.url 'http://example.com', 'the_file', size: 'A4'
 
     url.must_equal 'generated-url'
   end
 
+  it 'passes format if set to UrlGenerator instance' do
+    generator = stub
+    generator.expects(:generate)
+    DocJuan::UrlGenerator.expects(:new).
+      with('http://example.com', 'the_file', 'jpg', {}).
+      returns(generator)
+
+    DocJuan.url 'http://example.com', 'the_file', format: 'jpg'
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doc_juan
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-28 00:00:00.000000000 Z
+date: 2012-09-26 00:00:00.000000000 Z
 dependencies: []
 description: A small helper class to generate urls to a Doc-Juan instance
 email:
@@ -26,11 +26,13 @@ files:
 - doc_juan.gemspec
 - lib/doc_juan.rb
 - lib/doc_juan/config.rb
+- lib/doc_juan/token.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/token_spec.rb
 - spec/url_generator_spec.rb
 - spec/url_helper_spec.rb
 homepage: https://github.com/Oktavilla/Doc-Juan-Helper
@@ -45,21 +47,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3331118814664929665
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3331118814664929665
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Given a url and options the DocJuan generates a url to a DocJuan server including
@@ -67,5 +63,6 @@ summary: Given a url and options the DocJuan generates a url to a DocJuan server
 test_files:
 - spec/configuration_spec.rb
 - spec/spec_helper.rb
+- spec/token_spec.rb
 - spec/url_generator_spec.rb
 - spec/url_helper_spec.rb