yt-support 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 320897c435303a2e12b6889a59b0258dd249b4ef
+  data.tar.gz: d96402625a05ab1e621d98b94a6e7810253a0a92
+SHA512:
+  metadata.gz: a848182a029379a5c58640a1c7bdeae13f15fda93db35378ff1af40df4540bfa3089f089b09e9ae91dc6e2eb8422432b6376cd8ae76734f659984db36caa86c7
+  data.tar.gz: c47d0461dac76678f894ccb80d6a34f63af935f5206a12a35b23f90b850291bbf5e263af46e482287ba69f0a468a8448fa80c71ddb3aa78cef326dd536435b4a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--fail-fast

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# 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-17
+
+* [FEATURE] Extracted Yt::Config and Yt::Configuration from Yt

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+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
+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,32 @@
+Common code needed by the other Yt gems
+=======================================
+
+Yt::Support provides common functionality to all Yt gems.
+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)
+[![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)
+
+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)
+
+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

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

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "yt/support"
+
+# 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/yt/config.rb

@@ -0,0 +1,55 @@
+require 'yt/configuration'
+
+# An object-oriented Ruby client for YouTube.
+# @see http://www.rubydoc.info/gems/yt/
+module Yt
+  # Provides methods to read and write global configuration settings.
+  #
+  # A typical usage is to set the API keys retrieved from the
+  # {http://console.developers.google.com Google Developers Console}.
+  #
+  # @example Set the API key for a server-only YouTube app:
+  #   Yt.configure do |config|
+  #     config.api_key = 'ABCDEFGHIJ1234567890'
+  #   end
+  #
+  # @example Set the API client id/secret for a web-client YouTube app:
+  #   Yt.configure do |config|
+  #     config.client_id = 'ABCDEFGHIJ1234567890'
+  #     config.client_secret = 'ABCDEFGHIJ1234567890'
+  #   end
+  #
+  # Note that Yt.configure has precedence over values through with
+  # environment variables (see {Yt::Models::Configuration}).
+  #
+  module Config
+    # Yields the global configuration to the given block.
+    #
+    # @example
+    #   Yt.configure do |config|
+    #     config.api_key = 'ABCDEFGHIJ1234567890'
+    #   end
+    #
+    # @yield [Yt::Models::Configuration] The global configuration.
+    def configure
+      yield configuration if block_given?
+    end
+
+    # Returns the global {Yt::Models::Configuration} object.
+    #
+    # While this method _can_ be used to read and write configuration settings,
+    # it is easier to use {Yt::Config#configure} Yt.configure}.
+    #
+    # @example
+    #     Yt.configuration.api_key = 'ABCDEFGHIJ1234567890'
+    #
+    # @return [Yt::Models::Configuration] The global configuration.
+    def configuration
+      @configuration ||= Yt::Configuration.new
+    end
+  end
+
+  # @note Config is the only module auto-loaded in the Yt module,
+  #       in order to have a syntax as easy as Yt.configure
+  extend Config
+end

data/lib/yt/configuration.rb

@@ -0,0 +1,68 @@
+module Yt
+  # Provides an object to store global configuration settings.
+  #
+  # This class is typically not used directly, but by calling
+  # {Yt::Config#configure Yt.configure}, which creates and updates a single
+  # instance of {Yt::Models::Configuration}.
+  #
+  # @example Set the API client id/secret for a web-client YouTube app:
+  #   Yt.configure do |config|
+  #     config.client_id = 'ABCDEFGHIJ1234567890'
+  #     config.client_secret = 'ABCDEFGHIJ1234567890'
+  #   end
+  #
+  # @see Yt::Config for more examples.
+  #
+  # An alternative way to set global configuration settings is by storing
+  # them in the following environment variables:
+  #
+  # * +YT_CLIENT_ID+ to store the Client ID for web/device apps
+  # * +YT_CLIENT_SECRET+ to store the Client Secret for web/device apps
+  # * +YT_API_KEY+ to store the API key for server/browser apps
+  # * +YT_LOG_LEVEL+ to store the verbosity level of the logs
+  #
+  # In case both methods are used together,
+  # {Yt::Config#configure Yt.configure} takes precedence.
+  #
+  # @example Set the API client id/secret for a web-client YouTube app:
+  #   ENV['YT_CLIENT_ID'] = 'ABCDEFGHIJ1234567890'
+  #   ENV['YT_CLIENT_SECRET'] = 'ABCDEFGHIJ1234567890'
+  #
+  class Configuration
+    # @return [String] the Client ID for web/device YouTube applications.
+    # @see https://console.developers.google.com Google Developers Console
+    attr_accessor :client_id
+
+    # @return [String] the Client Secret for web/device YouTube applications.
+    # @see https://console.developers.google.com Google Developers Console
+    attr_accessor :client_secret
+
+    # @return [String] the API key for server/browser YouTube applications.
+    # @see https://console.developers.google.com Google Developers Console
+    attr_accessor :api_key
+
+    # @return [String] the level of output to print for debugging purposes.
+    attr_accessor :log_level
+
+    # Initialize the global configuration settings, using the values of
+    # the specified following environment variables by default.
+    def initialize
+      @client_id = ENV['YT_CLIENT_ID']
+      @client_secret = ENV['YT_CLIENT_SECRET']
+      @api_key = ENV['YT_API_KEY']
+      @log_level = ENV['YT_LOG_LEVEL']
+    end
+
+    # @return [Boolean] whether the logging output is extra-verbose.
+    #   Useful when developing (e.g., to print the curl of every request).
+    def developing?
+      %w(devel).include? log_level.to_s
+    end
+
+    # @return [Boolean] whether the logging output is verbose.
+    #   Useful when debugging (e.g., to print the curl of failing requests).
+    def debugging?
+      %w(devel debug).include? log_level.to_s
+    end
+  end
+end

data/lib/yt/support.rb

@@ -0,0 +1 @@
+require 'yt/config'

data/lib/yt/support/version.rb

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

data/yt-support.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yt/support/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'yt-support'
+  spec.version       = Yt::Support::VERSION
+  spec.authors       = ['Claudio Baccigalupo', 'Kang-Kyu Lee']
+  spec.email         = ['claudio@fullscreen.net', 'kang-kyu.lee@fullscreen.net']
+
+  spec.summary       = %q{Support utilities for Yt gems}
+  spec.description   = %q{Yt::Support provides common functionality to Yt,
+    Yt::Auth. It is considered suitable for internal use only at this time.}
+  spec.homepage      = 'https://github.com/fullscreen/yt-support'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 2.2.2'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  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'
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: yt-support
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Claudio Baccigalupo
+- Kang-Kyu Lee
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-17 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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
+    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: 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::Support provides common functionality to Yt,
+      Yt::Auth. It is considered suitable for internal use only at this time.
+email:
+- 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/config.rb
+- lib/yt/configuration.rb
+- lib/yt/support.rb
+- lib/yt/support/version.rb
+- yt-support.gemspec
+homepage: https://github.com/fullscreen/yt-support
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Support utilities for Yt gems
+test_files: []