omniauth-slooob 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df30a1cc7eea71429f0cf5c6b8742145d09f8b0b
+  data.tar.gz: 37c23819f2910a5a0f07d433f5a67b2fca223d73
+SHA512:
+  metadata.gz: 7bab1f82b57abaa51762fd9a7ed08b9eeb63cdb10bb2849b9059cacf59df176fdb7ad63fc0902954a2e75b8f51bf7d253c1fd5174a6d9c815bb31ded10227cd1
+  data.tar.gz: ada082ae2d3de4e86798241de1c495a93f64d128a4de8cfc5a61a8d6ad1a21299e2bf50af3f4f5c798ff8eae789ee8edacfa6ee998a8c3a833378f2b04157bd9

data/.github/issue_template.md

@@ -0,0 +1,14 @@
+### Expected behavior
+Tell us what should happen
+
+### Actual behavior
+Tell us what happens instead
+
+### Steps to reproduce
+Show a way to reproduce
+
+### System configuration
+
+**Ruby version**:
+
+**Rails version**:

data/.github/pull_request_template.md

@@ -0,0 +1,21 @@
+### Summary
+
+Provide a general description of the code changes in your pull
+request... were there any bugs you had fixed? If so, mention them. If
+these bugs have open GitHub issues, be sure to tag them here as well,
+to keep the conversation linked together.
+
+### Other Information
+
+If there's anything else that's important and relevant to your pull
+request, mention that information here. This could include
+benchmarks, or other information.
+
+If you are updating any of the CHANGELOG files or are asked to update the
+CHANGELOG files by reviewers, please add the CHANGELOG entry at the top of the file.
+
+Finally, if your pull request affects documentation or any non-code
+changes, guidelines for those changes are [available
+here](https://github.com/slooob/acts_as_favoritor/blob/master/CONTRIBUTING.md)
+
+Thanks for contributing to `acts_as_favoritor`!

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.ruby-gemset
+.ruby-version
+.rvmrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.powenv
+.idea/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+    - 2.3.3

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## master
+
+nothing yet
+
+## 1.0.0 - 2017-08-25
+
+Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at help@slooob.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+
+# # Test Coverage
+# gem 'simplecov', require: false, group: :test

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Slooob
+
+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,301 @@
+# Slooob OAuth2 Strategy for OmniAuth
+
+[![Build Status](https://travis-ci.org/slooob/omniauth-slooob.svg)](https://travis-ci.org/slooob/omniauth-slooob)
+[![Gem Version](https://badge.fury.io/rb/omniauth-slooob.svg)](https://badge.fury.io/rb/omniauth-slooob)
+
+**Built on Slooob Identity API v1**
+
+Strategy to authenticate with Slooob via OAuth2 in OmniAuth.
+
+Get your API key at: https://developer.slooob.com/dashboard/apps. Note the Client ID and the Client Secret.
+
+---
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Slooob API Setup](#slooob-api-setup)
+* [Usage](#usage)
+    * [Configuration](#configuration)
+    * [Auth Hash](#auth-hash)
+    * [Devise](#devise)
+* [Testing](#testing)
+    * [Test Coverage](#test-coverage)
+* [Contributing](#contributing)
+    * [Contributors](#contributors)
+    * [Semantic Versioning](#semantic-versioning)
+* [License](#license)
+
+---
+
+**Note**: You generate separate keys for development (sandbox) and production (live) with each application you register.
+Use the [config Gem](https://rubygems.org/gems/config) to organize your keys and keep them safe.
+
+For more details we encourage you to read the Slooob Auth API docs: https://developer.slooob.com/docs/api/identity/v1
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-slooob'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-slooob
+
+## Slooob API Setup
+
+* Go to https://developer.slooob.com/dashboard/apps
+* Select your app.
+* Open the Manage APIs tab.
+* Make sure 'Identity API' is enabled.
+* Open the Credentials tab.
+* Set `<YOURDOMAIN>/users/auth/slooob/callback` as Return URL for each 'sandbox' and 'live'.
+* Now Save. It may take a few minutes for changes to take effect.
+
+## Usage
+
+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 :slooob, ENV['SLOOOB_KEY'], ENV['SLOOOB_SECRET']
+end
+```
+
+You can now access the OmniAuth Slooob OAuth2 URL: `/auth/slooob`
+
+For more examples please take a look at `examples/omniauth.rb`
+
+**Note**: While developing your application, if you change the scope in the initializer you will need to restart your app server. Remember that either the 'email' or 'public' scope is required!
+
+### Configuration
+
+You can configure several options, which you pass in to the `provider` method via a hash:
+
+* `scope`: A comma-separated list of permissions you want to request from the user. See the [Identity API docs](https://developer.slooob.com/docs/api/identity/v1/#permissions) for a full list of available permissions. Caveats:
+    * The `email` and `public` scopes are used by default. By defining your own `scope`, you override these defaults, but Slooob requires at least one of `email` or `public`, so make sure to add at least one of them to your scope!
+
+* `redirect_uri`: Override the redirect_uri used by the gem.
+
+* `incremental_authorization`: If this is provided with the value true, and the authorization request is granted, the authorization will include any previous authorizations granted to this user/application combination for other scopes. See Slooob's [Incremental Authorization](https://developer.slooob.com/docs/api/identity/v1/#incremental-authorization) for additional details.
+
+* `image_size`: The size of the user's profile picture. Possible values:
+    * `raw`: 800x800px
+    * `big`: 350x350px
+    * `medium`: 100x100px
+    * `small`: 75x75px
+    * `tiny`: 50x50px
+    * Defaults to `raw`.
+
+### Auth Hash
+
+Here's an example of an authentication hash available in the callback by accessing `request.env['omniauth.auth']`:
+
+```ruby
+{
+    provider: "slooob",
+    uid: "bathjJwvdhKjgfgh8Jd745J7dh5Qkgflbnczd65dfnw",
+    info: {
+        email: "example@example.com",
+        username: "jony",
+        name: "John Smith",
+        first_name: "John",
+        last_name: "Smith",
+        description: "I love cats.",
+        image: "https://cdn.slooob.com/raw",
+        location: nil,
+        confirmed: true,
+        urls: {
+            website: "https://jonyscats.com",
+            slooob: "https://slooob.com/a/jony"
+        }
+    },
+    credentials: {
+        token: "token",
+        refresh_token: "refresh_token",
+        expires_at: 1355082790,
+        expires: true
+    },
+    extra: {
+        raw_info: {
+            username: "jony",
+            name: "John Smith",
+            first_name: "John",
+            last_name: "Smith",
+            description: "I love cats.",
+            avatar: {
+                raw: "https://cdn.slooob.com/raw",
+                big: "https://cdn.slooob.com/big",
+                medium: "https://cdn.slooob.com/medium",
+                small: "https://cdn.slooob.com/small",
+                tiny: "https://cdn.slooob.com/tiny"
+            },
+            location: nil,
+            latitude: nil,
+            longitude: nil,
+            phone: nil,
+            birthday: nil,
+            website: "https://jonyscats.com",
+            profile: "https://slooob.com/a/jony",
+            plan: "basic",
+            email_confirmed: true,
+            verified: false,
+            lang: "en",
+            status: "online",
+            id: 234345676578969343456,
+            created_at: 1259222400,
+            contacts_count: 2,
+            followers_count: 12,
+            following_count: 36,
+            favorites_count: 169,
+            watching_count: 532
+        }
+    }
+}
+```
+
+For more details see the Slooob [List Of Attributes](https://developer.slooob.com/docs/api/identity/v1/#attributes).
+
+### Devise
+
+First define your application id and secret in `config/initializers/devise.rb`. Do not use the snippet mentioned in the [Usage](#usage) section.
+
+```ruby
+require 'omniauth-slooob'
+config.omniauth :slooob, ENV['SLOOOB_CLIENT_ID'], ENV['SLOOOB_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`. In general this is defined in `app/models/user.rb`
+
+```ruby
+devise :omniauthable, omniauth_providers: [:slooob]
+```
+
+Then make sure your callbacks controller is setup.
+
+```ruby
+class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
+    def paypal_oauth2
+        # You need to implement the method below in your model (e.g. app/models/user.rb)
+        @user = User.from_omniauth(request.env['omniauth.auth'])
+
+        if @user.persisted?
+            flash[:notice] = I18n.t 'devise.omniauth_callbacks.success', kind: 'Slooob'
+            sign_in_and_redirect @user, event: :authentication
+        else
+            session['devise.slooob_data'] = request.env['omniauth.auth']
+            redirect_to new_user_registration_url
+        end
+    end
+end
+```
+
+And bind to or create the user
+
+```ruby
+def self.from_omniauth access_token
+    data = access_token.info
+    user = User.where(:email => data["email"]).first
+
+    # Uncomment the section below if you want users to be created if they don't exist
+    # unless user
+    #     user = User.create(name: data["name"],
+    #        email: data["email"],
+    #        password: Devise.friendly_token[0,20]
+    #     )
+    # end
+    user
+end
+```
+
+For your views you can login using:
+
+```erb
+<%= link_to 'Sign in with Slooob', user_slooob_omniauth_authorize_path %>
+
+<%# Devise prior 4.1.0: %>
+<%= link_to 'Sign in with Slooob', user_omniauth_authorize_path(:slooob) %>
+```
+
+An overview is available at https://github.com/plataformatec/devise/wiki/OmniAuth:-Overview
+
+---
+
+## Testing
+
+Tests are written with Shoulda. Tests are run using rake.
+
+1. Fork this repository
+2. Clone your forked git locally
+3. Install dependencies
+
+    `$ bundle install`
+
+4. Run tests
+
+    `$ rake test`
+
+### Test Coverage
+
+Test coverage can be calculated using SimpleCov. Make sure you have the [simplecov gem](https://github.com/colszowka/simplecov) installed.
+
+1. Uncomment SimpleCov in the Gemfile
+2. Uncomment the relevant section in `test/test_helper.rb`
+3. Run tests
+
+    `$ rake test`
+
+---
+
+## Contributing
+
+We hope that you will consider contributing to omniauth-slooob. Please read this short overview for some information about how to get started:
+
+[Learn more about contributing to this repository](https://github.com/slooob/omniauth-slooob/blob/master/CONTRIBUTING.md), [Code of Conduct](https://github.com/slooob/omniauth-slooob/blob/master/CODE_OF_CONDUCT.md)
+
+### Contributors
+
+Give the people some :heart: who are working on this project. See them all at:
+
+https://github.com/slooob/omniauth-slooob/graphs/contributors
+
+### Semantic Versioning
+
+omniauth-slooob follows Semantic Versioning 2.0 as defined at http://semver.org.
+
+## License
+
+MIT License
+
+Copyright (c) 2017 Slooob
+
+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.