api_base 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f7c64a64a166f1c8b54d6d06d7d390c42d38166dead3e70574097cc98f7c1553
+  data.tar.gz: 62c43b1db2628f41c1817e1f2700eaf9b4cf38e6ec94ec77fd4620e6a37e7f7b
+SHA512:
+  metadata.gz: 737062be042509aa0ea003d0327ed429614a4aa068555392c8d7c48bf73e2551dccdbfba6ea54c13174354ef88de669b1bc9df26eaefef88ed12463f3adbe010
+  data.tar.gz: 1e9bc490d4c224c55bbb2b0f086d235601bebdc99e0ab6b3907d4ca7da9d7c6931b6b924c7a28f59f1b442bf3e7adbb20220a88a5bd4b3378385a4b6ad05a1f9

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,21 @@
+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/README.md

@@ -0,0 +1,40 @@
+# ApiBase
+
+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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'api_base'
+```
+
+And then execute:
+
+    $ bundle install
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/api_base.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/api_base.gemspec

@@ -0,0 +1,33 @@
+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

@@ -0,0 +1,14 @@
+#!/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

@@ -0,0 +1,8 @@
+#!/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/db/migrate/20220612165032_create_api_logs.rb

@@ -0,0 +1,20 @@
+class CreateApiLogs < ActiveRecord::Migration[6.0]
+  def change
+    create_table :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/base.rb

@@ -0,0 +1,70 @@
+require "active_support"
+require "faraday"
+require "stoplight"
+require "api_base/concerns/traceable"
+require "api_base/concerns/filterer"
+
+module ApiBase
+  class Base
+    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
+
+    rescue_from Stoplight::Error::RedLight do
+      Rails.logger.warn "#{identifier} api circuit is closed"
+      raise Api::Error::ApiError, "Circuit broken"
+    end
+
+    rescue_from Faraday::TimeoutError do
+      Rails.logger.warn "#{identifier} api timed-out"
+      raise Api::Error::ApiError, "Request timed-out"
+    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?(Api::Error::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 Api::Error::ProcessingError, "Request failed with status: #{response.status}"
+    end
+
+    def success_status_codes
+      [200, 201]
+    end
+
+    def filterer
+      @filterer ||= ActiveSupport::ParameterFilter.new sensitive_data_keys
+    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 = Models::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/models/api_log.rb

@@ -0,0 +1,109 @@
+# == 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

data/lib/api_base/version.rb

@@ -0,0 +1,3 @@
+module ApiBase
+  VERSION = "0.1.1"
+end

data/lib/api_base.rb

@@ -0,0 +1,12 @@
+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"
+
+module ApiBase
+  class Error < StandardError; end
+
+  # Your code goes here...
+end

metadata

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