pki_express 1.3.0 → 1.3.2

data/lib/pki_express.rb

@@ -1,70 +1,70 @@
-require_relative 'pki_express/pki_express_config'
-require_relative 'pki_express/pki_express_operator'
-require_relative 'pki_express/enum'
-require_relative 'pki_express/pk_algorithms'
-require_relative 'pki_express/base_signer'
-require_relative 'pki_express/signature_starter'
-require_relative 'pki_express/signature_explorer'
-require_relative 'pki_express/signer'
-require_relative 'pki_express/auth_complete_result'
-require_relative 'pki_express/auth_start_result'
-require_relative 'pki_express/authentication'
-require_relative 'pki_express/cades_signature'
-require_relative 'pki_express/cades_signature_starter'
-require_relative 'pki_express/check_service_result'
-require_relative 'pki_express/command_error'
-require_relative 'pki_express/commands'
-require_relative 'pki_express/digest_algorithm'
-require_relative 'pki_express/digest_algorithm_and_value'
-require_relative 'pki_express/discovery_service_result'
-require_relative 'pki_express/error_codes'
-require_relative 'pki_express/installation_not_found_error'
-require_relative 'pki_express/oids'
-require_relative 'pki_express/name'
-require_relative 'pki_express/pades_certification_level'
-require_relative 'pki_express/pades_horizontal_align'
-require_relative 'pki_express/pades_measurement_units'
-require_relative 'pki_express/pades_page_optimization'
-require_relative 'pki_express/pades_page_optimization'
-require_relative 'pki_express/pades_paper_size'
-require_relative 'pki_express/pades_signature'
-require_relative 'pki_express/pades_signature_explorer'
-require_relative 'pki_express/pades_signature_starter'
-require_relative 'pki_express/pades_signer'
-require_relative 'pki_express/pades_signer_info'
-require_relative 'pki_express/pades_size'
-require_relative 'pki_express/pades_text_horizontal_align'
-require_relative 'pki_express/pades_vertical_align'
-require_relative 'pki_express/pades_visual_positioning'
-require_relative 'pki_express/pades_visual_auto_positioning'
-require_relative 'pki_express/pades_visual_image'
-require_relative 'pki_express/pades_visual_manual_positioning'
-require_relative 'pki_express/pades_visual_rectangle'
-require_relative 'pki_express/pades_visual_representation'
-require_relative 'pki_express/pades_visual_text'
-require_relative 'pki_express/pk_certificate'
-require_relative 'pki_express/pki_brazil_certificate_fields'
-require_relative 'pki_express/pki_brazil_certificate_types'
-require_relative 'pki_express/pki_italy_certificate_fields'
-require_relative 'pki_express/pki_italy_certificate_types'
-require_relative 'pki_express/signature_algorithm_and_value'
-require_relative 'pki_express/signature_finisher'
-require_relative 'pki_express/signature_policy_identifier'
-require_relative 'pki_express/signature_start_result'
-require_relative 'pki_express/standard_signature_policies'
-require_relative 'pki_express/timestamp_authority'
-require_relative 'pki_express/trust_service_auth_parameters'
-require_relative 'pki_express/trust_service_info'
-require_relative 'pki_express/trust_service_manager'
-require_relative 'pki_express/trust_service_session_result'
-require_relative 'pki_express/trust_service_session_types'
-require_relative 'pki_express/tsa_authentication_type'
-require_relative 'pki_express/validation_error'
-require_relative 'pki_express/validation_item'
-require_relative 'pki_express/validation_item_types'
-require_relative 'pki_express/validation_results'
-require_relative 'pki_express/version'
-require_relative 'pki_express/version_manager'
-
-module PkiExpress
+require_relative 'pki_express/pki_express_config'
+require_relative 'pki_express/pki_express_operator'
+require_relative 'pki_express/enum'
+require_relative 'pki_express/pk_algorithms'
+require_relative 'pki_express/base_signer'
+require_relative 'pki_express/signature_starter'
+require_relative 'pki_express/signature_explorer'
+require_relative 'pki_express/signer'
+require_relative 'pki_express/auth_complete_result'
+require_relative 'pki_express/auth_start_result'
+require_relative 'pki_express/authentication'
+require_relative 'pki_express/cades_signature'
+require_relative 'pki_express/cades_signature_starter'
+require_relative 'pki_express/check_service_result'
+require_relative 'pki_express/command_error'
+require_relative 'pki_express/commands'
+require_relative 'pki_express/digest_algorithm'
+require_relative 'pki_express/digest_algorithm_and_value'
+require_relative 'pki_express/discovery_service_result'
+require_relative 'pki_express/error_codes'
+require_relative 'pki_express/installation_not_found_error'
+require_relative 'pki_express/oids'
+require_relative 'pki_express/name'
+require_relative 'pki_express/pades_certification_level'
+require_relative 'pki_express/pades_horizontal_align'
+require_relative 'pki_express/pades_measurement_units'
+require_relative 'pki_express/pades_page_optimization'
+require_relative 'pki_express/pades_page_optimization'
+require_relative 'pki_express/pades_paper_size'
+require_relative 'pki_express/pades_signature'
+require_relative 'pki_express/pades_signature_explorer'
+require_relative 'pki_express/pades_signature_starter'
+require_relative 'pki_express/pades_signer'
+require_relative 'pki_express/pades_signer_info'
+require_relative 'pki_express/pades_size'
+require_relative 'pki_express/pades_text_horizontal_align'
+require_relative 'pki_express/pades_vertical_align'
+require_relative 'pki_express/pades_visual_positioning'
+require_relative 'pki_express/pades_visual_auto_positioning'
+require_relative 'pki_express/pades_visual_image'
+require_relative 'pki_express/pades_visual_manual_positioning'
+require_relative 'pki_express/pades_visual_rectangle'
+require_relative 'pki_express/pades_visual_representation'
+require_relative 'pki_express/pades_visual_text'
+require_relative 'pki_express/pk_certificate'
+require_relative 'pki_express/pki_brazil_certificate_fields'
+require_relative 'pki_express/pki_brazil_certificate_types'
+require_relative 'pki_express/pki_italy_certificate_fields'
+require_relative 'pki_express/pki_italy_certificate_types'
+require_relative 'pki_express/signature_algorithm_and_value'
+require_relative 'pki_express/signature_finisher'
+require_relative 'pki_express/signature_policy_identifier'
+require_relative 'pki_express/signature_start_result'
+require_relative 'pki_express/standard_signature_policies'
+require_relative 'pki_express/timestamp_authority'
+require_relative 'pki_express/trust_service_auth_parameters'
+require_relative 'pki_express/trust_service_info'
+require_relative 'pki_express/trust_service_manager'
+require_relative 'pki_express/trust_service_session_result'
+require_relative 'pki_express/trust_service_session_types'
+require_relative 'pki_express/tsa_authentication_type'
+require_relative 'pki_express/validation_error'
+require_relative 'pki_express/validation_item'
+require_relative 'pki_express/validation_item_types'
+require_relative 'pki_express/validation_results'
+require_relative 'pki_express/version'
+require_relative 'pki_express/version_manager'
+
+module PkiExpress
 end

data/pki_express.gemspec

@@ -1,27 +1,27 @@
-# coding: utf-8
-require_relative 'lib/pki_express/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'pki_express'
-  spec.version = PkiExpress::VERSION
-  spec.license = 'MIT'
-  spec.authors = ['Ismael Medeiros']
-  spec.email = %w{ismaelm@lacunasoftware.com}
-  spec.homepage = 'http://docs.lacunasoftware.com/en-us/articles/pki-express'
-  spec.summary = 'Gem for using PKI Express on Ruby'
-  spec.description = 'Classes to use Lacuna Software\'s PKI Express'
-  spec.files = `git ls-files -z`.split("\x0")
-  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
-
-  spec.metadata = {
-      'bug_tracker_uri'   => 'https://github.com/LacunaSoftware/PkiExpressRuby/issues',
-      'changelog_uri'     => 'https://github.com/LacunaSoftware/PkiExpressRuby/blob/develop/CHANGELOG.md',
-      'documentation_uri' => 'http://docs.lacunasoftware.com/en-us/articles/pki-express',
-      'source_code_uri'   => 'https://github.com/LacunaSoftware/PkiExpressRuby'
-  }
-
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 13'
+# coding: utf-8
+require_relative 'lib/pki_express/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'pki_express'
+  spec.version = PkiExpress::VERSION
+  spec.license = 'MIT'
+  spec.authors = ['Ismael Medeiros']
+  spec.email = %w{ismaelm@lacunasoftware.com}
+  spec.homepage = 'http://docs.lacunasoftware.com/en-us/articles/pki-express'
+  spec.summary = 'Gem for using PKI Express on Ruby'
+  spec.description = 'Classes to use Lacuna Software\'s PKI Express'
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.metadata = {
+      'bug_tracker_uri'   => 'https://github.com/LacunaSoftware/PkiExpressRuby/issues',
+      'changelog_uri'     => 'https://github.com/LacunaSoftware/PkiExpressRuby/blob/develop/CHANGELOG.md',
+      'documentation_uri' => 'http://docs.lacunasoftware.com/en-us/articles/pki-express',
+      'source_code_uri'   => 'https://github.com/LacunaSoftware/PkiExpressRuby'
+  }
+
+  spec.add_development_dependency 'bundler', '~> 2.3'
+  spec.add_development_dependency 'rake', '~> 13'
 end

data/spec/pki_express/pki_express_config_spec.rb

@@ -0,0 +1,73 @@
+require 'faker'
+
+require_relative '../spec_helper'
+
+module PkiExpress
+    describe PkiExpressConfig do
+        it 'should set valid default values when no value is passed in contructor' do
+            config = PkiExpressConfig.new
+            expect(config.pki_express_home).to be_nil
+            expect(File.directory?(config.temp_folder)).to be(true)
+            expect(File.directory?(config.transfer_data_folder)).to be(true)
+        end
+
+        it 'should set pki_express_home folder when a valid path is passed' do
+            fake_pki_express_home = Dir.mktmpdir('pkie')
+            config = PkiExpressConfig.new(fake_pki_express_home)
+            expect(config.pki_express_home).to equal(fake_pki_express_home)
+            Dir.rmdir(fake_pki_express_home)
+        end
+
+        it 'should raise ArgumentError when an invalid path is passed' do
+            expect { PkiExpressConfig.new(Faker::String.random) }.to raise_error(ArgumentError)
+        end
+
+        it 'should raise ArgumentError when a path is passed but doesn\'t exist' do
+            fake_pki_express_home = Faker::File.dir
+            expect { PkiExpressConfig.new(fake_pki_express_home) }.to raise_error(ArgumentError)
+        end
+
+        it 'should set temp_folder when a valid path is passed' do
+            fake_temp_folder = Dir.mktmpdir('pkie')
+            config = PkiExpressConfig.new(nil,  fake_temp_folder)
+            expect(config.temp_folder).to equal(fake_temp_folder)
+            Dir.rmdir(fake_temp_folder)
+        end
+
+        it 'should set temp_folder with a default folder when no path is passed' do
+            config1 = PkiExpressConfig.new
+            config2 = PkiExpressConfig.new
+            expect(config1.temp_folder).to equal(config2.temp_folder)
+        end
+
+        it 'should raise ArgumentError when an invalid path is passed' do
+            expect { PkiExpressConfig.new(nil, Faker::String.random) }.to raise_error(ArgumentError)
+        end
+
+        it 'should raise ArgumentError when a path is passed but doesn\'t exist' do
+            fake_pki_express_home = Faker::File.dir
+            expect { PkiExpressConfig.new(nil, fake_pki_express_home) }.to raise_error(ArgumentError)
+        end
+
+        it 'should set transfer_data_folder when a valid path is passed' do
+            fake_transfer_data_folder = Dir.mktmpdir('pkie')
+            config = PkiExpressConfig.new(nil, nil, fake_transfer_data_folder)
+            expect(config.transfer_data_folder).to equal(fake_transfer_data_folder)
+            Dir.rmdir(fake_transfer_data_folder)
+        end
+
+        it 'should set transfer_data_folder with temp_folder value when no path is passed' do
+            config = PkiExpressConfig.new
+            expect(config.transfer_data_folder).to equal(config.temp_folder)
+        end
+
+        it 'should raise ArgumentError when an invalid path is passed' do
+            expect { PkiExpressConfig.new(nil, nil, Faker::String.random) }.to raise_error(ArgumentError)
+        end
+
+        it 'should raise ArgumentError when a path is passed but doesn\'t exist' do
+            fake_pki_express_home = Faker::File.dir
+            expect { PkiExpressConfig.new(nil, nil, fake_pki_express_home) }.to raise_error(ArgumentError)
+        end
+    end
+end

data/spec/pki_express/pki_express_operator_spec.rb

@@ -0,0 +1,31 @@
+require_relative '../spec_helper'
+
+module PkiExpress
+    describe PkiExpressOperator do
+        it "should remove files created by child classes when GC remove its instance" do
+            operator = ChildOperator.new
+            temp_files = []
+            (1..3).each { 
+                created_file = operator.create_temp_file
+                temp_files.append(created_file)
+                expect(File.exist?(created_file)).to equal(true)
+            }
+            operator = nil
+            GC.start
+
+            temp_files.each do |file|
+                expect(File.exist?(file)).to equal(false)
+            end
+        end
+    end
+    
+    class ChildOperator < PkiExpressOperator
+        def initialize(config=PkiExpressConfig.new)
+            super(config)
+        end
+
+        def create_temp_file
+            super
+        end
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require_relative '../lib/pki_express'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pki_express
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.2
 platform: ruby
 authors:
 - Ismael Medeiros
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-04 00:00:00.000000000 Z
+date: 2023-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -46,7 +46,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitattributes"
+- ".github/workflows/test.yml"
 - ".gitignore"
+- ".rspec"
 - CHANGELOG.md
 - Gemfile
 - README.md
@@ -120,6 +122,9 @@ files:
 - lib/pki_express/version.rb
 - lib/pki_express/version_manager.rb
 - pki_express.gemspec
+- spec/pki_express/pki_express_config_spec.rb
+- spec/pki_express/pki_express_operator_spec.rb
+- spec/spec_helper.rb
 homepage: http://docs.lacunasoftware.com/en-us/articles/pki-express
 licenses:
 - MIT
@@ -128,7 +133,7 @@ metadata:
   changelog_uri: https://github.com/LacunaSoftware/PkiExpressRuby/blob/develop/CHANGELOG.md
   documentation_uri: http://docs.lacunasoftware.com/en-us/articles/pki-express
   source_code_uri: https://github.com/LacunaSoftware/PkiExpressRuby
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -143,8 +148,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.0.3.1
+signing_key:
 specification_version: 4
 summary: Gem for using PKI Express on Ruby
-test_files: []
+test_files:
+- spec/pki_express/pki_express_config_spec.rb
+- spec/pki_express/pki_express_operator_spec.rb
+- spec/spec_helper.rb