Merge pull request #71 from aspose-pdf-cloud/develop

update to 24.3

Author: kaferi

README.md

@@ -29,8 +29,7 @@ XLS, XLSX, PPTX, DOC, DOCX, MobiXML, JPEG, EMF, PNG, BMP, GIF, TIFF, Text
 ## Read PDF Formats
 MHT, PCL, PS, XSLFO, MD
 
-## Enhancements in Version 24.2
-- Memory leak when converting PDF to DOCX.
+## Enhancements in Version 24.3
 - A new version of Aspose.PDF Cloud was prepared using the latest version of Aspose.PDF for .NET.
 
 ## Installation
@@ -46,15 +45,15 @@ gem build aspose_pdf_cloud.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./aspose_pdf_cloud-24.2.0.gem
+gem install ./aspose_pdf_cloud-24.3.0.gem
 ```
-(for development, run `gem install --dev ./aspose_pdf_cloud-24.2.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./aspose_pdf_cloud-24.3.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'aspose_pdf_cloud', '~> 24.2.0'
+    gem 'aspose_pdf_cloud', '~> 24.3.0'
 
 ### Install from Git
 
@@ -67,19 +66,19 @@ Add the following in the Gemfile:
 
 ```ruby
     # Get your ClientId and ClientSecret from https://dashboard.aspose.cloud (free registration required).
+    @pdf_api = PdfApi.new('MY_CLIENT_ID', 'MY_CLIENT_SECRET')    
+    file_name = 'PdfWithAnnotations.pdf'
+    page_number = 2
+    opts = {
+      :folder => 'tempFolder'
+    }
+    response = @pdf_api.get_page_annotations(file_name, page_number, opts)
+```
 
-    AsposePdfCloud.configure do |config|
-            config.client_data['ClientId'] = 'MY_CLIENT_ID'
-            config.client_data['ClientSecret'] = 'MY_CLIENT_SECRET'
-            config.host = host
-    
-	file_name = 'PdfWithAnnotations.pdf'
-	page_number = 2
-	opts = {
-	  :folder => 'tempFolder'
-	}
-
-	response = @pdf_api.get_page_annotations(file_name, page_number, opts)
+## SelfHost Aspose.PDF Cloud
+Create **PdfApi** object without **app_key** and **app_sid** parameters, but with **host** parameter set to *url of SelfHost Aspose.PDF Cloud* and **self_host** parameter set to *true*:
+```ruby
+    @pdf_api = PdfApi.new('', '', 'MY_SELFHOST_URL', true)
 ```
 
 ## Unit Tests

lib/aspose_pdf_cloud/api/pdf_api.rb

@@ -25,10 +25,18 @@ module AsposePdfCloud
   class PdfApi
     attr_accessor :api_client
 
-    def initialize(app_key, app_sid, api_client = ApiClient.default)
+    def initialize(app_key, app_sid, host = "", self_host = false, api_client = ApiClient.default)
       @api_client = api_client
+      @api_client.config.self_host = self_host
       @api_client.config.app_key = app_key
       @api_client.config.app_sid = app_sid
+      if host != ""
+        if @api_client.config.self_host
+          @api_client.config.self_host_url = host
+        else
+          @api_client.config.host = host
+        end
+      end
     end
 
 

lib/aspose_pdf_cloud/api_client.rb

@@ -107,7 +107,9 @@ def build_request(http_method, path, opts = {})
       form_params = opts[:form_params] || {}
       body = opts[:body] || {}
 
-      update_params_for_auth! header_params, query_params, opts[:auth_names]
+      if !@config.self_host
+        update_params_for_auth! header_params, query_params, opts[:auth_names]
+      end
 
       req_opts = {
         :method => http_method,
@@ -124,11 +126,12 @@ def build_request(http_method, path, opts = {})
         end
       end
 
-      # OAuth 2.0
       req_opts[:params] = opts[:query_params]
 
-      add_o_auth_token(req_opts)
-
+      if !@config.self_host
+        # OAuth 2.0
+        add_o_auth_token(req_opts)
+      end
 
       conn = Faraday.new url, {:params => query_params, :headers => header_params} do |f|
       f.request :multipart
@@ -411,6 +414,9 @@ def build_collection_param(param, collection_format)
 
     # Request access and refresh tokens if needed
     def request_token_if_needed
+      if @config.self_host
+        return
+      end
       # check token exists
       if @config.access_token
         return

lib/aspose_pdf_cloud/configuration.rb

@@ -24,6 +24,12 @@
 module AsposePdfCloud
   class Configuration
 
+    # SelfHost
+    attr_accessor :self_host
+
+    # SelfHost URL
+    attr_accessor :self_host_url
+
     # App Key
     attr_accessor :app_key
 
@@ -152,7 +158,11 @@ def host=(host)
     end
 
     def base_url
-      url = "#{scheme}://#{[host, '/v3.0'].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+      if @self_host
+        url = self_host_url
+      else
+        url = "#{scheme}://#{[host, '/v3.0'].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+      end
       URI.encode(url)
     end
 

lib/aspose_pdf_cloud/version.rb

@@ -20,5 +20,5 @@
 =end
 
 module AsposePdfCloud
-  VERSION = "24.2.0"
+  VERSION = "24.3.0"
 end

test/pdf_tests.rb

@@ -32,10 +32,13 @@ class PdfTests < Minitest::Test
   def setup
     servercreds_json = File.read('../../../Settings/servercreds.json')
     creds = JSON.parse(servercreds_json)
-    @pdf_api = PdfApi.new(creds["AppKey"], creds["AppSID"])
+    self_host = creds.has_key?("SelfHost") ? creds["SelfHost"] : false
+    app_key = creds.has_key?("AppKey") ? creds["AppKey"] : ""
+    app_sid = creds.has_key?("AppSID") ? creds["AppSID"] : ""
+    product_uri = creds.has_key?("ProductUri") ? creds["ProductUri"] : ""
+    @pdf_api = PdfApi.new(app_key, app_sid, product_uri, self_host)
     @temp_folder = 'TempPdfCloud'
     @test_data_folder = '../test_data/'
-
     config = @pdf_api.api_client.config
     config.scheme = 'https'
   end