ffs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6b2cff7f5daf06156fabe219da66264de966d77
+  data.tar.gz: c480256002500ddad9688520dde5517853ccd9c2
+SHA512:
+  metadata.gz: f930cdcb0188056c4b6f6ad81734c01af2f4ce4adec064c6f8aa3b2664e2e6bbbed58e4424bb61dd576f7bfda34db982ad1bf67907098786ba7f33c367894179
+  data.tar.gz: 17841838a3ed677bda01b7bfcaaa65b3487db823beb95aca415958a7110bfa0c19848d382b66b457638cd08182a5e2042a0e980b2ac74a709b15c12eb4fefa8b

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/LineLength:
+  Enabled: false
+Style/NumericLiterals:
+  Enabled: false
+Style/Documentation:
+  Enabled: false

data/Gemfile

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

data/README.md

@@ -0,0 +1,169 @@
+# FFS
+
+FFS provides a quick and flexible way to get up and running with
+[Firebase Dynamic Links](https://firebase.google.com/docs/dynamic-links/)
+through a minimal API.
+
+## Installation
+
+FFS works with Rails 4.1 onwards. Add it to your Gemfile with:
+
+```ruby
+gem 'ffs'
+```
+
+Then run `bundle install`.
+
+Next, run the generator to create the initializer:
+
+```ruby
+$ rails generate f_f_s:install
+```
+
+Once the generator completes, you will be presented with instructions to
+complete the setup of FFS. You will need to set up your application's settings
+in `config/initializers/ffs.rb`. A minimal configuration utilizing Firebase's
+link shortening and accommodating Android and iOS can be seen here:
+
+```ruby
+FFS.configure do |config|
+  # ==> General configuration
+  config.firebase_api_key = 'my_firebase_api_key'
+  config.dynamic_link_domain = 'mydomain.app.goo.gl'
+  config.suffix = 'SHORT'
+
+  # ==> Android configuration
+  config.android_package_name = 'my_package_name'
+
+  # ==> iOS configuration
+  config.ios_bundle_id = 'my_bundle_id'
+  config.ios_app_store_id = 'my_app_store_id'
+end
+```
+
+You should utilize environment variables for any API keys and other sensitive
+information you don't want made public.
+For a full explanation of each configuration option, check the
+[Firebase dynamic links documentation](https://firebase.google.com/docs/reference/dynamic-links/link-shortener).
+
+## Usage
+
+FFS provides a single public method to generate your dynamic link. After customizing the initializer to your needs, create a new instance of `FFS::Share`:
+
+```ruby
+ffs = FFS::Share.new
+```
+
+Next, call `#generate_dynamic_link`, which takes two arguments: A hash containing basic information to be displayed when your link is shared to a social network, and an optional hash to turn features off and on, depending on your needs. Here's an example utilizing `#generate_dynamic_link`'s default options:
+
+```ruby
+link_info = {
+  link: 'www.example.com/user/1',
+  socialMetaTagInfo: {
+    socialTitle: 'My Social Media Title',
+    socialDescription: 'Description of the thing being shared.',
+    socialImageLink: 'http://i.imgur.com/d5ByxBl.png'
+  }
+}
+
+ffs.generate_dynamic_link(link_info)
+```
+
+This returns a hash containing the short link and a link to view a flowchart of
+where the link will take you in a variety of situations.
+
+```ruby
+{
+  "shortLink": "https://yourdomain.app.goo.gl/randomString",
+  "previewLink": "https://yourdomain.app.goo.gl/?link=http://www.example.com&apn=com.example.hello"
+}
+```
+
+![Flowchart](http://i.imgur.com/qanlwcs.png)
+
+### Advanced Usage
+
+Imagine we have this model:
+
+```ruby
+class Author < ApplicationRecord
+  validates :name, :bio, :picture
+end
+```
+
+We want to pass this object to FFS to create a shareable link to post to Twitter.
+Since `#generate_dynamic_link` takes a hash as its first argument, it allows
+us to do this:
+
+```ruby
+walt = Author.new(
+  name: 'Walt Whitman',
+  bio: 'American poet, essayist, and journalist.',
+  picture: 'walt.jpg'
+)
+ffs = FFS::Share.new
+
+def author_info(author)
+  {
+    link: "www.example.com/author/#{author.id}",
+    socialMetaTagInfo: {
+      socialTitle: author.name,
+      socialDescription: author.bio,
+      socialImageLink: author.picture
+    }
+  }
+end
+
+link_info = author_info(walt)
+
+ffs.generate_dynamic_link(link_info)
+```
+
+### Options
+
+Below is a table of options you can pass to `#generate_dynamic_link`, along with their default value:
+
+| Option  | Default Value | Description |
+| ------------- | ------------- | ------------- |
+| android  | true | Include metadata for Android. |
+| ios | true | Include metadata for iOS. |
+| min_package | false | Restrict the dynamic link to certain app versions. (Android) |
+| ipad | false | Include separate metadata for iPad |
+| custom_scheme | false | Define a custom URL scheme for your app. (iOS) |
+| fallback | false | Provide a link to open when the app isn't installed. |
+| analytics | false | Collect analytics using Google Play and/or iTunes. |
+| bitly | false | Use Bitly for link shortening instead of Firebase. |
+
+Utilize options like this:
+
+```ruby
+ffs = FFS::Share.new
+
+# We don't need metadata for iOS, want Google Play analytics, and want to use Bitly.
+ffs.generate_dynamic_link(link_info, ios: false, analytics: true, bitly: true)
+```
+
+Detailed explanations can be found in the
+[Firebase documentation](https://firebase.google.com/docs/reference/dynamic-links/link-shortener#parameters)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/goronfreeman/ffs.
+
+## License
+
+MIT
+
+Copyright (c) 2017 Hunter Braun
+
+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/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'ffs'
+
+# 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(__FILE__)

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/ffs.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ffs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ffs'
+  spec.version       = FFS::VERSION
+  spec.authors       = ['Hunter Braun']
+  spec.email         = ['hunter.braun@gmail.com']
+
+  spec.summary       = 'Fast Firebase sharing for Ruby.'
+  spec.description   = 'Easily generate Firebase dynamic links for your Ruby application.'
+  spec.homepage      = 'https://github.com/goronfreeman/ffs'
+
+  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_dependency 'rails', '>= 4.1.0', '< 5.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/ffs.rb

@@ -0,0 +1,15 @@
+require 'ffs/configuration'
+require 'ffs/version'
+require 'ffs/share'
+require 'generators/ffs/install_generator'
+
+module FFS
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+end

data/lib/ffs/configuration.rb

@@ -0,0 +1,10 @@
+module FFS
+  class Configuration
+    attr_accessor :firebase_api_key, :bitly_api_key, :dynamic_link_domain, :suffix,
+                  :android_package_name, :android_fallback_link, :android_min_version,
+                  :ios_bundle_id, :ios_fallback_link, :ios_app_store_id,
+                  :ipad_fallback_link, :ipad_bundle_id, :custom_scheme,
+                  :utm_source, :utm_medium, :utm_campaign, :utm_term, :utm_content, :gclid,
+                  :at, :ct, :mt, :pt
+  end
+end

data/lib/ffs/share.rb

@@ -0,0 +1,115 @@
+require 'json'
+require 'net/http'
+require 'uri'
+
+module FFS
+  class Share
+    DEFAULT = {
+      android: true,
+      ios: true,
+      min_package: false,
+      ipad: false,
+      custom_scheme: false,
+      fallback: false,
+      analytics: false,
+      bitly: false
+    }.freeze
+
+    def generate_dynamic_link(hash, **options)
+      opts = DEFAULT.merge(options)
+      uri = URI.parse("https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=#{FFS.configuration.firebase_api_key}")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      headers = { 'Content-Type' => 'application/json' }
+      body = build_json_body(hash, opts)
+      res = http.post(uri, body, headers).body
+
+      return res unless opts[:bitly]
+      shorten_with_bitly(res)
+    end
+
+    private
+
+    def build_json_body(hash, opts)
+      body = base_info
+      body[:dynamicLinkInfo].merge!(hash)
+      body[:dynamicLinkInfo][:androidInfo] = build_android_info(opts) if opts[:android]
+      body[:dynamicLinkInfo][:iosInfo] = build_ios_info(opts) if opts[:ios]
+      body[:dynamicLinkInfo][:analyticsInfo] = build_analytics_info(opts) if opts[:analytics]
+      body.to_json
+    end
+
+    def base_info
+      {
+        dynamicLinkInfo: {
+          dynamicLinkDomain: FFS.configuration.dynamic_link_domain
+        },
+        suffix: {
+          option: FFS.configuration.suffix
+        }
+      }
+    end
+
+    def build_android_info(opts)
+      android_info = {
+        androidPackageName: FFS.configuration.android_package_name
+      }
+
+      android_info[:androidFallbackLink] = FFS.configuration.android_fallback_link if opts[:fallback]
+      android_info[:androidMinPackageVersionCode] = FFS.configuration.android_min_version if opts[:min_package]
+      android_info
+    end
+
+    def build_ios_info(opts)
+      ios_info = {
+        iosBundleId: FFS.configuration.ios_bundle_id,
+        iosAppStoreId: FFS.configuration.ios_app_store_id
+      }
+
+      ios_info[:iosFallbackLink] = FFS.configuration.ios_fallback_link if opts[:fallback]
+      ios_info[:iosCustomScheme] = FFS.configuration.custom_scheme if opts[:custom_scheme]
+      build_ipad_info(ios_info, opts) if opts[:ipad]
+      ios_info
+    end
+
+    def build_ipad_info(ios_info, opts)
+      ios_info[:iosIpadBundleId] = FFS.configuration.ipad_bundle_id
+      ios_info[:iosIpadFallbackLink] = FFS.configuration.ipad_fallback_link if opts[:fallback]
+    end
+
+    def build_analytics_info(opts)
+      analytics = {}
+      analytics[:googlePlayAnalytics] = build_google_play_analytics(body) if opts[:android]
+      analytics[:itunesConnectAnalytics] = build_itunes_connect_analytics(body) if opts[:ios]
+      analytics
+    end
+
+    def build_google_play_analytics
+      {
+        utmSource: FFS.configuration.utm_source,
+        utmMedium: FFS.configuration.utm_medium,
+        utmCampaign: FFS.configuration.utm_campaign,
+        utmTerm: FFS.configuration.utm_term,
+        utmContent: FFS.configuration.utm_content,
+        gclid: FFS.configuration.gclid
+      }
+    end
+
+    def build_itunes_connect_analytics
+      {
+        at: FFS.configuration.at,
+        ct: FFS.configuration.ct,
+        mt: FFS.configuration.mt,
+        pt: FFS.configuration.pt
+      }
+    end
+
+    def shorten_with_bitly(res)
+      long_link = JSON.parse(res)['previewLink'].gsub(/&d=1/, '').gsub(/&/, '%26')
+      uri = URI.parse("https://api-ssl.bitly.com/v3/shorten?access_token=#{FFS.configuration.bitly_api_key}&longUrl=#{long_link}")
+      res = JSON.parse(Net::HTTP.get(uri))
+
+      res['data']['url']
+    end
+  end
+end

data/lib/ffs/version.rb

@@ -0,0 +1,3 @@
+module FFS
+  VERSION = '0.1.0'.freeze
+end

data/lib/generators/ffs/install_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators'
+
+module FFS
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+      desc 'Creates FFS initializer for your application'
+
+      def copy_initializer
+        template 'initializer.rb', 'config/initializers/ffs.rb'
+      end
+
+      def show_readme
+        readme 'README'
+      end
+    end
+  end
+end

data/lib/generators/templates/README

@@ -0,0 +1,16 @@
+===============================================================================
+
+Some setup you must do manually if you haven't yet:
+
+  Modify config/initializers/ffs.rb to suit your application's needs.
+  Full documentation for each configuration option can be found here:
+  https://firebase.google.com/docs/reference/dynamic-links/link-shortener
+
+  You should store any sensitive information in environment variables that you
+  do not check into version control:
+
+    FFS.configure do |config|
+      config.firebase_api_key = Rails.application.secrets.firebase[:api_key]
+    end
+
+===============================================================================

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,68 @@
+# Use this hook to configure API keys, Android package info, iOS bundle info,
+# and analytics info. Many of these configuration options are not required,
+# and depend on how you you initialize FFS. Please check the README for more info.
+# Full documentation for each configuration option can be found here:
+# https://firebase.google.com/docs/reference/dynamic-links/link-shortener
+FFS.configure do |config|
+  # ==> General configuration
+  # Configure the project ID associated with your Firebase project.
+  # You can find your project ID in your project's Firebase console.
+  config.firebase_api_key = 'api_key'
+
+  # Optionally configure your Bitly API key to use Bitly link shortening,
+  # instead of the default Firebase link shortening.
+  # config.bitly_api_key = 'api_key'
+
+  # Configure your Firebase project's Dynamic Links domain.
+  # You can find this value in the Dynamic Links section of the Firebase console.
+  config.dynamic_link_domain = 'dynamic_link_domain'
+
+  # Configure the length of the generated short link.
+  # Only needed when using the Firebase link shortener.
+  # Allowed options are 'SHORT' and 'UNGUESSABLE'.
+  config.suffix = 'SHORT'
+
+  # ==> Android configuration
+  # Configure the package name of the Android app to use to open the link.
+  config.android_package_name = 'android_package_name'
+
+  # Configure the link to open when the app isn't installed.
+  # config.android_fallback_link = 'android_fallback_link'
+
+  # Configure the versionCode of the minimum version of your app that can open the link.
+  # config.android_min_version = 'android_min_version'
+
+  # ==> iOS configuration
+  # Configure the bundle ID of the iOS app to use to open the link.
+  config.ios_bundle_id = 'ios_bundle_id'
+
+  # Configure your app's App Store ID.
+  config.ios_app_store_id = 'ios_app_store_id'
+
+  # Configure the link to open when the app isn't installed.
+  # config.ios_fallback_link = 'ios_fallback_link'
+
+  # Configure the link to open on iPads when the app isn't installed.
+  # config.ipad_fallback_link = 'ipad_fallback_link'
+
+  # Configure the bundle ID of the iOS app to use on iPads to open the link.
+  # config.ipad_bundle_id = 'ipad_bundle_id'
+
+  # Configure your app's custom URL scheme, if defined to be something other than your app's bundle ID
+  # config.custom_scheme = 'custom_scheme'
+
+  # ==> Analytics configuration
+  # Configure your Google Play analytics parameters.
+  # config.utm_source = 'utm_source'
+  # config.utm_medium = 'utm_medium'
+  # config.utm_campaign = 'utm_campaign'
+  # config.utm_term = 'utm_term'
+  # config.utm_content = 'utm_content'
+  # config.gclid = 'gclid'
+
+  # Configure your iTunes Connect analytics parameters.
+  # config.at = 'at'
+  # config.ct = 'ct'
+  # config.mt = 'mt'
+  # config.pt = 'pt'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: ffs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hunter Braun
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+description: Easily generate Firebase dynamic links for your Ruby application.
+email:
+- hunter.braun@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ffs.gemspec
+- lib/ffs.rb
+- lib/ffs/configuration.rb
+- lib/ffs/share.rb
+- lib/ffs/version.rb
+- lib/generators/ffs/install_generator.rb
+- lib/generators/templates/README
+- lib/generators/templates/initializer.rb
+homepage: https://github.com/goronfreeman/ffs
+licenses: []
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Fast Firebase sharing for Ruby.
+test_files: []