<commit_before>BadBill - Billomat API Client
===================

(developed for internal use at [rrbone](http://www.rrbone.net))

Simple but working API client for the [Billomat API][apidocu].

See the [API documentation][apidocu] for full documentation of all resources.

## Features

* Fast and easy access to all resources the API provides
  (not all resources are Ruby classes, yet)
* Full documentation.
* Test coverage as best as I can.
* Production-ready (it's for a job project).

## What's working right now

The basic BadBill class allows access to all resources. It includes no syntactic sugar to work with, instead it just returns the data as a hash. This works for basic usage.

The following resources are currently implemented as its own class:

* [clients](http://www.billomat.com/en/api/clients/) (`BadBill::Client`)
* [invoices](http://www.billomat.com/en/api/invoices/) (`BadBill::Invoice`)
* [invoice-payments](http://www.billomat.com/en/api/invoices/payments/) (`BadBill::InvoicePayment`)
* [invoice-items](http://www.billomat.com/en/api/invoices/items/) (`BadBill::InvoiceItem`)
* [recurring](http://www.billomat.com/en/api/recurrings/) (`BadBill::Recurring`)

Implementing new resources is easy. Pull Requests for others are welcome.

## Requirements

* [yajl-ruby](https://github.com/brianmario/yajl-ruby)
* [faraday](https://github.com/technoweenie/faraday)
* [faraday_middleware](https://github.com/pengwynn/faraday_middleware)
* [hashie](https://github.com/intridea/hashie)

## Installation

BadBill is just a `gem install badbill` away. Get an API key for the Billomat API on your profile page.

## Examples

### Basic Usage<commit_msg>List InvoiceComment in README.<commit_after>BadBill - Billomat API Client
===================

(developed for internal use at [rrbone](http://www.rrbone.net))

Simple but working API client for the [Billomat API][apidocu].

See the [API documentation][apidocu] for full documentation of all resources.

## Features

* Fast and easy access to all resources the API provides
  (not all resources are Ruby classes, yet)
* Full documentation.
* Test coverage as best as I can.
* Production-ready (it's for a job project).

## What's working right now

The basic BadBill class allows access to all resources. It includes no syntactic sugar to work with, instead it just returns the data as a hash. This works for basic usage.

The following resources are currently implemented as its own class:

* [clients](http://www.billomat.com/en/api/clients/) (`BadBill::Client`)
* [invoices](http://www.billomat.com/en/api/invoices/) (`BadBill::Invoice`)
* [invoice-payments](http://www.billomat.com/en/api/invoices/payments/) (`BadBill::InvoicePayment`)
* [invoice-items](http://www.billomat.com/en/api/invoices/items/) (`BadBill::InvoiceItem`)
* [invoice-comments](http://www.billomat.com/en/api/invoices/comments) (`BadBill::InvoiceComment`)
* [recurring](http://www.billomat.com/en/api/recurrings/) (`BadBill::Recurring`)

Implementing new resources is easy. Pull Requests for others are welcome.

## Requirements

* [yajl-ruby](https://github.com/brianmario/yajl-ruby)
* [faraday](https://github.com/technoweenie/faraday)
* [faraday_middleware](https://github.com/pengwynn/faraday_middleware)
* [hashie](https://github.com/intridea/hashie)

## Installation

BadBill is just a `gem install badbill` away. Get an API key for the Billomat API on your profile page.

## Examples

### Basic Usage
{'fraction_non_alphanumeric': 0.1416134648868253, 'fraction_numerical': 0.0, 'mean_word_length': 4.994782608695652, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 8, 'lorem ipsum': 0, 'www.': 13, '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': '3030897', 'n_tokens_mistral': 1137, 'n_tokens_neox': 1068, 'n_words': 318}