search

awslabs / amazon-kinesis-client-ruby

A Ruby interface for the Amazon Kinesis Client Library. Allows developers to easily create robust application to process Amazon Kinesis streams in Ruby.
Apache License 2.0
146 stars 56 forks source link

Usage question regarding the pom file #68

Closed jpaulgs closed 1 year ago

jpaulgs commented 1 year ago

The pom.xml file is not packaged in the gemspec.

I was expecting to pull that from the gem and install the required dependancies from there for my environments.

Is that an oversight or should I copy the pom file to my application and hard lock the version of this gem that I depend on?

zengyu714 commented 1 year ago

Hi @jpaulgs, pom.xml should be part of the gemspec, we will release a patch version to fix this, thanks for pointing it out!

zengyu714 commented 1 year ago

The pom file should now be included in the most recent version of 2.1.1 (https://rubygems.org/gems/aws-kclrb), closing the issue..

jpaulgs commented 1 year ago

@zengyu714 the pom file isn't currently a valid pom file. It's missing a few fields groupId, artifactId and version. I know that the sample code includes a rake file that downloads the jar files but I figure if I need to install java anyway I can get maven retrieve these.

Would it be possible for a future version to include something like?

    <groupId>software.amazon.kinesis</groupId>
    <artifactId>amazon-kinesis-client-ruby-pom</artifactId>
    <version>2.1.0</version>
zengyu714 commented 1 year ago

Hi @jpaulgs, since kcl-ruby is essentially a wrapper for kcl-java, in order to use it, you need to download the necessary jars (as done in the Rakefile) and have Java installed on your system.

Would it be possible for a future version to include something like?

I don't think it is necessary to add the aforementioned lines to the pom.xml. While the pom file is primarily used for GitHub dependabot, it is not a crucial tool for managing dependencies in kcl-ruby.