firebase-auth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7bf096b7cac074f0438a1e9de58ef33a1e177e88
+  data.tar.gz: 91000c7a3a18145736e00e6f3ff18c329db00c78
+SHA512:
+  metadata.gz: ba38696727528d887afc776fc31406d40bc5fcd08e274faaccb517da900c5fbdd336f19234855d82ba9c67b47eb54b93996cb17c57ddb1cc562e130c5eafff35
+  data.tar.gz: 3127485fd806d0ab197478b117e293490fd9a73b8048d18c0ae19dad907dd93c9d15d3e37bf2d96f92c379ee11cbdf92a4e36b5f5f2154c4fea562029b89e2ba

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hungdh@onaclover.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Huy Hùng
+
+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,41 @@
+# Firebase::Auth
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/firebase/auth`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'firebase-auth'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install firebase-auth
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/firebase-auth. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "firebase/auth"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/firebase-auth.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'firebase/auth/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "firebase-auth"
+  spec.version       = Firebase::Auth::VERSION
+  spec.authors       = ["Huy Hùng"]
+  spec.email         = ["huyhung1994@gmail.com"]
+
+  spec.summary       = "Firebase Authentication wrapper for Ruby"
+  spec.homepage      = "https://github.com/hungdh0x5e/firebase-auth"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_runtime_dependency "rest-client", "~> 2.0"
+end

data/lib/firebase/auth.rb

@@ -0,0 +1,293 @@
+require 'firebase/auth/version'
+require 'firebase/auth/config'
+require 'rest-client'
+require 'json'
+
+module Firebase
+  module Auth
+    class Client
+      attr_reader :api_key
+
+      def initialize(api_key)
+        raise ArgumentError.new('Missing api_key') if (api_key.nil? || api_key.empty?)
+
+        @api_key = api_key
+      end
+
+      # Create a new email and password user
+      # Params:
+      #   @email: The email for the user to create.
+      #   @password: The password for the user to create.
+      # Error:
+      #   [EMAIL_EXISTS, OPERATION_NOT_ALLOWED, TOO_MANY_ATTEMPTS_TRY_LATER]
+      # Referrences:
+      #   https://firebase.google.com/docs/reference/rest/auth/#section-create-email-password
+      def sign_up_email(email, password, options={})
+        data = {
+          email: email, password: password,
+          displayName: options[:display_name],
+          returnSecureToken: true
+        }
+        process(:post, Config::SIGN_UP_EMAIL, data)
+      end
+
+      # Sign in a user with an email and password
+      # # Params:
+      #   @email:
+      #   @password:
+      # Error:
+      #   [EMAIL_NOT_FOUND, INVALID_PASSWORD, USER_DISABLED]
+      # Referrences:
+      #   https://firebase.google.com/docs/reference/rest/auth/#section-create-email-password
+      def sign_in_email(email, password)
+        data = {
+          email: email, password: password, returnSecureToken: true
+        }
+        process(:post, Config::SIGN_IN_EMAIL, data)
+      end
+
+      # Sign in a user anonymously
+      def sign_in_anonymously
+        data = { returnSecureToken: true }
+        process(:post, Config::SIGN_UP_EMAIL, data)
+      end
+
+      # Sign in with OAuth credential
+      # Params:
+      #   @provider: [facebook.com, google.com, github.com, twitter.com]
+      #   @access_token: OAuth credential
+      #   @request_uri: The URI to which the IDP redirects the user back.
+      # Error
+      #   [OPERATION_NOT_ALLOWED, INVALID_IDP_RESPONSE]
+      def sign_in_oauth(provider, access_token, request_uri)
+        data = {
+          requestUri: request_uri,
+          postBody: "access_token=#{access_token}&providerId=#{provider}",
+          returnSecureToken: true,
+          returnIdpCredential: true
+        }
+
+        process(:post, Config::SIGN_IN_OAUTH, data)
+      end
+
+      # Fetch providers for email
+      # Params:
+      #   @email: User's email address
+      #   @continue_uri: The URI to which the IDP redirects the user back
+      # Error
+      #   [INVALID_EMAIL]
+      def fetch_providers_for_email(email, continue_uri)
+        data = { identifier: email, continueUri: continue_uri }
+
+        process(:post, Config::GET_PROVIDERS_FOR_EMAIL, data)
+      end
+
+      # Send code confirmation to reset password via email
+      # Params:
+      #   @email: User's email address want reset password
+      # Error
+      #   [EMAIL_NOT_FOUND]
+      def send_confirm_code(email)
+        data = {
+          email: email,
+          requestType: Param::PASSWORD_RESET
+        }
+
+        process(:post, Config::SEND_CODE_CONFIRM, data)
+      end
+
+      # Verify password reset code
+      # Params:
+      #   @code: code received though email
+      # Error
+      #   [OPERATION_NOT_ALLOWED, EXPIRED_OOB_CODE, INVALID_OOB_CODE]
+      def verfify_password_code(code)
+        data = { oobCode: code }
+
+        process(:post, Config::VERIFY_CODE_RESET_PWD, data)
+      end
+
+      # Reset password
+      # Params:
+      #   @code: code received though email
+      #   @password: new password want change
+      # Error
+      #   [OPERATION_NOT_ALLOWED, EXPIRED_OOB_CODE, INVALID_OOB_CODE]
+      def reset_password(code, password)
+        data = { oobCode: code, newPassword: password }
+
+        process(:post, Config::RESET_PASSWORD, data)
+      end
+
+      # Change a user's email
+      # Params:
+      #   @token: user's token
+      #   @email: the user's new email.
+      # Error
+      #   [EMAIL_EXISTS, INVALID_ID_TOKEN]
+      def change_email(token, email)
+        data = { idToken: token, email: email, returnSecureToken: true}
+
+        process(:post, Config::SET_ACCOUNT_INFO, data)
+      end
+
+      # Change a user's password
+      # Params:
+      #   @token: user's token
+      #   @password: User's new password.
+      # Error
+      #   [INVALID_ID_TOKEN, WEAK_PASSWORD]
+      def change_password(token, password)
+        data = { idToken: token, password: password, returnSecureToken: true }
+
+        process(:post, Config::SET_ACCOUNT_INFO, data)
+      end
+
+      # Update user's profile
+      # Params:
+      #   @token: user's token
+      #   @user_name: User's new display name
+      #   @photo_url: User's new photo url
+      # Error
+      #   [INVALID_ID_TOKEN]
+      def update_profile(token, user_name, photo_url)
+        data = {
+          idToken: token, displayName: user_name,
+          photoUrl: photo_url, returnSecureToken: true
+        }
+
+        process(:post, Config::SET_ACCOUNT_INFO, data)
+      end
+
+      # Get account info
+      # Params:
+      #   @token: The Firebase ID token of the account
+      # Error
+      #   [INVALID_ID_TOKEN, USER_NOT_FOUND]
+      def get_account_info(token)
+        data = { idToken: token }
+
+        process(:post, Config::GET_ACCOUNT_INFO, data)
+      end
+
+      # Link new account (email/ password) with user exist
+      # Param:
+      #   @token: token of main user
+      #   @email: user's email want link
+      #   @password: user's password want link
+      # Error
+      #   [CREDENTIAL_TOO_OLD_LOGIN_AGAIN, TOKEN_EXPIRED,
+      #     INVALID_ID_TOKEN, WEAK_PASSWORD]
+      def link_with_email(token, email, password)
+        data = {
+          idToken: token,
+          email: email, password: password,
+          returnSecureToken: true
+        }
+
+        process(:post, Config::SET_ACCOUNT_INFO, data)
+      end
+
+      # Link new account (email/ password) with user exist
+      # Param:
+      #   @token: token of main user
+      #   @email: user's email want link
+      #   @password: user's password want link
+      # Error
+      #   [CREDENTIAL_TOO_OLD_LOGIN_AGAIN, TOKEN_EXPIRED,
+      #     INVALID_ID_TOKEN, WEAK_PASSWORD]
+      def link_with_oauth(token, provider, access_token, redirect_uri)
+        data = {
+          idToken: token, requestUri: redirect_uri,
+          postBody: "id_token=#{access_token}&providerId=#{provider}",
+          returnSecureToken: true, returnIdpCredential: true
+        }
+
+        process(:post, Config::SET_ACCOUNT_INFO, data)
+      end
+
+      # Unlink between account
+      # Params:
+      #   @token: user's token want unlink
+      #   @providers: list of provider want unlink
+      # Error
+      #   [INVALID_ID_TOKEN]
+      def unlink_provider(token, providers=[])
+        data = { idToken: token, deleteProvider: providers }
+
+        process(:post, Config::SET_ACCOUNT_INFO, data)
+      end
+
+      # Send email verification
+      # Params:
+      #   @token: user's token
+      #  Error
+      #   [INVALID_ID_TOKEN, USER_NOT_FOUND]
+      def send_email_verify(token)
+        data = { idToken: token, requestType: Param::VERIFY_EMAIL }
+
+        process(:post, Config::SEND_CODE_CONFIRM, data)
+      end
+
+      # Verify email by code
+      # Params:
+      #   @code:
+      # Error
+      #   [EXPIRED_OOB_CODE, INVALID_OOB_CODE,
+      #     USER_DISABLED, EMAIL_NOT_FOUND]
+      def confirm_email(code)
+        data = { oobCode: code }
+
+        process(:post, Config::SET_ACCOUNT_INFO, data)
+      end
+
+      def delete_account(token)
+        data = { idToken: token }
+
+        process(:post, Config::DELETE_ACCOUNT, data)
+      end
+
+      def refresh_token(refresh_token)
+        data = {
+          grant_type: Param::REFRESH_TOKEN,
+          refresh_token: refresh_token
+        }
+
+        begin
+          RestClient::Request.execute(method: :post,
+                                    url: "#{Config::EXCHANGE_REFRESH_TOKEN}?key=#{api_key}",
+                                    headers: { 'Content-Type': 'application/json' },
+                                    payload: data.to_json,
+                                    timeout: 10)
+        rescue RestClient::ExceptionWithResponse => e
+          e.response
+        end
+      end
+
+      # Additional Get certificate sign token (JWT)
+      def get_certificate
+        begin
+          res = RestClient::Request.execute(method: :get,
+                                    url: "#{Config::GET_CERTIFICATE}",
+                                    timeout: 10)
+          certificates = JSON.parse(res.body)
+        rescue RestClient::ExceptionWithResponse => e
+          e.response
+        end
+      end
+
+      private
+      def process(verb, path, data=nil)
+        begin
+          RestClient::Request.execute(method: verb,
+                                    url: "#{Config::BASE_URI}/#{path}?key=#{api_key}",
+                                    headers: { 'Content-Type': 'application/json' },
+                                    payload: data.to_json,
+                                    timeout: 10)
+        rescue RestClient::ExceptionWithResponse => e
+          e.response
+        end
+      end
+    end
+  end
+end

data/lib/firebase/auth/config.rb

@@ -0,0 +1,28 @@
+module Firebase
+  module Auth
+    module Config
+      BASE_URI = 'https://www.googleapis.com/identitytoolkit/v3/relyingparty'
+      EXCHANGE_REFRESH_TOKEN = 'https://securetoken.googleapis.com/v1/token'
+      GET_CERTIFICATE = 'https://www.googleapis.com/robot/v1/metadata/x509/securetoken@system.gserviceaccount.com'
+      VERIFY_TOKEN_VERSION = 'verifyCustomToken'
+      SIGN_UP_EMAIL = 'signupNewUser'
+      SIGN_IN_EMAIL = 'verifyPassword'
+      SIGN_IN_OAUTH = 'verifyAssertion'
+
+      SEND_CODE_CONFIRM = 'getOobConfirmationCode'
+      RESET_PASSWORD = 'resetPassword'
+
+      SET_ACCOUNT_INFO = 'setAccountInfo'
+      GET_ACCOUNT_INFO = 'getAccountInfo'
+      GET_PROVIDERS_FOR_EMAIL = 'createAuthUri'
+
+      DELETE_ACCOUNT = 'deleteAccount'
+    end
+
+    module Param
+      REFRESH_TOKEN = 'refresh_token'
+      PASSWORD_RESET = 'PASSWORD_RESET'
+      VERIFY_EMAIL = 'VERIFY_EMAIL'
+    end
+  end
+end

data/lib/firebase/auth/version.rb

@@ -0,0 +1,5 @@
+module Firebase
+  module Auth
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: firebase-auth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Huy Hùng
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- huyhung1994@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- firebase-auth.gemspec
+- lib/firebase/auth.rb
+- lib/firebase/auth/config.rb
+- lib/firebase/auth/version.rb
+homepage: https://github.com/hungdh0x5e/firebase-auth
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Firebase Authentication wrapper for Ruby
+test_files: []