smart-app-banner 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8bd3811e5ac568dca15971f6df9ea9d20b33500
+  data.tar.gz: e15154f81aca0f4e0f58b3e01550501caa6b7ec8
+SHA512:
+  metadata.gz: 43d5c318363c1bdc0e62dd3c09ca7fd91029163335d0e469334bcdf7ca425ad2184748f0cd24f6c621d7ffb2dbbe2a658905f806ac59354569605bfb453b8876
+  data.tar.gz: cbbc8c8df079b976b18a5d5b491047f2d934a5d16d446ee7ff09018f0ba9d60dbd3142860b1f98e64d05a758733e4066c3739d606b38f3b3ad7d444db3168b7b

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.un~

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+gem 'rake'
+
+# Specify your gem's dependencies in smart-app-banner.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kristian Freeman
+
+MIT License
+
+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/README.md

@@ -0,0 +1,45 @@
+# Smart App Banner
+
+`smart-app-banner` is a Rails helper for providing [Smart App Banners](apple)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'smart-app-banner'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smart-app-banner
+
+## Usage
+
+`smart-app-banner` uses a text tag, which means it can be easily integrated into any Rails view.
+
+```erb
+<%= smart_app_banner(app_id) %>
+```
+
+As per Apple's guidelines, there are two optional arguments:
+
+```erb
+<%= smart_app_banner(app_id, { affiliate-data: "imkmf", app-argument: "from-website" } %>
+```
+
+You can read more about these [here](apple).
+
+## Contributing
+
+Pull requests always welcome!
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[apple]: https://developer.apple.com/library/ios/documentation/AppleApplications/Reference/SafariWebContent/PromotingAppswithAppBanners/PromotingAppswithAppBanners.html

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/lib/smart-app-banner.rb

@@ -0,0 +1,20 @@
+require "smart-app-banner/helper"
+require "smart-app-banner/version"
+
+module Rails
+  module SmartAppBanner
+    if defined?(::Rails::Engine)
+      class Engine < ::Rails::Engine
+        initializer 'smart-app-banner', group: :all do |app|
+          ActiveSupport.on_load(:action_controller) do
+            include Rails::SmartAppBanner::Helper
+          end
+
+          ActiveSupport.on_load(:action_view) do
+            include Rails::SmartAppBanner::Helper
+          end
+        end
+      end
+    end
+  end
+end

data/lib/smart-app-banner/helper.rb

@@ -0,0 +1,31 @@
+module Rails
+  module SmartAppBanner
+    module Helper
+      def smart_app_banner(id, options = {})
+        unless id
+          raise AppIDNotDefined
+        end
+
+        app_id = "app-id=#{ id }"
+
+        if options[:affiliate_data].nil?
+          affiliate_data = nil
+        else
+          affiliate_data = "affiliate-data=#{ options[:affiliate_data] }"
+        end
+
+        if options[:app_argument].nil?
+          app_argument = nil
+        else
+          app_argument = "app-argument=#{ options[:app_argument] }"
+        end
+
+        metadata = [app_id, affiliate_data, app_argument].
+          delete_if(&:nil?).
+          join(', ')
+
+        output = "<meta name=\"apple-itunes-app\" content=\"#{ metadata }\">"
+      end
+    end
+  end
+end

data/lib/smart-app-banner/version.rb

@@ -0,0 +1,3 @@
+module SmartAppBanner
+  VERSION = "0.0.1"
+end

data/smart-app-banner.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smart-app-banner/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "smart-app-banner"
+  gem.version       = SmartAppBanner::VERSION
+  gem.authors       = ["Kristian Freeman"]
+  gem.email         = ["kristian@kristianfreeman.com"]
+  gem.description   = %q{A Rails helper for including iTunes app 'Smart App Banners'}
+  gem.summary       = gem.description
+  gem.homepage      = "https://kristianfreeman.com"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rspec"
+end

data/spec/smart_app_banner_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Rails::SmartAppBanner::Helper do
+  let(:banner_helper) { SmartAppBannerHelperStub.new }
+  let(:id) { "389801252" }
+
+  it "should return a correct tag with an app id" do
+    output = "<meta name=\"apple-itunes-app\" content=\"app-id=389801252\">"
+    expect(banner_helper.smart_app_banner(id)).to eq(output)
+  end
+
+  it "should allow arguments" do
+    output = "<meta name=\"apple-itunes-app\" content=\"app-id=389801252, affiliate-data=foobar\">"
+    input = banner_helper.smart_app_banner(id, { affiliate_data: 'foobar' })
+    expect(input).to eq(output)
+  end
+
+  it "should fail without an id" do
+    expect {
+      banner_helper.smart_app_banner(nil)
+    }.to raise_error
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'smart-app-banner'
+require 'stub'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/stub.rb

@@ -0,0 +1,29 @@
+class SmartAppBannerHelperStub
+  include Rails::SmartAppBanner::Helper
+
+  def smart_app_banner(id, options = {})
+    unless id
+      raise AppIDNotDefined
+    end
+
+    app_id = "app-id=#{ id }"
+
+    if options[:affiliate_data].nil?
+      affiliate_data = nil
+    else
+      affiliate_data = "affiliate-data=#{ options[:affiliate_data] }"
+    end
+
+    if options[:app_argument].nil?
+      app_argument = nil
+    else
+      app_argument = "app-argument=#{ options[:app_argument] }"
+    end
+
+    metadata = [app_id, affiliate_data, app_argument].
+      delete_if(&:nil?).
+      join(', ')
+
+    output = "<meta name=\"apple-itunes-app\" content=\"#{ metadata }\">"
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: smart-app-banner
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kristian Freeman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Rails helper for including iTunes app 'Smart App Banners'
+email:
+- kristian@kristianfreeman.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/smart-app-banner.rb
+- lib/smart-app-banner/helper.rb
+- lib/smart-app-banner/version.rb
+- smart-app-banner.gemspec
+- spec/smart_app_banner_spec.rb
+- spec/spec_helper.rb
+- spec/stub.rb
+homepage: https://kristianfreeman.com
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A Rails helper for including iTunes app 'Smart App Banners'
+test_files:
+- spec/smart_app_banner_spec.rb
+- spec/spec_helper.rb
+- spec/stub.rb