dadata_test.go

// Live API tests.
// To run API test pass `DADATA_API_KEY` and `DADATA_SECRET_KEY` environment variables with your values.
package dadata

import (
	"bytes"
	"context"
	"fmt"
	"net/url"
	"os"
	"testing"

	"github.com/ekomobile/dadata/v2/client"
	"github.com/ekomobile/dadata/v2/client/transport/encoder"
	"github.com/stretchr/testify/suite"

	"github.com/ekomobile/dadata/v2/api/suggest"
)

type (
	ApiSuggestIntegrationTest struct {
		suite.Suite
	}

	ApiCleanIntegrationTest struct {
		suite.Suite
	}
)

func (s *ApiSuggestIntegrationTest) SetupSuite() {
	if _, ok := os.LookupEnv("DADATA_API_KEY"); !ok {
		s.Suite.T().Skip("no api keys in env")
	}
}

func (s *ApiCleanIntegrationTest) SetupSuite() {
	if _, ok := os.LookupEnv("DADATA_API_KEY"); !ok {
		s.Suite.T().Skip("no api keys in env")
	}
}

func TestSuggestApiIntegration(t *testing.T) {
	suite.Run(t, &ApiSuggestIntegrationTest{})
}

func TestCleanApiIntegration(t *testing.T) {
	suite.Run(t, &ApiCleanIntegrationTest{})
}

func (s *ApiSuggestIntegrationTest) TestAddress() {
	api := NewSuggestApi()
	params := suggest.RequestParams{
		Query: "ул Свободы",
	}
	res, err := api.Address(context.Background(), &params)
	s.NoError(err)
	s.NotEmpty(res)
}

func (s *ApiSuggestIntegrationTest) TestAddress_low_level() {
	var err error
	endpointUrl, err := url.Parse(EndpointURLSuggest)
	if err != nil {
		return
	}

	cli := client.NewClient(endpointUrl,
		client.WithEncoderFactory(encoder.RawEncoderFactory()),
		client.WithDecoderFactory(encoder.RawDecoderFactory()),
	)

	request := bytes.NewBufferString("{ \"query\": \"москва хабар\" }")
	response := &bytes.Buffer{}

	err = cli.Post(context.Background(), "suggest/address", request, response)

	s.NoError(err)
	s.NotEmpty(response.String())
}

func (s *ApiSuggestIntegrationTest) TestAddressWithLanguageParamRU() {
	api := NewSuggestApi()

	params := suggest.RequestParams{
		Query:    "ул Свободы",
		Language: "RU",
	}

	res, err := api.Address(context.Background(), &params)

	s.NoError(err)
	s.NotEmpty(res)
}

func (s *ApiSuggestIntegrationTest) TestAddressWithLanguageParamEN() {
	api := NewSuggestApi()

	params := suggest.RequestParams{
		Query:    "ул Свободы",
		Language: "EN",
	}

	res, err := api.Address(context.Background(), &params)

	s.NoError(err)
	s.NotEmpty(res)
}

func (s *ApiSuggestIntegrationTest) TestBank() {
	api := NewSuggestApi()
	params := suggest.RequestParams{
		Query: "сбербанк",
	}
	res, err := api.Bank(context.Background(), &params)
	s.NoError(err)
	s.NotEmpty(res)
}

func (s *ApiSuggestIntegrationTest) TestParty() {
	api := NewSuggestApi()
	params := suggest.RequestParams{
		Query: "сбербанк",
	}
	res, err := api.Party(context.Background(), &params)
	s.NoError(err)
	s.NotEmpty(res)
}

func (s *ApiSuggestIntegrationTest) TestPartyWithTypePositive() {
	api := NewSuggestApi()

	// positive: there are some legal entities "сбербанк"
	res, err := api.Party(context.Background(), &suggest.RequestParams{
		Query: "сбербанк",
		Type:  suggest.PartyTypeLegal,
	})

	s.NoError(err)
	s.NotEmpty(res)
}

func (s *ApiSuggestIntegrationTest) TestPartyWithTypeNegative() {
	api := NewSuggestApi()

	// there are no one individual entrepreneur "сбербанк"
	res, err := api.Party(context.Background(), &suggest.RequestParams{
		Query: "сбербанк",
		Type:  suggest.PartyTypeIndividual,
	})

	s.NoError(err)
	s.Empty(res)
}

func (s *ApiSuggestIntegrationTest) TestPartyById() {
	api := NewSuggestApi()

	query := "7707083893"
	params := suggest.NewPartyByIDParams(query)

	res, err := api.PartyByID(context.Background(), params)

	s.NoError(err)
	s.NotEmpty(res)
}

func (s *ApiSuggestIntegrationTest) TestPartyByIdWithKPP() {
	api := NewSuggestApi()

	query := "7707083893"
	testKPP := "773601001"

	params := suggest.NewPartyByIDParams(query).
		SetKPP(testKPP)

	res, err := api.PartyByID(context.Background(), params)

	s.NoError(err)
	s.NotEmpty(res)
	s.Equal(query, res[0].Data.Inn)
	s.Equal(testKPP, res[0].Data.Kpp)
}

func (s *ApiSuggestIntegrationTest) TestPartyByIdWithBranchType() {
	api := NewSuggestApi()

	query := "7707083893"

	params := suggest.NewPartyByIDParams(query).
		SetBranchType(suggest.PartyBranchTypeMain).
		SetType(suggest.PartyTypeLegal)

	res, err := api.PartyByID(context.Background(), params)

	s.NoError(err)
	s.NotEmpty(res)
	s.Equal(query, res[0].Data.Inn)
}

func (s *ApiSuggestIntegrationTest) TestPartyByIdWithStatusActive() {
	api := NewSuggestApi()

	query := "7707083893"

	params := suggest.NewPartyByIDParams(query).
		SetBranchType(suggest.PartyBranchTypeMain).
		SetType(suggest.PartyTypeLegal).
		SetStatus(suggest.PartyStatusActive)

	res, err := api.PartyByID(context.Background(), params)

	s.NoError(err)
	s.NotEmpty(res)
	s.Equal(query, res[0].Data.Inn)
	s.Equal(string(suggest.PartyStatusActive), res[0].Data.State.Status)
}

func (s *ApiSuggestIntegrationTest) TestPartyByIdWithStatusLiquidatedAndActive() {
	api := NewSuggestApi()

	query := "7707083893"

	params := suggest.NewPartyByIDParams(query).
		SetBranchType(suggest.PartyBranchTypeMain).
		SetType(suggest.PartyTypeLegal).
		SetStatus(suggest.PartyStatusLiquidated, suggest.PartyStatusActive)

	res, err := api.PartyByID(context.Background(), params)

	s.NoError(err)
	s.NotEmpty(res)
	s.Equal(query, res[0].Data.Inn)
	s.Equal(string(suggest.PartyStatusActive), res[0].Data.State.Status)
}

func (s *ApiSuggestIntegrationTest) TestPartyByIdWithStatusLiquidatedNegative() {
	api := NewSuggestApi()

	query := "7707083893"

	params := suggest.NewPartyByIDParams(query).
		SetBranchType(suggest.PartyBranchTypeMain).
		SetType(suggest.PartyTypeLegal).
		SetStatus(suggest.PartyStatusLiquidated)

	res, err := api.PartyByID(context.Background(), params)

	s.NoError(err)
	s.Len(res, 0)
}

func (s *ApiSuggestIntegrationTest) TestCountry() {
	api := NewSuggestApi()
	params := suggest.RequestParams{
		Query: "росс",
	}
	res, err := api.Country(context.Background(), &params)
	s.NoError(err)
	s.NotEmpty(res)
}

func (s *ApiSuggestIntegrationTest) TestName() {
	api := NewSuggestApi()
	params := suggest.RequestParams{
		Query: "але",
	}
	res, err := api.Name(context.Background(), &params)
	s.NoError(err)
	s.NotEmpty(res)
}

func (s *ApiSuggestIntegrationTest) TestNameWithParts() {
	api := NewSuggestApi()
	params := suggest.RequestParams{
		Query: "але",
	}
	res, err := api.Name(context.Background(), &params, suggest.WithNameParts(suggest.NamePartSurname))
	s.NoError(err)
	s.NotEmpty(res)
}

func (s *ApiSuggestIntegrationTest) TestNameWithGender() {
	api := NewSuggestApi()
	params := suggest.RequestParams{
		Query: "але",
	}
	res, err := api.Name(context.Background(), &params, suggest.WithNameGender(suggest.NameGenderFemale))
	s.NoError(err)
	s.NotEmpty(res)
}

func (s *ApiSuggestIntegrationTest) TestEmail() {
	api := NewSuggestApi()
	params := suggest.RequestParams{
		Query: "ax",
	}
	res, err := api.Email(context.Background(), &params)
	s.NoError(err)
	s.NotEmpty(res)
}

func (s *ApiSuggestIntegrationTest) TestFMSUnit() {
	api := NewSuggestApi()
	params := suggest.RequestParams{
		Query: "увд",
	}
	res, err := api.FMSUnit(context.Background(), &params)
	s.NoError(err)
	s.NotEmpty(res)
}

func (s *ApiCleanIntegrationTest) TestAddress() {
	api := NewCleanApi()
	res, err := api.Address(context.Background(), "мск сухонска 11/-89")
	s.NoError(err)
	s.NotEmpty(res)
	s.Len(res, 1)
}

func (s *ApiCleanIntegrationTest) TestPhone() {
	api := NewCleanApi()
	res, err := api.Phone(context.Background(), "+79851234567")
	s.NoError(err)
	s.NotEmpty(res)
	s.Len(res, 1)
}

func (s *ApiCleanIntegrationTest) TestName() {
	api := NewCleanApi()
	res, err := api.Name(context.Background(), "Срегей владимерович иванов")
	s.NoError(err)
	s.NotEmpty(res)
	s.Len(res, 1)
}

func (s *ApiCleanIntegrationTest) TestEmail() {
	api := NewCleanApi()
	res, err := api.Email(context.Background(), "serega@yandex/ru")
	s.NoError(err)
	s.NotEmpty(res)
	s.Len(res, 1)
}

func (s *ApiCleanIntegrationTest) TestBirthday() {
	api := NewCleanApi()
	res, err := api.Birthday(context.Background(), "12 12 12")
	s.NoError(err)
	s.NotEmpty(res)
	s.Len(res, 1)
}

func (s *ApiCleanIntegrationTest) TestVehicle() {
	api := NewCleanApi()
	res, err := api.Vehicle(context.Background(), "форд фокус")
	s.NoError(err)
	s.NotEmpty(res)
	s.Len(res, 1)
}

func (s *ApiCleanIntegrationTest) TestPassport() {
	api := NewCleanApi()
	res, err := api.Passport(context.Background(), "4509 235857")
	s.NoError(err)
	s.NotEmpty(res)
	s.Len(res, 1)
}

func (s *ApiSuggestIntegrationTest) TestGeoLocateWithoutLongitude() {
	api := NewSuggestApi()

	params := suggest.GeolocateParams{
		Lat: "55.878",
	}

	res, err := api.GeoLocate(context.Background(), &params)

	s.NoError(err)
	s.Empty(res)
}

func (s *ApiSuggestIntegrationTest) TestGeoLocateWithoutLatitude() {
	api := NewSuggestApi()

	params := suggest.GeolocateParams{
		Lon: "37.653",
	}

	res, err := api.GeoLocate(context.Background(), &params)

	s.NoError(err)
	s.Empty(res)
}

func (s *ApiSuggestIntegrationTest) TestGeoLocateWithEmptyBody() {
	api := NewSuggestApi()

	params := suggest.GeolocateParams{}

	res, err := api.GeoLocate(context.Background(), &params)

	s.NoError(err)
	s.Empty(res)
}

func (s *ApiSuggestIntegrationTest) TestGeoLocateWithLanguageParamRU() {
	api := NewSuggestApi()

	params := suggest.GeolocateParams{
		Lat:      "55.878",
		Lon:      "37.653",
		Language: "RU",
	}

	res, err := api.GeoLocate(context.Background(), &params)

	s.NoError(err)
	s.NotEmpty(res)
}

func (s *ApiSuggestIntegrationTest) TestGeoLocateWithLanguageParamEN() {
	api := NewSuggestApi()

	params := suggest.GeolocateParams{
		Lat:      "55.878",
		Lon:      "37.653",
		Language: "EN",
	}

	res, err := api.GeoLocate(context.Background(), &params)

	s.NoError(err)
	s.NotEmpty(res)
}

func (s *ApiSuggestIntegrationTest) TestGeoLocateWithCountTwo() {
	api := NewSuggestApi()
	reqElementCount := 2

	params := suggest.GeolocateParams{
		Lat:      "55.878",
		Lon:      "37.653",
		Language: "EN",
		Count:    reqElementCount,
	}

	res, err := api.GeoLocate(context.Background(), &params)

	s.NoError(err)
	s.Len(res, reqElementCount)
}

func (s *ApiSuggestIntegrationTest) TestGeoLocateWithRadius() {
	api := NewSuggestApi()

	params := suggest.GeolocateParams{
		Lat:          "55.878",
		Lon:          "37.653",
		Language:     "EN",
		RadiusMeters: 100,
	}

	res, err := api.GeoLocate(context.Background(), &params)

	s.NoError(err)
	s.NotEmpty(res)
}

func ExampleNewSuggestApi() {
	api := NewSuggestApi()

	params := suggest.RequestParams{
		Query: "ул Свободы",
	}

	suggestions, err := api.Address(context.Background(), &params)
	if err != nil {
		return
	}

	for _, s := range suggestions {
		fmt.Printf("%s", s.Value)
	}
}