Installation

Add this line to your application's Gemfile:

gem 'customer_score'

And then execute:

$ bundle

Or install it yourself as:

$ gem install customer_score

Usage

Require the gem

require 'customer_scoring'

To create a client instance, run this code:

client = CustomerScore::Client.new

To retrieve scoring advice for a customer based on their income, zipcode, and age, run this code:

score = client.get_score("5000", "60201", "35")
#=> "{:propensity => 0.26532, :ranking => "C"}"
```


## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/customer_score. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).