<commit_before># Gfw API Client

[![Build Status](https://travis-ci.org/Vizzuality/gfw-ruby-client-library.svg)](https://travis-ci.org/Vizzuality/gfw-ruby-client-library) [![Coverage Status](https://coveralls.io/repos/Vizzuality/gfw-ruby-client-library/badge.svg)](https://coveralls.io/r/Vizzuality/gfw-ruby-client-library) [![Code Climate](https://codeclimate.com/github/Vizzuality/gfw-ruby-client-library/badges/gpa.svg)](https://codeclimate.com/github/Vizzuality/gfw-ruby-client-library) [![Inline docs](http://inch-ci.org/github/Vizzuality/gfw-ruby-client-library.svg?branch=master)](http://inch-ci.org/github/Vizzuality/gfw-ruby-client-library)

A Ruby Client library for the [GFW-API](https://github.com/wri/gfw-api). For now this library should not be used for any production apps.

## Requirements and Known Limitations

Tested with Ruby 2.0.0, 2.1.0, 2.2.0, JRuby (1.9 mode)

Requires Rails >= 4.0

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'gfw_api_client'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install gfw_api_client

Make the following constants, in config/gfw.yaml file:
<commit_msg>Add current version to readme file<commit_after># Gfw API Client

[![Gem Version](https://badge.fury.io/rb/gfw_api_client.svg)](http://badge.fury.io/rb/gfw_api_client)[![Build Status](https://travis-ci.org/Vizzuality/gfw-ruby-client-library.svg)](https://travis-ci.org/Vizzuality/gfw-ruby-client-library) [![Coverage Status](https://coveralls.io/repos/Vizzuality/gfw-ruby-client-library/badge.svg)](https://coveralls.io/r/Vizzuality/gfw-ruby-client-library) [![Code Climate](https://codeclimate.com/github/Vizzuality/gfw-ruby-client-library/badges/gpa.svg)](https://codeclimate.com/github/Vizzuality/gfw-ruby-client-library) [![Inline docs](http://inch-ci.org/github/Vizzuality/gfw-ruby-client-library.svg?branch=master)](http://inch-ci.org/github/Vizzuality/gfw-ruby-client-library)

A Ruby Client library for the [GFW-API](https://github.com/wri/gfw-api). For now this library should not be used for any production apps.

## Requirements and Known Limitations

Tested with Ruby 2.0.0, 2.1.0, 2.2.0, JRuby (1.9 mode)

Requires Rails >= 4.0

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'gfw_api_client'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install gfw_api_client

Make the following constants, in config/gfw.yaml file:

{'fraction_non_alphanumeric': 0.15798045602605862, 'fraction_numerical': 0.010586319218241042, 'mean_word_length': 4.740654205607477, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 15, 'lorem ipsum': 0, 'www.': 0, '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': '1235117', 'n_tokens_mistral': 947, 'n_tokens_neox': 871, 'n_words': 160}