Data

Tools

Indexes

Applications

Experiments

Open Source Science

wsfn

Go package for standardize web service functionality across our library's go projects

https://github.com/caltechlibrary/wsfn

Science Score: 52.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ✓
    Institutional organization owner
    Organization caltechlibrary has institutional domain (www.library.caltech.edu)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (4.9%) to scientific vocabulary

Keywords

caltechlibrary web-service
Last synced: 9 months ago · JSON representation ·

Repository

Go package for standardize web service functionality across our library's go projects

Basic Info
Statistics
  • Stars: 2
  • Watchers: 6
  • Forks: 0
  • Open Issues: 0
  • Releases: 9
Topics
caltechlibrary web-service
Created over 8 years ago · Last pushed 10 months ago
Metadata Files
Readme License Citation Codemeta

README.md

wsfn

wsfn is a package for common web functions Caltech Library uses in various Golang based Caltech Library tools and services. The goal is to standardize our handling of web interactions.

  • wsfn.CORSPolicy is a structure for adding CORS headers to a http Handler
  • StaticRouter is a http Handler Function for working with static routes
  • RedirectRouter handles simple target prefix, destination prefix redirect handling
    • AddRedirectRoute adds a target prefix and destination prefix
    • HasRedirectRoutes return true if any redirect routes are configured
    • RedirectRouter uses the internal redirect data to handle redirects
  • ReverseProxy router lets front other web services.

An example webserver is also provided to demonstrate some of the functionality available with this package. The webserver is intended for instructional purposes only and shouldn't be used in a production setting.

Owner

  • Name: Caltech Library
  • Login: caltechlibrary
  • Kind: organization
  • Email: helpdesk@library.caltech.edu
  • Location: Pasadena, CA 91125

We manage the physical and digital holdings of the California Institute of Technology, provide services and training, and develop open-source software.

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
type: software
title: wsfn
abstract: "A golang package providing simple static http services."
authors:
  - family-names: Doiel
    given-names: R. S.
    orcid: https://orcid.org/0000-0003-0900-6903
    email: rsdoiel@caltech.edu

contacts:
  - family-names: 
    given-names: 

repository-code: "https://github.com/caltechlibrary/wsfn"
version: 0.0.13
date-released: 2025-04-14

license-url: "https://caltechlibrary.github.io/wsfn/LICENSE"
keywords:
  - go
  - web service

CodeMeta (codemeta.json) 

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "type": "SoftwareSourceCode",
  "codeRepository": "https://github.com/caltechlibrary/wsfn",
  "author": [
    {
      "id": "https://orcid.org/0000-0003-0900-6903",
      "type": "Person",
      "givenName": "R. S.",
      "familyName": "Doiel",
      "affiliation": "Caltech Library",
      "email": "rsdoiel@caltech.edu"
    }
  ],
  "maintainer": [
    {
      "type": "Person",
      "name": "https://orcid.org/0000-0003-0900-6903"
    }
  ],
  "dateModified": "2025-04-14",
  "datePublished": "2025-04-14",
  "description": "A golang package providing simple static http services.",
  "keywords": [
    "go",
    "web service"
  ],
  "name": "wsfn",
  "license": "https://caltechlibrary.github.io/wsfn/LICENSE",
  "programmingLanguage": [
    "Go"
  ],
  "softwareRequirements": [
    "Go >= 1.24.2",
    "GNU Make > 3",
    "Pandoc >= 3.1",
    "CMTools >= 0.0.23"
  ],
  "version": "0.0.13",
  "developmentStatus": "active",
  "issueTracker": "https://github.com/caltechlibrary/wsfn/issues",
  "downloadUrl": "https://github.com/caltechlibrary/wsfn/releases",
  "releaseNotes": "This is a maintenance release compiled with Go version 1.24.2 and updated dependencies.",
  "copyrightYear": 2025,
  "copyrightHolder": [
    "California Institute of Technology"
  ]
}

GitHub Events

Total
  • Release event: 2
  • Delete event: 1
  • Push event: 21
  • Pull request event: 2
  • Create event: 2
Last Year
  • Release event: 2
  • Delete event: 1
  • Push event: 21
  • Pull request event: 2
  • Create event: 2

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 0
  • Total pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 18 days
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 1.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • dependabot[bot] (3)
Top Labels
Issue Labels
Pull Request Labels
dependencies (3) go (1)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 1
  • Total dependent repositories: 0
  • Total versions: 10
proxy.golang.org: github.com/caltechlibrary/wsfn

Package wsfn provides a common library of functions and structures for working with web services in Caltech Library projects and software. @author R. S. Doiel, <rsdoiel@caltech.edu> Copyright (c) 2021, Caltech All rights not granted herein are expressly reserved by Caltech Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

  • Versions: 10
  • Dependent Packages: 1
  • Dependent Repositories: 0
Rankings
Dependent packages count: 4.6%
Average: 7.0%
Dependent repos count: 9.3%
Last synced: 10 months ago

Dependencies

go.mod go
  • github.com/BurntSushi/toml v0.3.1
  • github.com/caltechlibrary/cli v0.0.16
  • golang.org/x/crypto v0.0.0-20201221181555-eec23a3978ad
go.sum go
  • github.com/BurntSushi/toml v0.3.1
  • github.com/caltechlibrary/cli v0.0.16
  • golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2
  • golang.org/x/crypto v0.0.0-20201221181555-eec23a3978ad
  • golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3
  • golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a
  • golang.org/x/sys v0.0.0-20191026070338-33540a1f6037
  • golang.org/x/term v0.0.0-20201117132131-f5c789dd3221
  • golang.org/x/text v0.3.0