dapr 0.1.24 → 0.1.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f9f12b47b2ab348b8b9f5095344b65bb4da63c278cfb4dcf56ca8b12f7cd67a
-  data.tar.gz: 7908909ca89827446908d97dc90c067893e1d8ddaf2d713cb5d12ea659b28ea4
+  metadata.gz: ede293d0cbb90960527f0c91f4009679a2db765f355b8a9d17094f209c11b900
+  data.tar.gz: a6ca7bc7a6ad7f8a775b395a6c5eb1da9164f820af88efd8768827436beabc75
 SHA512:
-  metadata.gz: c9f2864759062b40a8d69f964e827c58de2044dfdcb10d17e055ac9c1ab1b8f52f1a762ae1e3d60c3de9bd3949acfdd717c3f3b404e649a13b5fe1db7f8287ce
-  data.tar.gz: e3aa1f63899f004c65985f3169f0ea70aae72b541df1d9977d6da234244e3db21054920cb8b1efcbd5fe9cb8efb9d98a66ef81f5fbffb746b48699f40a8dce3d
+  metadata.gz: 4f0d9506ea6006ddd9a117bb330767b86c208d56ef668b418e46b0f3cc231788a8c28dee64a2b412b32cda25bbe104f1b7d27a26b063773e4173c8e127a149d5
+  data.tar.gz: 5b3612f1175a25544aa284514391d4b0c27f9ddaca60eafafe589e7cfc5942b4c2d73c616e7d6743e1596558216302ed7371f8d2f322100e116bd218f4040e07

data/.overcommit.yml

@@ -0,0 +1,337 @@
+---
+PreCommit:
+  AuthorEmail:
+    enabled: true
+  AuthorName:
+    enabled: true
+  BerksfileCheck:
+    enabled: false
+  BrokenSymlinks:
+    enabled: true
+  BundleAudit:
+    enabled: true
+  BundleCheck:
+    enabled: true
+  BundleOutdated:
+    enabled: true
+  CaseConflicts:
+    enabled: true
+  ChamberCompare:
+    enabled: false
+  ChamberSecurity:
+    enabled: false
+  ChamberVerification:
+    enabled: false
+  CodeSpellCheck:
+    enabled: false
+  CoffeeLint:
+    enabled: false
+  CookStyle:
+    enabled: false
+  Credo:
+    enabled: false
+  CssLint:
+    enabled: false
+  DartAnalyzer:
+    enabled: false
+  Dogma:
+    enabled: false
+  ErbLint:
+    enabled: false
+  EsLint:
+    enabled: false
+  ExecutePermissions:
+    enabled: false
+  Fasterer:
+    enabled: false
+  FixMe:
+    enabled: true
+  FileSize:
+    enabled: false
+  Flay:
+    enabled: false
+  Foodcritic:
+    enabled: false
+  ForbiddenBranches:
+    enabled: true
+    branch_patterns: [ 'main', 'master' ]
+  GinkgoFocus:
+    enabled: false
+  GoFmt:
+    enabled: false
+  GolangciLint:
+    enabled: false
+  GoLint:
+    enabled: false
+  GoVet:
+    enabled: false
+  Hadolint:
+    enabled: false
+  HamlLint:
+    enabled: false
+  HardTabs:
+    enabled: false
+  Hlint:
+    enabled: false
+  HtmlHint:
+    enabled: false
+  HtmlTidy:
+    enabled: false
+  ImageOptim:
+    enabled: false
+  JavaCheckstyle:
+    enabled: false
+  Jscs:
+    enabled: false
+  JsHint:
+    enabled: false
+  JsLint:
+    enabled: false
+  Jsl:
+    enabled: false
+  JsonSyntax:
+    enabled: false
+  KtLint:
+    enabled: false
+  LicenseFinder:
+    enabled: false
+  LicenseHeader:
+    enabled: false
+  LocalPathsInGemfile:
+    enabled: false
+  Mdl:
+    enabled: false
+  MergeConflicts:
+    enabled: true
+  MixFormat:
+    enabled: false
+  PuppetMetadataJsonLint:
+    enabled: false
+  NginxTest:
+    enabled: false
+  Pep257:
+    enabled: false
+  Pep8:
+    enabled: false
+  PhpLint:
+    enabled: false
+  PhpCs:
+    enabled: false
+  PhpCsFixer:
+    enabled: false
+  PhpStan:
+    enabled: false
+  Pronto:
+    enabled: false
+  PuppetLint:
+    enabled: false
+  Pycodestyle:
+    enabled: false
+  Pydocstyle:
+    enabled: false
+  Pyflakes:
+    enabled: false
+  Pylint:
+    enabled: false
+  PythonFlake8:
+    enabled: false
+  RakeTarget:
+    enabled: false
+  RailsBestPractices:
+    enabled: false
+  RailsSchemaUpToDate:
+    enabled: false
+  Reek:
+    enabled: false
+  RstLint:
+    enabled: false
+  RSpec:
+    enabled: false
+  RuboCop:
+    enabled: true
+  RubyLint:
+    enabled: false
+  RubySyntax:
+    enabled: false
+  Scalariform:
+    enabled: false
+  Scalastyle:
+    enabled: false
+  ScssLint:
+    enabled: false
+  SemiStandard:
+    enabled: false
+  ShellCheck:
+    enabled: true
+  SlimLint:
+    enabled: false
+  Sorbet:
+    enabled: false
+  Sqlint:
+    enabled: false
+  Standard:
+    enabled: false
+  Stylelint:
+    enabled: false
+  SwiftLint:
+    enabled: false
+  TerraformFormat:
+    enabled: false
+  TsLint:
+    enabled: false
+  TrailingWhitespace:
+    enabled: true
+  TravisLint:
+    enabled: false
+  Vint:
+    enabled: false
+  W3cCss:
+    enabled: false
+  W3cHtml:
+    enabled: false
+  LineEndings:
+    enabled: false
+  XmlLint:
+    enabled: false
+  XmlSyntax:
+    enabled: false
+  YamlLint:
+    enabled: false
+  YamlSyntax:
+    enabled: true
+  YardCoverage:
+    enabled: false
+  YarnCheck:
+    enabled: false
+CommitMsg:
+  CapitalizedSubject:
+    enabled: true
+  EmptyMessage:
+    enabled: true
+  GerritChangeId:
+    enabled: false
+  HardTabs:
+    enabled: false
+  MessageFormat:
+    enabled: false
+  RussianNovel:
+    enabled: false
+  SingleLineSubject:
+    enabled: true
+  SpellCheck:
+    enabled: false
+  TextWidth:
+    enabled: true
+  TrailingPeriod:
+    enabled: true
+PostCheckout:
+  BowerInstall:
+    enabled: false
+  BundleInstall:
+    enabled: false
+  ComposerInstall:
+    enabled: false
+  GitLfs:
+    enabled: false
+  IndexTags:
+    enabled: false
+  NpmInstall:
+    enabled: false
+  SubmoduleStatus:
+    enabled: false
+  YarnInstall:
+    enabled: false
+PostCommit:
+  BowerInstall:
+    enabled: false
+  BundleInstall:
+    enabled: false
+  Commitplease:
+    enabled: false
+  ComposerInstall:
+    enabled: false
+  GitGuilt:
+    enabled: false
+  GitLfs:
+    enabled: false
+  IndexTags:
+    enabled: false
+  NpmInstall:
+    enabled: false
+  SubmoduleStatus:
+    enabled: false
+  YarnInstall:
+    enabled: false
+PostMerge:
+  BowerInstall:
+    enabled: false
+  BundleInstall:
+    enabled: false
+  ComposerInstall:
+    enabled: false
+  GitLfs:
+    enabled: false
+  IndexTags:
+    enabled: false
+  NpmInstall:
+    enabled: false
+  SubmoduleStatus:
+    enabled: false
+  YarnInstall:
+    enabled: false
+PostRewrite:
+  BowerInstall:
+    enabled: false
+  BundleInstall:
+    enabled: false
+  ComposerInstall:
+    enabled: false
+  IndexTags:
+    enabled: false
+  NpmInstall:
+    enabled: false
+  SubmoduleStatus:
+    enabled: false
+  YarnInstall:
+    enabled: false
+PrePush:
+  Brakeman:
+    enabled: false
+  CargoTest:
+    enabled: false
+  FlutterTest:
+    enabled: false
+  GitLfs:
+    enabled: false
+  GolangciLint:
+    enabled: false
+  GoTest:
+    enabled: false
+  Minitest:
+    enabled: false
+  MixTest:
+    enabled: false
+  PhpUnit:
+    enabled: false
+  Pronto:
+    enabled: false
+  ProtectedBranches:
+    enabled: true
+  PubTest:
+    enabled: false
+  Pytest:
+    enabled: false
+  PythonNose:
+    enabled: false
+  RSpec:
+    enabled: false
+  RakeTarget:
+    enabled: false
+  TestUnit:
+    enabled: false
+PreRebase:
+  MergedCommits:
+    enabled: false
+PrepareCommitMsg:
+  ReplaceBranch:
+    enabled: false

data/.rubocop.yml

@@ -1,7 +1,7 @@
 ---
 require:
   - rubocop-rake
-  - rubocop-rspec
+  - rubocop-minitest
 
 AllCops:
   TargetRubyVersion: 3.2.0

data/Rakefile

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require 'minitest/test_task'
 
-RSpec::Core::RakeTask.new(:spec)
+Minitest::TestTask.create
 
 require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+require 'pathname'
+Pathname.glob('tasks/*.rake').each { |r| load r }
+
+# Coverage and wipelock both come from tasks/
+task default: %i[coverage rubocop wipelock]

data/Readme.adoc

@@ -20,9 +20,11 @@ endif::[]
 
 == Overview
 
-This library provides a Ruby client for the Dapr runtime. It is a work in progress and is not yet ready for production use.
+This library provides an interface to the {dapr-building-block}s.
 
-Documentation will be added as the library matures.
+CAUTION: This is a work in progress and is not yet ready for production use.
+
+NOTE: Documentation will be added as this library matures.
 
 == Installation
 
@@ -34,9 +36,17 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install dapr
 
+.Example from Gemfile
+[source,ruby]
+----
+gem 'dapr', '~> 0.1.9', require: 'dapr/client'
+gem 'datadog_api_client'
+gem 'grpc', force_ruby_platform: true
+----
+
 == Usage
 
-Dapr being such a kitchen sink, this library exposes each {dapr-building-block} as either a
+Dapr being such a Smörgåsbord, this library exposes each {dapr-building-block} as either a
 Client or a Service, depending on whether it uses the AppCallback runtime (Service) or
 the Dapr API (Client). The clients are thin wrappers around the Dapr API, while the service
  implementations will be more opinionated, higher-level abstractions. See the specific section on
@@ -80,7 +90,7 @@ focus on the business logic of your service, rather than the plumbing of message
 ----
 require 'dapr/service/subscriber'
 handler = ->(event) { puts "Got event: #{event}" } <1>
-pubsub_name = 'pubsub' <2>
+pubsub_name = 'pubsub-name' <2>
 topics = 'TOPIC-A' <3>
 sub = Rubyists::Dapr::Service::Subscriber.new(pubsub_name:, topics:, handler:) <4>
 sub.start! <5>
@@ -89,12 +99,12 @@ sub.start! <5>
 +
 NOTE: The handler can be anything that responds to `#call`, such as a lambda, proc, or instance. Sky's the limit! (Dependency injection, anyone?)
 +
-<2> The name of the Dapr pubsub component this subscriber will utilize.
+<2> The name of the Dapr pubsub component this subscriber will utilize. 
 <3> The name of the topic(s) to subscribe to.
 +
 TIP: Multiple topics can be subscribed to simultaneously by passing an array of topic names to the `topics` argument.
 +
-<4> Create a new subscriber for the `pubsub` pubsub component, subscribing to the `TOPIC-A` topic.
+<4> Create a new subscriber for the `pubsub-name` pubsub component, subscribing to the `TOPIC-A` topic.
 <5> Start the subscriber. This will block the current thread and call the handler for each message received.
 
 === State Management

data/coverage/coverage.json

@@ -0,0 +1 @@
+{"timestamp":1715471428,"command_name":"Unit Tests","files":[{"filename":"/home/bougyman/rubyists/dapr/lib/dapr.rb","covered_percent":100.0,"coverage":{"lines":[null,null,1,1,null,null,1,1,3,null,null,null,1,1,1,1,1,null,null]},"covered_strength":1.2,"covered_lines":10,"lines_of_code":10},{"filename":"/home/bougyman/rubyists/dapr/lib/dapr/client.rb","covered_percent":100.0,"coverage":{"lines":[null,null,1,1,1,1,1,null,1,1,null,1,1,1,1,1,null,1,4,null,1,1,null,null,1,8,null,null,1,1,null,null,1,11,null,null,null,1,1,null,1,5,null,null,1,1,1,1,null,1,null,null,1,2,null,null,null,null,null]},"covered_strength":1.7575757575757576,"covered_lines":33,"lines_of_code":33},{"filename":"/home/bougyman/rubyists/dapr/lib/dapr/client/lock.rb","covered_percent":100.0,"coverage":{"lines":[null,null,1,1,null,1,1,1,null,1,null,1,1,null,null,1,null,null,1,null,1,1,null,1,6,6,null,null,null,null,null,null,1,6,6,null,null,null,1,6,6,5,5,null,null,1,null,null,null,1,4,4,4,null,3,3,null,null,1,null,null,1,18,null,null,null,null,null]},"covered_strength":3.0606060606060606,"covered_lines":33,"lines_of_code":33}],"metrics":{"covered_percent":100.0,"covered_strength":2.25,"covered_lines":76,"total_lines":76}}

data/lib/dapr/client/lock.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+require_relative '../client'
+
+module Rubyists
+  module Dapr
+    module Client
+      # Handles publishing messages to Dapr pub/sub topics
+      class Lock
+        # Include the client module
+        include Client
+        include SemanticLogger::Loggable
+
+        # The name of the pubsub component, the client, and the serialization to use
+        attr_reader :store_name, :resource_id, :lock
+
+        # The proto class for the TryLock request message
+        LockRequest = ::Dapr::Proto::Runtime::V1::TryLockRequest
+        # The proto class for the Unlock request message
+        UnlockRequest = ::Dapr::Proto::Runtime::V1::UnlockRequest
+        DEFAULT_STORE_NAME = 'locker'
+
+        def self.acquire(resource_id, store_name: DEFAULT_STORE_NAME, ttl: 10)
+          lock = new(store_name, resource_id)
+          lock.lock!(ttl:)
+        end
+
+        # Initialize the Lock
+        #
+        # @param store_name [String]  The name of the Dapr lock store component to use
+        # @param resource_id [String] The unique ID of the resource to lock
+        def initialize(store_name, resource_id)
+          @store_name = store_name
+          @resource_id = resource_id
+        end
+
+        # @param ttl [Integer] The time-to-live for the lock in seconds
+        def lock!(ttl: 10)
+          response = singleton.try_lock(LockRequest.new(store_name:, resource_id:, lock_owner:, expiry_in_seconds: ttl))
+          if response.success
+            logger.info('Acquired lock', store_name:, resource_id:, ttl:, lock_owner:)
+            return self
+          end
+
+          logger.warn "Failed to acquire lock for #{resource_id}"
+          nil
+        end
+
+        def unlock!
+          response = singleton.unlock(UnlockRequest.new(store_name:, resource_id:, lock_owner:))
+          status = response.status
+          return true if status == :SUCCESS
+
+          logger.warn('Unlock Failed!', status:, store_name:, resource_id:, lock_owner:)
+          false
+        end
+
+        private
+
+        # @return [String] The unique ID of the lock owner
+        def lock_owner
+          @lock_owner ||= SecureRandom.uuid
+        end
+      end
+    end
+  end
+end

data/lib/dapr/client.rb

@@ -11,13 +11,15 @@ module Rubyists
     # The namespace for the Dapr client
     module Client
       include SemanticLogger::Loggable
-      DAPR_PORT = ENV.fetch('DAPR_GRPC_PORT', '5001')
+      DAPR_PORT = ENV.fetch('DAPR_GRPC_PORT', nil)
       DAPR_URI = ENV.fetch('DAPR_GRPC_HOST', 'localhost')
       DAPR_STUB = ::Dapr::Proto::Runtime::V1::Dapr::Stub
 
-      def self.client
-        logger.info "Creating Dapr client for #{DAPR_URI}:#{DAPR_PORT}"
-        DAPR_STUB.new("#{DAPR_URI}:#{DAPR_PORT}", :this_channel_is_insecure)
+      def self.client(dapr_port: DAPR_PORT, dapr_uri: DAPR_URI)
+        return DummyClient.new if dapr_port.nil?
+
+        logger.info "Creating Dapr client for #{dapr_uri}:#{dapr_port}"
+        DAPR_STUB.new("#{dapr_uri}:#{dapr_port}", :this_channel_is_insecure)
       end
 
       def self.singleton
@@ -31,6 +33,27 @@ module Rubyists
       def singleton
         @singleton ||= Rubyists::Dapr::Client.singleton
       end
+
+      # Make a dummy client that responds to every method with a warning and the called method signature
+      class DummyClient
+        include SemanticLogger::Loggable
+
+        def initialize(*_)
+          logger.warn 'Dapr is not available (no DAPR_GRPC_PORT), using dummy client'
+        end
+
+        def method_missing(method_name, *, &)
+          self.class.define_method(method_name) do |*args, &block|
+            logger.warn 'Dapr is not available (no DAPR_GRPC_PORT), using dummy client'
+            { method_name:, args:, block: }
+          end
+          send(method_name, *, &)
+        end
+
+        def respond_to_missing?(_method_name, _include_private = false)
+          true
+        end
+      end
     end
   end
 end

data/lib/dapr/version.rb

@@ -2,6 +2,6 @@
 
 module Rubyists
   module Dapr
-    VERSION = '0.1.24'
+    VERSION = '0.1.26'
   end
 end

data/lib/dapr.rb

@@ -1,9 +1,19 @@
 # frozen_string_literal: true
 
+require 'pathname'
 require_relative 'dapr/version'
 
+# Add a method to Pathname to join paths on /
+class Pathname
+  def /(other)
+    join(other.to_s)
+  end
+end
+
 module Rubyists
   module Dapr
     class Error < StandardError; end
+    ROOT    = Pathname.new(__dir__).join('..').expand_path
+    LIBROOT = ROOT.join('lib/dapr')
   end
 end

data/oci/Containerfile

@@ -0,0 +1,48 @@
+ARG ALPINE_VERSION=3.19
+ARG RUBY_VERSION=3.3.1
+FROM docker.io/ruby:$RUBY_VERSION-alpine$ALPINE_VERSION AS build-env
+
+# Setting env up
+ARG APP_ROOT=/app
+ARG JOBS=8
+ENV LANG C.UTF-8
+ENV BUNDLE_SILENCE_ROOT_WARNING=1
+
+#Install dependencies needed for compilation
+RUN apk --no-cache add curl ruby-dev build-base git
+
+WORKDIR $APP_ROOT
+
+RUN mkdir -p lib/dapr
+COPY lib/dapr/version.rb lib/dapr/version.rb
+COPY Gemfile dapr.gemspec .
+RUN bundle config set build.nokogiri --use-system-libraries && \
+    bundle config set without  'test development assets' && \
+    bundle install --jobs 8 && \
+    mkdir -p /src && \
+    cd /src && \
+    curl -L https://github.com/leahneukirchen/snooze/archive/refs/tags/v0.5.tar.gz > snooze.tar.gz && \
+    tar xvf snooze.tar.gz && \
+    cd snooze-0.5 && \
+    make && \
+    install -m 0755 snooze /bin/snooze && \
+    cd / && \
+    rm -rf /src
+
+# Remove folders not needed in resulting image
+RUN rm -rf node_modules tmp/cache app/assets vendor/assets spec
+
+############### Build step done ###############
+FROM docker.io/ruby:3.3.0-alpine3.19
+ARG ALPINE_VERSION=3.19
+ARG RUBY_VERSION=3.3.1
+ARG APP_ROOT=/app
+
+WORKDIR $APP_ROOT
+
+# install packages
+RUN apk --update --no-cache add coreutils curl bash runit
+COPY --from=build-env /usr/local/bundle/ /usr/local/bundle/
+COPY --from=build-env /bin/snooze /bin/snooze
+
+CMD ['bundle', 'exec', 'puma', '-C', 'config/puma.rb']

data/tasks/coverage.rake

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+CoverageError = Class.new(StandardError)
+desc 'Run all specs with coverage'
+task :coverage do
+  ENV['COVERAGE'] = 'test'
+  require 'json'
+  require 'bigdecimal'
+  coverage_file = Pathname('coverage/coverage.json')
+  old_coverage = ''
+  old_percent = 0
+  if coverage_file.exist?
+    old_coverage = coverage_file.read
+    old_percent = BigDecimal(JSON.parse(old_coverage)['metrics']['covered_percent'], 4).to_f
+  end
+
+  sh 'ruby test/test_dapr.rb'
+
+  new_coverage = coverage_file.read
+  new_percent = BigDecimal(JSON.parse(new_coverage)['metrics']['covered_percent'], 4).to_f
+  if new_percent < old_percent
+    coverage_file.write old_coverage
+    raise CoverageError, "Coverage dropped from #{old_percent}% to #{new_percent}%"
+  elsif new_percent > old_percent
+    puts "Coverage increased from #{old_percent}% to #{new_percent}%"
+  else
+    puts "Coverage stayed the same at #{old_percent}%"
+  end
+end

data/tasks/wipelock.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+desc 'Remove Gemfile.lock'
+task :wipelock do
+  system 'rm -f Gemfile.lock'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dapr
 version: !ruby/object:Gem::Version
-  version: 0.1.24
+  version: 0.1.26
 platform: ruby
 authors:
 - Tj (bougyman) Vanderpoel
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-17 00:00:00.000000000 Z
+date: 2024-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dapr-ruby
@@ -46,18 +46,24 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".overcommit.yml"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
 - Rakefile
 - Readme.adoc
+- coverage/coverage.json
 - lib/dapr.rb
 - lib/dapr/client.rb
+- lib/dapr/client/lock.rb
 - lib/dapr/client/publisher.rb
 - lib/dapr/service.rb
 - lib/dapr/service/subscriber.rb
 - lib/dapr/version.rb
+- oci/Containerfile
 - sig/dapr.rbs
+- tasks/coverage.rake
+- tasks/wipelock.rake
 homepage: https://github.com/rubyists/dapr
 licenses: []
 metadata: