yt-auth 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa59f6dde7868b7585152893893aa77a79404528
-  data.tar.gz: 64625fa7604cb3f253c577102ade540aa317c14d
+  metadata.gz: eae916ff8a0b31773c93ae830d2d151c894724af
+  data.tar.gz: 8143530fa4e8b21f3457fc411602e55d4d13ddd5
 SHA512:
-  metadata.gz: 135e580bd9fb49f1d4011fc63a2f3dcb5899b7879e632558b1b5be9517d7033c87244c31792172b0be41c0d24ff9e32282dc1a8e06c754ab9940c2a81ed72fa2
-  data.tar.gz: 17888e161fe3e40501f2257e0a94428ddcb2d56ba9427f2e2a15922be4508aa0b2bafaca0ff81ab33ad534a80bda31b469cc94cb08fb66c59e33ce509669b11b
+  metadata.gz: a0e6e06cc458c1ec49e1e17fdf86bbe76f37982e4b875ac0e6dc2c7325a94116186512f09a2a2ddf05f2a74f1d00f10444a3fbaf5f69a4e9783298df10edd28a
+  data.tar.gz: 41678fd22b58200a537f4a7c9461b61dd3d6f2fc1180644afc59b7f38610fe7015d37f0c580d3300a940737d937cf0bb923f769e87ab2ec8427769f0dc7e258f

data/.rspec

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

data/.travis.yml

@@ -1,3 +1,9 @@
+sudo: false
 language: ruby
+notifications:
+  email: false
 rvm:
-  - 2.2.2
+  - 2.3.1
+script:
+  - bundle exec rspec
+  - bundle exec yard stats | grep "100.00% documented"

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+For more information about changelogs, check
+[Keep a Changelog](http://keepachangelog.com) and
+[Vandamme](http://tech-angels.github.io/vandamme).
+
+## 0.1.0  - 2017-03-27
+
+* [FEATURE] Add `AuthError`
+* [FEATURE] Add `email`
+* [FEATURE] Add `url`

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 claudiob
+Copyright (c) 2017 Fullscreen, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,3 +1,70 @@
-# Yt::Auth
+Yt::Auth - authenticate users with their Google account
+=======================================================
 
-:star: :star: :star:
+Yt::Auth helps you write apps that need to authenticate users by means of their Google account.
+
+The **source code** is available on [GitHub](https://github.com/fullscreen/yt-auth) and the **documentation** on [RubyDoc](http://www.rubydoc.info/gems/yt-auth/frames).
+
+[![Build Status](http://img.shields.io/travis/Fullscreen/yt-auth/master.svg)](https://travis-ci.org/Fullscreen/yt-auth)
+[![Coverage Status](http://img.shields.io/coveralls/Fullscreen/yt-auth/master.svg)](https://coveralls.io/r/Fullscreen/yt-auth)
+[![Dependency Status](http://img.shields.io/gemnasium/Fullscreen/yt-auth.svg)](https://gemnasium.com/Fullscreen/yt-auth)
+[![Code Climate](http://img.shields.io/codeclimate/github/Fullscreen/yt-auth.svg)](https://codeclimate.com/github/Fullscreen/yt-auth)
+[![Online docs](http://img.shields.io/badge/docs-✓-green.svg)](http://www.rubydoc.info/gems/yt-auth/frames)
+[![Gem Version](http://img.shields.io/gem/v/yt-auth.svg)](http://rubygems.org/gems/yt-auth)
+
+The Yt::Auth library provides two methods: `url` and `email`.
+
+Yt::Auth#url
+------------
+
+With the `url` method, you can obtain a URL where to redirect users who need to
+authenticate with their Google account in order to use your application:
+
+```ruby
+redirect_uri = 'https://example.com/auth' # REPLACE WITH REAL ONE
+Yt::Auth.new(redirect_uri: redirect_uri).url
+ # => https://accounts.google.com/o/oauth2/auth?client_id=...&scope=email&redirect_uri=https%3A%2F%2Fexample.com%2Fauth&response_type=code
+```
+
+Yt::Auth#email
+--------------
+
+After users have authenticated with their Google account, they will be
+redirected to the `redirect_uri` you indicated, with an extra `code` query
+parameter, e.g. `https://example.com/auth?code=1234`
+
+With the `email` method, you can obtain the verified email of the users:
+
+```ruby
+redirect_uri = 'https://example.com/auth' # REPLACE WITH REAL ONE
+code = '1234' # REPLACE WITH REAL ONE
+Yt::Auth.new(redirect_uri: redirect_uri, code: code).email
+ # => "user@example.com"
+```
+
+Yt::AuthError
+-------------
+
+`Yt::AuthError` will be raised whenever something goes wrong during the
+authentication process. The message of the error will include the details:
+
+```ruby
+redirect_uri = 'https://example.com/auth' # REPLACE WITH REAL ONE
+code = 'this-is-not-a-valid-code'
+Yt::Auth.new(redirect_uri: redirect_uri, code: code).email
+ # => Yt::AuthError: Invalid authorization code.
+```
+
+
+How to contribute
+=================
+
+Contribute to the code by forking the project, adding the missing code,
+writing the appropriate tests and submitting a pull request.
+
+In order for a PR to be approved, all the tests need to pass and all the public
+methods need to be documented and listed in the guides. Remember:
+
+- to run all tests locally: `bundle exec rspec`
+- to generate the docs locally: `bundle exec yard`
+- to list undocumented methods: `bundle exec yard stats --list-undoc`

data/Rakefile

@@ -1 +1,9 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+require 'rspec/core/version'
+
+desc 'Run all examples'
+RSpec::Core::RakeTask.new :spec
+
+task default: [:spec]

data/bin/console

@@ -1,14 +1,14 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "yt-auth"
+require 'bundler/setup'
+require 'yt/auth'
 
 # 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"
+# require 'pry'
 # Pry.start
 
-require "irb"
-IRB.start
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -1,6 +1,7 @@
-#!/bin/bash
+#!/usr/bin/env bash
 set -euo pipefail
 IFS=$'\n\t'
+set -vx
 
 bundle install
 

data/lib/yt/auth/version.rb

@@ -1,5 +1,6 @@
 module Yt
-  module Auth
-    VERSION = "0.0.0"
+  class Auth
+    # current version of gem
+    VERSION = '0.1.0'
   end
 end

data/lib/yt/auth.rb

@@ -0,0 +1,80 @@
+require 'yt/config'
+require 'yt/auth_request'
+
+# An object-oriented Ruby client for YouTube.
+# @see http://www.rubydoc.info/gems/yt/
+module Yt
+  # Provides methods to authenticate a user with the Google OAuth flow.
+  # @see https://developers.google.com/accounts/docs/OAuth2
+  class Auth
+    # @param [Hash] options the options to initialize an instance of Yt::Auth.
+    # @option options [String] :redirect_uri The URI to redirect users to
+    #   after they have completed the Google OAuth flow.
+    # @option options [String] :code A single-use authorization code provided
+    #   by Google OAuth to obtain an access token to access Google API.
+    def initialize(options = {})
+      @redirect_uri = options[:redirect_uri]
+      @code = options[:code]
+    end
+
+    # @return [String] the URL where to authenticate with a Google account.
+    def url
+      host = 'accounts.google.com'
+      path = '/o/oauth2/auth'
+      query = URI.encode_www_form url_params
+      URI::HTTPS.build(host: host, path: path, query: query).to_s
+    end
+
+    # @return [String] the email of an authenticated Google account.
+    def email
+      response = AuthRequest.new(email_params).run
+      response.body['email']
+    end
+
+  private
+
+    def url_params
+      {}.tap do |params|
+        params[:client_id] = Yt.configuration.client_id
+        params[:scope] = :email
+        params[:redirect_uri] = @redirect_uri
+        params[:response_type] = :code
+      end
+    end
+
+    def email_params
+      {}.tap do |params|
+        params[:path] = '/oauth2/v2/userinfo'
+        params[:headers] = {Authorization: "Bearer #{tokens['access_token']}"}
+      end
+    end
+
+    # @return [Hash] the tokens of an authenticated Google account.
+    def tokens
+      AuthRequest.new(tokens_params).run.body
+    end
+
+    def tokens_params
+      {}.tap do |params|
+        params[:host] = 'accounts.google.com'
+        params[:path] = '/o/oauth2/token'
+        params[:method] = :post
+        params[:request_format] = :form
+        params[:body] = tokens_body
+        params[:error_message] = ->(body) {
+          JSON(body)['error_description'] || 'Invalid authorization code.'
+        }
+      end
+    end
+
+    def tokens_body
+      {}.tap do |params|
+        params[:client_id] = Yt.configuration.client_id
+        params[:client_secret] = Yt.configuration.client_secret
+        params[:code] = @code
+        params[:redirect_uri] = @redirect_uri
+        params[:grant_type] = :authorization_code
+      end
+    end
+  end
+end

data/lib/yt/auth_error.rb

@@ -0,0 +1,5 @@
+module Yt
+  # A wrapper around StandardError.
+  class AuthError < StandardError
+  end
+end

data/lib/yt/auth_request.rb

@@ -0,0 +1,91 @@
+require 'net/http'
+require 'json'
+require 'yt/auth_error'
+
+module Yt
+  # @private
+  # A wrapper around Net::HTTP to send HTTP requests to any web API and
+  # return their result or raise an error if the result is unexpected.
+  class AuthRequest
+    # Initializes an AuthRequest object.
+    def initialize(options = {})
+      @host = options.fetch :host, 'www.googleapis.com'
+      @path = options[:path]
+      @method = options.fetch :method, :get
+      @headers = options.fetch :headers, {}
+      @body = options[:body]
+      @request_format = options.fetch :request_format, :json
+      @error_message = options.fetch :error_message, ->(body) {"Error: #{body}"}
+    end
+
+    # Sends the request and returns the response.
+    def run
+      if response.is_a? Net::HTTPSuccess
+        response.tap do
+          parse_response!
+        end
+      else
+        raise Yt::AuthError, error_message
+      end
+    end
+
+  private
+
+    # @return [URI::HTTPS] the (memoized) URI of the request.
+    def uri
+      attributes = {host: @host, path: @path}
+      @uri ||= URI::HTTPS.build attributes
+    end
+
+    # @return [Net::HTTPRequest] the full HTTP request object,
+    #   inclusive of headers of request body.
+    def http_request
+      net_http_class = Object.const_get "Net::HTTP::#{@method.capitalize}"
+      @http_request ||= net_http_class.new(uri.request_uri).tap do |request|
+        set_request_body! request
+        set_request_headers! request
+      end
+    end
+
+    # Adds the request body to the request in the appropriate format.
+    # if the request body is a JSON Object, transform its keys into camel-case,
+    # since this is the common format for JSON APIs.
+    def set_request_body!(request)
+      if @body
+        request.set_form_data @body
+      end
+    end
+
+    # Adds the request headers to the request in the appropriate format.
+    # The User-Agent header is also set to recognize the request, and to
+    # tell the server that gzip compression can be used, since Net::HTTP
+    # supports it and automatically sets the Accept-Encoding header.
+    def set_request_headers!(request)
+      if @request_format == :json
+        request.initialize_http_header 'Content-Type' => 'application/json'
+      end
+      @headers.each do |name, value|
+        request.add_field name, value
+      end
+    end
+
+    # Run the request and memoize the response or the server error received.
+    def response
+      @response ||= Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+        http.request http_request
+      end
+    end
+
+    # Replaces the body of the response with the parsed version of the body,
+    # according to the format specified in the AuthRequest.
+    def parse_response!
+      if response.body
+        response.body = JSON response.body
+      end
+    end
+
+    def error_message
+      @error_message.call response.body
+    end
+  end
+end

data/yt-auth.gemspec

@@ -4,22 +4,30 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'yt/auth/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "yt-auth"
+  spec.name          = 'yt-auth'
   spec.version       = Yt::Auth::VERSION
-  spec.authors       = ["claudiob"]
-  spec.email         = ["claudiob@gmail.com"]
+  spec.authors       = ['Claudio Baccigalupo', 'Kang-Kyu Lee']
+  spec.email         = ['claudio@fullscreen.net', 'kang-kyu.lee@fullscreen.net']
 
-  spec.summary       = %q{Write a short summary, because Rubygems requires one.}
-  spec.description   = %q{Write a longer description or delete this line.}
-  spec.homepage      = "https://github.com/fullscreen/yt-auth"
-  spec.license       = "MIT"
+  spec.summary       = %q{Google Authentication Ruby client}
+  spec.description   = %q{Yt::Auth makes it easy to authenticate users to any
+    web application by means of their Google account.}
+  spec.homepage      = 'https://github.com/fullscreen/yt-auth'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 2.2.2'
 
-  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'yt-support', '>= 0.1'
 
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'coveralls', '~> 0.8.15'
+  spec.add_development_dependency 'pry-nav', '~> 0.2.4'
+  spec.add_development_dependency 'yard', '~> 0.9.5'
 end

metadata

@@ -1,29 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: yt-auth
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
-- claudiob
+- Claudio Baccigalupo
+- Kang-Kyu Lee
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-22 00:00:00.000000000 Z
+date: 2017-03-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: yt-support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,23 +67,72 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Write a longer description or delete this line.
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.15
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.15
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+description: |-
+  Yt::Auth makes it easy to authenticate users to any
+      web application by means of their Google account.
 email:
-- claudiob@gmail.com
+- claudio@fullscreen.net
+- kang-kyu.lee@fullscreen.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- lib/yt-auth.rb
+- lib/yt/auth.rb
 - lib/yt/auth/version.rb
+- lib/yt/auth_error.rb
+- lib/yt/auth_request.rb
 - yt-auth.gemspec
 homepage: https://github.com/fullscreen/yt-auth
 licenses:
@@ -68,7 +146,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -79,5 +157,5 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Write a short summary, because Rubygems requires one.
+summary: Google Authentication Ruby client
 test_files: []

data/lib/yt-auth.rb

@@ -1,3 +0,0 @@
-module Yt::Auth
-  # Your code goes here...
-end