kagaribi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d7009cb11cae6982c8214c7de69349b851ac8b7475959801b48ebb309762a5e6
+  data.tar.gz: 77887aa0a0f38a9cc1a83177505e78ec3bd4d20a6cf2f37eddae03ddb4f17539
+SHA512:
+  metadata.gz: f3849fcf52d60d06a23105f2318547bd9a14c49edaa9a9df6cdc28cd08ab1b91b78a533349c68935204a632e86b4b569600209f9cbfb14796f67df0e75fb351d
+  data.tar.gz: 26c6ee337021f3c5d68a9d622db22cbc3c54e4052eb4e75e4af36d80c616b3f6af5c095cbc87e23ae8d6c8198dbd21171ade05196baec2bc9bcb850ef19c6f1b

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.yardopts

@@ -0,0 +1,6 @@
+--markup markdown
+--no-private
+--hide-void-return
+-
+CHANGELOG.md
+LICENSE.txt

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## [Unreleased]
+[full changelog](http://github.com/sue445/kagaribi/compare/v0.1.0...main)
+
+## [0.1.0] - 2024-05-11
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 sue445
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# Kagaribi(篝火) :fire:
+Simple client for [Cloud Firestore](https://cloud.google.com/firestore)
+
+[![test](https://github.com/sue445/kagaribi/actions/workflows/test.yml/badge.svg)](https://github.com/sue445/kagaribi/actions/workflows/test.yml)
+
+## Installation
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+$ bundle add kagaribi
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+$ gem install kagaribi
+```
+
+## Usage
+### Authentication
+Pass environment variables for Firestore authentication
+
+see https://cloud.google.com/ruby/docs/reference/google-cloud-firestore/latest/AUTHENTICATION
+
+### Simple usage
+```ruby
+require "kagaribi"
+
+collection = Kagaribi.collection("users")
+
+collection.set("sue445", name: "sue445", url: "https://github.com/sue445")
+
+collection.get("sue445")
+#=> { name: "sue445", url: "https://github.com/sue445" }
+```
+
+All methods are followings
+
+https://sue445.github.io/kagaribi/Kagaribi/Collection
+
+## Development
+At first, install [Firebase Local Emulator Suite](https://firebase.google.com/docs/emulator-suite/install_and_configure)
+
+Mac 
+
+```bash
+brew install firebase-cli
+```
+
+Unix
+
+```bash
+sudo wget https://firebase.tools/bin/linux/latest -O /usr/local/bin/firebase --quiet
+sudo chmod 755 /usr/local/bin/firebase
+firebase setup:emulators:firestore
+```
+
+Run tests with Firebase Local Emulator
+
+```bash
+bundle exec rake spec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sue445/kagaribi.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+desc "Run spec"
+task :spec do
+  sh "firebase --project test emulators:exec --only firestore 'rspec'"
+end
+
+desc "Check rbs"
+task :rbs do
+  sh "rbs validate"
+  sh "steep check"
+end
+
+desc "Run all"
+task all: %i(spec rbs)
+
+task default: :all

data/Steepfile

@@ -0,0 +1,31 @@
+# D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+
+  check "lib"                       # Directory name
+  # check "Gemfile"                   # File name
+  # check "app/models/**/*.rb"        # Glob
+  # ignore "lib/templates/*.rb"
+
+  # library "pathname"              # Standard libraries
+  # library "strong_json"           # Gems
+
+  collection_config "rbs_collection.yaml"
+
+  # configure_code_diagnostics(D::Ruby.default)      # `default` diagnostics setting (applies by default)
+  # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.silent)       # `silent` diagnostics setting
+  # configure_code_diagnostics do |hash|             # You can setup everything yourself
+  #   hash[D::Ruby::NoMethod] = :information
+  # end
+end
+
+# target :test do
+#   signature "sig", "sig-private"
+#
+#   check "test"
+#
+#   # library "pathname"              # Standard libraries
+# end

data/lib/kagaribi/collection.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module Kagaribi
+  class Collection
+    MAX_RETRY_COUNT = 5
+
+    # @!attribute [r] collection_name
+    #   @return [String]
+    attr_reader :collection_name
+
+    # @!attribute [r] database_id
+    #   @return [String,nil]
+    attr_reader :database_id
+
+    # @!attribute [r] 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
+    def initialize(collection_name, database_id: nil, logger: nil)
+      @collection_name = collection_name
+      @database_id = database_id
+
+      @logger =
+        if logger
+          logger
+        else
+          Logger.new($stdout)
+        end
+    end
+
+    # Save a document to collection
+    # @note If a document with the same key exists, it is overwritten.
+    # @param doc_key [String]
+    # @param data [Hash]
+    def set(doc_key, data)
+      ref = firestore.doc(full_doc_key(doc_key))
+      ref.set(data)
+    end
+
+    # Update a document that has already been saved
+    # @note If a document with the same key exists, it is merged.
+    # @param doc_key [String]
+    # @param data [Hash]
+    def update(doc_key, data)
+      ref = firestore.doc(full_doc_key(doc_key))
+      ref.update(data)
+    end
+
+    # Get document from collection
+    # @param doc_key [String]
+    # @return [Hash<Symbol,Object>] return empty Hash if document isn't found
+    def get(doc_key)
+      with_retry("Kagaribi::Collection#get") do
+        ref = firestore.doc(full_doc_key(doc_key))
+        snap = ref.get
+        snap&.data || {}
+      end
+    end
+
+    # Whether document is exists in collection
+    # @param doc_key [String]
+    # @return [Boolean]
+    def exists?(doc_key)
+      with_retry("Kagaribi::Collection#exists?") do
+        ref = firestore.doc(full_doc_key(doc_key))
+        snap = ref.get
+        snap&.exists?
+      end
+    end
+
+    # Delete document in collection
+    # @param doc_key [String]
+    def delete(doc_key)
+      ref = firestore.doc(full_doc_key(doc_key))
+      ref.delete
+    end
+
+    # @param key [String]
+    # @return [String]
+    def self.sanitize_key(key)
+      key.tr("/", "-")
+    end
+
+    private
+
+    # @return [Google::Cloud::Firestore]
+    def firestore
+      @firestore ||= Google::Cloud::Firestore.new(database_id: database_id)
+    end
+
+    # @return [String]
+    def sanitized_collection_name
+      sanitize_key(@collection_name)
+    end
+
+    # @param key [String]
+    # @return [String]
+    def sanitize_key(key)
+      Collection.sanitize_key(key)
+    end
+
+    # @param doc_key [String]
+    # @return [String]
+    def full_doc_key(doc_key)
+      "#{sanitized_collection_name}/#{sanitize_key(doc_key)}"
+    end
+
+    # @param label [String]
+    # @yield
+    def with_retry(label)
+      yield
+    rescue TypeError, GRPC::Unavailable, RuntimeError, Signet::AuthorizationError => error
+      raise error unless retryable_error?(error)
+
+      retry_count ||= 0
+      retry_count += 1
+
+      raise error if retry_count > MAX_RETRY_COUNT
+
+      logger.warn "[#{label}] collection_name=#{@collection_name}, retry_count=#{retry_count}, error=#{error}"
+      sleep 1
+      retry
+    end
+
+    # @param error [StandardError]
+    # @return [Boolean]
+    def retryable_error?(error)
+      case error
+      when RuntimeError
+        # e.g.
+        # Could not load the default credentials. Browse to
+        # https://developers.google.com/accounts/docs/application-default-credentials
+        # for more information
+        return true if error.message.include?("Could not load the default credentials.")
+
+        # e.g.
+        # Your credentials were not found. To set up Application Default
+        # Credentials for your environment, see
+        # https://cloud.google.com/docs/authentication/external/set-up-adc
+        return true if error.message.include?("Your credentials were not found.")
+
+        return false
+      end
+
+      true
+    end
+  end
+end

data/lib/kagaribi/version.rb

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

data/lib/kagaribi.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "google/cloud/firestore"
+require "logger"
+
+require_relative "kagaribi/version"
+
+module Kagaribi
+  class Error < StandardError; end
+
+  autoload :Collection, "kagaribi/collection"
+
+  # @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
+  # @return [Kagaribi::Collection]
+  def self.collection(collection_name, database_id: nil, logger: nil)
+    Collection.new(collection_name, database_id: database_id, logger: logger)
+  end
+end

data/rbs_collection.lock.yaml

@@ -0,0 +1,32 @@
+---
+path: ".gem_rbs_collection"
+gems:
+- name: diff-lcs
+  version: '1.5'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 7a105f52053ce1c708b605dfa9c1ab8473424036
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: fileutils
+  version: '0'
+  source:
+    type: stdlib
+- name: logger
+  version: '0'
+  source:
+    type: stdlib
+- name: monitor
+  version: '0'
+  source:
+    type: stdlib
+- name: rake
+  version: '13.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 7a105f52053ce1c708b605dfa9c1ab8473424036
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+gemfile_lock_path: Gemfile.lock

data/rbs_collection.yaml

@@ -0,0 +1,26 @@
+# Download sources
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# You can specify local directories as sources also.
+# - type: local
+#   path: path/to/your/local/repository
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+gems:
+  - name: rbs
+    ignore: true
+  - name: steep
+    ignore: true
+  - name: yard
+    ignore: true
+  - name: kagaribi
+    ignore: true
+
+  - name: logger

data/sig/kagaribi/collection.rbs

@@ -0,0 +1,30 @@
+# TypeProf 0.21.9
+
+# Classes
+module Kagaribi
+  class Collection
+    MAX_RETRY_COUNT: Integer
+
+    @firestore: Google::Cloud::Firestore
+
+    attr_reader collection_name: String
+    attr_reader database_id: String
+    attr_reader logger: Logger
+
+    def initialize: (String collection_name, ?database_id: string?, ?logger: Logger?) -> void
+    def set: (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
+    def self.sanitize_key: (String key) -> String
+
+    private
+
+    def firestore: -> Google::Cloud::Firestore
+    def sanitized_collection_name: -> String
+    def sanitize_key: (String key) -> String
+    def full_doc_key: (String doc_key) -> String
+    def with_retry: (String label)  { -> untyped } -> untyped
+    def retryable_error?: (StandardError error) -> bool
+  end
+end

data/sig/kagaribi.rbs

@@ -0,0 +1,10 @@
+module Kagaribi
+  VERSION: String
+
+  class Error < StandardError
+  end
+
+  def self.collection: (String collection_name, ?database_id: string?, ?logger: Logger?) -> Collection
+
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: kagaribi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sue445
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-cloud-firestore
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: steep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple client for Cloud Firestore
+email:
+- sue445@sue445.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".yardopts"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- Steepfile
+- lib/kagaribi.rb
+- lib/kagaribi/collection.rb
+- lib/kagaribi/version.rb
+- rbs_collection.lock.yaml
+- rbs_collection.yaml
+- sig/kagaribi.rbs
+- sig/kagaribi/collection.rbs
+homepage: https://github.com/sue445/kagaribi
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sue445/kagaribi
+  source_code_uri: https://github.com/sue445/kagaribi
+  changelog_uri: https://github.com/sue445/kagaribi/blob/main/CHANGELOG.md
+  documentation_uri: https://sue445.github.io/kagaribi/
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: Simple client for Cloud Firestore
+test_files: []