omniauth-bcx 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4682dca155d02303863593069c986bc33b038375
+  data.tar.gz: 5dc19b16638a7de79a6785af680a8c752d4c4799
+SHA512:
+  metadata.gz: '096f7901528373d2fee5628d04b7a853abc48cd1080178b7a480697d224f0be2a55f7b37dcb1791ad44c215ed9cd7ff755e561b54725c6381efd98fd37bc2a8e'
+  data.tar.gz: 38cb80e9f5af17aab4ad9f6e7b2846dc7654bc5fc7fa434cc846fecc11bff8cc8b20cf00717a8fa746c56b5e06c71c36ed7788fcc20629409a7ef8fd87a8d612

data/.codeclimate.yml

@@ -0,0 +1,16 @@
+---
+engines:
+  rubocop:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - "ruby"
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+  - .bundle/
+  - test/**/*
+  - benchmarks/**/*

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rubocop.yml

@@ -0,0 +1,63 @@
+AllCops:
+  Include:
+    - '**/*.gemspec'
+    - '**/*.podspec'
+    - '**/*.jbuilder'
+    - '**/*.rake'
+    - '**/*.opal'
+    - '**/config.ru'
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - '**/Capfile'
+    - '**/Guardfile'
+    - '**/Podfile'
+    - '**/Thorfile'
+    - '**/Vagrantfile'
+    - '**/Berksfile'
+    - '**/Cheffile'
+    - '**/Vagabondfile'
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: space
+  SpaceBeforeBlockParameters: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBraces: no_space
+
+Layout/FirstArrayElementLineBreak:
+  Enabled: true
+
+Layout/FirstHashElementLineBreak:
+  Enabled: true
+
+Style/SymbolArray:
+  Enabled: true
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  []
+    '%i': []
+    '%q': []
+    '%Q': []
+    '%r': '{}'
+    '%s': []
+    '%w': []
+    '%W': []
+    '%x': []
+
+Metrics/LineLength:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Naming/FileName:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+cache: bundler
+sudo: false
+notifications:
+  email: false
+rvm:
+- 2.4.2
+before_script:
+- "curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter"
+- chmod +x ./cc-test-reporter
+- "./cc-test-reporter before-build"
+after_script:
+- "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
+env:
+  global:
+    secure: qJ9AQ1tXd8qETxedDDt9IaNcHvcfOn/PuwfoDAgRaLVrrtcSBx12xOzy4rSO1UVWhFlZS+qbsXp4YGT4+PWbi56bM6/LbfAa5o4hFeJA23gbN0UCIDBrOQgeGRG154lGoyJV0eXtEdzfNuZnPUSMVTHGzemWMox+Q8ePCH5yOHh96Rk7U5oA0YiT1MgiIg0EFEj8ELhacfeYGGoXjYRdUrwEqOv09WSUaq+xrc5KhR6pe+IVTZMiIEkPiBWNIHCqHfV8C0CjKAGwZOb63hKAzQR846YrWi8oCBFLkn5zzG49XgXpx+E46iMotXn6gEsMmQid+haZBWpABPra4ArNa3FKgFM4kP38PZvPFfLS7DHRAhsO6EbJvkHCewwgaFaMCImu40GBW6MEgk9MLCkaCXt8Or1fYbJsM7PMUdVtj6RuH0R5MeyS3O7FSnDWteSzEbsevAwNoYon/xSKXRyM5cbIIb4IS1oRF4vlw6HMwXa4LMeh7eHErs5XsMhMIxkEOmrY5t5dkSEK0pyQf9c3Eq0RolvStfzOytLkYgzCEKJ/VlGufEwkuiDn/rJmKA1DLZCdDJ/VO2n+fcHvE125NeHpAAmWKDb0FqffQvthj56SfHiQSQ5c5xX1x/nErv5vaJjAtTk/Ir4q+wVPogypOWPypyL1HrWvUO/8kh+W+Y8=

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Nando Vieira
+
+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,49 @@
+# Omniauth::BCX
+
+[![Travis-CI](https://travis-ci.org/fnando/omniauth-bcx.png)](https://travis-ci.org/fnando/omniauth-bcx)
+[![CodeClimate](https://codeclimate.com/github/fnando/omniauth-bcx.png)](https://codeclimate.com/github/fnando/omniauth-bcx)
+[![Test Coverage](https://codeclimate.com/github/fnando/omniauth-bcx/badges/coverage.svg)](https://codeclimate.com/github/fnando/omniauth-bcx/coverage)
+[![Gem](https://img.shields.io/gem/v/omniauth-bcx.svg)](https://rubygems.org/gems/omniauth-bcx)
+[![Gem](https://img.shields.io/gem/dt/omniauth-bcx.svg)](https://rubygems.org/gems/omniauth-bcx)
+
+[Basecamp](http://basecamp.com)'s OAuth2 Strategy for OmniAuth.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'omniauth-bcx'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-bcx
+
+## Usage
+
+`OmniAuth::Strategies::BCX` is simply a Rack middleware. Read the OmniAuth docs for detailed instructions: <https://github.com/intridea/omniauth>.
+
+First, create a new application at `https://launchpad.37signals.com/integrations`. Your callback URL must be something like `https://example.com/auth/basecamp/callback`. For development you can use `http://127.0.0.1:3000/auth/basecamp/callback`.
+
+Here's a quick example, adding the middleware to a Rails app in `config/initializers/omniauth.rb`. This example assumes you're exporting your credentials as environment variables.
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :basecamp, 
+            ENV['BASECAMP_CLIENT_ID'], 
+            ENV['BASECAMP_CLIENT_SECRET']
+end
+```
+
+Now visit `/auth/basecamp` to start authentication against Sentry.
+
+## Contributing
+
+1. Fork [omniauth-bcx](https://github.com/fnando/omniauth-bcx/fork)
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = false
+end
+
+task default: :test

data/lib/omniauth/strategies/bcx.rb

@@ -0,0 +1,56 @@
+require "omniauth"
+require "omniauth-oauth2"
+
+module OmniAuth
+  module Strategies
+    class BCX < OmniAuth::Strategies::OAuth2
+      option :name, "basecamp"
+
+      option :client_options,
+             site: "https://launchpad.37signals.com",
+             authorize_url: "/authorization/new",
+             token_url: "/authorization/token"
+
+      def authorize_params
+        super.tap do |params|
+          params[:response_type] = "code"
+          params[:client_id] = client.id
+          params[:redirect_uri] ||= callback_url
+          params[:type] = "web_server"
+        end
+      end
+
+      uid do
+        info[:id]
+      end
+
+      info do
+        raw_info.fetch(:identity)
+      end
+
+      extra do
+        raw_info
+      end
+
+      def token_params
+        OmniAuth::Strategy::Options.new(
+          code: request.params["code"],
+          redirect_uri: callback_url,
+          client_id: client.id,
+          client_secret: client.secret,
+          type: "web_server"
+        )
+      end
+
+      def raw_info
+        @raw_info ||= deep_symbolize(access_token.get("/authorization.json").parsed)
+      end
+
+      def callback_url
+        full_host + script_name + callback_path
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization "bcx", "BCX"

data/lib/omniauth-bcx/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module BCX
+    VERSION = "0.1.0".freeze
+  end
+end

data/lib/omniauth-bcx.rb

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

data/omniauth-bcx.gemspec

@@ -0,0 +1,26 @@
+require "./lib/omniauth-bcx/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-bcx"
+  spec.version       = Omniauth::BCX::VERSION
+  spec.authors       = ["Nando Vieira"]
+  spec.email         = ["fnando.vieira@gmail.com"]
+  spec.summary       = "OmniAuth strategy for Basecamp (https://basecamp.com)."
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/fnando/omniauth-bcx"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_runtime_dependency "omniauth-oauth2"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "pry-meta"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "webmock"
+end

data/test/omniauth/strategies/client_options_test.rb

@@ -0,0 +1,25 @@
+require "test_helper"
+
+class ClientOptionsTest < Minitest::Test
+  let(:app) { ->(env) { } }
+
+  let(:strategy) do
+    OmniAuth::Strategies::BCX.new(app, "consumer_id", "consumer_secret")
+  end
+
+  test "sets name" do
+    assert_equal "basecamp", strategy.options.name
+  end
+
+  test "sets site" do
+    assert_equal "https://launchpad.37signals.com", strategy.options.client_options.site
+  end
+
+  test "sets authorize url" do
+    assert_equal "/authorization/new", strategy.options.client_options.authorize_url
+  end
+
+  test "sets token url" do
+    assert_equal "/authorization/token", strategy.options.client_options.token_url
+  end
+end

data/test/omniauth/strategies/data_test.rb

@@ -0,0 +1,66 @@
+require "test_helper"
+
+class DataTest < Minitest::Test
+  let(:app) { ->(env) { } }
+
+  let(:strategy) do
+    OmniAuth::Strategies::BCX.new(app, "consumer_id", "consumer_secret")
+  end
+
+  test "returns raw info" do
+    payload = {"id" => "ID"}
+    access_token = mock("access_token")
+    response = mock("response", parsed: payload)
+    access_token.expects(:get).with("/authorization.json").returns(response)
+    strategy.stubs(:access_token).returns(access_token)
+
+    assert_equal Hash[:id, "ID"], strategy.raw_info
+  end
+
+  test "returns info" do
+    identity = {id: "ID", name: "NAME"}
+    raw_info = {identity: identity}
+    strategy.stubs(:raw_info).returns(raw_info)
+
+    info = strategy.info
+
+    assert_equal "ID", info[:id]
+    assert_equal "NAME", info[:name]
+  end
+
+  test "returns uid" do
+    strategy.stubs(:info).returns(id: "ID")
+    assert_equal "ID", strategy.uid
+  end
+
+  test "returns extra info" do
+    raw_info = {raw: true}
+    strategy.stubs(:raw_info).returns(raw_info)
+
+    assert_equal raw_info, strategy.extra
+  end
+
+  test "returns authorize params" do
+    session = {}
+    request = Rack::Request.new("env.session" => {})
+    strategy.stubs(:session).returns(session)
+    strategy.stubs(:request).returns(request)
+    strategy.stubs(:script_name).returns("")
+
+    assert_equal "code", strategy.authorize_params[:response_type]
+    assert_equal "consumer_id", strategy.authorize_params[:client_id]
+    assert_equal "web_server", strategy.authorize_params[:type]
+    assert_equal "/auth/basecamp/callback", strategy.authorize_params[:redirect_uri]
+  end
+
+  test "returns token params" do
+    strategy.stubs(:callback_url).returns("/auth/basecamp/callback")
+    strategy.request.stubs(:params).returns("code" => "CODE")
+
+    assert_equal "CODE", strategy.token_params.code
+    assert_equal "/auth/basecamp/callback", strategy.token_params.redirect_uri
+    assert_equal "consumer_id", strategy.token_params.client_id
+    assert_equal "consumer_secret", strategy.token_params.client_secret
+    assert_equal "web_server", strategy.token_params.type
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require "simplecov"
+SimpleCov.start
+
+require "bundler/setup"
+require "omniauth-bcx"
+
+require "minitest/utils"
+require "minitest/autorun"

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-bcx
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nando Vieira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  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: bundler
+  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: 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: minitest-utils
+  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: pry-meta
+  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: mocha
+  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: 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'
+description: OmniAuth strategy for Basecamp (https://basecamp.com).
+email:
+- fnando.vieira@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth-bcx.rb
+- lib/omniauth-bcx/version.rb
+- lib/omniauth/strategies/bcx.rb
+- omniauth-bcx.gemspec
+- test/omniauth/strategies/client_options_test.rb
+- test/omniauth/strategies/data_test.rb
+- test/test_helper.rb
+homepage: https://github.com/fnando/omniauth-bcx
+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.6.13
+signing_key: 
+specification_version: 4
+summary: OmniAuth strategy for Basecamp (https://basecamp.com).
+test_files:
+- test/omniauth/strategies/client_options_test.rb
+- test/omniauth/strategies/data_test.rb
+- test/test_helper.rb