oauth_token_verifier 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec509c6ef623d7c5f4c3e99bcc9998f6add0f3d9
+  data.tar.gz: e3df41224d4579a2561340036465f8ffc3679a81
+SHA512:
+  metadata.gz: 19b23a9dd996aa58c8f138af2475248902e3695470a3b3bbf13530386cdf7dd23e8870a5e558a8af2831c1043c8e5c0335671221323c6afe8debbeaeb4d5159d
+  data.tar.gz: 5be231ec627f88e026a9c59edcb399eff45f2b66908df1d4e247230ae82d9047285241ec96c2446afc5709736ff313ee5463c47eb8bdbb338fdf73244c333f1b

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.15.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Shkrt
+
+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,47 @@
+# OauthTokenVerifier
+
+This library helps to verify oauth2 access tokens that have been obtained from third party, i.e. mobile application.
+
+## Installation
+
+`gem install oauth_token_verifier`
+
+`gem oauth_token_verifier`
+
+## Configuration
+
+```
+OauthTokenVerifier.configure do |c|
+
+  # You should configure enabled providers first, only three providers are supported by now
+  c.enabled_providers = [:google, :facebook, :vk]
+
+  # then goes separate configuration for each provider
+  # provider name to be returned
+  c.facebook.name = 'facebook'
+
+  # id field - this used to uniquely identify user
+  c.facebook.id_field = 'id'
+
+  # mapping of other returned fields. By default, no fields parameter passed when querying a provider. Feel free to add any field supported by chosen provider
+  c.facebook.fields_mapping = { first_name: :name }
+
+  c.vk.name = 'vkontakte'
+  c.vk.id_field = 'uid'
+  c.vk.fields_mapping = { sex: :gender, photo_id: :avatar }
+
+  c.google.name = 'google'
+  c.google.id_field = 'email'
+  c.google.fields_mapping = { given_name: :first_name, picture: :avatar }
+
+end
+```
+
+## Usage
+
+`include OauthTokenVerifier`
+
+`verify(:google, 'qweqweqwLKJNlknlknlk343=')`
+
+The response will either return a struct, containing profile info fields, or raise an exception with error explanation
+

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_token_verifier'
+
+# 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/oauth_token_verifier/configuration.rb

@@ -0,0 +1,24 @@
+module OauthTokenVerifier
+  class Configuration
+    attr_accessor :enabled_providers, :google, :vk, :facebook
+    ProviderSettings = Struct.new(:fields_mapping, :name, :id_field)
+
+    def initialize
+      @enabled_providers = []
+
+      @google = ProviderSettings.new({
+        'first_name' => 'given_name',
+        'last_name' => 'family_name'
+      }, 'google', 'email')
+
+      @vk = ProviderSettings.new({
+        'first_name' => 'first_name',
+        'last_name' => 'last_name'
+      }, 'vk', 'uid')
+
+      @facebook = ProviderSettings.new({
+        'first_name' => 'name',
+      }, 'facebook', 'id')
+    end
+  end
+end

data/lib/oauth_token_verifier/providers/facebook.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module OauthTokenVerifier::Providers
+  class Facebook
+    BaseFields = Struct.new(:uid, :provider, :info)
+
+    def initialize
+      @data_fields = Struct.new(*config.fields_mapping.values)
+      @request_fields = config.fields_mapping.keys.join(',')
+    end
+
+    def verify_token(context)
+      uri = build_uri(context.token)
+      response = check_response(uri)
+      parse_response(response)
+    end
+
+    private
+
+    def config
+      OauthTokenVerifier.configuration.facebook
+    end
+
+    def build_uri(token)
+      URI::HTTPS.build(host: 'graph.facebook.com',
+                       path: '/me',
+                       query: { access_token: token,
+                                fields: @request_fields
+                              }.to_query)
+    end
+
+    def check_response(uri)
+      response = JSON.parse(Net::HTTP.get(uri))
+      if error = response['error']
+        raise TokenVerifier::TokenCheckError, error['message']
+      else
+        response
+      end
+    end
+
+    def parse_response(data)
+      BaseFields.new(
+        data[config.id_field],
+        config.name,
+        @data_fields.new(
+          *data.values_at(*config.fields_mapping.keys.map(&:to_s))
+        )
+      )
+    end
+  end
+end

data/lib/oauth_token_verifier/providers/google.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module OauthTokenVerifier::Providers
+  class Google
+    BaseFields = Struct.new(:uid, :provider, :info)
+
+    def initialize
+      @data_fields = Struct.new(*config.fields_mapping.values)
+    end
+
+    def verify_token(context)
+      uri = build_uri(context.token)
+      response = check_response(uri)
+      parse_response(response)
+    end
+
+    private
+
+    def config
+      OauthTokenVerifier.configuration.google
+    end
+
+    def build_uri(token)
+      URI::HTTPS.build(host: 'www.googleapis.com',
+                       path: '/oauth2/v3/tokeninfo',
+                       query: { id_token: token }.to_query)
+    end
+
+    def check_response(uri)
+      response = JSON.parse(Net::HTTP.get(uri))
+      if error = response['error_description']
+        raise TokenVerifier::TokenCheckError, error
+      else
+        response
+      end
+    end
+
+    def parse_response(data)
+      BaseFields.new(
+        data[config.id_field],
+        config.name,
+        @data_fields.new(
+          *data.values_at(*config.fields_mapping.keys.map(&:to_s))
+        )
+      )
+    end
+  end
+end

data/lib/oauth_token_verifier/providers/vk.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module OauthTokenVerifier::Providers
+  class Vk
+    BaseFields = Struct.new(:uid, :provider, :info)
+
+    def initialize
+      @data_fields = Struct.new(*config.fields_mapping.values)
+      @request_fields = config.fields_mapping.keys.join(',')
+    end
+
+    def verify_token(context)
+      uri = build_uri(context.token)
+      response = check_response(uri)
+      parse_response(response)
+    end
+
+    private
+
+    def config
+      OauthTokenVerifier.configuration.vk
+    end
+
+    def build_uri(token)
+      URI::HTTPS.build(host: 'api.vk.com',
+                       path: '/method/users.get',
+                       query: { access_token: token,
+                                fields: @request_fields
+                              }.to_query)
+    end
+
+    def check_response(uri)
+      response = JSON.parse(Net::HTTP.get(uri))
+      if error = response['error']
+        raise TokenVerifier::TokenCheckError, error['error_msg']
+      else
+        response['response'].first
+      end
+    end
+
+    def parse_response(data)
+      BaseFields.new(
+        data[config.id_field],
+        config.name,
+        @data_fields.new(
+          *data.values_at(*config.fields_mapping.keys.map(&:to_s))
+        )
+      )
+    end
+  end
+end

data/lib/oauth_token_verifier/version.rb

@@ -0,0 +1,3 @@
+module OauthTokenVerifier
+  VERSION = '0.1.1'.freeze
+end

data/lib/oauth_token_verifier.rb

@@ -0,0 +1,57 @@
+require 'oauth_token_verifier/version'
+require 'oauth_token_verifier/configuration'
+require 'oauth_token_verifier/providers/google'
+require 'oauth_token_verifier/providers/facebook'
+require 'oauth_token_verifier/providers/vk'
+
+module OauthTokenVerifier
+  def verify(provider_name, payload)
+    TokenVerifier.new(provider_name, payload[:token]).verify_token
+  end
+
+  def configure
+    yield configuration
+  end
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+  module_function :configuration, :configure
+
+  class TokenVerifier
+    attr_reader :token
+    attr_accessor :provider
+
+    # TODO: Factor out errors to separate module with inheritance
+    class TokenCheckError < StandardError
+      def initialize(msg)
+        super(msg)
+      end
+    end
+
+    class NoProviderFoundError < StandardError
+      def initialize(msg)
+        super(msg)
+      end
+    end
+
+    def initialize(provider_name, token)
+      @provider = find_provider(provider_name).new
+      @token = token
+    end
+
+    def verify_token
+      @provider.verify_token(self)
+    end
+
+    private
+
+    def find_provider(name)
+      unless OauthTokenVerifier.configuration.enabled_providers.include? name
+        raise NoProviderFoundError, "Oauth provider #{name} is not enabled in configuration"
+      end
+
+      "OauthTokenVerifier::Providers::#{name.to_s.camelize}".constantize
+    end
+  end
+end

data/oauth_token_verifier.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'oauth_token_verifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'oauth_token_verifier'
+  spec.version       = OauthTokenVerifier::VERSION
+  spec.authors       = ['Shkrt']
+  spec.email         = ['zxcgpppmnn@gmail.com']
+
+  spec.summary       = 'Oauth2 token verification'
+  spec.description   = 'This library provides possibility of verifying oauth2 access tokens, obtained from third party'
+  spec.homepage      = "https://github.com/Shkrt/oauth_token_verifier"
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: oauth_token_verifier
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Shkrt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This library provides possibility of verifying oauth2 access tokens,
+  obtained from third party
+email:
+- zxcgpppmnn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/oauth_token_verifier.rb
+- lib/oauth_token_verifier/configuration.rb
+- lib/oauth_token_verifier/providers/facebook.rb
+- lib/oauth_token_verifier/providers/google.rb
+- lib/oauth_token_verifier/providers/vk.rb
+- lib/oauth_token_verifier/version.rb
+- oauth_token_verifier.gemspec
+homepage: https://github.com/Shkrt/oauth_token_verifier
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Oauth2 token verification
+test_files: []