hpa-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ddf9c859a6954e4cbc841a602d51ac80f5fde86b
+  data.tar.gz: 1caec3d42ff90a113b2121a33e6d66a881440d89
+SHA512:
+  metadata.gz: 4303eb9d8d976f413bff2013ebed2fd5fe7912d4879618b999a87982909116e48fd1252e208aa4bf56485e04c091cd2d5c1f11e57b84d4148980dce8c2dde49d
+  data.tar.gz: dcc76bf2b84f769e942c85425b5328a21ac205421524652155f61717fb9b7354a754c1273b83a82a64807febdacd9bbe4dfbce9cf1899c76614eb82200f7fa8a

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Zoran Žabčić
+
+
+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,208 @@
+hpa-ruby
+=====
+
+This is a Ruby wrapper for [HTML PDF API](http://htmlpdfapi.com) - [Documentation](http://htmlpdfapi.com/documentation)
+
+HTML PDF API is a service that allows you to convert HTML to PDF using standard technologies (HTML, CSS and JavaScript).
+
+
+Installation
+=====
+
+### Rails
+
+Add this line to your application"s Gemfile:
+
+    gem "hpa-ruby", require: "hpa"
+
+And then execute:
+
+    $ bundle
+
+
+### Or install it yourself
+
+    $ gem install hpa-ruby
+
+
+Usage
+=====
+
+Require the Hpa gem
+
+    require "hpa"
+
+Then you have to set your API token:
+
+    Hpa.api_token = "<your token>"
+
+## Configuration
+
+Set API base (endpoint and version)
+
+    Hpa.api_base = "htmlpdfapi.com/api/v1" # default
+
+
+Assets
+-------
+
+### Get Assets List
+    
+    response = Hpa::Asset.get
+    assets = JSON.parse(response) 
+
+on success returns: 
+
+    response # json object
+    response.code # 200
+
+    JSON.parse(response) # [{"id":"53a99cc76d64be7c26b5e57b", "name":"hpa_logo.png", "mime":"image/png", "size":650}, {...}, {...}]
+
+
+### Create Asset
+
+    response = Hpa::Asset.create(:file => File.open("path/to/file.png"))
+
+on success returns: 
+
+    response # json object
+    response.code # 201
+
+    JSON.parse(response) # {"id":"53a99cc76d64be7c26b5e57b", "name":"hpa_logo.png", "mime":"image/png", "size":650}
+
+
+### Find Asset
+
+    response = Hpa::Asset.find(id)
+
+on success returns: 
+
+    response # file
+    response.code # 200
+
+
+### Delete Asset
+
+    response = Hpa::Asset.delete(id)
+
+on success returns: 
+
+    response # ""
+    response.code # 204
+
+
+Credits
+-------
+
+    response = Hpa::Credit.get
+
+on success returns: 
+
+    response # current number of credits
+    response.code # 200
+
+
+PDFs
+-------
+
+### Generate PDF
+
+From url:
+
+    response = Hpa::Pdf.create(:url => "http://htmlpdfapi.com/examples/example.html")
+
+From HTML string:
+
+    response = Hpa::Pdf.create(:html => "<h1>Generate PDF from HTML string</h1>")
+
+From HTML file:
+
+    response = Hpa::Pdf.create(:file => File.open("index.html"))
+
+From compressed file:
+
+    response = Hpa::Pdf.create(:file => File.open("sample.zip"))
+
+on success returns: 
+
+    response # file (PDF)
+    response.code # 200
+
+save it to a file
+
+    File.open("result.pdf", "w+") do |f|
+      f.write response
+    end
+
+
+Notice:
+
+    response == response.body
+    
+
+### Passing additional options 
+
+    Hpa::Pdf.create(
+      :file => File.open("index.html"),
+      :dpi => 150,
+      :margin_top => 20mm
+    )
+
+[Full options list](https://htmlpdfapi.com/documentation#pdf)
+
+Rails example
+=====
+
+Set your api token inside config/application.rb
+
+    module HpaExample
+      class Application < Rails::Application
+
+        Hpa.api_token = "<your token>"
+
+      end
+    end
+
+
+
+controllers/example_controller.rb
+
+    class ExampleController < ApplicationController
+
+      def show
+        respond_to do |format|
+          format.html { render(layout: "pdf") }
+
+          format.pdf do
+            pdf = Hpa::Pdf.create( 
+              html: render_to_string(layout: "pdf").to_str,
+              header: render_to_string(template: "example/header.erb", layout: "pdf").to_str,
+              footer: render_to_string(template: "example/footer.erb", layout: "pdf").to_str,
+              header_spacing: 10,
+              footer_spacing: 10,
+              engine_version: 12
+            )
+
+            send_data(pdf, filename: "hpa_rails_example.pdf", type: "application/pdf", disposition: "inline")
+          end
+
+        end
+      end
+
+    end
+
+
+[Sample Rails application](https://github.com/htmlpdfapi/hpa_rails_example)
+
+
+Testing
+-------
+    rake test api_token="<your token>"
+
+## Contributing
+
+1. Fork it ( https://github.com/htmlpdfapi/hpa-ruby/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 new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*_test.rb"
+end

data/hpa.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hpa/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hpa-ruby"
+  spec.version       = Hpa::VERSION
+  spec.authors       = ["Zoran Žabčić"]
+  spec.email         = ["zoran@effectiva.hr"]
+  spec.summary       = %q{HTML PDF API wrapper}
+  spec.description   = %q{HTML PDF API is a service that allows you to convert HTML to PDF using standard technologies (HTML, CSS and JavaScript).}
+  spec.homepage      = "https://github.com/htmlpdfapi/hpa-ruby"
+  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 "rest-client"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/lib/hpa/asset.rb

@@ -0,0 +1,21 @@
+module Hpa
+  class Asset
+
+    def self.get
+      Hpa.get(:assets)
+    end
+
+    def self.find(id)
+      Hpa.find(:assets, id)
+    end
+
+    def self.create(options={})
+      Hpa.create(:assets, options)
+    end
+
+    def self.delete(id)
+      Hpa.delete(:assets, id)
+    end
+
+  end
+end

data/lib/hpa/credit.rb

@@ -0,0 +1,9 @@
+module Hpa
+  class Credit
+
+    def self.get
+      Hpa.get(:credits)
+    end
+
+  end
+end

data/lib/hpa/errors/api_error.rb

@@ -0,0 +1,3 @@
+module Hpa
+  class ApiError < HpaError; end
+end

data/lib/hpa/errors/hpa_error.rb

@@ -0,0 +1,16 @@
+module Hpa
+  class HpaError < StandardError
+
+    attr_reader :status, :message
+
+    def initialize(status=nil, message=nil)
+      @status = status
+      @message = message
+    end
+
+    def to_s
+      [status, message].compact.join(" ")
+    end
+
+  end
+end

data/lib/hpa/pdf.rb

@@ -0,0 +1,9 @@
+module Hpa
+  class Pdf
+
+    def self.create(options={})
+      Hpa.create(:pdf, options)
+    end
+
+  end
+end

data/lib/hpa/version.rb

@@ -0,0 +1,5 @@
+module Hpa
+
+  VERSION = "0.0.1"
+
+end

data/lib/hpa.rb

@@ -0,0 +1,68 @@
+require "rest-client"
+
+# Version
+require "hpa/version"
+
+# Resources
+require "hpa/asset"
+require "hpa/credit"
+require "hpa/pdf"
+
+# Errors
+require "hpa/errors/hpa_error"
+require "hpa/errors/api_error"
+
+module Hpa
+
+  @@api_token = nil
+  @@api_base = "htmlpdfapi.com/api/v1"
+
+  def self.api_token
+    @@api_token
+  end
+
+  def self.api_token=(api_token)
+    @@api_token = api_token
+  end
+
+  def self.api_base
+    @@api_base
+  end
+
+  def self.api_base=(api_base)
+    @@api_base = api_base
+  end
+
+  def self.get(resource)
+    handle_api_error { RestClient.get(endpoint(resource), authentication) }
+  end
+
+  def self.find(resource, id)
+    handle_api_error { RestClient.get(endpoint(resource, id), authentication) }
+  end
+
+  def self.create(resource, options={})
+    handle_api_error { RestClient.post(endpoint(resource), options, authentication) }
+  end
+
+  def self.delete(resource, id)
+    handle_api_error { RestClient.delete(endpoint(resource, id), authentication) }
+  end
+
+  private
+
+    def self.authentication
+      {:authentication => ["Token", api_token].join(" ")}
+    end
+
+    def self.endpoint(resource, id=nil)
+      [api_base, resource, id].compact.join("/")
+    end
+
+    def self.handle_api_error
+      yield
+      rescue RestClient::Exception => e
+        raise ApiError.new(e.http_code, e.http_body)
+    end
+
+end

data/test/hpa_test.rb

@@ -0,0 +1,79 @@
+require 'test_helper'
+
+class HpaTest < MiniTest::Unit::TestCase
+
+
+  def setup 
+    # add 2 sec delay between tests
+    sleep 2
+  end
+
+
+  def test_get_assets
+    response = Hpa::Asset.get
+    assert_equal 200, response.code
+  end
+
+
+  def test_create_find_and_delete_asset
+    # first, check if asset named "hpa-4ff6375e12f1.png" 
+    # already exists and delete it 
+    assets = JSON.parse(Hpa::Asset.get.body)
+    asset = assets.detect { |a| a["name"] == "hpa-4ff6375e12f1.png"}
+    Hpa::Asset.delete(asset["id"]) if asset
+
+    # create asset
+    sleep 1
+    image = File.open(fixtures_path("hpa-4ff6375e12f1.png"))
+    response = Hpa::Asset.create(:file => image)
+    assert_equal 201, response.code
+
+    asset = JSON.parse(response.body)
+
+    # find asset
+    sleep 1
+    response = Hpa::Asset.find(asset["id"])
+    assert_equal 200, response.code
+
+    # delete asset
+    sleep 1
+    response = Hpa::Asset.delete(asset["id"])
+    assert_equal 204, response.code
+    assert_empty response.body
+  end
+
+
+  def test_get_credits
+    response = Hpa::Credit.get
+
+    assert_equal 200, response.code
+    assert_match  /\d+/, response.body
+  end
+
+
+  def test_create_pdf_from_string
+    response = Hpa::Pdf.create(:html => "<h1>Title</h1>")
+
+    assert_equal 200, response.code
+    assert_equal "%PDF", response.body[0, 4]
+  end
+
+
+  def test_create_pdf_from_url
+    response = Hpa::Pdf.create(:url => "http://htmlpdfapi.com/examples/example.html")
+
+    assert_equal 200, response.code
+    assert_equal "%PDF", response.body[0, 4]
+  end
+
+
+  def test_create_pdf_from_file
+    file = File.open(fixtures_path("compressed_file.zip"))
+    response = Hpa::Pdf.create(:file => file)
+
+    assert_equal 200, response.code
+    assert_equal "%PDF", response.body[0, 4]
+  end
+
+
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require 'hpa'
+require 'minitest/unit'
+require 'minitest/autorun'
+require 'minitest/pride'
+
+
+class MiniTest::Unit::TestCase
+
+  Hpa.api_token = ENV['api_token']
+  Hpa.api_base = ENV['api_base'] if ENV['api_base']
+
+  def fixtures_path(filename)
+    File.join(File.dirname(__FILE__), "fixtures", filename)
+  end
+  
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: hpa-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Zoran Žabčić
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: HTML PDF API is a service that allows you to convert HTML to PDF using
+  standard technologies (HTML, CSS and JavaScript).
+email:
+- zoran@effectiva.hr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- hpa.gemspec
+- lib/hpa.rb
+- lib/hpa/asset.rb
+- lib/hpa/credit.rb
+- lib/hpa/errors/api_error.rb
+- lib/hpa/errors/hpa_error.rb
+- lib/hpa/pdf.rb
+- lib/hpa/version.rb
+- test/fixtures/compressed_file.zip
+- test/fixtures/hpa-4ff6375e12f1.png
+- test/hpa_test.rb
+- test/test_helper.rb
+homepage: https://github.com/htmlpdfapi/hpa-ruby
+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.2.2
+signing_key: 
+specification_version: 4
+summary: HTML PDF API wrapper
+test_files:
+- test/fixtures/compressed_file.zip
+- test/fixtures/hpa-4ff6375e12f1.png
+- test/hpa_test.rb
+- test/test_helper.rb