LjoyceCustomerScoring

This gem will return propensity and ranking data based on a consumer's income, zipcode, and age.

Requirements

Ruby version 2.2.0

Installation

Add this line to your application's Gemfile:

gem 'ljoyce_customer_scoring'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ljoyce_customer_scoring

Usage

request = LjoyceCustomerScoring::Analysis.request(income: 50000, zipcode: 60201, age: 35)

request.propensity => 0.26532

request.ranking => "C"

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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.

Unit Testing

This gem includes an RSPEC test suite:

  • Clone github repo
  • Cd into gem folder
  • Run 'bundle exec rspec' in your terminal

Note: The 'invalid request' test fails when using the mock API, as the mock API won't take in an argument for parameters. Test will pass with an API enpoint that accepts parameters

License

The gem is available as open source under the terms of the MIT License.