api_base 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7c64a64a166f1c8b54d6d06d7d390c42d38166dead3e70574097cc98f7c1553
-  data.tar.gz: 62c43b1db2628f41c1817e1f2700eaf9b4cf38e6ec94ec77fd4620e6a37e7f7b
+  metadata.gz: ad387684e0176452fd738348781bf05e627d44cc170946c5820049e17c74fbf0
+  data.tar.gz: c59f1adedbe0fbc80fcf3568fcf467b646987f22932d3a053747babfac7505f4
 SHA512:
-  metadata.gz: 737062be042509aa0ea003d0327ed429614a4aa068555392c8d7c48bf73e2551dccdbfba6ea54c13174354ef88de669b1bc9df26eaefef88ed12463f3adbe010
-  data.tar.gz: 1e9bc490d4c224c55bbb2b0f086d235601bebdc99e0ab6b3907d4ca7da9d7c6931b6b924c7a28f59f1b442bf3e7adbb20220a88a5bd4b3378385a4b6ad05a1f9
+  metadata.gz: be650a32b4bd36756f491d9383bf2ee20320631591baa3370026ef354386136edea8e4cdb9b86f8aecd2e8aa7d7cea894731a793727565feb380b4d961346a08
+  data.tar.gz: 01350e16a0b860a95e426e2a07aa1e842025f7900f438de544a8afc888570f38fa5c509d3f3e1e84fde4b30744c04f9df44df0f229f3a36294ffba36578132a9

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

@@ -1,40 +1,28 @@
 # ApiBase
+Short description and motivation.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/api_base`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+## Usage
+How to use my plugin.
 
 ## Installation
-
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'api_base'
+gem "api_base"
 ```
 
 And then execute:
-
-    $ bundle install
+```bash
+$ bundle
+```
 
 Or install it yourself as:
-
-    $ gem install api_base
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```bash
+$ gem install api_base
+```
 
 ## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/api_base.
-
+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

@@ -1,6 +1,10 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
 
-RSpec::Core::RakeTask.new(:spec)
+require 'bundler/setup'
 
-task :default => :spec
+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

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 class CreateApiLogs < ActiveRecord::Migration[6.0]
   def change
-    create_table :api_logs do |t|
+    create_table :api_base_api_logs do |t|
       t.text :api, null: false
       t.text :origin, null: false
       t.text :source, null: false

data/lib/api_base/behaviours/get_json.rb

@@ -13,13 +13,13 @@ module ApiBase
       def execute_request(endpoint, _payload)
         execute do
           connection.get(endpoint) do |req|
-            req.headers["Content-Type"] = "application/json"
+            req.headers['Content-Type'] = 'application/json'
           end
         end
       end
 
       def method
-        "GET"
+        'GET'
       end
     end
   end

data/lib/api_base/behaviours/post_json.rb

@@ -14,13 +14,13 @@ module ApiBase
         execute do
           connection.post(endpoint, payload) do |req|
             req.body = payload.to_json
-            req.headers["Content-Type"] = "application/json"
+            req.headers['Content-Type'] = 'application/json'
           end
         end
       end
 
       def method
-        "POST"
+        'POST'
       end
     end
   end

data/lib/api_base/behaviours/shared.rb

@@ -5,7 +5,7 @@ module ApiBase
     # Shared module that adds common methods to api behaviours
     module Shared
       def behaviour_delegate(endpoint, payload = {})
-        api_log = Models::ApiLog.start_outgoing_request(self, method, 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
 
@@ -25,26 +25,26 @@ module ApiBase
       protected
 
       def make_request(endpoint, payload)
-        trace_active_tag("request.endpoint", endpoint)
-        trace_active_tag("request.payload", filter_object(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)
+        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"
+        raise NotImplementedError, 'method is not implemented'
       end
 
       def execute_request
-        raise NotImplementedError, "execute_request is not implemented"
+        raise NotImplementedError, 'execute_request is not implemented'
       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/{base.rb → endpoint.rb}

@@ -1,35 +1,34 @@
-require "active_support"
-require "faraday"
-require "stoplight"
-require "api_base/concerns/traceable"
-require "api_base/concerns/filterer"
+# 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 Base
+  class Endpoint
     include ActiveSupport::Rescuable
     include Concerns::Traceable
     include Concerns::Filterer
-
-    def identifier
-      raise NotImplementedError, "identifier is not implemented"
-    end
-
-    def connection
-      raise NotImplementedError, "connection is not implemented"
-    end
-
-    def sensitive_data_keys
-      raise NotImplementedError, "sensitive_data_keys is not implemented"
-    end
+    include ApiBase::Service
+    include ApiBase::Connection
 
     rescue_from Stoplight::Error::RedLight do
       Rails.logger.warn "#{identifier} api circuit is closed"
-      raise Api::Error::ApiError, "Circuit broken"
+      raise ApiBase::Errors::ApiError, 'Circuit broken'
     end
 
     rescue_from Faraday::TimeoutError do
       Rails.logger.warn "#{identifier} api timed-out"
-      raise Api::Error::ApiError, "Request timed-out"
+      raise ApiBase::Errors::ApiError, 'Request timed-out'
+    end
+
+    def identifier
+      "#{service_name}:#{connection_name}"
     end
 
     protected
@@ -42,7 +41,7 @@ module ApiBase
       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?(Api::Error::ProcessingError)
+        raise error if error.is_a?(ApiBase::Errors::ProcessingError)
 
         handler.call(error)
       end
@@ -56,15 +55,11 @@ module ApiBase
     def validate_status_code(response)
       return if success_status_codes.include?(response.status)
 
-      raise Api::Error::ProcessingError, "Request failed with status: #{response.status}"
-    end
-
-    def success_status_codes
-      [200, 201]
+      raise ApiBase::Errors::ProcessingError, "Request failed with status: #{response.status}"
     end
 
     def filterer
-      @filterer ||= ActiveSupport::ParameterFilter.new sensitive_data_keys
+      @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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApiBase
-  VERSION = "0.1.1"
+  VERSION = '0.3.0'
 end

data/lib/api_base.rb

@@ -1,12 +1,14 @@
-require "api_base/version"
-require "api_base/base"
-require "api_base/behaviours/shared"
-require "api_base/behaviours/get_json"
-require "api_base/behaviours/post_json"
-require "api_base/models/api_log"
+# frozen_string_literal: true
 
-module ApiBase
-  class Error < StandardError; end
+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

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: api_base
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Stefan Froelich
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-27 00:00:00.000000000 Z
+date: 2022-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 6.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 6.0.3
 - !ruby/object:Gem::Dependency
   name: stoplight
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 3.0.0
 description: Building blocks for building API Clients
 email:
 - sfroelich01@gmail.com
@@ -59,26 +59,34 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- LICENSE.txt
+- MIT-LICENSE
 - README.md
 - Rakefile
-- api_base.gemspec
-- bin/console
-- bin/setup
+- 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/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/models/api_log.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
@@ -95,14 +103,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Building blocks for building API Clients

data/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-Gemfile.lock
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.1
-before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -1,7 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in api_base.gemspec
-gemspec
-
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 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/api_base.gemspec

@@ -1,33 +0,0 @@
-require_relative "lib/api_base/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "api_base"
-  spec.version = ApiBase::VERSION
-  spec.authors = ["Stefan Froelich"]
-  spec.email = ["sfroelich01@gmail.com"]
-
-  spec.summary = "Building blocks for building API Clients"
-  spec.description = spec.summary
-  spec.homepage = "https://github.com/ussd-engine/api-base"
-  spec.license = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = spec.homepage
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "rails", "~> 7"
-  spec.add_dependency "faraday", "~> 2"
-  spec.add_dependency "stoplight", "~> 3"
-end

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "api_base"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/api_base/models/api_log.rb

@@ -1,109 +0,0 @@
-# == 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"
-require "active_record"
-
-module ApiBase
-  module Models
-    class ApiLog < ActiveRecord::Base
-      attribute :sanitized, :boolean, default: false
-
-      validate :nothing_changed, unless: :new_record?
-      validate :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: 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: duration,
-                          response_body: response.body, response_headers: response.headers
-      end
-
-      def self.start_weekhook_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: 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 nothing_changed
-        errors.add(:base, "Record is read-only") if changed?
-      end
-
-      def 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
-end