leapfrog 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 9cd50da2392d3cc40bc83c5f873310f7b40fa01e
4
+ data.tar.gz: bcb01bb8c88f70c1c8451b2c3b347a909ea042c6
5
+ SHA512:
6
+ metadata.gz: fcba0610400882342300ab73f80e6ddf6403ba9ad38477896552a0714865406545c8d0dfc372b7b807f5e5b7e5f75ab3171444bcc9eaf1dea4977a96f284d485
7
+ data.tar.gz: 3820d78adc5b6911dbbcfcf81260127646b00f6a72e6e5693a3e70eb3dfdfe9daff3d00ee118627871fe17c776465f0d2a7b86b5bf8d928e5714807e9b9540e7
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in leapfrog.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2013 Vince Cima
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,34 @@
1
+ # Leapfrog
2
+
3
+ TODO: Write a gem description
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ gem 'leapfrog'
10
+
11
+ And then execute:
12
+
13
+ $ bundle
14
+
15
+ Or install it yourself as:
16
+
17
+ $ gem install leapfrog
18
+
19
+ ## Usage
20
+
21
+ TODO: Write usage instructions here
22
+
23
+ ## Contributing
24
+
25
+ 1. Fork it
26
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
27
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
28
+ 4. Push to the branch (`git push origin my-new-feature`)
29
+ 5. Create new Pull Request
30
+
31
+ ## Assumptions
32
+
33
+ 1. All params for customer_scoring endpoint are required.
34
+ 2. Server sends 403 status code for invalid request params, no further validation info.
data/Rakefile ADDED
@@ -0,0 +1,11 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new do |t|
5
+ t.libs << 'test'
6
+ t.libs << 'lib'
7
+ t.test_files = FileList['test/**/*_test.rb']
8
+ end
9
+
10
+ desc "Run tests"
11
+ task :default => :test
data/leapfrog.gemspec ADDED
@@ -0,0 +1,26 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'leapfrog/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "leapfrog"
8
+ spec.version = Leapfrog::VERSION
9
+ spec.authors = ["Vince Cima"]
10
+ spec.email = ["contact@vincecima.com"]
11
+ spec.description = "Small client for interactive with Leapfrog advice API."
12
+ spec.summary = "Code sample that interacts with Leapfrog API."
13
+ spec.homepage = ""
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files`.split($/)
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_development_dependency "bundler", "~> 1.3"
22
+ spec.add_development_dependency "rake"
23
+ spec.add_development_dependency "webmock", "~> 1.14.0"
24
+
25
+ spec.add_dependency "rest-client", "~> 1.6.7"
26
+ end
data/lib/leapfrog.rb ADDED
@@ -0,0 +1,11 @@
1
+ # External dependencies
2
+ require "rest_client"
3
+ require "json"
4
+
5
+ require "leapfrog/version"
6
+ require "leapfrog/customer"
7
+ require "leapfrog/scoring_client"
8
+ require "leapfrog/advice"
9
+
10
+ module Leapfrog
11
+ end
@@ -0,0 +1,8 @@
1
+ class Advice
2
+ attr_reader :propensity, :ranking
3
+
4
+ def initialize(propensity: nil, ranking: nil)
5
+ @propensity = propensity
6
+ @ranking = ranking
7
+ end
8
+ end
@@ -0,0 +1,9 @@
1
+ class Customer
2
+ attr_reader :income, :zipcode, :age
3
+
4
+ def initialize(income, zipcode, age)
5
+ @income = income
6
+ @zipcode = zipcode
7
+ @age = age
8
+ end
9
+ end
@@ -0,0 +1,32 @@
1
+ class ScoringClient
2
+ @@API_URL = "http://internal.leapfrogonline.com/customer_scoring"
3
+
4
+ def score(customer)
5
+ raise ArgumentError, "income cannot be nil" if customer.income.nil?
6
+ raise ArgumentError, "zipcode cannot be nil" if customer.zipcode.nil?
7
+ raise ArgumentError, "age cannot be nil" if customer.age.nil?
8
+
9
+ begin
10
+ response = RestClient.get(@@API_URL, {params: customer_to_query_params(customer), accept: :json})
11
+ rescue RestClient::InternalServerError => error
12
+ raise "Scoring Advice Internal Error"
13
+ rescue RestClient::Forbidden => error
14
+ if error.response.code == 403
15
+ raise ArgumentError, "request parameters invalid"
16
+ end
17
+ end
18
+
19
+ response_to_advice(response)
20
+ end
21
+
22
+ private
23
+
24
+ def customer_to_query_params(customer)
25
+ {income: customer.income, zipcode: customer.zipcode, age: customer.age}
26
+ end
27
+
28
+ def response_to_advice(response)
29
+ data = JSON.parse(response.body, {symbolize_names: true})
30
+ return Advice.new(data)
31
+ end
32
+ end
@@ -0,0 +1,3 @@
1
+ module Leapfrog
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,49 @@
1
+ require "test_helper"
2
+
3
+ class ScoringClientTest < MiniTest::Unit::TestCase
4
+ def setup
5
+ WebMock.reset!
6
+ @api_url = "http://internal.leapfrogonline.com/customer_scoring"
7
+ @valid_query_params = {income: 50000, zipcode: 60201, age: 35}
8
+ @valid_customer = Customer.new(50000, 60201, 35)
9
+ @score_client = ScoringClient.new
10
+ end
11
+
12
+ def test_required_customer_attributes
13
+ assert_raises ArgumentError, "Customer income cannot be nil" do
14
+ customer = Customer.new(nil, 60657, 21)
15
+ @score_client.score(customer)
16
+ end
17
+
18
+ assert_raises ArgumentError, "Customer zipcode cannot be nil" do
19
+ customer = Customer.new(10000, nil, 21)
20
+ @score_client.score(customer)
21
+ end
22
+
23
+ assert_raises ArgumentError, "Customer age cannot be nil" do
24
+ customer = Customer.new(10000, 60657, nil)
25
+ @score_client.score(customer)
26
+ end
27
+ end
28
+
29
+ def test_expected_response
30
+ stub_http_request(:get, @api_url).with(query: @valid_query_params).to_return(:status => 200, :body => '{"propensity":0.26532, "ranking":"C"}')
31
+ advice = @score_client.score(@valid_customer)
32
+ assert_equal(0.26532, advice.propensity)
33
+ assert_equal("C", advice.ranking)
34
+ end
35
+
36
+ def test_response_error
37
+ assert_raises RuntimeError, "Client should expose RuntimeError on server error" do
38
+ stub_http_request(:get, @api_url).with(query: @valid_query_params).to_return(:status => 500)
39
+ @score_client.score(@valid_customer)
40
+ end
41
+ end
42
+
43
+ def test_request_error
44
+ assert_raises ArgumentError, "Client should expose ArgumentError on server validation of parameters failure" do
45
+ stub_http_request(:get, @api_url).with(query: @valid_query_params).to_return(:status => 403)
46
+ @score_client.score(@valid_customer)
47
+ end
48
+ end
49
+ end
@@ -0,0 +1,5 @@
1
+ $LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
2
+
3
+ require "webmock/minitest"
4
+ require "leapfrog.rb"
5
+ require "minitest/autorun"
metadata ADDED
@@ -0,0 +1,115 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: leapfrog
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Vince Cima
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2013-10-06 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ~>
18
+ - !ruby/object:Gem::Version
19
+ version: '1.3'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ~>
25
+ - !ruby/object:Gem::Version
26
+ version: '1.3'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - '>='
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - '>='
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: webmock
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ~>
46
+ - !ruby/object:Gem::Version
47
+ version: 1.14.0
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ~>
53
+ - !ruby/object:Gem::Version
54
+ version: 1.14.0
55
+ - !ruby/object:Gem::Dependency
56
+ name: rest-client
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ~>
60
+ - !ruby/object:Gem::Version
61
+ version: 1.6.7
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ~>
67
+ - !ruby/object:Gem::Version
68
+ version: 1.6.7
69
+ description: Small client for interactive with Leapfrog advice API.
70
+ email:
71
+ - contact@vincecima.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - .gitignore
77
+ - Gemfile
78
+ - LICENSE.txt
79
+ - README.md
80
+ - Rakefile
81
+ - leapfrog.gemspec
82
+ - lib/leapfrog.rb
83
+ - lib/leapfrog/advice.rb
84
+ - lib/leapfrog/customer.rb
85
+ - lib/leapfrog/scoring_client.rb
86
+ - lib/leapfrog/version.rb
87
+ - test/scoring_client_test.rb
88
+ - test/test_helper.rb
89
+ homepage: ''
90
+ licenses:
91
+ - MIT
92
+ metadata: {}
93
+ post_install_message:
94
+ rdoc_options: []
95
+ require_paths:
96
+ - lib
97
+ required_ruby_version: !ruby/object:Gem::Requirement
98
+ requirements:
99
+ - - '>='
100
+ - !ruby/object:Gem::Version
101
+ version: '0'
102
+ required_rubygems_version: !ruby/object:Gem::Requirement
103
+ requirements:
104
+ - - '>='
105
+ - !ruby/object:Gem::Version
106
+ version: '0'
107
+ requirements: []
108
+ rubyforge_project:
109
+ rubygems_version: 2.0.3
110
+ signing_key:
111
+ specification_version: 4
112
+ summary: Code sample that interacts with Leapfrog API.
113
+ test_files:
114
+ - test/scoring_client_test.rb
115
+ - test/test_helper.rb