https://github.com/locaweb/heartcheck-cas

Provides cas checker for heartcheck
https://github.com/locaweb/heartcheck-cas

hacktoberfest

Last synced: about 2 months ago
JSON representation

Provides cas checker for heartcheck

• Host: GitHub
• URL: https://github.com/locaweb/heartcheck-cas
• Owner: locaweb
• License: mit
• Created: 2015-07-07T21:16:43.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2021-10-27T22:16:02.000Z (about 3 years ago)
• Last Synced: 2024-04-24T05:58:45.980Z (9 months ago)
• Topics: hacktoberfest
• Language: Ruby
• Homepage:
• Size: 21.5 KB
• Stars: 0
• Watchers: 15
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Heartcheck::Cas

[![Build Status](https://github.com/locaweb/heartcheck-cas/actions/workflows/ci.yml/badge.svg)](https://github.com/locaweb/heartcheck-cas/actions/workflows/ci.yml)

[![Code Climate](https://codeclimate.com/github/locaweb/heartcheck-cas/badges/gpa.svg)](https://codeclimate.com/github/locaweb/heartcheck-cas)

A plugin to check CAS accessibility connection with [heartcheck](https://github.com/locaweb/heartcheck).

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'heartcheck-cas'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install heartcheck-cas

## Usage

You can check any CAS credentials that there's in your app.

```ruby

Heartcheck.setup do |config|

  config.add :cas do |c|

    c.add_service({

        service: 'locaweb',

        username: 'username',

        password: 'password',

        server: 'https://path-to-cas-server/v1/tickets'

    })

  end

end

```

**Check Heartcheck example** [here](https://github.com/locaweb/heartcheck/blob/master/lib/heartcheck/generators/templates/config.rb)

## Development setup using Docker

The Docker Hearthcheck-Cas provides a container with the current stable version of Ruby released and requires you to have these tools available in your local environment:

*   [Docker](https://docs.docker.com/get-docker/)

*   [Docker Compose](https://docs.docker.com/compose/install/)

*   [Bash](https://www.gnu.org/software/bash/)

#### BootStrap Script to run the dockerized environment

 ```bash

 ./scripts/heartcheck-cas setup

 ```

 Run the command `./scripts/heartcheck-cas -h` to see available options.

## Contributing

1.  [Fork it](https://github.com/locaweb/heartcheck-cas/fork)

2.  Create your feature branch ( **git checkout -b my-new-feature** )

3.  Commit your changes ( **git commit -am 'Add some feature'** )

4.  Push to the branch ( **git push origin my-new-feature** )

5.  Create a new Pull Request

## License

*   [MIT License](https://github.com/locaweb/heartcheck-cas/blob/master/LICENSE.txt)