firebase-ruby 0.1.0 → 0.2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71129a24564dba1985fd02873accf5e6d3546d5e
-  data.tar.gz: 5e7ce2fcef94d65b4c841baaa19c4d5a504db055
+  metadata.gz: 9ed31533488ea96baffad5a57685f0270a38e3c4
+  data.tar.gz: 21e8b7d9747ef1f43a614de297a54182781ccb0f
 SHA512:
-  metadata.gz: 1ef0c98f6394aaaaf885addb150fa0487c8961180288cef0938f908908797679c34ffa14a5d496e299eaf3f8ef7e3bc499c8c945b285ebb45bd4e163898ee2b8
-  data.tar.gz: ec53da00cec351a3b6b7f1ade123a1b2b22cf45712c06d6036c2cbb072e46d1ad4caa2e68ab620fb6cce8474e7f740f7c2d6a302d596fe8db60ba81f991c2f91
+  metadata.gz: bfb8b6e5680a6be288405e3f3b69f074afbcb91849403d2b816c37985f079b6759e79cb35b06ded436c422d390b48db0f4406e1cf67b04d6e0981cfadd36e499
+  data.tar.gz: ef0cfe88733e0f8f6d17f5dd5f05b26e9bfcbe8e530b2f3ecc8ff0e3f15c23202685c031f68a35ae119f88d34ccc025220fd22eada415f36174f958098285421

data/.codeclimate.yml

@@ -0,0 +1,18 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby:
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+
+ratings:
+   paths:
+     - "**"
+
+exclude_paths:
+  - lib/firebase-ruby/trollop.rb

data/README.md

@@ -1,2 +1,60 @@
-# firebase-ruby-private
-Pure simple Ruby based Firebase REST library
+# firebase-ruby
+
+[![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.
+
+## CLI: fbrb
+
+This gem has a built-in command `fbrb` as an example use and for quick testing.
+
+```sh
+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
+
+```ruby
+require 'firebase-ruby'
+
+# If you want to enable debug logging
+Firebase.logger = Logger.new(STDOUT)
+Firebase.logger.level = Logger::DEBUG
+
+db = Firebase::Database.new()
+db.set_auth_with_key(path: path_to_key_file)
+# or alternatively supply the JSON as string
+db.set_auth_with_key(json: json_string)
+
+db.get('/users/jack/name')
+#{
+#  "first": "Jack",
+#  "last": "Sparrow"
+#}
+
+db.put('/users/jack/name', {first: "Jack", last: "Sparrow"})
+#{
+#  "first": "Jack",
+#  "last": "Sparrow"
+#}
+
+db.post('/message_list', {user_id: "jack", text: "Ahoy!"})
+#{
+#  "name": "-INOQPH-aV_psbk3ZXEX"
+#}
+
+db.patch('/users/jack/name', {last: "Jones"})
+#{
+#  "last": "Jones"
+#}
+
+db.delete('/users/jack/name/last')
+```
+
+## 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.
+
+`firebase-ruby` keeps the Google OAuth 2.0 process a black box. But for more details, see the document on Google Developers which the process is based on: [Using OAuth 2.0 for Server to Server Applications](https://developers.google.com/identity/protocols/OAuth2ServiceAccount).

data/bin/fbrb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 require 'firebase-ruby/trollop'
 require 'firebase-ruby'
+require 'json'
 
 
 opts = Trollop::options do
@@ -11,6 +12,7 @@ opts = Trollop::options do
   opt :log, 'Log file', type: :string
   opt :path, 'Path', type: :string
   opt :request, 'Specify request command to use', type: :string, short: 'X', default: 'get'
+  opt :ruby, 'Output Ruby format'
   opt :verbose, 'Verbose mode'
 end
 
@@ -48,4 +50,11 @@ when :put, :patch, :post
   end
 end
 
-puts data if data
+if data
+  if opts[:ruby]
+    puts data
+  else
+    json_opts = {indent: '  ', space: ' ', object_nl: "\n", array_nl: "\n"}
+    puts JSON.fast_generate(data, json_opts)
+  end
+end

data/firebase-ruby.gemspec

@@ -7,12 +7,15 @@ Gem::Specification.new do |s|
   s.version       = Firebase::Version
   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.summary       = %q{Pure Ruby Firebase REST library}
+  s.description   = %q{A simple Firebase Realtime Database REST API library in pure Ruby.}
   s.homepage      = 'https://github.com/kenjij/firebase-ruby'
   s.license       = 'MIT'
 
   s.files         = `git ls-files`.split($/)
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.require_paths = ['lib']
+
+  s.required_ruby_version = '>= 2.0'
+  s.add_runtime_dependency 'jwt', '~> 1.5'
 end

data/lib/firebase-ruby/database.rb

@@ -59,12 +59,9 @@ module Firebase
     def http
       unless @http
         url = FIREBASE_URL_TEMPLATE % project_id
-        headers = {
-          'Authorization' => "Bearer #{auth.valid_token}",
-          'Content-Type' => 'application/json'
-        }
-        @http = HTTP.new(url, headers)
+        @http = HTTP.new(url, {'Content-Type' => 'application/json'})
       end
+      @http.headers['Authorization'] = "Bearer #{auth.valid_token}"
       return @http
     end
 

data/lib/firebase-ruby/version.rb

@@ -1,5 +1,5 @@
 module Firebase
 
-  Version = '0.1.0'
+  Version = '0.2.0.1'
 
 end

metadata

@@ -1,16 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: firebase-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0.1
 platform: ruby
 authors:
 - Ken J.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-05 00:00:00.000000000 Z
-dependencies: []
-description: Firebase REST library written in pure Ruby without external dependancy.
+date: 2017-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: A simple Firebase Realtime Database REST API library in pure Ruby.
 email:
 - kenjij@gmail.com
 executables:
@@ -18,6 +32,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - LICENSE
 - README.md
 - bin/fbrb
@@ -41,7 +56,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -49,8 +64,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Pure simple Ruby based Firebase REST library
+summary: Pure Ruby Firebase REST library
 test_files: []