pluton8 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: deb82287262c2b97f12fd5bfc979f4a941298cd65e49e54a9a5230589e51d0ce
+  data.tar.gz: 323132fc5bc08c80d53a3777fa394b1807c90b24d47cb3ee423d2dc699f8b644
+SHA512:
+  metadata.gz: 418ba9c52c8bb793796d9b1dd7bdf49bd535475ef091acdbfa21e5616373f7523c61a957c13bd4b3ab0a0f9ac69f1129c6b78b5e9f4fa9b3222b5e9a3bf1cf3c
+  data.tar.gz: 1c9ba047239d839c8c7af40fa9b804d877af7c075e8920901ba1422acff6d4de9c65211a00c8d5909e511f7d0ee520341de58038acb33a24e3ee4c93b5facf49

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Stefan Froelich
+
+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.

data/README.md

@@ -0,0 +1,28 @@
+# ApiBase
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "api_base"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install api_base
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/assets/config/api_base_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/api_base .css

data/app/assets/stylesheets/api_base/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/api_base/application_controller.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ApiBase
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/api_base/application_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ApiBase
+  module ApplicationHelper
+  end
+end

data/app/jobs/api_base/application_job.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ApiBase
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/api_base/application_mailer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ApiBase
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/api_base/api_log.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: api_logs
+#
+#  id               :bigint           not null, primary key
+#  api              :text             not null
+#  duration         :float
+#  endpoint         :text             not null
+#  exception        :jsonb
+#  method           :text             not null
+#  origin           :text             not null
+#  request_body     :jsonb
+#  request_headers  :jsonb
+#  response_body    :jsonb
+#  response_headers :jsonb
+#  source           :text             not null
+#  status_code      :integer
+#  created_at       :datetime         not null
+#  updated_at       :datetime         not null
+#
+require 'English'
+
+module ApiBase
+  class ApiLog < ApplicationRecord
+    attribute :sanitized, :boolean, default: false
+
+    validate :ensure_nothing_changed, unless: :new_record?
+    validate :ensure_data_sanitized
+
+    validates_presence_of :api, :origin, :source, :endpoint
+
+    validates :source, presence: true, inclusion: { in: %w[outgoing_request incoming_webhook] }
+    validates :method, presence: true, inclusion: { in: %w[GET POST DELETE PUT] }
+
+    def self.start_outgoing_request(origin, method, endpoint, payload)
+      ApiLog.new api: origin.identifier, origin: origin.class.to_s, source: 'outgoing_request',
+                 endpoint: "#{origin.connection.url_prefix}#{endpoint}", method:,
+                 request_headers: origin.connection.headers, request_body: payload
+    end
+
+    def complete_outgoing_request(response, duration)
+      # Ensure we are recording the actual headers that were sent on the request.
+      # The ones set from the connection might not be the final headers.
+      self.request_headers = response.env.request_headers
+      # Set the rest of the response attributes.
+      assign_attributes status_code: response.status, duration:,
+                        response_body: response.body, response_headers: response.headers
+    end
+
+    def self.start_webhook_request(origin, request)
+      ApiLog.new api: origin, origin: origin.class.to_s, source: 'incoming_webhook',
+                 endpoint: request.fullpath, method: request.method,
+                 request_headers: request.headers.env.reject { |key|
+                   key.to_s.include?('.')
+                 }, request_body: request.params
+    end
+
+    def complete_webhook_request(response, duration)
+      # Set the rest of the response attributes.
+      assign_attributes status_code: response.status, duration:,
+                        response_body: response.body, response_headers: response.headers
+    end
+
+    def filter_sensitive_data
+      parse_json_fields
+
+      %i[request_headers request_body response_headers response_body exception].each do |prop|
+        self[prop] = yield(self[prop]) if self[prop].is_a?(Hash)
+      end
+
+      self.sanitized = true
+    end
+
+    private
+
+    def ensure_nothing_changed
+      errors.add(:base, 'Record is read-only') if changed?
+    end
+
+    def ensure_data_sanitized
+      errors.add(:base, 'Data must be sanitized') unless sanitized?
+    end
+
+    def parse_json_fields
+      %i[request_headers request_body response_headers response_body exception].each do |prop|
+        self[prop] = safely_parse_json(self[prop])
+      end
+    end
+
+    def safely_parse_json(value)
+      case value
+      when nil, Hash
+        value
+      when String
+        JSON.parse value
+      when StandardError
+        [e.message, *e.backtrace].join($INPUT_RECORD_SEPARATOR).to_json
+      else
+        value.to_s.to_json
+      end
+    rescue StandardError
+      # Something we can't encode. Let's preserve it as a string.
+      value.to_s.to_json
+    end
+  end
+end

data/app/models/api_base/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ApiBase
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/api_base/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Api base</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "api_base/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+ApiBase::Engine.routes.draw do
+end

data/db/migrate/20220612165032_create_api_logs.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class CreateApiLogs < ActiveRecord::Migration[6.0]
+  def change
+    create_table :api_base_api_logs do |t|
+      t.text :api, null: false
+      t.text :origin, null: false
+      t.text :source, null: false
+      t.text :endpoint, null: false
+      t.text :method, null: false
+      t.jsonb :request_headers
+      t.jsonb :request_body
+      t.integer :status_code
+      t.jsonb :response_headers
+      t.jsonb :response_body
+      t.float :duration
+      t.jsonb :exception
+
+      t.timestamps
+    end
+  end
+end

data/lib/api_base/behaviours/get_json.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ApiBase
+  module Behaviours
+    # Shared concern that adds the ability to get json from an endpoint
+    module GetJson
+      include Shared
+
+      alias get_json behaviour_delegate
+
+      protected
+
+      def execute_request(endpoint, _payload)
+        execute do
+          connection.get(endpoint) do |req|
+            req.headers['Content-Type'] = 'application/json'
+          end
+        end
+      end
+
+      def method
+        'GET'
+      end
+    end
+  end
+end

data/lib/api_base/behaviours/post_json.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ApiBase
+  module Behaviours
+    # Shared concern that adds the ability to post json to an endpoint
+    module PostJson
+      include Shared
+
+      alias post_json behaviour_delegate
+
+      protected
+
+      def execute_request(endpoint, payload)
+        execute do
+          connection.post(endpoint, payload) do |req|
+            req.body = payload.to_json
+            req.headers['Content-Type'] = 'application/json'
+          end
+        end
+      end
+
+      def method
+        'POST'
+      end
+    end
+  end
+end

data/lib/api_base/behaviours/shared.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module ApiBase
+  module Behaviours
+    # Shared module that adds common methods to api behaviours
+    module Shared
+      def behaviour_delegate(endpoint, payload = {})
+        api_log = ApiBase::ApiLog.start_outgoing_request(self, method, endpoint, payload)
+        response, duration = make_request(endpoint, payload)
+        api_log.complete_outgoing_request response, duration
+
+        response
+      rescue StandardError => e
+        api_log.exception = e if api_log.present?
+        raise
+      ensure
+        if api_log.present?
+          api_log.filter_sensitive_data { |data| filter_object(data) }
+          api_log.save!
+        end
+
+        validate_status_code response if response.present?
+      end
+
+      protected
+
+      def make_request(endpoint, payload)
+        trace_active_tag('request.endpoint', endpoint)
+        trace_active_tag('request.payload', filter_object(payload))
+
+        start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        response = execute_request(endpoint, payload)
+        duration = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start
+
+        trace_active_tag('response.status', response.status)
+        trace_active_tag('response.body', filter_object(response.body))
+        trace_active_tag('response.duration', duration)
+
+        [response, duration]
+      end
+
+      def method
+        raise NotImplementedError, 'method is not implemented'
+      end
+
+      def execute_request
+        raise NotImplementedError, 'execute_request is not implemented'
+      end
+    end
+  end
+end

data/lib/api_base/concerns/filterer.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module ApiBase
+  module Concerns
+    module Filterer
+      protected
+
+      def filterer
+        @filterer ||= ActiveSupport::ParameterFilter.new(Rails.application.config.filter_parameters)
+      end
+
+      def filter_object(obj)
+        return if obj.nil?
+
+        case obj
+        when Array then filter_array(obj)
+        when Hash then filter_hash(obj)
+        else obj
+        end
+      end
+
+      def filter_array(array)
+        return if array.nil?
+
+        array.map do |item|
+          case item
+          when Array then filter_array(item)
+          when Hash then filter_hash(item)
+          else item
+          end
+        end
+      end
+
+      def filter_hash(hash)
+        return if hash.nil?
+
+        hash.each do |key, value|
+          case value
+          when Array then hash[key] = filter_array(value)
+          when Hash then hash[key] = filter_hash(value)
+          end
+        end
+        filterer.filter (hash.try(:permit!) || hash).to_hash
+      end
+    end
+  end
+end

data/lib/api_base/concerns/traceable.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ApiBase
+  module Concerns
+    module Traceable
+      protected
+
+      def trace_root_tag(name, value)
+        Rails.logger.debug "trace_root_tag -> #{name} | #{value}"
+      end
+
+      def trace_root_error(error)
+        Rails.logger.debug "trace_root_error -> #{error}"
+      end
+
+      def trace_active_tag(name, value)
+        Rails.logger.debug "trace_active_tag -> #{name} | #{value}"
+      end
+
+      def trace_active_error(error)
+        Rails.logger.debug "trace_active_error -> #{error}"
+      end
+    end
+  end
+end

data/lib/api_base/connection.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ApiBase
+  module Connection
+    def connection
+      @connection_cache ||= {}
+      @connection_cache[connection_name] ||= with_connection(connection_name)
+    end
+
+    def connection_name
+      defined?(@connection_name) ? @connection_name.to_sym : :default
+    end
+
+    def with_connection(connection_name)
+      @connection_name = connection_name
+    end
+
+    protected
+
+    def with_connection(connection_name)
+      raise NotImplementedError, "with_connection is not implemented"
+    end
+  end
+end

data/lib/api_base/endpoint.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'stoplight'
+require 'api_base/service'
+require 'api_base/connection'
+require 'api_base/concerns/traceable'
+require 'api_base/concerns/filterer'
+require 'api_base/errors/api_error'
+require 'api_base/errors/processing_error'
+
+module ApiBase
+  class Endpoint
+    include ActiveSupport::Rescuable
+    include Concerns::Traceable
+    include Concerns::Filterer
+    include ApiBase::Service
+    include ApiBase::Connection
+
+    rescue_from Stoplight::Error::RedLight do
+      Rails.logger.warn "#{identifier} api circuit is closed"
+      raise ApiBase::Errors::ApiError, 'Circuit broken'
+    end
+
+    rescue_from Faraday::TimeoutError do
+      Rails.logger.warn "#{identifier} api timed-out"
+      raise ApiBase::Errors::ApiError, 'Request timed-out'
+    end
+
+    def identifier
+      "#{service_name}:#{connection_name}"
+    end
+
+    protected
+
+    def execute(&block)
+      light = Stoplight(identifier) do
+        block.call
+      end
+
+      light.with_error_handler do |error, handler|
+        # We don't want processing errors to affect our circuit breakers
+        # They are our api equivalent of runtime errors.
+        raise error if error.is_a?(ApiBase::Errors::ProcessingError)
+
+        handler.call(error)
+      end
+
+      light.run
+    rescue StandardError => e
+      trace_active_error(e)
+      rescue_with_handler(e) || raise
+    end
+
+    def validate_status_code(response)
+      return if success_status_codes.include?(response.status)
+
+      raise ApiBase::Errors::ProcessingError, "Request failed with status: #{response.status}"
+    end
+
+    def filterer
+      @filterer ||= ActiveSupport::ParameterFilter.new sensitive_keys
+    end
+  end
+end

data/lib/api_base/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ApiBase
+  class Engine < ::Rails::Engine
+    isolate_namespace ApiBase
+  end
+end

data/lib/api_base/errors/api_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ApiBase
+  module Errors
+    class ApiError < StandardError
+    end
+  end
+end

data/lib/api_base/errors/processing_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ApiBase
+  module Errors
+    class ProcessingError < ApiError
+    end
+  end
+end

data/lib/api_base/service.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ApiBase
+  module Service
+    def service_name
+      raise NotImplementedError, 'service_name is not implemented'
+    end
+
+    def sensitive_keys
+      raise NotImplementedError, 'sensitive_keys is not implemented'
+    end
+
+    def success_status_codes
+      [200, 201]
+    end
+  end
+end

data/lib/api_base/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ApiBase
+  VERSION = '0.1.0'
+end

data/lib/api_base.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'api_base/version'
+require 'api_base/engine'
+require 'api_base/endpoint'
+require 'api_base/behaviours/shared'
+require 'api_base/behaviours/get_json'
+require 'api_base/behaviours/post_json'
+require 'api_base/errors/api_error'
+require 'api_base/errors/processing_error'
+
+module ApiBase
+  # Your code goes here...
+end

data/lib/tasks/api_base_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :api_base do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: pluton8
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stefan Froelich
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+- !ruby/object:Gem::Dependency
+  name: stoplight
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Building blocks for building API Clients
+email:
+- sfroelich01@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/api_base_manifest.js
+- app/assets/stylesheets/api_base/application.css
+- app/controllers/api_base/application_controller.rb
+- app/helpers/api_base/application_helper.rb
+- app/jobs/api_base/application_job.rb
+- app/mailers/api_base/application_mailer.rb
+- app/models/api_base/api_log.rb
+- app/models/api_base/application_record.rb
+- app/views/layouts/api_base/application.html.erb
+- config/routes.rb
+- db/migrate/20220612165032_create_api_logs.rb
+- lib/api_base.rb
+- lib/api_base/behaviours/get_json.rb
+- lib/api_base/behaviours/post_json.rb
+- lib/api_base/behaviours/shared.rb
+- lib/api_base/concerns/filterer.rb
+- lib/api_base/concerns/traceable.rb
+- lib/api_base/connection.rb
+- lib/api_base/endpoint.rb
+- lib/api_base/engine.rb
+- lib/api_base/errors/api_error.rb
+- lib/api_base/errors/processing_error.rb
+- lib/api_base/service.rb
+- lib/api_base/version.rb
+- lib/tasks/api_base_tasks.rake
+homepage: https://github.com/ussd-engine/api-base
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/ussd-engine/api-base
+  source_code_uri: https://github.com/ussd-engine/api-base
+  changelog_uri: https://github.com/ussd-engine/api-base
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Building blocks for building API Clients
+test_files: []