firebase 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e864ba62615c80fdea3df462d52ff16f0a05581b
-  data.tar.gz: f92180ed3c2af45cdec10d0c0342a05079727b58
+SHA256:
+  metadata.gz: d72f4bd9c17f8c7d7839cbb1defd919299ca5d32b62c44b31c98f877f5e8b8b9
+  data.tar.gz: 7b0edc9268116110902f07912f5e2f06830e202a651a375c0b800506c17d64db
 SHA512:
-  metadata.gz: 63f404aa8ed4b8f69baebeb5dc3043fd3f7bec1916dd9c1bb51e4690225e7908dad5807a732da525b8b365d2c43467079ff9626e658eb645f911b2e566dcf769
-  data.tar.gz: 7bdbd22fffb2c1ebb2362db13f2b7e01d13303c56d365e806f8073c8422699024a03fc2da4c2f9c6d283f4242aaca4478eefecc6b9db82d18a1fb3d7aeed32c9
+  metadata.gz: b8c9c29aeccf96d90d88ee18448f29b8ea3d2f269d31230ea8ee8851fb4ae6035f9953351fe1cd430b87a7d03e47a8ab6fec6835568add43f6869a2b56a6faf6
+  data.tar.gz: 821ec1fa4f8279d908356344146452b3e7515242dc936f4077c412adf5084dda4c077ed9b697a753e43888e353fca70b8e9a329dcdfbe277b0ec9373edd41917

data/CHANGELOG.md

@@ -1,12 +1,16 @@
 # Changelog
 
+## 0.2.7
+
+* Support newer Firebase [authentication method](https://github.com/oscardelben/firebase-ruby/pull/81)
+
 ## 0.2.5
 
 * [Refactor to remove Request proxy class, expose http client](https://github.com/oscardelben/firebase-ruby/commit/138b1e1461ff33da506b0d7992b42e3544be9cf1)
 
 ## 0.2.4
 
-* Add support for server timestamp. 
+* Add support for server timestamp.
 
 ## 0.2.3
 

data/README.md

@@ -1,4 +1,5 @@
-# firebase [![Build Status](https://travis-ci.org/oscardelben/firebase-ruby.svg?branch=master)](https://travis-ci.org/oscardelben/firebase-ruby)
+# firebase [![Build Status](https://travis-ci.org/oscardelben/firebase-ruby.svg?branch=master)](https://travis-ci.org/oscardelben/firebase-ruby) [![Gem Version](https://badge.fury.io/rb/firebase.svg)](https://rubygems.org/gems/firebase)
+
 
 Ruby wrapper for the [Firebase REST API](https://www.firebase.com/docs/rest/api/).
 
@@ -19,18 +20,21 @@ base_uri = 'https://<your-firebase>.firebaseio.com/'
 
 firebase = Firebase::Client.new(base_uri)
 
-response = firebase.push("todos", { :name => 'Pick the milk', :priority => 1 })
+response = firebase.push("todos", { :name => 'Pick the milk', :'.priority' => 1 })
 response.success? # => true
 response.code # => 200
 response.body # => { 'name' => "-INOQPH-aV_psbk3ZXEX" }
 response.raw_body # => '{"name":"-INOQPH-aV_psbk3ZXEX"}'
 ```
 
-If you have a read-only namespace, set your secret key as follows:
+If you have a read-only namespace, you need to authenticate your Firebase client. `firebase-ruby` will attempt to determine if you are using the old or new [authentication method](https://firebase.google.com/docs/database/rest/auth) by whether your auth string is a valid JSON string or not.
+
 ```ruby
-firebase = Firebase::Client.new(base_uri, secret_key)
+# Using Firebase Admin SDK private key
+firebase = Firebase::Client.new(base_uri, private_key_json_string)
 
-response = firebase.push("todos", { :name => 'Pick the milk', :priority => 1 })
+# Using Firebase Database Secret (deprecated)
+firebase = Firebase::Client.new(base_uri, db_secret)
 ```
 
 You can now pass custom query options to firebase:
@@ -48,6 +52,16 @@ response = firebase.push("todos", {
 })
 ```
 
+To update multiple values that are not direct descendants, supply their paths as keys in the payload to update:
+
+```ruby
+# note the empty path string here as the first argument
+firebase.update('', {
+  "users/posts/#{postID}" => true,
+  "posts/#{postID}" => text
+})
+```
+
 So far, supported methods are:
 
 ```ruby

data/lib/firebase.rb

@@ -1,5 +1,6 @@
 require 'firebase/response'
 require 'firebase/server_value'
+require 'googleauth'
 require 'httpclient'
 require 'json'
 require 'uri'
@@ -13,13 +14,22 @@ module Firebase
         raise ArgumentError.new('base_uri must be a valid https uri')
       end
       base_uri += '/' unless base_uri.end_with?('/')
+      default_header = {
+        'Content-Type' => 'application/json'
+      }
+      if auth && valid_json?(auth)
+        # Using Admin SDK private key
+        scopes = %w(https://www.googleapis.com/auth/firebase.database https://www.googleapis.com/auth/userinfo.email)
+        credentials = Google::Auth::DefaultCredentials.make_creds(json_key_io: StringIO.new(auth), scope: scopes)
+        default_header = credentials.apply(default_header)
+      else
+        # Using deprecated Database Secret
+        @auth = auth
+      end
       @request = HTTPClient.new({
         :base_url => base_uri,
-        :default_header => {
-          'Content-Type' => 'application/json'
-        }
+        :default_header => default_header
       })
-      @auth = auth
     end
 
     # Writes and returns the data
@@ -53,11 +63,23 @@ module Firebase
     private
 
     def process(verb, path, data=nil, query={})
+      if path[0] == '/'
+        raise(ArgumentError.new("Invalid path: #{path}. Path must be relative"))
+      end
       Firebase::Response.new @request.request(verb, "#{path}.json", {
         :body             => (data && data.to_json),
         :query            => (@auth ? { :auth => @auth }.merge(query) : query),
         :follow_redirect  => true
       })
     end
+
+    def valid_json?(json)
+      begin
+        JSON.parse(json)
+        return true
+      rescue JSON::ParserError
+        return false
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: firebase
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Oscar Del Ben
@@ -12,6 +12,20 @@ date: 2015-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.3
+- !ruby/object:Gem::Dependency
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: googleauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -89,22 +103,12 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- ".document"
-- ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
-- VERSION
-- firebase.gemspec
 - lib/firebase.rb
 - lib/firebase/response.rb
 - lib/firebase/server_value.rb
-- spec/firebase_spec.rb
-- spec/spec_helper.rb
 homepage: http://github.com/oscardelben/firebase-ruby
 licenses:
 - MIT
@@ -125,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Firebase wrapper for Ruby

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/.rspec

@@ -1 +0,0 @@
---color

data/.travis.yml

@@ -1,8 +0,0 @@
-sudo: false
-language: ruby
-rvm:
- - "1.8.7"
- - "1.9.3"
- - "2.1.5"
- - "2.2.3"
-bundler_args: --without utility

data/Gemfile

@@ -1,19 +0,0 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-
-gem 'httpclient'
-gem 'json'
-
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem 'rake'
-  gem 'rdoc'
-  gem 'rspec'
-end
-
-group :utility do
-  gem 'jeweler'
-end

data/Gemfile.lock

@@ -1,73 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    addressable (2.3.8)
-    builder (3.2.2)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
-    diff-lcs (1.2.5)
-    faraday (0.9.2)
-      multipart-post (>= 1.2, < 3)
-    git (1.2.9.1)
-    github_api (0.13.0)
-      addressable (~> 2.3)
-      descendants_tracker (~> 0.0.4)
-      faraday (~> 0.8, < 0.10)
-      hashie (>= 3.4)
-      multi_json (>= 1.7.5, < 2.0)
-      nokogiri (~> 1.6.6)
-      oauth2
-    hashie (3.4.3)
-    highline (1.7.8)
-    httpclient (2.7.0.1)
-    jeweler (2.0.1)
-      builder
-      bundler (>= 1.0)
-      git (>= 1.2.5)
-      github_api
-      highline (>= 1.6.15)
-      nokogiri (>= 1.5.10)
-      rake
-      rdoc
-    json (1.8.3)
-    jwt (1.5.2)
-    mini_portile (0.6.2)
-    multi_json (1.11.2)
-    multi_xml (0.5.5)
-    multipart-post (2.0.0)
-    nokogiri (1.6.6.4)
-      mini_portile (~> 0.6.0)
-    oauth2 (1.0.0)
-      faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (~> 1.2)
-    rack (1.6.4)
-    rake (10.4.2)
-    rdoc (4.2.0)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.1)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    thread_safe (0.3.5)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  httpclient
-  jeweler
-  json
-  rake
-  rdoc
-  rspec

data/Rakefile

@@ -1,52 +0,0 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-    gem.name = "firebase"
-    gem.homepage = "http://github.com/oscardelben/firebase-ruby"
-    gem.license = "MIT"
-    gem.summary = %Q{Firebase wrapper for Ruby}
-    gem.description = %Q{Firebase wrapper for Ruby}
-    gem.email = "info@oscardelben.com"
-    gem.authors = ["Oscar Del Ben"]
-    # dependencies defined in Gemfile
-  end
-  Jeweler::RubygemsDotOrgTasks.new
-rescue LoadError
-end
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :default => :spec
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "firebase #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +0,0 @@
-0.2.6

data/firebase.gemspec

@@ -1,69 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: firebase 0.2.6 ruby lib
-
-Gem::Specification.new do |s|
-  s.name = "firebase"
-  s.version = "0.2.6"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["Oscar Del Ben"]
-  s.date = "2015-11-26"
-  s.description = "Firebase wrapper for Ruby"
-  s.email = "info@oscardelben.com"
-  s.extra_rdoc_files = [
-    "CHANGELOG.md",
-    "LICENSE.txt",
-    "README.md"
-  ]
-  s.files = [
-    ".document",
-    ".rspec",
-    ".travis.yml",
-    "CHANGELOG.md",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "firebase.gemspec",
-    "lib/firebase.rb",
-    "lib/firebase/response.rb",
-    "lib/firebase/server_value.rb",
-    "spec/firebase_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = "http://github.com/oscardelben/firebase-ruby"
-  s.licenses = ["MIT"]
-  s.rubygems_version = "2.4.5"
-  s.summary = "Firebase wrapper for Ruby"
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<httpclient>, [">= 0"])
-      s.add_runtime_dependency(%q<json>, [">= 0"])
-      s.add_development_dependency(%q<rake>, [">= 0"])
-      s.add_development_dependency(%q<rdoc>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-    else
-      s.add_dependency(%q<httpclient>, [">= 0"])
-      s.add_dependency(%q<json>, [">= 0"])
-      s.add_dependency(%q<rake>, [">= 0"])
-      s.add_dependency(%q<rdoc>, [">= 0"])
-      s.add_dependency(%q<rspec>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<httpclient>, [">= 0"])
-    s.add_dependency(%q<json>, [">= 0"])
-    s.add_dependency(%q<rake>, [">= 0"])
-    s.add_dependency(%q<rdoc>, [">= 0"])
-    s.add_dependency(%q<rspec>, [">= 0"])
-  end
-end
-

data/spec/firebase_spec.rb

@@ -1,132 +0,0 @@
-require 'spec_helper'
-
-describe "Firebase" do
-  let (:data) do
-    { 'name' => 'Oscar' }
-  end
-
-  describe "invalid uri" do
-    it "should raise on http" do
-      expect{ Firebase::Client.new('http://test.firebaseio.com') }.to raise_error(ArgumentError)
-    end
-
-    it 'should raise on empty' do
-      expect{ Firebase::Client.new('') }.to raise_error(ArgumentError)
-    end
-  end
-
-  before do
-    @firebase = Firebase::Client.new('https://test.firebaseio.com')
-  end
-
-  describe "set" do
-    it "writes and returns the data" do
-      expect(@firebase).to receive(:process).with(:put, 'users/info', data, {})
-      @firebase.set('users/info', data)
-    end
-  end
-
-  describe "get" do
-    it "returns the data" do
-      expect(@firebase).to receive(:process).with(:get, 'users/info', nil, {})
-      @firebase.get('users/info')
-    end
-
-    it "correctly passes custom ordering params" do
-      params = {
-        :orderBy => '"$key"',
-        :startAt => '"A1"'
-      }
-      expect(@firebase).to receive(:process).with(:get, 'users/info', nil, params)
-      @firebase.get('users/info', params)
-    end
-
-    it "works when run against real Firebase dataset" do
-      firebase = Firebase::Client.new 'https://dinosaur-facts.firebaseio.com'
-      response = firebase.get 'dinosaurs', :orderBy => '"$key"', :startAt => '"a"', :endAt => '"m"'
-      expect(response.body).to eq({
-        "bruhathkayosaurus" => {
-          "appeared" => -70000000,
-            "height" => 25,
-            "length" => 44,
-             "order" => "saurischia",
-          "vanished" => -70000000,
-            "weight" => 135000
-        },
-        "lambeosaurus" => {
-          "appeared" => -76000000,
-            "height" => 2.1,
-            "length" => 12.5,
-             "order" => "ornithischia",
-          "vanished" => -75000000,
-            "weight" => 5000
-        },
-        "linhenykus" => {
-          "appeared" => -85000000,
-            "height" => 0.6,
-            "length" => 1,
-             "order" => "theropoda",
-          "vanished" => -75000000,
-            "weight" => 3
-        }
-      })
-    end
-
-    it "return nil if response body contains 'null'" do
-      mock_response = double(:body => 'null')
-      response = Firebase::Response.new(mock_response)
-      expect { response.body }.to_not raise_error
-    end
-
-    it "return true if response body contains 'true'" do
-      mock_response = double(:body => 'true')
-      response = Firebase::Response.new(mock_response)
-      expect(response.body).to eq(true)
-    end
-
-    it "return false if response body contains 'false'" do
-      mock_response = double(:body => 'false')
-      response = Firebase::Response.new(mock_response)
-      expect(response.body).to eq(false)
-    end
-
-    it "raises JSON::ParserError if response body contains invalid JSON" do
-      mock_response = double(:body => '{"this is wrong"')
-      response = Firebase::Response.new(mock_response)
-      expect { response.body }.to raise_error(JSON::ParserError)
-    end
-  end
-
-  describe "push" do
-    it "writes the data" do
-      expect(@firebase).to receive(:process).with(:post, 'users', data, {})
-      @firebase.push('users', data)
-    end
-  end
-
-  describe "delete" do
-    it "returns true" do
-      expect(@firebase).to receive(:process).with(:delete, 'users/info', nil, {})
-      @firebase.delete('users/info')
-    end
-  end
-
-  describe "update" do
-    it "updates and returns the data" do
-      expect(@firebase).to receive(:process).with(:patch, 'users/info', data, {})
-      @firebase.update('users/info', data)
-    end
-  end
-
-  describe "http processing" do
-    it "sends custom auth" do
-      firebase = Firebase::Client.new('https://test.firebaseio.com', 'secret')
-      expect(firebase.request).to receive(:request).with(:get, "todos.json", {
-        :body => nil,
-        :query => {:auth => "secret", :foo => 'bar'},
-        :follow_redirect => true
-      })
-      firebase.get('todos', :foo => 'bar')
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,12 +0,0 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'rspec'
-require 'firebase'
-
-# Requires supporting files with custom matchers and macros, etc,
-# in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
-
-RSpec.configure do |config|
-
-end