omnitoken 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ace4482f49697143d37ce315b327c2a84ed71b3
+  data.tar.gz: 99e1e737d587e96b9a4ee7519e44df1a0161ff19
+SHA512:
+  metadata.gz: 20970c131a123db1d4f48830429703e4fb3b191d770c2b47383a99f60529fc99e0167ba5a7c6e3705020c9af4507d5d07f10f1156ef55d009d44526b7a8ed6c7
+  data.tar.gz: 508f29a138b1c193e26658082e036ec4424c7c552441195c6d7adcb01104ea081fc72366776c1085611fa43c259d37124631b9f489adb89534e064ec402100a3

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# OmniToken Changelog
+
+## v0.0.1
+* First alphaish release as a gem.
+* Twitter and Facebook are supported.

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+gem 'sinatra'
+gem 'haml'
+gem 'omniauth'
+
+group :development do
+  gem 'rack-test'
+end

data/README.md

@@ -0,0 +1,70 @@
+# OmniToken
+
+## Introduction
+OmniToken is a handy tool for getting OAuth tokens from multiple providers. It brings up a web page interface which lists the popular "Login with XXX" social buttons and displays the token and other basic information after user finishes the authentication flow.
+
+It is a tiny Sinatra-based web application.
+
+It heavily relies on [OmniAuth](https://github.com/intridea/omniauth) and its strategies. Theoretically, any OAuth provider can be supported as long as there is a OmniAuth strategy for it. It can be easily achieved by installing the startegy gem and adding a config file.
+
+## Get Started
+To install the latest stable version, run:
+
+`gem install omnitoken`
+
+After the gem and its dependencies are installed, run:
+
+`omnitoken -s`
+
+A web server is started. Visit `http://localhost:4567` in the web browser and you will see a page with the "No OAuth providers are configured." message.
+
+Follow next section to add some providers. You need to restart the web server after adding new providers.
+
+## Add Providers
+To get the token from a provider, a tiny configuration file is required. OmniToken has been tested with following providers and a configuration template is shipped for each of them:
+* Twitter
+* Facebook
+
+### Twitter
+First, install the twitter strategy gem:
+
+`gem install omniauth-twitter`
+
+Copy the twitter template by running:
+
+`omnitoken -a twitter`
+
+A `twitter.yml` file will be created in `providers` folder in your working directory. Open it using your favorite editor and fill the fileds. The values can be found on your twitter application page you registered beforehand.
+
+### Facebook
+First, install the facebook strategy gem:
+
+`gem install omniauth-facebook`
+
+Copy the facebook template by running:
+
+`omnitoken -a facebook`
+
+A `facebook.yml` file will be created in `providers` folder in your working directory. Open it using your favorite editor and fill the fileds. The values can be found on your facebook application page you registered beforehand.
+
+### Others
+Theoretically, OmniToken can be support any provider as long as there is a OmniAuth strategy for it. Please follow these steps to add a provider which doesn't have a shipped template.
+
+First, find and install the strategy gem for your provider. Assume it is `omniauth-example`.
+
+`gem install omniauth-example`
+
+Create a file named `example.ym` and put it in `providers` folder under your working directory. **NOTE: all providers configuration file should be put in `providers`.**
+
+Refer to startegies' documentation and get the required argumements. Add a corresponding value to each argument. For example, the arguments are `foo` and `bar`. The `example.yml` should look like this:
+
+```yaml
+foo: "xxx"
+bar: "xxx"
+```
+
+## Supported Ruby Versions
+OmniToken is tested under 2.0.0.
+
+## License
+Copyright (c) 2013-2014 Minjie Zha. See [LICENSE](https://github.com/magic003/omnitoken/blob/master/LICENSE-MIT) for details.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake'
+require 'rake/testtask'
+
+task :default => [:test]
+
+desc "Run unit tests"
+Rake::TestTask.new("test") do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/bin/omnitoken

@@ -0,0 +1,103 @@
+#!/usr/bin/env ruby
+
+# This is the script for running OmniToken application.
+#
+# Usage:
+#   omnitoken [options]
+#   Options:
+#     -a, --add name1,name2,nameN
+#                           Add the config template for specified OAuth providers
+#     -s, --server          Start the web server
+#     -h, --help            Display this help message
+#     -v, --version         Show OmniToken version
+#
+# Author::      Minjie Zha (mailto:minjiezha@gmail.com)
+# Copyright::   Copyright (c) 2013-2014 Minjie Zha
+
+require 'optparse'
+
+begin
+  require 'omnitoken_app'
+rescue LoadError
+  require File.join(File.expand_path(File.dirname(__FILE__)), *%w[.. omnitoken_app])
+end
+
+# Add provider templates.
+def on_add(names)
+  return if names.nil?
+  provider_dir = OmniTokenApp::PROVIDER_DIR
+  # create the providers folder if it doesn't exist
+  unless names.empty? || Dir.exists?(provider_dir)
+    $stdout.puts "Creating #{provider_dir} folder"
+    Dir.mkdir(provider_dir) 
+  end
+
+  template_dir = File.join(
+                    File.expand_path(File.dirname(__FILE__)), 
+                    *%w[.. templates])
+  names.each do |n|
+    file = "#{n.downcase}.yml"
+    # check if the template file is available
+    unless File.exists?(File.join(template_dir, file))
+      $stderr.puts "Template for #{n} is not available. "\
+        "Please follow the OmniToken README to create its config file."
+      next
+    end
+
+    # check if the config file is already there
+    if File.exists?(File.join(provider_dir, file))
+       overwrite = loop do
+         $stdout.print("File #{file} already exists. Overwrite it?(y/Y/n/N):")
+         ans = $stdin.gets.chomp
+         break true if 'y'.eql?(ans.downcase)
+         break false if 'n'.eql?(ans.downcase)
+       end 
+       next unless overwrite
+    end
+
+    # copy the template file
+    $stdout.puts "Copying template #{file}"
+    FileUtils.cp(File.join(template_dir, file),
+                 File.join(provider_dir, ''))
+  end
+end
+
+# Starts the web server.
+def on_server()
+    puts 'Starting OmniToken web server'
+    OmniTokenApp.run!
+end
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: omnitoken [options]"
+
+  opts.separator ""
+  opts.separator "Options:"
+
+  opts.on('-a', '--add name1,name2,nameN', Array, 'Add the config template for specified OAuth providers') do |names|
+    on_add(names)
+    exit
+  end
+
+  opts.on('-s', '--server', 'Start the web server') do
+    on_server()
+    exit
+  end
+
+  opts.on_tail('-h', '--help', 'Display this help message') do
+    puts opts
+    exit
+  end
+
+  opts.on_tail('-v', '--version', 'Show OmniToken version') do
+    puts OmniTokenApp::VERSION
+    exit
+  end
+
+  opts.on() do
+    puts opts
+    exit
+  end
+
+end.parse!
+

data/config.ru

@@ -0,0 +1,3 @@
+puts $:
+require File.dirname(__FILE__) + '/omnitoken_app'
+run OmniTokenApp

data/omnitoken_app.rb

@@ -0,0 +1,124 @@
+require 'sinatra/base'
+require 'haml'
+require 'omniauth'
+
+require 'yaml'
+
+# This is the Sinatra application for getting tokens.
+class OmniTokenApp < Sinatra::Base
+  # version number 
+  VERSION = '0.0.1'
+
+  # configuration folder for various OAuth providers
+  PROVIDER_DIR = 'providers'
+
+  enable :sessions
+  set :haml, {:format => :html5, :layout => :layout}
+
+  before '/*' do
+    # load providers and save in the application level
+    if !settings.respond_to?(:providers) || settings.providers.nil?
+      load_providers()
+      self.class.set :providers, @providers
+    else
+      @providers = settings.providers
+    end
+  end
+
+  # home page
+  get '/' do
+    haml :index
+  end
+
+  # callback route for providers
+  get "#{OmniAuth.config.path_prefix}/:provider/callback" do |p|
+    auth = env['omniauth.auth']
+    provider = get_provider(p)
+    not_found if provider.nil?
+    # get the arguments and provided values for the provider
+    args = {}
+    p_args = provider[:args].dup
+    provider[:klass].args.each do |arg|
+      args[arg] = p_args.shift
+    end
+    haml :results, :locals => { auth: env['omniauth.auth'], args: args}
+  end
+
+  # OAuth failure route
+  get "#{OmniAuth.config.path_prefix}/failure" do
+    [400, haml(:error, :locals => { message: params[:message] })]
+  end
+
+  not_found do
+    [404, haml(:error, :locals => { message: "Page Not Found" })]
+  end
+
+
+  private
+
+  # Gets the loaded provider by name
+  def get_provider(name)
+    provider = nil
+    @providers.each do |p|
+      provider = p if p[:id].eql?(name.to_sym)
+    end
+    provider
+  end
+
+  # Loads providers from the configuration files
+  def load_providers
+    @providers = []
+    Dir.glob(File.join(PROVIDER_DIR, '*.yml')) do |file|
+      name = File.basename(file, '.yml').to_sym
+      # require ruby files for the strategy
+      strategy = require_strategy(name)
+      @providers << { id: name,
+                      display_name: OmniAuth::Utils.camelize(name),
+                      path: "#{OmniAuth.config.path_prefix}/#{name}",
+                      args: read_strategy_arg(strategy, file),
+                      klass: strategy
+                    }
+    end
+
+    # set the strategies as a middleware
+    use_strategy_middleware
+  end
+
+  # Sets the OmniAuth builder as a middleware
+  def use_strategy_middleware
+    providers = @providers
+    self.class.use OmniAuth::Builder do
+      providers.each do |p|
+        provider p[:id], *p[:args]
+      end
+    end
+  end
+
+  # Reads the arguments for a strategy from the configuration file.
+  def read_strategy_arg(strategy, file) 
+    args = []
+    yaml = YAML::load(File.open(file))
+    strategy.args.each do |arg|
+      if yaml[arg.to_s].nil?
+        fail "The #{arg} argument is not provided in #{file}."
+      else
+        args << yaml[arg.to_s]
+      end
+    end
+    args
+  end
+
+  # Requires the ruby file for a strategy.
+  def require_strategy(name)
+    begin
+      require "omniauth-#{name}"
+      OmniAuth::Strategies.const_get(OmniAuth::Utils.camelize(name))
+    rescue LoadError => e
+      fail e, "Could not find matching strategy for #{name}. You may need to install an additional gem (such as omniauth-#{name})."
+    end
+  end
+
+  # Run this application
+  run! if app_file == $0
+
+end

data/public/style.css

@@ -0,0 +1,146 @@
+/* global */
+body {
+    font-family: Helvetica, Arial, sans-serif;
+    color: #333333;
+    font-size: 14px;
+    line-height: 1.5;
+    background: none repeat scroll 0 0 #F9F9F9;
+}
+
+h1 {
+    font-size: 80px;
+    line-height: 1.15;
+}
+
+h2 {
+    font-size: 2em;
+    line-height: 1.15;
+}
+
+a {
+    text-decoration: none;
+}
+
+/* layout */
+#container {
+    margin: 0 auto;
+}
+
+/* the social buttons styles are copied from https://grove.io/login */
+#social_buttons {
+    width: 460px;
+    background: none repeat scroll 0 0 white;
+    border-radius: 5px 5px 5px 5px;
+    box-shadow: 0 1px 5px rgba(0, 0, 0, 0.2);
+    margin: 40px auto 20px;
+    padding: 30px;
+}
+
+#social_buttons h2 {
+    border-bottom: 1px solid #F0F0F0;
+    margin-bottom: 20px;
+    margin-top: 0;
+    padding-bottom: 10px
+}
+
+#social_buttons ul {
+    text-align: center;
+    list-style: none outside none;
+    margin: 5px;
+    padding: 5px;
+}
+
+#social_buttons li {
+    margin: 20px;
+    padding-bottom: 15px;
+}
+
+/* This button style is copied from bitbucket's Create repository button */
+.connect_button, .connect_buton:visited {
+    font-size: 16px;
+    -moz-box-sizing: border-box;
+    background: linear-gradient(to bottom, #FFFFFF 0%, #F2F2F2 100%) repeat scroll 0 0 transparent;
+    border: 1px solid #CCCCCC;
+    border-radius: 3.01px 3.01px 3.01px 3.01px;
+    color: #333333;
+    cursor: pointer;
+    display: inline-block;
+    padding: 4px 20px;
+    text-decoration: none;
+    text-shadow: 0 1px 0 white;
+    vertical-align: baseline;
+    white-space: nowrap;
+    box-shadow: 0 2px 4px rgba(0, 0, 0, 0.2);
+    width: 200px;
+}
+
+.connect_button:hover {
+    background: linear-gradient(to bottom, #FFFFFF 0%, #F7F7F7 100%) repeat scroll 0 0 transparent;
+    border-color: #999999;
+    color: #000000;
+    text-decoration: none;
+}
+
+.connect_button:active {
+    background-color: #F2F2F2;
+    background-image: none;
+    box-shadow: 0 3px 6px rgba(0, 0, 0, 0.1) inset;
+    text-decoration: none;
+    text-shadow: none;
+}
+
+.connect_button em {
+    font-style: normal;
+    font-weight: bold;
+}
+
+#error {
+    text-align: center;
+    margin: 40px auto 20px;
+    padding: 30px;
+}
+
+#error p {
+    font-size: 20px;
+    font-style: bold;
+}
+
+#results {
+    width: 660px;
+    background: none repeat scroll 0 0 white;
+    border-radius: 5px 5px 5px 5px;
+    box-shadow: 0 1px 5px rgba(0, 0, 0, 0.2);
+    margin: 40px auto 20px;
+    padding: 30px;
+}
+
+#results h2 {
+    border-bottom: 1px solid #F0F0F0;
+    margin-bottom: 20px;
+    margin-top: 0;
+    padding-bottom: 10px
+}
+
+#results table {
+    width: 100%;
+    border-spacing: 0;
+    table-layout: fixed;
+}
+
+#results td {
+    padding: 8px 0;
+    border-bottom: 1px solid #F0F0F0;
+    word-wrap: break-word;
+}
+
+#results td:first-child {
+    width: 30%;
+}
+
+#results tr:hover td {
+    background: none repeat scroll 0 0 #F8F8F8;
+}
+
+#results a {
+   float: right; 
+}

data/templates/facebook.yml

@@ -0,0 +1,2 @@
+client_id: "CLIENT_ID"
+client_secret: "CLIENT_SECRET"

data/templates/twitter.yml

@@ -0,0 +1,2 @@
+consumer_key: "CONSUMER_KEY"
+consumer_secret: "CONSUMER_SECRET"

data/test/helper.rb

@@ -0,0 +1,10 @@
+ENV['RACK_ENV'] = 'test'
+require 'minitest/autorun'
+require 'rack/test'
+
+begin
+  require 'omnitoken_app'
+rescue LoadError
+  require File.join(File.expand_path(File.dirname(__FILE__)), %w{.. omnitoken_app})
+end
+

data/test/omnitoken_app_test.rb

@@ -0,0 +1,14 @@
+require File.expand_path(File.dirname(__FILE__)) + '/helper'
+
+include Rack::Test::Methods
+
+def app
+  OmniTokenApp
+end
+
+describe 'OmniToken app' do
+  it "should show the home page" do
+    get '/'
+    assert_equal 200, last_response.status
+  end
+end

data/views/error.haml

@@ -0,0 +1,3 @@
+#error
+  %h1 Oops!
+  %p= message

data/views/index.haml

@@ -0,0 +1,11 @@
+#social_buttons 
+  %h2 OmniToken
+  - if @providers.nil? || @providers.empty?
+    No OAuth providers are configured.
+  - else
+    %ul
+      - @providers.each do |p|
+        %li
+          %a.connect_button{title: "Login with #{p[:display_name]}", href: "#{p[:path]}"}
+            Login with
+            %em= p[:display_name]

data/views/layout.haml

@@ -0,0 +1,10 @@
+!!! 5
+%html{lang: 'en'}
+  %head
+    %meta{charset: 'utf-8'}
+    %title OmniToken 
+    %link{rel: 'stylesheet', href: '/style.css'}
+  %body
+    #container
+      = yield
+

data/views/results.haml

@@ -0,0 +1,18 @@
+#results
+  %h2= auth.provider.capitalize
+  %table
+    %tr
+      %td.attr Uid
+      %td= auth.uid
+    - auth.credentials.each do |key, value|
+      %tr
+        %td.attr= key.capitalize
+        %td= value
+    %tr
+      %td.attr Name
+      %td= auth.info.name
+    - args.each do |key, value|
+      %tr
+        %td.attr= key.capitalize
+        %td= value
+  %a{title: 'Home', href: '/'} << Back to Home

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: omnitoken
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Minjie Zha
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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: haml
+  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: omniauth
+  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: rack-test
+  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: OmniToken is a handy tool for getting OAuth tokens from multiple providers.
+email:
+- minjiezha@gmail.com
+executables:
+- omnitoken
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- bin/omnitoken
+- config.ru
+- omnitoken_app.rb
+- public/style.css
+- templates/twitter.yml
+- templates/facebook.yml
+- views/error.haml
+- views/layout.haml
+- views/results.haml
+- views/index.haml
+- test/helper.rb
+- test/omnitoken_app_test.rb
+- README.md
+- Gemfile
+- CHANGELOG.md
+homepage: https://github.com/magic003/omnitoken
+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.0.3
+signing_key: 
+specification_version: 4
+summary: OmniToken
+test_files:
+- test/helper.rb
+- test/omnitoken_app_test.rb