<commit_before>#  gadafi gem

This gem is a simple wrapper around the gadafi url shortening service, available at http://gadaf.fi.

## Installation

As with most ruby gems, just type this on the command line.

    $ gem install gadafi

## Usage

It's a pretty simple gem - just paste in the url you want to short, and
it'll print the url for the short url to STDOUT:

    $ gadafi http://en.wikipedia.org/wiki/URL_shortening        # http://www.gadaf.fi/1

## TODO / Thoughts

* I largely created it as a an exercise to help me learn how to make gems using bundler, by following along this tutorial here by [radar][].
* I'm aware that this gem is a somewhat comical example of over-engineering - this could be accomplished much quicker by simply using an alias to curl for example, but the aim of this gem was learning how to make gems, rather than development minimalism :)
* It uses minitest instead of rspec for testing, but otherwise, I've tried to follow it fairly faithfully.
* I don't really expect any, but if you find this useful, I'd be happy to take feature requests, and pull requests.
* TODO use mocks with the tests
* TODO use a local storage of somekind to cache already queried urls

# Author

* [<NAME>][http://chrisadams.me.uk]


## License

[MIT LICENSE][./MIT-LICENCE]<commit_msg>Flesh out readme better.<commit_after>#  gadafi gem

This gem is a simple wrapper around the gadafi url shortening service, available at [http://gadaf.fi].

## Installation

As with most ruby gems, just type this on the command line.

    $ gem install gadafi

## Usage

It's a pretty simple gem - just paste in the url you want to shorten, and it'll print the url for the short url to STDOUT:

    $ gadafi http://en.wikipedia.org/wiki/URL_shortening        # http://www.gadaf.fi/1

## TODO / Thoughts

* I largely created it as a an exercise to help me learn how to make gems using bundler, by following along [this tutorial here][] by [radar][].
* I'm aware that this gem is a somewhat comical example of over-engineering - this could be accomplished much quicker by simply using an alias to curl for example, but the aim of this gem was learning how to make gems, rather than development minimalism :)
* It uses minitest instead of rspec for testing, but otherwise, I've tried to follow it fairly faithfully.
* I don't really expect any, but if you find this useful, I'd be happy to take feature requests, and pull requests.
* TODO use mocks with the tests to stop hitting an actual api endpoint.
* TODO use a local storage of some kind to cache already queried urls.  Suggestions welcome!


# Author

* [<NAME>][] 

## License

[MIT LICENSE][]

# Thanks 

[<NAME>][] - for making a cool url service in the first place
[Ryan Bigg][] (on github as [radar][]) - for making such a great guide to follow.

<!-- links -->

[<NAME>]: http://toffe.wordpress.com
[<NAME>]: http://chrisadams.me.uk
[this tutorial here]: https://github.com/radar/guides/blob/master/gem-development.md
[MIT LICENSE]: https://github.com/mrchrisadams/gadafi/blob/master/MIT-LICENSE
[Ryan Bigg]: https://github.com/radar
[radar]: https://github.com/radar

{'fraction_non_alphanumeric': 0.08759590792838874, 'fraction_numerical': 0.0006393861892583121, 'mean_word_length': 3.7844036697247705, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 4, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, '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': '7091634', 'n_tokens_mistral': 934, 'n_tokens_neox': 890, 'n_words': 445}