Skip to content

PDFCLOUD-5202 Add Ruby examples for pdfRest API integration - #105

Merged
datalogics-tsmith merged 7 commits into
pdfrest:mainfrom
datalogics-kam:pdfcloud-5202-initial-ruby-routes
Sep 4, 2025
Merged

datalogics-tsmith merged 7 commits into
pdfrest:mainfrom
datalogics-kam:pdfcloud-5202-initial-ruby-routes

Conversation

@datalogics-kam

Copy link
Copy Markdown
Contributor
  • Add JSON and Multipart payload examples demonstrating API usage.
  • Include .env.example and integrate dotenv for API key management.
  • Add .gitignore tailored for Ruby projects.
  • Introduce Gemfile and Gemfile.lock for dependency management.
  • Provide comprehensive documentation in README.md.

@datalogics-kam
datalogics-kam force-pushed the pdfcloud-5202-initial-ruby-routes branch from 64a2fa0 to 0410531 Compare September 2, 2025 21:36
@datalogics-kam
datalogics-kam marked this pull request as ready for review September 3, 2025 14:08
@datalogics-kam
datalogics-kam force-pushed the pdfcloud-5202-initial-ruby-routes branch from a173fc6 to 2ee6f71 Compare September 3, 2025 17:30
Comment thread Ruby/README.md Outdated
Comment thread Ruby/README.md Outdated
- Add JSON and Multipart payload examples demonstrating API usage.
- Include `.env.example` and integrate `dotenv` for API key management.
- Add `.gitignore` tailored for Ruby projects.
- Introduce `Gemfile` and `Gemfile.lock` for dependency management.
- Provide comprehensive documentation in `README.md`.
- Document project structure, coding conventions, and testing process.
- Provide instructions for setup, development, and sample execution.
- Include commit, PR guidelines, and security tips.
- Update `README.md` with details on optional EU API endpoint for GDPR compliance.
- Extend `.env.example` to include configurable `PDFREST_URL` for overriding the default API base URL.
- Refactor Ruby examples to dynamically use the base URL from environment variables.
Comment thread Ruby/.env.example
Comment thread Ruby/Complex Flow Examples/merge-different-file-types.rb
Comment thread Ruby/Endpoint Examples/JSON Payload/markdown.rb
Comment thread Ruby/Endpoint Examples/JSON Payload/rasterized-pdf.rb
Comment thread Ruby/Endpoint Examples/Multipart Payload/markdown.rb
Comment thread Ruby/Endpoint Examples/Multipart Payload/rasterized-pdf.rb
- Specify use of `ENV['PDFREST_URL']` for setting the API base URL (defaulting to `https://api.pdfrest.com`).
- Introduce `merge-different-file-types.rb` demonstrating file conversion and merging via pdfRest API.
- Leverage `.env` for API key and base URL configuration.
- Support various file types with content type detection and dynamic conversion to PDF.
- Updated README.md
- Standardize header comments across Ruby samples for clarity and consistency.
- Update `.env.example` with API key instructions and optional EU endpoint configuration.
- Enhance Ruby examples with detailed setup, usage, and output instructions.
- Revise `AGENTS.md` with audience and tone guidelines for sample development.
@datalogics-kam
datalogics-kam force-pushed the pdfcloud-5202-initial-ruby-routes branch from 2ee6f71 to fe0fd15 Compare September 3, 2025 20:41
- Included URL for detailed GDPR compliance info across Ruby examples, `AGENTS.md`, and `.env.example`.
- Enhanced comments to guide users on EU region API usage.
@datalogics-tsmith
datalogics-tsmith merged commit 0fd2bca into pdfrest:main Sep 4, 2025
1 check passed
@datalogics-kam
datalogics-kam deleted the pdfcloud-5202-initial-ruby-routes branch September 4, 2025 15:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants