scorekeeper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f4ae93b5375ed62e6fe73b327771bcd7a4b9a4e2
+  data.tar.gz: 886db77fce74a0ea95387626af271f93f6c64a3a
+SHA512:
+  metadata.gz: 3e7fcc6bf4cc648bf54dad5fb37739b33e488122e80b8332fb0e0087c9c5fcab6ca91628c964fc5e85abbfa2695e6bc9720315e714c4feb51e04a3cb7e097335
+  data.tar.gz: dd0847b70e6b348bc918ce6ef9fb07e69591be570f28b5e3d3e05056837bfae3774a4c6d6209a39fcb82f5951d401446c9ef8755ecbc8f6a16a7e1df402764be

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.3.1
+before_install: gem install bundler -v 1.13.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 gardoroman
+
+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,44 @@
+# Scorekeeper
+[![Build Status](https://travis-ci.org/gardoroman/scorekeeper.svg?branch=master)](https://travis-ci.org/gardoroman/scorekeeper)
+This is gem is a library built for an anonymous company called the Jumping Amphibian.
+The library integrates an API which scores a consumer based on the consumer's income, zipcode, and age.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'scorekeeper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scorekeeper
+
+## Usage
+
+*Dependencies*
+
+* Tested with Ruby 2.3.1 (has not been tested with other versions)
+* JSON
+* HTTParty
+
+## 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/gardoroman/scorekeeper.
+
+
+## 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 "scorekeeper"
+
+# 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/scorekeeper.rb

@@ -0,0 +1,7 @@
+require "scorekeeper/version"
+require "scorekeeper/customer_scoring"
+require "scorekeeper/error_types"
+
+module Scorekeeper
+  # Your code goes here...
+end

data/lib/scorekeeper/customer_scoring.rb

@@ -0,0 +1,80 @@
+module Scorekeeper
+
+  require 'httparty'
+  require 'json'
+
+  class CustomerScoring
+
+    BASE_URL = "http://not_real.com/customer_scoring"
+    NUM_PATTERN = /\D/
+
+    attr_reader :income, :zipcode, :age
+
+    # initialize object with args containing income, zipcode, and age
+    def initialize(args={})
+      @income = args.fetch(:income, nil)
+      @zipcode = args.fetch(:zipcode, nil)
+      @age = args.fetch(:age, nil)
+      validate_paramters
+      check_values
+    end
+
+    # calls make_request method to ensure there are no errors. Returns response from API call.
+    def search
+      response = make_request
+      begin
+        response_hash = JSON.parse(response.body)
+      rescue JSON::ParserError
+        raise RequestException
+      else
+        response_hash
+      end
+    end
+
+    private
+
+    # Handles call to API. It will return a response if successful otherwise it will raise an error.
+    def make_request
+      query = {'income': @income, 'zipcode': @zipcode, 'age': @age}
+      begin
+        response = HTTParty.get(BASE_URL, query: query)
+      # I know I can do better than this
+      rescue Exception => e
+        raise RequestException
+      else
+        response
+      end
+    end
+
+    # ensures that the necessary parameters were passed in and that values conform to parameters required by API
+    def validate_paramters
+      raise Scorekeeper::MissingParameterException if @income.nil? || @zipcode.nil? || @age.nil?
+    end
+
+    # ensures that valid values are passed
+    def check_values
+      check_numericity
+      check_zip_code
+    end
+
+    #ensures that income and age are numeric passes pattern that checks to see if there is a non-digit or negative number. If so the pattern match will not be nil and an error will be raised
+    def check_numericity
+      check_patterns(@income.to_s)
+      check_patterns(@age.to_s)
+    end
+
+    # ensures that zip code is all digits and that length is equal to 5
+    def check_zip_code
+      zip_string = @zipcode.to_s
+      raise InvalidParameterException if zip_string.size != 5
+      # raise InvalidParameterException if (@zipcode.to_s =~ pattern)
+      check_patterns(zip_string)
+    end
+
+    def check_patterns(number)
+      raise InvalidParameterException unless (number =~ NUM_PATTERN).nil?
+    end
+
+
+  end
+end

data/lib/scorekeeper/error_types.rb

@@ -0,0 +1,9 @@
+module Scorekeeper
+
+  class MissingParameterException < StandardError; end
+
+  class InvalidParameterException < StandardError; end
+
+  class RequestException < StandardError; end
+
+end

data/lib/scorekeeper/version.rb

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

data/scorekeeper.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scorekeeper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "scorekeeper"
+  spec.version       = Scorekeeper::VERSION
+  spec.authors       = ["gardoroman"]
+  spec.email         = ["gardoroman@gmail.com"]
+
+  spec.summary       = %q{Gem to analyze a customers score}
+  spec.description   = %q{This gem uses demographic data to generate a score}
+  spec.homepage      = "https://github.com/gardoroman/scorekeeper"
+  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.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = ": Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  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_runtime_dependency     "httparty", "~> 0.14"
+  spec.add_runtime_dependency     "json", "~> 2.0"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: scorekeeper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- gardoroman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+description: This gem uses demographic data to generate a score
+email:
+- gardoroman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/scorekeeper.rb
+- lib/scorekeeper/customer_scoring.rb
+- lib/scorekeeper/error_types.rb
+- lib/scorekeeper/version.rb
+- scorekeeper.gemspec
+homepage: https://github.com/gardoroman/scorekeeper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Gem to analyze a customers score
+test_files: []