firebased 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6d2d4e39a94908550d701dbc25fd3535e7ed974
+  data.tar.gz: 99de4196b9c662b96fd7f4f7d4b360478d3cd740
+SHA512:
+  metadata.gz: 519486eb946105c80c93562209279c739e41d3c2b2dd036c2efe3582c0b4e6da48c7ecb7434cfd63c7cf64528d04043fe948cf6e4cbec889cc19aa0f43ae8627
+  data.tar.gz: 30b1dca9ccad1b2f42f89a7fd8bd55c235b27a1b4210e89aeeac8e4b1f5de4f1b3e4c5959850e4954ff62834538570bdadc854b20f335f8b80e6fd0acef27caa

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in firebased.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Miles Zimmerman
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# Firebased
+
+A ruby gem to deploy and manage Firebase instances programaticaly. Based off of [firebase-admin](https://github.com/casetext/firebase-admin) by [casetext](https://github.com/casetext).
+
+Only create/get/delete implemented, will do more when time/necesity demands it (or a blessed soul submits a pull request).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'firebased'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install firebased
+
+
+## Configure
+
+First, put your Firebase account email and password in some environment files.
+
+Then either in an initializer if on rails, or wherever else, include a config block:
+
+```ruby
+Firebased.configure do |config|
+  config.email    = ENV['FIREBASE_EMAIL']
+  config.password = ENV['FIREBASE_PASS']
+end
+```
+
+
+## Usage
+
+#### Create a Firebase
+
+```ruby
+fb = Firebased.create_firebase('my-firebase-url-slug', 'My Optional Firebase Name')
+```
+
+#### Retrieve a Firebase
+
+```ruby
+fb = Firebased.get_firebase('my-firebase-url-slug')
+```
+
+#### Delete a Firebase
+
+```ruby
+Firebased.delete_firebase('my-firebase-url-slug')
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/econlab/firebased/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/firebased.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'firebased/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "firebased"
+  spec.version       = Firebased::VERSION
+  spec.authors       = ["Miles Zimmerman"]
+  spec.email         = ["miles@maztek.io"]
+  spec.summary       = %q{Deploy and manage Firebase instances programatically}
+  spec.description   = %q{A ruby gem to deploy and manage Firebase instances programaticaly. Based off of firebase-admin by casetext.}
+  spec.homepage      = "https://github.com/econlab/firebased"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "json"
+end

data/lib/firebased.rb

@@ -0,0 +1,39 @@
+require_relative 'firebased/version'
+
+require_relative 'firebased/account'
+require_relative 'firebased/firebase'
+require_relative 'firebased/configurable'
+
+module Firebased
+  class << self
+    include Firebased::Configurable
+    
+    # Delegate to a Firebased::Account
+    #
+    # @return [Firebased::Account]
+    def client
+      @client = Firebased::Account.new(credentials) unless defined?(@client)
+      @client
+    end
+    
+    # Has a client been initialized on the Firebased module?
+    #
+    # @return [Boolean]
+    def client?
+      !!@client
+    end
+    
+    
+    def respond_to?(method_name, include_private=false)
+      client.respond_to?(method_name, include_private) || super
+    end
+    
+    private
+
+      def method_missing(method_name, *args, &block)
+        return super unless client.respond_to?(method_name)
+        client.send(method_name, *args, &block)
+      end
+    
+  end
+end

data/lib/firebased/account.rb

@@ -0,0 +1,69 @@
+require 'faraday'
+require 'json'
+
+ACCOUNT_BASE = 'https://admin.firebase.com/account'
+FIRE_BASE    = 'https://admin.firebase.com/firebase'
+
+module Firebased
+  class Account
+    attr_reader :email, :pass, :token, :bases
+    
+    def initialize(email, pass, token = nil)
+      @email = email
+      @pass  = pass
+      @token = token
+      @bases = {}
+      login! unless token
+    end
+    
+    
+    # Fetches admin token if not passed on initialize
+    def login!
+      params     = { email: email, password: pass }
+      response   = Faraday.get("#{ACCOUNT_BASE}/login", params)
+      attributes = JSON.parse(response.body)
+      @token     = attributes["adminToken"]
+    end
+    
+    
+    # Create a new firebase
+    #
+    # @param name     [String] slug/url-friendly app name
+    # @param app_name [String] title of firebase
+    #
+    # @return         [Firebased::Firebase] a fresh new Firebase instance
+    def create_firebase(name, app_name = nil)
+      params   = { token: @token, appName: app_name || name }
+      response = Faraday.post("#{FIRE_BASE}/#{name}", params)
+      response = JSON.parse(response.body)
+      firebase = Firebased::Firebase.new(name, @token) if response["success"]
+      @bases[name] = firebase
+      return firebase
+    end
+    
+    
+    # Fetch an existing firebase
+    #
+    # @param name     [String] slug/url-friendly app name
+    #
+    # @return         [Firebased::Firebase] a fresh new Firebase instance
+    def get_firebase(name)
+      @bases[name] || Firebased::Firebase.new(name, @token)
+    end
+    
+    
+    # Delete an existing firebase
+    #
+    # @param name     [String] slug/url-friendly app name
+    #
+    # @return         [Firebased::Firebase] a fresh new Firebase instance
+    def delete_firebase(name)
+      params   = { "_method" => "DELETE", namespace: name, token: @token }
+      response = Faraday.post("#{FIRE_BASE}/#{name}", params)
+      response = JSON.parse(response.body)
+      p response["error"]
+      @bases.delete(name) unless response["error"]
+    end
+    
+  end
+end

data/lib/firebased/configurable.rb

@@ -0,0 +1,29 @@
+module Firebased
+  module Configurable
+    attr_writer :email, :password
+    
+    class << self
+      def keys
+        @keys ||= [:email, :password, :token]
+      end
+    end
+    
+    # Allow block configuration
+    def configure
+      yield self
+      self
+    end
+    
+    private
+    
+      # @return [Hash]
+      def credentials
+        {
+          email:    @email,
+          password: @password,
+          token:    @token
+        }
+      end
+    
+  end
+end

data/lib/firebased/firebase.rb

@@ -0,0 +1,33 @@
+require 'faraday'
+require 'json'
+
+FIRE_BASE = 'https://admin.firebase.com/firebase'
+
+module Firebased
+  class Firebase
+    attr_accessor :name, :personal_token, :admin_token, :firebase_token, :auth_tokens
+    
+    def initialize(name, admin_token)
+      @name        = name
+      @admin_token = admin_token
+      generate_reference!
+    end
+    
+    
+    def auth_tokens
+      return @auth_tokens || get_auth_tokens
+    end
+    
+    
+    private
+    
+    def generate_reference!
+      params     = { token: @admin_token, namespace: @name }
+      response   = Faraday.get("#{FIRE_BASE}/#{name}/token", params)
+      attributes = JSON.parse(response.body)
+      @personal_token = attributes["personalToken"]
+      @firebase_token = attributes["firebaseToken"]
+    end
+    
+  end
+end

data/lib/firebased/version.rb

@@ -0,0 +1,3 @@
+module Firebased
+  VERSION = "0.1.0"
+end

data/test/account/account_test.rb

@@ -0,0 +1,18 @@
+require './test/test_helper'
+
+class FirebasedAccountTest < Minitest::Test
+  
+  def test_exists
+    assert Firebased::Account
+  end
+  
+  def test_account_logs_in_when_token_omitted
+    VCR.use_cassette('account', :record => :once) do
+      account = Firebased::Account.new('email', 'pass')
+      
+      assert_equal Firebased::Account, account.class
+      refute_nil   account.token
+    end
+  end
+    
+end

data/test/account/firebase_test.rb

@@ -0,0 +1,33 @@
+require 'securerandom'
+require './test/test_helper'
+
+class FirebasedAccountTest < Minitest::Test
+  
+  def setup
+    @account = Firebased::Account.new('email', 'pass', 'token')
+    @hash = SecureRandom.hex.to_s
+  end
+  
+  def test_can_create_firebase
+    p @hash
+    VCR.use_cassette('firebase_created', :record => :all) do
+      fb = @account.create_firebase(@hash)
+      refute_nil fb
+    end
+  end
+  
+  def test_can_get_firebase
+    p @hash
+    fb = @account.get_firebase(@hash)
+    refute_nil fb
+  end
+  
+  def test_can_delete_firebase
+    p @hash
+    VCR.use_cassette('firebase_deleted', :record => :all) do
+      fb = @account.delete_firebase(@hash)
+      assert_nil @account.bases[@hash]
+    end
+  end
+    
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require './lib/firebased'
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = "test/fixtures"
+  c.hook_into :webmock
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: firebased
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Miles Zimmerman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby gem to deploy and manage Firebase instances programaticaly. Based
+  off of firebase-admin by casetext.
+email:
+- miles@maztek.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- firebased.gemspec
+- lib/firebased.rb
+- lib/firebased/account.rb
+- lib/firebased/configurable.rb
+- lib/firebased/firebase.rb
+- lib/firebased/version.rb
+- test/.DS_Store
+- test/account/.DS_Store
+- test/account/account_test.rb
+- test/account/firebase_test.rb
+- test/test_helper.rb
+homepage: https://github.com/econlab/firebased
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Deploy and manage Firebase instances programatically
+test_files:
+- test/.DS_Store
+- test/account/.DS_Store
+- test/account/account_test.rb
+- test/account/firebase_test.rb
+- test/test_helper.rb