firebase_dynamic_link 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51b5d7e71fe3c9c0ab7b5bfd80a6bfb23e5dbe61
-  data.tar.gz: 1857195a47111dcd5e1add4b181ab8cb860be9a4
+  metadata.gz: 68097ad4857f4630938203f52a41e070468ca86b
+  data.tar.gz: 10e4a64a80f75e0f14e8ea567ccbb08615e41977
 SHA512:
-  metadata.gz: f19b37fc7a8272344e7314e7855a73cdeb318d899f974fe78207c9f89402698488f9d5f55c5a78c2c072dd659a10b62bb2e81e56b53fae888d24cd5fe35bbab0
-  data.tar.gz: 14a2bae7132cac8fc2d20131fcd5be77a633c67b19a0bfd0c6ac2e6e88b6bfd32cce440727ae58a6065d40fae2f3b84f2d8c4c08a8967d4f911908f21e8a57fc
+  metadata.gz: 76edc91a6a5c37bbc4e5a6822523cc38c76a57fedc0ca29d0bf51900ba2e392aee4984516d89f5f88071ccb9a9d164be8a6fefbd97bf00a420d8e520e01f49aa
+  data.tar.gz: 1e944261c7925b97325f7ab728007f5b74d208d7ddde5c6ad7c30fa8a82af62ebf2d51189c8a925a15eaf4cadcde1b447388c5727ae9bc4a31c0d9175d93d62d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    firebase_dynamic_link (0.1.1)
+    firebase_dynamic_link (0.1.2)
       dry-configurable (~> 0.5, >= 0.5.0)
       faraday (~> 0.9, >= 0.9.2)
 

data/README.md

@@ -40,12 +40,17 @@ FirebaseDynamicLink.configure do |config|
   config.default.suffix.option = 'SHORTEN' or 'UNGUESSABLE'
 
   config.default.dynamic_link_domain = 'http://xyz.app.goo.gl'
+
+  config.timeout = 3 # timeout and open timeout for global request
+  config.open_timeout = 3
 end
 
 client = FirebaseDynamicLink::Client.new
 options = {
-  suffix_option: '' # to override default suffix default config 
-  dynamic_link_domain: '' # to override default dynamic_link_domain default config
+  suffix_option: '', # to override default suffix default config 
+  dynamic_link_domain: '', # to override default dynamic_link_domain default config
+  timeout: 10, # timeout and open timeout for each request
+  open_timeout: 10
 }
 result = client.shorten_link(link, options)
 # options argument is optional
@@ -56,7 +61,6 @@ if request successful, then the result should be like following hash object
 
 ```ruby
 { 
-  :success=>true, 
   :link=>"https://--.app.goo.gl/ukph", 
   :preview_link=>"https://--.app.goo.gl/ukph?d=1", 
   :warning=>[
@@ -69,25 +73,11 @@ if request successful, then the result should be like following hash object
        {
          "warningCode"=>"..."
        }
-    ], 
-  :error_message=>nil, 
-  :error_status=>nil, 
-  :error_code=>nil
+    ]
 }
 ```
 
-otherwise
-
-```ruby
-{ :success=>false,
-  :link=>nil,
-  :preview_link=>nil, 
-  :warning=>nil,
-  :error_message=>"Long link is not parsable: ...",
-  :error_status=>"INVALID_ARGUMENT",
-  :error_code=>400
-}
-```
+otherwise it raises FirebaseDynamicLink::ConnectionError exception, with message = http error message
 
 # NOTE
 

data/gemfiles/version_2016.gemfile.lock

@@ -1,7 +1,9 @@
 PATH
   remote: ..
   specs:
-    firebase_dynamic_link (0.1.0)
+    firebase_dynamic_link (0.1.2)
+      dry-configurable (~> 0.5, >= 0.5.0)
+      faraday (~> 0.9, >= 0.9.2)
 
 GEM
   remote: https://rubygems.org/
@@ -44,7 +46,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  appraisal
+  appraisal (~> 2.2.0)
   bundler (~> 1.16)
   dotenv (~> 2.2, >= 2.2.2)
   dry-configurable (= 0.5.0)

data/gemfiles/version_2017a.gemfile.lock

@@ -1,7 +1,9 @@
 PATH
   remote: ..
   specs:
-    firebase_dynamic_link (0.1.0)
+    firebase_dynamic_link (0.1.2)
+      dry-configurable (~> 0.5, >= 0.5.0)
+      faraday (~> 0.9, >= 0.9.2)
 
 GEM
   remote: https://rubygems.org/
@@ -44,7 +46,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  appraisal
+  appraisal (~> 2.2.0)
   bundler (~> 1.16)
   dotenv (~> 2.2, >= 2.2.2)
   dry-configurable (= 0.6.0)

data/gemfiles/version_2017b.gemfile.lock

@@ -1,7 +1,9 @@
 PATH
   remote: ..
   specs:
-    firebase_dynamic_link (0.1.0)
+    firebase_dynamic_link (0.1.2)
+      dry-configurable (~> 0.5, >= 0.5.0)
+      faraday (~> 0.9, >= 0.9.2)
 
 GEM
   remote: https://rubygems.org/
@@ -44,7 +46,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  appraisal
+  appraisal (~> 2.2.0)
   bundler (~> 1.16)
   dotenv (~> 2.2, >= 2.2.2)
   dry-configurable (= 0.6.0)

data/gemfiles/version_2018.gemfile.lock

@@ -1,7 +1,9 @@
 PATH
   remote: ..
   specs:
-    firebase_dynamic_link (0.1.0)
+    firebase_dynamic_link (0.1.2)
+      dry-configurable (~> 0.5, >= 0.5.0)
+      faraday (~> 0.9, >= 0.9.2)
 
 GEM
   remote: https://rubygems.org/
@@ -44,7 +46,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  appraisal
+  appraisal (~> 2.2.0)
   bundler (~> 1.16)
   dotenv (~> 2.2, >= 2.2.2)
   dry-configurable (= 0.7.0)

data/lib/firebase_dynamic_link.rb

@@ -7,6 +7,7 @@ module FirebaseDynamicLink
   extend Dry::Configurable
 
   class InvalidConfig < StandardError; end
+  class ConnectionError < StandardError; end
 
   # You can change it to
   # FirebaseDynamicLink.adapter = :patron
@@ -19,6 +20,12 @@ module FirebaseDynamicLink
 
   setting :api_key
 
+  # Timeout default setting is 3 seconds
+  setting :timeout, 3
+
+  # Open timeout default setting is 3 seconds
+  setting :open_timeout, 3
+
   # This domain will be used if dynamic_link_domain setting is nil
   # it raises error if both of settings are nil
   setting :default do

data/lib/firebase_dynamic_link/client.rb

@@ -8,28 +8,24 @@ module FirebaseDynamicLink
     #   status >= 400
     #   body {"error"=>{"code"=>400, "message"=>"Long link is not parsable: https://k4mu4.app.goo.gl?link=abcde [https://firebase.google.com/docs/dynamic-links/rest#create_a_short_link_from_parameters]", "status"=>"INVALID_ARGUMENT"}}
     def shorten_link(link, options = {})
+      build_connection_options(connection, options)
+
       suffix_option = options.delete(:suffix_option)
       suffix_option ||= config.default.suffix.option
-      dynamic_link_domain = options.delete(:dynamic_link_domain)
-      dynamic_link_domain ||= config.default.dynamic_link_domain || raise(FirebaseDynamicLink::InvalidConfig, 'Dynamic link domain is empty')
-      link = "#{dynamic_link_domain}?link=#{link}"
+
       response = connection.post(nil, {
-        longDynamicLink: link,
+        longDynamicLink: build_link(link, options),
         suffix: {
           option: suffix_option
         }
       }.to_json)
-      body = JSON.parse(response.body)
-      has_error = body.key?('error')
-      {
-        success: !has_error,
-        link: has_error ? nil : body['shortLink'],
-        preview_link: has_error ? nil : body['previewLink'],
-        warning: has_error ? nil : body['warning'],
-        error_message: has_error ? body['error']['message'] : nil,
-        error_status: has_error ? body['error']['status'] : nil,
-        error_code: has_error ? body['error']['code'] : nil
-      }
+      if response.status.between?(200, 299)
+        render_success(response)
+      else
+        raise_error(response)
+      end
+    rescue Faraday::ConnectionFailed => e
+      raise FirebaseDynamicLink::ConnectionError, e.message
     end
 
     def shorten_object(_json_object)
@@ -38,10 +34,21 @@ module FirebaseDynamicLink
 
     private
 
+    def build_link(link, options)
+      dynamic_link_domain = options.delete(:dynamic_link_domain)
+      dynamic_link_domain ||= config.default.dynamic_link_domain || raise(FirebaseDynamicLink::InvalidConfig, 'Dynamic link domain is empty')
+      "#{dynamic_link_domain}?link=#{link}"
+    end
+
+    def build_connection_options(c, options)
+      c.options.timeout = 1 if options.key?(:timeout)
+      c.options.open_timeout = 1 if options.key?(:open_timeout)
+      c
+    end
+
     def connection
-      con = Faraday::Connection.new(url: end_point,
-                                    headers: { 'Content-Type' => 'application/json' })
-      con
+      @connection ||= Faraday::Connection.new(url: end_point,
+                                              headers: { 'Content-Type' => 'application/json' })
     end
 
     def config
@@ -51,5 +58,28 @@ module FirebaseDynamicLink
     def end_point
       "https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=#{config.api_key}"
     end
+
+    def raise_error(response)
+      message = response.reason_phrase if response.respond_to?(:reason_phrase)
+      if message.nil?
+        message = begin
+                    body = JSON.parse(response.body)
+                    body['error']['message']
+                  rescue
+                    response.body
+                  end
+      end
+      raise FirebaseDynamicLink::ConnectionError, message
+    end
+
+    def render_success(response)
+      body = JSON.parse(response.body)
+      has_error = body.key?('error')
+      {
+        link: has_error ? nil : body['shortLink'],
+        preview_link: has_error ? nil : body['previewLink'],
+        warning: has_error ? nil : body['warning']
+      }
+    end
   end
 end

data/lib/firebase_dynamic_link/version.rb

@@ -1,3 +1,3 @@
 module FirebaseDynamicLink
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: firebase_dynamic_link
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - M Saiqul Haq