implement gateway for 17vin decoder (#284)

* implement gateway for 17vin decoder

* decoding working with mmy

* test, implement into decoding service

Author: JamesReate

cmd/device-definitions-api/decode_vin.go

@@ -5,8 +5,9 @@ import (
 	"flag"
 	"fmt"
 
+	"github.com/goccy/go-json"
+
 	"github.com/DIMO-Network/device-definitions-api/internal/config"
-	"github.com/DIMO-Network/device-definitions-api/internal/core/services"
 	"github.com/DIMO-Network/device-definitions-api/internal/infrastructure/gateways"
 	"github.com/google/subcommands"
 	"github.com/rs/zerolog"
@@ -16,23 +17,25 @@ type decodeVINCmd struct {
 	logger   *zerolog.Logger
 	settings *config.Settings
 
-	datGroup bool
-	drivly   bool
-	vincario bool
+	datGroup   bool
+	drivly     bool
+	vincario   bool
+	japan17vin bool
 }
 
 func (*decodeVINCmd) Name() string { return "decodevin" }
 func (*decodeVINCmd) Synopsis() string {
 	return "tries decoding a vin with chosen provider - does not insert in our db"
 }
 func (*decodeVINCmd) Usage() string {
-	return `decodevin [-dat|-drivly|-vincario] <vin 17 chars> <country two letter iso>`
+	return `decodevin [-dat|-drivly|-vincario|-japan17vin] <vin 17 chars> <country two letter iso>`
 }
 
 func (p *decodeVINCmd) SetFlags(f *flag.FlagSet) {
 	f.BoolVar(&p.datGroup, "dat", false, "use dat group vin decoder")
-	f.BoolVar(&p.datGroup, "drivly", false, "use drivly vin decoder")
-	f.BoolVar(&p.datGroup, "vincario", false, "use vincario vin decoder")
+	f.BoolVar(&p.drivly, "drivly", false, "use drivly vin decoder")
+	f.BoolVar(&p.vincario, "vincario", false, "use vincario vin decoder")
+	f.BoolVar(&p.japan17vin, "japan17vin", false, "use japan17vin vin decoder")
 }
 
 func (p *decodeVINCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interface{}) subcommands.ExitStatus {
@@ -41,11 +44,8 @@ func (p *decodeVINCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interfac
 		return subcommands.ExitUsageError
 	}
 	vin := f.Args()[0]
-	if !services.ValidateVIN(vin) {
-		fmt.Println("invalid vin")
-		return subcommands.ExitUsageError
-	}
-	country := "US"
+
+	country := "USA"
 	if len(f.Args()) == 2 {
 		country = f.Args()[1]
 	}
@@ -83,6 +83,19 @@ func (p *decodeVINCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interfac
 
 		fmt.Printf("VIN Response: %+v\n", vinInfo)
 	}
+	if p.japan17vin {
+		jp17vinAPI := gateways.NewJapan17VINAPI(p.logger, p.settings)
+		vinInfo, payload, err := jp17vinAPI.GetVINInfo(vin)
+		if err != nil {
+			fmt.Println(err.Error())
+			return subcommands.ExitFailure
+		}
+		jsonBytes, _ := json.MarshalIndent(vinInfo, "", " ")
+		fmt.Println("VIN Info:")
+		fmt.Println(string(jsonBytes))
+		fmt.Println("Raw JSON Payload:")
+		fmt.Println(string(payload))
+	}
 
 	fmt.Println()
 	return subcommands.ExitSuccess

go.mod

@@ -12,6 +12,7 @@ require (
 	github.com/docker/go-connections v0.5.0
 	github.com/ethereum/go-ethereum v1.14.7
 	github.com/friendsofgo/errors v0.9.2
+	github.com/goccy/go-json v0.10.2
 	github.com/gofiber/adaptor/v2 v2.2.1
 	github.com/gofiber/contrib/jwt v1.0.10
 	github.com/gofiber/fiber/v2 v2.52.5
@@ -20,7 +21,6 @@ require (
 	github.com/grpc-ecosystem/go-grpc-middleware/v2 v2.1.0
 	github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0
 	github.com/jarcoal/httpmock v1.1.0
-	github.com/lib/pq v1.10.9
 	github.com/mitchellh/mapstructure v1.5.0
 	github.com/patrickmn/go-cache v2.1.0+incompatible
 	github.com/pkg/errors v0.9.1
@@ -88,6 +88,7 @@ require (
 	github.com/googleapis/gax-go/v2 v2.13.0 // indirect
 	github.com/gorilla/websocket v1.5.3 // indirect
 	github.com/holiman/uint256 v1.3.1 // indirect
+	github.com/lib/pq v1.10.9 // indirect
 	github.com/lufia/plan9stats v0.0.0-20240513124658-fba389f38bae // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect

go.sum

@@ -327,6 +327,8 @@ github.com/go-redis/redis/v8 v8.11.5/go.mod h1:gREzHqY1hg6oD9ngVRbLStwAWKhA0FEgq
 github.com/go-sql-driver/mysql v1.6.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LBy8hT2VhHyBg=
 github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY=
 github.com/go-task/slim-sprig v0.0.0-20210107165309-348f09dbbbc0/go.mod h1:fyg7847qk6SyHyPtNmDHnmrv/HOrqktSC+C9fM+CJOE=
+github.com/goccy/go-json v0.10.2 h1:CrxCmQqYDkv1z7lO7Wbh2HN93uovUHgrECaO5ZrCXAU=
+github.com/goccy/go-json v0.10.2/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I=
 github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
 github.com/gofiber/adaptor/v2 v2.2.1 h1:givE7iViQWlsTR4Jh7tB4iXzrlKBgiraB/yTdHs9Lv4=
 github.com/gofiber/adaptor/v2 v2.2.1/go.mod h1:AhR16dEqs25W2FY/l8gSj1b51Azg5dtPDmm+pruNOrc=

internal/api/api.go

@@ -59,6 +59,7 @@ func Run(ctx context.Context, logger zerolog.Logger, settings *config.Settings,
 	vincarioAPIService := gateways.NewVincarioAPIService(settings, &logger)
 	fuelAPIService := gateways.NewFuelAPIService(settings, &logger)
 	autoIsoAPIService := gateways.NewAutoIsoAPIService(settings.AutoIsoAPIUid, settings.AutoIsoAPIKey)
+	japan17VINAPI := gateways.NewJapan17VINAPI(&logger, settings)
 	registryInstance, err := contracts.NewRegistry(settings.EthereumRegistryAddress, ethClient)
 	if err != nil {
 		logger.Fatal().Err(err).Msg("Failed to create registry query instance.")
@@ -73,7 +74,7 @@ func Run(ctx context.Context, logger zerolog.Logger, settings *config.Settings,
 	vinRepository := repositories.NewVINRepository(pdb.DBS, registryInstance)
 
 	//cache services
-	vincDecodingService := services.NewVINDecodingService(drivlyAPIService, vincarioAPIService, autoIsoAPIService, &logger, ddOnChainService, datGroupWSService, pdb.DBS)
+	vincDecodingService := services.NewVINDecodingService(drivlyAPIService, vincarioAPIService, autoIsoAPIService, &logger, ddOnChainService, datGroupWSService, pdb.DBS, japan17VINAPI)
 	powerTrainTypeService, err := services.NewPowerTrainTypeService("powertrain_type_rule.yaml", &logger, ddOnChainService)
 	searchService := search.NewTypesenseAPIService(settings, &logger)
 	if err != nil {

internal/config/settings.go

@@ -51,6 +51,8 @@ type Settings struct {
 	IdentityAPIURL                    url.URL        `yaml:"IDENTITY_API_URL"`
 	PolygonScanAPIKey                 string         `yaml:"POLYGON_SCAN_API_KEY"`
 	GoogleSheetsCredentials           string         `yaml:"GOOGLE_SHEETS_CREDENTIALS"`
+	Japan17VINUser                    string         `yaml:"JAPAN17_VIN_USER"`
+	Japan17VINPassword                string         `yaml:"JAPAN17_VIN_PASSWORD"`
 }
 
 func (s *Settings) IsProd() bool {

internal/core/models/vin_decoding_models.go

@@ -18,6 +18,7 @@ const (
 	DATGroupProvider DecodeProviderEnum = "dat"
 	AllProviders     DecodeProviderEnum = ""
 	TeslaProvider    DecodeProviderEnum = "tesla"
+	Japan17VIN       DecodeProviderEnum = "japan17vin"
 )
 
 type VINDecodingInfoData struct {
@@ -403,3 +404,12 @@ type DATGroupEquipment struct {
 	ManufacturerDescription string `json:"manufacturerDescription"`
 	Description             string `json:"description"`
 }
+
+// nolint
+type Japan17MMY struct {
+	VIN                   string `json:"vin"`
+	ManufacturerName      string `json:"manufacturerName"`
+	ManufacturerLowerCase string `json:"manufacturerLowerCase"`
+	ModelName             string `json:"modelName"`
+	Year                  int    `json:"year"`
+}

internal/core/queries/decode_vin.go

@@ -204,7 +204,7 @@ func (dc DecodeVINQueryHandler) Handle(ctx context.Context, query mediator.Messa
 	}
 	// not a tesla, regular decode path
 	if vinInfo == nil || vinInfo.Model == "" {
-		vinInfo, err = dc.vinDecodingService.GetVIN(ctx, vin.String(), dt, coremodels.AllProviders, qry.Country) // this will try drivly first
+		vinInfo, err = dc.vinDecodingService.GetVIN(ctx, vin.String(), dt, coremodels.AllProviders, qry.Country) // this will try drivly first unless of japan
 	}
 
 	// if no luck decoding VIN, try buildingVinInfo from known data passed in, typically smartcar or software connections

internal/core/services/vin_decoding_service.go

@@ -32,19 +32,21 @@ type VINDecodingService interface {
 }
 
 type vinDecodingService struct {
+	logger             *zerolog.Logger
 	drivlyAPISvc       gateways.DrivlyAPIService
 	vincarioAPISvc     gateways.VincarioAPIService
-	logger             *zerolog.Logger
 	autoIsoAPIService  gateways.AutoIsoAPIService
 	DATGroupAPIService gateways.DATGroupAPIService
+	japan17VINAPI      gateways.Japan17VINAPI
 	onChainSvc         gateways.DeviceDefinitionOnChainService
 	dbs                func() *db.ReaderWriter
 }
 
 func NewVINDecodingService(drivlyAPISvc gateways.DrivlyAPIService, vincarioAPISvc gateways.VincarioAPIService, autoIso gateways.AutoIsoAPIService, logger *zerolog.Logger,
-	onChainSvc gateways.DeviceDefinitionOnChainService, datGroupAPIService gateways.DATGroupAPIService, dbs func() *db.ReaderWriter) VINDecodingService {
-	return &vinDecodingService{drivlyAPISvc: drivlyAPISvc, vincarioAPISvc: vincarioAPISvc, autoIsoAPIService: autoIso, logger: logger,
-		onChainSvc: onChainSvc, DATGroupAPIService: datGroupAPIService, dbs: dbs}
+	onChainSvc gateways.DeviceDefinitionOnChainService, datGroupAPIService gateways.DATGroupAPIService, dbs func() *db.ReaderWriter,
+	japan17VINAPI gateways.Japan17VINAPI) VINDecodingService {
+	return &vinDecodingService{drivlyAPISvc: drivlyAPISvc, vincarioAPISvc: vincarioAPISvc, autoIsoAPIService: autoIso,
+		japan17VINAPI: japan17VINAPI, logger: logger, onChainSvc: onChainSvc, DATGroupAPIService: datGroupAPIService, dbs: dbs}
 }
 
 func (c vinDecodingService) GetVIN(ctx context.Context, vin string, dt *repoModel.DeviceType, provider coremodels.DecodeProviderEnum, country string) (*coremodels.VINDecodingInfoData, error) {
@@ -53,7 +55,10 @@ func (c vinDecodingService) GetVIN(ctx context.Context, vin string, dt *repoMode
 
 	result := &coremodels.VINDecodingInfoData{}
 	vin = strings.ToUpper(strings.TrimSpace(vin))
-	if !ValidateVIN(vin) {
+	// check for japan chasis
+	if (len(vin) < 17 && len(vin) > 10) || country == "JPN" {
+		provider = coremodels.Japan17VIN
+	} else if !ValidateVIN(vin) {
 		return nil, fmt.Errorf("invalid vin: %s", vin)
 	}
 
@@ -105,6 +110,20 @@ func (c vinDecodingService) GetVIN(ctx context.Context, vin string, dt *repoMode
 		if err != nil {
 			return nil, err
 		}
+	case coremodels.Japan17VIN:
+		mmy, raw, err := c.japan17VINAPI.GetVINInfo(vin)
+		if err != nil {
+			return nil, errors.Wrapf(err, "unable to decode vin: %s with japan17vin", vin)
+		}
+		result = &coremodels.VINDecodingInfoData{
+			VIN:      vin,
+			Make:     mmy.ManufacturerName,
+			Model:    mmy.ModelName,
+			Year:     int32(mmy.Year),
+			Source:   coremodels.Japan17VIN,
+			MetaData: null.JSONFrom(raw),
+			Raw:      raw,
+		}
 	case coremodels.AutoIsoProvider:
 		vinAutoIsoInfo, err := c.autoIsoAPIService.GetVIN(vin)
 		if err != nil {

internal/core/services/vin_decoding_service_test.go

@@ -32,8 +32,9 @@ type VINDecodingServiceSuite struct {
 	mockVincarioAPISvc     *mock_gateways.MockVincarioAPIService
 	mockAutoIsoAPISvc      *mock_gateways.MockAutoIsoAPIService
 	mockDATGroupAPIService *mock_gateways.MockDATGroupAPIService
-	mockOnChainSvc         *mock_gateways.MockDeviceDefinitionOnChainService
+	mockJapan17VINAPI      *mock_gateways.MockJapan17VINAPI
 
+	mockOnChainSvc     *mock_gateways.MockDeviceDefinitionOnChainService
 	vinDecodingService VINDecodingService
 }
 
@@ -58,10 +59,11 @@ func (s *VINDecodingServiceSuite) SetupTest() {
 	s.mockAutoIsoAPISvc = mock_gateways.NewMockAutoIsoAPIService(s.ctrl)
 	s.mockAutoIsoAPISvc = mock_gateways.NewMockAutoIsoAPIService(s.ctrl)
 	s.mockDATGroupAPIService = mock_gateways.NewMockDATGroupAPIService(s.ctrl)
+	s.mockJapan17VINAPI = mock_gateways.NewMockJapan17VINAPI(s.ctrl)
 	s.mockOnChainSvc = mock_gateways.NewMockDeviceDefinitionOnChainService(s.ctrl)
 
 	s.vinDecodingService = NewVINDecodingService(s.mockDrivlyAPISvc, s.mockVincarioAPISvc, s.mockAutoIsoAPISvc, dbtesthelper.Logger(),
-		s.mockOnChainSvc, s.mockDATGroupAPIService, s.pdb.DBS)
+		s.mockOnChainSvc, s.mockDATGroupAPIService, s.pdb.DBS, s.mockJapan17VINAPI)
 }
 
 func (s *VINDecodingServiceSuite) TearDownTest() {
@@ -76,6 +78,33 @@ func (s *VINDecodingServiceSuite) TearDownSuite() {
 	}
 }
 
+func (s *VINDecodingServiceSuite) Test_VINDecodingService_Japan17VIN_Success() {
+	ctx := context.Background()
+	const vin = "ZWR90-8000186"
+	const makeID = "Toyota"
+	const country = "CHN"
+
+	vinInfoResp := &coremodels.Japan17MMY{
+		VIN:                   vin,
+		ManufacturerName:      makeID,
+		ManufacturerLowerCase: "toyota",
+		ModelName:             "Voxy",
+		Year:                  2022,
+	}
+	s.mockJapan17VINAPI.EXPECT().GetVINInfo(vin).Times(1).Return(vinInfoResp, []byte{0x1, 0x22}, nil)
+
+	dt := dbtesthelper.SetupCreateDeviceType(s.T(), s.pdb)
+
+	result, err := s.vinDecodingService.GetVIN(ctx, vin, dt, coremodels.AllProviders, country)
+
+	s.NoError(err)
+	assert.Equal(s.T(), result.VIN, vin)
+	assert.Equal(s.T(), result.Source, coremodels.Japan17VIN)
+	assert.Equal(s.T(), result.Make, "Toyota")
+	assert.Equal(s.T(), result.Model, "Voxy")
+	assert.Equal(s.T(), result.Year, int32(2022))
+}
+
 func (s *VINDecodingServiceSuite) Test_VINDecodingService_Drivly_Success() {
 	ctx := context.Background()
 	const vin = "1FMCU0G61MUA52727" // ford escape 2021