firebase 0.1.5 → 0.1.6

data/CHANGELOG

@@ -0,0 +1,3 @@
+- UNRELEASED
+
+* You can now create instances of Firebase. The old syntax still works but will be removed in version 0,2. - @wannabefro

data/Gemfile.lock

@@ -1,32 +1,64 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.1.3)
-    ethon (0.5.9)
-      ffi (~> 1.2.0)
+    addressable (2.3.5)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    ethon (0.6.1)
+      ffi (>= 1.3.0)
       mime-types (~> 1.18)
-    ffi (1.2.1)
-    git (1.2.5)
-    jeweler (1.8.3)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    ffi (1.9.3)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.20)
+    httpauth (0.2.0)
+    jeweler (1.8.8)
+      builder
       bundler (~> 1.0)
       git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
       rake
       rdoc
-    json (1.7.0)
-    mime-types (1.21)
-    rake (0.9.2.2)
-    rdoc (3.12)
+    json (1.8.1)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    mime-types (1.25)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (4.0.1)
       json (~> 1.4)
-    rspec (2.9.0)
-      rspec-core (~> 2.9.0)
-      rspec-expectations (~> 2.9.0)
-      rspec-mocks (~> 2.9.0)
-    rspec-core (2.9.0)
-    rspec-expectations (2.9.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.9.0)
-    typhoeus (0.6.1)
-      ethon (~> 0.5.9)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    typhoeus (0.6.6)
+      ethon (~> 0.6.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -9,18 +9,17 @@ See a [video demo](https://vimeo.com/41494336?utm_source=internal&utm_medium=ema
 
 ### Installation
 
-
 ```
 gem install firebase
 ```
-
 ### Usage
 
-
 ```ruby
-Firebase.base_uri = 'https://<your-firebase>.firebaseio.com/'
+base_uri = 'https://<your-firebase>.firebaseio.com/'
 
-response = Firebase.push("todos", { :name => 'Pick the milk', :priority => 1 })
+firebase = Firebase.new(base_uri)
+
+response = firebase.push("todos", { :name => 'Pick the milk', :priority => 1 })
 response.success? # => true
 response.code # => 200
 response.body # => { 'name' => "-INOQPH-aV_psbk3ZXEX" }
@@ -29,20 +28,19 @@ response.raw_body # => '{"name":"-INOQPH-aV_psbk3ZXEX"}'
 
 If you have a read-only namespace, set your secret key as follows:
 ```ruby
-Firebase.base_uri = 'https://<your-firebase>.firebaseio.com/'
-Firebase.auth = 'yoursecretkey'
+firebase = Firebase.new(base_uri, secret_key)
 
-response = Firebase.push("todos", { :name => 'Pick the milk', :priority => 1 })
+response = firebase.push("todos", { :name => 'Pick the milk', :priority => 1 })
 ```
 
-
 So far, supported methods are:
 
 ```ruby
-Firebase.set(path, data)
-Firebase.get(path)
-Firebase.push(path, data)
-Firebase.delete(path)
+set(path, data)
+get(path)
+push(path, data)
+delete(path)
+update(path, data)
 ```
 
 More features are coming soon.
@@ -52,6 +50,6 @@ More information about Firebase and the Firebase API is available at the
 
 ### Copyright
 
-Copyright (c) 2012 Oscar Del Ben. See LICENSE.txt for
+Copyright (c) 2013 Oscar Del Ben. See LICENSE.txt for
 further details.
 

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.1.6

data/firebase.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "firebase"
-  s.version = "0.1.5"
+  s.version = "0.1.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Oscar Del Ben"]
-  s.date = "2013-11-10"
+  s.date = "2013-11-23"
   s.description = "Firebase wrapper for Ruby"
   s.email = "info@oscardelben.com"
   s.extra_rdoc_files = [
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".rspec",
+    "CHANGELOG",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -28,6 +29,7 @@ Gem::Specification.new do |s|
     "firebase.gemspec",
     "lib/firebase.rb",
     "lib/firebase/request.rb",
+    "lib/firebase/response.rb",
     "spec/firebase_request_spec.rb",
     "spec/firebase_spec.rb",
     "spec/spec_helper.rb"

data/lib/firebase.rb

@@ -1,49 +1,95 @@
+class Firebase
 
-module Firebase
-
-  autoload :Request, 'firebase/request'
+  require 'firebase/request'
+  require 'firebase/response'
 
   class << self
-    attr_accessor :base_uri, :auth
 
-    def base_uri=(other)
-      if other # Guard from nil
-        other = other + "/" if other[-1] != "/"
+    def format_uri(other)
+      if other
+        other.end_with?("/") ? other : other + '/'
       end
-      @base_uri = other
+    end
+
+    def base_uri=(other)
+      deprecate
+      default_instance.request.base_uri = format_uri(other)
     end
 
     def auth=(auth)
-      @auth = auth
+      deprecate
+      default_instance.request.auth = auth
     end
 
-    # Writes and returns the data
-    #   Firebase.set('users/info', { 'name' => 'Oscar' }) => { 'name' => 'Oscar' }
     def set(path, data)
-      Firebase::Request.put(path, data)
+      deprecate
+      default_instance.set(path, data)
     end
 
-    # Returns the data at path
     def get(path)
-      Firebase::Request.get(path)
+      deprecate
+      default_instance.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)
-      Firebase::Request.post(path, data)
+      deprecate
+      default_instance.push(path, data)
     end
 
-    # Deletes the data at path and returs true
     def delete(path)
-      Firebase::Request.delete(path)
+      deprecate
+      default_instance.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)
-      Firebase::Request.patch(path, data)
+      deprecate
+      default_instance.patch(path, data)
     end
 
+    def default_instance
+      @default_instance ||= Firebase.new(nil, nil)
+    end
+
+    def deprecate
+      puts "[FIREBASE] This syntax has been deprecated. Please upgrade to the new Firebase.new(...).method syntax"
+    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,80 +3,55 @@ require 'json'
 require 'open-uri'
 require 'uri'
 
-module Firebase
+class Firebase
   class Request
 
-    class << self
-
-      def get(path)
-        process(:get, path)
-      end
-
-      def put(path, value)
-        process(:put, path, :body => value.to_json)
-      end
-
-      def post(path, value)
-        process(:post, path, :body => value.to_json)
-      end
-
-      def delete(path)
-        process(:delete, path)
-      end
-
-      def patch(path, value)
-        process(:patch, path, :body => value.to_json)
-      end
-
-      def build_url(path)
-        host = Firebase.base_uri
-        path = "#{path}.json"
-        query_string = Firebase.auth ? "?auth=#{Firebase.auth}" : ""
-        url = URI.join(Firebase.base_uri, path, query_string)
-
-        url.to_s
-      end
-
-      private
-
-      def process(method, path, options={})
-        raise "Please set Firebase.base_uri before making requests" unless Firebase.base_uri
-
-	      @@hydra ||= Typhoeus::Hydra.new
-        request = Typhoeus::Request.new(build_url(path),
-                                        :body => options[:body],
-                                        :method => method)
-        @@hydra.queue(request)
-        @@hydra.run
-
-        new request.response
-      end
+    attr_accessor :base_uri, :auth
 
+    def initialize(base_uri, auth=nil)
+      @base_uri = base_uri
+      @auth = auth
     end
 
-    attr_accessor :response
+    def get(path)
+      process(:get, path)
+    end
 
-    def initialize(response)
-      @response = response
+    def put(path, value)
+      process(:put, path, :body => value.to_json)
     end
 
-    def body
-      JSON.parse(response.body, :quirks_mode => true)
-    rescue JSON::ParserError => e
-      response.body == 'null' ? nil : raise
+    def post(path, value)
+      process(:post, path, :body => value.to_json)
     end
 
-    def raw_body
-      response.body
+    def delete(path)
+      process(:delete, path)
     end
 
-    def success?
-      [200, 204].include? response.code
+    def patch(path, value)
+      process(:patch, path, :body => value.to_json)
     end
 
-    def code
-      response.code
+    def build_url(path)
+      path = "#{path}.json"
+      query_string = auth ? "?auth=#{auth}" : ""
+      url = URI.join(base_uri, path, query_string)
+
+      url.to_s
     end
 
+    private
+
+    def process(method, path, options={})
+      @@hydra ||= Typhoeus::Hydra.new
+      request = Typhoeus::Request.new(build_url(path),
+                                      :body => options[:body],
+                                      :method => method)
+      @@hydra.queue(request)
+      @@hydra.run
+
+      Firebase::Response.new(request.response)
+    end
   end
 end

data/lib/firebase/response.rb

@@ -0,0 +1,28 @@
+class Firebase
+  class Response
+
+    attr_accessor :response
+
+    def initialize(response)
+      @response = response
+    end
+
+    def body
+      JSON.parse(response.body, :quirks_mode => true)
+    rescue JSON::ParserError => e
+      response.body == 'null' ? nil : raise
+    end
+
+    def raw_body
+      response.body
+    end
+
+    def success?
+      [200, 204].include? response.code
+    end
+
+    def code
+      response.code
+    end
+  end
+end

data/spec/firebase_request_spec.rb

@@ -2,31 +2,27 @@ require 'spec_helper'
 
 describe "Firebase Request" do
 
-  after do
-    Firebase.base_uri = nil
-  end
-
   describe "url_builder" do
+    before do
+      @req = req = Firebase::Request.new 'https://test.firebaseio.com'
+    end
+
     it "should build the correct url when passed no path" do
-      Firebase.base_uri = 'https://test.firebaseio.com'
-      Firebase::Request.build_url(nil).should == 'https://test.firebaseio.com/.json'
+      @req.build_url(nil).should == 'https://test.firebaseio.com/.json'
     end
-  end
 
-  describe "url_builder" do
     it "should build the correct url when passed a path" do
-      Firebase.base_uri = 'https://test.firebaseio.com'
+      req = Firebase::Request.new 'https://test.firebaseio.com'
 
-      Firebase::Request.build_url('users/eugene').should == 'https://test.firebaseio.com/users/eugene.json'
+      @req.build_url('users/eugene').should == 'https://test.firebaseio.com/users/eugene.json'
     end
   end
 
-  describe "url_builder" do
+  describe 'auth' do
     it "should include a auth in the query string, if configured" do
-      Firebase.base_uri = 'https://test.firebaseio.com'
-      Firebase.auth = 'secretkey'
+      req = Firebase::Request.new('https://test.firebaseio.com', 'secretkey')
 
-      Firebase::Request.build_url('users/eugene').should == 'https://test.firebaseio.com/users/eugene.json?auth=secretkey'
+      req.build_url('users/eugene').should == 'https://test.firebaseio.com/users/eugene.json?auth=secretkey'
     end
   end
 end

data/spec/firebase_spec.rb

@@ -2,73 +2,71 @@ require 'spec_helper'
 
 describe "Firebase" do
 
-  it 'should have a base_uri attribute' do
-    Firebase.base_uri.should be_nil
-    Firebase.base_uri = 'http://example.com/foo'
-    Firebase.base_uri.should == 'http://example.com/foo/'
-  end
-
   let (:data) do
     { 'name' => 'Oscar' }
   end
 
+  before do
+    @firebase = Firebase.new('https://test.firebaseio.com')
+    @req = @firebase.request
+  end
+
   describe "set" do
     it "writes and returns the data" do
-      Firebase::Request.should_receive(:put).with('users/info', data)
-      Firebase.set('users/info', data)
+      @req.should_receive(:put).with('users/info', data)
+      @firebase.set('users/info', data)
     end
   end
 
   describe "get" do
     it "returns the data" do
-      Firebase::Request.should_receive(:get).with('users/info')
-      Firebase.get('users/info')
+      @req.should_receive(:get).with('users/info')
+      @firebase.get('users/info')
     end
 
     it "return nil if response body contains 'null'" do
-      mock_response = mock(:body => 'null')
-      @request = Firebase::Request.new(mock_response)
-      expect { @request.body }.to_not raise_error(JSON::ParserError)
+      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 = mock(:body => 'true')
-      @request = Firebase::Request.new(mock_response)
-      @request.body.should eq(true)
+      mock_response = double(:body => 'true')
+      response = Firebase::Response.new(mock_response)
+      response.body.should eq(true)
     end
 
     it "return false if response body contains 'false'" do
-      mock_response = mock(:body => 'false')
-      @request = Firebase::Request.new(mock_response)
-      @request.body.should eq(false)
+      mock_response = double(:body => 'false')
+      response = Firebase::Response.new(mock_response)
+      response.body.should eq(false)
     end
 
     it "raises JSON::ParserError if response body contains invalid JSON" do
-      mock_response = mock(:body => '{"this is wrong"')
-      @request = Firebase::Request.new(mock_response)
-      expect { @request.body }.to raise_error(JSON::ParserError)
+      mock_response = double(:body => '{"this is wrong"')
+      response = Firebase::Response.new(mock_response)
+      expect { response.body }.to raise_error
     end
-
   end
 
   describe "push" do
     it "writes the data" do
-      Firebase::Request.should_receive(:post).with('users', data)
-      Firebase.push('users', data)
+      @req.should_receive(:post).with('users', data)
+      @firebase.push('users', data)
     end
   end
 
   describe "delete" do
     it "returns true" do
-      Firebase::Request.should_receive(:delete).with('users/info')
-      Firebase.delete('users/info')
+      @req.should_receive(:delete).with('users/info')
+      @firebase.delete('users/info')
     end
   end
 
   describe "update" do
     it "updates and returns the data" do
-      Firebase::Request.should_receive(:patch).with('users/info', data)
-      Firebase.update('users/info', data)
+      @req.should_receive(:patch).with('users/info', data)
+      @firebase.update('users/info', data)
     end
   end
 end

metadata

@@ -2,14 +2,14 @@
 name: firebase
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Oscar Del Ben
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-10 00:00:00.000000000 Z
+date: 2013-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
@@ -85,6 +85,7 @@ extra_rdoc_files:
 files:
 - .document
 - .rspec
+- CHANGELOG
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -94,6 +95,7 @@ files:
 - firebase.gemspec
 - lib/firebase.rb
 - lib/firebase/request.rb
+- lib/firebase/response.rb
 - spec/firebase_request_spec.rb
 - spec/firebase_spec.rb
 - spec/spec_helper.rb
@@ -110,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       segments:
       - 0
-      hash: 675265491536299218
+      hash: -3647962587689699515
       version: '0'
   none: false
 required_rubygems_version: !ruby/object:Gem::Requirement