select_pdf_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 098930437dd6e75013830c8ceb62783b408309d6
+  data.tar.gz: 99170880bbe8759d518cebee3ded5e3dd8c80489
+SHA512:
+  metadata.gz: 1184de9dde9c70d531d001abd0c922abe91af93bb92f578e90e8cf5d18c188d52aba7b4f038933056b4df76785f07c51bcf185f83fe32c8715880078d19b2be5
+  data.tar.gz: db5fdabb37f34e977ecfdacc071848f6691973c20381e718d9a30ed1aa90caaf4526d37dbdebe5f55b598279d528bad215f143697833185b49506238cc92ccf4

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 arianamador
+
+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,70 @@
+# select_pdf_api
+
+A wrapper for the [selectpdf.org](http://selectpdf.com/) public API.
+
+The [selectpdf.org](http://selectpdf.com/) online API allows you to create PDFs from web pages and raw HTML code in your applications.
+
+## Installation
+Add this line to your application's Gemfile:
+
+    gem 'select_pdf_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install select_pdf_api
+
+You'll need to have a config folder and at least the default select-pdf-config.yml file. Inside your config folder you'll be able to have as many config.yml files as necessary.
+
+    mkdir config
+    touch select-pdf-config.yml
+
+Inside your select-pdf-config.yml:
+``` ruby
+key: 'service api key'
+```
+See the [API Documentation](https://github.com/arian-amador/select_pdf_api/) for all the options. 
+
+## Usage
+
+##### Default
+``` ruby
+pdf_doc = SelectPdfApi.new({url: "http://www.google.com"})   # Load the default select-pdf-config.yml and setup the url to capture. 
+pdf_doc.download   # Save result to the default ./document.pdf
+
+```
+##### Load a specific config per download
+``` ruby
+
+sites = [
+  {url: "http://www.google.com", save_to: 'google_com.pdf'},
+  {url: "http://mail.yahoo.com", save_to: 'mail_yahoo.pdf', 
+    config_file: 'password-protected-yahoo.yml'}]
+
+sites.each do |options|
+  pdf = SelectPdfApi.new options
+  pdf.download
+end
+```
+
+##### Changing config options
+``` ruby
+pdf = SelectPdfApi.new   # Loads default config file.
+pdf.config.load_config('wide_margins.yml')   # Load wide margin options.
+pdf.download
+```
+
+## Documentation
+* API - http://selectpdf.com/html-to-pdf-api/
+* Rubydoc - http://www.rubydoc.info/github/arian-amador/select_pdf_api/master
+* GitHub - https://github.com/arian-amador/select_pdf_api/
+
+## Contributing
+1. Fork it ( https://github.com/arian-amador/select_pdf_api/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,6 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/test_select_pdf_api/test_*.rb"
+end

data/lib/select_pdf_api/exceptions.rb

@@ -0,0 +1,4 @@
+class SelectPdfApi
+	class DownloadError < StandardError; end
+	class ConfigError < StandardError; end
+end

data/lib/select_pdf_api/version.rb

@@ -0,0 +1,3 @@
+class SelectPdfApi
+	VERSION = "0.0.1"
+end

data/lib/select_pdf_api/yaml_file_config.rb

@@ -0,0 +1,24 @@
+class SelectPdfApi
+	class YamlFileConfig
+
+		def initialize(filename)
+			@data = {}
+			load_config filename
+		end
+
+		def load_config(filename)
+			config_file = File.join(File.expand_path(File.join('config')), filename)
+
+			raise SelectPdfApi::ConfigError, "Config file #{config_file} does not exist." unless
+				File.exist? config_file
+
+			@data = YAML::load_file(config_file)
+
+			raise SelectPdfApi::ConfigError, "Error loading values from #{config_file}" unless @data
+		end
+
+		def options
+			@data
+		end
+	end
+end

data/lib/select_pdf_api.rb

@@ -0,0 +1,52 @@
+require 'yaml'
+require 'httparty'
+
+require 'select_pdf_api/yaml_file_config'
+require 'select_pdf_api/exceptions'
+
+class SelectPdfApi
+	attr_accessor :config, :save_to, :url
+
+	API_URL = 'http://selectpdf.com/api'
+
+	# TODO: Refactor this...
+	DEFAULT_OPTIONS = {
+		config_file: "select-pdf-config.yml",
+		save_to: "document.pdf"
+	}
+
+	def initialize(user_opts={})
+		opts = DEFAULT_OPTIONS.merge user_opts
+
+		@url 		 = opts[:url]
+		@config  = opts[:config] || SelectPdfApi::YamlFileConfig.new(opts[:config_file])
+		@save_to = opts[:save_to]
+		@success = false
+	end
+
+	def download
+		raise SelectPdfApi::DownloadError, "A URL must be specified." if @url.nil?
+
+		request  = "#{API_URL}/?#{params}"
+		response = HTTParty.get request
+
+		if response.success?
+			File.open(@save_to, "wb") {|f| f.write response.parsed_response}
+			@success = true
+		else
+			raise SelectPdfApi::DownloadError, "There was an error with the following request #{request}"
+		end
+	end
+
+	def params
+		result = []
+		@config.options.sort.map { |name, value| result << "#{name}=#{value}" }
+		result << "url=#{@url}"
+		result.join('&')
+	end
+
+	def success?
+		@success
+	end
+
+end

data/select_pdf_api.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+require 'select_pdf_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "select_pdf_api"
+  spec.version       = SelectPdfApi::VERSION
+  spec.authors       = ["Arian Amador"]
+  spec.email         = ["arian@arianamador.com"]
+  spec.summary       = %q{Wrapper library for the Select PDF service.}
+  spec.description   = %q{Wrapper library for the Select PDF service. SelectPdf offers a REST API that can be used to convert html to pdf in any language with our dedicated web service.}
+  spec.homepage      = "https://www.github.com/arian-amador/select-pdf-api"
+  spec.licenses      = ["MIT"]
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.post_install_message = "PDF all the web of things!"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_development_dependency "vcr", '~> 2.9', '>= 2.9.3'
+  spec.add_development_dependency "webmock", '~> 1.20', '>= 1.20.4'
+  spec.add_development_dependency 'minitest', '~> 5.5', '>= 5.5.1'
+
+  spec.add_dependency "httparty", "~> 0.13.3"
+end

data/test/fixtures/all-config.yml

@@ -0,0 +1,9 @@
+key: "valid-key-123-67ad"
+page_size: "Letter"
+page_orientation: "Landscape"
+margin_right: "2pt"
+margin_bottom: "2pt"
+margin_left: "1.25pt"
+margin_left: "1.25pt"
+user_password: "user123"
+owner_password: "owner567"

data/test/fixtures/minimum-config.yml

@@ -0,0 +1 @@
+key: 'random-valid-api-123abc-345dbc'

data/test/minitest_helper.rb

@@ -0,0 +1,13 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+$:.unshift File.expand_path('../../config', __FILE__)
+require 'select_pdf_api'
+
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'vcr'
+
+VCR.configure do |c|
+	c.allow_http_connections_when_no_cassette = false
+  c.cassette_library_dir = "test/fixtures/vcr"
+  c.hook_into :webmock
+end

data/test/test_select_pdf_api/test_api.rb

@@ -0,0 +1,73 @@
+require './test/minitest_helper'
+
+# API test
+describe SelectPdfApi do
+	let(:valid_url) 	{'http://www.google.com'}
+	let(:invalid_url) { SelectPdfApi.new({url: 'invalid_url'}) }
+
+	let(:default_config_api) { SelectPdfApi.new({url: valid_url})}
+	let(:minimum_config_api) { SelectPdfApi.new({url: valid_url,
+		config_file: '../test/fixtures/minimum-config.yml'})}
+	let(:maximum_config_api) { SelectPdfApi.new({url: valid_url,
+			config_file: '../test/fixtures/all-config.yml'})}
+
+	def test_class_exists
+		assert default_config_api
+		default_config_api.must_be_instance_of SelectPdfApi
+	end
+
+	def test_save_to_should_be_changable
+		original_filename = "/tmp/test_file_1.tmp"
+		modified_filename = "/tmp/test_file_9.tmp"
+
+		new_select = SelectPdfApi.new({url: valid_url, save_to: original_filename})
+		new_select.save_to.must_equal original_filename
+		new_select.save_to = modified_filename
+		new_select.save_to.must_equal modified_filename
+	end
+
+	def test_url_should_be_changable
+		modified_url = "http://mail.yahoo.com"
+
+		default_config_api.url.must_equal valid_url
+		default_config_api.url = modified_url
+		default_config_api.url.must_equal modified_url
+	end
+
+	describe "#params" do
+		def test_params_exists
+			default_config_api.must_respond_to 'params'
+		end
+
+		def test_it_should_build_params_for_all_options
+			maximum_config_api.params.must_equal "key=valid-key-123-67ad&margin_bottom=2pt&margin_left=1.25pt&margin_right=2pt&owner_password=owner567&page_orientation=Landscape&page_size=Letter&user_password=user123&url=http://www.google.com"
+		end
+
+		def test_it_should_build_params_for_minimum_options
+			minimum_config_api.params.must_equal "key=random-valid-api-123abc-345dbc&url=http://www.google.com"
+		end
+	end
+
+	describe "#download" do
+		def test_download_exists
+			default_config_api.must_respond_to 'download'
+		end
+
+		def test_it_fails_without_a_url
+			-> {SelectPdfApi.new.download}.must_raise SelectPdfApi::DownloadError
+		end
+
+		def test_it_fails_with_an_invalid_url
+			VCR.use_cassette('download_with_invalid_url', :record => :new_episodes) do
+				-> {invalid_url.download}.must_raise SelectPdfApi::DownloadError
+			end
+		end
+
+		def test_it_downloads_a_pdf
+			VCR.use_cassette('download', :record => :new_episodes) do
+				default_config_api.download
+				default_config_api.success?
+			end
+		end
+	end
+end

data/test/test_select_pdf_api/test_yaml_file_config.rb

@@ -0,0 +1,39 @@
+require './test/minitest_helper'
+
+# Config test
+describe SelectPdfApi::YamlFileConfig do
+	let(:fixtures)			 {"../test/fixtures"}
+
+	let(:blank_config) 	 {SelectPdfApi::YamlFileConfig.new("#{fixtures}/blank-config.yml")}
+	let(:minimum_config) {SelectPdfApi::YamlFileConfig.new("#{fixtures}/minimum-config.yml")}
+	let(:maximum_config) {SelectPdfApi::YamlFileConfig.new("#{fixtures}/all-config.yml")}
+	let(:invalid_config) {SelectPdfApi::YamlFileConfig.new('invalid_config')}
+
+	def test_it_should_fail_with_an_invalid_config
+		-> {invalid_config}.must_raise SelectPdfApi::ConfigError
+	end
+
+	def test_it_should_fail_with_a_blank_config
+		-> {blank_config}.must_raise SelectPdfApi::ConfigError
+	end
+
+	def test_valid_options_for_minimium_config
+		result = {"key"=>"random-valid-api-123abc-345dbc"}
+		minimum_config.options.must_equal result
+	end
+
+	def test_valid_options_for_all_options_config
+		result = {"key"=>"valid-key-123-67ad", "page_size"=>"Letter", "page_orientation"=>"Landscape", "margin_right"=>"2pt", "margin_bottom"=>"2pt", "margin_left"=>"1.25pt", "user_password"=>"user123", "owner_password"=>"owner567"}
+		maximum_config.options.must_equal result
+	end
+
+	def test_it_loads_a_new_config
+		original = {"key"=>"random-valid-api-123abc-345dbc"}
+		modified = {"key"=>"valid-key-123-67ad", "page_size"=>"Letter", "page_orientation"=>"Landscape", "margin_right"=>"2pt", "margin_bottom"=>"2pt", "margin_left"=>"1.25pt", "user_password"=>"user123", "owner_password"=>"owner567"}
+
+		config = SelectPdfApi::YamlFileConfig.new("#{fixtures}/minimum-config.yml")
+		config.options.must_equal original
+		config.load_config("#{fixtures}/all-config.yml")
+		config.options.must_equal modified
+	end
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: select_pdf_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Arian Amador
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-15 00:00:00.000000000 Z
+dependencies:
+- !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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.20.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.20.4
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.5.1
+- !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
+description: Wrapper library for the Select PDF service. SelectPdf offers a REST API
+  that can be used to convert html to pdf in any language with our dedicated web service.
+email:
+- arian@arianamador.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/select_pdf_api.rb
+- lib/select_pdf_api/exceptions.rb
+- lib/select_pdf_api/version.rb
+- lib/select_pdf_api/yaml_file_config.rb
+- select_pdf_api.gemspec
+- test/fixtures/all-config.yml
+- test/fixtures/blank-config.yml
+- test/fixtures/minimum-config.yml
+- test/minitest_helper.rb
+- test/test_select_pdf_api/test_api.rb
+- test/test_select_pdf_api/test_yaml_file_config.rb
+homepage: https://www.github.com/arian-amador/select-pdf-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: PDF all the web of things!
+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.1
+signing_key: 
+specification_version: 4
+summary: Wrapper library for the Select PDF service.
+test_files:
+- test/fixtures/all-config.yml
+- test/fixtures/blank-config.yml
+- test/fixtures/minimum-config.yml
+- test/minitest_helper.rb
+- test/test_select_pdf_api/test_api.rb
+- test/test_select_pdf_api/test_yaml_file_config.rb