An open API service indexing awesome lists of open source software.

https://github.com/d6o/itibasicauth

Basic Auth Matcher to Itinerary Router
https://github.com/d6o/itibasicauth

go golang golang-library golang-package golang-router golang-tools http mux router

Last synced: 2 months ago
JSON representation

Basic Auth Matcher to Itinerary Router

Awesome Lists containing this project

README

        

# ItiBasicAuth ![Language Badge](https://img.shields.io/badge/Language-Go-blue.svg) ![Go Report](https://goreportcard.com/badge/github.com/DiSiqueira/ItiBasicAuth) ![License Badge](https://img.shields.io/badge/License-MIT-blue.svg) ![Status Badge](https://img.shields.io/badge/Status-Stable-brightgreen.svg)

ItiBasicAuth is a matcher to be used in the [Itinerary][itinerary].

ItiBasicAuth validates if the request are using valid credentials.

[itinerary]: https://github.com/DiSiqueira/Itinerary

## Project Status

ItiBasicAuth is stable. Pull Requests [are welcome](https://github.com/DiSiqueira/ItiBasicAuth#social-coding)

## Installation

### Go Get

```bash
$ go get github.com/DiSiqueira/itibasicauth
```

## Basic usage

```go
r := itinerary.NewRouter()

r.NewPath(BasicAuthHandler).AddMatcher(itibasicauth.New("disiqueira", "123"))
```

## Full Example

```go
package main

import (
"github.com/disiqueira/itinerary"
"net/http"
"github.com/disiqueira/itibasicauth"
)

func NoAuthHandler(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("This is a UnAuthenticated Request"))
}

func BasicAuthHandler(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("This is a Authenticated Request!!!"))
}

func main() {
r := itinerary.NewRouter()

r.NewPath(BasicAuthHandler).AddMatcher(itibasicauth.New("disiqueira", "123"))
r.NewPath(NoAuthHandler)

http.ListenAndServe(":8000", r)
}
```

## Contributing

### Bug Reports & Feature Requests

Please use the [issue tracker](https://github.com/DiSiqueira/ItiBasicAuth/issues) to report any bugs or file feature requests.

### Developing

PRs are welcome. To begin developing, do this:

```bash
$ git clone https://github.com/DiSiqueira/ItiBasicAuth.git itiwildcard
$ cd itiwildcard/
```

## Social Coding

1. Create an issue to discuss about your idea
2. [Fork it] (https://github.com/DiSiqueira/ItiBasicAuth/fork)
3. Create your feature branch (`git checkout -b my-new-feature`)
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Push to the branch (`git push origin my-new-feature`)
6. Create a new Pull Request
7. Profit! :white_check_mark:

## License

The MIT License (MIT)

Copyright (c) 2013-2017 Diego Siqueira

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.