firebase_dynamic_link 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bbe6a0cad3172b77570b15cff0e5b0f2fe7f269
-  data.tar.gz: ca41acc8781f8df96553abce36c10a4a17b3cf17
+  metadata.gz: 8b8833e89c026a88c4375d66c0b9eec4e0e62b3f
+  data.tar.gz: 32431d2b24ed100688667c1b934a17fdfa3d2b82
 SHA512:
-  metadata.gz: db1298ece8caed00932db3a5a0e3d6182e2c1284f797fc92635eccb9aa02c79c3da00bf00383928a6376c28532fecd22bfe36068b953179083ca3d95aba20920
-  data.tar.gz: d3b9e410ffb53da8e8b759ffe15bdd89e5764a2e5b1d104f699c3ddfc64a0328fa92e2963bc64cba32617768393f7ec140a39229bb5ae31c14b963ffb39294fd
+  metadata.gz: e6b997cb918cbd0a3efcf22f253576ccf626afaf7e93728c8431c42b0e1f289557d8b0e8c503a1566b5de96dcce206f1f4d7c9e2a39cf26af61f24a8898d5868
+  data.tar.gz: aade124ecd68188957b5b0ecae65e013f5141037ef1546f5e3b73192e36e077dd823bbf2b8489a9e93da5e44743398b17ea7e084d1372efefbf86edd225e0522

data/.rubocop.yml

@@ -3,3 +3,144 @@ Metrics/BlockLength:
     - 'Rakefile'
     - '**/*.rake'
     - 'spec/**/*.rb'
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Do not use braces for hash literals when they are the last argument of a
+# method call.
+Style/BracesAroundHashParameters:
+  Enabled: true
+  EnforcedStyle: context_dependent
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/ElseAlignment:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+  AutoCorrect: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+Layout/FirstParameterIndentation:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeComma:
+    Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+    Enabled: true
+
+Style/DefWithParentheses:
+  Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# Detect hard tabs, no hard tabs.
+Layout/Tab:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingBlankLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/UnneededPercentQ:
+  Enabled: true
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: true
+  AllowMultipleReturnValues: true
+
+Style/Semicolon:
+  Enabled: true
+  AllowAsExpressionSeparator: true
+
+# Prefer Foo.method over Foo::method
+Style/ColonMethodCall:
+  Enabled: true

data/Appraisals

@@ -1,19 +1,21 @@
-appraise 'version-2018' do
-  gem 'dry-configurable', '0.7.0'
-  gem 'faraday', '0.14.0'
+# frozen_string_literal: true
+
+appraise "version-2018" do
+  gem "dry-configurable", "0.7.0"
+  gem "faraday", "0.14.0"
 end
 
-appraise 'version-2017b' do
-  gem 'dry-configurable', '0.6.0'
-  gem 'faraday', '0.11.0'
+appraise "version-2017b" do
+  gem "dry-configurable", "0.6.0"
+  gem "faraday", "0.11.0"
 end
 
-appraise 'version-2017a' do
-  gem 'dry-configurable', '0.6.0'
-  gem 'faraday', '0.10.1'
+appraise "version-2017a" do
+  gem "dry-configurable", "0.6.0"
+  gem "faraday", "0.10.1"
 end
 
-appraise 'version-2016' do
-  gem 'dry-configurable', '0.5.0'
-  gem 'faraday', '0.9.2'
+appraise "version-2016" do
+  gem "dry-configurable", "0.5.0"
+  gem "faraday", "0.9.2"
 end

data/Gemfile

@@ -1,6 +1,13 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in firebase_dynamic_link.gemspec
 gemspec
+
+# group :development do
+#   gem 'guard'
+#   gem 'guard-rspec'
+# end

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    firebase_dynamic_link (0.1.3)
-      dry-configurable (~> 0.5, >= 0.5.0)
+    firebase_dynamic_link (1.0.0)
+      dry-configurable (~> 0.6, >= 0.6.0)
       faraday (~> 0.9, >= 0.9.2)
 
 GEM

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/README.md

@@ -13,9 +13,7 @@ based on reference https://firebase.google.com/docs/reference/dynamic-links/link
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'firebase_dynamic_link'
-```
+    gem 'firebase_dynamic_link'
 
 And then execute:
 
@@ -30,74 +28,108 @@ Or install it yourself as:
 ### Configure the HTTP client
 
 ```ruby
-FirebaseDynamicLink.configure do |config|
-  # the adapter should be supported by Faraday
-  # more info look at https://github.com/lostisland/faraday/tree/master/test/adapters
-  # Faraday.default_adapter is the default adapter
-  config.adapter = :httpclient
+    FirebaseDynamicLink.configure do |config|
+      # the adapter should be supported by Faraday
+      # more info look at https://github.com/lostisland/faraday/tree/master/test/adapters
+      # Faraday.default_adapter is the default adapter
+      config.adapter = :httpclient
 
-  # required
-  config.api_key = 'API_KEY'
+      # required
+      config.api_key = 'API_KEY'
 
-  # default 'UNGUESSABLE'
-  config.default.suffix.option = 'SHORT' or 'UNGUESSABLE'
+      # default 'UNGUESSABLE'
+      config.suffix_option = 'SHORT' or 'UNGUESSABLE'
 
-  # required
-  config.default.dynamic_link_domain = 'http://xyz.app.goo.gl'
+      # required, Don't put http://
+      config.dynamic_link_domain = 'xyz.app.goo.gl'
 
-  # default 3 seconds
-  config.timeout = 3 
+      # default 3 seconds
+      config.timeout = 3 
 
-  # default 3 seconds
-  config.open_timeout = 3
-end
+      # default 3 seconds
+      config.open_timeout = 3
+    end
+```
 
-client = FirebaseDynamicLink::Client.new
-options = {
-  # optional, to override default suffix default config 
-  suffix_option: '', 
+### Shorten a link
 
-  # optional, to override default dynamic_link_domain default config
-  dynamic_link_domain: '', 
+```ruby
+    client = FirebaseDynamicLink::Client.new
+    link = "http://domain.com/path/path"
+    options = {
+      # optional, to override default suffix default config 
+      suffix_option: '', 
 
-  # optional, timeout of each request of this instance
-  timeout: 10, 
+      # optional, to override default dynamic_link_domain default config
+      dynamic_link_domain: '', 
 
-  # optional, open timeout of each request of this instance
-  open_timeout: 10
-}
+      # optional, timeout of each request of this instance
+      timeout: 10, 
 
-# options argument is optional
-result = client.shorten_link(link, options)
+      # optional, open timeout of each request of this instance
+      open_timeout: 10
+    }
 
+    # options argument is optional
+    result = client.shorten_link(link, options)
 ```
 
-if request successful, then the result should be like following hash object
+### Shorten parameters
 
 ```ruby
-{ 
-  :link=>"https://--.app.goo.gl/ukph", 
-  :preview_link=>"https://--.app.goo.gl/ukph?d=1", 
-  :warning=>[
-       { 
-         "warningCode"=>"UNRECOGNIZED_PARAM",
-         "warningMessage"=>"..."}, 
-       {
-         "warningCode"=>"..."
-       }, 
-       {
-         "warningCode"=>"..."
-       }
-    ]
-}
+    client = FirebaseDynamicLink::Client.new
+    options = {
+      # optional, to override default suffix default config 
+      suffix_option: '', 
+
+      # optional, to override default dynamic_link_domain default config
+      dynamic_link_domain: '', 
+
+      # optional, timeout of each request of this instance
+      timeout: 10, 
+
+      # optional, open timeout of each request of this instance
+      open_timeout: 10
+    }
+
+    parameters = {
+      link: link,
+      android_info: {
+        android_package_name: name,
+      }
+      ios_info: {},
+      navigation_info: {},
+      analytics_info: {},
+      social_meta_tag_info: {}
+    }
+
+    # options argument is optional
+    result = client.shorten_parameters(parameters, options)
 ```
 
-otherwise it raises `FirebaseDynamicLink::ConnectionError`, with message = http error message
+if request successful, then the result should be like following hash object
+
+or if the request reached daily quota, client will throw `FirebaseDynamicLink::QuotaExceeded` error
 
-# NOTE
+```ruby
+    { 
+      :link=>"https://--.app.goo.gl/ukph", 
+      :preview_link=>"https://--.app.goo.gl/ukph?d=1", 
+      :warning=>[
+           { 
+             "warningCode"=>"UNRECOGNIZED_PARAM",
+             "warningMessage"=>"..."}, 
+           {
+             "warningCode"=>"..."
+           }, 
+           {
+             "warningCode"=>"..."
+           }
+        ]
+    }
+```
 
-this gem only implemented to shorten long dynamic link til now, next version is supposed to 
-be able shorten a JSON object
+otherwise it will throw `FirebaseDynamicLink::ConnectionError` error, with message = http error message
 
 ## Development
 

data/Rakefile

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

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "firebase_dynamic_link"

data/firebase_dynamic_link.gemspec

@@ -1,37 +1,39 @@
 
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'firebase_dynamic_link/version'
+require "firebase_dynamic_link/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'firebase_dynamic_link'
+  spec.name          = "firebase_dynamic_link"
   spec.version       = FirebaseDynamicLink::VERSION
-  spec.authors       = ['M Saiqul Haq']
-  spec.email         = ['saiqulhaq@gmail.com']
+  spec.authors       = ["M Saiqul Haq"]
+  spec.email         = ["saiqulhaq@gmail.com"]
 
-  spec.summary       = 'Ruby client for Firebase Dynamic Link service'
+  spec.summary       = "Ruby client for Firebase Dynamic Link service"
   spec.description   = spec.summary
-  spec.homepage      = 'https://github.com/saiqulhaq/firebase_dynamic_link'
-  spec.license       = 'MIT'
-  spec.metadata["yard.run"] = 'yri'
+  spec.homepage      = "https://github.com/saiqulhaq/firebase_dynamic_link"
+  spec.license       = "MIT"
+  spec.metadata["yard.run"] = "yri"
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'exe'
+  spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'dry-configurable', '~> 0.5', '>= 0.5.0'
-  spec.add_runtime_dependency 'faraday', '~> 0.9', '>= 0.9.2'
+  spec.add_runtime_dependency "dry-configurable", "~> 0.6", ">= 0.6.0"
+  spec.add_runtime_dependency "faraday", "~> 0.9", ">= 0.9.2"
 
-  spec.add_development_dependency 'appraisal', '~> 2.2.0'
-  spec.add_development_dependency 'vcr', '~> 4.0', '>= 4.0.0'
-  spec.add_development_dependency 'dotenv', '~> 2.2', '>= 2.2.2'
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'pry', '~> 0.11.3'
-  spec.add_development_dependency 'bootsnap', '~> 1.3.0'
-  spec.add_development_dependency 'simplecov', '>= 0.16.1'
+  spec.add_development_dependency "appraisal", "~> 2.2.0"
+  spec.add_development_dependency "bootsnap", "~> 1.3.0"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "dotenv", "~> 2.2", ">= 2.2.2"
+  spec.add_development_dependency "pry", "~> 0.11.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", ">= 0.16.1"
+  spec.add_development_dependency "vcr", "~> 4.0", ">= 4.0.0"
 end

data/gemfiles/version_2016.gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "dry-configurable", "0.5.0"
+gem "dry-configurable", "0.6.0"
 gem "faraday", "0.9.2"
 
 gemspec path: "../"

data/gemfiles/version_2016.gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: ..
   specs:
-    firebase_dynamic_link (0.1.3)
-      dry-configurable (~> 0.5, >= 0.5.0)
+    firebase_dynamic_link (1.0.0)
+      dry-configurable (~> 0.6, >= 0.6.0)
       faraday (~> 0.9, >= 0.9.2)
 
 GEM
@@ -18,8 +18,8 @@ GEM
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
     docile (1.3.0)
-    dotenv (2.2.2)
-    dry-configurable (0.5.0)
+    dotenv (2.4.0)
+    dry-configurable (0.6.0)
       concurrent-ruby (~> 1.0)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
@@ -60,7 +60,7 @@ DEPENDENCIES
   bootsnap (~> 1.3.0)
   bundler (~> 1.16)
   dotenv (~> 2.2, >= 2.2.2)
-  dry-configurable (= 0.5.0)
+  dry-configurable (= 0.6.0)
   faraday (= 0.9.2)
   firebase_dynamic_link!
   pry (~> 0.11.3)

data/gemfiles/version_2017a.gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: ..
   specs:
-    firebase_dynamic_link (0.1.3)
-      dry-configurable (~> 0.5, >= 0.5.0)
+    firebase_dynamic_link (1.0.0)
+      dry-configurable (~> 0.6, >= 0.6.0)
       faraday (~> 0.9, >= 0.9.2)
 
 GEM

data/gemfiles/version_2017b.gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: ..
   specs:
-    firebase_dynamic_link (0.1.3)
-      dry-configurable (~> 0.5, >= 0.5.0)
+    firebase_dynamic_link (1.0.0)
+      dry-configurable (~> 0.6, >= 0.6.0)
       faraday (~> 0.9, >= 0.9.2)
 
 GEM

data/gemfiles/version_2018.gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: ..
   specs:
-    firebase_dynamic_link (0.1.3)
-      dry-configurable (~> 0.5, >= 0.5.0)
+    firebase_dynamic_link (1.0.0)
+      dry-configurable (~> 0.6, >= 0.6.0)
       faraday (~> 0.9, >= 0.9.2)
 
 GEM

data/lib/firebase_dynamic_link.rb

@@ -1,40 +1,90 @@
-require 'dry-configurable'
-require 'faraday'
-require 'firebase_dynamic_link/client'
-require 'firebase_dynamic_link/version'
+# frozen_string_literal: true
+
+require "dry-configurable"
+require "faraday"
+require "firebase_dynamic_link/client"
+require "firebase_dynamic_link/link_renderer"
+require "firebase_dynamic_link/version"
 
 module FirebaseDynamicLink
   extend Dry::Configurable
 
+  # called when invalid configuration given
   class InvalidConfig < StandardError; end
+
+  # called when HTTP request failed
   class ConnectionError < StandardError; end
 
-  # You can change it to
-  # FirebaseDynamicLink.adapter = :patron
-  # FirebaseDynamicLink.adapter = :httpclient
-  # FirebaseDynamicLink.adapter = :net_http_persistent
-  #
-  # And get the value by
-  # FirebaseDynamicLink.adapter
+  # called when Firebase says that no more quota
+  class QuotaExceeded < StandardError; end
+
+  # @!group Configuration
+  # @!method adapter
+  #   @!scope class
+  #   Selected Faraday HTTP adapter
+  # @!method adapter=(adapter_key)
+  #   @!scope class
+  #   Set Faraday HTTP adapter
+  #   @param adapter_key [Symbol]
+  #   @example
+  #     FirebaseDynamicLink.adapter = :patron
+  #     FirebaseDynamicLink.adapter = :httpclient
+  #     FirebaseDynamicLink.adapter = :net_http_persistent
+  #   @see https://github.com/lostisland/faraday/tree/master/test/adapters
+  # @since 0.1.0
   setting :adapter, Faraday.default_adapter
 
+  # @!method api_key
+  #   @!scope class
+  #   Given api key
+  # @!method api_key=(key)
+  #   @!scope class
+  #   Set api key
+  #   @param key [String]
+  # @since 0.1.0
   setting :api_key
 
-  # Timeout default setting is 3 seconds
+  # @!method timout
+  #   Timeout default setting is 3 seconds
+  #   @!scope class
+  # @!method timout=(seconds)
+  #   @!scope class
+  #   @param seconds [Integer]
+  # @since 0.1.0
+  # @!scope class
   setting :timeout, 3
 
-  # Open timeout default setting is 3 seconds
+  # @!method open_timout
+  #   @!scope class
+  #   Open timeout default setting is 3 seconds
+  # @!method open_timout=(seconds)
+  #   @!scope class
+  #   @param seconds [Integer]
+  # @since 0.1.0
+  # @!scope class
   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
-    # Firebase dynamic link domain
-    setting(:dynamic_link_domain)
-    setting :suffix do
-      setting(:option, 'UNGUESSABLE') { |value|
-        %w(SHORT UNGUESSABLE).include?(value) ? value : raise(FirebaseDynamicLink::InvalidConfig, 'default suffix option config is not valie')
-      }
-    end
+  # @!method dynamic_link_domain
+  #   @!scope class
+  #   Firebase dynamic link domain
+  # @!method dynamic_link_domain=(domain)
+  #   @!scope class
+  #   @param domain [String]
+  # @since 1.0.0
+  # @!scope class
+  setting(:dynamic_link_domain)
+
+  # @!method suffix_option
+  #   @!scope class
+  #   Firebase suffix option setting, default is UNGUESSABLE
+  # @!method suffix_option=(suffix)
+  #   @!scope class
+  #   @raise [FirebaseDynamicLink::InvalidConfig] if value is not one of SHORT and UNGUESSABLE
+  #   @param suffix [String]
+  # @since 1.0.0
+  # @!scope class
+  setting(:suffix_option, "UNGUESSABLE") do |value|
+    %w[SHORT UNGUESSABLE].include?(value) ? value : raise(FirebaseDynamicLink::InvalidConfig, "default suffix option config is not valid")
   end
+  # @!endgroup
 end

data/lib/firebase_dynamic_link/client.rb

@@ -1,85 +1,161 @@
+# frozen_string_literal: true
+
+require "firebase_dynamic_link/connection"
+require "firebase_dynamic_link/link_renderer"
+
 module FirebaseDynamicLink
+  # Main class that responsible to shorten link or parameters
   class Client
-    attr_accessor :dynamic_link_domain
+    extend Forwardable
 
-    # on succeed
-    #
-    # on failure
-    #   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 initialize
+      @link_renderer = FirebaseDynamicLink::LinkRenderer.new
+      @connection = FirebaseDynamicLink::Connection.new(end_point)
+    end
+
+    # @param link [String] required
+    # @param options [Hash]
+    #   * :timeout optional, default is FirebaseDynamicLink.config.timout
+    #   * :open_timeout [Integer] optional, default is FirebaseDynamicLink.config.open_timout
+    #   * :suffix_option [String] optional, default is FirebaseDynamicLink.config.suffix_option
+    #   * :dynamic_link_domain [String] optional, default is FirebaseDynamicLink.config.dynamic_link_domain
+    # @return [Hash{Symbol=>String}]
+    # @see FirebaseDynamicLink::LinkRenderer#render LinkRenderer#render for returned Hash
     def shorten_link(link, options = {})
-      build_connection_options(connection, options)
+      connection.timeout = options[:timeout] if options.key?(:timeout)
+      connection.open_timeout = options[:open_timeout] if options.key?(:open_timeout)
 
-      suffix_option = options.delete(:suffix_option)
-      suffix_option ||= config.default.suffix.option
+      suffix_option = options[:suffix_option] if options.key?(:suffix_option)
 
       response = connection.post(nil, {
         longDynamicLink: build_link(link, options),
         suffix: {
-          option: suffix_option
+          option: suffix_option || config.suffix_option
         }
       }.to_json)
-      if response.status.between?(200, 299)
-        render_success(response)
-      else
-        raise_error(response)
-      end
+      link_renderer.render(response)
     rescue Faraday::ConnectionFailed, Faraday::TimeoutError => e
       raise FirebaseDynamicLink::ConnectionError, e.message
     end
 
-    def shorten_object(_json_object)
-      raise NotImplementedError
-    end
+    # @param params [Hash]
+    #   * link [String]
+    #   * android_info [Hash]
+    #     * android_package_name [String]
+    #     * android_fallback_link [String]
+    #     * android_min_package_version_code [String]
+    #     * android_link [String]
+    #   * ios_info [Hash]
+    #     * ios_bundle_id [String]
+    #     * ios_fallback_link [String]
+    #     * ios_custom_scheme [String]
+    #     * ios_ipad_fallback_link [String]
+    #     * ios_ipad_bundle_id [String]
+    #     * ios_app_store_id [String]
+    #   * navigation_info [Hash]
+    #     * enable_forced_redirect [Boolean]
+    #   * analytics_info [Hash]
+    #     * google_play_analytics [Hash]
+    #       * utm_source [String]
+    #       * utm_medium [String]
+    #       * utm_campaign [String]
+    #       * utm_term [String]
+    #       * utm_content [String]
+    #       * gclid [String]
+    #     * itunes_connect_analytics [Hash]
+    #       * at [String]
+    #       * ct [String]
+    #       * mt [String]
+    #       * pt [String]
+    #   * social_meta_tag_info [Hash]
+    #     * social_title [String]
+    #     * social_description [String]
+    #     * social_image_link [String]
+    # @example
+    #   options = {
+    #     suffix_option: "SHORT",
+    #     dynamic_link_domain: 'domain' # optional
+    #   }
+    #
+    #   parameters = {
+    #     link: link,
+    #     android_info: {
+    #       android_package_name: string,
+    #       android_fallback_link: string,
+    #       android_min_package_version_code: string,
+    #       android_link: string
+    #     },
+    #     ios_info: {
+    #       ios_bundle_id: string,
+    #       ios_fallback_link: string,
+    #       ios_custom_scheme: string,
+    #       ios_ipad_fallback_link: string,
+    #       ios_ipad_bundle_id: string,
+    #       ios_app_store_id: string
+    #     },
+    #     navigation_info: {
+    #       enable_forced_redirect: boolean,
+    #     },
+    #     analytics_info: {
+    #       google_play_analytics: {
+    #         utm_source: string,
+    #         utm_medium: string,
+    #         utm_campaign: string,
+    #         utm_term: string,
+    #         utm_content: string,
+    #         gclid: string
+    #       },
+    #       itunes_connect_analytics: {
+    #         at: string,
+    #         ct: string,
+    #         mt: string,
+    #         pt: string
+    #       }
+    #     },
+    #     social_meta_tag_info: {
+    #       social_title: string,
+    #       social_description: string,
+    #       social_image_link: string
+    #     }
+    #   }
+    #   result = instance.shorten_parameters(parameters, options)
+    # @return [Hash{Symbol=>String}]
+    # @see FirebaseDynamicLink::LinkRenderer#render LinkRenderer#render for returned Hash
+    def shorten_parameters(params, options = {})
+      connection.timeout = options[:timeout] if options.key?(:timeout)
+      connection.open_timeout = options[:open_timeout] if options.key?(:open_timeout)
 
-    private
+      suffix_option = options[:suffix_option] if options.key?(:suffix_option)
 
-    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
+      dynamic_link_domain ||= config.dynamic_link_domain || raise(FirebaseDynamicLink::InvalidConfig, "Dynamic link domain is empty")
 
-    def build_connection_options(c, options)
-      c.options.timeout = options.delete(:timeout) if options.key?(:timeout)
-      c.options.open_timeout = options.delete(:open_timeout) if options.key?(:open_timeout)
-      c
+      response = connection.post(nil, {
+        dynamicLinkInfo: params.merge(dynamicLinkDomain: dynamic_link_domain),
+        suffix: {
+          option: suffix_option || config.suffix_option
+        }
+      }.to_json)
+      link_renderer.render(response)
+    rescue Faraday::ConnectionFailed, Faraday::TimeoutError => e
+      raise FirebaseDynamicLink::ConnectionError, e.message
     end
 
-    def connection
-      @connection ||= Faraday::Connection.new(url: end_point,
-                                              headers: { 'Content-Type' => 'application/json' })
-    end
+    private
 
-    def config
-      ::FirebaseDynamicLink.config
-    end
+    def_delegators :@link_renderer, :render_success, :raise_error
+    def_delegators :FirebaseDynamicLink, :config
 
-    def end_point
-      "https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=#{config.api_key}"
-    end
+    attr_reader :link_renderer, :connection
 
-    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
+    def build_link(link, options)
+      dynamic_link_domain = options.delete(:dynamic_link_domain)
+      dynamic_link_domain ||= config.dynamic_link_domain || raise(FirebaseDynamicLink::InvalidConfig, "Dynamic link domain is empty")
+      "#{dynamic_link_domain}?link=#{link}"
     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']
-      }
+    def end_point
+      "https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=#{config.api_key}"
     end
   end
 end

data/lib/firebase_dynamic_link/connection.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module FirebaseDynamicLink
+  # Responsible to do HTTP request
+  class Connection
+    extend Forwardable
+
+    # @!method post
+    #   see Faraday::Connection#post
+    def_delegators :client, :post
+
+    def initialize(end_point)
+      @client = Faraday::Connection.new(url: end_point,
+                                        headers: { "Content-Type" => "application/json" })
+
+      client.options.timeout = FirebaseDynamicLink.config.timeout
+      client.options.open_timeout = FirebaseDynamicLink.config.open_timeout
+    end
+
+    # @see Faraday.timeout=
+    def timeout=(time)
+      client.options.timeout = time
+    end
+
+    # @see Faraday.timeout
+    def timeout
+      client.options.timeout
+    end
+
+    # @see Faraday.open_timeout=
+    def open_timeout=(time)
+      client.options.open_timeout = time
+    end
+
+    # @see Faraday.open_timeout
+    def open_timeout
+      client.options.open_timeout
+    end
+
+    private
+
+    attr_reader :client
+  end
+end

data/lib/firebase_dynamic_link/link_renderer.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module FirebaseDynamicLink
+  # Responsible to formatting output of Client#shorten_link
+  class LinkRenderer
+    # @param response [Faraday::Connection] http reponse
+    # @return [Hash<Symbol, String or Hash>
+    # @example
+    #   {
+    #     :link => short link result
+    #     :preview_link => preview of short link result
+    #     :warning => warning message by Firebase if present
+    #   }
+    # @raise FirebaseDynamicLink::ConnectionError if there is something wrong with Faraday request
+    # @raise FirebaseDynamicLink::QuotaExceeded if request reached Google Firebase quota
+    def render(response)
+      if response.status.between?(200, 299)
+        render_success(response)
+      elsif response.status == 429
+        raise_limit_has_reached
+      else
+        raise_error(response)
+      end
+    end
+
+    private
+
+    def render_success(response)
+      body = JSON.parse(response.body)
+      return raise_error(response) if body.key?("error")
+      {
+        link: body["shortLink"],
+        preview_link: body["previewLink"],
+        warning: body["warning"]
+      }
+    end
+
+    def raise_error(response)
+      reason = response.reason_phrase.to_s if response.respond_to?(:reason_phrase)
+      message = begin
+                  body = JSON.parse(response.body)
+                  body["error"]["message"]
+                rescue JSON::ParserError, NoMethodError
+                  response.body
+                end
+      raise FirebaseDynamicLink::ConnectionError, [reason, message].compact.join(": ")
+    end
+
+    def raise_limit_has_reached
+      raise FirebaseDynamicLink::QuotaExceeded, "Request limit has been reached"
+    end
+  end
+end

data/lib/firebase_dynamic_link/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FirebaseDynamicLink
-  VERSION = "0.1.3"
+  VERSION = "1.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firebase_dynamic_link
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
 - M Saiqul Haq
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-28 00:00:00.000000000 Z
+date: 2018-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -65,25 +65,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.2.0
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: bootsnap
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
-    - - ">="
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -105,19 +113,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.2.2
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 0.11.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 0.11.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -147,47 +155,39 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 0.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 0.16.1
 - !ruby/object:Gem::Dependency
-  name: bootsnap
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.0
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
+        version: '4.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: 4.0.0
 description: Ruby client for Firebase Dynamic Link service
 email:
 - saiqulhaq@gmail.com
@@ -204,6 +204,7 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -221,6 +222,8 @@ files:
 - gemfiles/version_2018.gemfile.lock
 - lib/firebase_dynamic_link.rb
 - lib/firebase_dynamic_link/client.rb
+- lib/firebase_dynamic_link/connection.rb
+- lib/firebase_dynamic_link/link_renderer.rb
 - lib/firebase_dynamic_link/version.rb
 homepage: https://github.com/saiqulhaq/firebase_dynamic_link
 licenses: