adobe_doc_api 0.1.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e5a77582f1fc5d80a10d049be384c0abf2dbe2b4206522128e536a8787517de
-  data.tar.gz: 5373eb84624217386db5663be8b8c829dcd9b98128a5a634c9467185ce3e6f3d
+  metadata.gz: 561ccbe710cbc9856655dc3d4235846dc2c55bacbc6d44794cc76282846b87b1
+  data.tar.gz: 7df931d666bb7cd7007b7c870504b996a77103e80a09ba5e97c21e9b96f8e8c8
 SHA512:
-  metadata.gz: 9b0b0dd6eff1e19d986ef5e52e0b2409b88ecba9bac484948ed7366a485b062f94c7c11f81160735f714e08c5a24a38b6baca8cbebd15148c9562e8b360f7fdc
-  data.tar.gz: aa00f4f6446199a46dab1b0101cbc3acd71ab44692375b83695e7062eccacab12b549298528a80f45e9c80b46ddc42217339a36d7d612aa91c39c3e86070d71c
+  metadata.gz: cc3925566f5027e07062cfd437d65898df2e688d33b39b6977bdf1d9954688e1d8677cb72d81b1ff4142082c022d258590166499380e37572af147da9c12cf85
+  data.tar.gz: 8500d15211572b7377e7e2710ca0d6c926555df58e3980972561f6b3843f483381d1d2fe70e69487c8f2edbe71a1953a8372b6f4eed38f872742871577dd9cb3

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-## [Unreleased]
+## [0.2.1] - 2023-06-20
+- Updates to Adobe PDF Services API
+- Removed JWT token authentication
+
+## [0.1.4] - 2021-12-30
+- Fix issue with parsing file boundary that included \r\n
 
 ## [0.1.3] - 2021-12-30
 - Added ability to configure AdobeDocApi to provide better customization

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    adobe_doc_api (0.2.0)
+      faraday (~> 1.8)
+      faraday_middleware (~> 1.2)
+      jwt (~> 2.3.0)
+      openssl (~> 2.2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (1.10.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    ipaddr (1.2.5)
+    jwt (2.3.0)
+    minitest (5.15.0)
+    multipart-post (2.3.0)
+    openssl (2.2.3)
+      ipaddr
+    rake (13.0.6)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-linux
+
+DEPENDENCIES
+  adobe_doc_api!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.2.32

data/README.md

@@ -1,6 +1,6 @@
 # AdobeDocApi
 
-This is still a work in progress. Use at your own risk.
+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
 
@@ -18,35 +18,46 @@ Or install it yourself as:
 
     $ gem install adobe_doc_api
 
-## Configuration 
-* Configuration can be overridden if you need by passing the values to AdobeDocApi::Client.new
+## Configuration
 ```ruby
 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
+    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+
+```ruby
+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
 
 ```ruby
-key_path = "../full_path_to/private.key"
 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
-
-# Without configuration you must pass these values
-# client = AdobeDocApi::Client.new(private_key: key_path, client_id: ENV['adobe_client_id'], client_secret: ENV['adobe_client_secret']org_id: ENV['adobe_org_id'], tech_account_id: ENV['adobe_tech_account_id'], access_token: nil)
-
 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
+```ruby
+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
 - [x] Add multipart parsing to improve saving the file from the response
 - [ ] Add documentation

data/lib/adobe_doc_api/client.rb

@@ -24,78 +24,85 @@ module AdobeDocApi
     end
 
     def get_access_token(private_key)
-      jwt_payload = {
-        "iss" => @org_id,
-        "sub" => @tech_account_id,
-        "https://ims-na1.adobelogin.com/s/ent_documentcloud_sdk" => true,
-        "aud" => "https://ims-na1.adobelogin.com/c/#{@client_id}",
-        "exp" => (Time.now.utc + 60).to_i
-      }
-
-      rsa_private = OpenSSL::PKey::RSA.new File.read(private_key)
-
-      jwt_token = JWT.encode jwt_payload, rsa_private, "RS256"
-
+      # TODO: JWT token deprecated and will stop working Jan 1, 2024.
+      # jwt_payload = {
+      #   "iss" => @org_id,
+      #   "sub" => @tech_account_id,
+      #   "https://ims-na1.adobelogin.com/s/ent_documentcloud_sdk" => true,
+      #   "aud" => "https://ims-na1.adobelogin.com/c/#{@client_id}",
+      #   "exp" => (Time.now.utc + 60).to_i
+      # }
+      #
+      # rsa_private = OpenSSL::PKey::RSA.new File.read(private_key)
+      #
+      # 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|
+      # response = connection.post JWT_URL do |req|
+      #   req.params["client_id"] = @client_id
+      #   req.params["client_secret"] = @client_secret
+      #   req.params["jwt_token"] = jwt_token
+      # end
+      scopes = "openid, DCAPI, AdobeID"
+
+      response = connection.post "https://ims-na1.adobelogin.com/ims/token/v3" do |req|
         req.params["client_id"] = @client_id
-        req.params["client_secret"] = @client_secret
-        req.params["jwt_token"] = jwt_token
+        req.body = "client_secret=#{@client_secret}&grant_type=client_credentials&scope=#{scopes}"
       end
-
       return response.body["access_token"]
     end
 
+    def get_asset_id
+      # Create new asset ID to get upload pre-signed Uri
+      connection = Faraday.new do |conn|
+        conn.request :authorization, "Bearer", @access_token
+        conn.headers["x-api-key"] = @client_id
+        conn.headers["Content-Type"] = ""
+        conn.response :json, content_type: "application/json"
+      end
+      response = connection.post "https://pdf-services.adobe.io/assets" do |req|
+        req.body = {mediaType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document"}.to_json
+        req.headers["Content-Type"] = "application/json"
+      end
+      # Return pre-signed uploadUri and assedID
+      return response.body["assetID"], response.body["uploadUri"]
+    end
+
     def submit(json:, template:, output:)
-      @output = output
-      output_format = /docx/.match?(File.extname(@output)) ? "application/vnd.openxmlformats-officedocument.wordprocessingml.document" : "application/pdf"
+      asset_id, upload_uri = get_asset_id
 
+      # Upload template to asset created earlier.
+      response = Faraday.put upload_uri do |req|
+        req.headers["Content-Type"] = "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
+        req.body = File.binread(template)
+      end
+      raise("Failed to upload template.") if response.status.to_i != 200
+
+      # Post JSON Data for Merge to documentGeneration
       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: File.extname(@output).delete("."),
-              jsonDataForMerge: json
-            }
-          }
-        },
-        "cpf:outputs": {
-          documentOut: {
-            "dc:format": output_format.to_s,
-            "cpf:location": "multipartLabel"
-          }
-        }
+        assetID: asset_id,
+        outputFormat: File.extname(output).delete("."),
+        jsonDataForMerge: json
       }.to_json
-
-      connection = Faraday.new API_ENDPOINT_URL do |conn|
+      payload = content_request
+      connection = Faraday.new do |conn|
         conn.request :authorization, "Bearer", @access_token
         conn.headers["x-api-key"] = @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(template, "application/vnd.openxmlformats-officedocument.wordprocessingml.document")
-      res = connection.post("/ops/:create", payload)
-      status_code = res.body["cpf:status"]["status"].to_i
-      @location_url = res.headers["location"]
-      raise Error.new(status_code: status_code, msg: res.body["cpf:status"]) unless status_code == 202
-      poll_for_file(@location_url)
+      res = connection.post "https://pdf-services-ue1.adobe.io/operation/documentgeneration" do |req|
+        req.body = payload
+        req.headers["Content-Type"] = "application/json"
+      end
+      # TODO need to check status of response
+      # Begin polling for status of file
+      poll_for_file(res.headers["location"], output)
     end
 
     private
 
-    def poll_for_file(url)
+    def poll_for_file(url, output)
       connection = Faraday.new do |conn|
         conn.request :authorization, "Bearer", @access_token
         conn.headers["x-api-key"] = @client_id
@@ -105,11 +112,11 @@ module AdobeDocApi
         sleep(6)
         response = connection.get(url)
         counter += 1
-        if response.body.include?('"cpf:status":{"completed":true,"type":"","status":200}')
-          @raw_response = response
-          return write_to_file(response.body)
+        if JSON.parse(response.body)["status"] == "done"
+          file_response = Faraday.get JSON.parse(response.body)["asset"]["downloadUri"]
+          return true if File.open(output, "wb") { |f| f.write file_response.body}
         else
-          status = JSON.parse(response.body)["cpf:status"]
+          status = JSON.parse(response.body)["status"]
           raise Error.new(status_code: status["status"], msg: status) if status["status"] != 202
         end
         break if counter > 10
@@ -119,21 +126,5 @@ module AdobeDocApi
       end
     end
 
-    def write_to_file(response_body)
-      line_index = []
-      lines = response_body.split("\r\n")
-      lines.each_with_index do |line, i|
-        next if line.include?("--Boundary_") || line.match?(/^Content-(Type|Disposition):/) || line.empty? || JSON.parse(line.force_encoding("UTF-8").to_s)
-      rescue
-        line_index << i
-      end
-      if line_index.length == 1
-        File.open(@output, "wb") { |f| f.write lines.at(line_index[0])}
-        true
-      else
-        false
-      end
-    end
-
   end
 end

data/lib/adobe_doc_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adobe_doc_api
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.1
 platform: ruby
 authors:
 - Chris Sonnier
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-30 00:00:00.000000000 Z
+date: 2023-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -76,6 +76,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile