Contents

# ConsumerScore

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/consumer_score`. To experiment with that code, run `bin/console` for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'consumer_score_naj'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install consumer_score_naj

## Usage

To fetch a customer score based on income, zipcode, and age:
```ruby
Consumer::Score.get_score({income: 5000, zipcode: 60201, age: 50})
```
Should return 'propensity' and 'ranking' values, in the form of a JSON response:
```ruby
  => {"propensity"=>0.31175, "ranking"=>"C"}
```
Will only provide a successful response with all three values (income, zipcode, age)
Otherwise, API will ask for more information:

```ruby
  => {"message"=>"Please provide income, zipcode, and age for successful response."}
```

## Dependencies

```ruby
  "bundler", "~> 1.14"
  "rake", "~> 10.0"
  "rspec", "~> 3.0"
  "unirest", "1.1.2"

  ruby "2.4.0"
```

## 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](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/mrjonesbot/consumer_score.


## License

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

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
consumer_score_naj-0.5.0	README.md