ps_pop_client 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f1e22adb89cd91257fbce292b29633fe8dd92ea
+  data.tar.gz: 22cd5234ef5b4f595d271c1064bf5c15ffc1c139
+SHA512:
+  metadata.gz: 36431f30f538e11c299c552a440a20ce43462d8679b3a277e577e907f17ea95ff113e673f902f5d341bcc8aef40ffa234ff22d0b40921e68411df147d779db5f
+  data.tar.gz: 21e3dbb11e76723c8f80f0979e969b84fe4ce06b3fecc043aded436864afb4586d93e774a6cf5257bd6eaf953f5b26e90756c057383dcc2ae742e8d1b2b197e9

data/.gitgnore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    ps_pop_client (0.1.1)
+      json
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    json (2.2.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ps_pop_client!
+  rspec
+
+BUNDLED WITH
+   1.14.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Harsh Singh
+
+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,59 @@
+## PeerStreet Population Estimate Ruby Client
+This is gem is built as Ruby client to access to the endpoint:</br>
+https://pstreet-api.herokuapp.com/api/v1/cbsa/find?cbsa_ids[]=15540&cbsa_ids[]=11260&zip_codes[]=79607
+
+## Installation
+1. Rails App
+#### Add the following line to Gemfile 
+```
+gem 'ps_pop_client'
+```
+
+#### Execute 'bundle'
+```
+bundle install
+```
+2. Cli
+```
+gem install 'ps_pop_client'
+```
+
+## Usage
+
+### Send Request
+
+##### step 1.
+```ruby
+ required 'ps_pop_client'
+```
+##### step 2.
+```ruby
+# request params
+params = {:cbsa_ids => [11260,3232],
+           :zip_codes => [79607, 90254],
+           :name => "South Bay"
+          }
+## 1. default endpoint is "https://pstreet-api.herokuapp.com"
+PSClient::Api.new.find(params)
+
+## 2. include your own endpoint:
+PSClient::Api.new({:base_uri => "https://myown-api.com"}).find(params)
+```
+
+##### Params Fields Definition
+| Items  | Description | Type  | 
+| :------------ |:---------------:| -----:|
+| cbsa_ids      | CBSA Codes| Array | 
+| zip_codes     | Zip Codes   |  Array|
+| name          | MSA Name  |  String |
+
+### Run Rspec 
+```
+rspec
+```
+
+
+
+
+
+

data/lib/ps_pop_client.rb

@@ -0,0 +1,6 @@
+require_relative 'ps_pop_client/version'
+require_relative 'ps_pop_client/request'
+require_relative 'ps_pop_client/response'
+require_relative 'ps_pop_client/error'
+require_relative 'ps_pop_client/base_client'
+require_relative 'ps_pop_client/client'

data/lib/ps_pop_client/base_client.rb

@@ -0,0 +1,12 @@
+
+module PSClient
+  class BaseApi
+    def initialize(args={ :base_uri => nil })
+      @base_uri  = args[:base_uri]
+    end 
+  
+    def request(path)
+      APIConnection.new(@base_uri, path).get
+    end 
+  end  
+end

data/lib/ps_pop_client/client.rb

@@ -0,0 +1,48 @@
+DEFAULT_URI = 'https://pstreet-api.herokuapp.com'
+
+module PSClient
+  require_relative 'tools/request_util'
+  class Api < BaseApi
+    def initialize(args={ :base_uri => DEFAULT_URI })
+      super(args)
+    end 
+
+    def find(req={}) 
+      begin
+        parsed_req = parse_req_to_symbols(req)
+        check_request(parsed_req)
+        uri = encode_uri(parsed_req)
+        response = request(uri)
+        check_status(response)
+        fitlered_response = filter_records(parsed_req, response)
+        return Response.new(fitlered_response).parse
+      rescue => e
+        return Response.new(e).parse_error
+      end
+    end 
+
+    private      
+      def check_status(response)
+        return if (200..299).cover?(response.code.to_i)
+        raise Error.new(response.message, response.code)
+      end
+      
+      def filter_records(req, response) 
+        ResponseUtil.filter_records(req, response)
+      end 
+      
+      def parse_req_to_symbols(req)
+        RequestUtil.parse_to_symbol(req)
+      end 
+      def check_request(req)
+        RequestUtil.validate_find_request(req)
+      end 
+      def encode_uri(req)
+        cbsa_ids_uri = (req.keys.include?(:cbsa_ids) && req[:cbsa_ids].kind_of?(Array)) ? req[:cbsa_ids].inject("") { |s, a| s + "cbsa_ids[]=" + a.to_s + "&" } : ""
+        zipcodes_uri = (req.keys.include?(:zip_codes) && req[:zip_codes].kind_of?(Array)) ? req[:zip_codes].inject("") { |s, a| s + "zip_codes[]=" + a.to_s + "&" } : ""
+        name = (req.keys.include?(:name) && req[:name].kind_of?(String)) ? "name=" + req[:name] : ""
+        "/api/v1/cbsa/find?" + cbsa_ids_uri + zipcodes_uri + name
+      end 
+  end
+end 
+

data/lib/ps_pop_client/error.rb

@@ -0,0 +1,9 @@
+module PSClient 
+  class Error < StandardError
+    attr_reader :code
+    def initialize(message = nil, code = nil)
+      super(message)
+      @code = (code) ? code : 500
+    end
+  end
+end

data/lib/ps_pop_client/request.rb

@@ -0,0 +1,25 @@
+module PSClient
+  require 'net/http'
+  require 'uri'
+
+  class APIConnection
+    def initialize(uri=nil,path=nil)
+      @base_uri = uri
+      @path = path
+    end 
+    
+    def get
+      url = get_url
+      request = Net::HTTP::Get.new(url)
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true if url.scheme == 'https'
+      response = http.request(request)
+      return response
+    end
+
+    private
+      def get_url
+        URI.parse("#{@base_uri}#{@path}")
+      end 
+  end 
+end 

data/lib/ps_pop_client/response.rb

@@ -0,0 +1,19 @@
+module PSClient
+  require 'json'
+    require_relative 'tools/error_util'
+    require_relative 'tools/response_util'
+    class Response
+      def initialize(response= {})
+        @response=response
+      end 
+      
+      def parse
+        res_body = JSON.parse(@response.body)
+        { status: @response.code.to_i , data:res_body["data"]}
+      end 
+
+      def parse_error
+         ErrorUtil.parse_response(@response);
+      end 
+  end
+end 

data/lib/ps_pop_client/tools/error_util.rb

@@ -0,0 +1,9 @@
+module ErrorUtil
+  def self.parse_response(e)
+    response = {
+      status: (e.class == PSClient::Error) ?  e.code.to_i : 500,
+      message: e.message
+    }
+    return response
+  end 
+end 

data/lib/ps_pop_client/tools/request_util.rb

@@ -0,0 +1,16 @@
+module RequestUtil
+  require_relative '../error'
+  def self.validate_find_request(req)
+    if !req.kind_of?(Hash) 
+      raise PSClient::Error.new("Invalid request with wrong data type.", 400)
+    elsif !req.keys.include?(:cbsa_ids) && !req.keys.include?(:zip_codes) && !req.keys.include?(:name)
+      raise PSClient::Error.new("Must have at least one request on cbsa_ids, zip_codes or name params.", 400)
+    elsif (req.keys.include?(:cbsa_ids) && !req[:cbsa_ids].kind_of?(Array)) || (req.keys.include?(:zip_codes) && !req[:zip_codes].kind_of?(Array)) || (req.keys.include?(:name) && !req[:name].kind_of?(String))
+      raise PSClient::Error.new("Invalid request with wrong data type.", 400)
+    end 
+  end 
+  def self.parse_to_symbol(req)
+    raise PSClient::Error.new("Invalid request with wrong data type.", 400) if !req.kind_of?(Hash) 
+    Hash[req.map{|(k,v)| [k.to_sym,v]}]
+  end 
+end  

data/lib/ps_pop_client/tools/response_util.rb

@@ -0,0 +1,33 @@
+module ResponseUtil
+  def self.filter_by_zipcodes(a_for, a_against)
+    return [] if !a_for.kind_of?(Array) || a_for.count == 0
+    result = a_for.select do |e|
+      a_against.include?(e)
+    end
+    return result
+  end
+
+  def self.filter_records(req,response)
+    return response unless req[:zip_codes].kind_of?(Array)
+    res_body = JSON.parse(response.body)
+    records = res_body["data"]["records"]
+      records.each do |record|
+        if self.should_filter?(req[:cbsa_ids], record["cbsa_id"],record["zip_code"], req[:zip_codes]) 
+          record["zip_code"] = self.filter_by_zipcodes(record["zip_code"], req[:zip_codes])
+        end 
+      end 
+    res_body["data"]["records"] = records
+    res_body["data"]["count"] = records.length
+    response.body = JSON.generate(res_body)
+    return response
+  end  
+   
+  def self.should_filter?(cbsa_ids_array, cbsa_id, res_zipcodes,req_zipcodes)
+    cbsa_ids = !cbsa_ids_array ? [] : cbsa_ids_array
+    !(cbsa_ids.include? cbsa_id.to_i) && self.compare_zipcodes(res_zipcodes,req_zipcodes)
+  end 
+
+  def self.compare_zipcodes(a, b)
+    (a&b).size  > 0 
+  end
+end  

data/lib/ps_pop_client/version.rb

@@ -0,0 +1,3 @@
+module PSClient
+  VERSION = '0.1.1'
+end

data/ps_pop_client.gemspec

@@ -0,0 +1,28 @@
+require File.expand_path("../lib/ps_pop_client/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'ps_pop_client'
+  s.version     = PSClient::VERSION
+  s.date        = '2019-09-16'
+  s.summary     = "API To fetch population growth on CBSA"
+  s.description = "Ruby Client to interact with CBSA api as described on PeerStreet take home assignment."
+  s.authors     = ["Steven Chow"]
+  s.email       = 'stevenwchow@gmail.com'
+  # s.files       =  ['lib/ps_pop_client.rb', 
+  #                   'lib/ps_pop_client/*.rb',
+  #                   'lib/ps_pop_client/tools/**/*']
+  s.files = `git ls-files`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split('\n').map{ |f| File.basename(f) }
+  # s.files       =  ['lib/ps_pop_client.rb', 
+  #                     'lib/ps_pop_client/base_client.rb',
+  #                     'lib/ps_pop_client/client.rb',
+  #                     'lib/ps_pop_client/error.rb',
+  #                     'lib/ps_pop_client/request.rb',
+  #                     'lib/ps_pop_client/response.rb',
+  #                     'lib/ps_pop_client/version.rb']
+  s.require_paths = ['lib']
+  s.homepage    = 'https://github.com/schow6272003/ps_gem'
+  s.license       = 'MIT'
+  s.add_dependency 'json'
+  s.add_development_dependency 'rspec'
+end

data/spec/ps_pop_client/client_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe PSClient::VERSION do
+  it 'has ver. number' do 
+    expect(PSClient::VERSION).not_to be_empty 
+  end 
+end

data/spec/ps_pop_client_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe PSClient::Api do
+  before do
+    @client = described_class.new
+  end  
+
+  describe "#find"  do
+    subject {@client.find(req)}
+
+    context "when valid request params" do 
+      let(:req) { { "cbsa_ids" => [11260] }} 
+      it "expects to return with 200 status code" do
+        expect(subject[:status]).to eq 200
+      end 
+      
+      it "expects to return 1 record" do
+        expect(subject[:data]["records"].count).to eq 1
+      end
+      
+      it "expects cbsa code to be 11260" do
+        expect(subject[:data]["records"][0]["cbsa_id"]).to eq 11260
+      end 
+
+      it "expects to include zipcodes" do
+        expect(subject[:data]["records"][0]["zip_code"]).to include(99501,99502,99503)
+      end 
+      
+      it "expects to include msa name" do
+        expect(subject[:data]["records"][0]["name"]).to eq "Anchorage, AK"
+      end
+
+      it "expects to include 2014 pop estimate" do 
+        expect(subject[:data]["records"][0]["pop_estimate"][4]["number"]).to eq 398642
+      end
+      it "expects to include 2015 pop estimate" do 
+        expect(subject[:data]["records"][0]["pop_estimate"][5]["number"]).to eq 399790
+      end
+    end  
+
+    context "when search using zipcodes" do
+      let(:req) { { :zip_codes => [48813,5482] }} 
+    
+      it "expects to return with 200 status code" do
+        expect(subject[:status]).to eq 200
+      end 
+
+      it "expects to return 2 record" do
+        expect(subject[:data]["count"]).to eq 2
+      end
+
+      it "expects first record to have zipcode 48813" do
+        expect(subject[:data]["records"][0]["zip_code"]).to include(48813)
+      end
+
+      it "expects first record to have zipcode 5482" do
+        expect(subject[:data]["records"][1]["zip_code"]).to include(5482)
+      end
+    end  
+
+    context "when search msa name by keyword" do
+      let(:req) { { :name => "Burlington" }} 
+
+      it "expects to return with 200 status code" do
+        expect(subject[:status]).to eq 200
+      end 
+
+      it "expects to return 2 record" do
+        expect(subject[:data].count).to eq 2
+      end
+
+      it "expects to include 'Burlington' on msa name" do
+        expect(subject[:data]["records"][0]["name"]).to include("Burlington")
+      end
+    end 
+
+    context "When no records are found" do
+      let (:req) {{:name => "Hello World!"}}
+      
+      it "expects to return with 200 status code" do
+        expect(subject[:status]).to eq 200
+      end
+      
+      it "expects to return 0 records" do
+        expect(subject[:data]["records"].count).to eq 0
+      end 
+    end
+
+    context "when request is invalid"  do 
+      let(:req) { {}}
+      
+      it "expect to response http status to be" do 
+        expect(subject[:status]).to eq 400
+      end
+    end
+  end 
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+Bundler.setup
+require 'ps_pop_client'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: ps_pop_client
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Steven Chow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: Ruby Client to interact with CBSA api as described on PeerStreet take
+  home assignment.
+email: stevenwchow@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitgnore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- lib/ps_pop_client.rb
+- lib/ps_pop_client/base_client.rb
+- lib/ps_pop_client/client.rb
+- lib/ps_pop_client/error.rb
+- lib/ps_pop_client/request.rb
+- lib/ps_pop_client/response.rb
+- lib/ps_pop_client/tools/error_util.rb
+- lib/ps_pop_client/tools/request_util.rb
+- lib/ps_pop_client/tools/response_util.rb
+- lib/ps_pop_client/version.rb
+- ps_pop_client.gemspec
+- spec/ps_pop_client/client_spec.rb
+- spec/ps_pop_client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/schow6272003/ps_gem
+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.6.12
+signing_key: 
+specification_version: 4
+summary: API To fetch population growth on CBSA
+test_files: []