oauth-bwergemn 1.0.1

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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 namakukingkong@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and 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,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in auth-bwergemn.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,100 @@
+PATH
+  remote: .
+  specs:
+    oauth_bwergemn (1.0.0)
+      grape (~> 1.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    ast (2.4.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    builder (3.2.4)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    concurrent-ruby (1.1.5)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    equalizer (0.0.11)
+    grape (1.1.0)
+      activesupport
+      builder
+      mustermann-grape (~> 1.0.0)
+      rack (>= 1.3.0)
+      rack-accept
+      virtus (>= 1.0.0)
+    i18n (1.8.1)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    jaro_winkler (1.5.4)
+    minitest (5.13.0)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    mustermann-grape (1.0.1)
+      mustermann (>= 1.0.0)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    rack (2.0.8)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.79.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    zeitwerk (2.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1.0)
+  oauth_bwergemn!
+  rake (~> 10.0)
+  rspec (~> 3.7.0)
+  rubocop (~> 0.79.0)
+  rubocop-performance (~> 1.5.2)
+
+BUNDLED WITH
+   2.1.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Namakukingkong
+
+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,114 @@
+# Oauth Bwergemn on Grape API
+
+Oauth Bwergemn is a Grape middleware to connect your API resources with your API authenticator.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'oauth-bwergemn'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oauth-bwergemn
+
+## Usage
+
+### Install generator
+
+On your first install, run this generator :
+
+```ruby
+rails g oauth_bwergemn:install
+```
+
+### Usage with Grape
+
+You will need to use the middleware in your main API :
+
+```ruby
+# use middleware
+use ::OauthBwergemn::Oauth2
+```
+
+You could also use the helpers :
+
+```ruby
+# use helpers
+helpers ::OauthBwergemn::Helpers
+```
+
+And also don't forget to rescue the invalid token :
+
+```ruby
+# rescue invalid token
+rescue_from OauthBwergemn::Errors::InvalidToken do |e|
+  error!(e, 401)
+end
+rescue_from OauthBwergemn::Errors::InvalidScope do |e|
+  error!(e, 401)
+end
+```
+
+### Protecting your endpoint
+
+In your endpoint you need to define which protected endpoint by adding this DSL :
+
+1.  `oauth2`
+2.  `oauth2 "email"`
+
+Example :
+
+```ruby
+desc "Your protected endpoint"
+oauth2 
+get :protected do
+    # your code goes here
+end
+```
+
+```ruby
+desc "Your protected endpoint with defined scope"
+oauth2 "email"
+get :protected do
+    # your code goes here
+end
+```
+
+## Nice feature
+
+From your protected endpoint you could get :
+
+1. `resource_access_token` => Your access token
+2. `resource_credentials` => Full credentials
+3. `resource_owner` => Current Object
+
+
+## TODO
+
+- Add rspec test
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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/namakukingkong/oauth-bwergemn ] . This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Oauth Bwergemn project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/namakukingkong/oauth-bwergemn/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "oauth-bwergemn"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/oauth_bwergemn/install_generator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module OauthBwergemn
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../../templates', __FILE__)
+
+    def copy_initializer
+      template 'initializer.rb', 'config/initializers/oauth_bwergemn.rb'
+    end
+  end
+end

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,5 @@
+OauthBwergemn.setup do |config|
+  # your authentication server
+  config.auth_strategy = "hub"
+  config.resources     = { admin: "Models::Admin", user: "Models::User" }
+end

data/lib/oauth-bwergemn.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'oauth_bwergemn/version'
+
+require 'grape'
+
+require 'oauth_bwergemn/configuration'
+
+require 'oauth_bwergemn/oauth2'
+require 'oauth_bwergemn/extension'
+require 'oauth_bwergemn/helpers'
+
+require 'oauth_bwergemn/base_strategy'
+require 'oauth_bwergemn/auth_strategies/hub'
+require 'oauth_bwergemn/auth_methods/auth_methods'
+
+require 'oauth_bwergemn/errors/invalid_token'
+require 'oauth_bwergemn/errors/invalid_scope'
+
+module OauthBwergemn
+  extend OauthBwergemn::Configuration
+  define_setting :auth_strategy, 'hub'
+  define_setting :resources, user: 'User'
+
+  def self.config_resources
+    resources
+  end
+end

data/lib/oauth_bwergemn/auth_methods/auth_methods.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module OauthBwergemn
+  module AuthMethods
+    attr_accessor :the_access_token, :current_user, :credentials
+    attr_accessor :resource__token, :resource_owner, :resource_credentials
+
+    def protected_endpoint=(protected)
+      @protected_endpoint = protected
+    end
+
+    def protected_endpoint?
+      @protected_endpoint || false
+    end
+
+    def optional_endpoint=(opt)
+      @optional_endpoint = opt
+    end
+
+    def optional_endpoint?
+      @optional_endpoint || false
+    end
+
+    # rubocop:disable Lint/DuplicateMethods
+    def resource_token
+      @_resource_token
+    end
+
+    def resource_token=(token)
+      @_resource_token = token
+    end
+
+    def resource_owner=(resource)
+      @_resource_owner = resource
+    end
+
+    def resource_owner
+      @_resource_owner
+    end
+
+    def resource_credentials=(credentials)
+      @_resource_credentials = credentials
+    end
+
+    def resource_credentials
+      @_resource_credentials
+    end
+    # rubocop:enable Lint/DuplicateMethods
+  end
+end