adobe_doc_api 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d1e60f6687db22347aa8a8d772e066716ff6b9c9d5d9065ab0395543ab8808e
-  data.tar.gz: 40f43095bb7fb02dd9a8724941c823c3870965a40b313f9e580e9d919dc13def
+  metadata.gz: 4e5a77582f1fc5d80a10d049be384c0abf2dbe2b4206522128e536a8787517de
+  data.tar.gz: 5373eb84624217386db5663be8b8c829dcd9b98128a5a634c9467185ce3e6f3d
 SHA512:
-  metadata.gz: d47936fe2d22f56b0268c1e60019847a45b63ff35c5dac178e43fe5e597e68ccb9c3be16c293101410ccdc94dc9b4522c891852792d84a42bcd67c3b32a44288
-  data.tar.gz: 2c479317760c7ae45aa6dfd31ac6606cf71e7db98107cd9e1bbd308e19a017816aed99441420492ff400959f24fc4386285b26834c481872cc285f11f3f39b18
+  metadata.gz: 9b0b0dd6eff1e19d986ef5e52e0b2409b88ecba9bac484948ed7366a485b062f94c7c11f81160735f714e08c5a24a38b6baca8cbebd15148c9562e8b360f7fdc
+  data.tar.gz: aa00f4f6446199a46dab1b0101cbc3acd71ab44692375b83695e7062eccacab12b549298528a80f45e9c80b46ddc42217339a36d7d612aa91c39c3e86070d71c

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## [Unreleased]
 
+## [0.1.3] - 2021-12-30
+- Added ability to configure AdobeDocApi to provide better customization
+
 ## [0.1.0] - 2021-12-28
 
 - Initial release

data/README.md

@@ -18,13 +18,16 @@ Or install it yourself as:
 
     $ gem install adobe_doc_api
 
-## Recommended ENV variables 
-*Client.new will fallback to use these variables if they are not passed in setup
+## Configuration 
+* Configuration can be overridden if you need by passing the values to AdobeDocApi::Client.new
 ```ruby
-ENV['adobe_org_id']
-ENV['adobe_tech_account_id']
-ENV['adobe_client_id']
-ENV['adobe_client_secret']
+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
 ```
 
 ## Usage
@@ -35,11 +38,13 @@ 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(private_key: key_path)
-# Without ENV variables set
+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
 ```
 
 ## Todo

data/lib/adobe_doc_api/client.rb

@@ -10,16 +10,17 @@ module AdobeDocApi
 
     attr_reader :access_token, :location_url, :raw_response, :client_id, :client_secret, :org_id, :tech_account_id
 
-    def initialize(private_key:, 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)
+    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
-      @client_id = client_id
-      @client_secret = client_secret
-      @org_id = org_id
-      @tech_account_id = tech_account_id
+      @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
       @location_url = nil
       @output_file_path = nil
       @raw_response = nil
-      @access_token = access_token || get_access_token(private_key)
+      @access_token = access_token || get_access_token(@private_key_path)
     end
 
     def get_access_token(private_key)
@@ -45,7 +46,6 @@ module AdobeDocApi
       end
 
       return response.body["access_token"]
-
     end
 
     def submit(json:, template:, output:)

data/lib/adobe_doc_api/configuration.rb

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

data/lib/adobe_doc_api/version.rb

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

data/lib/adobe_doc_api.rb

@@ -1,10 +1,26 @@
 # frozen_string_literal: true
 
 require_relative "adobe_doc_api/version"
+require "adobe_doc_api/configuration"
 
 module AdobeDocApi
   autoload :Client, "adobe_doc_api/client"
   autoload :Error, "adobe_doc_api/error"
 
-  # Your code goes here...
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adobe_doc_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Chris Sonnier
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-29 00:00:00.000000000 Z
+date: 2021-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -83,6 +83,7 @@ files:
 - bin/setup
 - lib/adobe_doc_api.rb
 - lib/adobe_doc_api/client.rb
+- lib/adobe_doc_api/configuration.rb
 - lib/adobe_doc_api/error.rb
 - lib/adobe_doc_api/version.rb
 homepage: https://github.com/c-sonnier/adobe_doc_api