<commit_before># Headquarters

Ruby wrapper for the [headquarters
API](https://github.com/groupbuddies/headquarters)

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'headquarters'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install headquarters

## Usage

TODO: Write usage instructions here

## Contributing

1. Fork it ( https://github.com/[my-github-username]/headquarters/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<commit_msg>Better README<commit_after># Headquarters

Ruby wrapper for the [headquarters API](https://github.com/groupbuddies/headquarters)

# Usage

Add this line to your application's Gemfile:

```ruby
gem 'headquarters'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install headquarters

## Configuration

You can set the API's base endpoint and port:

```ruby
Headquarters.api_base = "0.0.0.0"
Headquarters.api_port = 3000
```

### Logging

Out of the box headquarters-ruby will log all requests and responses to `STDOUT`, you
can use any logger you want, though:

    Headquarters.logger = Logger.new(STDERR)

## Members

To retrieve a collection of all members of the team you might use the `all`
operation:

    Headquarters::Member.all

### Internal

There is some extra info protected with basic authentication. In order to get it
you must first add the credentials to you `.env` file:

```
BASIC_AUTH_USER=some-username
BASIC_AUTH_PASS=<PASSWORD>
```

Now you may use the `all_internal` operation:

    Headquarters::Member.all_internal

# Testing

To run the tests (including style tests with Rubucop) install all the
dependencies and run the default rake task:

```
bundle install
bundle exec rake
```

# Contributing

1. Fork it ( https://github.com/[my-github-username]/headquarters/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
{'fraction_non_alphanumeric': 0.09863636363636363, 'fraction_numerical': 0.008181818181818182, 'mean_word_length': 4.252983293556086, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 1, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2287978', 'n_tokens_mistral': 695, 'n_tokens_neox': 641, 'n_words': 263}