firestore-odm 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70a068827be24d47e32f8aafaf73a81ac5cf49efae3e9b5c2485effe3595d5d2
-  data.tar.gz: 269d7b77881215e34601579d874a4dba9a562de051d6692fdaec498a740f70ed
+  metadata.gz: 4b530cba51bdd238e2599633f45d66c50945548a60c6b37e18d33d8e2f56aac4
+  data.tar.gz: 0b1ca53aa593fd9a028bcf83bc28f14e9eb3033484e33801512cf6f6f818df31
 SHA512:
-  metadata.gz: 2cc94432b57069c10b75232bef32d87d7fc1c253e9b91d0151641ab9eefeb15a60cc48f1a997b424006940247b9b0d4eaa308beac848557c126b73071f0e9a5a
-  data.tar.gz: a6bc96cf17a2f133fadc149a3cc56c25a48c16cc9bf44943d5886cbe4616031804eb5a52da6bca573fe6b14e80cb4882d445ea77094a7db4c5a9dbbb2173050f
+  metadata.gz: 16380f656883a44abcc3b73092df5f0ec621ba8b5a70354485f6af24787e0731d46583f1a4dd562a42f496803369a3b2739cc8c5250eab0ecc4f7b2820be9bff
+  data.tar.gz: be54202ae93445c1b6b3d5f2e020211592572096a670e2245517ab081980ec25ce0cae2c71cfe4add5d6292cfb1a551bea37711a3576090107c6965bc9ebf23c

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+
+*.json
+*.gem

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'solargraph'
+end

data/Gemfile.lock

@@ -0,0 +1,118 @@
+PATH
+  remote: .
+  specs:
+    firestore-odm (0.1.3)
+      google-cloud-firestore (~> 1.4, >= 1.4.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
+    backport (1.1.2)
+    benchmark (0.1.0)
+    concurrent-ruby (1.1.6)
+    e2mmap (0.1.0)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    google-cloud-core (1.5.0)
+      google-cloud-env (~> 1.0)
+      google-cloud-errors (~> 1.0)
+    google-cloud-env (1.3.1)
+      faraday (>= 0.17.3, < 2.0)
+    google-cloud-errors (1.0.0)
+    google-cloud-firestore (1.4.3)
+      concurrent-ruby (~> 1.0)
+      google-cloud-core (~> 1.2)
+      google-gax (~> 1.8)
+      googleapis-common-protos (>= 1.3.9, < 2.0)
+      googleapis-common-protos-types (>= 1.0.4, < 2.0)
+      rbtree (~> 0.4.2)
+    google-gax (1.8.1)
+      google-protobuf (~> 3.9)
+      googleapis-common-protos (>= 1.3.9, < 2.0)
+      googleauth (~> 0.9)
+      grpc (~> 1.24)
+      rly (~> 0.2.3)
+    google-protobuf (3.12.1-universal-darwin)
+    googleapis-common-protos (1.3.10)
+      google-protobuf (~> 3.11)
+      googleapis-common-protos-types (>= 1.0.5, < 2.0)
+      grpc (~> 1.27)
+    googleapis-common-protos-types (1.0.5)
+      google-protobuf (~> 3.11)
+    googleauth (0.12.0)
+      faraday (>= 0.17.3, < 2.0)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.16)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (~> 0.14)
+    grpc (1.28.0-universal-darwin)
+      google-protobuf (~> 3.11)
+      googleapis-common-protos-types (~> 1.0)
+    jaro_winkler (1.5.4)
+    jwt (2.2.1)
+    maruku (0.7.3)
+    memoist (0.16.2)
+    mini_portile2 (2.4.0)
+    multi_json (1.14.1)
+    multipart-post (2.1.1)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    os (1.1.0)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    public_suffix (4.0.5)
+    rainbow (3.0.0)
+    rbtree (0.4.2)
+    reverse_markdown (1.4.0)
+      nokogiri
+    rexml (3.2.4)
+    rly (0.2.3)
+    rubocop (0.84.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    signet (0.14.0)
+      addressable (~> 2.3)
+      faraday (>= 0.17.3, < 2.0)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    solargraph (0.39.8)
+      backport (~> 1.1)
+      benchmark
+      bundler (>= 1.17.2)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      maruku (~> 0.7, >= 0.7.3)
+      nokogiri (~> 1.9, >= 1.9.1)
+      parser (~> 2.3)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (~> 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.0.1)
+    tilt (2.0.10)
+    unicode-display_width (1.7.0)
+    yard (0.9.25)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  firestore-odm!
+  solargraph
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2020, Felipe Cabrera
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,33 @@
+# Firestore ODM
+
+## Configure
+Add `gem 'firestore-odm'` to your Gemfile, or from the terminal
+```
+gem install firestore-odm
+```
+
+Then type
+```
+export GOOGLE_CLOUD_CREDENTIALS=<path_to_google_cloud_credentials>
+```
+
+## How to use
+
+```ruby
+require 'firestore-odm'
+
+class Account < FirestoreODM::Model
+  path :accounts
+
+  field :name, String
+  field :email, String
+end
+
+account = Account.create do |doc|
+  doc.name = 'John Smith'
+  doc.email = 'john.smith@example.com'
+end
+
+puts account.path     #=> accounts/<document_id>
+puts account.to_json  #=> {"name": "John Smith", "email": "john.smith@example.com"}
+```

data/firestore-odm.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |spec|
+  spec.name         = 'firestore-odm'
+  spec.version      = '0.1.4'
+  spec.licenses     = 'BSD-2-Clause'
+  spec.summary      = 'ODM for Firestore in Ruby'
+  spec.description  = ''
+  spec.author       = 'Felipe Cabrera'
+  spec.email        = 'fecabrera0@outlook.com'
+  spec.files        = `git ls-files`.split("\n")
+  spec.homepage     = 'https://github.com/fecabrera/firestore-odm'
+  spec.metadata     = {"source_code_uri" => "https://github.com/fecabrera/firestore-odm"}
+
+  spec.add_dependency 'google-cloud-firestore', '~> 1.4', '>= 1.4.3'
+end

data/test.rb

@@ -0,0 +1,72 @@
+$:.unshift File.join(Dir.pwd, 'lib')
+
+require 'date'
+require 'firestore-odm'
+
+class Post < FirestoreODM::Model
+  path :posts
+
+  field :content, String
+  field :created_at, DateTime
+end
+
+class Account < FirestoreODM::Model
+  path :info
+
+  field :first_name, String
+  field :last_name, String
+  field :birthday, Date, :max => Proc.new { Date.today.prev_year(18) }
+  field :updated_at, DateTime
+end
+
+class User < FirestoreODM::Model
+  path :users
+
+  field :name, String
+  field :created_at, DateTime
+
+  contains Post, Account
+end
+
+puts Account.parse_birthday(Date.parse('2001-12-02'))
+puts Account.parse_birthday(Date.parse('2002-12-02'))
+puts Account.parse_birthday(Date.parse('2003-12-02'))
+
+begin
+  user = User.create_with_id 'john.smith' do |doc|
+    doc.name = 'John Smith'
+    doc.created_at = DateTime.now
+  end
+
+  puts "#{user.path}: #{user.to_json}"
+
+  begin
+    user.create_account_with_id 'account' do |doc|
+      doc.first_name = 'John'
+      doc.last_name = 'Smith'
+      doc.birthday = Date.parse('1981-06-25')
+      doc.updated_at = DateTime.now
+    end
+
+    begin
+      account = user.account_from_id 'account'
+
+      puts "#{account.path}: #{account.to_json}"
+    ensure
+      account.delete
+    end
+
+    post = user.create_post do |doc|
+      doc.content = 'Hello world!'
+      doc.created_at = DateTime.now
+    end
+
+    begin
+      puts "#{post.path}: #{post.to_json}"
+    ensure
+      post.delete
+    end
+  ensure
+    user.delete
+  end
+end

metadata

@@ -1,26 +1,53 @@
 --- !ruby/object:Gem::Specification
 name: firestore-odm
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Felipe Cabrera
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-07 00:00:00.000000000 Z
-dependencies: []
+date: 2020-06-15 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: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.3
 description: ''
 email: fecabrera0@outlook.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- firestore-odm.gemspec
 - lib/firestore-odm.rb
 - lib/firestore-odm/collection.rb
 - lib/firestore-odm/document.rb
 - lib/firestore-odm/model.rb
 - lib/firestore-odm/schema.rb
+- test.rb
 homepage: https://github.com/fecabrera/firestore-odm
 licenses:
 - BSD-2-Clause