adobe_doc_api 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 561ccbe710cbc9856655dc3d4235846dc2c55bacbc6d44794cc76282846b87b1
-  data.tar.gz: 7df931d666bb7cd7007b7c870504b996a77103e80a09ba5e97c21e9b96f8e8c8
+  metadata.gz: 88a17a7824cbc56df0cc3b1a4fe8ce43e51ac80d2f49c8aeb2bf3bd3d3afc4b6
+  data.tar.gz: 4ab99d5fd436027b5a8dfa58610969ec6955cd592474e55ac0285def3c4f62ce
 SHA512:
-  metadata.gz: cc3925566f5027e07062cfd437d65898df2e688d33b39b6977bdf1d9954688e1d8677cb72d81b1ff4142082c022d258590166499380e37572af147da9c12cf85
-  data.tar.gz: 8500d15211572b7377e7e2710ca0d6c926555df58e3980972561f6b3843f483381d1d2fe70e69487c8f2edbe71a1953a8372b6f4eed38f872742871577dd9cb3
+  metadata.gz: a0298bd962026cc2c072239d0a8dda4fbca883b94389f40daa5efc843a2256b239a52bb3c21b4900c3098338b10f78e47d22c52745527b1df739ea80c46bcd3e
+  data.tar.gz: e8c44532b30fe23d98076fa67f5ce0b49d9def18f5593142fbed19f75410025d5461d7f87604a48f07f0b1a458f19b4f64283b49bfb77f666b288ba2ae6e5122

data/CHANGELOG.md

@@ -1,6 +1,9 @@
+## [0.3.0] - 2023-06-20
+- Migrated authentication from JWT to OAuth server-to-server
+- Updated configuration to accept OAuth scopes
+
 ## [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

data/README.md

@@ -23,9 +23,7 @@ Or install it yourself as:
 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.scopes = nil
 end
 ```
 ### Recommended configuration if using Rails 6+
@@ -33,9 +31,7 @@ end
 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)
+    config.scopes = Rails.application.credentials.dig(:adobe_doc, :scopes)
 end
 ```
 ## Usage
@@ -51,16 +47,10 @@ client.submit(json: json_data, template: template_path, output: 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)
+client = AdobeDocApi::Client.new(client_id: adobe_client_id,
+                                 client_secret: adobe_client_secret,
+                                 scopes: adobe_scopes)
 ```
-## Todo
-- [x] Add multipart parsing to improve saving the file from the response
-- [ ] Add documentation
 
 ## Contributing
 

data/lib/adobe_doc_api/client.rb

@@ -1,130 +1,176 @@
-require "faraday"
-require "faraday_middleware"
-require "jwt"
-require "openssl"
+require "net/http"
+require "json"
 
 module AdobeDocApi
   class Client
-    JWT_URL = "https://ims-na1.adobelogin.com/ims/exchange/jwt/".freeze
-    API_ENDPOINT_URL = "https://cpf-ue1.adobe.io".freeze
+    OAUTH_URL = "https://ims-na1.adobelogin.com/ims/token/v3".freeze
+    API_ENDPOINT_URL = "https://pdf-services-ue1.adobe.io/operation/documentgeneration"
+    attr_reader :location_url, :raw_response, :client_id, :client_secret, :scopes
 
-    attr_reader :access_token, :location_url, :raw_response, :client_id, :client_secret, :org_id, :tech_account_id
-
-    def initialize(private_key: nil, client_id: nil, client_secret: nil, org_id: nil, tech_account_id: nil, access_token: nil)
-      # TODO Need to validate if any params are missing and return error
+    def initialize(client_id: nil, client_secret: nil, scopes: nil)
       @client_id = client_id || AdobeDocApi.configuration.client_id
       @client_secret = client_secret || AdobeDocApi.configuration.client_secret
-      @org_id = org_id || AdobeDocApi.configuration.org_id
-      @tech_account_id = tech_account_id || AdobeDocApi.configuration.tech_account_id
-      @private_key_path = private_key || AdobeDocApi.configuration.private_key_path
+      @scopes = scopes || AdobeDocApi.configuration.scopes
       @location_url = nil
       @output_file_path = nil
       @raw_response = nil
-      @access_token = access_token || get_access_token(@private_key_path)
+      @access_token = get_access_token
     end
 
-    def get_access_token(private_key)
-      # 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|
-      #   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.body = "client_secret=#{@client_secret}&grant_type=client_credentials&scope=#{scopes}"
-      end
-      return response.body["access_token"]
+    def submit(json:, template:, output:)
+      @output = output
+      @asset_id, upload_uri = upload_presigned_uri
+      upload_asset(upload_uri, template: template)
+      document_generation(json: json)
     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"
+    private
+
+    def get_access_token
+      url = URI(OAUTH_URL)
+      https = Net::HTTP.new(url.host, url.port)
+      https.use_ssl = true
+      request = Net::HTTP::Post.new(url)
+      request["Content-Type"] = "application/x-www-form-urlencoded"
+      request.body = "grant_type=client_credentials&client_id=#{@client_id}&client_secret=#{@client_secret}&scope=#{@scopes}"
+      response = https.request(request)
+      if response.code.to_i != 200
+        raise Error.new(status_code: response.code, msg: "Failed to get access token: #{response.body}")
+      else
+        puts "Access token retrieved successfully"
+        JSON.parse(response.body)["access_token"]
       end
-      # Return pre-signed uploadUri and assedID
-      return response.body["assetID"], response.body["uploadUri"]
     end
 
-    def submit(json:, template:, output:)
-      asset_id, upload_uri = get_asset_id
+    def upload_presigned_uri
 
-      # 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
+      url = URI("https://pdf-services-ue1.adobe.io/assets")
+      https = Net::HTTP.new(url.host, url.port)
+      https.use_ssl = true
+      request = Net::HTTP::Post.new(url)
+      request["Content-Type"] = "application/json"
+      request["X-API-Key"] = @client_id
+      request["Authorization"] = "bearer #{@access_token}"
+      request.body ='{"mediaType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document"}'
+      response = https.request(request)
 
-      # Post JSON Data for Merge to documentGeneration
-      content_request = {
-        assetID: asset_id,
-        outputFormat: File.extname(output).delete("."),
-        jsonDataForMerge: json
-      }.to_json
-      payload = content_request
-      connection = Faraday.new do |conn|
-        conn.request :authorization, "Bearer", @access_token
-        conn.headers["x-api-key"] = @client_id
+      if response.code.to_i != 200
+        raise Error.new(status_code: response.code, msg: "Failed to create asset: #{response.body}")
+      else
+        puts "Asset created successfully"
+        response_body = JSON.parse(response.body)
+        asset_id = response_body["assetID"]
+        upload_uri = response_body["uploadUri"]
+        return asset_id, upload_uri
       end
-      res = connection.post "https://pdf-services-ue1.adobe.io/operation/documentgeneration" do |req|
-        req.body = payload
-        req.headers["Content-Type"] = "application/json"
+
+    end
+
+    def upload_asset(upload_uri, template:)
+
+      # Upload the template to the presigned URI
+      url = URI(upload_uri)
+      https = Net::HTTP.new(url.host, url.port)
+      https.use_ssl = true
+      request = Net::HTTP::Put.new(url)
+      request["Content-Type"] = "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
+      request.body = File.read(template)
+      response = https.request(request)
+      if response.code.to_i != 200
+        raise Error.new(status_code: response.code, msg: "Failed to upload template: #{response.body}")
+      else
+        puts "Template uploaded successfully"
       end
-      # TODO need to check status of response
-      # Begin polling for status of file
-      poll_for_file(res.headers["location"], output)
+
     end
 
-    private
+    def document_generation(json:)
+      # Document Generation
+      url = URI("https://pdf-services-ue1.adobe.io/operation/documentgeneration")
+      https = Net::HTTP.new(url.host, url.port)
+      https.use_ssl = true
+      request = Net::HTTP::Post.new(url)
+      request["Content-Type"] = "application/json"
+      request["X-API-Key"] = @client_id
+      request["Authorization"] = "Bearer #{@access_token}"
 
-    def poll_for_file(url, output)
-      connection = Faraday.new do |conn|
-        conn.request :authorization, "Bearer", @access_token
-        conn.headers["x-api-key"] = @client_id
+      request.body = {"assetID": @asset_id,
+                      "outputFormat": "docx",
+                      "jsonDataForMerge": json
+      }.to_json
+
+      response = https.request(request)
+
+      if response.code.to_i != 201
+        raise Error.new(status_code: response.code, msg: "Failed to submit document generation request: #{response.body}")
+      else
+        status_url = response.header["location"]
+        puts "Document Generation submitted successfully"
       end
-      counter = 0
+
+      # Start polling for the status of the document generation
+      poll_status(status_url)
+    end
+
+    def poll_status(status_url, timeout: 30)
+      # Poll for the generated document
+      download_uri = nil
       loop do
-        sleep(6)
-        response = connection.get(url)
-        counter += 1
-        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}
+        timeout -= 1
+        break if timeout <= 0
+
+        # Wait for 5 seconds before checking the status
+        url = URI(status_url)
+        https = Net::HTTP.new(url.host, url.port)
+        https.use_ssl = true
+        request = Net::HTTP::Get.new(url)
+        request["Content-Type"] = "application/json"
+        request["X-API-Key"] = @client_id
+        request["Authorization"] = "Bearer #{@access_token}"
+        response = https.request(request)
+
+        if response.code.to_i != 200
+          raise Error.new(status_code: response.code, msg: "Failed to check document generation status: #{response.body}")
+        end
+
+        response_body = JSON.parse(response.body)
+        puts "Current status: #{response_body['status']}"
+        if response_body["status"] == "done"
+          download_uri = response_body["asset"]["downloadUri"]
+          break
+        elsif response_body["status"] == "failed"
+          raise Error.new(status_code: response.code, msg: "Document generation failed: #{response.body}")
         else
-          status = JSON.parse(response.body)["status"]
-          raise Error.new(status_code: status["status"], msg: status) if status["status"] != 202
+          puts "Document generation in progress..."
         end
-        break if counter > 10
-      rescue => e
-        # Raise other exceptions
-        raise(e)
+        sleep 1
+      end
+
+      # If the download URI is available, proceed to download the document
+      if download_uri
+        download_output(download_uri: download_uri)
+      else
+        raise Error.new(status_code: response.code, msg: "Document generation not completed: #{response.body}")
       end
+
     end
 
+    def download_output(download_uri:)
+      # Finally, download the generated document
+      url = URI(download_uri)
+      https = Net::HTTP.new(url.host, url.port)
+      https.use_ssl = true
+      request = Net::HTTP::Get.new(url)
+      response = https.request(request)
+      if response.code.to_i != 200
+        raise Error.new(status_code: response.code, msg: "Failed to download document: #{response.body}")
+      else
+        if File.open(@output, "wb") { |f| f.write response.body }
+          puts "Document saved successfully to #{@output}"
+          return true
+        end
+      end
+    end
   end
+
 end

data/lib/adobe_doc_api/configuration.rb

@@ -1,13 +1,11 @@
 module AdobeDocApi
   class Configuration
-    attr_accessor :client_id, :client_secret, :org_id, :tech_account_id, :private_key_path
+    attr_accessor :client_id, :client_secret, :scopes
 
     def initialize
       @client_id = nil
-      @client_sercret = nil
-      @org_id = nil
-      @tech_account_id = nil
-      @private_key_path = nil
+      @client_secret = nil
+      @scopes = nil
     end
   end
 end

data/lib/adobe_doc_api/version.rb

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

metadata

@@ -1,71 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: adobe_doc_api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Sonnier
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-20 00:00:00.000000000 Z
+date: 2025-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.0'
   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
+        version: '2.0'
 description: Ruby interface for Adobe PDF Services API Document Generation
 email:
 - christopher.sonnier@gmail.com
@@ -76,7 +34,6 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -102,14 +59,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Ruby interface for Adobe PDF Services API Document Generation

data/Gemfile.lock

@@ -1,57 +0,0 @@
-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