yt-auth 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eae916ff8a0b31773c93ae830d2d151c894724af
-  data.tar.gz: 8143530fa4e8b21f3457fc411602e55d4d13ddd5
+  metadata.gz: f0c8b8b1fb86567a1fac8a9f824c02df621588c0
+  data.tar.gz: bef00004294f1b4f60dfc14c4f47821cd632bdf9
 SHA512:
-  metadata.gz: a0e6e06cc458c1ec49e1e17fdf86bbe76f37982e4b875ac0e6dc2c7325a94116186512f09a2a2ddf05f2a74f1d00f10444a3fbaf5f69a4e9783298df10edd28a
-  data.tar.gz: 41678fd22b58200a537f4a7c9461b61dd3d6f2fc1180644afc59b7f38610fe7015d37f0c580d3300a940737d937cf0bb923f769e87ab2ec8427769f0dc7e258f
+  metadata.gz: 58ddb25205d859933ac217a9250806fa63a6de154710dde3984b4cf011f599631d3e5550bcc28a5909f472f197f984095d7cfce858ab061d8deef1308682080d
+  data.tar.gz: 02444caa168eddd2ca09218690b024baf76f67c6ab675cae7b91269ee4fb1ebd1cf14dd30b6559e19ffd8b79114b682c8cd4af61c207e13960af55ddeb064f27

data/CHANGELOG.md

@@ -6,6 +6,16 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.2.0  - 2017-03-29
+
+**How to upgrade**
+
+If your code uses `Yt::AuthError` then you must use `Yt::HTTPError` instead.
+If your code uses `Yt::AuthRequest` then you must use `Yt::HTTPRequest` instead.
+
+* [ENHANCEMENT] Extract `AuthError` to `HTTPError` in yt-support gem
+* [ENHANCEMENT] Extract `AuthRequest` to `HTTPRequest` in yt-support gem
+
 ## 0.1.0  - 2017-03-27
 
 * [FEATURE] Add `AuthError`

data/README.md

@@ -12,7 +12,7 @@ The **source code** is available on [GitHub](https://github.com/fullscreen/yt-au
 [![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`.
+The Yt::Auth class provides two public methods: `url` and `email`.
 
 Yt::Auth#url
 ------------
@@ -42,17 +42,17 @@ Yt::Auth.new(redirect_uri: redirect_uri, code: code).email
  # => "user@example.com"
 ```
 
-Yt::AuthError
+Yt::HTTPError
 -------------
 
-`Yt::AuthError` will be raised whenever something goes wrong during the
+`Yt::HTTPError` 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.
+ # => Yt::HTTPError: Invalid authorization code.
 ```
 
 

data/lib/yt/auth.rb

@@ -1,5 +1,5 @@
 require 'yt/config'
-require 'yt/auth_request'
+require 'yt/http_request'
 
 # An object-oriented Ruby client for YouTube.
 # @see http://www.rubydoc.info/gems/yt/
@@ -27,7 +27,7 @@ module Yt
 
     # @return [String] the email of an authenticated Google account.
     def email
-      response = AuthRequest.new(email_params).run
+      response = HTTPRequest.new(email_params).run
       response.body['email']
     end
 
@@ -51,7 +51,7 @@ module Yt
 
     # @return [Hash] the tokens of an authenticated Google account.
     def tokens
-      AuthRequest.new(tokens_params).run.body
+      HTTPRequest.new(tokens_params).run.body
     end
 
     def tokens_params

data/lib/yt/auth/version.rb

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

data/yt-auth.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'yt-support', '>= 0.1'
+  spec.add_dependency 'yt-support', '>= 0.1.1'
 
   spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'rspec', '~> 3.5'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yt-auth
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Claudio Baccigalupo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-27 00:00:00.000000000 Z
+date: 2017-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yt-support
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -131,8 +131,6 @@ files:
 - bin/setup
 - 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:

data/lib/yt/auth_error.rb

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

data/lib/yt/auth_request.rb

@@ -1,91 +0,0 @@
-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