leapfrog-customer_scoring 0.0.1

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/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* Initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Paul Sorensen
+
+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,51 @@
+# Leapfrog::CustomerScoring
+
+[![Build Status](https://travis-ci.org/paulnsorensen/leapfrog-customer_scoring.png)](https://travis-ci.org/paulnsorensen/leapfrog-customer_scoring)
+[![Dependency Status](https://gemnasium.com/paulnsorensen/leapfrog-customer_scoring.png)](https://gemnasium.com/paulnsorensen/leapfrog-customer_scoring)
+[![Code Climate](https://codeclimate.com/github/paulnsorensen/leapfrog-customer_scoring.png)](https://codeclimate.com/github/paulnsorensen/leapfrog-customer_scoring)
+
+
+Ruby API client for Leapfrog Online customer scoring
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'leapfrog-customer_scoring'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install leapfrog-customer_scoring
+
+## Usage
+
+Clients are instantiated with `http://internal.leapfrogonline/customer_scoring` as the default URL. 
+
+    client = Leapfrog::CustomerScoring::Client.new
+
+You may optionally pass a different URL to use.
+
+    client = Leapfrog::CustomerScoring::Client.new("http://example.com")
+
+To retrieve the scoring advice for a customer, you will call the `get_score(income, zipcode, age)` method. The response will be a `Hash` with two symbolized keys containing the `:propensity` and `:ranking` for that customer.
+
+    advice = client.get_score("50000", "60621", "35")
+    advice.inspect
+    => "{:propensity=>0.26532, :ranking=>\"C\"}"
+
+## Testing
+
+To test this gem, you can checkout the master branch and run the `rake`
+in your console.
+
+## 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

data/Rakefile

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

data/leapfrog-customer_scoring.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'leapfrog/customer_scoring/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "leapfrog-customer_scoring"
+  spec.version       = Leapfrog::CustomerScoring::VERSION
+  spec.authors       = ["Paul Sorensen"]
+  spec.email         = ["paulnsorensen@gmail.com"]
+  spec.description   = %q{Ruby API client for Leapfrog Online customer scoring}
+  spec.summary       = %q{Ruby API client for Leapfrog Online customer scoring}
+  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 "rspec"
+  spec.add_development_dependency "webmock", "~> 1.14.0"
+  spec.add_runtime_dependency "rest-client", "~> 1.6.7"
+  spec.add_runtime_dependency "json", "~> 1.8.0"
+end

data/lib/leapfrog/customer_scoring/client.rb

@@ -0,0 +1,57 @@
+module Leapfrog
+  module CustomerScoring
+    class Client
+      DEFAULT_URL = "http://internal.leapfrogonline.com/customer_scoring"
+
+      # You may initialize the Client with any url or just use the default
+      # url of "http://internal.leapfrogonline.com/customer_scoring".
+      # 
+      #   client = Leapfrog::CustomerScoring::Client.new
+      #
+      # -- OR--
+      #
+      #   other_url = "http://example.com/customer_scoring"
+      #   client = Leapfrog::CustomerScoring::Client.new(other_url)
+      #
+      # This is the url to which the client will make requests
+      def initialize(url="")
+        @url = url.empty? ? DEFAULT_URL : url
+      end
+
+      # Makes request to the initialized endpoint to retrieve customer
+      # scoring advice. The <tt>income</tt>, <tt>zipcode</tt> and
+      # <tt>age</tt> parameters are required. The return value is a
+      # <tt>Hash</tt> with keys containing the <tt>:propensity</tt>
+      # and <tt>:ranking </tt> for customer with the passed parameters
+      #
+      #   advice = client.get_score("50000", "60621", "35")
+      #   advice.inspect
+      #   => "{:propensity=>0.26532, :ranking=>\"C\"}"
+      #
+      def get_score(income, zipcode, age)
+        params = {income: income, zipcode: zipcode, age: age}
+        begin
+          RestClient.get(url, params: params) do |response, request, result|
+            case response.code
+            when 200
+              return ::JSON.parse(response, symbolize_names: true)
+            when 422
+              raise Leapfrog::CustomerScoring::InvalidInput
+            when 404
+              raise Leapfrog::CustomerScoring::ResourceNotFound
+            when 500
+              raise Leapfrog::CustomerScoring::ServerError
+            else
+              response.return!(request, result)
+            end
+          end
+        rescue RestClient::RequestTimeout
+          raise Leapfrog::CustomerScoring::ServerTimeout
+        end
+      end
+
+      private
+      attr_reader :url
+    end
+  end
+end

data/lib/leapfrog/customer_scoring/exceptions.rb

@@ -0,0 +1,27 @@
+module Leapfrog
+  module CustomerScoring 
+    class InvalidInput < Exception
+      def initialize(data={})
+        @data = data
+      end
+    end
+    
+    class ResourceNotFound < Exception
+      def initialize(data={})
+        @data = data
+      end
+    end
+    
+    class ServerError < Exception
+      def initialize(data={})
+        @data = data
+      end
+    end
+
+    class ServerTimeout < Exception
+      def initialize(data={})
+        @data = data
+      end
+    end
+  end
+end

data/lib/leapfrog/customer_scoring/version.rb

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

data/lib/leapfrog/customer_scoring.rb

@@ -0,0 +1,10 @@
+require 'json'
+require 'rest_client'
+require "leapfrog/customer_scoring/exceptions"
+require "leapfrog/customer_scoring/client"
+require "leapfrog/customer_scoring/version"
+
+module Leapfrog
+  module CustomerScoring
+  end
+end

data/spec/leapfrog/customer_scoring/client_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe Leapfrog::CustomerScoring do
+  describe "#initialize" do
+    it "should have the correct default url" do
+      client = Leapfrog::CustomerScoring::Client.new
+      expect(client.send(:url)).to eql(Leapfrog::CustomerScoring::Client::DEFAULT_URL)
+    end
+
+    it "should allow another url to be specified" do
+      client = Leapfrog::CustomerScoring::Client.new("http://paulnsorensen.com")
+      expect(client.send(:url)).to eql("http://paulnsorensen.com")
+    end
+  end
+
+  describe "#get_score" do
+    context "when successful" do
+      before(:all) do
+        test_url =  Leapfrog::CustomerScoring::Client::DEFAULT_URL
+        test_url += "?age=35&income=50000&zipcode=60621"
+        stub_request(:get, test_url).
+        to_return(status: 200, body: '{"propensity": 0.26532,"ranking": "C"}')
+        client = Leapfrog::CustomerScoring::Client.new
+        @result = client.get_score("50000", "60621", "35")
+      end
+
+      it "should return a Hash" do
+        expect(@result).to be_kind_of(Hash)
+      end
+
+      it "should only include 'propensity' and 'ranking" do
+        expect(@result.keys.sort).to eql([:propensity, :ranking])
+      end
+
+      it "should have the correct value for 'propensity'" do
+        expect(@result[:propensity]).to eql(0.26532)
+      end
+
+      it "should have the correct value for 'ranking'" do        
+        expect(@result[:ranking]).to eql("C")
+      end
+    end
+
+    context "when invalid url" do
+      before(:all) do
+        test_url =  Leapfrog::CustomerScoring::Client::DEFAULT_URL
+        test_url += "?age=35&income=50000&zipcode=60621"
+        stub_request(:get, test_url).
+        to_return(status: [404, "Invalid URL"])
+      end
+      let(:client) { Leapfrog::CustomerScoring::Client.new }
+
+      it "should raise an InvalidUrl exception" do
+        expect { client.get_score("50000", "60621", "35") }.
+        to raise_error(Leapfrog::CustomerScoring::ResourceNotFound)
+      end
+    end
+
+    context "when invalid input" do
+      before(:all) do
+        test_url =  Leapfrog::CustomerScoring::Client::DEFAULT_URL
+        test_url += "?age=35&income=50000&zipcode=no"
+        stub_request(:get, test_url).
+        to_return(status: [422, "Invalid Input"])
+      end
+      let(:client) { Leapfrog::CustomerScoring::Client.new }
+
+      it "should raise an InvalidInput exception" do
+        expect { client.get_score("50000", "no", "35") }.
+        to raise_error(Leapfrog::CustomerScoring::InvalidInput)
+      end
+    end
+
+    context "when server error" do
+      before(:all) do
+        test_url =  Leapfrog::CustomerScoring::Client::DEFAULT_URL
+        test_url += "?age=35&income=50000&zipcode=60621"
+        stub_request(:get, test_url).
+        to_return(status: [500, "Internal Server Error"])
+      end
+      let(:client) { Leapfrog::CustomerScoring::Client.new }
+
+      it "should raise a ServerError exception" do
+        expect { client.get_score("50000", "60621", "35") }.
+        to raise_error(Leapfrog::CustomerScoring::ServerError)
+      end
+    end
+
+    context "when timed out" do
+      before(:all) do
+        test_url =  Leapfrog::CustomerScoring::Client::DEFAULT_URL
+        test_url += "?age=35&income=50000&zipcode=60621"
+        stub_request(:get, test_url).
+        to_timeout
+      end
+      let(:client) { Leapfrog::CustomerScoring::Client.new }
+
+      it "should raise a Timeout exception" do
+        expect { client.get_score("50000", "60621", "35") }.
+        to raise_error(Leapfrog::CustomerScoring::ServerTimeout)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'webmock/rspec'
+require 'leapfrog/customer_scoring'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: leapfrog-customer_scoring
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Paul Sorensen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.14.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: Ruby API client for Leapfrog Online customer scoring
+email:
+- paulnsorensen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- leapfrog-customer_scoring.gemspec
+- lib/leapfrog/customer_scoring.rb
+- lib/leapfrog/customer_scoring/client.rb
+- lib/leapfrog/customer_scoring/exceptions.rb
+- lib/leapfrog/customer_scoring/version.rb
+- spec/leapfrog/customer_scoring/client_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3260785113119909660
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3260785113119909660
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Ruby API client for Leapfrog Online customer scoring
+test_files:
+- spec/leapfrog/customer_scoring/client_spec.rb
+- spec/spec_helper.rb