firebase 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0d272b8076db9628a215cc2643851b1c903792f
-  data.tar.gz: 02f854d3a3a9de3aa92a26819e8f6769cf9ceb0b
+  metadata.gz: 7f4d0e635f2b61323e742ed14dffca10ef4507ea
+  data.tar.gz: feb3f0741ff08578e52d78f5396012c0b0f4ab76
 SHA512:
-  metadata.gz: 6c98bd290872e0db6015f58f3f70ae8b9e552b666177823d33fe363a3c3b40c9b6d9c7f5a7b6467c46ccc2fc75a68e7ab55b11f861ed822a644c73df43efdda5
-  data.tar.gz: 753b7d2324f190d48adda9f8169e9bb4dd0bdf69bcfb0e9769abfff559cb11327903f32a7693794f51cf76e9038f8af167d4136d61994c999972f6dd535fb862
+  metadata.gz: b7330bf19b01c9631ca5c181248907a5f4fa8faafe1db2ce85f23eb5c63b5317b41f13a4eca104c58fd8c96534ff5014dc3b86dfa53e45aa0c7fbe86950f382e
+  data.tar.gz: e30401898c34f104c7c4a4b6257f96eb4a6e0e090c64b7488e0eb02f3df2241061d30d73607d7fa4dfdd7b9fc4faa57d28f5e661f301c0a83f84790cbaaa4056

data/README.md

@@ -7,12 +7,12 @@ update your clients **in realtime from the backend**.
 
 See a [video demo](https://vimeo.com/41494336?utm_source=internal&utm_medium=email&utm_content=cliptranscoded&utm_campaign=adminclip) of what's possible.
 
-### Installation
+## Installation
 
 ```
 gem install firebase
 ```
-### Usage
+## Usage
 
 ```ruby
 base_uri = 'https://<your-firebase>.firebaseio.com/'
@@ -58,10 +58,23 @@ delete(path, query_options)
 update(path, data, query_options)
 ```
 
+### Configuring HTTP options
+
+[httpclient](https://github.com/nahi/httpclient) is used under the covers to make HTTP requests.
+You may find yourself wanting to tweak the timeout settings. By default, `httpclient` uses
+some [sane defaults](https://github.com/nahi/httpclient/blob/dd322d39d4d11c48f7bbbc05ed6273ac912d3e3b/lib/httpclient/session.rb#L138),
+but it is quite easy to change them by modifying the `request` object directly:
+
+```ruby
+firebase = Firebase::Client.new(base_uri)
+# firebase.request is a regular httpclient object
+firebase.request.connect_timeout = 30
+```
+
 More information about Firebase and the Firebase API is available at the
 [official website](http://www.firebase.com/).
 
-### Copyright
+## Copyright
 
 Copyright (c) 2013 Oscar Del Ben. See LICENSE.txt for
 further details.

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.2.5

data/firebase.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: firebase 0.2.4 ruby lib
+# stub: firebase 0.2.5 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "firebase"
-  s.version = "0.2.4"
+  s.version = "0.2.5"
 
   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-05-24"
+  s.date = "2015-11-18"
   s.description = "Firebase wrapper for Ruby"
   s.email = "info@oscardelben.com"
   s.extra_rdoc_files = [
@@ -31,7 +31,6 @@ Gem::Specification.new do |s|
     "VERSION",
     "firebase.gemspec",
     "lib/firebase.rb",
-    "lib/firebase/request.rb",
     "lib/firebase/response.rb",
     "lib/firebase/server_value.rb",
     "spec/firebase_spec.rb",

data/lib/firebase.rb

@@ -1,7 +1,8 @@
-require 'uri'
-require 'firebase/request'
 require 'firebase/response'
 require 'firebase/server_value'
+require 'httpclient'
+require 'json'
+require 'uri'
 
 module Firebase
   class Client
@@ -12,47 +13,51 @@ module Firebase
         raise ArgumentError.new('base_uri must be a valid https uri')
       end
       base_uri += '/' unless base_uri.end_with?('/')
-      @request = Firebase::Request.new(base_uri)
+      @request = HTTPClient.new({
+        :base_url => base_uri,
+        :default_header => {
+          'Content-Type' => 'application/json'
+        }
+      })
       @auth = auth
     end
 
     # Writes and returns the data
     #   Firebase.set('users/info', { 'name' => 'Oscar' }) => { 'name' => 'Oscar' }
     def set(path, data, query={})
-      request.put(path, data, query_options(query))
+      process :put, path, data, query
     end
 
     # Returns the data at path
     def get(path, query={})
-      request.get(path, query_options(query))
+      process :get, path, query
     end
 
     # Writes the data, returns the key name of the data added
     #   Firebase.push('users', { 'age' => 18}) => {"name":"-INOQPH-aV_psbk3ZXEX"}
     def push(path, data, query={})
-      request.post(path, data, query_options(query))
+      process :post, path, data, query
     end
 
     # Deletes the data at path and returs true
     def delete(path, query={})
-      request.delete(path, query_options(query))
+      process :delete, path, query
     end
 
     # Write the data at path but does not delete ommited children. Returns the data
     #   Firebase.update('users/info', { 'name' => 'Oscar' }) => { 'name' => 'Oscar' }
     def update(path, data, query={})
-      request.patch(path, data, query_options(query))
+      process :patch, path, data, query
     end
 
     private
 
-    def query_options(query)
-      if auth
-        { :auth => auth }.merge(query)
-      else
-        query
-      end
+    def process(verb, path, data=nil, query={})
+      Firebase::Response.new @request.request(verb, "#{path}.json", {
+        :body             => (data && data.to_json),
+        :query            => (auth ? { :auth => auth }.merge(query) : query),
+        :follow_redirect  => true
+      })
     end
   end
 end
-

data/spec/firebase_spec.rb

@@ -17,19 +17,18 @@ describe "Firebase" do
 
   before do
     @firebase = Firebase::Client.new('https://test.firebaseio.com')
-    @req = @firebase.request
   end
 
   describe "set" do
     it "writes and returns the data" do
-      @req.should_receive(:put).with('users/info', data, {})
+      @firebase.should_receive(:process).with(:put, 'users/info', data, {})
       @firebase.set('users/info', data)
     end
   end
 
   describe "get" do
     it "returns the data" do
-      @req.should_receive(:get).with('users/info', {})
+      @firebase.should_receive(:process).with(:get, 'users/info', {})
       @firebase.get('users/info')
     end
 
@@ -60,29 +59,33 @@ describe "Firebase" do
 
   describe "push" do
     it "writes the data" do
-      @req.should_receive(:post).with('users', data, {})
+      @firebase.should_receive(:process).with(:post, 'users', data, {})
       @firebase.push('users', data)
     end
   end
 
   describe "delete" do
     it "returns true" do
-      @req.should_receive(:delete).with('users/info', {})
+      @firebase.should_receive(:process).with(:delete, 'users/info', {})
       @firebase.delete('users/info')
     end
   end
 
   describe "update" do
     it "updates and returns the data" do
-      @req.should_receive(:patch).with('users/info', data, {})
+      @firebase.should_receive(:process).with(:patch, 'users/info', data, {})
       @firebase.update('users/info', data)
     end
   end
 
-  describe "options" do
-    it "passes custom options" do
+  describe "http processing" do
+    it "sends custom auth" do
       firebase = Firebase::Client.new('https://test.firebaseio.com', 'secret')
-      firebase.request.should_receive(:get).with('todos', {:auth => 'secret', :foo => 'bar'})
+      firebase.request.should_receive(:request).with(:get, "todos.json", {
+        :body => {:foo => 'bar'}.to_json,
+        :query => {:auth => "secret"},
+        :follow_redirect => true
+      })
       firebase.get('todos', :foo => 'bar')
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firebase
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Oscar Del Ben
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-24 00:00:00.000000000 Z
+date: 2015-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -86,7 +86,6 @@ files:
 - VERSION
 - firebase.gemspec
 - lib/firebase.rb
-- lib/firebase/request.rb
 - lib/firebase/response.rb
 - lib/firebase/server_value.rb
 - spec/firebase_spec.rb

data/lib/firebase/request.rb

@@ -1,38 +0,0 @@
-require 'httpclient'
-require 'json'
-
-module Firebase
-  class Request
-    def initialize(base_uri)
-      @client = HTTPClient.new(base_url: base_uri)
-      @client.default_header['Content-Type'] = 'application/json'
-    end
-
-    def get(path, query_options)
-      process(:get, path, nil, query_options)
-    end
-
-    def put(path, value, query_options)
-      process(:put, path, value.to_json, query_options)
-    end
-
-    def post(path, value, query_options)
-      process(:post, path, value.to_json, query_options)
-    end
-
-    def delete(path, query_options)
-      process(:delete, path, nil, query_options)
-    end
-
-    def patch(path, value, query_options)
-      process(:patch, path, value.to_json, query_options)
-    end
-
-    private
-
-    def process(method, path, body=nil, query_options={})
-      response = @client.request(method, "#{path}.json", body: body, query: query_options, follow_redirect: true)
-      Firebase::Response.new(response)
-    end
-  end
-end