Add auth url (#29)

co-authored-by: Sukaant Chaudhary <sukaant.chaudhary@gmail.com> This is a breaking change. Adding authUrl and authHeaders and renaming queryParams and headers to sourceQueryParams and sourceHeaders to avoid confusion.
UrbanOS-Public · Jun 12, 2019 · bb16897 · bb16897
1 parent da00092
commit bb16897
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 13 deletions.
diff --git a/lib/smart_city/dataset.ex b/lib/smart_city/dataset.ex
@@ -41,16 +41,21 @@ defmodule SmartCity.Dataset do
         }
       ],
       "sourceUrl": "",
+      "authUrl": "",
       "sourceFormat": "",
       "sourceType": "",     // remote|stream|batch
       "cadence": "",
-      "queryParams": {
+      "sourceQueryParams": {
         "key1": "",
         "key2": ""
       },
       "transformations": [], // ?
       "validations": [],     // ?
-      "headers": {
+      "sourceHeaders": {
+        "header1": "",
+        "header2": ""
+      }
+      "authHeaders": {
         "header1": "",
         "header2": ""
       }

diff --git a/lib/smart_city/dataset/technical.ex b/lib/smart_city/dataset/technical.ex
@@ -11,15 +11,17 @@ defmodule SmartCity.Dataset.Technical do
           orgName: String.t(),
           systemName: String.t(),
           sourceUrl: String.t(),
+          authUrl: String.t(),
           sourceFormat: String.t(),
           schema: not_required(list(map())),
           orgId: not_required(String.t()),
           sourceType: not_required(String.t()),
           cadence: not_required(String.t()),
-          queryParams: not_required(map()),
+          sourceQueryParams: not_required(map()),
           transformations: not_required(list()),
           validations: not_required(list()),
-          headers: not_required(map()),
+          sourceHeaders: not_required(map()),
+          authHeaders: not_required(map()),
           partitioner: not_required(%{type: String.t(), query: String.t()}),
           private: not_required(boolean())
         }
@@ -28,16 +30,18 @@ defmodule SmartCity.Dataset.Technical do
   defstruct cadence: "never",
             credentials: false,
             dataName: nil,
-            headers: %{},
+            sourceHeaders: %{},
+            authHeaders: %{},
             orgId: nil,
             orgName: nil,
             partitioner: %{type: nil, query: nil},
             private: true,
-            queryParams: %{},
+            sourceQueryParams: %{},
             schema: [],
             sourceFormat: nil,
             sourceType: "remote",
             sourceUrl: nil,
+            authUrl: nil,
             systemName: nil,
             transformations: [],
             validations: []

diff --git a/mix.exs b/mix.exs
@@ -4,7 +4,7 @@ defmodule SmartCity.Registry.MixProject do
   def project do
     [
       app: :smart_city_registry,
-      version: "2.6.6",
+      version: "3.0.0",
       elixir: "~> 1.8",
       start_permanent: Mix.env() == :prod,
       deps: deps(),

diff --git a/test/support/fixture_helper.ex b/test/support/fixture_helper.ex
@@ -44,9 +44,12 @@ defmodule FixtureHelper do
               queryParams: %{},
               transformations: ["a_transform"],
               version: "1",
-              headers: %{
+              sourceHeaders: %{
                 Authorization: "Basic xdasdgdasgdsgd"
               },
+              authHeaders: %{
+                afoo: "abar"
+              },
               systemName: "scos",
               orgName: "Whatever"
             },

diff --git a/test/unit/smart_city/dataset/technical_test.exs b/test/unit/smart_city/dataset/technical_test.exs
@@ -12,9 +12,12 @@ defmodule SmartCity.Dataset.TechnicalTest do
       "sourceType" => "batch",
       "cadence" => 30_000,
       "sourceFormat" => "gtfs",
-      "headers" => %{
+      "sourceHeaders" => %{
         "foo" => "bar"
       },
+      "authHeaders" => %{
+        "afoo" => "abar"
+      },
       "transformations" => [%{"foo" => %{"bar" => 1}}],
       "validations" => [1, 2, 3]
     }
@@ -42,14 +45,15 @@ defmodule SmartCity.Dataset.TechnicalTest do
     test "returns Technical struct when given string keys", %{message: tech} do
       actual = Technical.new(tech)
       assert actual.systemName == "org__dataset"
-      assert actual.queryParams == %{}
+      assert actual.sourceQueryParams == %{}
       assert actual.cadence == 30_000
       assert actual.sourceType == "batch"
     end
 
     test "converts deeply nested string keys to atoms", %{message: tech} do
       actual = Technical.new(tech)
-      assert actual.headers.foo == "bar"
+      assert actual.sourceHeaders.foo == "bar"
+      assert actual.authHeaders.afoo == "abar"
       assert List.first(actual.transformations).foo.bar == 1
     end
 

diff --git a/test/unit/smart_city/dataset_test.exs b/test/unit/smart_city/dataset_test.exs
@@ -20,9 +20,9 @@ defmodule SmartCity.DatasetTest do
         "sourceFormat" => "gtfs",
         "sourceType" => "stream",
         "cadence" => 9000,
-        "headers" => %{},
+        "sourceHeaders" => %{},
         "partitioner" => %{type: nil, query: nil},
-        "queryParams" => %{},
+        "sourceQueryParams" => %{},
         "transformations" => [],
         "validations" => [],
         "schema" => []