|
| 1 | +# frozen_string_literal: true |
| 2 | + |
| 3 | +# Base class for API services with HTTP client and error handling |
| 4 | +class ApiConnector |
| 5 | + # Class-level configuration |
| 6 | + class << self |
| 7 | + attr_accessor :timeout, :max_retries, :retry_delay, :logging |
| 8 | + end |
| 9 | + |
| 10 | + # Default configuration |
| 11 | + self.timeout = 10 |
| 12 | + self.max_retries = 3 |
| 13 | + self.retry_delay = 1 |
| 14 | + self.logging = Rails.env.development? |
| 15 | + |
| 16 | + def initialize |
| 17 | + @connection = build_connection |
| 18 | + end |
| 19 | + |
| 20 | + # Generic method to make API requests with error handling |
| 21 | + def make_request(method, url, options = {}) |
| 22 | + return error_response('API endpoint not configured') unless url |
| 23 | + |
| 24 | + begin |
| 25 | + response = @connection.send(method) do |req| |
| 26 | + req.url url |
| 27 | + req.headers['Content-Type'] = 'application/json' |
| 28 | + |
| 29 | + # Add custom headers |
| 30 | + options[:headers]&.each { |key, value| req.headers[key] = value } |
| 31 | + |
| 32 | + # Add body for POST/PUT requests |
| 33 | + req.body = options[:body] if options[:body] |
| 34 | + end |
| 35 | + |
| 36 | + handle_response(response) |
| 37 | + rescue Faraday::TimeoutError => e |
| 38 | + handle_timeout_error(e) |
| 39 | + rescue Faraday::ConnectionFailed => e |
| 40 | + handle_connection_error(e) |
| 41 | + rescue Faraday::Error => e |
| 42 | + handle_faraday_error(e) |
| 43 | + rescue StandardError => e |
| 44 | + handle_generic_error(e) |
| 45 | + end |
| 46 | + end |
| 47 | + |
| 48 | + def handle_response(response) |
| 49 | + case response.status |
| 50 | + when 200 |
| 51 | + success_response(response.body) |
| 52 | + when 401 |
| 53 | + error_response('Invalid credentials') |
| 54 | + when 403 |
| 55 | + error_response('Access denied') |
| 56 | + when 404 |
| 57 | + error_response('Service not found') |
| 58 | + when 422 |
| 59 | + error_response('Invalid data') |
| 60 | + when 500..599 |
| 61 | + error_response('Service error') |
| 62 | + else |
| 63 | + error_response('Unexpected response from service') |
| 64 | + end |
| 65 | + end |
| 66 | + |
| 67 | + private |
| 68 | + |
| 69 | + def build_connection |
| 70 | + Faraday.new do |faraday| |
| 71 | + faraday.request :url_encoded |
| 72 | + faraday.request :json |
| 73 | + faraday.response :json |
| 74 | + faraday.adapter Faraday.default_adapter |
| 75 | + |
| 76 | + # Configure timeout |
| 77 | + faraday.options.timeout = self.class.timeout |
| 78 | + faraday.options.open_timeout = self.class.timeout |
| 79 | + |
| 80 | + # Configure logging if enabled |
| 81 | + if self.class.logging |
| 82 | + faraday.response :logger, Rails.logger, { headers: false, bodies: false } |
| 83 | + end |
| 84 | + end |
| 85 | + end |
| 86 | + |
| 87 | + def generate_api_token(username, password) |
| 88 | + # Generate a token based on username and password |
| 89 | + # You can customize this method based on your API requirements |
| 90 | + |
| 91 | + # Get token generation method from configuration |
| 92 | + token_method = ENV['API_TOKEN_METHOD'] || 'base64' |
| 93 | + |
| 94 | + case token_method |
| 95 | + when 'hmac' |
| 96 | + generate_hmac_token(username, password) |
| 97 | + when 'base64' |
| 98 | + generate_base64_token(username, password) |
| 99 | + when 'simple' |
| 100 | + generate_simple_token(username, password) |
| 101 | + else |
| 102 | + generate_base64_token(username, password) # Default to base64 |
| 103 | + end |
| 104 | + end |
| 105 | + |
| 106 | + def generate_hmac_token(username, password) |
| 107 | + # Using HMAC for secure token generation |
| 108 | + secret_key = ENV['API_SECRET_KEY'] || 'default_secret_key' |
| 109 | + timestamp = Time.current.to_i |
| 110 | + token_data = "#{username}:#{password}:#{timestamp}" |
| 111 | + OpenSSL::HMAC.hexdigest('SHA256', secret_key, token_data) |
| 112 | + end |
| 113 | + |
| 114 | + def generate_base64_token(username, password) |
| 115 | + # Base64 encoded token |
| 116 | + token_data = "#{username}:#{password}" |
| 117 | + Base64.strict_encode64(token_data) |
| 118 | + end |
| 119 | + |
| 120 | + def generate_simple_token(username, password) |
| 121 | + # Simple concatenation (less secure, but simple) |
| 122 | + timestamp = Time.current.to_i |
| 123 | + "#{username}:#{password}:#{timestamp}" |
| 124 | + end |
| 125 | + |
| 126 | + def handle_timeout_error(error) |
| 127 | + Rails.logger.error "API Connector timeout: #{error.message}" if self.class.logging |
| 128 | + error_response('Service timeout') |
| 129 | + end |
| 130 | + |
| 131 | + def handle_connection_error(error) |
| 132 | + Rails.logger.error "API Connector connection failed: #{error.message}" if self.class.logging |
| 133 | + error_response('Cannot connect to service') |
| 134 | + end |
| 135 | + |
| 136 | + def handle_faraday_error(error) |
| 137 | + Rails.logger.error "API Connector Faraday error: #{error.message}" if self.class.logging |
| 138 | + error_response('Network error') |
| 139 | + end |
| 140 | + |
| 141 | + def handle_generic_error(error) |
| 142 | + Rails.logger.error "API Connector error: #{error.message}" |
| 143 | + error_response('Service temporarily unavailable') |
| 144 | + end |
| 145 | + |
| 146 | + def success_response(data) |
| 147 | + { |
| 148 | + success: true, |
| 149 | + data: data, |
| 150 | + message: 'Operation successful' |
| 151 | + } |
| 152 | + end |
| 153 | + |
| 154 | + def error_response(message) |
| 155 | + { |
| 156 | + success: false, |
| 157 | + message: message, |
| 158 | + data: nil |
| 159 | + } |
| 160 | + end |
| 161 | +end |
0 commit comments