embulk-parser-twitter_ads_stats 0.1.0

data/src/test/scala/org/embulk/parser/twitter_ads_stats/ColumnSpec.scala

@@ -0,0 +1,33 @@
+package org.embulk.parser.twitter_ads_stats
+
+import org.embulk.spi.`type`.Types
+import org.embulk.spi.{Column => EmbulkColumn}
+
+class ColumnSpec extends UnitSpec {
+  "メトリクスグループのJSONがアルファベット順で JSON 型で生成される" in {
+    val metricElementNames = MetricElementNames(
+      Map(
+        "video" -> Seq(
+          "video_total_views",
+          "video_views_25",
+        ),
+        "billing" -> Seq(
+          "billed_engagements",
+          "billed_charge_local_micro"
+        )
+      )
+    )
+    val actual = Column.createEmbulkColumns(metricElementNames)
+
+    val expected = Seq(
+      new EmbulkColumn(0, "id", Types.STRING),
+      new EmbulkColumn(1, "date", Types.STRING),
+      new EmbulkColumn(2, "segment", Types.STRING),
+      new EmbulkColumn(3, "placement", Types.STRING),
+      new EmbulkColumn(4, "billing", Types.JSON),
+      new EmbulkColumn(5, "video", Types.JSON),
+    )
+
+    assert(actual == expected)
+  }
+}

data/src/test/scala/org/embulk/parser/twitter_ads_stats/MetricElementNamesSpec.scala

@@ -0,0 +1,14 @@
+package org.embulk.parser.twitter_ads_stats
+
+class MetricElementNamesSpec extends UnitSpec {
+  "ソートされたメトリクスグループの名前を取得する" in {
+    val emptySeq = Seq.empty
+    val names = MetricElementNames(
+      Map("b" -> emptySeq, "a" -> emptySeq, "c" -> emptySeq)
+    )
+    val actual = names.getSortedMetricsGroupNames
+    val expected = List("a", "b", "c")
+
+    assert(actual == expected)
+  }
+}

data/src/test/scala/org/embulk/parser/twitter_ads_stats/MetricsGroupJsonSpec.scala

@@ -0,0 +1,20 @@
+package org.embulk.parser.twitter_ads_stats
+
+import spray.json.{JsNull, JsNumber, JsObject, pimpAny}
+
+class MetricsGroupJsonSpec extends UnitSpec {
+  "json write" in {
+    import MetricsGroupJson._
+
+    val v: MetricsGroup = Map("a" -> Some(3), "b" -> Some(6), "c_e" -> None)
+
+    val actual = v.toJson
+
+    val expected = JsObject(
+      "a" -> JsNumber(3),
+      "b" -> JsNumber(6),
+      "c_e" -> JsNull
+    )
+    assert(actual == expected)
+  }
+}

data/src/test/scala/org/embulk/parser/twitter_ads_stats/UnitSpec.scala

@@ -0,0 +1,5 @@
+package org.embulk.parser.twitter_ads_stats
+
+import org.scalatest.{DiagrammedAssertions, WordSpec}
+
+abstract class UnitSpec extends WordSpec with DiagrammedAssertions

data/src/test/scala/org/embulk/parser/twitter_ads_stats/define/MetricsJsonSpec.scala

@@ -0,0 +1,57 @@
+package org.embulk.parser.twitter_ads_stats.define
+
+import org.embulk.parser.twitter_ads_stats.{MetricElementNames, UnitSpec}
+import spray.json._
+
+class MetricsJsonSpec extends UnitSpec {
+
+  "メトリクスのネストしたJSON構造を .つなぎの要素名を指定してRead できる" in {
+
+    val metricElementNames = MetricElementNames(
+      Map(
+        "x" -> Seq("a", "b"),
+        "y" -> Seq("c.e", "c.f", "d.e", "d.f")
+      )
+    )
+
+    val jsValue =
+      """
+        |{
+        |    "a": [
+        |      510,
+        |      494,
+        |      364
+        |    ],
+        |    "b": [1,2,3],
+        |    "c": {
+        |      "e": [1,2,3],
+        |      "f": null
+        |    },
+        |    "d": {
+        |      "e": [
+        |        2,
+        |        3,
+        |        4
+        |      ],
+        |      "f": [
+        |        12,
+        |        19,
+        |        13
+        |      ]
+        |    }
+        |}
+      """.stripMargin.parseJson
+    val actual = new RootJson(metricElementNames).MetricsReader.read(jsValue)
+    val expected = Metrics(
+      Map(
+        "a" -> Some(Vector(510, 494, 364)),
+        "b" -> Some(Vector(1, 2, 3)),
+        "c_e" -> Some(Vector(1, 2, 3)),
+        "c_f" -> None,
+        "d_e" -> Some(Vector(2, 3, 4)),
+        "d_f" -> Some(Vector(12, 19, 13))
+      )
+    )
+    assert(actual == expected)
+  }
+}

data/src/test/scala/org/embulk/parser/twitter_ads_stats/define/ParamsSpec.scala

@@ -0,0 +1,26 @@
+package org.embulk.parser.twitter_ads_stats.define
+
+import java.time.{LocalDate, LocalDateTime}
+
+import org.embulk.parser.twitter_ads_stats.UnitSpec
+
+class ParamsSpec extends UnitSpec {
+  "開始日~(終了日-1)の日程を取得する" in {
+    val period = Params(LocalDateTime.of(2017, 1, 1, 0, 0, 0), LocalDateTime.of(2017, 1, 4, 23, 23, 23), "")
+    val actual = period.targetDates
+    val expected = List(
+      LocalDate.of(2017, 1, 1),
+      LocalDate.of(2017, 1, 2),
+      LocalDate.of(2017, 1, 3)
+    )
+    assert(actual == expected)
+  }
+  "開始日から終了日までの全日程は、開始日から終了日が同一な場合は同一な日程となる" in {
+    val period = Params(LocalDateTime.of(2017, 1, 1, 0, 0, 0), LocalDateTime.of(2017, 1, 1, 23, 23, 23), "")
+    val actual = period.targetDates
+    val expected = List(
+      LocalDate.of(2017, 1, 1)
+    )
+    assert(actual == expected)
+  }
+}

data/src/test/scala/org/embulk/parser/twitter_ads_stats/define/RootJsonSpec.scala

@@ -0,0 +1,20 @@
+package org.embulk.parser.twitter_ads_stats.define
+
+import org.embulk.parser.twitter_ads_stats
+import org.embulk.parser.twitter_ads_stats.UnitSpec
+import spray.json._
+
+class RootJsonSpec extends UnitSpec {
+  "JSONをパースできる" in {
+
+    val largeJsonSource = scala.io.Source
+      .fromInputStream(
+        getClass.getResourceAsStream("/test.json")
+      )
+      .mkString
+      .parseJson
+
+    val root = new RootJson(twitter_ads_stats.metricElementNames).RootReader.read(largeJsonSource)
+    //    println(root)
+  }
+}

data/src/test/scala/org/embulk/parser/twitter_ads_stats/define/RootSpec.scala

@@ -0,0 +1,356 @@
+package org.embulk.parser.twitter_ads_stats.define
+
+import java.time.{LocalDate, LocalDateTime}
+
+import org.embulk.parser.twitter_ads_stats.{Column, InvalidMetricTimeSeriesException, MetricElementNames, UnitSpec}
+import org.scalatest.EitherValues._
+
+class RootSpec extends UnitSpec {
+
+  "メトリクス要素名から複数のカラムを解決する" in {
+    import RootSpec._
+
+    val actual = defaultRoot.resolveColumns(metricElementNames)
+
+    val expected = List(
+      Column(
+        "123",
+        LocalDate.of(2017, 1, 1),
+        None,
+        "",
+        Map(
+          "media" -> Map(
+            "media_views" -> Some(1),
+            "media_engagements" -> None
+          ),
+          "billing" -> Map(
+            "billed_engagements" -> Some(1),
+            "billed_charge_local_micro" -> Some(1)
+          ),
+          "web_conversion" -> Map(
+            "conversion_purchases_assisted" -> Some(1)
+          )
+        )
+      ),
+      Column(
+        "123",
+        LocalDate.of(2017, 1, 2),
+        None,
+        "",
+        Map(
+          "media" -> Map(
+            "media_views" -> Some(2),
+            "media_engagements" -> None
+          ),
+          "billing" -> Map(
+            "billed_engagements" -> Some(2),
+            "billed_charge_local_micro" -> Some(2)
+          ),
+          "web_conversion" -> Map(
+            "conversion_purchases_assisted" -> Some(2)
+          )
+        )
+      ),
+      Column(
+        "123",
+        LocalDate.of(2017, 1, 1),
+        None,
+        "",
+        Map(
+          "media" -> Map(
+            "media_views" -> Some(10),
+            "media_engagements" -> None
+          ),
+          "billing" -> Map(
+              "billed_engagements" -> Some(10),
+              "billed_charge_local_micro" -> Some(10)
+            ),
+          "web_conversion" -> Map(
+            "conversion_purchases_assisted" -> Some(10)
+          )
+        )
+      ),
+      Column(
+        "123",
+        LocalDate.of(2017, 1, 2),
+        None,
+        "",
+        Map(
+          "media" -> Map(
+            "media_views" -> Some(20),
+            "media_engagements" -> None
+          ),
+          "billing" -> Map(
+            "billed_engagements" -> Some(20),
+            "billed_charge_local_micro" -> Some(20)
+          ),
+          "web_conversion" -> Map(
+            "conversion_purchases_assisted" -> Some(20)
+          )
+        )
+      ),
+      Column(
+        "456",
+        LocalDate.of(2017, 1, 1),
+        None,
+        "",
+        Map(
+          "media" -> Map(
+            "media_views" -> Some(1),
+            "media_engagements" -> None
+          ),
+          "billing" -> Map(
+              "billed_engagements" -> Some(1),
+              "billed_charge_local_micro" -> Some(1)
+            ),
+          "web_conversion" -> Map(
+            "conversion_purchases_assisted" -> Some(1)
+          )
+        )
+      ),
+      Column(
+        "456",
+        LocalDate.of(2017, 1, 2),
+        None,
+        "",
+        Map(
+          "media" -> Map(
+            "media_views" -> Some(2),
+            "media_engagements" -> None
+          ),
+          "billing" -> Map(
+            "billed_engagements" -> Some(2),
+            "billed_charge_local_micro" -> Some(2)
+          ),
+          "web_conversion" -> Map(
+            "conversion_purchases_assisted" -> Some(2)
+          )
+        )
+      ),
+      Column(
+        "456",
+        LocalDate.of(2017, 1, 1),
+        None,
+        "",
+        Map(
+          "media" -> Map(
+            "media_views" -> Some(10),
+            "media_engagements" -> None
+          ),
+          "billing" -> Map(
+              "billed_engagements" -> Some(10),
+              "billed_charge_local_micro" -> Some(10)
+            ),
+          "web_conversion" -> Map(
+            "conversion_purchases_assisted" -> Some(10)
+          )
+        )
+      ),
+      Column(
+        "456",
+        LocalDate.of(2017, 1, 2),
+        None,
+        "",
+        Map(
+          "media" -> Map(
+            "media_views" -> Some(20),
+            "media_engagements" -> None
+          ),
+          "billing" -> Map(
+            "billed_engagements" -> Some(20),
+            "billed_charge_local_micro" -> Some(20)
+          ),
+          "web_conversion" -> Map(
+            "conversion_purchases_assisted" -> Some(20)
+          )
+        )
+      )
+    )
+    val rightValue = actual.right.value
+    assert(rightValue == expected)
+  }
+  "メトリクス時系列のコレクション要素数以上の期間が指定された時、 InvalidMetricTimeSeriesException となる" in {
+    import RootSpec._
+
+    val actual = createRoot(
+      Request(
+        params = Params(
+          start_time = LocalDateTime.of(2017, 1, 1, 1, 1, 1),
+          end_time = LocalDateTime.of(2017, 1, 4, 1, 1, 1),
+          placement = ""
+        )
+      )
+    ).resolveColumns(metricElementNames)
+
+    intercept[InvalidMetricTimeSeriesException] {
+      throw actual.left.get
+    }
+  }
+  "指定したメトリクス名のみを解決する" in {
+    import RootSpec._
+
+    val names = MetricElementNames(
+      Map(
+        "media" ->
+          Seq(
+            "media_views"
+          )
+      )
+    )
+
+    val actual = createRoot(
+      Request(
+        params = Params(
+          start_time = LocalDateTime.of(2017, 1, 1, 1, 1, 1),
+          end_time = LocalDateTime.of(2017, 1, 1, 1, 1, 1),
+          placement = ""
+        )
+      )
+    ).resolveColumns(names)
+
+    val expected = Seq(
+      Column(
+        "123",
+        LocalDate.of(2017, 1, 1),
+        None,
+        "",
+        Map(
+          "media" -> Map(
+            "media_views" -> Some(1)
+          )
+        )
+      ),
+      Column(
+        "123",
+        LocalDate.of(2017, 1, 1),
+        None,
+        "",
+        Map(
+          "media" -> Map(
+            "media_views" -> Some(10)
+          )
+        )
+      ),
+      Column(
+        "456",
+        LocalDate.of(2017, 1, 1),
+        None,
+        "",
+        Map(
+          "media" -> Map(
+            "media_views" -> Some(1)
+          )
+        )
+      ),
+      Column(
+        "456",
+        LocalDate.of(2017, 1, 1),
+        None,
+        "",
+        Map(
+          "media" -> Map(
+            "media_views" -> Some(10)
+          )
+        )
+      )
+    )
+    val rightValue = actual.right.value
+
+    assert(rightValue == expected)
+  }
+}
+
+object RootSpec {
+
+  val defaultRoot: Root = createRoot(
+    Request(
+      params = Params(
+        start_time = LocalDateTime.of(2017, 1, 1, 1, 1, 1),
+        end_time = LocalDateTime.of(2017, 1, 3, 1, 1, 1),
+        placement = ""
+      )
+    )
+  )
+
+  def createRoot(request: Request): Root = {
+    Root(
+      data = Seq(
+        Data(
+          id = "123",
+          id_data = Seq(
+            IDData(
+              metrics = Metrics(
+                Map(
+                  "billed_engagements" -> Some(Vector(1, 2)),
+                  "billed_charge_local_micro" -> Some(Vector(1, 2)),
+                  "media_views" -> Some(Vector(1, 2)),
+                  "media_engagements" -> None,
+                  "conversion_purchases_assisted" -> Some(Vector(1, 2))
+                )
+              ),
+              segment = None
+            ),
+            IDData(
+              metrics = Metrics(
+                Map(
+                  "billed_engagements" -> Some(Vector(10, 20)),
+                  "billed_charge_local_micro" -> Some(Vector(10, 20)),
+                  "media_views" -> Some(Vector(10, 20)),
+                  "media_engagements" -> None,
+                  "conversion_purchases_assisted" -> Some(Vector(10, 20))
+                )
+              ),
+              segment = None
+            )
+          )
+        ),
+        Data(
+          id = "456",
+          id_data = Seq(
+            IDData(
+              metrics = Metrics(
+                Map(
+                  "billed_engagements" -> Some(Vector(1, 2)),
+                  "billed_charge_local_micro" -> Some(Vector(1, 2)),
+                  "media_views" -> Some(Vector(1, 2)),
+                  "media_engagements" -> None,
+                  "conversion_purchases_assisted" -> Some(Vector(1, 2))
+                )
+              ),
+              segment = None
+            ),
+            IDData(
+              metrics = Metrics(
+                Map(
+                  "billed_engagements" -> Some(Vector(10, 20)),
+                  "billed_charge_local_micro" -> Some(Vector(10, 20)),
+                  "media_views" -> Some(Vector(10, 20)),
+                  "media_engagements" -> None,
+                  "conversion_purchases_assisted" -> Some(Vector(10, 20))
+                )
+              ),
+              segment = None
+            )
+          )
+        )
+      ),
+      request = request
+    )
+  }
+
+  val metricElementNames = MetricElementNames(
+    Map(
+      "billing" -> Seq(
+        "billed_engagements",
+        "billed_charge_local_micro"
+      ),
+      "media" -> Seq(
+        "media_views",
+        "media_engagements"
+      ),
+      "web_conversion" -> Seq(
+        "conversion_purchases.assisted"
+      )
+    )
+  )
+}