gitlab-client-cache 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20d4daf1d7e01d29ee5eaaf8b1edd660ce52ec89148bfc51e8daf9908909165b
+  data.tar.gz: 9969132bc7cd53b70c5f4602afa9c17817c18177403bb17fbd77b743def7da3d
+SHA512:
+  metadata.gz: 02a47cb4bc8b35df3b71e1175b3df13b98044fdaf4ebc2e76a6961261490e6954e83513e68233902c16390ee0f0a32081b1fd024495b8fc99bff494dff62bebd
+  data.tar.gz: 3807c92653c2c9222b8f49f914ca52f1966782f4bc8be43278d4e9c3c6ed7e4280cf0815a28527314eb2671859adfcf5b59dc6b0a2b1e7e39100ff0dcae4f759

data/lib/gitlab/client/cache/caching.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "cgi"
+require "json"
+require "pathname"
+
+class Gitlab::Client::Cache::Caching
+  PATH_PATTERN = /^(..)(..)(.*)$/
+
+  def initialize(config)
+    @config = config
+  end
+
+  def cached(http_path, http_params)
+    path = path_to(http_path, http_params)
+
+    if path.exist? && path_fresh?(path)
+      load(path)
+    else
+      dump(path, yield)
+    end
+  end
+
+  private
+
+  def path_fresh?(path)
+    return true unless @config.expires_in
+
+    path.mtime + @config.expires_in >= Time.now
+  end
+
+  def load(path)
+    Marshal.load(inflate(path.read))
+  end
+
+  def inflate(content)
+    return content unless @config.compression
+
+    klass, *_params = Array(@config.compression)
+
+    Object.const_get(klass).inflate(content)
+  end
+
+  def dump(path, response)
+    path.dirname.mkpath
+    path.write(deflate(Marshal.dump(response)))
+
+    response
+  end
+
+  def deflate(content)
+    return content unless @config.compression
+
+    klass, *params = Array(@config.compression)
+
+    if params
+      Object.const_get(klass).deflate(content, *params)
+    else
+      Object.const_get(klass).deflate(content)
+    end
+  end
+
+  def path_to(http_path, http_params)
+    params = clean_params(http_params)
+    plain = JSON.generate([http_path, params])
+    key = Digest::SHA256.hexdigest(plain)
+
+    parts = [
+      @config.cache_root,
+      clean_path(@config.scope),
+      *PATH_PATTERN.match(key).captures
+    ].compact
+
+    Pathname.new(parts.join("/"))
+  end
+
+  def clean_params(params)
+    params = params.dup
+    params.delete(:logger)
+    params.delete(:log_level)
+
+    params
+  end
+
+  def clean_path(path)
+    CGI.escape(path)
+       .gsub(".", "_")
+  end
+end

data/lib/gitlab/client/cache/config.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Gitlab::Client::Cache
+  Config = Struct.new(:cache_root, :scope, :compression, :expires_in, keyword_init: true) do
+    def self.build
+      new(
+        cache_root: default_cache_root,
+        scope: default_scope,
+        compression: default_compression,
+        expires_in: default_expires_in
+      )
+    end
+
+    def self.default_cache_root
+      root = ENV.fetch("GITLAB_CLIENT_CACHE_ROOT", nil)
+      root ||= if ENV.key?("XDG_CACHE_HOME")
+                 File.join(ENV.fetch("XDG_CACHE_HOME"), Process.uid.to_s)
+               else
+                 File.join(File.realpath(Dir.home), ".cache")
+               end
+
+      File.join(root, "gitlab-cache")
+    end
+
+    def self.default_scope
+      ENV.fetch("GITLAB_CLIENT_CACHE_SCOPE", File.basename($PROGRAM_NAME))
+    end
+
+    def self.default_compression
+      "Zlib"
+    end
+
+    def self.default_expires_in
+      value = ENV.fetch("GITLAB_CLIENT_CACHE_EXPIRES_IN_SECONDS", nil)
+      day = 24 * 60 * 60
+
+      Integer(value || day)
+    end
+  end
+end

data/lib/gitlab/client/cache/patch.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Gitlab::Client::Cache::Patch
+  def get(path, params = {})
+    Gitlab::Client::Cache::Caching.new(Gitlab::Client::Cache.config).cached(path, params) { super }
+  end
+end
+
+Gitlab::Request.singleton_class.prepend(Gitlab::Client::Cache::Patch)

data/lib/gitlab/client/cache/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GitlabClientCache
+  VERSION = "0.0.1"
+end

data/lib/gitlab/client/cache.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "digest/sha2"
+
+require_relative "cache/version"
+require_relative "cache/config"
+require_relative "cache/caching"
+require_relative "cache/patch"
+
+module Gitlab::Client::Cache
+  VERSION = GitlabClientCache::VERSION
+
+  # Performs caching for `gitlab` gem.
+  def self.config
+    @config ||= Config.build
+  end
+
+  def self.configure
+    yield config if block_given?
+
+    nil
+  end
+end

data/lib/gitlab-client-cache.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "gitlab/client/cache"

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: gitlab-client-cache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Leitzen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gitlab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Store fetched responses locally.
+email:
+- peter@leitzen.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/gitlab-client-cache.rb
+- lib/gitlab/client/cache.rb
+- lib/gitlab/client/cache/caching.rb
+- lib/gitlab/client/cache/config.rb
+- lib/gitlab/client/cache/patch.rb
+- lib/gitlab/client/cache/version.rb
+homepage: https://gitlab.com/splatteal/gitlab-client-cache
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/splatteal/gitlab-client-cache
+  source_code_uri: https://gitlab.com/splatteal/gitlab-client-cache
+  changelog_uri: https://gitlab.com/splatteal/gitlab-client-cache
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: Response cache for `gitlab` gem
+test_files: []