quokka 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd9aa8d1139f22330ee6b422e9e9b48bd3f0f977
+  data.tar.gz: 7943be07a23d26ff4b368433918fb48bd1a24035
+SHA512:
+  metadata.gz: 58a14e256b889eb5d18ef8bd8765e02dde05ecae5a7c9ae18b897022e2fa1af8a22352f1034ffd947645413df7c064b3db0001fb1d3a4daf711d59fc383b1f2d
+  data.tar.gz: 53b1ad917a95fa331f29c79430e97c9b41fca2e776a59a15fc7fbfde216b994953e619142c48ed60a5d28743ed48132dd4427b1ce4929547285e24d40b733fd0

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,5 @@
+require: rubocop-rspec
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at tom@tomkruijsen.nl. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tom Kruijsen
+
+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,52 @@
+# Quokka [![Build Status](https://travis-ci.org/tomkr/quokka.svg?branch=master)](https://travis-ci.org/tomkr/quokka)
+
+Quokka provides tools to make logging in with Facebook from your server a breeze.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'quokka'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install quokka
+
+## Usage
+
+The Facebook login flow has a couple of steps that Quokka can help you out with.
+
+First you need to setup your app id and secret by specifying them in the env variables `FACEBOOK_APP_ID` and `FACEBOOK_SECRET`.
+
+Next your web application will need to redirect to a dialog url created by:
+
+    Quokka.login_dialog_url(redirect_uri)
+
+Facebook will redirect to your redirect uri with a `code` parameter. Pass this to `access_token` to get the required token.
+
+    access_token = Quokka.access_token(redirect_uri, code)
+
+Now you can use the `access_token` you received to get user data from Facebook.
+
+    Quokka.user_data(access_token)
+
+## 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/tomkr/quokka. 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

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

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/lib/quokka.rb

@@ -0,0 +1,80 @@
+require "open-uri"
+require "addressable/template"
+require "quokka/version"
+
+# Tools for logging in with Facebook
+module Quokka
+  GRAPH_URI = Addressable::URI.parse(
+    "https://graph.facebook.com/v2.6/"
+  )
+  LOGIN_URI = Addressable::Template.new(
+    "https://www.facebook.com/dialog/oauth{?q*}"
+  )
+
+  module_function
+
+  # Constructs a url that will open a login dialog on Facebook that requests
+  # permission for your app.
+  #
+  # @param redirect_uri URI which Facebook will redirect to after login
+  #
+  # @return [String] URL to Facebook login dialog
+  def login_dialog_url(redirect_uri)
+    LOGIN_URI.expand(
+      q: {
+        client_id: ENV.fetch("FACEBOOK_APP_ID"),
+        redirect_uri: redirect_uri
+      }
+    ).to_s
+  end
+
+  # Gets the hash with access token data from Facebook, based on the
+  # redirect_uri used in the login dialog and the code that was returned from
+  # it.
+  #
+  # @param redirect_uri URI which Facebook redirected to after login
+  # @param code The code provided by Facebook
+  #
+  # @return [Hash] Hash with access token data from Facebook
+  def access_token_data(redirect_uri, code)
+    read_json_from_url(graph_url("oauth/access_token",
+                                 client_id: ENV.fetch("FACEBOOK_APP_ID"),
+                                 client_secret: ENV.fetch("FACEBOOK_SECRET"),
+                                 code: code,
+                                 redirect_uri: redirect_uri))
+  end
+
+  # Gets the hash with access token data from Facebook, based on the
+  # redirect_uri used in the login dialog and the code that was returned from
+  # it and returns only the access token itself.
+  #
+  # @param redirect_uri URI which Facebook redirected to after login
+  # @param code The code provided by Facebook
+  #
+  # @return [String] The access token data from Facebook
+  def access_token(redirect_uri, code)
+    access_token_data(redirect_uri, code)["access_token"]
+  end
+
+  # Gets a hash of data for the user logged in with the access token. This
+  # allows you to get the details of the logged in user for further usage.
+  #
+  # @param access_token The token provided by Facebook
+  #
+  # @return [Hash] The data for the logged in user
+  def user_data(access_token)
+    read_json_from_url(graph_url("me", access_token: access_token))
+  end
+
+  def graph_url(path, query)
+    uri = GRAPH_URI.join(path)
+    uri.query_values = query
+    uri.to_s
+  end
+  private_class_method :graph_url
+
+  def read_json_from_url(url)
+    JSON.parse(open(url).read)
+  end
+  private_class_method :read_json_from_url
+end

data/lib/quokka/version.rb

@@ -0,0 +1,3 @@
+module Quokka
+  VERSION = "0.1.0".freeze
+end

data/quokka.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "quokka/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "quokka"
+  spec.version       = Quokka::VERSION
+  spec.authors       = ["Tom Kruijsen"]
+  spec.email         = ["tom@tomkruijsen.nl"]
+
+  spec.summary       = "Tools for logging in with Facebook."
+  spec.description   = <<-EOF
+    Quokka provides tools to make logging in with Facebook from your server a
+    breeze.
+  EOF
+  spec.homepage      = "http://github.com/tomkr/quokka"
+  spec.license       = "MIT"
+
+  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 "addressable", "~> 2.4"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop-rspec", "~> 1.5"
+  spec.add_development_dependency "rubocop", "~> 0.40"
+  spec.add_development_dependency "simplecov", "~> 0.11"
+  spec.add_development_dependency "webmock", "~> 2.1"
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: quokka
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Kruijsen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: |2
+      Quokka provides tools to make logging in with Facebook from your server a
+      breeze.
+email:
+- tom@tomkruijsen.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/quokka.rb
+- lib/quokka/version.rb
+- quokka.gemspec
+homepage: http://github.com/tomkr/quokka
+licenses:
+- MIT
+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.1
+signing_key: 
+specification_version: 4
+summary: Tools for logging in with Facebook.
+test_files: []