firebase-authentication 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52f63a09db5325c16fef42a13e248799767c1b9378af29a029e4ed5e7532b004
-  data.tar.gz: da4d219fc4d98dabf25e86ec4944188dc8e45f00bb9182fb2dabd03866db797a
+  metadata.gz: 4546fc49b1646e864b9aeed627ed6aa659a276853691dd0e79a2d77300e2cb8c
+  data.tar.gz: de8b4059a5eaf651a9f44ae0a655579d72c6aec5c0feff28842883d40350a9ed
 SHA512:
-  metadata.gz: 7051a16c7a466845d33617a9cf0b9ea1f9413d66fa0da1eb57d8a574e9d4360838ad4e976484862f9f377fcfdb761047a657236e7e66badc4545ba7b1fbc6c88
-  data.tar.gz: b4f2ba99ba8758e6e056df2f42787e211e230d25aedde1a76548b852e2ba336416c74bd9ae42e26c0eb92e73243d6b301c5c8fb2d478139e11e68243fc95d3e0
+  metadata.gz: fa8e18c14288c4e7c523ff75b86be762444d3f3d59c34704d9c172695d7f2fa4ac7c40c95edda180ff80dacbf3579fcb7a21dab89ed6861cd2bcb3c4e31e686f
+  data.tar.gz: 191da01e5bf01b5a2e989603097a9738480f171c96bf823a38503f09cd80d7646b312833153ab82f2083f0c2af7db5627a8b8b044eaae8a8d1fb9505fecb77b6

data/README.md

@@ -1,8 +1,6 @@
 # Firebase::Authentication
 
-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/authentication`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A Ruby wrapper for [Firebase Auth REST API](https://firebase.google.com/docs/reference/rest/auth)
 
 ## Installation
 
@@ -22,7 +20,25 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First, initialize service client with your Web API Key.<br>
+
+```ruby
+require "firebase/authentication"
+service = Firebase::Authentication::Service.new(ENV['API_KEY'])
+```
+
+Then, call the [method](https://github.com/shuntagami/firebase-authentication/blob/main/lib/firebase/authentication/service.rb) you need like below.<br>
+
+```ruby
+service.sign_up(email, password)
+```
+
+You can use the response like below.<br>
+
+```ruby
+response = service.sign_up(email, password)
+uid = JSON.parse(response.body)['localId'] # The uid of the newly created user.
+```
 
 ## Development
 
@@ -32,12 +48,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/firebase-authentication. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/firebase-authentication/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/shuntagami/firebase-authentication. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/shuntagami/firebase-authentication/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Firebase::Authentication project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/firebase-authentication/blob/main/CODE_OF_CONDUCT.md).

data/firebase-authentication.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["shuntagami23@gmail.com"]
 
   spec.summary       = "Firebase Authentication for Ruby client"
-  spec.homepage      = "https://github.com/shuntagami/firebase_auth_for_ruby"
+  spec.homepage      = "https://github.com/shuntagami/firebase-authentication"
   spec.license       = "MIT"
   spec.required_ruby_version = ">= 3.0.0"
 

data/lib/firebase/authentication/config.rb

@@ -13,6 +13,7 @@ module Firebase
       SIGN_IN_OAUTH = "signInWithIdp?key="
       SIGN_UP_EMAIL = "signUp?key="
       UPDATE_ACCOUNT_INFO = "update?key="
+      VERIFY_CUSTOM_TOKEN = "signInWithCustomToken?key="
     end
   end
 end

data/lib/firebase/authentication/service.rb

@@ -6,48 +6,161 @@ require_relative "config"
 
 module Firebase
   module Authentication
+    # A Ruby wrapper for Firebase REST API
+    #
+    # Query the Firebase Auth backend through a REST API
+    #
+    # @example
+    #   require "firebase/authentication"
+    #
+    #   service = Firebase::Authentication::Service.new(ENV['API_KEY'])
+    #   service.sign_up(email, password)
+    #
+    # @see https://firebase.google.com/docs/reference/rest/auth
     class Service
       def initialize(api_key, logger = Rails.logger)
         @logger = logger
         @api_key = api_key
       end
 
+      # Change a user's email.
+      # @param [String] token
+      #   A Firebase Auth ID token for the user.
+      # @param [String] email
+      #   The user's new email.
+      #
+      # @return [Net::HTTPOK]
+      #
+      # @raise [Net::HTTPRetriableError] An error occurred on the server and the request can be retried
+      # @raise [Net::HTTPServerException] The request is invalid and should not be retried without modification
+      # @raise [Net::HTTPFatalError] An internal server error occurred
+      #
+      # @see https://firebase.google.com/docs/reference/rest/auth#section-change-email
       def change_email(token, email)
         res = fetch(:post, Config::UPDATE_ACCOUNT_INFO, { idToken: token, email: email, returnSecureToken: true })
         res.value
         res
       end
 
+      # Change a user's password.
+      # @param [String] token
+      #   A Firebase Auth ID token for the user.
+      # @param [String] password
+      #   The user's new password.
+      #
+      # @return [Net::HTTPOK]
+      #
+      # @raise [Net::HTTPRetriableError] An error occurred on the server and the request can be retried
+      # @raise [Net::HTTPServerException] The request is invalid and should not be retried without modification
+      # @raise [Net::HTTPFatalError] An internal server error occurred
+      #
+      # @see https://firebase.google.com/docs/reference/rest/auth#section-change-password
       def change_password(token, password)
         res = fetch(:post, Config::UPDATE_ACCOUNT_INFO, { idToken: token, passsord: password, returnSecureToken: true })
         res.value
         res
       end
 
+      # Delete a user.
+      # @param [String] token
+      #   The Firebase ID token of the user to delete.
+      #
+      # @return [Net::HTTPOK]
+      #
+      # @raise [Net::HTTPRetriableError] An error occurred on the server and the request can be retried
+      # @raise [Net::HTTPServerException] The request is invalid and should not be retried without modification
+      # @raise [Net::HTTPFatalError] An internal server error occurred
+      #
+      # @see https://firebase.google.com/docs/reference/rest/auth#section-delete-account
       def delete_account(token)
         res = fetch(:post, Config::DELETE_ACCOUNT, { idToken: token })
         res.value
         res
       end
 
+      # Exchange a custom Auth token for an ID and refresh token
+      # @param [String] token
+      #   A Firebase Auth custom token from which to create an ID and refresh token pair.
+      #
+      # @return [Net::HTTPOK]
+      #
+      # @raise [Net::HTTPRetriableError] An error occurred on the server and the request can be retried
+      # @raise [Net::HTTPServerException] The request is invalid and should not be retried without modification
+      # @raise [Net::HTTPFatalError] An internal server error occurred
+      #
+      # @see https://firebase.google.com/docs/reference/rest/auth#section-verify-custom-token
+      def exchange_custom_token(token)
+        res = fetch(:post, Config::VERIFY_CUSTOM_TOKEN, { idToken: token, returnSecureToken: true })
+        res.value
+        res
+      end
+
+      # Get a user's data
+      # @param [String] token
+      #   The Firebase ID token of the account.
+      #
+      # @return [Net::HTTPOK]
+      #
+      # @raise [Net::HTTPRetriableError] An error occurred on the server and the request can be retried
+      # @raise [Net::HTTPServerException] The request is invalid and should not be retried without modification
+      # @raise [Net::HTTPFatalError] An internal server error occurred
+      #
+      # @see https://firebase.google.com/docs/reference/rest/auth#section-get-account-info
       def get_account_info(token)
         res = fetch(:post, Config::GET_ACCOUNT_INFO, { idToken: token })
         res.value
         res
       end
 
+      # Send a password reset email.
+      # @param [String] email
+      #   User's email address.
+      #
+      # @return [Net::HTTPOK]
+      #
+      # @raise [Net::HTTPRetriableError] An error occurred on the server and the request can be retried
+      # @raise [Net::HTTPServerException] The request is invalid and should not be retried without modification
+      # @raise [Net::HTTPFatalError] An internal server error occurred
+      #
+      # @see https://firebase.google.com/docs/reference/rest/auth#section-send-password-reset-email
       def send_password_reset_email(email)
         res = fetch(:post, Config::RESET_PASSWORD, { requestType: "PASSWORD_RESET", email: email })
         res.value
         res
       end
 
+      # Signin a user.
+      # @param [String] email
+      #   The email the user is signing in with.
+      # @param [String] password
+      #   The password for the account.
+      #
+      # @return [Net::HTTPOK]
+      #
+      # @raise [Net::HTTPRetriableError] An error occurred on the server and the request can be retried
+      # @raise [Net::HTTPServerException] The request is invalid and should not be retried without modification
+      # @raise [Net::HTTPFatalError] An internal server error occurred
+      #
+      # @see https://firebase.google.com/docs/reference/rest/auth#section-sign-in-email-password
       def sign_in_email(email, password)
         res = fetch(:post, Config::SIGN_IN_EMAIL, { email: email, passsord: password, returnSecureToken: true })
         res.value
         res
       end
 
+      # Signup new user.
+      # @param [String] email
+      #   The email for the user to create.
+      # @param [String] password
+      #   The password for the user to create.
+      #
+      # @return [Net::HTTPOK]
+      #
+      # @raise [Net::HTTPRetriableError] An error occurred on the server and the request can be retried
+      # @raise [Net::HTTPServerException] The request is invalid and should not be retried without modification
+      # @raise [Net::HTTPFatalError] An internal server error occurred
+      #
+      # @see https://firebase.google.com/docs/reference/rest/auth#section-create-email-password
       def sign_up(email, password)
         res = fetch(:post, Config::SIGN_UP_EMAIL, { email: email, password: password, returnSecureToken: true })
         res.value

data/lib/firebase/authentication/version.rb

@@ -1,5 +1,5 @@
 module Firebase
   module Authentication
-    VERSION = "0.3.0".freeze
+    VERSION = "1.0.0".freeze
   end
 end

data/lib/firebase/authentication.rb

@@ -34,7 +34,7 @@ module Firebase
       end
 
       def create_custom_token(uid, claims = {})
-        private_key = OpenSSL::PKey::RSA.new Global.firebase.private_key.gsub('\\n', "\n")
+        private_key = OpenSSL::PKey::RSA.new Global.firebase.private_key.gsub("\\n", "\n")
         service_account_email = Global.firebase.client_email
         now_seconds = Time.now.to_i
         payload = { iss: service_account_email,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firebase-authentication
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - shuntagami
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-07 00:00:00.000000000 Z
+date: 2021-10-16 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -22,7 +22,6 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -33,7 +32,7 @@ files:
 - lib/firebase/authentication/config.rb
 - lib/firebase/authentication/service.rb
 - lib/firebase/authentication/version.rb
-homepage: https://github.com/shuntagami/firebase_auth_for_ruby
+homepage: https://github.com/shuntagami/firebase-authentication
 licenses:
 - MIT
 metadata: {}

data/Gemfile.lock

@@ -1,188 +0,0 @@
-PATH
-  remote: .
-  specs:
-    firebase-authentication (0.2.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actioncable (6.1.4.1)
-      actionpack (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-    actionmailbox (6.1.4.1)
-      actionpack (= 6.1.4.1)
-      activejob (= 6.1.4.1)
-      activerecord (= 6.1.4.1)
-      activestorage (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
-      mail (>= 2.7.1)
-    actionmailer (6.1.4.1)
-      actionpack (= 6.1.4.1)
-      actionview (= 6.1.4.1)
-      activejob (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 2.0)
-    actionpack (6.1.4.1)
-      actionview (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
-      rack (~> 2.0, >= 2.0.9)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.1.4.1)
-      actionpack (= 6.1.4.1)
-      activerecord (= 6.1.4.1)
-      activestorage (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
-      nokogiri (>= 1.8.5)
-    actionview (6.1.4.1)
-      activesupport (= 6.1.4.1)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.1.4.1)
-      activesupport (= 6.1.4.1)
-      globalid (>= 0.3.6)
-    activemodel (6.1.4.1)
-      activesupport (= 6.1.4.1)
-    activerecord (6.1.4.1)
-      activemodel (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
-    activestorage (6.1.4.1)
-      actionpack (= 6.1.4.1)
-      activejob (= 6.1.4.1)
-      activerecord (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
-      marcel (~> 1.0.0)
-      mini_mime (>= 1.1.0)
-    activesupport (6.1.4.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    ast (2.4.2)
-    builder (3.2.4)
-    concurrent-ruby (1.1.9)
-    crass (1.0.6)
-    diff-lcs (1.4.4)
-    dotenv (2.7.6)
-    dotenv-rails (2.7.6)
-      dotenv (= 2.7.6)
-      railties (>= 3.2)
-    erubi (1.10.0)
-    globalid (0.5.2)
-      activesupport (>= 5.0)
-    i18n (1.8.10)
-      concurrent-ruby (~> 1.0)
-    jwt (2.2.3)
-    loofah (2.12.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.1)
-      mini_mime (>= 0.1.1)
-    marcel (1.0.2)
-    method_source (1.0.0)
-    mini_mime (1.1.1)
-    mini_portile2 (2.6.1)
-    minitest (5.14.4)
-    nio4r (2.5.8)
-    nokogiri (1.12.5)
-      mini_portile2 (~> 2.6.1)
-      racc (~> 1.4)
-    parallel (1.21.0)
-    parser (3.0.2.0)
-      ast (~> 2.4.1)
-    racc (1.5.2)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails (6.1.4.1)
-      actioncable (= 6.1.4.1)
-      actionmailbox (= 6.1.4.1)
-      actionmailer (= 6.1.4.1)
-      actionpack (= 6.1.4.1)
-      actiontext (= 6.1.4.1)
-      actionview (= 6.1.4.1)
-      activejob (= 6.1.4.1)
-      activemodel (= 6.1.4.1)
-      activerecord (= 6.1.4.1)
-      activestorage (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
-      bundler (>= 1.15.0)
-      railties (= 6.1.4.1)
-      sprockets-rails (>= 2.0.0)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
-      loofah (~> 2.3)
-    railties (6.1.4.1)
-      actionpack (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
-      method_source
-      rake (>= 0.13)
-      thor (~> 1.0)
-    rainbow (3.0.0)
-    rake (13.0.6)
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.22.0)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.12.0)
-      parser (>= 3.0.1.1)
-    ruby-progressbar (1.11.0)
-    sprockets (4.0.2)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.2.2)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
-    thor (1.1.0)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
-    websocket-driver (0.7.5)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.5)
-    zeitwerk (2.4.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  dotenv-rails
-  firebase-authentication!
-  jwt
-  rails (~> 6.1.4)
-  rake
-  rspec
-  rubocop
-
-BUNDLED WITH
-   2.2.28