hcfilters

README

hcfilters

😄 filters for github.com/gregjones/httpcache

Usage

$ go get -u moul.io/hcfilters

// before
client := &http.Client{
	Transport: httpcache.NewTransport(
		diskcache.New(diskcachePath),
	),
}

// after
client := &http.Client{
	Transport: httpcache.NewTransport(
		hcfilters.MaxSize( // skip caching results > 2Mb
			diskcache.New(diskcachePath),
			2*1024*1024,
		),
	),
}

License

© 2020 Manfred Touron

Licensed under the Apache License, Version 2.0 (LICENSE-APACHE) or the MIT license (LICENSE-MIT), at your option. See the COPYRIGHT file for more details.

SPDX-License-Identifier: (Apache-2.0 OR MIT)

Documentation

Overview

Package hcfilters provides filtering middlewares for github.com/gregjones/httpcache.

message from the author:

+--------------------------------------------------------------+
| * * * ░░░░░░░░░░░░░░░░░░░░  Hello  ░░░░░░░░░░░░░░░░░░░░░░░░░░|
+--------------------------------------------------------------+
|                                                              |
|     ++              ______________________________________   |
|     ++++           /                                      \  |
|      ++++          |                                      |  |
|    ++++++++++      |   Feel free to contribute to this    |  |
|   +++       |      |       project or contact me on       |  |
|   ++         |     |    manfred.life if you like this     |  |
|   +  -==   ==|     |               project!               |  |
|  (   <*>   <*>     |                                      |  |
|   |          |    /|                  :)                  |  |
|   |         _)   / |                                      |  |
|   |      +++    /  \______________________________________/  |
|    \      =+   /                                             |
|     \      +                                                 |
|     |\++++++                                                 |
|     |  ++++      ||//                                        |
|  ___|   |___    _||/__                                     __|
| /    ---    \   \|  |||                   __ _  ___  __ __/ /|
|/  |       |  \    \ /                    /  ' \/ _ \/ // / / |
||  |       |  |    | |                   /_/_/_/\___/\_,_/_/  |
+--------------------------------------------------------------+

This is how to wrap an existing backend:

before:

    client := &http.Client{
        Transport: httpcache.NewTransport(
	       diskcache.New(diskcachePath),
        ),
    }

after:

client := &http.Client{
    Transport: httpcache.NewTransport(
        hcfilters.MaxSize( // skip caching results > 2Mb
            diskcache.New(diskcachePath),
            2*1024*1024,
        ),
    ),
}

Index

• type Cache
  • func MaxSize(next Cache, limit int) Cache
  • func MinSize(next Cache, limit int) Cache

Types

type Cache

type Cache interface {
	// Get returns the []byte representation of a cached response and a bool
	// set to true if the value isn't empty
	Get(key string) (responseBytes []byte, ok bool)
	// Set stores the []byte representation of a response against a key
	Set(key string, responseBytes []byte)
	// Delete removes the value associated with the key
	Delete(key string)
}

Cache is a clone of the httpcache.Cache struct to avoid having a dependency on the original repo

func MaxSize

func MaxSize(next Cache, limit int) Cache

MaxSize filters file that are too big to be cached

func MinSize

func MinSize(next Cache, limit int) Cache

MinSize filters file that are too small to be cached