slidize_cloud 24.9.0 → 24.10.0

data/spec/api_client_spec.rb

@@ -0,0 +1,240 @@
+=begin
+/**
+ * --------------------------------------------------------------------------------------------------------------------
+ * <copyright company="Smallize">
+ *   Copyright (c) 2024 Slidize for Cloud
+ * </copyright>
+ * <summary>
+ *   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.
+ * </summary>
+ * --------------------------------------------------------------------------------------------------------------------
+ */
+=end
+
+require 'spec_helper'
+
+describe SlidizeCloud::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          SlidizeCloud.configure { |c| c.host = 'http://example.com' }
+          expect(SlidizeCloud::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          SlidizeCloud.configure { |c| c.host = 'https://wookiee.com' }
+          expect(SlidizeCloud::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          SlidizeCloud.configure { |c| c.host = 'hobo.com/v4' }
+          expect(SlidizeCloud::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          SlidizeCloud.configure { |c| c.base_path = 'v4/dog' }
+          expect(SlidizeCloud::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          SlidizeCloud.configure { |c| c.base_path = '/v4/dog' }
+          expect(SlidizeCloud::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          SlidizeCloud.configure { |c| c.base_path = nil }
+          expect(SlidizeCloud::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+
+  describe 'proxy in #build_connection' do
+    let(:config) { SlidizeCloud::Configuration.new }
+    let(:api_client) { SlidizeCloud::ApiClient.new(config) }
+    let(:proxy_uri) { URI('http://example.org:8080') }
+
+    it 'defaults to nil' do
+      expect(SlidizeCloud::Configuration.default.proxy).to be_nil
+      expect(config.proxy).to be_nil
+
+      connection = api_client.build_connection
+      expect(connection.proxy_for_request('/test')).to be_nil
+    end
+
+    it 'can be customized with a string' do
+      config.proxy = proxy_uri.to_s
+
+      connection = api_client.build_connection
+      configured_proxy = connection.proxy_for_request('/test')
+
+      expect(configured_proxy).not_to be_nil
+      expect(configured_proxy.uri.to_s).to eq proxy_uri.to_s
+    end
+
+    it 'can be customized with a hash' do
+      config.proxy = { uri: proxy_uri }
+
+      connection = api_client.build_connection
+      configured_proxy = connection.proxy_for_request('/test')
+
+      expect(configured_proxy).not_to be_nil
+      expect(configured_proxy.uri).to eq proxy_uri
+    end
+  end
+
+  describe '#deserialize' do
+    it "handles Array<Integer>" do
+      api_client = SlidizeCloud::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[12, 34]')
+      data = api_client.deserialize(response, 'Array<Integer>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([12, 34])
+    end
+
+    it 'handles Array<Array<Integer>>' do
+      api_client = SlidizeCloud::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[[12, 34], [56]]')
+      data = api_client.deserialize(response, 'Array<Array<Integer>>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([[12, 34], [56]])
+    end
+
+    it 'handles Hash<String, String>' do
+      api_client = SlidizeCloud::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '{"message": "Hello"}')
+      data = api_client.deserialize(response, 'Hash<String, String>')
+      expect(data).to be_instance_of(Hash)
+      expect(data).to eq(:message => 'Hello')
+    end
+  end
+
+  describe "#object_to_hash" do
+    it 'ignores nils and includes empty arrays' do
+      # uncomment below to test object_to_hash for model
+      # api_client = SlidizeCloud::ApiClient.new
+      # _model = SlidizeCloud::ModelName.new
+      # update the model attribute below
+      # _model.id = 1
+      # update the expected value (hash) below
+      # expected = {id: 1, name: '', tags: []}
+      # expect(api_client.object_to_hash(_model)).to eq(expected)
+    end
+  end
+
+  describe '#build_collection_param' do
+    let(:param) { ['aa', 'bb', 'cc'] }
+    let(:api_client) { SlidizeCloud::ApiClient.new }
+
+    it 'works for csv' do
+      expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
+    end
+
+    it 'works for ssv' do
+      expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
+    end
+
+    it 'works for tsv' do
+      expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
+    end
+
+    it 'works for pipes' do
+      expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
+    end
+
+    it 'works for multi' do
+      expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
+    end
+
+    it 'fails for invalid collection format' do
+      expect { api_client.build_collection_param(param, :INVALID) }.to raise_error(RuntimeError, 'unknown collection format: :INVALID')
+    end
+  end
+
+  describe '#json_mime?' do
+    let(:api_client) { SlidizeCloud::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.json_mime?(nil)).to eq false
+      expect(api_client.json_mime?('')).to eq false
+
+      expect(api_client.json_mime?('application/json')).to eq true
+      expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true
+      expect(api_client.json_mime?('APPLICATION/JSON')).to eq true
+
+      expect(api_client.json_mime?('application/xml')).to eq false
+      expect(api_client.json_mime?('text/plain')).to eq false
+      expect(api_client.json_mime?('application/jsonp')).to eq false
+    end
+  end
+
+  describe '#select_header_accept' do
+    let(:api_client) { SlidizeCloud::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_accept(nil)).to be_nil
+      expect(api_client.select_header_accept([])).to be_nil
+
+      expect(api_client.select_header_accept(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+
+      expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml')
+    end
+  end
+
+  describe '#select_header_content_type' do
+    let(:api_client) { SlidizeCloud::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_content_type(nil)).to be_nil
+      expect(api_client.select_header_content_type([])).to be_nil
+
+      expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+      expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain')
+    end
+  end
+
+  describe '#sanitize_filename' do
+    let(:api_client) { SlidizeCloud::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.sanitize_filename('sun')).to eq('sun')
+      expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,99 @@
+=begin
+/**
+ * --------------------------------------------------------------------------------------------------------------------
+ * <copyright company="Smallize">
+ *   Copyright (c) 2024 Slidize for Cloud
+ * </copyright>
+ * <summary>
+ *   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.
+ * </summary>
+ * --------------------------------------------------------------------------------------------------------------------
+ */
+=end
+
+require 'spec_helper'
+
+describe SlidizeCloud::Configuration do
+  let(:config) { SlidizeCloud::Configuration.default }
+
+  before(:each) do
+    # uncomment below to setup host and base_path
+    # require 'URI'
+    # uri = URI.parse("https://api.slidize.cloud/v1.0/slides")
+    # SlidizeCloud.configure do |c|
+    #   c.host = uri.host
+    #   c.base_path = uri.path
+    # end
+  end
+
+  describe '#base_url' do
+    it 'should have the default value' do
+      # uncomment below to test default value of the base path
+      # expect(config.base_url).to eq("https://api.slidize.cloud/v1.0/slides")
+    end
+
+    it 'should remove trailing slashes' do
+      [nil, '', '/', '//'].each do |base_path|
+        config.base_path = base_path
+        # uncomment below to test trailing slashes
+        # expect(config.base_url).to eq("https://api.slidize.cloud/v1.0/slides")
+      end
+    end
+  end
+
+  describe '#configure_faraday_connection' do
+    let(:faraday_connection) { Faraday::Connection.new }
+
+    before do
+      stub_const('CustomAdapter', Class.new(Faraday::Adapter))
+      stub_const('AnotherCustomAdapter', Class.new(Faraday::Adapter))
+
+      config.configure_faraday_connection do |conn|
+        conn.adapter CustomAdapter
+        conn.response :logger, nil, headers: true, bodies: true, log_level: :debug do |logger|
+          logger.filter(/(Authorization: )(.*)/, '\1[REDACTED]')
+        end
+      end
+    end
+
+    it 'adds a block that will be used to configure the connection' do
+      expect(faraday_connection.adapter).to eq(Faraday::Adapter::NetHttp)
+      expect(faraday_connection.builder.handlers).to_not include(Faraday::Response::Logger)
+
+      config.configure_connection(faraday_connection)
+
+      expect(faraday_connection.adapter).to eq(CustomAdapter)
+      expect(faraday_connection.builder.handlers).to include(Faraday::Response::Logger)
+    end
+
+    it 'supports multiple configuration blocks' do
+      config.configure_faraday_connection do |conn|
+        conn.adapter AnotherCustomAdapter
+      end
+
+      expect(faraday_connection.adapter).to eq(Faraday::Adapter::NetHttp)
+      expect(faraday_connection.builder.handlers).to_not include(Faraday::Response::Logger)
+
+      config.configure_connection(faraday_connection)
+
+      expect(faraday_connection.adapter).to eq(AnotherCustomAdapter)
+      expect(faraday_connection.builder.handlers).to include(Faraday::Response::Logger)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,128 @@
+=begin
+/**
+ * --------------------------------------------------------------------------------------------------------------------
+ * <copyright company="Smallize">
+ *   Copyright (c) 2024 Slidize for Cloud
+ * </copyright>
+ * <summary>
+ *   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.
+ * </summary>
+ * --------------------------------------------------------------------------------------------------------------------
+ */
+=end
+
+# load the gem
+require 'slidize_cloud'
+
+# The following  was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slidize_cloud
 version: !ruby/object:Gem::Version
-  version: 24.9.0
+  version: 24.10.0
 platform: ruby
 authors:
 - Slidize.Cloud Team
@@ -70,7 +70,45 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- TestData/macros.pptm
+- TestData/master.pptx
+- TestData/protected.pptx
+- TestData/test.pptx
+- TestData/watermark.png
+- git_push.sh
+- lib/slidize_cloud.rb
+- lib/slidize_cloud/api/slidize_api.rb
+- lib/slidize_cloud/api_client.rb
+- lib/slidize_cloud/api_error.rb
+- lib/slidize_cloud/configuration.rb
+- lib/slidize_cloud/models/convert_request.rb
+- lib/slidize_cloud/models/convert_to_video_request.rb
+- lib/slidize_cloud/models/export_format.rb
+- lib/slidize_cloud/models/image_watermark_options.rb
+- lib/slidize_cloud/models/image_watermark_request.rb
+- lib/slidize_cloud/models/merge_options.rb
+- lib/slidize_cloud/models/merge_request.rb
+- lib/slidize_cloud/models/protect_request.rb
+- lib/slidize_cloud/models/protection_options.rb
+- lib/slidize_cloud/models/replace_text_options.rb
+- lib/slidize_cloud/models/replace_text_request.rb
+- lib/slidize_cloud/models/split_options.rb
+- lib/slidize_cloud/models/split_request.rb
+- lib/slidize_cloud/models/text_watermark_options.rb
+- lib/slidize_cloud/models/text_watermark_request.rb
+- lib/slidize_cloud/models/unprotect_request.rb
+- lib/slidize_cloud/models/video_options.rb
+- lib/slidize_cloud/models/video_resolution_type.rb
+- lib/slidize_cloud/models/video_transition_type.rb
+- lib/slidize_cloud/version.rb
+- slidize_cloud.gemspec
+- spec/api_client_spec.rb
+- spec/configuration_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/slidize-cloud/slidize-cloud-ruby
 licenses:
 - MIT
@@ -94,4 +132,7 @@ rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Slidize.Cloud Web API References Ruby Gem
-test_files: []
+test_files:
+- spec/api_client_spec.rb
+- spec/configuration_spec.rb
+- spec/spec_helper.rb