AdobeDocApi
This is still a work in progress and breaking changes may be made, but I will do my best to update the README when features have been changed.
Installation
Add this line to your application's Gemfile:
gem 'adobe_doc_api'
And then execute:
$ bundle install
Or install it yourself as:
$ gem install adobe_doc_api
Configuration
AdobeDocApi.configure do |config|
config.client_id = nil
config.client_secret = nil
config.org_id = nil
config.tech_account_id = nil
config.private_key_path = nil
end
Recommended configuration if using Rails 6+
AdobeDocApi.configure do |config|
config.client_id = Rails.application.credentials.dig(:adobe_doc, :client_id)
config.client_secret = Rails.application.credentials.dig(:adobe_doc, :client_secret)
config.org_id = Rails.application.credentials.dig(:adobe_doc, :org_id)
config.tech_account_id = Rails.application.credentials.dig(:adobe_doc, :tech_account_id)
config.private_key_path = Rails.application.credentials.dig(:adobe_doc, :private_key_path)
end
Usage
template_path = "../full_path_to/disclosure.docx"
output_path = "../full_path_to_output/output.docx"
json_data = { 'DocTag': 'Value', 'DocTag2': 'Value2'}
client = AdobeDocApi::Client.new
client.submit(json: json_data, template: template_path, output: output_path)
# returns true or false if file was saved to output_path
Usage without configuration
client = AdobeDocApi::Client.new(private_key: key_path,
client_id: adobe_client_id,
client_secret: adobe_client_secret,
org_id: adobe_org_id,
tech_account_id: adobe_tech_account_id,
access_token: nil)
Todo
- Add multipart parsing to improve saving the file from the response
- Add documentation
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
License
The gem is available as open source under the terms of the MIT License.