rest-firebase 0.9.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45df4ea3a44c2d4bd3987e9732b5d3c4bc8244e3
-  data.tar.gz: 558d531d7bd4f7a87bcb1a8d9eb6472aa892ed9d
+  metadata.gz: a30e9102ed052bca42445fecdfa66a498e8e01a3
+  data.tar.gz: e2323344983ba8c34fcb155d28eafb5140fa6c74
 SHA512:
-  metadata.gz: 040559b33938b07933026e8824b81ff087ed1b83221e23dea9abb8dc0f2d07967d7fa267aa4c3f22f2f1939bf88e5ded0ff27e713f3555887b394388918e1987
-  data.tar.gz: 367a943d81a2eaa5220a6bb737f6f697ffd81c4a6c7dd0eb1c82ed6c099bb20d471cdf6970c09aadfab342ebfe6b44e874147e7b3fa212bee2ebcc2c3510a51a
+  metadata.gz: 6c839fdac740a2b1377bcc9a53041efbe18c046344a937d42f0bc377019031aeb5455f77f076bbc4a636304de8ae039a5e9b8336edbcd5caedec7a70eb0ac215
+  data.tar.gz: 93688fe31a380d56223905232f236eb7f3ac5ca8676ca22a1ba456fddccd98866a4c02be5a387f061daa7510767e75802b5aaedc445c4a0bf84ab3533b73f718

data/.gitignore

@@ -1,2 +1,2 @@
 /pkg/
-Gemfile.lock
+/coverage/

data/.travis.yml

@@ -1,10 +1,11 @@
-before_install: 'git submodule update --init'
-script: 'ruby -r bundler/setup -S rake test'
 
+language: ruby
 rvm:
   - 1.9
   - 2.0
   - 2.1
-  - ruby
   - rbx-2
   - jruby
+
+install: 'bundle install --retry=3'
+script: 'ruby -r bundler/setup -S rake test'

data/CHANGES.md

@@ -1,5 +1,19 @@
 # CHANGES
 
+## rest-firebase 1.0.0 -- 2014-12-09
+
+### Enhancement
+
+* Encode query in JSON to make using [Firebase queries][] easy.
+* Introduced `max_retries`, `retry_exceptions`, and `error_callback` from
+  latest rest-core (3.5.0+). See README.md for detail.
+
+[Firebase queries]: https://www.firebase.com/docs/rest/guide/retrieving-data.html#section-rest-queries
+
+### Internal Enhancement
+
+* Encode payload in JSON with middleware from rest-core
+
 ## rest-firebase 0.9.5 -- 2014-11-07
 
 * Base64url encoded JWT would no longer contain any newlines.

data/Gemfile

@@ -18,6 +18,9 @@ gem 'multi_json'
 
 gem 'rack'
 
+gem 'simplecov', :require => false if ENV['COV']
+gem 'coveralls', :require => false if ENV['CI']
+
 platforms :ruby do
   gem 'yajl-ruby'
 end

data/README.md

@@ -1,4 +1,4 @@
-# rest-firebase [![Build Status](https://secure.travis-ci.org/CodementorIO/rest-firebase.png?branch=master)](http://travis-ci.org/CodementorIO/rest-firebase)
+# rest-firebase [![Build Status](https://secure.travis-ci.org/CodementorIO/rest-firebase.png?branch=master)](http://travis-ci.org/CodementorIO/rest-firebase) [![Coverage Status](https://coveralls.io/repos/CodementorIO/rest-firebase/badge.png)](https://coveralls.io/r/CodementorIO/rest-firebase)
 
 by [Codementor][]
 
@@ -65,6 +65,17 @@ f = RestFirebase.new :site => 'https://SampleChat.firebaseIO-demo.com/',
                      :secret => 'secret',
                      :d => {:auth_data => 'something'},
                      :log_method => method(:puts),
+                     # `timeout` in seconds
+                     :timeout => 10,
+                     # `max_retries` upon failures. Default is: `0`
+                     :max_retries => 3,
+                     # `retry_exceptions` for which exceptions should retry
+                     # Default is: `[IOError, SystemCallError]`
+                     :retry_exceptions =>
+                       [IOError, SystemCallError, Timeout::Error],
+                     # `error_callback` would get called each time there's
+                     # an exception. Useful for monitoring and logging.
+                     :error_callback => method(:p),
                      # `auth_ttl` describes when we should refresh the auth
                      # token. Set it to `false` to disable auto-refreshing.
                      # The default is 23 hours.
@@ -96,6 +107,9 @@ p f.post('users/tom', :some => 'other')
 p f.get('users/tom')
 p f.delete('users/tom')
 
+# With Firebase queries (it would encode query in JSON for you)
+p f.get('users/tom', :orderBy => '$key', :limitToFirst => 1)
+
 # Need to tell onreconnect stops reconnecting, or even if we close
 # the connection manually, it would still try to reconnect again.
 @reconnect = false

data/Rakefile

@@ -10,14 +10,18 @@ $LOAD_PATH.unshift(File.expand_path("#{dir}/rest-core/lib"))
 
 Gemgem.init(dir) do |s|
   s.name     = 'rest-firebase'
-  s.version  = '0.9.5'
+  s.version  = '1.0.0'
   s.homepage = 'https://github.com/CodementorIO/rest-firebase'
 
   s.authors  = ['Codementor', 'Lin Jen-Shin (godfat)']
   s.email    = ['help@codementor.io']
 
-  %w[rest-core].each{ |g| s.add_runtime_dependency(g, '>=3.3.0') }
+  %w[rest-core].each{ |g| s.add_runtime_dependency(g, '>=3.5.0') }
 
   # exclude rest-core
   s.files.reject!{ |f| f.start_with?('rest-core/') }
 end
+
+task 'test' do
+  SimpleCov.add_filter('rest-core/lib') if ENV['COV'] || ENV['CI']
+end

data/lib/rest-firebase.rb

@@ -3,19 +3,21 @@ require 'rest-core'
 
 # https://www.firebase.com/docs/security/custom-login.html
 # https://www.firebase.com/docs/rest-api.html
+# https://www.firebase.com/docs/rest/guide/retrieving-data.html#section-rest-queries
 RestFirebase = RC::Builder.client(:d, :secret, :auth, :auth_ttl, :iat) do
-  use RC::Timeout       , 10
-
   use RC::DefaultSite   , 'https://SampleChat.firebaseIO-demo.com/'
   use RC::DefaultHeaders, {'Accept' => 'application/json',
                            'Content-Type' => 'application/json'}
   use RC::DefaultQuery  , nil
 
+  use RC::Retry         , 0, RC::Retry::DefaultRetryExceptions
+  use RC::Timeout       , 10
   use RC::FollowRedirect, 1
-  use RC::CommonLogger  , nil
   use RC::ErrorHandler  , lambda{ |env| RestFirebase::Error.call(env) }
   use RC::ErrorDetectorHttp
+  use RC::JsonRequest   , true
   use RC::JsonResponse  , true
+  use RC::CommonLogger  , nil
   use RC::Cache         , nil, 600
 end
 
@@ -75,15 +77,12 @@ module RestFirebase::Client
 
   def request env, app=app
     check_auth
-
-    path = "#{env[REQUEST_PATH]}.json"
-    payload = if env[REQUEST_PAYLOAD]
-      {REQUEST_PAYLOAD => Json.encode(env[REQUEST_PAYLOAD])}
-    else
-      {}
+    query = env[REQUEST_QUERY].inject({}) do |q, (k, v)|
+      q[k] = Json.encode(v)
+      q
     end
-
-    super(env.merge(REQUEST_PATH => path).merge(payload), app)
+    super(env.merge(REQUEST_PATH => "#{env[REQUEST_PATH]}.json",
+                    REQUEST_QUERY => query), app)
   end
 
   def generate_auth opts={}

data/rest-firebase.gemspec

@@ -1,16 +1,16 @@
 # -*- encoding: utf-8 -*-
-# stub: rest-firebase 0.9.5 ruby lib
+# stub: rest-firebase 1.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rest-firebase"
-  s.version = "0.9.5"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = [
   "Codementor",
   "Lin Jen-Shin (godfat)"]
-  s.date = "2014-11-07"
+  s.date = "2014-12-09"
   s.description = "Ruby Firebase REST API client built on top of [rest-core][].\n\n[rest-core]: https://github.com/godfat/rest-core"
   s.email = ["help@codementor.io"]
   s.files = [
@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
   "test/test_api.rb"]
   s.homepage = "https://github.com/CodementorIO/rest-firebase"
   s.licenses = ["Apache License 2.0"]
-  s.rubygems_version = "2.4.2"
+  s.rubygems_version = "2.4.5"
   s.summary = "Ruby Firebase REST API client built on top of [rest-core][]."
   s.test_files = ["test/test_api.rb"]
 
@@ -39,11 +39,11 @@ Gem::Specification.new do |s|
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rest-core>, [">= 3.3.0"])
+      s.add_runtime_dependency(%q<rest-core>, [">= 3.5.0"])
     else
-      s.add_dependency(%q<rest-core>, [">= 3.3.0"])
+      s.add_dependency(%q<rest-core>, [">= 3.5.0"])
     end
   else
-    s.add_dependency(%q<rest-core>, [">= 3.3.0"])
+    s.add_dependency(%q<rest-core>, [">= 3.5.0"])
   end
 end

data/task/gemgem.rb

@@ -38,6 +38,99 @@ module Gemgem
     self.spec = spec
   end
 
+  def gem_install
+    require 'rubygems/commands/install_command'
+    # read ~/.gemrc
+    Gem.use_paths(Gem.configuration[:gemhome], Gem.configuration[:gempath])
+    Gem::Command.extra_args = Gem.configuration[:gem]
+
+    # setup install options
+    cmd = Gem::Commands::InstallCommand.new
+    cmd.handle_options([])
+
+    # install
+    install = Gem::Installer.new(gem_path, cmd.options)
+    install.install
+    puts "\e[35mGem installed: \e[33m#{strip_path(install.gem_dir)}\e[0m"
+  end
+
+  def gem_spec
+    create
+    write
+  end
+
+  def gem_build
+    require 'fileutils'
+    require 'rubygems/package'
+    gem = nil
+    Dir.chdir(dir) do
+      gem = Gem::Package.build(Gem::Specification.load(spec_path))
+      FileUtils.mkdir_p(pkg_dir)
+      FileUtils.mv(gem, pkg_dir) # gem is relative path, but might be ok
+    end
+    puts "\e[35mGem built: \e[33m#{strip_path("#{pkg_dir}/#{gem}")}\e[0m"
+  end
+
+  def gem_release
+    sh_git('tag', gem_tag)
+    sh_git('push')
+    sh_git('push', '--tags')
+    sh_gem('push', gem_path)
+  end
+
+  def gem_check
+    ver = spec.version.to_s
+
+    if ENV['VERSION'].nil?
+      puts("\e[35mExpected "                                  \
+           "\e[33mVERSION\e[35m=\e[33m#{ver}\e[0m")
+      exit(1)
+
+    elsif ENV['VERSION'] != ver
+      puts("\e[35mExpected \e[33mVERSION\e[35m=\e[33m#{ver} " \
+           "\e[35mbut got\n         "                         \
+           "\e[33mVERSION\e[35m=\e[33m#{ENV['VERSION']}\e[0m")
+      exit(2)
+    end
+  end
+
+  def test
+    return if test_files.empty?
+
+    if ENV['COV'] || ENV['CI']
+      require 'simplecov'
+      if ENV['CI']
+        require 'coveralls'
+        SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+      end
+      SimpleCov.start do
+        add_filter('test/')
+        add_filter('test.rb')
+      end
+    end
+
+    test_files.each{ |file| require "#{dir}/#{file[0..-4]}" }
+  end
+
+  def clean
+    return if ignored_files.empty?
+
+    require 'fileutils'
+    trash = File.expand_path("~/.Trash/#{spec.name}")
+    puts "Move the following files into: \e[35m#{strip_path(trash)}\e[33m"
+
+    ignored_files.each do |file|
+      from = "#{dir}/#{file}"
+      to   = "#{trash}/#{File.dirname(file)}"
+      puts strip_path(from)
+
+      FileUtils.mkdir_p(to)
+      FileUtils.mv(from, to)
+    end
+
+    print "\e[0m"
+  end
+
   def write
     File.open(spec_path, 'w'){ |f| f << split_lines(spec.to_ruby) }
   end
@@ -173,82 +266,38 @@ namespace :gem do
 
 desc 'Install gem'
 task :install => [:build] do
-  Gemgem.sh_gem('install', Gemgem.gem_path)
+  Gemgem.gem_install
 end
 
 desc 'Build gem'
 task :build => [:spec] do
-  require 'fileutils'
-  require 'rubygems/package'
-  gem = nil
-  Dir.chdir(Gemgem.dir) do
-    gem = Gem::Package.build(Gem::Specification.load(Gemgem.spec_path))
-    FileUtils.mkdir_p(Gemgem.pkg_dir)
-    FileUtils.mv(gem, Gemgem.pkg_dir) # gem is relative path, but might be ok
-  end
-  puts "\e[35mGem built: \e[33m" \
-       "#{Gemgem.strip_path("#{Gemgem.pkg_dir}/#{gem}")}\e[0m"
+  Gemgem.gem_build
 end
 
 desc 'Generate gemspec'
 task :spec do
-  Gemgem.create
-  Gemgem.write
+  Gemgem.gem_spec
 end
 
 desc 'Release gem'
 task :release => [:spec, :check, :build] do
-  Gemgem.module_eval do
-    sh_git('tag', Gemgem.gem_tag)
-    sh_git('push')
-    sh_git('push', '--tags')
-    sh_gem('push', Gemgem.gem_path)
-  end
+  Gemgem.gem_release
 end
 
 task :check do
-  ver = Gemgem.spec.version.to_s
-
-  if ENV['VERSION'].nil?
-    puts("\e[35mExpected "                                  \
-         "\e[33mVERSION\e[35m=\e[33m#{ver}\e[0m")
-    exit(1)
-
-  elsif ENV['VERSION'] != ver
-    puts("\e[35mExpected \e[33mVERSION\e[35m=\e[33m#{ver} " \
-         "\e[35mbut got\n         "                         \
-         "\e[33mVERSION\e[35m=\e[33m#{ENV['VERSION']}\e[0m")
-    exit(2)
-  end
+  Gemgem.gem_check
 end
 
 end # of gem namespace
 
 desc 'Run tests'
 task :test do
-  next if Gemgem.test_files.empty?
-  Gemgem.test_files.each{ |file| require "#{Gemgem.dir}/#{file[0..-4]}" }
+  Gemgem.test
 end
 
 desc 'Trash ignored files'
 task :clean => ['gem:spec'] do
-  next if Gemgem.ignored_files.empty?
-
-  require 'fileutils'
-  trash = File.expand_path("~/.Trash/#{Gemgem.spec.name}")
-  puts "Move the following files into:" \
-       " \e[35m#{Gemgem.strip_path(trash)}\e[33m"
-
-  Gemgem.ignored_files.each do |file|
-    from = "#{Gemgem.dir}/#{file}"
-    to   = "#{trash}/#{File.dirname(file)}"
-    puts Gemgem.strip_path(from)
-
-    FileUtils.mkdir_p(to)
-    FileUtils.mv(from, to)
-  end
-
-  print "\e[0m"
+  Gemgem.clean
 end
 
 task :default do

data/test/test_api.rb

@@ -26,6 +26,13 @@ Pork::API.describe RestFirebase do
     firebase.get('https://a').should.eq true
   end
 
+  would 'get with query' do
+    stub_request(:get, "#{path}&orderBy=%22date%22&limitToFirst=1").
+      to_return(:body => json)
+    firebase.get('https://a', :orderBy => 'date', :limitToFirst => 1).
+      should.eq rbon
+  end
+
   would 'put {"status":"ok"}' do
     stub_request(:put, path).with(:body => json).to_return(:body => json)
     firebase.put('https://a', rbon).should.eq rbon

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rest-firebase
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Codementor
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-07 00:00:00.000000000 Z
+date: 2014-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-core
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.5.0
 description: |-
   Ruby Firebase REST API client built on top of [rest-core][].
 
@@ -70,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Ruby Firebase REST API client built on top of [rest-core][].