Data Provider Skeleton Mockup

apps/lib/data_provider/configs/resources/source_config_schemas/skeleton.json

@@ -0,0 +1,13 @@
+{
+  "$id": "/resources/source_config_schemas/skeleton",
+  "type": "object",
+  "properties": {
+    "dataSource": {
+      "type": "string",
+      "const": "skeleton"
+    }
+   // TODO: add all other possible fields from your config object
+  },
+  "required": ["dataSource"], // TODO: add all other required fields here
+  "additionalProperties": false
+}

apps/lib/data_provider/configs/source_config_tests/skeleton_test.go

@@ -0,0 +1,33 @@
+package config
+
+import (
+	"testing"
+
+	"github.com/Stork-Oracle/stork-external/apps/lib/data_provider/configs"
+	"github.com/Stork-Oracle/stork-external/apps/lib/data_provider/sources/skeleton"
+	"github.com/Stork-Oracle/stork-external/apps/lib/data_provider/utils"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestValidSkeletonConfig(t *testing.T) {
+
+	// TODO: set this to a valid config string using a feed from your new source
+	validConfig := `{}`
+
+	config, err := configs.LoadConfigFromBytes([]byte(validConfig))
+	assert.NoError(t, err)
+
+	assert.Equal(t, 1, len(config.Sources))
+
+	sourceConfig := config.Sources[0]
+
+	dataSourceId, err := utils.GetDataSourceId(sourceConfig.Config)
+	assert.NoError(t, err)
+	assert.Equal(t, skeleton.SkeletonDataSourceId, dataSourceId)
+
+	sourceSpecificConfig, err := skeleton.GetSourceSpecificConfig(sourceConfig)
+	assert.NoError(t, err)
+
+	// TODO: write some asserts to check that the fields on sourceSpecificConfig have the values you'd expect
+	panic("implement me")
+}

apps/lib/data_provider/sources/skeleton/config.go

@@ -0,0 +1,8 @@
+package skeleton
+
+import "github.com/Stork-Oracle/stork-external/apps/lib/data_provider/types"
+
+type SkeletonConfig struct {
+	DataSource types.DataSourceId `json:"dataSource"` // required for all Data Provider Sources
+	// TODO: Add any additional config parameters needed to pull a particular data feed
+}

apps/lib/data_provider/sources/skeleton/data_source.go

@@ -0,0 +1,24 @@
+package skeleton
+
+import (
+	"github.com/Stork-Oracle/stork-external/apps/lib/data_provider/types"
+)
+
+type skeletonDataSource struct {
+	// TODO: set any necessary parameters
+}
+
+func newSkeletonDataSource(sourceConfig types.DataProviderSourceConfig) *skeletonDataSource {
+	skeletonConfig, err := GetSourceSpecificConfig(sourceConfig)
+	if err != nil {
+		panic("unable to decode config: " + err.Error())
+	}
+
+	// TODO: add any necessary initialization code
+	panic("implement me")
+}
+
+func (r skeletonDataSource) RunDataSource(updatesCh chan types.DataSourceUpdateMap) {
+	// TODO: Write all logic to fetch datapoints and add to updatesCh
+	panic("implement me")
+}

apps/lib/data_provider/sources/skeleton/data_source_test.go

@@ -0,0 +1,9 @@
+package skeleton
+
+import (
+	"testing"
+)
+
+func TestSkeletonDataSource(t *testing.T) {
+	// TODO: write some unit tests for your data source
+}

apps/lib/data_provider/sources/skeleton/init.go

@@ -0,0 +1,30 @@
+package skeleton
+
+import (
+	"github.com/Stork-Oracle/stork-external/apps/lib/data_provider/sources"
+	"github.com/Stork-Oracle/stork-external/apps/lib/data_provider/types"
+	"github.com/Stork-Oracle/stork-external/apps/lib/data_provider/utils"
+	"github.com/mitchellh/mapstructure"
+)
+
+var SkeletonDataSourceId types.DataSourceId = types.DataSourceId(utils.GetCurrentDirName())
+
+type skeletonDataSourceFactory struct{}
+
+func (f *skeletonDataSourceFactory) Build(sourceConfig types.DataProviderSourceConfig) types.DataSource {
+	return newSkeletonDataSource(sourceConfig)
+}
+
+func init() {
+	sources.RegisterDataSourceFactory(SkeletonDataSourceId, &skeletonDataSourceFactory{})
+}
+
+// assert we're satisfying our interfaces
+var _ types.DataSource = (*skeletonDataSource)(nil)
+var _ types.DataSourceFactory = (*skeletonDataSourceFactory)(nil)
+
+func GetSourceSpecificConfig(sourceConfig types.DataProviderSourceConfig) (SkeletonConfig, error) {
+	var config SkeletonConfig
+	err := mapstructure.Decode(sourceConfig.Config, &config)
+	return config, err
+}