omniauth-backstage 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9df104def5c10cbbbdc3e2c63fbf5c49259e53d8
+  data.tar.gz: ca386cab89dd903c77faf55abec828ca12bafdb4
+SHA512:
+  metadata.gz: be5baccfd1147e73fe934ae6e5f6e6c17effeec0ede8264b7b24f09acb664ba49e4195d989753611fb5ce54f9dd08fba1fe169907e6c9ea5c590362db02852ad
+  data.tar.gz: 9ea870c390ae43e58803fe5c797ad2016e7c998a2f4ef12bbc57b7c22c0ac9c7d0ef30d329182722e8aa4f02c7ec3257957be469a36a15e29afc2bf44ecc4283

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
+.DS_Store

data/Gemfile

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

data/README.md

@@ -0,0 +1,11 @@
+# OmniAuth Backstage
+
+This is the OmniAuth strategy for authenticating to [Backstage](https://github.com/backstage/backstage).
+
+## Usage
+
+```ruby
+use OmniAuth::Builder do
+  provider :backstage, ENV['BACKSTAGE_CLIENT_ID'], ENV['BACKSTAGE_CLIENT_SECRET'], { site: ENV['BACKSTAGE_SITE'], authorize_url: ENV['BACKSTAGE_AUTHORIZE_URL'], token_url: ENV['BACKSTAGE_TOKEN_URL'] }
+end
+```

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+desc 'Run specs'
+task :default => :spec

data/lib/omniauth/backstage/client.rb

@@ -0,0 +1,16 @@
+module OmniAuth
+  module Backstage
+    class Client
+      def self.client_options(options)
+        ok = %w{site authorize_url token_url}.all? {|param| options.include?(param.to_sym) }
+        raise ArgumentError, 'Missing required parameters.' unless ok
+
+        {
+          site: options[:site],
+          authorize_url: options[:authorize_url],
+          token_url: options[:token_url]
+        }
+      end
+    end
+  end
+end

data/lib/omniauth/strategies/backstage.rb

@@ -0,0 +1,37 @@
+require 'omniauth-oauth2'
+require "omniauth/backstage/client"
+
+module OmniAuth
+  module Strategies
+    class Backstage < OmniAuth::Strategies::OAuth2
+      option :name, 'backstage'
+      option :client_options, nil
+
+      uid { raw_info['email'].to_s }
+
+      info do
+        {
+          name: raw_info['name'],
+          email: raw_info['email'],
+          username: raw_info['username']
+        }
+      end
+
+      extra do
+        {
+          raw_info: raw_info
+        }
+      end
+
+      def initialize(app, *args, &block)
+        super(app, *args, &block)
+        options[:client_options] = OmniAuth::Backstage::Client.client_options(options) if options.client_options.nil?
+      end
+
+      def raw_info
+        payload = access_token.get('me').parsed
+        @raw_info ||= payload[:user]
+      end
+    end
+  end
+end

data/lib/omniauth-backstage/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Backstage
+    VERSION = "0.0.1"
+  end
+end

data/lib/omniauth-backstage.rb

@@ -0,0 +1,2 @@
+require "omniauth-backstage/version"
+require 'omniauth/strategies/backstage'

data/omniauth-backstage.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+require File.expand_path('../lib/omniauth-backstage/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-backstage"
+  spec.version       = OmniAuth::Backstage::VERSION
+  spec.license       = "MIT"
+
+  spec.authors       = ["Alberto Leal"]
+  spec.email         = ["albertonb@gmail.com"]
+  spec.description   = %q{Backstage OAuth2 Strategy for OmniAuth.}
+  spec.summary       = %q{Backstage OAuth2 Strategy for OmniAuth.}
+  spec.homepage      = "https://github.com/backstage/omniauth-backstage"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rspec', '~> 2.7'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock'
+
+  spec.add_dependency 'omniauth-oauth2', '~> 1.1.2'
+end

data/spec/omniauth/backstage/client_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe OmniAuth::Backstage::Client do
+  let(:options) {
+    {
+      site: 'https://backstage.example.org',
+      authorize_url: 'https://backstage.example.org/login/oauth/authorize',
+      token_url: 'https://backstage.example.org/login/oauth/access_token'
+    }
+  }
+  it "raises an exception when missing required params" do
+    expect{ OmniAuth::Backstage::Client.client_options }.to raise_error(ArgumentError)
+  end
+
+  it "returns client_options struture for omniauth" do
+    expect(OmniAuth::Backstage::Client.client_options(options)).to eq options
+  end
+end

data/spec/omniauth/strategies/backstage_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Backstage do
+  let(:access_token) { double('AccessToken', options: {}) }
+  let(:user) { double('User') }
+  let(:parsed_response) { double('Parsed Response', :[] => user) }
+  let(:response) { double('Response', :parsed => parsed_response) }
+
+  let(:backstage) do
+    OmniAuth::Strategies::Backstage.new('CLIENT_ID', 'CLIENT_SECRET',{
+        client_options: {
+          site: 'https://backstage.example.org',
+          authorize_url: 'https://backstage.example.org/login/oauth/authorize',
+          token_url: 'https://backstage.example.org/login/oauth/access_token'
+        }
+      }
+    )
+  end
+
+  subject do
+    OmniAuth::Strategies::Backstage.new({})
+  end
+
+  context "client options" do
+    it 'raises an exception if required params are not provided' do
+      expect{ subject }.to raise_error(ArgumentError)
+    end
+
+    describe "initializiation" do
+      it "site endpoint" do
+        expect(backstage.options.client_options.site).to eq('https://backstage.example.org')
+      end
+
+      it "authorize url endpoint" do
+        expect(backstage.options.client_options.authorize_url).to eq('https://backstage.example.org/login/oauth/authorize')
+      end
+
+      it "token endpoint" do
+        expect(backstage.options.client_options.token_url).to eq('https://backstage.example.org/login/oauth/access_token')
+      end
+    end
+  end
+
+  context "#raw_info" do
+    it "returns user info" do
+      allow(backstage).to receive(:access_token).and_return(access_token)
+      allow(access_token).to receive(:get).with('me').and_return(response)
+      expect(backstage.raw_info).to eq(user)
+    end
+  end
+
+  context "info" do
+    before(:each) do
+      backstage.stub(:raw_info).and_return({})
+    end
+
+    it "has name key" do
+      expect(backstage.info).to have_key(:name)
+    end
+
+    it "has email key" do
+      expect(backstage.info).to have_key(:email)
+    end
+
+    it "has username key" do
+      expect(backstage.info).to have_key(:username)
+    end
+  end
+
+  context "extra" do
+    it "returns raw user info" do
+      backstage.stub(:raw_info).and_return({ name: 'Alice', username: 'alice', email: 'alice@example.org'})
+
+      expect(backstage.extra).to have_key(:raw_info)
+      %w{name username email}.each do |k|
+        expect(backstage.extra[:raw_info]).to have_key(k.to_sym)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'simplecov'
+SimpleCov.start
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth'
+require 'omniauth-backstage'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend  OmniAuth::Test::StrategyMacros, type: :strategy
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-backstage
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alberto Leal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+description: Backstage OAuth2 Strategy for OmniAuth.
+email:
+- albertonb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- lib/omniauth-backstage.rb
+- lib/omniauth-backstage/version.rb
+- lib/omniauth/backstage/client.rb
+- lib/omniauth/strategies/backstage.rb
+- omniauth-backstage.gemspec
+- spec/omniauth/backstage/client_spec.rb
+- spec/omniauth/strategies/backstage_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/backstage/omniauth-backstage
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Backstage OAuth2 Strategy for OmniAuth.
+test_files:
+- spec/omniauth/backstage/client_spec.rb
+- spec/omniauth/strategies/backstage_spec.rb
+- spec/spec_helper.rb