yt-support 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c6a662f825d0c472754909155714397c84cf600c
-  data.tar.gz: 4999e00a754f796f8b9d5a00fed15fa538dc69bd
+SHA256:
+  metadata.gz: a3ec0b0a78227d1ed98c1c3a30a52856cfcc29d2626caaa0d0fb7594f00fa089
+  data.tar.gz: 43c49aadfe5b17c1b4284ca714090dd7bd1e8bd393438d32d941e3b3773e17f1
 SHA512:
-  metadata.gz: d91e68dea4b16beb241f28eb8808f56bd35536988c7e2565d463badf90d0568c5c4b9a64e2ee0d11dd90dc1240c1c22968e9afa8274e1189b63d26691c6c7ca1
-  data.tar.gz: 45245e9ec74c83598d767d472df76e88c2a375ab34d92f770b5e5e7e52890d848f061cf39288bbc8b7b75c498554c5e9062fcfdb063f3812b755defdf0047dff
+  metadata.gz: 972b41f231f9ff50a3c4602ecbb17a8d3ddf235f85023370c3c8be331769e30c8a6fdb3e8cedc6ec1fa39144569ee825c9c245c22863fab91e1029762bb2c363
+  data.tar.gz: f47aa72b0c5c6c9fb87b5829bb7c80bd44ca825c2a4310e3d4426c8955ab20c246ca846c74e62fdcc8151a3a024054d265de112f1f38149709ded0a88c9a6593

data/CHANGELOG.md

@@ -6,6 +6,18 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 1.0.0 - 2024/12/10
+
+* [FEATURE] Add `mock_auth_error` and `mock_auth_error` to `Yt.configuration`.
+
+## 0.1.4 - 2018/10/03
+
+* [FEATURE] Add ActiveSupport::Notification based instrumentation.
+
+## 0.1.3 - 2017-06-02
+
+* [FEATURE] Add `Yt.configuration.access_token` and `.refresh_token`
+
 ## 0.1.2 - 2017-04-02
 
 * [FEATURE] Add Yt::ConnectionError to deal with connection/server errors

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Fullscreen, Inc.
+Copyright (c) 2017-present 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/lib/yt/configuration.rb

@@ -44,6 +44,16 @@ module Yt
     # @return [String] the level of output to print for debugging purposes.
     attr_accessor :log_level
 
+    # @return [String] the access token to act on behalf of a YouTube account.
+    attr_accessor :access_token
+
+    # @return [String] a mock error to raise when trying to authenticate.
+    attr_accessor :mock_auth_error
+
+    # @return [String] a mock email to return when authenticating.
+    # If 'invalid-email' then try to authenticate will raise an error.
+    attr_accessor :mock_auth_email
+
     # Initialize the global configuration settings, using the values of
     # the specified following environment variables by default.
     def initialize
@@ -51,6 +61,8 @@ module Yt
       @client_secret = ENV['YT_CLIENT_SECRET']
       @api_key = ENV['YT_API_KEY']
       @log_level = ENV['YT_LOG_LEVEL']
+      @mock_auth_error = ENV['YT_MOCK_AUTH_ERROR']
+      @mock_auth_email = ENV['YT_MOCK_AUTH_EMAIL']
     end
 
     # @return [Boolean] whether the logging output is extra-verbose.

data/lib/yt/http_error.rb

@@ -1,5 +1,11 @@
 module Yt
   # A wrapper around StandardError.
   class HTTPError < StandardError
+    attr_reader :response
+
+    def initialize(msg, response: nil)
+      super msg
+      @response = response
+    end
   end
 end

data/lib/yt/http_request.rb

@@ -38,7 +38,7 @@ module Yt
       @headers = options.fetch :headers, {}
       @body = options[:body]
       @request_format = options.fetch :request_format, :json
-      @error_message = options.fetch :error_message, ->(body) {"Error: #{body}"}
+      @error_message = options.fetch :error_message, ->(code) {"Error: #{code}"}
     end
 
     # Sends the request and returns the response with the body parsed from JSON.
@@ -50,7 +50,7 @@ module Yt
           parse_response!
         end
       else
-        raise Yt::HTTPError, error_message
+        raise Yt::HTTPError.new(error_message, response: response)
       end
     end
 
@@ -85,13 +85,25 @@ module Yt
       end
     end
 
+    def as_curl
+      'curl'.tap do |curl|
+        curl <<  " -X #{http_request.method}"
+        http_request.each_header{|k, v| curl << %Q{ -H "#{k}: #{v}"}}
+        curl << %Q{ -d '#{http_request.body}'} if http_request.body
+        curl << %Q{ "#{uri.to_s}"}
+      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
+      case @request_format
+        when :json
+          request.body = @body.to_json
+        when :form
+          request.set_form_data @body
+      end if @body
     end
 
     # Adds the request headers to the request in the appropriate format.
@@ -109,8 +121,12 @@ module Yt
 
     # 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
+      instrument do |data|
+        @response ||= Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+          puts as_curl if Yt.configuration.developing?
+          http.request http_request
+        end
+        data[:response] = @response
       end
     rescue *server_errors => e
       raise Yt::ConnectionError, e.message
@@ -134,7 +150,20 @@ module Yt
     end
 
     def error_message
-      @error_message.call response.body
+      @error_message.call response.code
+    end
+
+    def instrument(&block)
+      data = {
+        request: http_request,
+        method: http_request.method,
+        request_uri: uri
+      }
+      if defined?(ActiveSupport::Notifications)
+        ActiveSupport::Notifications.instrument 'request.yt', data, &block
+      else
+        block.call(data)
+      end
     end
   end
 end

data/lib/yt/support/version.rb

@@ -1,7 +1,8 @@
 module Yt
   # Provides common functionality to all Yt gems.
   module Support
-    # current version of gem
-    VERSION = '0.1.2'
+    # @return [String] the SemVer-compatible gem version.
+    # @see http://semver.org
+    VERSION = '1.0.0'
   end
 end

data/yt-support.gemspec

@@ -17,15 +17,16 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.2.2'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  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.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'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'yard'
 end

metadata

@@ -1,100 +1,86 @@
 --- !ruby/object:Gem::Specification
 name: yt-support
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Claudio Baccigalupo
 - Kang-Kyu Lee
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-04-02 00:00:00.000000000 Z
+date: 2024-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.15
+        version: '0'
   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
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: '0'
 description: |-
   Yt::Support provides common functionality to Yt,
       Yt::Auth. It is considered suitable for internal use only at this time.
@@ -127,7 +113,7 @@ homepage: https://github.com/fullscreen/yt-support
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -142,9 +128,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.5.23
+signing_key:
 specification_version: 4
 summary: Support utilities for Yt gems
 test_files: []