omniauth-participa 1.0.0.rc2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d8e114a9af2bbcfe67794342f9e70c74fd5b01e
-  data.tar.gz: cebfdec065ada3ca1ccc9f984b9c0a37382fdeea
+  metadata.gz: 4480684a332639fdcd83f2947774928c61063f32
+  data.tar.gz: 98395a3520604b7d3b969f94e265ad1135407074
 SHA512:
-  metadata.gz: 318ea0037a4f0e6f40ed1ed91aa7cbd9d7a64dbf44595f669d0714c5370699198d638172a060cfa8259275de99c3b6eb6ed853f1201b6ebe1c35e3d3870771ed
-  data.tar.gz: 6abc85c22e3e10ad2af33aad8b9bff305673c7ea2b4f027529ac045c386150ee9f3d75c8e1f6eb2b6a52aaf37f61b9f3395c612c16d0adbb98388ccb25cad1f9
+  metadata.gz: f82ae4dc2281844106d2f5039d114addca98c9aa7a095771ec5657295f7d838de5b926d2607496255670964e17424082c22b2217607d6977c74cf423443b9756
+  data.tar.gz: 45b03a7f6d0458423805a459ab6b7495d65b0409b56162d696d103f67fd8669d24669f079134c7d8344b7611e119cd0fbd9dc9324ab7dc9ee5d789a79c4ca65a

data/README.md

@@ -1,8 +1,20 @@
-# Omniauth::Participa
+# Omniauth Participa
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/omniauth/participa`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/omniauth-participa.svg)](https://badge.fury.io/rb/omniauth-participa)
+[![Build Status](https://travis-ci.org/adab1ts/omniauth-participa.svg?branch=master)](https://travis-ci.org/adab1ts/omniauth-participa)
+[![license](https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square)](https://choosealicense.com/licenses/mit/)
+
+This gem contains the [OmniAuth](https://github.com/omniauth/omniauth) strategy for [Participa](https://github.com/GuanyemBarcelona/participa) platform.
+
+
+## Before You Begin
+
+[Participa](https://github.com/GuanyemBarcelona/participa) supports [OAuth 2](https://www.oauth.com/) authentication, playing the [Authorization and Resource Server](https://aaronparecki.com/oauth-2-simplified/#roles) roles.
+
+Participa uses the _Authorization Code_ grant to authorize Client apps acting on behalf the user. Contact the platform admin and ask for a **Client ID** and a **Client Secret** for your application. Remember to provide your **Redirect URI**:
+
+`https://your-application.domain/auth/participa/callback`.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -20,9 +32,85 @@ Or install it yourself as:
 
     $ gem install omniauth-participa
 
+
 ## Usage
 
-TODO: Write usage instructions here
+`OmniAuth::Strategies::Participa` is simply a Rack middleware. Tell OmniAuth about this provider. For a Rails app, your `config/initializers/omniauth.rb` file should look like this:
+
+```ruby
+# config/initializers/omniauth.rb
+
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :participa, ENV['PARTICIPA_CLIENT_ID'], ENV['PARTICIPA_CLIENT_SECRET']
+end
+```
+
+
+## Configuration
+
+You can configure several options, which you pass in to the `provider` method via a `Hash`:
+
+Option name | Default | Explanation
+--- | --- | ---
+`site` | `https://participa.dev` | URL of the Participa server instance  (e.g. https://the-server-app.com)
+`authorize_url` | `/oauth/authorize` | Authorization URL for Participa (e.g. https://the-server-app.com/oauth/authorize)
+`token_url` | `/oauth/token` | Token URL for Participa (e.g. https://the-server-app.com/oauth/token)
+`endpoint_url` | `/api/v2/users/me` | User endpoint URL for Participa (e.g. https://the-server-app.com/api/v2/users/me)'
+`redirect_uri` | | Custom callback URL used during the server-side flow (e.g. https://the-client-app.com/auth/participa/callback)
+
+Here's an example of a possible configuration:
+
+```ruby
+# config/initializers/omniauth.rb
+
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :participa, ENV['PARTICIPA_CLIENT_ID'], ENV['PARTICIPA_CLIENT_SECRET'],
+    {
+      redirect_uri: 'https://the-client-app.com/auth/participa/callback',
+      client_options: {
+        site: 'https://the-server-app.com',
+        authorize_url: 'https://the-server-app.com/oauth/authorize',
+        token_url: 'https://the-server-app.com/oauth/token',
+        endpoint_url: 'https://the-server-app.com/api/v2/users/me'
+      }
+    }
+end
+```
+
+
+## Auth Hash
+
+Here's an example _Auth Hash_ available in the callback by accessing `request.env['omniauth.auth']`:
+
+```ruby
+{
+  provider: 'participa',
+  uid: '12345',
+  info: {
+    email: 'jane.doe@acme.com',
+    name: 'Jane Doe',
+    username: 'Jane_Doe',
+    admin: true
+  },
+  credentials: {
+    token: 'ABCDEF...', # OAuth 2.0 access_token, which you may wish to store
+    refresh_token: "FEDCBA...",
+    expires_at: 1321747205, # when the access token expires (it always will),
+    expires: true # this will always be true
+  }
+  extra: {
+    raw_info: {
+      id: '12345',
+      email: 'jane.doe@acme.com',
+      full_name: 'Jane Doe',
+      username: 'Jane_Doe',
+      admin: true,
+      list_groups: ['group-1', 'group-2']
+    }
+  }
+}
+```
+
 
 ## Development
 
@@ -30,11 +118,26 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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/adab1ts/omniauth-participa.
+## Contact
+
+Email:    info[@]adabits[.]org  
+Twitter:  [@adab1ts](https://twitter.com/adab1ts)  
+Facebook: [Adab1ts](https://www.facebook.com/Adab1ts)  
+LinkedIn: [adab1ts](https://www.linkedin.com/company/adab1ts)  
+
+
+## Contributors
+
+Contributions of any kind are welcome!
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<img alt="laklau" src="https://avatars.githubusercontent.com/u/6210292?v=3&s=117" width="117"> |[<img alt="zuzust" src="https://avatars.githubusercontent.com/u/351530?v=3&s=117" width="117">](https://github.com/adab1ts/omniauth-participa/commits?author=zuzust) |
+:---: |:---: |
+[Klaudia Alvarez](https://github.com/laklau) |[Carles Muiños](https://github.com/zuzust)
+<!-- ALL-CONTRIBUTORS-LIST:END -->
 
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).

data/lib/omniauth-participa/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module Participa
-    VERSION = '1.0.0.rc2'
+    VERSION = '1.0.0'
   end
 end

data/lib/omniauth/strategies/participa.rb

@@ -7,10 +7,9 @@ module OmniAuth
       option :name, :participa
       option :scope, 'public'
       option :authorize_options, [:redirect_uri, :scope]
-      option :provider_ignores_state, true
 
       option :client_options, {
-        site: 'http://participa.dev',
+        site: 'https://participa.dev',
         authorize_url: '/oauth/authorize',
         token_url: '/oauth/token',
         endpoint_url: '/api/v2/users/me'
@@ -37,13 +36,12 @@ module OmniAuth
         }
       end
 
-      # TODO: add user groups
       extra do
         skip_info? ? {} : { raw_info: raw_info }
       end
 
       def raw_info
-        @raw_info ||= access_token.get(options[:client_options].try(:endpoint_url)).parsed
+        @raw_info ||= access_token.get(options[:client_options][:endpoint_url]).parsed
       end
 
       # https://github.com/intridea/omniauth-oauth2/issues/81

data/spec/omniauth/strategies/participa_spec.rb

@@ -3,7 +3,9 @@ require 'spec_helper'
 describe OmniAuth::Strategies::Participa do
   let(:request) { double('Request', params: {}, cookies: {}, env: {}) }
   let(:app) { -> {[200, {}, ['Participa']]} }
-  let(:raw_info) { {'id' => 'uid', 'admin' => true, 'email' => 'jane-doe@example.com', 'username' => 'jane-doe', 'full_name' => 'Jane Doe'} }
+  let(:raw_info) {
+    {'id' => 'uid', 'admin' => true, 'email' => 'jane-doe@example.com', 'username' => 'jane-doe', 'full_name' => 'Jane Doe'}
+  }
 
   subject do
     OmniAuth::Strategies::Participa.new(app, 'appid', 'secret', @options || {}).tap do |strategy|
@@ -72,8 +74,8 @@ describe OmniAuth::Strategies::Participa do
       end
 
       it 'should set the redirect_uri parameter if present' do
-        @options = { redirect_uri: 'htts://example.com/auth/participa/callback' }
-        expect(subject.authorize_params['redirect_uri']).to eq('htts://example.com/auth/participa/callback')
+        @options = { redirect_uri: 'https://example.com/auth/participa/callback' }
+        expect(subject.authorize_params['redirect_uri']).to eq('https://example.com/auth/participa/callback')
       end
     end
 
@@ -105,6 +107,27 @@ describe OmniAuth::Strategies::Participa do
     end
   end
 
+  describe '#callback_url' do
+    it 'should return the redirect_uri parameter if present' do
+      @options = { redirect_uri: 'https://example.com/auth/foo/callback' }
+      expect(subject.callback_url).to eq('https://example.com/auth/foo/callback')
+    end
+  end
+
+  describe '#raw_info' do
+    before do
+      access_token = double('access_token')
+      response = double('response', parsed: { foo: 'bar' })
+
+      expect(access_token).to receive(:get).with('/api/v2/users/me').and_return(response)
+      allow(subject).to receive(:access_token) { access_token }
+    end
+
+    it 'returns parsed response from access token' do
+      expect(subject.raw_info).to eq({ foo: 'bar'})
+    end
+  end
+
   describe '#uid' do
     it 'should return the user id' do
       allow(subject).to receive(:raw_info).and_return(raw_info)
@@ -133,4 +156,26 @@ describe OmniAuth::Strategies::Participa do
       expect(subject.info[:admin]).to eq(raw_info['admin'])
     end
   end
+
+  describe '#extra' do
+    before do
+      allow(subject).to receive(:raw_info).and_return(raw_info)
+    end
+
+    context "when skip info is true" do
+      before { subject.options.skip_info = true }
+
+      it 'should not include raw_info' do
+        expect(subject.extra).not_to have_key(:raw_info)
+      end
+    end
+
+    context "when skip info is false" do
+      before { subject.options.skip_info = false }
+
+      it 'should include raw_info' do
+        expect(subject.extra[:raw_info]).to eq(raw_info)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-participa
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc2
+  version: 1.0.0
 platform: ruby
 authors:
 - Carles Muiños
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-04 00:00:00.000000000 Z
+date: 2017-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -119,9 +119,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1