blackbook_client 0.1.0 → 1.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 +4 -4
- data/.github/PULL_REQUEST_TEMPLATE.md +18 -0
- data/.rspec +0 -1
- data/Gemfile.lock +7 -3
- data/README.md +3 -1
- data/blackbook_client.gemspec +1 -1
- data/lib/autocomplete_service.rb +19 -0
- data/lib/blackbook_client/version.rb +1 -1
- data/lib/blackbook_client.rb +6 -0
- data/lib/chromedata_service.rb +16 -0
- data/lib/http_rest_client.rb +61 -0
- data/lib/mappers/range_values_mapper.rb +15 -0
- data/lib/mappers/spec_pdf_mapper.rb +8 -0
- data/lib/mappers/uvc_mapper.rb +10 -0
- data/lib/uvc_service.rb +37 -0
- data/lib/vin_service.rb +16 -37
- metadata +10 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 74f52105e54523d683ea1d2cd5a14c02856c9efa1e30c6dab416eac01f46466c
|
|
4
|
+
data.tar.gz: 28621ad6f8ed8e4ae7936327166f99ef43fa8639db46d63031c84c999c8ea775
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: be62b82232a8fee54babca17fa588e91012e2d9cf410fb6a2887ccdc1e4eff991e46bcd55c682df69d4cb48c6180061149243e011c9563c866e0d59abfc60aea
|
|
7
|
+
data.tar.gz: 02a91961160e0975c93c813129b9361ad01e9e050cce08e7a19cdbc47babd64bd18ecae73bc65300a58a240cddb2e5c12a4fb8cca5fd1db783396a0d25e29167
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
Please provide the following information:
|
|
3
|
+
-->
|
|
4
|
+
|
|
5
|
+
**- What I did**
|
|
6
|
+
|
|
7
|
+
**- How I did it**
|
|
8
|
+
|
|
9
|
+
**- How to verify it**
|
|
10
|
+
|
|
11
|
+
**- Description for the changelog**
|
|
12
|
+
<!--
|
|
13
|
+
Write a short (one line) summary that describes the changes in this
|
|
14
|
+
pull request for inclusion in the changelog:
|
|
15
|
+
-->
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
**- A picture of a cute animal (not mandatory but encouraged)**
|
data/.rspec
CHANGED
data/Gemfile.lock
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
blackbook_client (0.1
|
|
4
|
+
blackbook_client (1.0.1)
|
|
5
5
|
httparty (~> 0.15)
|
|
6
6
|
|
|
7
7
|
GEM
|
|
@@ -13,8 +13,12 @@ GEM
|
|
|
13
13
|
safe_yaml (~> 1.0.0)
|
|
14
14
|
diff-lcs (1.3)
|
|
15
15
|
hashdiff (0.3.7)
|
|
16
|
-
httparty (0.
|
|
16
|
+
httparty (0.17.1)
|
|
17
|
+
mime-types (~> 3.0)
|
|
17
18
|
multi_xml (>= 0.5.2)
|
|
19
|
+
mime-types (3.3)
|
|
20
|
+
mime-types-data (~> 3.2015)
|
|
21
|
+
mime-types-data (3.2019.1009)
|
|
18
22
|
multi_xml (0.6.0)
|
|
19
23
|
public_suffix (3.0.1)
|
|
20
24
|
rake (10.5.0)
|
|
@@ -50,4 +54,4 @@ DEPENDENCIES
|
|
|
50
54
|
webmock (~> 3.3)
|
|
51
55
|
|
|
52
56
|
BUNDLED WITH
|
|
53
|
-
1.16.
|
|
57
|
+
1.16.6
|
data/README.md
CHANGED
|
@@ -27,9 +27,11 @@ Or install it yourself as:
|
|
|
27
27
|
#### Call the desired method
|
|
28
28
|
|
|
29
29
|
BlackbookClient.range_by_vin('19XFC1F79GE216281')
|
|
30
|
-
|
|
30
|
+
|
|
31
31
|
BlackbookClient.range_by_vin('19XFC1F79GE216281', { state: 'NY', mileage: 40000 })
|
|
32
32
|
|
|
33
|
+
BlackbookClient.range_by_chromedata_id(1000, { state: 'NY', mileage: 40000, chromeoptions: 'SE' })
|
|
34
|
+
|
|
33
35
|
#### Wait for the answer
|
|
34
36
|
|
|
35
37
|
{ range: { xclean: 16950, clean: 16375, average: 15650, rough: 14750 } }
|
data/blackbook_client.gemspec
CHANGED
|
@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
|
|
|
8
8
|
spec.version = BlackbookClient::VERSION
|
|
9
9
|
spec.authors = ['Christian Schmeichel']
|
|
10
10
|
spec.email = ['cschmeichel@theappraisallane.com']
|
|
11
|
-
spec.date = '
|
|
11
|
+
spec.date = Time.now.strftime('%Y-%m-%d')
|
|
12
12
|
|
|
13
13
|
spec.summary = %q{Blackbook Client}
|
|
14
14
|
spec.description = %q{A wrapper around BlackBook web services.}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
module AutocompleteService
|
|
2
|
+
include HttpRestClient
|
|
3
|
+
|
|
4
|
+
VEHICLE_AUTOCOMPLETE_URL = "#{BASE_URL}/UsedCarWS/UsedCarWS/Autocomplete".freeze
|
|
5
|
+
|
|
6
|
+
def lookup_autocomplete(query_params = {})
|
|
7
|
+
begin
|
|
8
|
+
response = HTTParty.get(VEHICLE_AUTOCOMPLETE_URL, headers: headers, query: query_params)
|
|
9
|
+
process_response(JSON.parse(response.body), :transformer)
|
|
10
|
+
rescue => e
|
|
11
|
+
[{ error: e.to_s }, 500]
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
def transformer(response)
|
|
16
|
+
return [] unless response && response['autocomplete']
|
|
17
|
+
response['autocomplete']
|
|
18
|
+
end
|
|
19
|
+
end
|
data/lib/blackbook_client.rb
CHANGED
|
@@ -1,11 +1,17 @@
|
|
|
1
1
|
require 'blackbook_client/version'
|
|
2
2
|
require 'trade_service'
|
|
3
3
|
require 'vin_service'
|
|
4
|
+
require 'chromedata_service'
|
|
5
|
+
require 'autocomplete_service'
|
|
6
|
+
require 'uvc_service'
|
|
4
7
|
require 'httparty'
|
|
5
8
|
|
|
6
9
|
class BlackbookClient
|
|
7
10
|
extend VinService
|
|
11
|
+
extend ChromedataService
|
|
8
12
|
extend TradeService
|
|
13
|
+
extend AutocompleteService
|
|
14
|
+
extend UVCService
|
|
9
15
|
|
|
10
16
|
class << self
|
|
11
17
|
attr_accessor :username, :password
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
module ChromedataService
|
|
2
|
+
include HttpRestClient
|
|
3
|
+
VEHICLE_BY_CHROMEDATA_URL =
|
|
4
|
+
"#{BASE_URL}/UsedCarWS/UsedCarWS/UsedVehicle/Chrome".freeze
|
|
5
|
+
|
|
6
|
+
def range_by_chromedata_id(chrome_id, query_params ={})
|
|
7
|
+
url = "#{VEHICLE_BY_CHROMEDATA_URL}/#{chrome_id}"
|
|
8
|
+
|
|
9
|
+
begin
|
|
10
|
+
response = HTTParty.get(url, headers: headers, query: query_params)
|
|
11
|
+
process_response(JSON.parse(response.body), :map_fields)
|
|
12
|
+
rescue => e
|
|
13
|
+
[{ error: e.to_s }, 500]
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
|
|
2
|
+
module HttpRestClient
|
|
3
|
+
|
|
4
|
+
BASE_URL = 'https://service.blackbookcloud.com'.freeze
|
|
5
|
+
|
|
6
|
+
def headers
|
|
7
|
+
token = Base64.encode64("#{username}:#{password}")
|
|
8
|
+
{ Authorization: "Basic #{token}" }
|
|
9
|
+
end
|
|
10
|
+
|
|
11
|
+
def make_request(method, url, query_params = {})
|
|
12
|
+
return unless [:get].include?(method)
|
|
13
|
+
begin
|
|
14
|
+
response = JSON.parse(HTTParty.send(method, url, headers: headers, query: query_params).body)
|
|
15
|
+
status = 200
|
|
16
|
+
|
|
17
|
+
if response['error_count'].positive? || message_with_error(response)
|
|
18
|
+
response = { error: response['message_list'][0]['description'] }
|
|
19
|
+
status = 400
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
[response, status]
|
|
23
|
+
|
|
24
|
+
rescue => e
|
|
25
|
+
[ { error: e.to_s }, 500]
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
def message_with_error(response)
|
|
30
|
+
response['message_list'].any? && response['message_list'][0]['type'] == 'Error'
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# TODO: deprecate this and start using make_request in services as it is used in vin_service and uvc_service
|
|
34
|
+
def process_response(response, transformer = nil)
|
|
35
|
+
status = 200
|
|
36
|
+
|
|
37
|
+
if response['error_count'].positive?
|
|
38
|
+
response = { error: response['message_list'][0]['description'] }
|
|
39
|
+
status = 400
|
|
40
|
+
elsif transformer
|
|
41
|
+
response = send(transformer, response)
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
[response, status]
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
# TODO: deprecate and start using mappers lib/mappers as in vin_service and uvc_service
|
|
48
|
+
def map_fields(response)
|
|
49
|
+
return {} unless response && response['used_vehicles'] && response['used_vehicles']['used_vehicle_list']
|
|
50
|
+
vehicle_range = response['used_vehicles']['used_vehicle_list'][0]
|
|
51
|
+
|
|
52
|
+
return {
|
|
53
|
+
range: {
|
|
54
|
+
xclean: vehicle_range['adjusted_whole_xclean'],
|
|
55
|
+
clean: vehicle_range['adjusted_whole_clean'],
|
|
56
|
+
average: vehicle_range['adjusted_whole_avg'],
|
|
57
|
+
rough: vehicle_range['adjusted_whole_rough']
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
end
|
|
61
|
+
end
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
module RangeValuesMapper
|
|
2
|
+
def self.map_fields(response)
|
|
3
|
+
return {} unless response&.dig('used_vehicles', 'used_vehicle_list')
|
|
4
|
+
vehicle_range = response['used_vehicles']['used_vehicle_list'][0]
|
|
5
|
+
|
|
6
|
+
return {
|
|
7
|
+
range: {
|
|
8
|
+
xclean: vehicle_range['adjusted_whole_xclean'],
|
|
9
|
+
clean: vehicle_range['adjusted_whole_clean'],
|
|
10
|
+
average: vehicle_range['adjusted_whole_avg'],
|
|
11
|
+
rough: vehicle_range['adjusted_whole_rough']
|
|
12
|
+
}
|
|
13
|
+
}
|
|
14
|
+
end
|
|
15
|
+
end
|
data/lib/uvc_service.rb
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
require 'mappers/spec_pdf_mapper'
|
|
2
|
+
require 'vin_service'
|
|
3
|
+
|
|
4
|
+
module UVCService
|
|
5
|
+
include SpecPdfMapper
|
|
6
|
+
include VinService
|
|
7
|
+
include HttpRestClient
|
|
8
|
+
|
|
9
|
+
VEHICLE_BY_UVC_URL =
|
|
10
|
+
"#{BASE_URL}/UsedCarWS/UsedCarWS/UsedVehicle/UVC".freeze
|
|
11
|
+
|
|
12
|
+
PDF_SPEC_BY_UVC_URL =
|
|
13
|
+
"#{BASE_URL}/UsedCarWS/UsedCarWS/PDFSpecs".freeze
|
|
14
|
+
|
|
15
|
+
def range_by_uvc(uvc_id, query_params = {})
|
|
16
|
+
url = "#{VEHICLE_BY_UVC_URL}/#{uvc_id}"
|
|
17
|
+
|
|
18
|
+
response = make_request(:get, url, query_params)
|
|
19
|
+
return response unless response.last == 200
|
|
20
|
+
[RangeValuesMapper.map_fields(response.first), response.last]
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
def spec_pdf_data(uvc, query_params = {})
|
|
24
|
+
url = "#{PDF_SPEC_BY_UVC_URL}/#{uvc}"
|
|
25
|
+
|
|
26
|
+
response = make_request(:get, url, query_params)
|
|
27
|
+
return response unless response.last == 200
|
|
28
|
+
[SpecPdfMapper.map_fields(response.first), response.last]
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
# This method is used by web-system to generate vehicle spec pdfs for appraisers
|
|
32
|
+
def pdf_data_by_vin(vin, query_params = {})
|
|
33
|
+
response = uvc_by_vin(vin, query_params)
|
|
34
|
+
return response unless response.last == 200
|
|
35
|
+
spec_pdf_data(response.first[:uvc], query_params)
|
|
36
|
+
end
|
|
37
|
+
end
|
data/lib/vin_service.rb
CHANGED
|
@@ -1,48 +1,27 @@
|
|
|
1
|
+
require 'http_rest_client'
|
|
2
|
+
require 'mappers/uvc_mapper'
|
|
3
|
+
require 'mappers/range_values_mapper'
|
|
4
|
+
|
|
1
5
|
module VinService
|
|
6
|
+
include UvcMapper
|
|
7
|
+
include RangeValuesMapper
|
|
8
|
+
include HttpRestClient
|
|
2
9
|
|
|
3
|
-
BASE_URL = 'https://service.blackbookcloud.com'.freeze
|
|
4
10
|
VEHICLE_BY_VIN_URL = "#{BASE_URL}/UsedCarWS/UsedCarWS/UsedVehicle/VIN".freeze
|
|
5
11
|
|
|
6
12
|
def range_by_vin(vin, query_params = {})
|
|
7
13
|
url = "#{VEHICLE_BY_VIN_URL}/#{vin}"
|
|
8
14
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
rescue => e
|
|
13
|
-
[{ error: e.to_s }, 500]
|
|
14
|
-
end
|
|
15
|
-
end
|
|
16
|
-
|
|
17
|
-
def headers
|
|
18
|
-
token = Base64.encode64("#{username}:#{password}")
|
|
19
|
-
{ Authorization: "Basic #{token}" }
|
|
20
|
-
end
|
|
21
|
-
|
|
22
|
-
def process_response(response)
|
|
23
|
-
status = 200
|
|
24
|
-
|
|
25
|
-
if response['error_count'].positive?
|
|
26
|
-
response = { error: response['message_list'][0]['description'] }
|
|
27
|
-
status = 400
|
|
28
|
-
else
|
|
29
|
-
response = map_fields(response)
|
|
30
|
-
end
|
|
31
|
-
|
|
32
|
-
[response, status]
|
|
15
|
+
response = make_request(:get, url, query_params)
|
|
16
|
+
return response unless response.last == 200
|
|
17
|
+
[RangeValuesMapper.map_fields(response.first), response.last]
|
|
33
18
|
end
|
|
34
19
|
|
|
35
|
-
def
|
|
36
|
-
|
|
37
|
-
vehicle_range = response['used_vehicles']['used_vehicle_list'][0]
|
|
20
|
+
def uvc_by_vin(vin, query_params = {})
|
|
21
|
+
url = "#{VEHICLE_BY_VIN_URL}/#{vin}"
|
|
38
22
|
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
clean: vehicle_range['adjusted_whole_clean'],
|
|
43
|
-
average: vehicle_range['adjusted_whole_avg'],
|
|
44
|
-
rough: vehicle_range['adjusted_whole_rough']
|
|
45
|
-
}
|
|
46
|
-
}
|
|
23
|
+
response = make_request(:get, url, query_params)
|
|
24
|
+
return response unless response.last == 200
|
|
25
|
+
[UvcMapper.map_fields(response.first), response.last]
|
|
47
26
|
end
|
|
48
|
-
end
|
|
27
|
+
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: blackbook_client
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1
|
|
4
|
+
version: 1.0.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Christian Schmeichel
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2019-11-13 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: httparty
|
|
@@ -101,6 +101,7 @@ executables: []
|
|
|
101
101
|
extensions: []
|
|
102
102
|
extra_rdoc_files: []
|
|
103
103
|
files:
|
|
104
|
+
- ".github/PULL_REQUEST_TEMPLATE.md"
|
|
104
105
|
- ".gitignore"
|
|
105
106
|
- ".rspec"
|
|
106
107
|
- ".ruby-gemset"
|
|
@@ -114,9 +115,16 @@ files:
|
|
|
114
115
|
- bin/console
|
|
115
116
|
- bin/setup
|
|
116
117
|
- blackbook_client.gemspec
|
|
118
|
+
- lib/autocomplete_service.rb
|
|
117
119
|
- lib/blackbook_client.rb
|
|
118
120
|
- lib/blackbook_client/version.rb
|
|
121
|
+
- lib/chromedata_service.rb
|
|
122
|
+
- lib/http_rest_client.rb
|
|
123
|
+
- lib/mappers/range_values_mapper.rb
|
|
124
|
+
- lib/mappers/spec_pdf_mapper.rb
|
|
125
|
+
- lib/mappers/uvc_mapper.rb
|
|
119
126
|
- lib/trade_service.rb
|
|
127
|
+
- lib/uvc_service.rb
|
|
120
128
|
- lib/vin_service.rb
|
|
121
129
|
homepage: https://github.com/theappraisallane/blackbook-client
|
|
122
130
|
licenses:
|