dapr-client 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76432e4fbd3b38d79bd33a4ceaf47da100dd830c622229fc5c8dbedea79e4d8b
-  data.tar.gz: 33fe1e47295af0fd07278b001fa0c7518b6e7017c23d23ece9f896a87ea377b9
+  metadata.gz: 681a7749162ceb3e77996a080c24459c755cd9f29c4f0b27cdb60786cb21f161
+  data.tar.gz: 73a5c8fa8873a45efe241052c7867422bf49a1d2bfbb78fe058bd3e4c82350e6
 SHA512:
-  metadata.gz: f6c69c223c3c720d4f239d9e9455f48ec86413c39dd94986dba5b33d7474c13e50d0ce3a329bbf35f1680f1c04e991301b8bb45a2732369e4adefcecc4c2b17c
-  data.tar.gz: 3f0f4b799cc2053bb2016584234f3ebcb2fedd476d3409f021b35a8807087c9a11067e49439a6176db5c86483fab4d5422fc030b0b8013cae4a5a7d0c385f556
+  metadata.gz: 3f476fe1b3f24653a39b7d3043baa79e04b9b1fa2f719125fb3bb9a0f61aed0562d01262125ef99267067ef9a15e2f25afc0ee14ceb077ff8a335349c4d33150
+  data.tar.gz: 439962d22770b4a002ffcaf9157e2b54d18a7ea3c2c235ba91cffcf4a12c1d5794d84e9fd82d6e6a5a748db41cfef2f8714491e949becf7ec408944972e39e97

data/.ruby-version

@@ -1 +1 @@
-2.5.7
+2.5.8

data/CHANGELOG.md

@@ -1,4 +1,7 @@
 # dapr-client
 
+## v0.2.0
+- Auto-generated client based on Dapr v0.8.0.
+
 ## v0.1.0 (initial release)
 - Auto-generated client based on Dapr v0.6.0.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dapr-client (0.1.0)
+    dapr-client (0.2.0)
       google-protobuf
 
 GEM

data/README.md

@@ -28,7 +28,7 @@ Or install it yourself as:
 A client can be created as follows:
 
 ```ruby
-require "dapr/generated/dapr_services_pb"
+require "dapr_services_pb"
 
 client = Dapr::Dapr::Stub.new('localhost:5001', :this_channel_is_insecure)
 ```
@@ -45,14 +45,31 @@ dapr run --protocol grpc --grpc-port=50001 ruby example.rb
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Setup
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests. You can also run `bin/console`
+for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+### GRPC Client
+
+Protobuf definitions are stored in the `dapr/proto` directory of this repo.
+
+There is a script, `bin/regen_client.sh`, that can be used to regenerate the Ruby client
+from the protocol definitions. The generated code can be found in `lib/dapr/proto` and is
+added to the lib path.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dapr.
+Bug reports and pull requests are welcome on GitHub at https://github.com/tjwp/dapr-ruby-sdk.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/bin/regen_client.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/env zsh
+
+bindir="$(dirname "$0")"
+
+cd "$bindir/.."
+
+echo "Regenerating from protos ... "
+set -ex
+
+bundle exec grpc_tools_ruby_protoc -I . --ruby_out=lib --grpc_out=lib dapr/proto/common/v1/common.proto
+bundle exec grpc_tools_ruby_protoc -I . --ruby_out=lib --grpc_out=lib dapr/proto/runtime/v1/dapr.proto
+bundle exec grpc_tools_ruby_protoc -I . --ruby_out=lib --grpc_out=lib dapr/proto/runtime/v1/appcallback.proto
+
+set +x
+echo "Done."

data/dapr.gemspec

@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib", "lib/dapr/generated"]
+  spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "google-protobuf"
 

data/dapr/proto/common/v1/common.proto

@@ -0,0 +1,140 @@
+// ------------------------------------------------------------
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+// ------------------------------------------------------------
+
+syntax = "proto3";
+
+package dapr.proto.common.v1;
+
+import "google/protobuf/any.proto";
+import "google/protobuf/duration.proto";
+
+option csharp_namespace = "Dapr.Client.Autogen.Grpc.v1";
+option java_outer_classname = "CommonProtos";
+option java_package = "io.dapr.v1";
+option go_package = "github.com/dapr/dapr/pkg/proto/common/v1;common";
+
+// HTTPExtension includes HTTP verb and querystring
+// when Dapr runtime delivers HTTP content.
+// 
+// For example, when callers calls http invoke api
+// POST http://localhost:3500/v1.0/invoke/<app_id>/method/<method>?query1=value1&query2=value2
+// 
+// Dapr runtime will parse POST as a verb and extract querystring to quersytring map.
+message HTTPExtension {
+  // Type of HTTP 1.1 Methods
+  // RFC 7231: https://tools.ietf.org/html/rfc7231#page-24
+  enum Verb {
+    NONE = 0;
+    GET = 1;
+    HEAD = 2;
+    POST = 3;
+    PUT = 4;
+    DELETE = 5;
+    CONNECT = 6;
+    OPTIONS = 7;
+    TRACE = 8;
+  }
+
+  // Required. HTTP verb.
+  Verb verb = 1;
+
+  // querystring includes HTTP querystring.
+  map<string, string> querystring = 2;
+}
+
+// InvokeRequest is the message to invoke a method with the data.
+// This message is used in InvokeService of Dapr gRPC Service and OnInvoke
+// of AppCallback gRPC service.
+message InvokeRequest {
+  // Required. method is a method name which will be invoked by caller.
+  string method = 1;
+
+  // Required. Bytes value or Protobuf message which caller sent.
+  // Dapr treats Any.value as bytes type if Any.type_url is unset.
+  google.protobuf.Any data = 2;
+
+  // The type of data content.
+  //
+  // This field is required if data delivers http request body
+  // Otherwise, this is optional.
+  string content_type = 3;
+
+  // HTTP specific fields if request conveys http-compatible request.
+  //
+  // This field is required for http-compatible request. Otherwise,
+  // this field is optional.
+  HTTPExtension http_extension = 4;
+}
+
+// InvokeResponse is the response message inclduing data and its content type
+// from app callback.
+// This message is used in InvokeService of Dapr gRPC Service and OnInvoke
+// of AppCallback gRPC service.
+message InvokeResponse {
+  // Required. The content body of InvokeService response.
+  google.protobuf.Any data = 1;
+
+  // Required. The type of data content.
+  string content_type = 2;
+}
+
+// StateItem represents state key, value, and additional options to save state.
+message StateItem {
+  // Required. The state key
+  string key = 1;
+
+  // Required. The state data for key
+  bytes value = 2;
+
+  // The entity tag which represents the specific version of data.
+  // The exact ETag format is defined by the corresponding data store.
+  string etag = 3;
+
+  // The metadata which will be passed to state store component.
+  map<string,string> metadata = 4;
+
+  // Options for concurrency, consistency, and retry_policy to save the state.
+  StateOptions options = 5;
+}
+
+// StateOptions configures concurrency, consistency, and retry policy for state operations
+message StateOptions {
+  // Enum describing the supported concurrency for state.
+  enum StateConcurrency {
+    CONCURRENCY_UNSPECIFIED = 0;
+    CONCURRENCY_FIRST_WRITE = 1;
+    CONCURRENCY_LAST_WRITE = 2;
+  }
+
+  // Enum describing the supported consistency for state.
+  enum StateConsistency {
+    CONSISTENCY_UNSPECIFIED = 0;
+    CONSISTENCY_EVENTUAL = 1;
+    CONSISTENCY_STRONG = 2;
+  }
+
+  StateConcurrency concurrency = 1;
+  StateConsistency consistency = 2;
+  StateRetryPolicy retry_policy = 3;
+}
+
+// StateRetryPolicy represents retry policy to set and delete state operations.
+message StateRetryPolicy {
+  // Enum describing the support retry pattern
+  enum RetryPattern {
+    RETRY_UNSPECIFIED = 0;
+    RETRY_LINEAR = 1;
+    RETRY_EXPONENTIAL = 2;
+  }
+
+  // Maximum number of retries.
+  int32 threshold = 1;
+
+  // Retry pattern.
+  RetryPattern pattern = 2;
+
+  // Initial delay between retries.
+  google.protobuf.Duration interval = 3;
+}

data/dapr/proto/runtime/v1/appcallback.proto

@@ -0,0 +1,131 @@
+// ------------------------------------------------------------
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+// ------------------------------------------------------------
+
+syntax = "proto3";
+
+package dapr.proto.runtime.v1;
+
+import "google/protobuf/empty.proto";
+import "dapr/proto/common/v1/common.proto";
+
+option csharp_namespace = "Dapr.AppCallback.Autogen.Grpc.v1";
+option java_outer_classname = "DaprAppCallbackProtos";
+option java_package = "io.dapr.v1";
+option go_package = "github.com/dapr/dapr/pkg/proto/runtime/v1;runtime";
+
+// 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.
+service AppCallback {
+  // Invokes service method with InvokeRequest.
+  rpc OnInvoke (common.v1.InvokeRequest) returns (common.v1.InvokeResponse) {}
+
+  // Lists all topics subscribed by this app.
+  rpc ListTopicSubscriptions(google.protobuf.Empty) returns (ListTopicSubscriptionsResponse) {}
+
+  // Subscribes events from Pubsub
+  rpc OnTopicEvent(TopicEventRequest) returns (google.protobuf.Empty) {}
+
+  // Lists all input bindings subscribed by this app.
+  rpc ListInputBindings(google.protobuf.Empty) returns (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) returns (BindingEventResponse) {}
+}
+
+// TopicEventRequest message is compatiable with CloudEvent spec v1.0
+// https://github.com/cloudevents/spec/blob/v1.0/spec.md
+message TopicEventRequest {
+  // id identifies the event. Producers MUST ensure that source + id 
+  // is unique for each distinct event. If a duplicate event is re-sent
+  // (e.g. due to a network error) it MAY have the same id. 
+  string id = 1;
+
+  // source identifies the context in which an event happened.
+  // Often this will include information such as the type of the
+  // event source, the organization publishing the event or the process
+  // that produced the event. The exact syntax and semantics behind
+  // the data encoded in the URI is defined by the event producer.
+  string source = 2;
+
+  // The type of event related to the originating occurrence. 
+  string type = 3;
+
+  // The version of the CloudEvents specification. 
+  string spec_version = 4;
+
+  // The content type of data value.
+  string data_content_type = 5;
+
+  // The content of the event.
+  bytes data = 7;
+
+  // The pubsub topic which publisher sent to.
+  string topic = 6;
+}
+
+// BindingEventRequest represents input bindings event.
+message BindingEventRequest {
+  // Requried. The name of the input binding component.
+  string name = 1;
+
+  // Required. The payload that the input bindings sent
+  bytes data = 2;
+
+  // The metadata set by the input binging components.
+  map<string,string> metadata = 3;
+}
+
+// BindingEventResponse includes operations to save state or
+// send data to output bindings optionally.
+message BindingEventResponse {
+  // The name of state store where states are saved.
+  string store_name = 1;
+
+  // The state key values which will be stored in store_name.
+  repeated common.v1.StateItem states = 2;
+
+  // BindingEventConcurrency is the kind of concurrency 
+  enum BindingEventConcurrency {
+    // SEQUENTIAL sends data to output bindings specified in "to" sequentially.
+    SEQUENTIAL = 0;
+    // PARALLEL sends data to output bindings specified in "to" in parallel.
+    PARALLEL = 1;
+  }
+
+  // The list of output bindings.
+  repeated string to = 3;
+
+  // The content which will be sent to "to" output bindings.
+  bytes data = 4;
+
+  // The concurrency of output bindings to send data to
+  // "to" output bindings list. The default is SEQUENTIAL.
+  BindingEventConcurrency concurrency = 5;
+}
+
+// ListTopicSubscriptionsResponse is the message including the list of the subscribing topics.
+message ListTopicSubscriptionsResponse {
+  // The list of topics.
+  repeated TopicSubscription subscriptions = 1;
+}
+
+// TopicSubscription represents topic and metadata.
+message TopicSubscription {
+  // Required. The name of topic which will be subscribed
+  string topic = 1;
+
+  // The optional properties used for this topic's subscribtion e.g. session id
+  map<string,string> metadata = 2;
+}
+
+// ListInputBindingsResponse is the message including the list of input bindings.
+message ListInputBindingsResponse {
+  // The list of input bindings.
+  repeated string bindings = 1;
+}

data/dapr/proto/runtime/v1/dapr.proto

@@ -0,0 +1,155 @@
+// ------------------------------------------------------------
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+// ------------------------------------------------------------
+
+syntax = "proto3";
+
+package dapr.proto.runtime.v1;
+
+import "google/protobuf/empty.proto";
+import "dapr/proto/common/v1/common.proto";
+
+option csharp_namespace = "Dapr.Client.Autogen.Grpc.v1";
+option java_outer_classname = "DaprProtos";
+option java_package = "io.dapr.v1";
+option go_package = "github.com/dapr/dapr/pkg/proto/runtime/v1;runtime";
+
+// Dapr service provides APIs to user application to access Dapr building blocks.
+service Dapr {
+  // Invokes a method on a remote Dapr app.
+  rpc InvokeService(InvokeServiceRequest) returns (common.v1.InvokeResponse) {}
+
+  // Gets the state for a specific key.
+  rpc GetState(GetStateRequest) returns (GetStateResponse) {}
+
+  // Saves the state for a specific key.
+  rpc SaveState(SaveStateRequest) returns (google.protobuf.Empty) {}
+
+  // Deletes the state for a specific key.
+  rpc DeleteState(DeleteStateRequest) returns (google.protobuf.Empty) {}
+
+  // Publishes events to the specific topic.
+  rpc PublishEvent(PublishEventRequest) returns (google.protobuf.Empty) {}
+
+  // Invokes binding data to specific output bindings
+  rpc InvokeBinding(InvokeBindingRequest) returns (InvokeBindingResponse) {}
+
+  // Gets secrets from secret stores.
+  rpc GetSecret(GetSecretRequest) returns (GetSecretResponse) {}
+}
+
+// InvokeServiceRequest represents the request message for Service invocation.
+message InvokeServiceRequest {
+  // Required. Callee's app id.
+  string id = 1;
+
+  // Required. message which will be delivered to callee.
+  common.v1.InvokeRequest message = 3;
+}
+
+// GetStateRequest is the message to get key-value states from specific state store.
+message GetStateRequest {
+  // The name of state store.
+  string store_name = 1;
+
+  // The key of the desired state
+  string key = 2;
+
+  // The read consistency of the state store.
+  common.v1.StateOptions.StateConsistency consistency = 3;
+}
+
+// GetStateResponse is the response conveying the state value and etag.
+message GetStateResponse {
+  // The byte array data
+  bytes data = 1;
+
+  // The entity tag which represents the specific version of data.
+  // ETag format is defined by the corresponding data store.
+  string etag = 2;
+}
+
+// DeleteStateRequest is the message to delete key-value states in the specific state store.
+message DeleteStateRequest {
+  // The name of state store.
+  string store_name = 1;
+
+  // The key of the desired state
+  string key = 2;
+
+  // The entity tag which represents the specific version of data.
+  // The exact ETag format is defined by the corresponding data store.
+  string etag = 3;
+
+  // State operation options which includes concurrency/
+  // consistency/retry_policy.
+  common.v1.StateOptions options = 4;
+}
+
+// SaveStateRequest is the message to save multiple states into state store.
+message SaveStateRequest {
+  // The name of state store.
+  string store_name = 1;
+
+  // The array of the state key values.
+  repeated common.v1.StateItem states = 2;
+}
+
+// PublishEventRequest is the message to publish event data to pubsub topic
+message PublishEventRequest {
+  // The pubsub topic
+  string topic = 1;
+
+  // The data which will be published to topic.
+  bytes data = 2;
+}
+
+// InvokeBindingRequest is the message to send data to output bindings
+message InvokeBindingRequest {
+  // The name of the output binding to invoke.
+  string name = 1;
+
+  // The data which will be sent to output binding.
+  bytes data = 2;
+
+  // The metadata passing to output binding components
+  // 
+  // Common metadata property:
+  // - ttlInSeconds : the time to live in seconds for the message. 
+  // If set in the binding definition will cause all messages to 
+  // have a default time to live. The message ttl overrides any value
+  // in the binding definition.
+  map<string,string> metadata = 3;
+
+  // The name of the operation type for the binding to invoke
+  string operation = 4;
+}
+
+// InvokeBindingResponse is the message returned from an output binding invocation
+message InvokeBindingResponse {
+  // The data which will be sent to output binding.
+  bytes data = 1;
+
+  // The metadata returned from an external system
+  map<string,string> metadata = 2;
+}
+
+// GetSecretRequest is the message to get secret from secret store.
+message GetSecretRequest {
+  // The name of secret store.
+  string store_name = 1;
+
+  // The name of secret key.
+  string key = 2;
+
+  // The metadata which will be sent to secret store components.
+  map<string,string> metadata = 3;
+}
+
+// GetSecretResponse is the response mesage to convey the requested secret.
+message GetSecretResponse {
+  // data is the secret value. Some secret store, such as kubernetes secret
+  // store, can save multiple secrets for single secret key.
+  map<string, string> data = 1;
+}