firebase 0.1.6 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4695f53c5178de66b3d6e41ea5a3a0c5779099cf
+  data.tar.gz: 2e56f83b67bddea9e40470ba74a01467dbd608ed
+SHA512:
+  metadata.gz: ea1883f4e4ba205ac2b81c40a3b576925e9dd2df3d68ee8d3dd25e4f8a043af5ccebb2b158faed2aa2e887935dbfde3b404dd9778a5e90dd28758342e4cc852c
+  data.tar.gz: c456f212241036b86703388137e0b0e153d7f611a41a0b1157fc3ba3a4226f9e1dd3be5a220661bacd410c3c9ebe57df54b0ea45cfaea342c17f580182d912af

data/CHANGELOG

@@ -1,3 +1,8 @@
-- UNRELEASED
+- 0.2.0
+
+* You can now pass query options to get/push/set, etc.
+* The old syntax no longer works. You now need to create instance variables of Firebase::Client.new(...)
+
+- 0.1.6
 
 * You can now create instances of Firebase. The old syntax still works but will be removed in version 0,2. - @wannabefro

data/Gemfile.lock

@@ -46,7 +46,7 @@ GEM
       multi_xml (~> 0.5)
       rack (~> 1.2)
     rack (1.5.2)
-    rake (10.1.0)
+    rake (10.1.1)
     rdoc (4.0.1)
       json (~> 1.4)
     rspec (2.14.1)

data/README.md

@@ -17,7 +17,7 @@ gem install firebase
 ```ruby
 base_uri = 'https://<your-firebase>.firebaseio.com/'
 
-firebase = Firebase.new(base_uri)
+firebase = Firebase::Client.new(base_uri)
 
 response = firebase.push("todos", { :name => 'Pick the milk', :priority => 1 })
 response.success? # => true
@@ -28,22 +28,26 @@ response.raw_body # => '{"name":"-INOQPH-aV_psbk3ZXEX"}'
 
 If you have a read-only namespace, set your secret key as follows:
 ```ruby
-firebase = Firebase.new(base_uri, secret_key)
+firebase = Firebase::Client.new(base_uri, secret_key)
 
 response = firebase.push("todos", { :name => 'Pick the milk', :priority => 1 })
 ```
 
-So far, supported methods are:
+You can now pass custom query options to firebase:
 
 ```ruby
-set(path, data)
-get(path)
-push(path, data)
-delete(path)
-update(path, data)
+response = firebase.push("todos", :limit => 1)
 ```
 
-More features are coming soon.
+So far, supported methods are:
+
+```ruby
+set(path, data, query_options)
+get(path, query_options)
+push(path, data, query_options)
+delete(path, query_options)
+update(path, data, query_options)
+```
 
 More information about Firebase and the Firebase API is available at the
 [official website](http://www.firebase.com/).

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.2.0

data/firebase.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "firebase"
-  s.version = "0.1.6"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Oscar Del Ben"]
-  s.date = "2013-11-23"
+  s.date = "2014-03-16"
   s.description = "Firebase wrapper for Ruby"
   s.email = "info@oscardelben.com"
   s.extra_rdoc_files = [
@@ -37,11 +37,11 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/oscardelben/firebase-ruby"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.23"
+  s.rubygems_version = "2.0.3"
   s.summary = "Firebase wrapper for Ruby"
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<typhoeus>, [">= 0.6.1"])

data/lib/firebase.rb

@@ -1,95 +1,56 @@
-class Firebase
+module Firebase
+  class Client
 
-  require 'firebase/request'
-  require 'firebase/response'
+    require 'firebase/request'
+    require 'firebase/response'
 
-  class << self
-
-    def format_uri(other)
+    def self.format_uri(other)
       if other
         other.end_with?("/") ? other : other + '/'
       end
     end
 
-    def base_uri=(other)
-      deprecate
-      default_instance.request.base_uri = format_uri(other)
-    end
+    attr_reader :auth, :request
 
-    def auth=(auth)
-      deprecate
-      default_instance.request.auth = auth
+    def initialize(base_uri, auth=nil)
+      uri = Firebase::Client.format_uri(base_uri)
+      @request = Firebase::Request.new(uri)
+      @auth = auth
     end
 
-    def set(path, data)
-      deprecate
-      default_instance.set(path, data)
+    # 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))
     end
 
-    def get(path)
-      deprecate
-      default_instance.get(path)
+    # Returns the data at path
+    def get(path, query={})
+      request.get(path, query_options(query))
     end
 
-    def push(path, data)
-      deprecate
-      default_instance.push(path, data)
+    # 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))
     end
 
-    def delete(path)
-      deprecate
-      default_instance.delete(path)
+    # Deletes the data at path and returs true
+    def delete(path, query={})
+      request.delete(path, query_options(query))
     end
 
-    def update(path, data)
-      deprecate
-      default_instance.patch(path, data)
+    # 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))
     end
 
-    def default_instance
-      @default_instance ||= Firebase.new(nil, nil)
-    end
+    private
 
-    def deprecate
-      puts "[FIREBASE] This syntax has been deprecated. Please upgrade to the new Firebase.new(...).method syntax"
+    def query_options(query)
+      { :auth => auth }.merge(query)
     end
-
-  end
-
-  attr_accessor :request
-
-  def initialize(base_uri, auth=nil)
-    uri = Firebase.format_uri(base_uri)
-    @request = Firebase::Request.new(uri, auth)
-  end
-
-    # Writes and returns the data
-    #   Firebase.set('users/info', { 'name' => 'Oscar' }) => { 'name' => 'Oscar' }
-  def set(path, data)
-    request.put(path, data)
-  end
-
-  # Returns the data at path
-  def get(path)
-    request.get(path)
-  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)
-    request.post(path, data)
   end
-
-  # Deletes the data at path and returs true
-  def delete(path)
-    request.delete(path)
-  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)
-    request.patch(path, data)
-  end
-
 end
 

data/lib/firebase/request.rb

@@ -3,51 +3,50 @@ require 'json'
 require 'open-uri'
 require 'uri'
 
-class Firebase
+module Firebase
   class Request
 
-    attr_accessor :base_uri, :auth
+    attr_reader :base_uri
 
-    def initialize(base_uri, auth=nil)
+    def initialize(base_uri)
       @base_uri = base_uri
-      @auth = auth
     end
 
-    def get(path)
-      process(:get, path)
+    def get(path, query_options)
+      process(:get, path, nil, query_options)
     end
 
-    def put(path, value)
-      process(:put, path, :body => value.to_json)
+    def put(path, value, query_options)
+      process(:put, path, value.to_json, query_options)
     end
 
-    def post(path, value)
-      process(:post, path, :body => value.to_json)
+    def post(path, value, query_options)
+      process(:post, path, value.to_json, query_options)
     end
 
-    def delete(path)
-      process(:delete, path)
+    def delete(path, query_options)
+      process(:delete, path, nil, query_options)
     end
 
-    def patch(path, value)
-      process(:patch, path, :body => value.to_json)
+    def patch(path, value, query_options)
+      process(:patch, path, value.to_json, query_options)
     end
 
     def build_url(path)
       path = "#{path}.json"
-      query_string = auth ? "?auth=#{auth}" : ""
-      url = URI.join(base_uri, path, query_string)
+      url = URI.join(base_uri, path)
 
       url.to_s
     end
 
     private
 
-    def process(method, path, options={})
+    def process(method, path, body=nil, query_options={})
       @@hydra ||= Typhoeus::Hydra.new
       request = Typhoeus::Request.new(build_url(path),
-                                      :body => options[:body],
-                                      :method => method)
+                                      :body => body,
+                                      :method => method,
+                                      :params => query_options)
       @@hydra.queue(request)
       @@hydra.run
 

data/lib/firebase/response.rb

@@ -1,4 +1,4 @@
-class Firebase
+module Firebase
   class Response
 
     attr_accessor :response

data/spec/firebase_request_spec.rb

@@ -17,12 +17,4 @@ describe "Firebase Request" do
       @req.build_url('users/eugene').should == 'https://test.firebaseio.com/users/eugene.json'
     end
   end
-
-  describe 'auth' do
-    it "should include a auth in the query string, if configured" do
-      req = Firebase::Request.new('https://test.firebaseio.com', 'secretkey')
-
-      req.build_url('users/eugene').should == 'https://test.firebaseio.com/users/eugene.json?auth=secretkey'
-    end
-  end
 end

data/spec/firebase_spec.rb

@@ -7,20 +7,20 @@ describe "Firebase" do
   end
 
   before do
-    @firebase = Firebase.new('https://test.firebaseio.com')
+    @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)
+      @req.should_receive(:put).with('users/info', data, {:auth => nil})
       @firebase.set('users/info', data)
     end
   end
 
   describe "get" do
     it "returns the data" do
-      @req.should_receive(:get).with('users/info')
+      @req.should_receive(:get).with('users/info', {:auth => nil})
       @firebase.get('users/info')
     end
 
@@ -51,22 +51,30 @@ describe "Firebase" do
 
   describe "push" do
     it "writes the data" do
-      @req.should_receive(:post).with('users', data)
+      @req.should_receive(:post).with('users', data, {:auth => nil})
       @firebase.push('users', data)
     end
   end
 
   describe "delete" do
     it "returns true" do
-      @req.should_receive(:delete).with('users/info')
+      @req.should_receive(:delete).with('users/info', {:auth => nil})
       @firebase.delete('users/info')
     end
   end
 
   describe "update" do
     it "updates and returns the data" do
-      @req.should_receive(:patch).with('users/info', data)
+      @req.should_receive(:patch).with('users/info', data, {:auth => nil})
       @firebase.update('users/info', data)
     end
   end
+
+  describe "options" do
+    it "passes custom options" do
+      firebase = Firebase::Client.new('https://test.firebaseio.com', 'secret')
+      firebase.request.should_receive(:get).with('todos', {:auth => 'secret', :foo => 'bar'})
+      firebase.get('todos', :foo => 'bar')
+    end
+  end
 end

metadata

@@ -1,80 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: firebase
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Oscar Del Ben
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-23 00:00:00.000000000 Z
+date: 2014-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.6.1
-    none: false
-  prerelease: false
-  name: typhoeus
   type: :runtime
-  requirement: !ruby/object:Gem::Requirement
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.6.1
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: json
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  prerelease: false
-  name: json
   type: :runtime
-  requirement: !ruby/object:Gem::Requirement
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  prerelease: false
-  name: rspec
   type: :development
-  requirement: !ruby/object:Gem::Requirement
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.3
-    none: false
-  prerelease: false
-  name: jeweler
   type: :development
-  requirement: !ruby/object:Gem::Requirement
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.3
-    none: false
 description: Firebase wrapper for Ruby
 email: info@oscardelben.com
 executables: []
@@ -102,29 +93,25 @@ files:
 homepage: http://github.com/oscardelben/firebase-ruby
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
-      segments:
-      - 0
-      hash: -3647962587689699515
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Firebase wrapper for Ruby
 test_files: []