adobe_doc_api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa70ac6119400a1d4e5f9f945b58d2c087221a6f94ce31f9a7e073450e021118
+  data.tar.gz: 1941e4e7f1c4ec3b57a504bb92be4c3faaa3d7c4f4148987458e422822ff69a5
+SHA512:
+  metadata.gz: 381363a1c7b89c72d42f7c3847b0857489b23428b768451f507259e49c2ad6bb0399a12e10e435a19f5c029347332ca21ccd7ca5ebc37741ecb32dde06dea704
+  data.tar.gz: 554a83e571dbe3d4844d250694c07cf8bfa0d545e290ed8e465c56c0f0a3df198ad94f1a6900a9fae5e43b681c344efb04e1ebd82cee168107234b1ca06003b3

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-12-28
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+christopher.sonnier[at]gmail.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in adobe_doc_api.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Chris Sonnier
+
+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,52 @@
+# AdobeDocApi
+
+This is still a work in progress. Use at your own risk.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'adobe_doc_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install adobe_doc_api
+
+## Required ENV variables
+```ruby
+ENV['adobe_org_id']
+ENV['adobe_tech_account_id']
+ENV['adobe_client_id']
+ENV['adobe_client_secret']
+```
+
+## Usage
+
+```ruby
+key_path = "../full_path_to/private.key"
+doc_path = "../full_path_to/disclosure.docx"
+destination = "../full_path_to_output/output.docx"
+json_data = { 'DocTag': 'Value', 'DocTag2': 'Value2'}
+client = AdobeDocApi::Client.new(private_key_path: key_path, destination_path: destination)
+client.submit(json: json_data, disclosure_file_path: doc_path)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, 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/c-sonnier/adobe_doc_api.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "adobe_doc_api"
+
+# 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
+
+require "irb"
+IRB.start(__FILE__)

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/adobe_doc_api/client.rb

@@ -0,0 +1,116 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'jwt'
+require 'openssl'
+
+module AdobeDocApi
+  class Client
+    JWT_URL = 'https://ims-na1.adobelogin.com/ims/exchange/jwt/'.freeze
+    API_ENDPOINT_URL = 'https://cpf-ue1.adobe.io'.freeze
+    attr_reader :access_token, :output_ext, :output_format, :poll_url, :content_request
+
+    def initialize(private_key_path:, destination_path:)
+      @destination_path = destination_path
+      @output_ext = File.extname(destination_path)
+      @output_format = @output_ext =~ /docx/ ? 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' : 'application/pdf'
+
+      jwt_payload = {
+        'iss' => ENV['adobe_org_id'],
+        'sub' => ENV['adobe_tech_account_id'],
+        'https://ims-na1.adobelogin.com/s/ent_documentcloud_sdk' => true,
+        'aud' => "https://ims-na1.adobelogin.com/c/#{ENV['adobe_client_id']}",
+        'exp' => (Time.now.utc + 500).to_i
+      }
+
+      rsa_private = OpenSSL::PKey::RSA.new File.read(private_key_path)
+      jwt_token = JWT.encode jwt_payload, rsa_private, 'RS256'
+
+      connection = Faraday.new do |conn|
+        conn.response :json, content_type: 'application/json'
+      end
+
+      response = connection.post JWT_URL do |req|
+        req.params['client_id'] = ENV['adobe_client_id']
+        req.params['client_secret'] = ENV['adobe_client_secret']
+        req.params['jwt_token'] = jwt_token
+      end
+
+      @access_token = response.body['access_token']
+
+    end
+
+    def submit(json:, disclosure_file_path:)
+      @content_request = {
+        "cpf:engine": {
+          "repo:assetId": 'urn:aaid:cpf:Service-52d5db6097ed436ebb96f13a4c7bf8fb'
+        },
+        "cpf:inputs": {
+          "documentIn": {
+            "dc:format": 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+            "cpf:location": 'InputFile0'
+          },
+          "params": {
+            "cpf:inline": {
+              "outputFormat": @output_ext.delete('.'),
+              "jsonDataForMerge": json
+            }
+          }
+        },
+        "cpf:outputs": {
+          "documentOut": {
+            "dc:format": @output_format.to_s,
+            "cpf:location": 'multipartLabel'
+          }
+        }
+      }.to_json
+
+      connection = Faraday.new API_ENDPOINT_URL do |conn|
+        conn.request :authorization, 'Bearer', @access_token
+        conn.headers['x-api-key'] = ENV['adobe_client_id']
+        conn.request :multipart
+        conn.request :url_encoded
+        conn.response :json, content_type: 'application/json'
+      end
+
+      payload = {'contentAnalyzerRequests' => content_request}
+      payload[:InputFile0] = Faraday::FilePart.new(disclosure_file_path, 'application/vnd.openxmlformats-officedocument.wordprocessingml.document')
+      res = connection.post('/ops/:create', payload)
+      @poll_url = res.headers['location']
+      poll_for_file(@poll_url)
+    end
+
+    def poll_for_file(url)
+      poll = Faraday.new do |conn|
+        conn.request :authorization, 'Bearer', @access_token
+        conn.headers['x-api-key'] = ENV['adobe_client_id']
+      end
+      counter = 0
+      loop do
+        sleep(6)
+        poll_response = poll.get(url)
+        counter += 1
+        if poll_response.body.include?('"cpf:status":{"completed":true,"type":"","status":200}')
+          write_to_file(poll_response)
+          break
+        end
+        break if counter > 10
+      rescue StandardError => e
+        # Here we can log if there is a failure from Adobe's response i.e. "Failed to complete"
+        raise(e)
+      end
+    end
+
+    def write_to_file(response)
+      temp_file = Tempfile.new([Time.now.to_i.to_s, @output_ext])
+      temp_file.write response.body
+      temp_file.rewind
+      # Read in the raw response and remove the
+      my_array = IO.readlines(temp_file.path)
+      my_array.pop
+      array = my_array.drop(9)
+      arry = array.join('')
+      File.open(@destination_path, 'wb') { |f| f.write arry.chomp}
+      temp_file.close!
+    end
+  end
+end

data/lib/adobe_doc_api/error.rb

@@ -0,0 +1,3 @@
+module AdobeDocApi
+  class Error < StandardError; end
+end

data/lib/adobe_doc_api/version.rb

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

data/lib/adobe_doc_api.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "adobe_doc_api/version"
+
+module AdobeDocApi
+  autoload :Client, "adobe_doc_api/client"
+  autoload :Error, "adobe_doc_api/error"
+
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: adobe_doc_api
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Chris Sonnier
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+description: Ruby interface for Adobe PDF Services API Document Generation
+email:
+- christopher.sonnier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/adobe_doc_api.rb
+- lib/adobe_doc_api/client.rb
+- lib/adobe_doc_api/error.rb
+- lib/adobe_doc_api/version.rb
+homepage: https://github.com/c-sonnier/adobe_doc_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/c-sonnier/adobe_doc_api
+  changelog_uri: https://github.com/c-sonnier/adobe_doc_api/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/c-sonnier/adobe_doc_api/issues
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: Ruby interface for Adobe PDF Services API Document Generation
+test_files: []