Skip to content

Commit f328a54

Browse files
authored
rename package from com.davideicardi.kaa to kaa.schemaregistry (#37)
* rename package from com.davideicardi.kaa to kaa.schemaregistry * cleanup * cleanup
1 parent 9541711 commit f328a54

28 files changed

+68
-60
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,16 @@ For serialization [Single object AVRO encoding](https://avro.apache.org/docs/cur
1313

1414
Kaa provides essentially 3 features:
1515

16-
- `com.davideicardi.kaa.KaaSchemaRegistry`: a simple embeddable schema registry that read and write schemas to Kafka
17-
- `com.davideicardi.kaa.avro.AvroSingleObjectSerializer[T]`: an avro serializer/deserializer for case classes, based on Avro4s, that internally uses `KaaSchemaRegistry` for schema resolution
18-
- `com.davideicardi.kaa.avro.GenericAvroSingleObjectSerializer`: an avro serializer/deserializer for `GenericRecord` classes that internally uses `KaaSchemaRegistry` for schema resolution
19-
- `com.davideicardi.kaa.kafka.GenericSerde[T]` an implementation of Kafka's `Serde[T]` based on `AvroSingleObjectSerializer`, that can be used with Kafka Stream
16+
- `kaa.schemaregistry.KaaSchemaRegistry`: a simple embeddable schema registry that read and write schemas to Kafka
17+
- `kaa.schemaregistry.avro.AvroSingleObjectSerializer[T]`: an avro serializer/deserializer for case classes, based on Avro4s, that internally uses `KaaSchemaRegistry` for schema resolution
18+
- `kaa.schemaregistry.avro.GenericAvroSingleObjectSerializer`: an avro serializer/deserializer for `GenericRecord` classes that internally uses `KaaSchemaRegistry` for schema resolution
19+
- `kaa.schemaregistry.kafka.GenericSerde[T]` an implementation of Kafka's `Serde[T]` based on `AvroSingleObjectSerializer`, that can be used with Kafka Stream
2020

2121
During serialization a schema hash is generated and stored inside Kafka with the schema (key=hash, value=schema).
2222
When deserializing the schema is retrieved from Kafka and used for the deserialization.
2323
`KaaSchemaRegistry` internally runs a Kafka consumer to read all schemas that will be cached in memory.
2424

25-
You can use `com.davideicardi.kaa.KaaSchemaRegistryAdmin` to programmatically create Kafka's schema topic.
25+
You can use `kaa.schemaregistry.KaaSchemaRegistryAdmin` to programmatically create Kafka's schema topic.
2626
NOTE: if you want to create the topic manually, remember to put cleanup policy to `compact` to maintain all the schemas.
2727

2828
## Why

build.sbt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ val kafkaVersion = "2.4.0" // NOTE: there is a dependencies to kafka also from a
6868

6969
val testDependencies = Seq(
7070
"org.scalatest" %% "scalatest" % "3.2.0" % "it,test",
71+
"ch.qos.logback" % "logback-classic" % "1.2.3" % "it" exclude("org.slf4j", "slf4j-api"),
7172
)
7273

7374
val dependencies = Seq(
@@ -109,12 +110,11 @@ lazy val kaaRegistryServer = (project in file("kaa-registry-server"))
109110
"com.typesafe.akka" %% "akka-stream" % AkkaVersion,
110111
"com.typesafe.akka" %% "akka-http" % AkkaHttpVersion,
111112
"com.typesafe.akka" %% "akka-http-spray-json" % AkkaHttpVersion,
112-
"ch.qos.logback" % "logback-classic" % "1.2.3",
113113
),
114114
)
115115
.dependsOn(kaa)
116116

117-
lazy val root = (project in file("."))
117+
lazy val kaaRoot = (project in file("."))
118118
.aggregate(kaa, sample)
119119
.settings(
120120
publish / skip := true,

kaa-registry-server/src/main/scala/kaa/EntryPoint.scala renamed to kaa-registry-server/src/main/scala/kaa/schemaregistry/server/EntryPoint.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
package kaa
1+
package kaa.schemaregistry.server
22

33
import java.util.concurrent.CountDownLatch
44

55
import akka.actor.ActorSystem
6-
import com.davideicardi.kaa.{KaaSchemaRegistry, KaaSchemaRegistryAdmin}
6+
import kaa.schemaregistry.{KaaSchemaRegistry, KaaSchemaRegistryAdmin}
77

88
import scala.concurrent.{ExecutionContext, ExecutionContextExecutor}
99

kaa-registry-server/src/main/scala/kaa/KaaController.scala renamed to kaa-registry-server/src/main/scala/kaa/schemaregistry/server/KaaController.scala

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
package kaa
1+
package kaa.schemaregistry.server
2+
23
import akka.http.scaladsl.model.StatusCodes
34
import akka.http.scaladsl.server.Directives._
45
import akka.http.scaladsl.server.Route
5-
import com.davideicardi.kaa.{SchemaId, SchemaRegistry}
6+
import kaa.schemaregistry.{SchemaId, SchemaRegistry}
67

78
import scala.concurrent.ExecutionContext
89

kaa-registry-server/src/main/scala/kaa/KaaHttpService.scala renamed to kaa-registry-server/src/main/scala/kaa/schemaregistry/server/KaaHttpService.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package kaa
1+
package kaa.schemaregistry.server
22

33
import akka.actor.ActorSystem
44
import akka.http.scaladsl.Http

kaa/src/it/resources/logback.xml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<configuration>
2+
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
3+
<!-- encoders are assigned the type ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
4+
<encoder>
5+
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
6+
</encoder>
7+
</appender>
8+
9+
<root level="info">
10+
<appender-ref ref="STDOUT" />
11+
</root>
12+
</configuration>

kaa/src/it/scala/KaaSchemaRegistrySpec.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import java.util.UUID
22

3-
import com.davideicardi.kaa.{KaaSchemaRegistry, KaaSchemaRegistryAdmin, SchemaId}
3+
import kaa.schemaregistry.{KaaSchemaRegistry, KaaSchemaRegistryAdmin, SchemaId}
44
import com.sksamuel.avro4s.AvroSchema
55
import org.scalatest._
66
import org.scalatest.flatspec._

kaa/src/main/scala-2.12/com/davideicardi/kaa/utils/CollectionConverters.scala renamed to kaa/src/main/scala-2.12/kaa/schemaregistry/utils/CollectionConverters.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package com.davideicardi.kaa.utils
1+
package kaa.schemaregistry.utils
22

33
import collection.JavaConverters._
44

kaa/src/main/scala-2.13/com/davideicardi/kaa/utils/CollectionConverters.scala renamed to kaa/src/main/scala-2.13/kaa/schemaregistry/kaa/utils/CollectionConverters.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package com.davideicardi.kaa.utils
1+
package kaa.schemaregistry.utils
22

33
import scala.jdk.CollectionConverters._
44

kaa/src/main/scala/com/davideicardi/kaa/KaaSchemaRegistry.scala renamed to kaa/src/main/scala/kaa/schemaregistry/KaaSchemaRegistry.scala

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package com.davideicardi.kaa
1+
package kaa.schemaregistry
22

33
import java.lang
44

@@ -16,13 +16,13 @@ import org.apache.kafka.common.serialization.{LongDeserializer, StringDeserializ
1616
import org.apache.kafka.common.serialization.{LongSerializer, StringSerializer}
1717

1818
import scala.concurrent.duration._
19-
import com.davideicardi.kaa.utils.Retry
19+
import kaa.schemaregistry.utils.Retry
2020
import java.util.concurrent.atomic.AtomicBoolean
2121

22-
import com.davideicardi.kaa.KaaSchemaRegistry._
22+
import kaa.schemaregistry.KaaSchemaRegistry._
2323

2424
import scala.concurrent._
25-
import com.davideicardi.kaa.utils.RetryConfig
25+
import kaa.schemaregistry.utils.RetryConfig
2626
import org.apache.kafka.clients.CommonClientConfigs
2727

2828
object KaaSchemaRegistry {

kaa/src/main/scala/com/davideicardi/kaa/KaaSchemaRegistryAdmin.scala renamed to kaa/src/main/scala/kaa/schemaregistry/KaaSchemaRegistryAdmin.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
package com.davideicardi.kaa
1+
package kaa.schemaregistry
22

33
import java.util.{Collections, Properties, Optional}
44
import org.apache.kafka.clients.admin.{AdminClient, NewTopic}
55
import org.apache.kafka.common.config.TopicConfig
66

7-
import com.davideicardi.kaa.utils.CollectionConverters
7+
import kaa.schemaregistry.utils.CollectionConverters
88

99
class KaaSchemaRegistryAdmin(
1010
adminProps: Properties,
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package com.davideicardi.kaa
1+
package kaa.schemaregistry
22

33
case class SchemaId(value: Long) extends AnyVal {
44
}

kaa/src/main/scala/com/davideicardi/kaa/SchemaRegistry.scala renamed to kaa/src/main/scala/kaa/schemaregistry/SchemaRegistry.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package com.davideicardi.kaa
1+
package kaa.schemaregistry
22

33
import org.apache.avro.Schema
44

kaa/src/main/scala/com/davideicardi/kaa/avro/AvroBinarySerializer.scala renamed to kaa/src/main/scala/kaa/schemaregistry/avro/AvroBinarySerializer.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package com.davideicardi.kaa.avro
1+
package kaa.schemaregistry.avro
22

33
import java.io.ByteArrayOutputStream
44

kaa/src/main/scala/com/davideicardi/kaa/avro/AvroSingleObjectEncoding.scala renamed to kaa/src/main/scala/kaa/schemaregistry/avro/AvroSingleObjectEncoding.scala

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
package com.davideicardi.kaa.avro
1+
package kaa.schemaregistry.avro
22

33
import java.nio.{ByteBuffer, ByteOrder}
44

5-
import com.davideicardi.kaa.SchemaId
6-
import com.davideicardi.kaa.InvalidSchemaException
5+
import kaa.schemaregistry.SchemaId
6+
import kaa.schemaregistry.InvalidSchemaException
77

88
object AvroSingleObjectEncoding {
99
/**

kaa/src/main/scala/com/davideicardi/kaa/avro/AvroSingleObjectSerializer.scala renamed to kaa/src/main/scala/kaa/schemaregistry/avro/AvroSingleObjectSerializer.scala

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
package com.davideicardi.kaa.avro
1+
package kaa.schemaregistry.avro
22

33
import com.sksamuel.avro4s._
4-
import com.davideicardi.kaa.SchemaRegistry
5-
import com.davideicardi.kaa.SchemaNotFoundException
4+
import kaa.schemaregistry.SchemaRegistry
5+
import kaa.schemaregistry.SchemaNotFoundException
66

77
class AvroSingleObjectSerializer[T >: Null : SchemaFor : Encoder : Decoder]
88
(

kaa/src/main/scala/com/davideicardi/kaa/avro/GenericAvroBinarySerializer.scala renamed to kaa/src/main/scala/kaa/schemaregistry/avro/GenericAvroBinarySerializer.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package com.davideicardi.kaa.avro
1+
package kaa.schemaregistry.avro
22

33
import org.apache.avro._
44
import java.io.ByteArrayOutputStream

kaa/src/main/scala/com/davideicardi/kaa/avro/GenericAvroSingleObjectSerializer.scala renamed to kaa/src/main/scala/kaa/schemaregistry/avro/GenericAvroSingleObjectSerializer.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
package com.davideicardi.kaa.avro
1+
package kaa.schemaregistry.avro
22

3-
import com.davideicardi.kaa.{SchemaNotFoundException, SchemaRegistry}
3+
import kaa.schemaregistry.{SchemaNotFoundException, SchemaRegistry}
44
import org.apache.avro.Schema
55
import org.apache.avro.generic.GenericRecord
66

kaa/src/main/scala/com/davideicardi/kaa/exceptions.scala renamed to kaa/src/main/scala/kaa/schemaregistry/exceptions.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package com.davideicardi.kaa
1+
package kaa.schemaregistry
22

33

44
class InvalidSchemaException(s:String) extends Exception(s){}

kaa/src/main/scala/com/davideicardi/kaa/kafka/GenericSerde.scala renamed to kaa/src/main/scala/kaa/schemaregistry/kafka/GenericSerde.scala

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
package com.davideicardi.kaa.kafka
1+
package kaa.schemaregistry.kafka
22

33
import com.sksamuel.avro4s.{Decoder, Encoder, SchemaFor}
4-
import com.davideicardi.kaa.SchemaRegistry
5-
import com.davideicardi.kaa.avro.AvroSingleObjectSerializer
4+
import kaa.schemaregistry.SchemaRegistry
5+
import kaa.schemaregistry.avro.AvroSingleObjectSerializer
66
import org.apache.kafka.common.serialization.{Deserializer, Serde, Serializer}
77

88
class GenericSerde[T >: Null : SchemaFor : Encoder : Decoder]

kaa/src/main/scala/com/davideicardi/kaa/test/TestSchemaRegistry.scala renamed to kaa/src/main/scala/kaa/schemaregistry/test/TestSchemaRegistry.scala

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
package com.davideicardi.kaa.test
1+
package kaa.schemaregistry.test
22

33
import org.apache.avro.Schema
44
import org.apache.avro.SchemaNormalization
5-
import com.davideicardi.kaa.SchemaId
6-
import com.davideicardi.kaa.SchemaRegistry
5+
import kaa.schemaregistry.SchemaId
6+
import kaa.schemaregistry.SchemaRegistry
77

88
class TestSchemaRegistry() extends SchemaRegistry {
99
val schemas = collection.mutable.Map[SchemaId, Schema]()

kaa/src/main/scala/com/davideicardi/kaa/utils/Retry.scala renamed to kaa/src/main/scala/kaa/schemaregistry/utils/Retry.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package com.davideicardi.kaa.utils
1+
package kaa.schemaregistry.utils
22

33
import scala.concurrent.duration._
44
import scala.concurrent._

kaa/src/test/scala/kaa/darwin/AvroBinarySerializerSpec.scala renamed to kaa/src/test/scala/kaa/schemaregistry/avro/AvroBinarySerializerSpec.scala

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
package com.davideicardi.kaa.darwin
1+
package kaa.schemaregistry.avro
22

33
import com.sksamuel.avro4s.AvroSchema
44
import org.scalatest._
55
import flatspec._
66
import matchers._
7-
import com.davideicardi.kaa.avro.AvroBinarySerializer
87

98
class AvroBinarySerializerSpec extends AnyFlatSpec with should.Matchers {
109

@@ -48,7 +47,7 @@ class AvroBinarySerializerSpec extends AnyFlatSpec with should.Matchers {
4847
val schema = target.currentSchema
4948

5049
//noinspection ScalaStyle
51-
val expectedSchema = """{"type":"record","name":"FooUser","namespace":"com.davideicardi.kaa.darwin.AvroBinarySerializerSpec","fields":[{"name":"name","type":"string"}]}"""
50+
val expectedSchema = """{"type":"record","name":"FooUser","namespace":"kaa.schemaregistry.avro.AvroBinarySerializerSpec","fields":[{"name":"name","type":"string"}]}"""
5251

5352
schema.toString(false) should be (expectedSchema)
5453
}

kaa/src/test/scala/kaa/darwin/AvroSingleObjectSerializerSpec.scala renamed to kaa/src/test/scala/kaa/schemaregistry/avro/AvroSingleObjectSerializerSpec.scala

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
1-
package com.davideicardi.kaa.darwin
1+
package kaa.schemaregistry.avro
22

33
import com.sksamuel.avro4s.AvroSchema
44
import org.apache.avro.{Schema, SchemaNormalization}
55
import org.scalatest._
66
import flatspec._
7-
import com.davideicardi.kaa.avro.{AvroBinarySerializer, AvroSingleObjectEncoding, AvroSingleObjectSerializer}
8-
import com.davideicardi.kaa.SchemaId
9-
import com.davideicardi.kaa.test.TestSchemaRegistry
7+
import kaa.schemaregistry.SchemaId
8+
import kaa.schemaregistry.test.TestSchemaRegistry
109
import matchers._
1110

1211
case class Pokemon(name: String, mainType: String, offType: Option[String], level: Int)

kaa/src/test/scala/kaa/darwin/GenericAvroBinarySerializerSpec.scala renamed to kaa/src/test/scala/kaa/schemaregistry/avro/GenericAvroBinarySerializerSpec.scala

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
package kaa.darwin
1+
package kaa.schemaregistry.avro
22

3-
import com.davideicardi.kaa.avro.GenericAvroBinarySerializer
43
import org.apache.avro.Schema
54
import org.apache.avro.generic.GenericData
65
import org.scalatest.flatspec._

kaa/src/test/scala/kaa/darwin/GenericAvroSingleObjectSerializerSpec.scala renamed to kaa/src/test/scala/kaa/schemaregistry/avro/GenericAvroSingleObjectSerializerSpec.scala

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
package kaa.darwin
1+
package kaa.schemaregistry.avro
22

3-
import com.davideicardi.kaa.SchemaId
4-
import com.davideicardi.kaa.avro.{AvroSingleObjectEncoding, GenericAvroBinarySerializer, GenericAvroSingleObjectSerializer}
5-
import com.davideicardi.kaa.test.TestSchemaRegistry
3+
import kaa.schemaregistry.SchemaId
4+
import kaa.schemaregistry.test.TestSchemaRegistry
65
import org.apache.avro.generic.GenericData
76
import org.apache.avro.{Schema, SchemaNormalization}
87
import org.scalatest.flatspec._

kaa/src/test/scala/kaa/kafka/GenericSerdeSpec.scala renamed to kaa/src/test/scala/kaa/schemaregistry/kafka/GenericSerdeSpec.scala

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
package com.davideicardi.kaa.darwin
1+
package kaa.schemaregistry.kafka
22

33
import org.scalatest._
44
import flatspec._
55
import matchers._
6-
import com.davideicardi.kaa.kafka.GenericSerde
7-
import com.davideicardi.kaa.test.TestSchemaRegistry
6+
import kaa.schemaregistry.test.TestSchemaRegistry
87

98
class GenericSerdeSpec extends AnyFlatSpec with should.Matchers {
109

sample/src/main/scala/sampleApp.scala

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import com.davideicardi.kaa.avro.{AvroSingleObjectEncoding, AvroSingleObjectSerializer}
2-
import com.davideicardi.kaa.KaaSchemaRegistry
3-
import com.davideicardi.kaa.KaaSchemaRegistryAdmin
1+
import kaa.schemaregistry.avro.{AvroSingleObjectEncoding, AvroSingleObjectSerializer}
2+
import kaa.schemaregistry.KaaSchemaRegistry
3+
import kaa.schemaregistry.KaaSchemaRegistryAdmin
44

55
object SampleApp {
66

0 commit comments

Comments
 (0)