pdfserve_client 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 55f08ddb2b267ba05ac6c1fcb49c2506cab4b762811eb4edd1fea0e421b3459f
+  data.tar.gz: 998567a407fecc32c6f30c594049c9be7f3dbb3d88fcecc15c5b7096195d0aec
+SHA512:
+  metadata.gz: 831380373c2db34056b9a2b7021cc871fc3a9779a6fbe76b2bb6c82ecf5c1c3a6a3801611bcfa97433e40dcad6c9760e550493b5ce3b94e00ffc3fd0897d3348
+  data.tar.gz: 44da7b08a931dd2c721b2fa9b0320f3a44a641117c70435a505966dfa797e94c768f863ed24219ea8bfb1548442d91d1ac8b3dd642e4413eb55e658d110916e8

data/README.md

@@ -0,0 +1,110 @@
+# PdfserveClient
+
+PdfserveClient is a gem to merge, stamp or split PDF files using the service https://github.com/ant31/pdfserve.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pdfserve_client', '~> 2.0'
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+## Usage
+
+### PDFServe Client
+
+```ruby
+require 'pdfserve_client'
+
+file_urls = [
+  'https://s3-public.de/file1.pdf',
+  'https://s3-public.de/file2.pdf'
+]
+output_path = './output.pdf'
+
+client = PdfserveClient::Client.new(api_endpoint: 'https://your.custom.endpoint')
+client.merge(file_urls:, output_path:)
+```
+
+or with a token
+
+```ruby
+
+require 'pdfserve_client'
+
+file_urls = [
+  'https://s3-public.de/file1.pdf',
+  'https://s3-public.de/file2.pdf'
+]
+output_path = './output.pdf'
+
+client = PdfserveClient::Client.new(api_endpoint: 'https://your.custom.endpoint', api_token: 'the-token')
+client.merge(file_urls:, output_path:)
+```
+
+`file_urls` needs to be an array of urls (images or pdfs) that need to be merged and in the order how you want to merge it
+`output_path` it can be a tmp file in the machine that makes the call
+
+
+### PDF Stamp
+
+```ruby
+require 'pdfserve_client'
+
+file_url = 'https://s3-public.de/file1.pdf'
+stamp_text = 'A1'
+
+client = PdfserveClient::Client.new(api_endpoint: 'https://your.custom.endpoint')
+client.stamp(file_url:, stamp_text:)
+```
+
+or with a token
+
+```ruby
+
+require 'pdfserve_client'
+
+file_url = 'https://s3-public.de/file1.pdf'
+stamp_text = 'A1'
+
+client = PdfserveClient::Client.new(api_endpoint: 'https://your.custom.endpoint', api_token: 'the-token')
+client.stamp(file_url:, stamp_text:)
+```
+
+`file_url` needs to be the url (image or pdf) that need to be stamped
+`stamp_text` it needs to be the text you want to add at the top right of the file
+
+### PDF Split
+
+```ruby
+require 'pdfserve_client'
+
+file_url = 'https://s3-public.de/file1.pdf'
+pages = '1-3,4,6-8'
+
+client = PdfserveClient::Client.new(api_endpoint: 'https://your.custom.endpoint')
+client.split(file_url:, pages:)
+```
+
+or with a token
+
+```ruby
+
+require 'pdfserve_client'
+
+file_url = 'https://s3-public.de/file1.pdf'
+pages = '1-3,4,6-8'
+
+client = PdfserveClient::Client.new(api_endpoint: 'https://your.custom.endpoint', api_token: 'the-token')
+client.split(file_url:, pages:)
+```
+
+`file_url` needs to be the url ( pdf) that need to be splitted
+`pages` it needs to be comma separated page(s) range for splitting file into those pages.

data/lib/pdfserve_client/client.rb

@@ -0,0 +1,40 @@
+require_relative "merge"
+require_relative "stamp"
+require_relative "split"
+
+module PdfserveClient
+  class Client
+    attr_reader :merge_service, :stamp_service, :split_service
+
+    def initialize(api_endpoint:, api_token:)
+      @api_endpoint = api_endpoint
+      @api_token = api_token
+    end
+
+    def merge(file_urls:, output_path:)
+      merge_service.merge(file_urls, output_path)
+    end
+
+    def stamp(file_url:, stamp_text:)
+      stamp_service.call(file_url, stamp_text)
+    end
+
+    def split(file_url:, pages:)
+      split_service.split(file_url:, pages:)
+    end
+
+    private
+
+    def merge_service
+      PdfserveClient::Merge.new(api_endpoint: @api_endpoint, api_token: @api_token)
+    end
+
+    def stamp_service
+      PdfserveClient::Stamp.new(api_endpoint: @api_endpoint, api_token: @api_token)
+    end
+
+    def split_service
+      PdfserveClient::Split.new(api_endpoint: @api_endpoint, api_token: @api_token)
+    end
+  end
+end

data/lib/pdfserve_client/merge.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "version"
+require "net/http"
+require "uri"
+require "json"
+
+module PdfserveClient
+  class Error < StandardError; end
+
+  class Merge
+    PATH = "/api/v1/pdf/merge"
+
+    def initialize(api_endpoint:, api_token: nil)
+      @api_endpoint = api_endpoint + PATH
+      @api_token = api_token
+    end
+
+    def merge(file_urls, output_path)
+      uri = URI(api_endpoint)
+      request = Net::HTTP::Post.new(uri)
+      request["token"] = api_token unless api_token.nil?
+      form_data = file_urls.map { |url| ["files", url] }
+
+      request.set_form form_data, "multipart/form-data"
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
+        http.request(request)
+      end
+
+      if response.is_a?(Net::HTTPSuccess)
+        File.open(output_path, "wb") { |file| file.write(response.body) }
+        puts "Success!"
+        OpenStruct.new(success: true, errors: "")
+      else
+        puts "Failed!"
+        OpenStruct.new(success: false, errors: response.message)
+      end
+    end
+
+    private
+
+    attr_reader :api_endpoint, :api_token
+  end
+end

data/lib/pdfserve_client/split.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative "version"
+require "net/http"
+require "uri"
+require "json"
+
+module PdfserveClient
+  class Error < StandardError; end
+
+  class Split
+    PATH = "/api/v1/pdf/split"
+
+    def initialize(api_endpoint:, api_token: nil)
+      @api_endpoint = api_endpoint + PATH
+      @api_token = api_token
+    end
+
+    def split(file_url:, pages:)
+      uri = URI(api_endpoint)
+      uri.query = URI.encode_www_form({ pages: pages })
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      request = Net::HTTP::Post.new(uri.request_uri)
+
+      request["token"] = api_token unless api_token.nil?
+      form_data = [["splitfile", file_url]]
+
+      request.set_form form_data, "multipart/form-data"
+
+      response = http.request(request)
+
+      if response.is_a?(Net::HTTPSuccess)
+        puts "Successful split!"
+        content_disposition = response.header["Content-Disposition"]
+        filename = content_disposition[/filename="?([^"]+)"?/, 1] || "archive.tar.gz"
+
+        OpenStruct.new(
+          success: true, response: response.read_body, filename: filename, errors: ""
+        )
+      else
+        puts "Failed!"
+        OpenStruct.new(
+          success: false, response: response.body, errors: response.message
+        )
+      end
+    end
+
+    private
+
+    attr_reader :api_endpoint, :api_token
+  end
+end

data/lib/pdfserve_client/stamp.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative "version"
+require "net/http"
+require "uri"
+require "json"
+
+module PdfserveClient
+  class Error < StandardError; end
+
+  class Stamp
+    PATH = "/api/v1/pdf/stamp"
+
+    def initialize(api_endpoint:, api_token: nil)
+      @api_endpoint = api_endpoint + PATH
+      @api_token = api_token
+    end
+
+    def call(file_url, stamp_text)
+      uri = URI(api_endpoint)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      request = Net::HTTP::Post.new(uri.request_uri)
+
+      request["token"] = api_token unless api_token.nil?
+      form_data = [
+        ["files", file_url],
+        ["stamp_text", { "text" => stamp_text, "color" => "0,0,0", "position_name" => "tr", "over" => "true" }.to_json]
+      ]
+
+      request.set_form form_data, "multipart/form-data"
+
+      response = http.request(request)
+
+      if response.is_a?(Net::HTTPSuccess)
+        puts "Successful stamp!"
+        OpenStruct.new(
+          success: true, response: response.body, errors: ""
+        )
+      else
+        puts "Failed!"
+        OpenStruct.new(
+          success: false, response: response.body, errors: response.message
+        )
+      end
+    end
+
+    private
+
+    attr_reader :api_endpoint, :api_token
+  end
+end

data/lib/pdfserve_client/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PdfserveClient
+  VERSION = "2.0.0"
+end

data/lib/pdfserve_client.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "pdfserve_client/client"

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: pdfserve_client
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Isabel Garcia
+- Antoine Legrand
+- Lakhan Pasari
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: This gem provides a simple interface to merge, stamp, split PDFs using
+  https://github.com/ant31/pdfserve API.
+email:
+- isabel.garcia@conny.legal
+- antoine.legrand@conny.legal
+- lakhan.pasari@conny.legal
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/pdfserve_client.rb
+- lib/pdfserve_client/client.rb
+- lib/pdfserve_client/merge.rb
+- lib/pdfserve_client/split.rb
+- lib/pdfserve_client/stamp.rb
+- lib/pdfserve_client/version.rb
+homepage: https://github.com/mietright/pdf_merger
+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.5.23
+signing_key:
+specification_version: 4
+summary: A gem for merging, stamping, and splitting PDFs using an external API
+test_files: []