wcc_ministries_client 1.0.2 → 1.0.4.rc1

data/lib/wcc_ministries_client/api_client.rb

@@ -15,7 +15,7 @@ require 'json'
 require 'logger'
 require 'tempfile'
 require 'time'
-require 'typhoeus'
+require 'faraday'
 
 module WCC::Ministries::Client
   class ApiClient
@@ -47,26 +47,29 @@ module WCC::Ministries::Client
     # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
     #   the data deserialized from response body (could be nil), response status code and response headers.
     def call_api(http_method, path, opts = {})
-      request = build_request(http_method, path, opts)
-      response = request.run
+      begin
+        response = @config.connection.public_send(http_method.to_sym.downcase) do |req|
+          build_request(http_method, path, req, opts)
+        end
 
-      if @config.debugging
-        @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
-      end
+        if @config.debugging
+          @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+        end
 
-      unless response.success?
-        if response.timed_out?
-          fail ApiError.new('Connection timed out')
-        elsif response.code == 0
-          # Errors from libcurl will be made visible here
-          fail ApiError.new(:code => 0,
-                            :message => response.return_message)
-        else
-          fail ApiError.new(:code => response.code,
-                            :response_headers => response.headers,
-                            :response_body => response.body),
-               response.status_message
+        unless response.success?
+          if response.status == 0
+            # Errors from libcurl will be made visible here
+            fail ApiError.new(:code => 0,
+                              :message => response.return_message)
+          else
+            fail ApiError.new(:code => response.status,
+                              :response_headers => response.headers,
+                              :response_body => response.body),
+                 response.status
+          end
         end
+      rescue Faraday::TimeoutError
+        fail ApiError.new('Connection timed out')
       end
 
       if opts[:return_type]
@@ -74,7 +77,7 @@ module WCC::Ministries::Client
       else
         data = nil
       end
-      return data, response.code, response.headers
+      return data, response.status, response.headers
     end
 
     # Builds the HTTP request
@@ -86,7 +89,7 @@ module WCC::Ministries::Client
     # @option opts [Hash] :form_params Query parameters
     # @option opts [Object] :body HTTP body (JSON/XML)
     # @return [Typhoeus::Request] A Typhoeus Request
-    def build_request(http_method, path, opts = {})
+    def build_request(http_method, path, request, opts = {})
       url = build_request_url(path, opts)
       http_method = http_method.to_sym.downcase
 
@@ -94,9 +97,7 @@ module WCC::Ministries::Client
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
 
-
-      # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
-      _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
+      update_params_for_auth! header_params, query_params, opts[:auth_names]
 
       req_opts = {
         :method => http_method,
@@ -104,16 +105,9 @@ module WCC::Ministries::Client
         :params => query_params,
         :params_encoding => @config.params_encoding,
         :timeout => @config.timeout,
-        :ssl_verifypeer => @config.verify_ssl,
-        :ssl_verifyhost => _verify_ssl_host,
-        :sslcert => @config.cert_file,
-        :sslkey => @config.key_file,
         :verbose => @config.debugging
       }
 
-      # set custom cert, if provided
-      req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
-
       if [:post, :patch, :put, :delete].include?(http_method)
         req_body = build_request_body(header_params, form_params, opts[:body])
         req_opts.update :body => req_body
@@ -121,8 +115,10 @@ module WCC::Ministries::Client
           @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
         end
       end
-
-      request = Typhoeus::Request.new(url, req_opts)
+      request.headers = header_params
+      request.body = req_body
+      request.url url
+      request.params = query_params
       download_file(request) if opts[:return_type] == 'File'
       request
     end
@@ -135,13 +131,17 @@ module WCC::Ministries::Client
     # @return [String] HTTP body data in the form of string
     def build_request_body(header_params, form_params, body)
       # http form
-      if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
-          header_params['Content-Type'] == 'multipart/form-data'
+      if header_params['Content-Type'] == 'application/x-www-form-urlencoded'
+        data = URI.encode_www_form(form_params)
+      elsif header_params['Content-Type'] == 'multipart/form-data'
         data = {}
         form_params.each do |key, value|
           case value
-          when ::File, ::Array, nil
-            # let typhoeus handle File, Array and nil parameters
+          when ::File, ::Tempfile
+            # TODO hardcode to application/octet-stream, need better way to detect content type
+            data[key] = Faraday::UploadIO.new(value.path, 'application/octet-stream', value.path)
+          when ::Array, nil
+            # let Faraday handle Array and nil parameters
             data[key] = value
           else
             data[key] = value.to_s
@@ -155,41 +155,12 @@ module WCC::Ministries::Client
       data
     end
 
-    # Save response body into a file in (the defined) temporary folder, using the filename
-    # from the "Content-Disposition" header if provided, otherwise a random filename.
-    # The response body is written to the file in chunks in order to handle files which
-    # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
-    # process can use.
-    #
-    # @see Configuration#temp_folder_path
     def download_file(request)
-      tempfile = nil
-      encoding = nil
-      request.on_headers do |response|
-        content_disposition = response.headers['Content-Disposition']
-        if content_disposition && content_disposition =~ /filename=/i
-          filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
-          prefix = sanitize_filename(filename)
-        else
-          prefix = 'download-'
-        end
-        prefix = prefix + '-' unless prefix.end_with?('-')
-        encoding = response.body.encoding
-        tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
-        @tempfile = tempfile
-      end
-      request.on_body do |chunk|
-        chunk.force_encoding(encoding)
-        tempfile.write(chunk)
-      end
-      request.on_complete do |response|
-        if tempfile
-          tempfile.close
-          @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
-                              "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
-                              "will be deleted automatically with GC. It's also recommended to delete the temp file "\
-                              "explicitly with `tempfile.delete`"
-        end
+      @stream = []
+
+      # handle streaming Responses
+      request.options.on_data = Proc.new do |chunk, overall_received_bytes|
+        @stream << chunk
       end
     end
 
@@ -214,7 +185,25 @@ module WCC::Ministries::Client
 
       # handle file downloading - return the File instance processed in request callbacks
       # note that response body is empty when the file is written in chunks in request on_body callback
-      return @tempfile if return_type == 'File'
+      if return_type == 'File'
+        content_disposition = response.headers['Content-Disposition']
+        if content_disposition && content_disposition =~ /filename=/i
+          filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+          prefix = sanitize_filename(filename)
+        else
+          prefix = 'download-'
+        end
+        prefix = prefix + '-' unless prefix.end_with?('-')
+        encoding = body.encoding
+        @tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+        @tempfile.write(@stream.join.force_encoding(encoding))
+        @tempfile.close
+        @config.logger.info "Temp file written to #{@tempfile.path}, please copy the file to a proper folder "\
+                            "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                            "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                            "explicitly with `tempfile.delete`"
+        return @tempfile
+      end
 
       return nil if body.nil? || body.empty?
 

data/lib/wcc_ministries_client/configuration.rb

@@ -10,6 +10,9 @@ OpenAPI Generator version: unset
 
 =end
 
+require 'faraday-http-cache'
+require 'faraday/follow_redirects'
+
 module WCC::Ministries::Client
   class Configuration
     # Defines url scheme
@@ -98,33 +101,28 @@ module WCC::Ministries::Client
     # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
     #
     # @return [true, false]
-    attr_accessor :verify_ssl
+    attr_accessor :ssl_verify
 
     ### TLS/SSL setting
-    # Set this to false to skip verifying SSL host name
-    # Default to true.
+    # Any `OpenSSL::SSL::` constant (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html)
     #
     # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
     #
-    # @return [true, false]
-    attr_accessor :verify_ssl_host
+    attr_accessor :ssl_verify_mode
 
     ### TLS/SSL setting
     # Set this to customize the certificate file to verify the peer.
     #
     # @return [String] the path to the certificate file
-    #
-    # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
-    # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
-    attr_accessor :ssl_ca_cert
+    attr_accessor :ssl_ca_file
 
     ### TLS/SSL setting
     # Client certificate file (for client certificate)
-    attr_accessor :cert_file
+    attr_accessor :ssl_client_cert
 
     ### TLS/SSL setting
     # Client private key file (for client certificate)
-    attr_accessor :key_file
+    attr_accessor :ssl_client_key
 
     # Set this to customize parameters encoding of array parameter with multi collectionFormat.
     # Default to nil.
@@ -136,6 +134,8 @@ module WCC::Ministries::Client
     attr_accessor :inject_format
 
     attr_accessor :force_ending_format
+    
+    attr_accessor :cache_store
 
     def initialize
       @scheme = 'https'
@@ -149,15 +149,16 @@ module WCC::Ministries::Client
       @api_key_prefix = {}
       @timeout = 0
       @client_side_validation = true
-      @verify_ssl = true
-      @verify_ssl_host = true
-      @params_encoding = nil
-      @cert_file = nil
-      @key_file = nil
+      @ssl_verify = true
+      @ssl_verify_mode = nil
+      @ssl_ca_file = nil
+      @ssl_client_cert = nil
+      @ssl_client_key = nil
       @debugging = false
       @inject_format = false
       @force_ending_format = false
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+      @cache_store = defined?(Rails) ? Rails.cache : nil
 
       yield(self) if block_given?
     end
@@ -233,6 +234,34 @@ module WCC::Ministries::Client
       }
     end
 
+    def ssl_options
+      {
+        :ca_file => ssl_ca_file,
+        :verify => ssl_verify,
+        :verify_mode => ssl_verify_mode,
+        :client_cert => ssl_client_cert,
+        :client_key => ssl_client_key
+      }
+    end
+
+    # Allows supplying a custom Faraday connection
+    attr_writer :connection
+    def connection
+      # new one each time unless set in configuration
+      @connection ||
+        Faraday.new(:url => base_url, :ssl => ssl_options) do |conn|
+          # Use Rails.cache for conditional GET requests, b/c the Ministries
+          # API responds much faster to conditional GETs when fresh
+          # requires faraday-http-cache
+          conn.use :http_cache, store: cache_store if cache_store
+
+          conn.adapter(Faraday.default_adapter)
+
+          # Follow redirects (requires 'faraday_middleware')
+          conn.response :follow_redirects
+        end
+    end
+
     # Returns URL based on server settings
     #
     # @param index array index of the server settings

data/lib/wcc_ministries_client/version.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: unset
 module WCC
   module Ministries
     module Client
-      VERSION = '1.0.2'
+      VERSION = '1.0.4.rc1'
     end
   end
 end

data/openapitools.json

@@ -8,6 +8,7 @@
         "generatorName": "ruby",
         "output": "#{cwd}",
         "glob": "swagger.json",
+        "library": "faraday",
         "additionalProperties": {
           "gemName": "wcc_ministries_client",
           "moduleName": "WCC::Ministries::Client",

data/spec/api_client_spec.rb

@@ -51,44 +51,6 @@ describe WCC::Ministries::Client::ApiClient do
     end
   end
 
-  describe 'params_encoding in #build_request' do
-    let(:config) { WCC::Ministries::Client::Configuration.new }
-    let(:api_client) { WCC::Ministries::Client::ApiClient.new(config) }
-
-    it 'defaults to nil' do
-      expect(WCC::Ministries::Client::Configuration.default.params_encoding).to eq(nil)
-      expect(config.params_encoding).to eq(nil)
-
-      request = api_client.build_request(:get, '/test')
-      expect(request.options[:params_encoding]).to eq(nil)
-    end
-
-    it 'can be customized' do
-      config.params_encoding = :multi
-      request = api_client.build_request(:get, '/test')
-      expect(request.options[:params_encoding]).to eq(:multi)
-    end
-  end
-
-  describe 'timeout in #build_request' do
-    let(:config) { WCC::Ministries::Client::Configuration.new }
-    let(:api_client) { WCC::Ministries::Client::ApiClient.new(config) }
-
-    it 'defaults to 0' do
-      expect(WCC::Ministries::Client::Configuration.default.timeout).to eq(0)
-      expect(config.timeout).to eq(0)
-
-      request = api_client.build_request(:get, '/test')
-      expect(request.options[:timeout]).to eq(0)
-    end
-
-    it 'can be customized' do
-      config.timeout = 100
-      request = api_client.build_request(:get, '/test')
-      expect(request.options[:timeout]).to eq(100)
-    end
-  end
-
   describe '#deserialize' do
     it "handles Array<Integer>" do
       api_client = WCC::Ministries::Client::ApiClient.new

data/spec/spec_helper.rb

@@ -10,6 +10,11 @@ OpenAPI Generator version: unset
 
 =end
 
+require 'simplecov'
+SimpleCov.start
+require 'simplecov-cobertura'
+SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
+
 # load the gem
 require 'wcc_ministries_client'
 

data/wcc_ministries_client.gemspec

@@ -27,7 +27,10 @@ Gem::Specification.new do |s|
   s.license     = "MIT"
   s.required_ruby_version = ">= 2.4"
 
-  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  # Expand the range of Faraday that can be used
+  s.add_runtime_dependency 'faraday', '>= 2.0', '< 3.0'
+  s.add_runtime_dependency 'faraday-http-cache', '>= 2.0', '< 3.0'
+  s.add_runtime_dependency 'faraday-follow_redirects'
 
   s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
 

metadata

@@ -1,35 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: wcc_ministries_client
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4.rc1
 platform: ruby
 authors:
 - Watermark Community Church
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-19 00:00:00.000000000 Z
+date: 2023-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: typhoeus
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-http-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-follow_redirects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -62,6 +96,10 @@ files:
 - README.md
 - Rakefile
 - bin/gen
+- coverage/.last_run.json
+- coverage/.resultset.json
+- coverage/.resultset.json.lock
+- coverage/coverage.xml
 - docs/Asset.md
 - docs/AssetFile.md
 - docs/AssetFileDetails.md
@@ -109,9 +147,8 @@ files:
 - lib/wcc_ministries_client/models/page_relationship_data.rb
 - lib/wcc_ministries_client/version.rb
 - openapitools.json
-- pkg/wcc_ministries_client-1.0.0.gem
-- pkg/wcc_ministries_client-1.0.1.gem
-- pkg/wcc_ministries_client-1.0.2.gem
+- pkg/wcc_ministries_client-1.0.4.gem
+- pkg/wcc_ministries_client-1.0.4.rc1.gem
 - spec/api/ministry_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
@@ -152,12 +189,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: WCC Ministries API Ruby Gem