ljoyce_customer_scoring 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0864a6d6df336b822936c8329a698d38486794a
+  data.tar.gz: ce03e83ed023776291d0908d9591f9f9d9133b93
+SHA512:
+  metadata.gz: 9980c3b21762dca3f2f79bca515ec841e03f20b552355f3a98d95b94c40a5f5c8b6a83a19d5d982df6d607f5d1426d235ee0d8d50dd3414abfe600969f8696b6
+  data.tar.gz: 7e83caeebe517431c93c4ca562f850ea8105f555e674d2bbed575028e85629621b0a01dd3a2eec3a51f17ec0de587b4794e62954c3b914d3389493362d18de7e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at joycelc4186@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ljoyce_customer_scoring.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Lauren Joyce
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# 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:
+
+```ruby
+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](https://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](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ljoyce_customer_scoring"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ljoyce_customer_scoring/version.rb

@@ -0,0 +1,3 @@
+module LjoyceCustomerScoring
+  VERSION = "0.1.0"
+end

data/lib/ljoyce_customer_scoring.rb

@@ -0,0 +1,44 @@
+require "ljoyce_customer_scoring/version"
+require "unirest"
+
+module LjoyceCustomerScoring
+  class Analysis
+    attr_reader :propensity, :ranking
+    # Creates an instance of the Analysis class, which assigns values to instance variables @propensity and @ranking based on the input hash
+    def initialize(input)
+      @propensity = input["propensity"]
+      @ranking = input["ranking"]
+    end
+
+    def self.request(request_parameters)
+      # If request_parameters is meets the following argument requirements
+      if request_parameters.class == Hash &&
+         request_parameters[:income] &&
+         request_parameters[:zipcode] &&
+         request_parameters[:age] &&
+         request_parameters[:income] > 0 &&
+         request_parameters[:zipcode].to_s.length == 5 &&
+         request_parameters[:age] > 0
+        # Using a mock api endpoint
+        mock_api = "http://www.mocky.io/v2/58b906ee0f00006706f09b9b"
+        data = Unirest.get(
+          "#{mock_api}?
+          income=#{request_parameters[:income]}&
+          zipcode=#{request_parameters[:zipcode]}&
+          age=#{request_parameters[:age]}"
+        ).body
+        # Use this hash to instantiate Analysis – Analysis.initialize(request_result), which returns instance variables @propensity and @ranking
+        request_result = {
+          "propensity" => data[0]["propensity"],
+          "ranking" => data[0]["ranking"]
+        }
+        analysis = Analysis.new(request_result)
+        return analysis
+      else
+        # If request_parameter is invalid
+        invalid_request_message = "Invalid request: must include valid request parameters for income, zipcode, age."
+        return invalid_request_message
+      end
+    end
+  end
+end

data/ljoyce_customer_scoring.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ljoyce_customer_scoring/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ljoyce_customer_scoring"
+  spec.version       = LjoyceCustomerScoring::VERSION
+  spec.authors       = ["Lauren Joyce"]
+  spec.email         = ["joycelc4186@gmail.com"]
+
+  spec.summary       = %q{Mock consumer scoring}
+  spec.description   = %q{Returns consumer propensity and ranking JSON data based on income, zipcode, and age.}
+  spec.homepage      = "https://github.com/laurenjoyce/ljoyce_customer_scoring"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "unirest", "~> 1.1.2"
+
+  spec.required_ruby_version = '~> 2.2.0'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: ljoyce_customer_scoring
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lauren Joyce
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: unirest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+description: Returns consumer propensity and ranking JSON data based on income, zipcode,
+  and age.
+email:
+- joycelc4186@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ljoyce_customer_scoring.rb
+- lib/ljoyce_customer_scoring/version.rb
+- ljoyce_customer_scoring.gemspec
+homepage: https://github.com/laurenjoyce/ljoyce_customer_scoring
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Mock consumer scoring
+test_files: []