omniauth-box-oauth2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d6cffcd728b0e80437cb82b951808e8f621ad9c
+  data.tar.gz: 8c3729c1402ad5d76354198cd2dd14e5e7cf4cdd
+SHA512:
+  metadata.gz: 752385736419fa778008cabc1348167e63f59bf7628f3cf6db22f2dd32fe25a968318dde351aab6b6ed16e2cdf6f0c88e591b1ab66daacea5a1830633ea2e35c
+  data.tar.gz: b1db3dcc2963ab1af3fb172054acae6f4b44ca1c4eb59c075cb4fe26599ada09cb327d613729fa8b13e94768e0fb51e677b8a6f2a69a0305c588d20023a82356

data/.codeclimate.yml

@@ -0,0 +1,12 @@
+---
+engines:
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - lib/**/*
+  - "**.rb"
+exclude_paths: 
+- spec/**/*

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.2
+  - 2.1
+  - 2.0
+  - 1.9.3
+before_install:
+  - gem install bundler -v 1.10.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do 
+  gem 'codeclimate-test-reporter'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Pramod Shinde
+
+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,108 @@
+[![Gem Version](https://badge.fury.io/rb/omniauth-box-oauth2.svg)](https://badge.fury.io/rb/omniauth-box-oauth2)
+[![Build Status](https://travis-ci.org/pramodshinde/omniauth-box-oauth2.svg?branch=master)](https://travis-ci.org/pramodshinde/omniauth-box-oauth2)
+[![Code Climate](https://codeclimate.com/github/pramodshinde/omniauth-box-oauth2/badges/gpa.svg)](https://codeclimate.com/github/pramodshinde/omniauth-box-oauth2)
+[![Test Coverage](https://codeclimate.com/github/pramodshinde/omniauth-box-oauth2/badges/coverage.svg)](https://codeclimate.com/github/pramodshinde/omniauth-box-oauth2/coverage)
+[![Dependency Status](https://gemnasium.com/pramodshinde/omniauth-box-oauth2.svg)](https://gemnasium.com/pramodshinde/omniauth-box-oauth2)
+
+# OmniAuth::Strategies::BoxOauth2
+
+OAuth2 Strategy for [Box](https://www.box.com/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-box-oauth2'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-box-oauth2
+
+## Usage
+
+You can register your application [here](https://cloud.app.box.com/login) and get `client_id` & `client_secret`.
+
+Here's an example for adding the middleware to a Rails app in config/initializers/omniauth.rb:
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :box_oauth2, ENV["BOX_CLIENT_ID"], ENV["BOX_CLIENT_SECRET"]
+end
+```
+
+Or If your are using devise add follwing in config/initializers/devise.rb
+```ruby
+config.omniauth :box_oauth2, ENV["BOX_CLIENT_ID"], ENV["BOX_CLIENT_SECRET"]
+```
+
+Then add the following to 'config/routes.rb' so the callback routes are defined.
+
+```ruby
+devise_for :users, :controllers => { :omniauth_callbacks => "users/omniauth_callbacks" }
+```
+
+Make sure your model is omniauthable. Generally this is "/app/models/user.rb"
+
+## Sample Auth Hash 
+```ruby
+{
+  "provider"=>"box_oauth2",
+  "uid"=>"123456",
+  "info"=> {
+    "name"=>"Pramod Shinde",
+    "email"=>"box_user@email.com",
+    "job_title"=>"Ruby On Rails Developer",
+    "image"=>"https://app.box.com/api/avatar/large/123456",
+    "phone"=>"1234567890",
+    "address"=>"address",
+    "status"=>"active"
+  },
+  "credentials"=> {
+    "token"=>"box_access_token",
+    "refresh_token"=>"box_refresh_token",
+    "expires_at"=>1451681914,
+    "expires"=>true
+  },
+  "extra"=> {
+    "raw_info"=> {
+      "type"=>"user",
+      "id"=>"123456",
+      "name"=>"Pramod Shinde",
+      "login"=>"box_user@email.com",
+      "created_at"=>"2014-10-28T00:04:41-07:00",
+      "modified_at"=>"2016-01-01T10:11:16-08:00",
+      "language"=>"en",
+      "timezone"=>"America/Los_Angeles",
+      "space_amount"=>10737418240,
+      "space_used"=>301803,
+      "max_upload_size"=>2147483648,
+      "status"=>"active",
+      "job_title"=>"Ruby On Rails Developer",
+      "phone"=>"1234567890",
+      "address"=>"address",
+      "avatar_url"=>"https://app.box.com/api/avatar/large/123456"
+    }
+  }
+}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes along with test cases (`git commit -am 'Add some feature'`)
+4. If possible squash your commits to one commit if they all belong to same feature.
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request.
+
+
+## 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/lib/omniauth-box-oauth2.rb

@@ -0,0 +1 @@
+require File.join('omniauth', 'box_oauth2')

data/lib/omniauth/box_oauth2.rb

@@ -0,0 +1 @@
+require File.join('omniauth', 'strategies', 'box_oauth2')

data/lib/omniauth/box_oauth2/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module BoxOauth2
+    VERSION = '0.1.0'
+  end
+end

data/lib/omniauth/strategies/box_oauth2.rb

@@ -0,0 +1,38 @@
+require 'omniauth-oauth2'
+module OmniAuth
+  module Strategies
+    class BoxOauth2 < OmniAuth::Strategies::OAuth2
+      option :name, 'box_oauth2'
+
+      option :client_options, {
+        site: 'https://api.box.com/2.0/',
+        authorize_url: 'https://app.box.com/api/oauth2/authorize',
+        token_url: 'https://api.box.com/oauth2/token'
+      }
+
+      uid { raw_info['id'] }
+
+      info do
+        {
+          name: raw_info['name'],
+          email: raw_info['login'],
+          job_title: raw_info['job_title'],
+          image: raw_info['avatar_url'],
+          phone: raw_info['phone'],
+          address: raw_info['address'],
+          status: raw_info['status']
+        }
+      end 
+
+      extra do 
+        { raw_info: raw_info }
+      end
+
+      private 
+
+      def raw_info
+        @raw_info ||= access_token.get('users/me').parsed || {}
+      end     
+    end
+  end
+end

data/omniauth-box-oauth2.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth/box_oauth2/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'omniauth-box-oauth2'
+  spec.version       = OmniAuth::BoxOauth2::VERSION
+  spec.authors       = ['Pramod Shinde']
+  spec.email         = ['pramodshinde7@gmail.com']
+
+  spec.summary       = %q{A Box OAuth2 strategy for OmniAuth 1.x}
+  spec.description   = %q{A Box OAuth2 strategy for OmniAuth 1.x}
+  spec.homepage      = 'https://github.com/pramodshinde/omniauth-box-oauth2'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'omniauth-oauth2', '~> 1.2'
+
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+end

data/spec/omniauth/strategies/box_oauth2_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+require 'omniauth-box-oauth2'
+
+describe OmniAuth::Strategies::BoxOauth2 do
+  let(:request) { double('Request', :params => {}, :cookies => {}, :env => {}) }
+  let(:app) {
+    lambda do
+      [200, {}, ["Hello."]]
+    end
+  }
+
+  subject do
+    OmniAuth::Strategies::BoxOauth2.new(app, 'appid', 'secret', @options || {}).tap do |strategy|
+      allow(strategy).to receive(:request) {
+        request
+      }
+    end
+  end
+
+  before do
+    OmniAuth.config.test_mode = true
+  end
+
+  after do
+    OmniAuth.config.test_mode = false
+  end
+
+  it 'has a version number' do
+    expect(OmniAuth::BoxOauth2::VERSION).not_to be nil
+  end
+
+  describe '#client_options' do
+    it 'has correct site' do
+      expect(subject.client.site).to eq('https://api.box.com/2.0/')
+    end
+
+    it 'has correct authorize_url' do
+      expect(subject.client.options[:authorize_url]).to eq('https://app.box.com/api/oauth2/authorize')
+    end
+
+    it 'has correct token_url' do
+      expect(subject.client.options[:token_url]).to eq('https://api.box.com/oauth2/token')
+    end
+  end
+
+  describe '#callback_path' do
+    it 'has the correct callback path' do
+      expect(subject.callback_path).to eq('/auth/box_oauth2/callback')
+    end
+  end
+
+  describe '#uid' do
+    before :each do
+      allow(subject).to receive(:raw_info) { { 'id' => 'uid' } }
+    end
+
+    it 'returns the id from raw_info' do
+      expect(subject.uid).to eq('uid')
+    end
+  end
+
+  describe '#info' do
+    before :each do
+      allow(subject).to receive(:raw_info) { {} }
+    end
+
+    context 'has all the necessary fields' do
+      it { expect(subject.info).to have_key :name }
+      it { expect(subject.info).to have_key :email }
+      it { expect(subject.info).to have_key :job_title }
+      it { expect(subject.info).to have_key :phone }
+      it { expect(subject.info).to have_key :address }
+      it { expect(subject.info).to have_key :status }
+      it { expect(subject.info).to have_key :image }
+    end
+  end
+
+  describe '#extra' do
+    before :each do
+      allow(subject).to receive(:raw_info) { { status: 'active' } }
+    end
+
+    it { expect(subject.extra[:raw_info]).to eq({ status: 'active' }) }
+  end
+
+  describe '#raw_info' do
+    before :each do
+      access_token = double('access token')
+      response = double('response', :parsed => { status: 'active' })
+      expect(access_token).to receive(:get).with('users/me').and_return(response)
+      allow(subject).to receive(:access_token) { access_token }
+    end
+
+    it 'returns parsed response from access token' do
+      expect(subject.send(:raw_info)).to eq({ status: 'active' })
+    end
+  end
+
+  describe '#access_token' do
+    before :each do
+      response = double('access token',
+        access_token: 'access_token',         
+        refresh_token: 'refresh_token',
+        expires_in: 3600, 
+        expires_at: 12345, 
+      ).as_null_object
+      allow(subject).to receive(:access_token) { response }
+    end
+
+    it { expect(subject.access_token.access_token).to eq('access_token') }
+    it { expect(subject.access_token.expires_in).to eq(3600) }
+    it { expect(subject.access_token.expires_at).to eq(12345) }
+    it { expect(subject.access_token.refresh_token).to eq('refresh_token') }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+require 'omniauth/box_oauth2'

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-box-oauth2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pramod Shinde
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: A Box OAuth2 strategy for OmniAuth 1.x
+email:
+- pramodshinde7@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/omniauth-box-oauth2.rb
+- lib/omniauth/box_oauth2.rb
+- lib/omniauth/box_oauth2/version.rb
+- lib/omniauth/strategies/box_oauth2.rb
+- omniauth-box-oauth2.gemspec
+- spec/omniauth/strategies/box_oauth2_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pramodshinde/omniauth-box-oauth2
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A Box OAuth2 strategy for OmniAuth 1.x
+test_files: []
+has_rdoc: