url2pdf 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ddfeb99c849ccaccf8388ae63f53df0ec4c0502
+  data.tar.gz: 29badc8e2353cff4169f0bf473c1579182d015ca
+SHA512:
+  metadata.gz: 0c1028f5d5bfb86c629b93ebb53287708c0c9f3dcc7a908b935772e9044fba8ed539552f5a76741cc01c9cdeb51318ab0fda53cefcaa697409def3c7420b8240
+  data.tar.gz: 2ca0f60405fcc22faac6341b12d669ce5907871c530645441d816bb3e3d45898a6a72da1195d0609a0975c45f0842d47afb2f982fa9fe3e528f17a05543c3c0f

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/.ruby-gemset

@@ -0,0 +1 @@
+url2pdf

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in url2pdf.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,39 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'bundle exec rspec --color --format=documentation' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Nic Pillinger
+
+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,31 @@
+# Url2pdf
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'url2pdf'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install url2pdf
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/url2pdf/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/url2pdf.rb

@@ -0,0 +1,31 @@
+require "url2pdf/version"
+require 'httparty'
+require 'rack'
+
+module Url2pdf
+
+  class Client
+
+    DEFAULT_PDF_SERVICE_URL = 'http://icanhazpdf.lsfapp.com/generate_pdf'
+    DEFAULT_HTTP_TIMEOUT = 10000
+
+    def initialize(api_key, options = {})
+      @api_key = api_key
+      @service_options = options
+    end
+
+    def pdf_from_url(full_url, options = {})
+      raise "API Key Is Required" if @api_key.nil?
+      uri = URI(full_url)
+      params = URI.decode_www_form(uri.query || "") << ['icanhazpdf', @api_key]
+      uri.query = URI.encode_www_form(params)
+      encoded_url = "#{@service_options[:server_url] || DEFAULT_PDF_SERVICE_URL}?url=#{Rack::Utils.escape(uri)}"
+      encoded_url += "&engine=#{options[:engine]}" if options.has_key?(:engine)
+      encoded_url += "&margin=#{options[:margin]}" if options.has_key?(:margin)
+      encoded_url += "&orientation=#{options[:orientation]}" if options.has_key?(:orientation)
+
+      HTTParty.get(encoded_url, timeout: @service_options[:timeout] || DEFAULT_HTTP_TIMEOUT)
+    end
+  end
+
+end

data/lib/url2pdf/version.rb

@@ -0,0 +1,3 @@
+module Url2pdf
+  VERSION = "0.0.1"
+end

data/spec/lib/url2pdf_spec.rb

@@ -0,0 +1,90 @@
+require 'url2pdf'
+
+describe "Url2pdf" do
+
+  describe "client pdf from url" do
+    let(:api_key) { "123abc" }
+    let(:options) { {} }
+
+    subject { Url2pdf::Client.new(api_key, options) }
+
+    before(:each) do
+      allow(HTTParty).to receive(:get)
+    end
+
+    it 'appends api_key to the url supplied' do
+      subject.pdf_from_url('http://a.url')
+      expect(HTTParty).to have_received(:get).with(/#{api_key}/, anything)
+    end
+
+    it 'escapes the url and params supplied so that it can be properly passed to the server' do
+      subject.pdf_from_url('http://google.com?param=something&another=different')
+      expect(HTTParty).to have_received(:get).with(/http%3A%2F%2Fgoogle.com%3Fparam%3Dsomething%26another%3Ddifferent/, anything)
+    end
+
+    it 'uses the default server unless otherwise specified' do
+      subject.pdf_from_url('http://a.url')
+      expect(HTTParty).to have_received(:get).with(/^#{Url2pdf::Client::DEFAULT_PDF_SERVICE_URL}/, anything)
+    end
+
+    it 'uses the default timeout unless otherwise specified' do
+      subject.pdf_from_url('http://a.url')
+      expect(HTTParty).to have_received(:get).with(anything, hash_including(timeout: Url2pdf::Client::DEFAULT_HTTP_TIMEOUT))
+    end
+
+    context 'different pdf server is specified in options' do
+      let(:server_url) { "http://newicanhazserver.com" }
+      let(:options) { {server_url: server_url} }
+
+      it 'uses the server url supplied' do
+        subject.pdf_from_url('http://a.url')
+        expect(HTTParty).to have_received(:get).with(/^#{server_url}/, anything)
+      end
+    end
+
+    context 'timeout is specified in options' do
+      let(:timeout) { 2000 }
+      let(:options) { {timeout: timeout} }
+
+      it 'uses the http timeout supplied' do
+        subject.pdf_from_url('http://a.url')
+        expect(HTTParty).to have_received(:get).with(anything, hash_including(timeout: timeout))
+      end
+    end
+
+    context 'no api key is supplied' do
+      let(:api_key) { nil }
+
+      it 'raises an eror' do
+        expect { subject.pdf_from_url('http://a.url') }.to raise_error("API Key Is Required")
+      end
+    end
+
+    describe 'pdf options supplied' do
+
+      context 'margin' do
+        it 'passes the margin parameter to the server' do
+          subject.pdf_from_url('http://a.url', {margin: '5cm'})
+          expect(HTTParty).to have_received(:get).with(/margin=5cm/, anything)
+        end
+      end
+
+      context 'orientation' do
+        it 'passes the orientation parameter to the server' do
+          subject.pdf_from_url('http://a.url', {orientation: :landscape})
+          expect(HTTParty).to have_received(:get).with(/orientation=landscape/, anything)
+        end
+      end
+
+      context 'valid engine' do
+        it 'passes the engine parameter' do
+          subject.pdf_from_url('http://a.url', {engine: :phantomjs})
+          expect(HTTParty).to have_received(:get).with(/engine=phantomjs/, anything)
+        end
+      end
+
+    end
+
+  end
+
+end

data/url2pdf.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'url2pdf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "url2pdf"
+  spec.version       = Url2pdf::VERSION
+  spec.authors       = ["Nic Pillinger"]
+  spec.email         = ["nic@lsf.io"]
+  spec.summary       = %q{ URL => PDF }
+  spec.description   = %q{ Client for LSF PDF service }
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack", "~> 1.6"
+  spec.add_dependency "httparty", "~> 0.13.3"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "guard", "~> 2.12"
+  spec.add_development_dependency "guard-rspec", "~> 4.5"
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: url2pdf
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nic Pillinger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+description: " Client for LSF PDF service "
+email:
+- nic@lsf.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/url2pdf.rb
+- lib/url2pdf/version.rb
+- spec/lib/url2pdf_spec.rb
+- url2pdf.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: URL => PDF
+test_files:
+- spec/lib/url2pdf_spec.rb