dapr-client 0.1.0 → 0.2.0

data/example.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "dapr/generated/dapr_services_pb"
+require "dapr_services_pb"
 
 port = ENV.fetch('DAPR_GRPC_PORT', '5001')
 dapr_uri = "localhost:#{port}"

data/examples/app-callback/README.md

@@ -0,0 +1,20 @@
+# AppCallbackExample
+
+Run the example service:
+
+```bash
+dapr run --app-id app-callback --protocol grpc --app-port 50051 \
+  bundle exec ruby app_callback_example.rb
+```
+
+Make a request to invoke a method:
+
+```bash
+dapr invoke -a app-callback -m foobar -p '{"foo": "bar"}'
+```
+
+Publish a message to a topic:
+
+```bash
+dapr publish -t "example" -d "5"
+```

data/examples/app-callback/app_callback_example.rb

@@ -0,0 +1,15 @@
+require_relative "./app_callback_service"
+
+$stdout.sync = true
+
+port = '0.0.0.0:50051'
+s = GRPC::RpcServer.new
+s.add_http2_port(port, :this_port_is_insecure)
+GRPC.logger.info("... running insecurely on #{port}")
+service = AppCallbackService
+s.handle(service)
+
+# Runs the server with SIGHUP, SIGINT and SIGQUIT signal handlers to
+#   gracefully shutdown.
+# User could also choose to run server via call to run_till_terminated
+s.run_till_terminated_or_interrupted([1, 'int', 'SIGQUIT'])

data/examples/app-callback/app_callback_service.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "dapr/proto/runtime/v1/appcallback_services_pb"
+require "json"
+
+class AppCallbackService < Dapr::Proto::Runtime::V1::AppCallback::Service
+  Any = Google::Protobuf::Any
+  Protocol = Dapr::Proto::Runtime::V1
+
+  def on_invoke(invoke, _call)
+    puts "invoked!"
+    # Be careful! method() is a builtin method in Ruby
+    method = invoke['method']
+    raw_data = invoke.data
+    data = JSON.parse(raw_data.value) if raw_data&.value
+    result = { method: method, data: data }
+    Dapr::Proto::Common::V1::InvokeResponse.new(data: Any.new(value: result.to_json))
+  rescue => ex
+    Dapr::Proto::Common::V1::InvokeResponse.new(data: Any.new(value: { error: ex.inspect }.to_json))
+  end
+
+  def list_topic_subscriptions(_empty, _call)
+    puts "topics requested!"
+    Protocol::ListTopicSubscriptionsResponse.
+        new(subscriptions: Array(Protocol::TopicSubscription.new(topic: "example")))
+  end
+
+  def list_input_bindings(_empty, _call)
+    puts "bindings requested!"
+    Protocol::ListInputBindingsResponse.new(bindings: %w(readers_digest))
+  end
+
+  def on_binding_event(binding_event, _call)
+    puts "binding event!"
+    name = binding_event.name
+    raw_data = binding_event.data
+    metadata = binding_event.metadata
+    puts "Binding Event: name:#{name}, data: #{raw_data}"
+    Protocol::BindingEventResponse.new # data: Any.new(value:)
+  end
+
+  def on_topic_event(topic_event, _call)
+    puts "topic event!"
+    topic = topic_event.topic
+    raw_data = topic_event.data
+    puts "Topic Event: topic:#{topic}, data: #{raw_data}"
+    Google::Protobuf::Empty.new
+  rescue => ex
+    puts ex.inspect
+  end
+end

data/examples/invoke-simple/README.md

@@ -0,0 +1,17 @@
+# Example - Invoke
+
+This example utilizes a receiver and a caller for the OnInvoke / Invoke
+functionality. It will create a gRPC server and bind the on_invoke method,
+which gets called after a client sends a direct method invocation.
+
+## Running
+
+To run this example, use the following code:
+
+```
+# 1. Start Receiver (expose gRPC receiver server on port 50051)
+dapr run --app-id invoke-receiver --protocol grpc --app-port 50051 bundle exec ruby invoke-receiver.rb
+
+# 2. Start Caller
+dapr run --app-id invoke-caller --protocol grpc bundle exec ruby invoke-caller.rb
+```

data/examples/invoke-simple/invoke-caller.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "dapr/proto/runtime/v1/dapr_services_pb"
+
+$stdout.sync = true
+
+port = ENV["DAPR_GRPC_PORT"]
+stub = Dapr::Proto::Runtime::V1::Dapr::Stub.new("localhost:#{port}", :this_channel_is_insecure)
+request = Dapr::Proto::Runtime::V1::InvokeServiceRequest.
+    new(id: "invoke-receiver",
+        message: Dapr::Proto::Common::V1::InvokeRequest.new(
+          method: "my-method",
+          data: Google::Protobuf::Any.new(value: "TEST MESSAGE"),
+          content_type: "text/plain; charset=UTF-8"
+        ))
+response = stub.invoke_service(request)
+
+puts response.content_type
+puts response.data.value

data/examples/invoke-simple/invoke-receiver.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+$stdout.sync = true
+
+require "dapr/proto/runtime/v1/appcallback_services_pb"
+
+class InvokeReceiverService < Dapr::Proto::Runtime::V1::AppCallback::Service
+  Any = Google::Protobuf::Any
+
+  def on_invoke(invoke, _call)
+    content_type = "text/plain; charset=UTF-8"
+    data = if invoke["method"] == "my-method"
+             Any.new(value: "INVOKE_RECEIVED")
+           else
+             Any.new(value: "unsupported method")
+           end
+
+    Dapr::Proto::Common::V1::InvokeResponse.new(data: data, content_type: content_type)
+  end
+end
+
+server = GRPC::RpcServer.new
+server.add_http2_port("0.0.0.0:50051", :this_port_is_insecure)
+server.handle(InvokeReceiverService)
+
+server.run_till_terminated_or_interrupted([1, +"int", +"SIGQUIT"])

data/examples/pubsub-simple/README.md

@@ -0,0 +1,13 @@
+# Example - Pub/Sub
+
+## Running
+
+To run this example, use the following commands:
+
+```bash
+# 1. Start Subscriber (expose gRPC receiver server on port 50051)
+dapr run --app-id subscriber --protocol grpc --app-port 50051 bundle exec ruby subscriber.rb
+
+# 2. Start Publisher
+dapr run --app-id publisher --protocol grpc bundle exec ruby publisher.rb
+```

data/examples/pubsub-simple/publisher.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "dapr/proto/runtime/v1/dapr_services_pb"
+
+$stdout.sync = true
+
+RuntimeV1 = Dapr::Proto::Runtime::V1
+
+port = ENV["DAPR_GRPC_PORT"]
+client = Dapr::Proto::Runtime::V1::Dapr::Stub.new("localhost:#{port}", :this_channel_is_insecure)
+
+client.publish_event(RuntimeV1::PublishEventRequest.
+    new(topic: "TOPIC_A", data: "ACTION=1"))
+
+puts "Published!"

data/examples/pubsub-simple/subscriber.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "dapr/proto/runtime/v1/appcallback_services_pb"
+
+$stdout.sync = true
+
+class Subscriber < Dapr::Proto::Runtime::V1::AppCallback::Service
+  RuntimeV1 = Dapr::Proto::Runtime::V1
+
+  # Dapr will call this method to get the list of topics the app
+  # wants to subscribe to. In this example, we are telling Dapr
+  # To subscribe to a topic named TOPIC_A
+  def list_topic_subscriptions(_empty, _call)
+    RuntimeV1::ListTopicSubscriptionsResponse.new(
+        subscriptions: Array(RuntimeV1::TopicSubscription.new(topic: "TOPIC_A")))
+  end
+
+  def on_topic_event(_topic_event, _call)
+    puts "Event received!"
+    Google::Protobuf::Empty.new
+  end
+end
+
+server = GRPC::RpcServer.new
+server.add_http2_port("0.0.0.0:50051", :this_port_is_insecure)
+server.handle(Subscriber)
+
+server.run_till_terminated_or_interrupted([1, +"int", +"SIGQUIT"])

data/examples/state-store/README.md

@@ -0,0 +1,7 @@
+# Example - State Store
+
+This example demonstrates saving, fetching, and deleting state from the store.
+
+```bash
+dapr run --app-id state-store --protocol grpc bundle exec ruby state-store.rb
+```

data/examples/state-store/state-store.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "dapr/proto/runtime/v1/dapr_services_pb"
+
+$stdout.sync = true
+
+RuntimeV1 = Dapr::Proto::Runtime::V1
+
+port = ENV["DAPR_GRPC_PORT"]
+client = Dapr::Proto::Runtime::V1::Dapr::Stub.new("localhost:#{port}", :this_channel_is_insecure)
+
+key = "my-key"
+store_name = "statestore"
+
+state = Dapr::Proto::Common::V1::StateItem.
+    new(key: key, value: "my state")
+
+client.save_state(RuntimeV1::SaveStateRequest.
+    new(store_name: store_name, states: Array(state)))
+puts "Saved!"
+
+response = client.get_state(RuntimeV1::GetStateRequest.
+    new(store_name: store_name, key: key))
+puts "Fetched!"
+puts response.inspect
+
+client.delete_state(RuntimeV1::DeleteStateRequest.
+    new(store_name: store_name, key: key))
+puts "Deleted!"

data/lib/dapr/proto/common/v1/common_pb.rb

@@ -0,0 +1,87 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: dapr/proto/common/v1/common.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/any_pb'
+require 'google/protobuf/duration_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("dapr/proto/common/v1/common.proto", :syntax => :proto3) do
+    add_message "dapr.proto.common.v1.HTTPExtension" do
+      optional :verb, :enum, 1, "dapr.proto.common.v1.HTTPExtension.Verb"
+      map :querystring, :string, :string, 2
+    end
+    add_enum "dapr.proto.common.v1.HTTPExtension.Verb" do
+      value :NONE, 0
+      value :GET, 1
+      value :HEAD, 2
+      value :POST, 3
+      value :PUT, 4
+      value :DELETE, 5
+      value :CONNECT, 6
+      value :OPTIONS, 7
+      value :TRACE, 8
+    end
+    add_message "dapr.proto.common.v1.InvokeRequest" do
+      optional :method, :string, 1
+      optional :data, :message, 2, "google.protobuf.Any"
+      optional :content_type, :string, 3
+      optional :http_extension, :message, 4, "dapr.proto.common.v1.HTTPExtension"
+    end
+    add_message "dapr.proto.common.v1.InvokeResponse" do
+      optional :data, :message, 1, "google.protobuf.Any"
+      optional :content_type, :string, 2
+    end
+    add_message "dapr.proto.common.v1.StateItem" do
+      optional :key, :string, 1
+      optional :value, :bytes, 2
+      optional :etag, :string, 3
+      map :metadata, :string, :string, 4
+      optional :options, :message, 5, "dapr.proto.common.v1.StateOptions"
+    end
+    add_message "dapr.proto.common.v1.StateOptions" do
+      optional :concurrency, :enum, 1, "dapr.proto.common.v1.StateOptions.StateConcurrency"
+      optional :consistency, :enum, 2, "dapr.proto.common.v1.StateOptions.StateConsistency"
+      optional :retry_policy, :message, 3, "dapr.proto.common.v1.StateRetryPolicy"
+    end
+    add_enum "dapr.proto.common.v1.StateOptions.StateConcurrency" do
+      value :CONCURRENCY_UNSPECIFIED, 0
+      value :CONCURRENCY_FIRST_WRITE, 1
+      value :CONCURRENCY_LAST_WRITE, 2
+    end
+    add_enum "dapr.proto.common.v1.StateOptions.StateConsistency" do
+      value :CONSISTENCY_UNSPECIFIED, 0
+      value :CONSISTENCY_EVENTUAL, 1
+      value :CONSISTENCY_STRONG, 2
+    end
+    add_message "dapr.proto.common.v1.StateRetryPolicy" do
+      optional :threshold, :int32, 1
+      optional :pattern, :enum, 2, "dapr.proto.common.v1.StateRetryPolicy.RetryPattern"
+      optional :interval, :message, 3, "google.protobuf.Duration"
+    end
+    add_enum "dapr.proto.common.v1.StateRetryPolicy.RetryPattern" do
+      value :RETRY_UNSPECIFIED, 0
+      value :RETRY_LINEAR, 1
+      value :RETRY_EXPONENTIAL, 2
+    end
+  end
+end
+
+module Dapr
+  module Proto
+    module Common
+      module V1
+        HTTPExtension = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("dapr.proto.common.v1.HTTPExtension").msgclass
+        HTTPExtension::Verb = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("dapr.proto.common.v1.HTTPExtension.Verb").enummodule
+        InvokeRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("dapr.proto.common.v1.InvokeRequest").msgclass
+        InvokeResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("dapr.proto.common.v1.InvokeResponse").msgclass
+        StateItem = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("dapr.proto.common.v1.StateItem").msgclass
+        StateOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("dapr.proto.common.v1.StateOptions").msgclass
+        StateOptions::StateConcurrency = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("dapr.proto.common.v1.StateOptions.StateConcurrency").enummodule
+        StateOptions::StateConsistency = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("dapr.proto.common.v1.StateOptions.StateConsistency").enummodule
+        StateRetryPolicy = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("dapr.proto.common.v1.StateRetryPolicy").msgclass
+        StateRetryPolicy::RetryPattern = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("dapr.proto.common.v1.StateRetryPolicy.RetryPattern").enummodule
+      end
+    end
+  end
+end

data/lib/dapr/proto/runtime/v1/appcallback_pb.rb

@@ -0,0 +1,62 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: dapr/proto/runtime/v1/appcallback.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/empty_pb'
+require 'dapr/proto/common/v1/common_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("dapr/proto/runtime/v1/appcallback.proto", :syntax => :proto3) do
+    add_message "dapr.proto.runtime.v1.TopicEventRequest" do
+      optional :id, :string, 1
+      optional :source, :string, 2
+      optional :type, :string, 3
+      optional :spec_version, :string, 4
+      optional :data_content_type, :string, 5
+      optional :data, :bytes, 7
+      optional :topic, :string, 6
+    end
+    add_message "dapr.proto.runtime.v1.BindingEventRequest" do
+      optional :name, :string, 1
+      optional :data, :bytes, 2
+      map :metadata, :string, :string, 3
+    end
+    add_message "dapr.proto.runtime.v1.BindingEventResponse" do
+      optional :store_name, :string, 1
+      repeated :states, :message, 2, "dapr.proto.common.v1.StateItem"
+      repeated :to, :string, 3
+      optional :data, :bytes, 4
+      optional :concurrency, :enum, 5, "dapr.proto.runtime.v1.BindingEventResponse.BindingEventConcurrency"
+    end
+    add_enum "dapr.proto.runtime.v1.BindingEventResponse.BindingEventConcurrency" do
+      value :SEQUENTIAL, 0
+      value :PARALLEL, 1
+    end
+    add_message "dapr.proto.runtime.v1.ListTopicSubscriptionsResponse" do
+      repeated :subscriptions, :message, 1, "dapr.proto.runtime.v1.TopicSubscription"
+    end
+    add_message "dapr.proto.runtime.v1.TopicSubscription" do
+      optional :topic, :string, 1
+      map :metadata, :string, :string, 2
+    end
+    add_message "dapr.proto.runtime.v1.ListInputBindingsResponse" do
+      repeated :bindings, :string, 1
+    end
+  end
+end
+
+module Dapr
+  module Proto
+    module Runtime
+      module V1
+        TopicEventRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("dapr.proto.runtime.v1.TopicEventRequest").msgclass
+        BindingEventRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("dapr.proto.runtime.v1.BindingEventRequest").msgclass
+        BindingEventResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("dapr.proto.runtime.v1.BindingEventResponse").msgclass
+        BindingEventResponse::BindingEventConcurrency = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("dapr.proto.runtime.v1.BindingEventResponse.BindingEventConcurrency").enummodule
+        ListTopicSubscriptionsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("dapr.proto.runtime.v1.ListTopicSubscriptionsResponse").msgclass
+        TopicSubscription = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("dapr.proto.runtime.v1.TopicSubscription").msgclass
+        ListInputBindingsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("dapr.proto.runtime.v1.ListInputBindingsResponse").msgclass
+      end
+    end
+  end
+end

data/lib/dapr/proto/runtime/v1/appcallback_services_pb.rb

@@ -0,0 +1,49 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: dapr/proto/runtime/v1/appcallback.proto for package 'dapr.proto.runtime.v1'
+# Original file comments:
+# ------------------------------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------------------------------
+#
+
+require 'grpc'
+require 'dapr/proto/runtime/v1/appcallback_pb'
+
+module Dapr
+  module Proto
+    module Runtime
+      module V1
+        module AppCallback
+          # AppCallback V1 allows user application to interact with Dapr runtime.
+          # User application needs to implement AppCallback service if it needs to
+          # receive message from dapr runtime.
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'dapr.proto.runtime.v1.AppCallback'
+
+            # Invokes service method with InvokeRequest.
+            rpc :OnInvoke, Dapr::Proto::Common::V1::InvokeRequest, Dapr::Proto::Common::V1::InvokeResponse
+            # Lists all topics subscribed by this app.
+            rpc :ListTopicSubscriptions, Google::Protobuf::Empty, ListTopicSubscriptionsResponse
+            # Subscribes events from Pubsub
+            rpc :OnTopicEvent, TopicEventRequest, Google::Protobuf::Empty
+            # Lists all input bindings subscribed by this app.
+            rpc :ListInputBindings, Google::Protobuf::Empty, ListInputBindingsResponse
+            # Listens events from the input bindings
+            #
+            # User application can save the states or send the events to the output
+            # bindings optionally by returning BindingEventResponse.
+            rpc :OnBindingEvent, BindingEventRequest, BindingEventResponse
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end