github.com/honeycombio/urlshaper
Package urlshaper creates a normalized shape (and other fields) from a URL. Given a URL or a URL Path (eg http://example.com/foo/bar?q=baz or just /foo/bar?q=baz) and an optional list of URL patterns, urlshaper will return an object that has that URL broken up in to its various components and provide a normalized shape of the URL. URL inputs to the urlshaper should be strings. They can be either fully qualified URLs or just the path. (Anything that the net/url parser can parse should be fine.) Valid URL inputs: Patterns should describe only the path section of the URL. Variable portions of the URL should be identified by a preceeding the section name with a colon (":"). To match additional sections after the pattern, include a terminal asterisk ("*") Valid patterns: If there is no error, the returned Result objected always has URI, Path, and Shape filled in. The remaining fields will have zero values if the corresponding sections of the URL are missing.
Readme
URL Shaper is a go library that takes a URL path and query and breaks it up into its components and creates a shape.
URL Shaper will generate a URL Shape by taking a URL and making a number of changes to it to make it easier to do analysis on URL patterns:
In addition to the URL shape, the Result object you get back from URL Shaper contains
Parameters in the path portion of the URL are identified by matching the URL against a list of provided patterns. Patterns are matched in the order provided; the first match wins. Patterns should represent the entire path portion of the URL - include a "*" at the end to match arbitrary additional segments.
input:
/about/en/books?isbn=123456&author=Aliceoutput:
/about/en/books?isbn=123456&author=Alice/about/en/booksisbn=123456&author=Alice{"isbn":["123456"],"author":["Alice"]}{}/about/en/books?author=?&isbn=?input:
/about/en/books/123456/about/:lang/books/:isbnoutput:
/about/en/books/123456/about/en/books/123456""{}{"lang":["en"],"isbn":["123456"]}/about/:lang/books/:isbninput:
/about/en/books?isbn=123456&author=Alice&isbn=987654/about/:lang/booksoutput:
/about/en/books?isbn=123456&author=Alice/about/en/booksisbn=123456&author=Alice{"isbn":["123456", "987654"],"author":["Alice"]}{"lang":["en"]}/about/:lang/books?author=?&isbn=?input:
/other/path/about/:lang/books, /docs/:sectionoutput:
/other/path/other/path""{}{}/other/pathinput:
-path /docs/quickstart/linux
-pattern /docs/:section/*
output:
/docs/quickstart/linux/docs/quickstart/linux""{}{"quickstart":["linux"]}/docs/:section/*FAQs
Package urlshaper creates a normalized shape (and other fields) from a URL. Given a URL or a URL Path (eg http://example.com/foo/bar?q=baz or just /foo/bar?q=baz) and an optional list of URL patterns, urlshaper will return an object that has that URL broken up in to its various components and provide a normalized shape of the URL. URL inputs to the urlshaper should be strings. They can be either fully qualified URLs or just the path. (Anything that the net/url parser can parse should be fine.) Valid URL inputs: Patterns should describe only the path section of the URL. Variable portions of the URL should be identified by a preceeding the section name with a colon (":"). To match additional sections after the pattern, include a terminal asterisk ("*") Valid patterns: If there is no error, the returned Result objected always has URI, Path, and Shape filled in. The remaining fields will have zero values if the corresponding sections of the URL are missing.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The June TC39 meeting wrapped up this week with eight proposals moving on to the next stage. Here's a quick roundup of the features that the committee approved to advance.
Security News
Cyber extortion in the US and Canada hit record levels in 2023, with ransomware attacks surging and median ransom demands skyrocketing, though fewer companies are choosing to pay ransoms.
Security News
Ecma TC39 is meeting this week and has moved key ECMAScript proposals forward, advancing Deferred Import Evaluation, Error.isError(), RegExp Escaping, and Promise.try to the next stages.