firebase-ruby 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c81422955349a239c73df7add0f495be525dee6df19fb99c07fcc7a97ad5ea9b
-  data.tar.gz: c28b48f45899cc15a405baf006addb187eb80379d144522f9412ec5c3244daac
+  metadata.gz: 4d8bdd33ef9631e94e965401224f4db530ec602a7cc937a59b8ad9b7b5c49d44
+  data.tar.gz: 80dc1825a35382944ecab8c19e8b61be66fbda26f2dcf4662696247aba45989a
 SHA512:
-  metadata.gz: 1c81dbcaef8b12f675a85d07488c6979161d2a2bd3bdada1e5e3fd69a6b38745a396f44c80bda7e88a00b310ee7febde6f300025378c8614d4f3764b284bcf3f
-  data.tar.gz: 267c6bdbef1be804ddcccd6c20d534fa6f0a874751fa0479c240079933da0d9ea4cc0a22931fae3ebfb12551f6ff075f8849a0e2627ef56e150afca770372663
+  metadata.gz: e3fb302a31039871d75dd1890718a6570fca57bd079f563f7e8197b4f4f1a55ef70532a1490c98ef2e30ad227787491fc3cb947a889adc85e0a677325115e42c
+  data.tar.gz: '0538e446b43ec656d5ddef7e1461f1848d7f3a2c8eb2ac540ce3a5a71644e49f505153a0598f5f8254023bde9fe68cc29fe6badf2d256dcb6aff6079368c12d5'

data/README.md

@@ -2,9 +2,19 @@
 
 [![Gem Version](https://badge.fury.io/rb/firebase-ruby.svg)](http://badge.fury.io/rb/firebase-ruby) [![Code Climate](https://codeclimate.com/github/kenjij/firebase-ruby/badges/gpa.svg)](https://codeclimate.com/github/kenjij/firebase-ruby) [![security](https://hakiri.io/github/kenjij/firebase-ruby/master.svg)](https://hakiri.io/github/kenjij/firebase-ruby/master)
 
-A pure Ruby library for [Firebase Realtime Database](https://firebase.google.com/products/database/) [REST API](https://firebase.google.com/docs/reference/rest/database/) which has only one external dependancy: [jwt](http://jwt.github.io/ruby-jwt/).  `firebase-ruby` uses Ruby's built-in Net::HTTP for all HTTP access.
+A pure Ruby library for [Firebase Realtime Database](https://firebase.google.com/products/database/) [REST API](https://firebase.google.com/docs/reference/rest/database/) which has only one external dependency: [jwt](http://jwt.github.io/ruby-jwt/).  `firebase-ruby` uses Ruby's built-in Net::HTTP for all HTTP access.
 
-## CLI: fbrb
+## Getting Started
+
+## Firebase Realtime Database
+
+Firebase SDK makes it easy to work with Realtime Database. However, on the server-side you you'll likely have to work with the REST API directly, and on top of this you will need to deal with OAuth, which can get complicated in a server environment.
+
+To use firebase-ruby, you'll need a [Service Account and its Private Key](https://firebase.google.com/docs/database/rest/auth#generate_an_access_token). This needs to be in JSON format. Now, you have two ways to use it.
+
+_See [Access Token](#oauth-20-access-token) for more details on that._
+
+## Usage 1) CLI: fbrb
 
 This gem has a built-in command `fbrb` as an example use and for quick testing.
 
@@ -14,7 +24,7 @@ fbrb -k privatekey.json /
 
 This will download the entire database in JSON format. By using the private key JSON file provided via Firebase console when creating a service account, necessary information such as project ID, URL, credentials are automatically applied.
 
-## Using In An App
+## Usage 2) In Your App
 
 ```ruby
 require 'firebase-ruby'
@@ -53,6 +63,10 @@ db.patch('/users/jack/name', {last: "Jones"})
 db.delete('/users/jack/name/last')
 ```
 
+## AWS Lambda Layers
+
+Trying to use it in a Lambda function but lost figuring out how to install gems? See [firebase-lambda-layer](https://github.com/kenjij/firebase-lambda-layer).
+
 ## OAuth 2.0 Access Token
 
 Using the given credentials, `firebase-ruby` will automatically retrieve the [access token](https://firebase.google.com/docs/reference/rest/database/user-auth) from Google's server. The token is valid for 1 hour but a new token will be fetched right before it expires.

data/firebase-ruby.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.authors       = ['Ken J.']
   s.email         = ['kenjij@gmail.com']
   s.summary       = %q{Pure simple Ruby based Firebase REST library}
-  s.description   = %q{Firebase REST library written in pure Ruby without external dependancy.}
+  s.description   = %q{A pure Ruby server-side library for Firebase Realtime Database with only one external dependency: jwt.}
   s.homepage      = 'https://github.com/kenjij/firebase-ruby'
   s.license       = 'MIT'
 
@@ -16,6 +16,6 @@ Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.required_ruby_version = '>= 2.0'
+  s.required_ruby_version = '>= 2.1'
   s.add_runtime_dependency 'jwt', '~> 2.2'
 end

data/lib/firebase-ruby/version.rb

@@ -1,5 +1,5 @@
 module Firebase
 
-  Version = '0.3.0'
+  Version = '0.3.1'
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: firebase-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Ken J.
@@ -24,7 +24,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
-description: Firebase REST library written in pure Ruby without external dependancy.
+description: 'A pure Ruby server-side library for Firebase Realtime Database with
+  only one external dependency: jwt.'
 email:
 - kenjij@gmail.com
 executables:
@@ -56,7 +57,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="