{"id":31722837,"url":"https://github.com/euglena1215/grpc_required_annotator","last_synced_at":"2025-10-09T04:19:48.454Z","repository":{"id":56875405,"uuid":"213940980","full_name":"euglena1215/grpc_required_annotator","owner":"euglena1215","description":"Annotator for null validation of gRPC requests using `required`","archived":false,"fork":false,"pushed_at":"2020-06-26T14:00:40.000Z","size":20,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-18T12:21:42.922Z","etag":null,"topics":["grpc","ruby"],"latest_commit_sha":null,"homepage":"https://rubygems.org/gems/grpc_required_annotator","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/euglena1215.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-10-09T14:31:07.000Z","updated_at":"2021-01-29T04:47:50.000Z","dependencies_parsed_at":"2022-08-20T22:00:36.226Z","dependency_job_id":null,"html_url":"https://github.com/euglena1215/grpc_required_annotator","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/euglena1215/grpc_required_annotator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/euglena1215%2Fgrpc_required_annotator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/euglena1215%2Fgrpc_required_annotator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/euglena1215%2Fgrpc_required_annotator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/euglena1215%2Fgrpc_required_annotator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/euglena1215","download_url":"https://codeload.github.com/euglena1215/grpc_required_annotator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/euglena1215%2Fgrpc_required_annotator/sbom","scorecard":{"id":384866,"data":{"date":"2025-08-11","repo":{"name":"github.com/euglena1215/grpc_required_annotator","commit":"5320fe6a8caf4c904fa1d22b3c82f821ea1cf275"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/11 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.txt:0","Info: FSF or OSI recognized license: MIT License: LICENSE.txt:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-18T16:22:03.226Z","repository_id":56875405,"created_at":"2025-08-18T16:22:03.226Z","updated_at":"2025-08-18T16:22:03.226Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278830199,"owners_count":26053256,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["grpc","ruby"],"created_at":"2025-10-09T04:19:47.260Z","updated_at":"2025-10-09T04:19:48.449Z","avatar_url":"https://github.com/euglena1215.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GrpcRequiredAnnotator [![Gem Version](https://badge.fury.io/rb/grpc_required_annotator.svg)](https://badge.fury.io/rb/grpc_required_annotator) [![Build Status](https://travis-ci.com/euglena1215/grpc_required_annotator.svg?branch=master)](https://travis-ci.com/euglena1215/grpc_required_annotator) [![codecov](https://codecov.io/gh/euglena1215/grpc_required_annotator/branch/master/graph/badge.svg)](https://codecov.io/gh/euglena1215/grpc_required_annotator)\n\nGrpcRequiredAnnotator is an annotator for null validation of gRPC requests using `required`.\n\n### Supported Types\n\n- Integer (int64, int32, etc...)\n- String (string)\n- Google::Protobuf::FieldMask (field_mask)\n- Google::Protobuf::RepeatedField (repeated fields)\n- Symbol (enum)\n\n### Unsupported Types\n\n- oneof\n- embedded messages\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'grpc_required_annotator'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install grpc_required_annotator\n\n## Usage\n\n```proto\nsyntax = \"proto3\";\npackage sample;\n\noption ruby_package = \"SamplePb\";\n\nservice Sample {\n    rpc Foo (FooRequest) returns (FooResponse);\n}\n\nmessage FooRequest {\n    int64 a = 1;\n    string b = 2;\n}\n\nmessage FooResponse {\n    int64 a = 1;\n    string b = 2;\n}\n```\n\n```rb\nclass SampleService \u003c SamplePb::Sample::Service\n  include GrpcRequiredAnnotator\n\n  # If a or b are null, raises GRPC::InvalidArgument\n  required :a, :b\n  def foo(request, call)\n    ## `required :a, :b` is equivalent to the following:\n    # raise GRPC::InvalidArgument.new(\"`a` is required\") if req.a == 0\n    # raise GRPC::InvalidArgument.new(\"`b` is required\") if req.b == \"\"\n    FooResponse.new(a: req.a, b: req.b)\n  end\nend\n```\n\n### Testing by rspec\n\n```rb\nRSpec.describe SampleService do\n  describe \"#foo\" do\n    describe \"required\" do\n      it \"a and b are required\" do\n        expect(described_class.required_fields(:foo)).to eq [:a, :b]\n      end\n    end\n  end\nend\n\n```\n\n## Development\n\nAfter 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.\n\nTo 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).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/grpc_required_annotator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n\n## Code of Conduct\n\nEveryone interacting in the Grpc::Required::Annotator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/grpc_required_annotator/blob/master/CODE_OF_CONDUCT.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feuglena1215%2Fgrpc_required_annotator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feuglena1215%2Fgrpc_required_annotator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feuglena1215%2Fgrpc_required_annotator/lists"}