pdfactory-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 73371827231fdcbb93c0b9d4df2d57f798bc86a59accfb5ad3cde403e6aa897f
+  data.tar.gz: 8ecbbcba0c773b6f5a281396408619cc723a1840440edc67a6781adcdb7aa3e5
+SHA512:
+  metadata.gz: 52f044f559f0efde19901815c813229ebed2867a37fd08bce5cb64a9d2adab509c7b89d8ad4ba921fe5ff15826692f0d74f6f1ff3cf2629e088862e3e647df9c
+  data.tar.gz: d27f05d6782e6a3b149f3a4c7c5d22f3ec95c0fcbecd16014e3382aa83d2f7a62790b82ff10932dacedf676d41d5acaabaef1fa6037cb44f4e8b4725fecd5901

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pdfactory-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Daniel Cruz Horts
+
+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,73 @@
+# PDFactory::Client
+
+This gem is a convenient Ruby client to interact with PDFactory, the [microservice](https://github.com/dncrht/pdfactory) that generates PDFs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pdfactory-client'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install pdfactory-client
+```
+
+## Usage
+
+Ensure you have an up and running PDFactory server. Please refer to [its documentation](https://github.com/dncrht/pdfactory).
+
+Depending how your server is configured, there'll be different ways to use this client. Examples:
+
+```ruby
+# Specify URL, user and password to access a protected server
+client = PDFactory::Client.new(url: 'http://localhost:5000/', user: 'user', password: 'password')
+
+# Specify URL only, to access an open server
+client = PDFactory::Client.new(url: 'http://localhost:5000/')
+
+# Read URL, user and password from ENV vars
+ENV['PDFACTORY_URL'] = 'http://localhost:5000/'
+ENV['PDFACTORY_USER'] = 'user'
+ENV['PDFACTORY_PASSWORD'] = 'password'
+client = PDFactory::Client.new
+
+# Override URL, user and/or password (eg: user)
+client = PDFactory::Client.new(user: 'l33t')
+```
+
+Convert the HTML document:
+
+```ruby
+html = '<b>kk</b>'
+pdf = client.html2pdf(html)
+```
+
+PDF is a binary string that you can stream through your webapp or even save to disk:
+
+```ruby
+File.write('my.pdf', pdf)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` or `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dncrht/pdfactory-client.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pdfactory/client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pdfactory/client/version.rb

@@ -0,0 +1,3 @@
+module PDFactory
+  VERSION = '0.1.0'
+end

data/lib/pdfactory/client.rb

@@ -0,0 +1,55 @@
+require "pdfactory/client/version"
+require 'base64'
+require 'faraday'
+
+module PDFactory
+  class Client
+    class ArgumentError < StandardError; end
+
+    def initialize(url: ENV['PDFACTORY_URL'], user: ENV['PDFACTORY_USER'], password: ENV['PDFACTORY_PASSWORD'])
+      url or raise ArgumentError.new('Service URL not set')
+      if blank?(user) && blank?(password)
+        # Allowed for open servers (eg: local)
+      else
+        user or raise ArgumentError.new('User must be set')
+        password or raise ArgumentError.new('Password must be set')
+      end
+
+      @url = url
+      @user = user
+      @password = password
+    end
+
+    def html2pdf(html)
+      pdf = call_api('/pdf', { html: html })
+      return unless pdf
+
+      Base64.decode64(pdf)
+    end
+
+    private
+
+    def call_api(endpoint, body, http_method = :post)
+      response = connection.send(http_method) do |response|
+        response.url(endpoint)
+        response.body = URI.encode_www_form(body)
+      end
+
+      if response.success?
+        response.body
+      else
+        nil
+      end
+    end
+
+    def connection
+      @connection ||= Faraday.new(@url) do |connection|
+        connection.basic_auth @user, @password
+      end
+    end
+
+    def blank?(value)
+      value.nil? || value.empty?
+    end
+  end
+end

data/pdfactory-client.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pdfactory/client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pdfactory-client"
+  spec.version       = PDFactory::VERSION
+  spec.authors       = ['Daniel Cruz Horts']
+
+  spec.summary       = %q{Ruby client for PDFactory.}
+  spec.homepage      = 'https://github.com/dncrht/pdfactory-client'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: pdfactory-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Cruz Horts
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-byebug
+  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: 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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: webmock
+  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: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pdfactory/client.rb
+- lib/pdfactory/client/version.rb
+- pdfactory-client.gemspec
+homepage: https://github.com/dncrht/pdfactory-client
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby client for PDFactory.
+test_files: []