firebase_dynamic_link 0.1.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7bbe6a0cad3172b77570b15cff0e5b0f2fe7f269
-  data.tar.gz: ca41acc8781f8df96553abce36c10a4a17b3cf17
+SHA256:
+  metadata.gz: 8ab11d4a89e7db50a374e53454e1d065b7cfc6d066beceab4f8145ac51c93933
+  data.tar.gz: e779c35872bfc268e79482b94c6f095f6bbd3fa6dd807e174fed29b3fcbd77db
 SHA512:
-  metadata.gz: db1298ece8caed00932db3a5a0e3d6182e2c1284f797fc92635eccb9aa02c79c3da00bf00383928a6376c28532fecd22bfe36068b953179083ca3d95aba20920
-  data.tar.gz: d3b9e410ffb53da8e8b759ffe15bdd89e5764a2e5b1d104f699c3ddfc64a0328fa92e2963bc64cba32617768393f7ec140a39229bb5ae31c14b963ffb39294fd
+  metadata.gz: 1377a22e552150f5a0f25a98a3a55008331d98a485b47d13cb4ce506226d4fd3f003f686d0a475f128f174f96ff2471b82b88e0308c77c24e89e6159b4572a0b
+  data.tar.gz: 643222e3a24ad3162c4e6ba6720bc54aa595e356e54b3a4116c109f80f7fbbc62290d6bf43001d47d815d0f19e3a54e9b4e09cea09b1c6877054eaadfcd9fec1

data/.gitignore

@@ -13,3 +13,4 @@
 spec/fixtures/vcr_cassettes/
 coverage
 doc
+Gemfile.lock

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/.travis.yml

@@ -1,13 +1,14 @@
 language: ruby
 rvm:
- - 2.2
  - 2.3
  - 2.4
+ - 2.5
+ - 2.6
 gemfile:
- - gemfiles/version_2016.gemfile
- - gemfiles/version_2017a.gemfile
- - gemfiles/version_2017b.gemfile
- - gemfiles/version_2018.gemfile
+  - gemfiles/version_2018.gemfile
+  - gemfiles/version_2017b.gemfile
+  - gemfiles/version_2017a.gemfile
+  - gemfiles/version_2020.gemfile
 env:
   global:
     - CC_TEST_REPORTER_ID=22b531be7956bd878ec8ce211da98c483c9724eebc8eb72f99d064f00aa6e985
@@ -18,4 +19,6 @@ before_script:
 script:
   - COVERAGE=1 bundle exec rspec
 after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+before_install:
+  - gem install bundler

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-2020" do
+  gem "dry-configurable", "0.11.6"
+  gem "faraday", "1.0.1"
 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/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

@@ -1,3 +1,21 @@
+
+<!-- vim-markdown-toc GFM -->
+
++ [FirebaseDynamicLink](#firebasedynamiclink)
+        - [Information](#information)
+    * [Installation](#installation)
+    * [Usage](#usage)
+        - [Configure the HTTP client](#configure-the-http-client)
+        - [Shorten a link](#shorten-a-link)
+        - [Shorten parameters](#shorten-parameters)
+    * [CHANGES](#changes)
+    * [Development](#development)
+    * [Contributing](#contributing)
+    * [License](#license)
+    * [Code of Conduct](#code-of-conduct)
+
+<!-- vim-markdown-toc -->
+
 # FirebaseDynamicLink
 
 [![Build Status](https://travis-ci.org/saiqulhaq/firebase_dynamic_link.svg?branch=master)](https://travis-ci.org/saiqulhaq/firebase_dynamic_link)
@@ -9,13 +27,17 @@ Opiniated Ruby Firebase Dynamic Links Short Links client
 
 based on reference https://firebase.google.com/docs/reference/dynamic-links/link-shortener
 
+This library is considered complete and in maintenance mode. New features will be added if Firebase Dynamic Links released new updates
+
+### Information
+Travis CI build is failing because dry-configurable v0.11 is not compatible with 
+Ruby 2.3. However Bundler will install lower version if your ruby is 2.3. So there is nothing to worry about
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'firebase_dynamic_link'
-```
+    gem 'firebase_dynamic_link'
 
 And then execute:
 
@@ -30,74 +52,115 @@ 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
+      config.dynamic_link_domain = 'https://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
+```
+
+### Shorten a link
+
+```ruby
+    client = FirebaseDynamicLink::Client.new
+    link = "http://domain.com/path/path"
+    options = {
+      # optional, to override default suffix default config 
+      suffix_option: '', 
 
-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, to override default dynamic_link_domain default config
-  dynamic_link_domain: '', 
+      # optional, timeout of each request of this instance
+      timeout: 10, 
 
-  # optional, timeout of each request of this instance
-  timeout: 10, 
+      # optional, open timeout of each request of this instance
+      open_timeout: 10
+    }
 
-  # optional, open timeout of each request of this instance
-  open_timeout: 10
-}
+    # options argument is optional
+    result = client.shorten_link(link, options)
+```
 
-# options argument is optional
-result = client.shorten_link(link, options)
+### Shorten parameters
 
+```ruby
+    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)
 ```
 
 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
+
 ```ruby
-{ 
-  :link=>"https://--.app.goo.gl/ukph", 
-  :preview_link=>"https://--.app.goo.gl/ukph?d=1", 
-  :warning=>[
-       { 
-         "warningCode"=>"UNRECOGNIZED_PARAM",
-         "warningMessage"=>"..."}, 
-       {
-         "warningCode"=>"..."
-       }, 
-       {
-         "warningCode"=>"..."
-       }
-    ]
-}
+    { 
+      :link=>"https://--.app.goo.gl/ukph", 
+      :preview_link=>"https://--.app.goo.gl/ukph?d=1", 
+      :warning=>[
+           { 
+             "warningCode"=>"UNRECOGNIZED_PARAM",
+             "warningMessage"=>"..."}, 
+           {
+             "warningCode"=>"..."
+           }, 
+           {
+             "warningCode"=>"..."
+           }
+        ]
+    }
 ```
 
-otherwise it raises `FirebaseDynamicLink::ConnectionError`, with message = http error message
+otherwise it will throw `FirebaseDynamicLink::ConnectionError` error, with message = http error message
+
+## CHANGES
 
-# NOTE
+VERSION:
 
-this gem only implemented to shorten long dynamic link til now, next version is supposed to 
-be able shorten a JSON object
+* 1.0.3 
+  Update Dry-configurable dependencies to version 0.6.0
 
 ## Development