client: added methods for connecting and disconnecting signals (#41)

Author: khtufteland

client.go

@@ -1,4 +1,4 @@
-// Copyright 2022-2024 Searis AS
+// Copyright 2022-2025 Searis AS
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -24,7 +24,8 @@ import (
 )
 
 const (
-	apiVersion = "1.1"
+	apiVersion             = "1.1"
+	apiVersionExperimental = "1.2alpha1"
 
 	paramCalculations   jsonrpc.ParamName = "calculations"
 	paramData           jsonrpc.ParamName = "data"
@@ -149,6 +150,10 @@ type AdminNamespace struct {
 	h jsonrpc.Handler
 }
 
+func (ns AdminNamespace) Handler() jsonrpc.Handler {
+	return ns.h
+}
+
 // SelectSignals returns a new request for querying signals and related
 // resources.
 func (ns AdminNamespace) SelectSignals(integration string, q fields.ResourceQuery) SelectSignalsRequest {
@@ -206,6 +211,10 @@ type ClarifyNamespace struct {
 	h jsonrpc.Handler
 }
 
+func (ns ClarifyNamespace) Handler() jsonrpc.Handler {
+	return ns.h
+}
+
 // SelectItems returns a request for querying items.
 func (ns ClarifyNamespace) SelectItems(q fields.ResourceQuery) SelectItemsRequest {
 	return methodSelectItems.NewRequest(ns.h,
@@ -332,6 +341,6 @@ type EvaluateRequest struct {
 type EvaluateResult = views.Selection[views.DataFrame, views.DataFrameInclude]
 
 var methodEvaluate = request.RelationalMethod[EvaluateResult]{
-	APIVersion: "1.2alpha1",
+	APIVersion: apiVersionExperimental,
 	Method:     "clarify.evaluate",
 }

credentials.go

@@ -1,4 +1,4 @@
-// Copyright 2022-2023 Searis AS
+// Copyright 2022-2025 Searis AS
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -143,7 +143,7 @@ func (creds Credentials) Client(ctx context.Context) *Client {
 		h = invalidRPCHandler{err: err}
 	}
 
-	return &Client{ns: IntegrationNamespace{integration: creds.Integration, h: h}}
+	return NewClient(creds.Integration, h)
 }
 
 // HTTPHandler returns a low-level RPC handler that communicates over HTTP using

examples/connect_signals/main.go

@@ -0,0 +1,40 @@
+package main
+
+import (
+	"context"
+	"encoding/json"
+	"os"
+
+	"github.com/clarify/clarify-go"
+	"github.com/clarify/clarify-go/fields"
+	clarifyx "github.com/clarify/clarify-go/x"
+)
+
+func main() {
+	creds, err := clarify.CredentialsFromFile("clarify-credentials.json")
+	if err != nil {
+		panic(err)
+	}
+
+	ctx := context.Background()
+	client := creds.Client(ctx)
+
+	integration := "c2mo5rac8v1dtfnta5e0"
+	item := "cuga77bpn4pb81evdgj0"
+	signal := "cl1d4kobi2aq0ttkc4b0"
+
+	q := fields.Query().Limit(1).Where(
+		fields.CompareField("id", fields.In(signal)),
+	).Total(true)
+
+	xclient := clarifyx.Upgrade(client)
+
+	result, err := xclient.Admin().ConnectSignals(integration, item, q).Do(ctx)
+	if err != nil {
+		panic(err)
+	}
+
+	enc := json.NewEncoder(os.Stdout)
+	enc.SetIndent("", "  ")
+	enc.Encode(result)
+}

examples/disconnect_signals/main.go

@@ -0,0 +1,39 @@
+package main
+
+import (
+	"context"
+	"encoding/json"
+	"os"
+
+	"github.com/clarify/clarify-go"
+	"github.com/clarify/clarify-go/fields"
+	clarifyx "github.com/clarify/clarify-go/x"
+)
+
+func main() {
+	creds, err := clarify.CredentialsFromFile("clarify-credentials.json")
+	if err != nil {
+		panic(err)
+	}
+
+	ctx := context.Background()
+	client := creds.Client(ctx)
+
+	integration := "c2mo5rac8v1dtfnta5e0"
+	signal := "cl1d4kobi2aq0ttkc4b0"
+
+	q := fields.Query().Limit(1).Where(
+		fields.CompareField("id", fields.In(signal)),
+	).Total(true)
+
+	xclient := clarifyx.Upgrade(client)
+
+	result, err := xclient.Admin().DisconnectSignals(integration, q).Do(ctx)
+	if err != nil {
+		panic(err)
+	}
+
+	enc := json.NewEncoder(os.Stdout)
+	enc.SetIndent("", "  ")
+	enc.Encode(result)
+}

x/clarifyx.go

@@ -0,0 +1,104 @@
+// Copyright 2022-2025 Searis AS
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package clarifyx
+
+import (
+	"github.com/clarify/clarify-go"
+	"github.com/clarify/clarify-go/fields"
+	"github.com/clarify/clarify-go/internal/request"
+	"github.com/clarify/clarify-go/jsonrpc"
+	"github.com/clarify/clarify-go/views"
+)
+
+const (
+	apiVersion             = "1.1"
+	apiVersionExperimental = "1.2alpha1"
+
+	paramFormat      jsonrpc.ParamName = "format"
+	paramIntegration jsonrpc.ParamName = "integration"
+	paramItem        jsonrpc.ParamName = "item"
+	paramQuery       jsonrpc.ParamName = "query"
+)
+
+type Client struct {
+	clarify.Client
+}
+
+func Upgrade(c *clarify.Client) Client {
+	return Client{Client: *c}
+}
+
+func (c Client) Admin() AdminNamespace {
+	return AdminNamespace{AdminNamespace: c.Client.Admin()}
+}
+
+type AdminNamespace struct {
+	clarify.AdminNamespace
+}
+
+// ConnectSignals returns a new request for publishing signals as items.
+func (ns AdminNamespace) ConnectSignals(integration, item string, q fields.ResourceQuery) ConnectSignalsRequest {
+	return methodConnectSignals.NewRequest(ns.Handler(),
+		paramIntegration.Value(integration),
+		paramItem.Value(item),
+		paramQuery.Value(q),
+		paramFormat.Value(views.SelectionFormat{
+			DataAsArray:         true,
+			GroupIncludedByType: true,
+		}),
+	)
+}
+
+type (
+	// ConnectSignalsRequest describe an initialized admin.publishSignal RPC
+	// request with access to a request handler.
+	ConnectSignalsRequest = request.Request[ConnectSignalsResult]
+
+	// ConnectSignalsResult describe the result format for a
+	// ConnectSignalsRequest.
+	ConnectSignalsResult = views.Selection[[]views.Signal, views.SignalInclude]
+)
+
+var methodConnectSignals = request.Method[ConnectSignalsResult]{
+	APIVersion: apiVersionExperimental,
+	Method:     "admin.connectSignals",
+}
+
+// DisconnectSignals returns a new request for publishing signals as items.
+func (ns AdminNamespace) DisconnectSignals(integration string, q fields.ResourceQuery) DisconnectSignalsRequest {
+	return methodDisconnectSignals.NewRequest(ns.Handler(),
+		paramIntegration.Value(integration),
+		paramQuery.Value(q),
+		paramFormat.Value(views.SelectionFormat{
+			DataAsArray:         true,
+			GroupIncludedByType: true,
+		}),
+	)
+}
+
+type (
+	// DisconnectSignalsRequest describe an initialized admin.publishSignal RPC
+	// request with access to a request handler.
+	DisconnectSignalsRequest = request.Request[DisconnectSignalsResult]
+
+	// DisconnectSignalsResult describe the result format for a
+	// DisconnectSignalsRequest.
+	DisconnectSignalsResult = views.Selection[[]views.Signal, views.SignalInclude]
+)
+
+var methodDisconnectSignals = request.Method[DisconnectSignalsResult]{
+	APIVersion: apiVersionExperimental,
+	Method:     "admin.disconnectSignals",
+}