leapfrog 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9cd50da2392d3cc40bc83c5f873310f7b40fa01e
+  data.tar.gz: bcb01bb8c88f70c1c8451b2c3b347a909ea042c6
+SHA512:
+  metadata.gz: fcba0610400882342300ab73f80e6ddf6403ba9ad38477896552a0714865406545c8d0dfc372b7b807f5e5b7e5f75ab3171444bcc9eaf1dea4977a96f284d485
+  data.tar.gz: 3820d78adc5b6911dbbcfcf81260127646b00f6a72e6e5693a3e70eb3dfdfe9daff3d00ee118627871fe17c776465f0d2a7b86b5bf8d928e5714807e9b9540e7

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Vince Cima
+
+MIT License
+
+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,34 @@
+# Leapfrog
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'leapfrog'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install leapfrog
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Assumptions
+
+1. All params for customer_scoring endpoint are required.
+2. Server sends 403 status code for invalid request params, no further validation info.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+desc "Run tests"
+task :default => :test

data/leapfrog.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'leapfrog/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "leapfrog"
+  spec.version       = Leapfrog::VERSION
+  spec.authors       = ["Vince Cima"]
+  spec.email         = ["contact@vincecima.com"]
+  spec.description   = "Small client for interactive with Leapfrog advice API."
+  spec.summary       = "Code sample that interacts with Leapfrog API."
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "webmock", "~> 1.14.0"
+
+  spec.add_dependency "rest-client", "~> 1.6.7"
+end

data/lib/leapfrog.rb

@@ -0,0 +1,11 @@
+# External dependencies
+require "rest_client"
+require "json"
+
+require "leapfrog/version"
+require "leapfrog/customer"
+require "leapfrog/scoring_client"
+require "leapfrog/advice" 
+
+module Leapfrog
+end

data/lib/leapfrog/advice.rb

@@ -0,0 +1,8 @@
+class Advice
+	attr_reader :propensity, :ranking
+
+	def initialize(propensity: nil, ranking: nil)
+		@propensity = propensity
+		@ranking = ranking
+	end
+end

data/lib/leapfrog/customer.rb

@@ -0,0 +1,9 @@
+class Customer
+	attr_reader :income, :zipcode, :age
+
+	def initialize(income, zipcode, age)
+		@income = income
+		@zipcode = zipcode
+		@age = age
+	end
+end

data/lib/leapfrog/scoring_client.rb

@@ -0,0 +1,32 @@
+class ScoringClient
+	@@API_URL = "http://internal.leapfrogonline.com/customer_scoring"
+
+	def score(customer)
+		raise ArgumentError, "income cannot be nil" if customer.income.nil?
+		raise ArgumentError, "zipcode cannot be nil" if customer.zipcode.nil?
+		raise ArgumentError, "age cannot be nil" if customer.age.nil?
+
+		begin
+			response = RestClient.get(@@API_URL, {params: customer_to_query_params(customer), accept: :json})
+		rescue RestClient::InternalServerError => error
+			raise "Scoring Advice Internal Error"
+		rescue RestClient::Forbidden => error
+			if error.response.code == 403
+				raise ArgumentError, "request parameters invalid"
+			end
+		end
+		
+		response_to_advice(response)
+	end
+
+	private
+
+	def customer_to_query_params(customer)
+		{income: customer.income, zipcode: customer.zipcode, age: customer.age}
+	end
+
+	def response_to_advice(response)
+		data = JSON.parse(response.body, {symbolize_names: true})
+		return Advice.new(data)
+	end
+end

data/lib/leapfrog/version.rb

@@ -0,0 +1,3 @@
+module Leapfrog
+  VERSION = "0.0.1"
+end

data/test/scoring_client_test.rb

@@ -0,0 +1,49 @@
+require "test_helper"
+
+class ScoringClientTest < MiniTest::Unit::TestCase
+	def setup
+		WebMock.reset!
+		@api_url = "http://internal.leapfrogonline.com/customer_scoring"
+		@valid_query_params = {income: 50000, zipcode: 60201, age: 35}
+		@valid_customer = Customer.new(50000, 60201, 35)
+		@score_client = ScoringClient.new
+	end
+
+	def test_required_customer_attributes
+		assert_raises ArgumentError, "Customer income cannot be nil" do
+			customer = Customer.new(nil, 60657, 21)
+			@score_client.score(customer)
+		end
+		
+		assert_raises ArgumentError, "Customer zipcode cannot be nil" do
+			customer = Customer.new(10000, nil, 21)
+			@score_client.score(customer)
+		end
+
+		assert_raises ArgumentError, "Customer age cannot be nil" do
+			customer = Customer.new(10000, 60657, nil)
+			@score_client.score(customer)
+		end
+	end
+
+	def test_expected_response
+		stub_http_request(:get, @api_url).with(query: @valid_query_params).to_return(:status => 200, :body => '{"propensity":0.26532, "ranking":"C"}')
+		advice = @score_client.score(@valid_customer)
+		assert_equal(0.26532, advice.propensity)
+		assert_equal("C", advice.ranking)
+	end
+
+	def test_response_error
+		assert_raises RuntimeError, "Client should expose RuntimeError on server error" do
+			stub_http_request(:get, @api_url).with(query: @valid_query_params).to_return(:status => 500)
+			@score_client.score(@valid_customer)
+		end
+	end
+
+	def test_request_error
+		assert_raises ArgumentError, "Client should expose ArgumentError on server validation of parameters failure" do
+			stub_http_request(:get, @api_url).with(query: @valid_query_params).to_return(:status => 403)
+			@score_client.score(@valid_customer)
+		end
+	end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+
+require "webmock/minitest"
+require "leapfrog.rb"
+require "minitest/autorun"

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: leapfrog
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vince Cima
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.14.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+description: Small client for interactive with Leapfrog advice API.
+email:
+- contact@vincecima.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- leapfrog.gemspec
+- lib/leapfrog.rb
+- lib/leapfrog/advice.rb
+- lib/leapfrog/customer.rb
+- lib/leapfrog/scoring_client.rb
+- lib/leapfrog/version.rb
+- test/scoring_client_test.rb
+- test/test_helper.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Code sample that interacts with Leapfrog API.
+test_files:
+- test/scoring_client_test.rb
+- test/test_helper.rb