Project

rack-smart-app-banner

0.03
Repository is archived
No commit activity in last 3 years
No release in over 3 years
rack-smart-app-bannermattt/rack-smart-app-bannerHomepageDocumentationSource CodeBug Tracker
Rack middleware to automatically include code for Smart App Banner, introduced in iOS 6.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
6,274
Stars
85
Forks
2
Watchers
4
 Releases
Current version
0.1.0
Total releases
2
First release
2012-09-21
Latest release
2019-07-08
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2017-08-01
Reverse Dependencies
0

 Dependencies

Development

minitest
~> 2.11
rack-test
~> 0.6
rake
>= 0

Runtime

rack
>= 1.2.0, < 2.0.0
 Project Readme

rack-smart-app-banner

Rack middleware to automatically include code for Smart App Banners on iOS

This project is no longer maintained.

Make it easy for users to discover and download your app from a website on iOS. With Safari’s Smart App Banner you can display a banner that provides a direct link to your app on the App Store, or opens the app if the user already has it installed. Smart App Banners integrate seamlessly, have the same look and feel users know from the App Store, and are easy to implement. Resources - Safari - Apple Developer

Requirements

  • Ruby 1.9 or higher

Installation

Gemfile

gem 'rack-smart-app-banner', require: 'rack/smart-app-banner'

Usage

use Rack::SmartAppBanner, app_id: "123456789",
                          affiliate_partner_id: 42,
                          affiliate_site_id: "abcdef123456",
                          app_argument: lambda { |request| request.path }

Include this in the config.ru file of your Rack application, to inject a corresponding <meta> tag into the <head> of each HTML document.

<meta
  name="apple-itunes-app"
  content="app-id=123456789, affiliate-data=partnerId=42&siteID=abcdef123456 app-argument=http://listings/123"
/>

Parameters

  • app_id: Required. Your app's unique identifier. To find your app ID from the iTunes Link Maker, type the name of your app in the Search field, and select the appropriate country and media type. In the results, find your app and select iPhone App Link in the column on the right. Your app ID is the nine-digit number in between id and ?mt.
  • affiliate_partner_id & affiliate_site_id: Optional. Your iTunes affiliate details, if you are an iTunes affiliate. If you aren't, you can find out more about becoming an iTunes affiliate at http://www.apple.com/itunes/affiliates/.
  • app_argument: Optional. A block that generates a URL that provides context to your native app. If you include this and the user has your app installed, they can jump from your website to the corresponding position in your iOS app.

Contact

Mattt

License

rack-smart-app-banner is available under the MIT license. See the LICENSE file for more info.