yt-support 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 320897c435303a2e12b6889a59b0258dd249b4ef
-  data.tar.gz: d96402625a05ab1e621d98b94a6e7810253a0a92
+  metadata.gz: 52850660c93460a274efca68349e3b6a1cdaf53c
+  data.tar.gz: bd1b2f4d5a3e4c0005dfd2d15ad5b8508c49f33e
 SHA512:
-  metadata.gz: a848182a029379a5c58640a1c7bdeae13f15fda93db35378ff1af40df4540bfa3089f089b09e9ae91dc6e2eb8422432b6376cd8ae76734f659984db36caa86c7
-  data.tar.gz: c47d0461dac76678f894ccb80d6a34f63af935f5206a12a35b23f90b850291bbf5e263af46e482287ba69f0a468a8448fa80c71ddb3aa78cef326dd536435b4a
+  metadata.gz: 0b804979d3bd2d49ef3841e5a0c43f1d692d634b38ef348409396c642257062eaf9cb76db6f0aa107807f9736e532713be08fc4a509978295add768c0490bcf5
+  data.tar.gz: 612a312b478a97225a0b35508fd2f4f40f7e52745f6f1b8bc44c7d6e3e49ea3380d9ec9f2eb65b1d72b5531a73f0e39f719ef971d12235e9247d8f13635b9254

data/CHANGELOG.md

@@ -6,6 +6,10 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.1.1 - 2017-03-29
+
+* [FEATURE] Extracted Yt::HTTPRequest and Yt::HTTPError from Yt::Auth
+
 ## 0.1.0 - 2017-03-17
 
 * [FEATURE] Extracted Yt::Config and Yt::Configuration from Yt

data/README.md

@@ -7,9 +7,9 @@ It is considered suitable for internal use only at this time.
 The **source code** is available on [GitHub](https://github.com/fullscreen/yt-support) and the **documentation** on [RubyDoc](http://www.rubydoc.info/gems/yt-support/frames).
 
 [![Build Status](http://img.shields.io/travis/Fullscreen/yt-support/master.svg)](https://travis-ci.org/Fullscreen/yt-support)
-[![Coverage Status](http://img.shields.io/coveralls/fullscreen/yt-support/master.svg)](https://coveralls.io/r/Fullscreen/yt-support)
-[![Dependency Status](http://img.shields.io/gemnasium/fullscreen/yt-support.svg)](https://gemnasium.com/Fullscreen/yt-support)
-[![Code Climate](http://img.shields.io/codeclimate/github/fullscreen/yt-support.svg)](https://codeclimate.com/github/Fullscreen/yt-support)
+[![Coverage Status](http://img.shields.io/coveralls/Fullscreen/yt-support/master.svg)](https://coveralls.io/r/Fullscreen/yt-support)
+[![Dependency Status](http://img.shields.io/gemnasium/Fullscreen/yt-support.svg)](https://gemnasium.com/Fullscreen/yt-support)
+[![Code Climate](http://img.shields.io/codeclimate/github/Fullscreen/yt-support.svg)](https://codeclimate.com/github/Fullscreen/yt-support)
 [![Online docs](http://img.shields.io/badge/docs-✓-green.svg)](http://www.rubydoc.info/gems/yt-support/frames)
 [![Gem Version](http://img.shields.io/gem/v/yt-support.svg)](http://rubygems.org/gems/yt-support)
 
@@ -17,6 +17,8 @@ Yt::Support provides:
 
 * [Yt.configure](http://www.rubydoc.info/gems/yt-support/Yt/Config#configure-instance_method)
 * [Yt::Configuration](http://www.rubydoc.info/gems/yt-support/Yt/Configuration)
+* [Yt::HTTPRequest](http://www.rubydoc.info/gems/yt-support/Yt/HTTPRequest)
+* [Yt::HTTPError](http://www.rubydoc.info/gems/yt-support/Yt/HTTPError)
 
 How to contribute
 =================

data/lib/yt/http_error.rb

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

data/lib/yt/http_request.rb

@@ -0,0 +1,128 @@
+require 'net/http'
+require 'json'
+require 'yt/http_error'
+
+module Yt
+  # 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.
+  # The basic way to use Request is by calling +run+ on an instance.
+  # @example List the most popular videos on YouTube.
+  #   host = ''www.googleapis.com'
+  #   path = '/youtube/v3/videos'
+  #   params = {chart: 'mostPopular', key: ENV['API_KEY'], part: 'snippet'}
+  #   response = Yt::Request.new(path: path, params: params).run
+  #   response.body['items'].map{|video| video['snippet']['title']}
+  # @api private
+  class HTTPRequest
+    # Initializes a Request object.
+    # @param [Hash] options the options for the request.
+    # @option options [Symbol] :method (:get) The HTTP method to use.
+    # @option options [String] :host The host of the request URI.
+    # @option options [String] :path The path of the request URI.
+    # @option options [Hash] :params ({}) The params to use as the query
+    #   component of the request URI, for instance the Hash +{a: 1, b: 2}+
+    #   corresponds to the query parameters +"a=1&b=2"+.
+    # @option options [Hash] :headers ({}) The headers of the request.
+    # @option options [#size] :body The body of the request.
+    # @option options [Hash] :request_format (:json) The format of the
+    #   requesty body. If a request body is passed, it will be parsed
+    #   according to this format before sending it in the request.
+    # @option options [Proc] :error_message The block that will be invoked
+    #   when a request fails.
+    def initialize(options = {})
+      @method = options.fetch :method, :get
+      @host = options.fetch :host, 'www.googleapis.com'
+      @path = options[:path]
+      @params = options.fetch :params, {}
+      @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 with the body parsed from JSON.
+    # @return [Net::HTTPResponse] if the request succeeds.
+    # @raise [Yt::HTTPError] if the request fails.
+    def run
+      if response.is_a? Net::HTTPSuccess
+        response.tap do
+          parse_response!
+        end
+      else
+        raise Yt::HTTPError, error_message
+      end
+    end
+
+  private
+
+    # @return [URI::HTTPS] the (memoized) URI of the request.
+    def uri
+      attributes = {host: @host, path: @path, query: URI.encode_www_form(query)}
+      @uri ||= URI::HTTPS.build attributes
+    end
+
+    # Equivalent to @params.transform_keys{|key| key.to_s.camelize :lower}
+    def query
+      {}.tap do |camel_case_params|
+        @params.each_key do |key|
+          camel_case_params[camelize key] = @params[key]
+        end
+      end
+    end
+
+    def camelize(part)
+      part.to_s.gsub(/(?:_|(\/))([a-z\d]*)/i) { "#{$1}#{$2.capitalize}" }
+    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 HTTPRequest.
+    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/lib/yt/support.rb

@@ -1 +1,2 @@
 require 'yt/config'
+require 'yt/http_request'

data/lib/yt/support/version.rb

@@ -2,6 +2,6 @@ module Yt
   # Provides common functionality to all Yt gems.
   module Support
     # current version of gem
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yt-support
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Claudio Baccigalupo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-17 00:00:00.000000000 Z
+date: 2017-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,6 +117,8 @@ files:
 - bin/setup
 - lib/yt/config.rb
 - lib/yt/configuration.rb
+- lib/yt/http_error.rb
+- lib/yt/http_request.rb
 - lib/yt/support.rb
 - lib/yt/support/version.rb
 - yt-support.gemspec