mapkit_token 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 45bea3e3d390b755069255b64c3d7feb217d8c724db38c3030403d1449cd01d9
+  data.tar.gz: ab38b4f43b735ce4ecd7ddca3d1a1a1453f6430489c85d1c2381b5ec71302413
+SHA512:
+  metadata.gz: 3cae35f9190898e2101da404c1deeb600fa72d2a9d9d11a39b7c1fec7a7270bd2d78bcdace8156c00b5e11ed6a725e1d3094a595c4692bb14e49c29fe36e720f
+  data.tar.gz: d822fe17f5db923ce272321a6ecee1a403337f46b1e45ad24517b62e2a50c68823fa3bd75fb614b424a13614e38d69aa5dff68e67b919d75d591d63f711ed9e5

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at medlund@mac.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mapkit_token.gemspec
+gemspec

data/README.md

@@ -0,0 +1,84 @@
+# MapKit Token
+
+MapKit JS uses JSON Web Tokens (JWTs) to authenticate map initializations and other API requests. This gem adds an endpoint to a Rails applications to provide MapKit JS with such authentication JWTs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mapkit_token'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mapkit_token
+
+## Usage
+
+Before you can use this gem, you need a Maps Identifer (i.e., Maps ID) and private key that is associated to a Maps ID. If you haven't yet done that, read more about how to do that here:
+
+[Creating a Maps Identifier and a Private Key](https://developer.apple.com/documentation/mapkitjs/creating_a_maps_identifier_and_a_private_key)
+
+Add your AuthKey to your application folder, and make sure you have these pieces of information:
+
+- Path to AuthKey
+- MapKit JS Key ID
+- Apple Developer Team ID
+
+Edit your application credentials:
+
+    $ EDITOR=vim rails credentials:edit
+
+In case you have different AuthKey files for your different environments, edit your environment credentials separately:
+
+    $ EDITOR=vim rails credentials:edit --environment development
+
+Add your credentials:
+
+```yaml
+mapkit:
+  auth_key_path: AuthKey_XXXXXXXXXX.p8
+  auth_key_id: XXXXXXXXXX
+  apple_team_id: XXXXXXXXXX
+```
+
+After reloading your application, it will have a new endpoint `/mapkit_token` that returns JWTs that are valid for 30 minutes. The application's hostname is added to the JWT payload to specify that the tokens only can used by the application itself. 
+
+Use the endpoint for the `authorizationCallback` function that MapKit JS calls whenever it detects that a new token is needed.
+
+```html
+<!DOCTYPE html>
+<html>
+...
+<div id="map" style="width: 800px; height: 600px;"></div>
+<script src="https://cdn.apple-mapkit.com/mk/5.0.x/mapkit.js"></script>
+<script>
+mapkit.init({ authorizationCallback: function(done) { fetch("/mapkit_token")
+    .then(res => res.text())
+    .then(token => done(token)) /* If successful, return your token to MapKit JS */ 
+    .catch(error => { /* Handle error */ });
+}});
+let map = new mapkit.Map("map", { center: new mapkit.Coordinate(59.329, 18.068) }); 
+</script>
+...
+</html>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mapkit_token. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the MapkitToken project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/mapkit_token/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/app/controllers/mapkit_token/mapkit_token_controller.rb

@@ -0,0 +1,28 @@
+module MapkitToken
+  class MapkitTokenController < ApplicationController
+
+    def mapkit
+      Rails.application.credentials.mapkit
+    end
+
+    def auth_key
+      File.read(mapkit[:auth_key_path])
+    end
+
+    def auth_key_id
+      mapkit[:auth_key_id]
+    end
+
+    def apple_team_id
+      mapkit[:apple_team_id]
+    end
+
+    def base_url
+      request.protocol + request.host
+    end
+
+    def show
+      render plain: Mapkit.token.generate(auth_key: auth_key, auth_key_id: auth_key_id, apple_team_id: apple_team_id, base_url: base_url)
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mapkit_token"
+
+# 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/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  get '/mapkit_token', to: 'mapkit_token/mapkit_token#show'
+end

data/lib/mapkit_token.rb

@@ -0,0 +1,15 @@
+require "active_support/all"
+require "mapkit_token/version"
+require "mapkit_token/app/models/mapkit.rb"
+require "jwt"
+
+module MapkitToken
+  mattr_accessor :app_root
+
+  def self.setup
+    yield self
+  end
+end
+
+require "mapkit_token/engine"
+

data/lib/mapkit_token/app/models/mapkit.rb

@@ -0,0 +1,25 @@
+class Mapkit
+  @@instance = Mapkit.new
+  private_class_method :new
+
+  def self.token
+    return @@instance
+  end
+
+  def generate *args
+    return nil unless (creds = args.first).is_a?(Hash)
+
+    auth_key = creds[:auth_key]
+    auth_key_id = creds[:auth_key_id]
+    apple_team_id = creds[:apple_team_id]
+    base_url = creds[:base_url]
+    lifespan_seconds = creds[:lifespan] ||= 1800
+
+    header = {kid: auth_key_id, typ: "JWT", alg: "ES256"}
+    payload = {iss: apple_team_id, iat: DateTime.now.to_i, exp: DateTime.now.to_i + lifespan_seconds, origin: base_url}.compact
+    private_key = OpenSSL::PKey::EC.new(auth_key)
+    return JWT.encode payload, private_key, algorithm='ES256', header
+  end
+end
+
+

data/lib/mapkit_token/engine.rb

@@ -0,0 +1,4 @@
+module MapkitToken
+  class Engine < Rails::Engine
+  end
+end

data/lib/mapkit_token/version.rb

@@ -0,0 +1,3 @@
+module MapkitToken
+  VERSION = "1.0.0"
+end

data/mapkit_token.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mapkit_token/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mapkit_token"
+  spec.version       = MapkitToken::VERSION
+  spec.authors       = ["Michael Edlund"]
+  spec.email         = ["medlund@mac.com"]
+
+  spec.summary       = %q{MapKit JS token endpoint provider.}
+  spec.homepage      = "https://github.com/arcticleo/mapkit_token"
+
+  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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "rails"
+  spec.add_dependency "jwt"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: mapkit_token
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michael Edlund
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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: 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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- medlund@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- app/controllers/mapkit_token/mapkit_token_controller.rb
+- bin/console
+- bin/setup
+- config/routes.rb
+- lib/mapkit_token.rb
+- lib/mapkit_token/app/models/mapkit.rb
+- lib/mapkit_token/engine.rb
+- lib/mapkit_token/version.rb
+- mapkit_token.gemspec
+homepage: https://github.com/arcticleo/mapkit_token
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: MapKit JS token endpoint provider.
+test_files: []