kagaribi 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7009cb11cae6982c8214c7de69349b851ac8b7475959801b48ebb309762a5e6
-  data.tar.gz: 77887aa0a0f38a9cc1a83177505e78ec3bd4d20a6cf2f37eddae03ddb4f17539
+  metadata.gz: 6341d635aacd9883dd113c02dd8d96494a1f7cbc52e727f521fa25210dbc4951
+  data.tar.gz: 4cc8aa1c3c4243a403c0a7299313063c20be62eb534b02c8f59a1c1b0f8dea85
 SHA512:
-  metadata.gz: f3849fcf52d60d06a23105f2318547bd9a14c49edaa9a9df6cdc28cd08ab1b91b78a533349c68935204a632e86b4b569600209f9cbfb14796f67df0e75fb351d
-  data.tar.gz: 26c6ee337021f3c5d68a9d622db22cbc3c54e4052eb4e75e4af36d80c616b3f6af5c095cbc87e23ae8d6c8198dbd21171ade05196baec2bc9bcb850ef19c6f1b
+  metadata.gz: f91c7d409d479cb25648a2cf873751a9d9c30c009ea4053593802a7eb1a05a4d8d9ba080ec80a666759cc2563ff8fee19431d454876f536db416403abc2ad33e
+  data.tar.gz: 04e176fa8b69703742932bde47be84b3c6e969ee8f9c41dc375fb2cda5e134e5201c92065c6c0b1e1a70655d0b48c8b19188144a08c719a95aff2b1b70102149

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
-[full changelog](http://github.com/sue445/kagaribi/compare/v0.1.0...main)
+[full changelog](http://github.com/sue445/kagaribi/compare/v0.1.1...main)
+
+## [0.1.1] - 2024-05-12
+[full changelog](http://github.com/sue445/kagaribi/compare/v0.1.0...v0.1.1)
+
+- Add missing rbs
+  - https://github.com/sue445/kagaribi/pull/18
 
 ## [0.1.0] - 2024-05-11
 

data/README.md

@@ -1,6 +1,7 @@
 # Kagaribi(篝火) :fire:
 Simple client for [Cloud Firestore](https://cloud.google.com/firestore)
 
+[![Gem Version](https://badge.fury.io/rb/kagaribi.svg)](https://badge.fury.io/rb/kagaribi)
 [![test](https://github.com/sue445/kagaribi/actions/workflows/test.yml/badge.svg)](https://github.com/sue445/kagaribi/actions/workflows/test.yml)
 
 ## Installation
@@ -22,13 +23,28 @@ Pass environment variables for Firestore authentication
 
 see https://cloud.google.com/ruby/docs/reference/google-cloud-firestore/latest/AUTHENTICATION
 
+### Requirements
+Firestore CRUD(Create/Read/Update/Delete) requires at least the following IAM Role
+
+* [Cloud Datastore User](https://cloud.google.com/iam/docs/understanding-roles#datastore.user) (`roles/datastore.user`)
+
 ### Simple usage
 ```ruby
 require "kagaribi"
 
 collection = Kagaribi.collection("users")
 
+# or
+
+class UsersCollection < Kagaribi::Collection
+  def initialize
+    super("users")
+  end
+end
+collection = UsersCollection.new
+
 collection.set("sue445", name: "sue445", url: "https://github.com/sue445")
+#=> document is stored in a key named "users/sue445" to Firestore collection
 
 collection.get("sue445")
 #=> { name: "sue445", url: "https://github.com/sue445" }

data/lib/kagaribi/collection.rb

@@ -1,24 +1,45 @@
 # frozen_string_literal: true
 
 module Kagaribi
+  # Manage a Firestore collection
+  #
+  # @example
+  #   require "kagaribi"
+  #
+  #   collection = Kagaribi.collection("users")
+  #
+  #   # or
+  #
+  #   class UsersCollection < Kagaribi::Collection
+  #     def initialize
+  #       super("users")
+  #     end
+  #   end
+  #   collection = UsersCollection.new
+  #
+  #   collection.set("sue445", name: "sue445", url: "https://github.com/sue445")
+  #   #=> document is stored in a key named "users/sue445" to Firestore collection
+  #
+  #   collection.get("sue445")
+  #   #=> { name: "sue445", url: "https://github.com/sue445" }
   class Collection
     MAX_RETRY_COUNT = 5
 
     # @!attribute [r] collection_name
-    #   @return [String]
+    # @return [String]
     attr_reader :collection_name
 
     # @!attribute [r] database_id
-    #   @return [String,nil]
+    # @return [String,nil]
     attr_reader :database_id
 
     # @!attribute [r] logger
-    #   @return [Logger]
+    # @return [Logger]
     attr_reader :logger
 
     # @param collection_name [String]
     # @param database_id [String,nil] Identifier for a Firestore database. If not present, the default database of the project is used.
-    # @param logger [Logger] default is `STDOUT` Logger
+    # @param logger [Logger,nil] default is `STDOUT` Logger
     def initialize(collection_name, database_id: nil, logger: nil)
       @collection_name = collection_name
       @database_id = database_id

data/lib/kagaribi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kagaribi
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/sig/kagaribi/collection.rbs

@@ -13,6 +13,7 @@ module Kagaribi
 
     def initialize: (String collection_name, ?database_id: string?, ?logger: Logger?) -> void
     def set: (String doc_key, Hash[untyped, untyped] data) -> void
+    def update: (String doc_key, Hash[untyped, untyped] data) -> void
     def get: (String doc_key) -> Hash[Symbol, untyped]
     def exists?: (String doc_key) -> bool
     def delete: (String doc_key) -> void

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kagaribi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - sue445
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-11 00:00:00.000000000 Z
+date: 2024-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-firestore