pipe_dream 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f47b91cab96e06142f2cd405feb214c927fcae0
+  data.tar.gz: e8e08de2ea36cd16f29381487068bf96242fdfab
+SHA512:
+  metadata.gz: 6944745d527bff9e69d7aa46ffd00c104353489c09138b1ed1913cea4ec19f56c7119590d696670c74fc59436094bdd5ae2144ad9560f3c1b3ec7fc819bb1648
+  data.tar.gz: e6242e4ce14a76ffe315ba64c61d58d0d328dda381e172818c717763efb05d236099e5faa10455e977c0d8c2597d3d275ffb224f1704ce9818d85240631711be

data/.circleci/config.yml

@@ -0,0 +1,62 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.3.3-node-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/pipe_dream
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run rubocop
+      - run:
+          name: run rubocop
+          command: |
+            rubocop
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                              --out /tmp/test-results/rspec.xml \
+                              --format progress \
+                              $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.byebug_history
+.rubocop-https---raw-githubusercontent-com-rubocop-hq-rubocop-master-config-enabled-yml

data/.rubocop.yml

@@ -0,0 +1,13 @@
+inherit_from:
+  - https://raw.githubusercontent.com/rubocop-hq/rubocop/master/config/enabled.yml
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - spec/**/*
+Style/Documentation:
+  Enabled: false
+Style/ExpandPathArguments:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.3

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pipe_dream.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    pipe_dream (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.1)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.57.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pipe_dream!
+  rake (~> 10.0)
+  rspec (~> 3.7)
+  rubocop (~> 0.52)
+
+BUNDLED WITH
+   1.16.2

data/README.md

@@ -0,0 +1,52 @@
+# PipeDream
+
+PipeDream allows you to easily search YouTube by providing a simple wrapper
+around YouTube's official APIs. What sets PipeDream apart from other options, is
+that it has no dependencies outside the Ruby standard library. This makes it easy
+to include in projects where you can't easily bundle dependencies, such as in an
+Alfred workflow.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pipe_dream'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pipe_dream
+
+## Usage
+
+Before you begin using PipeDream to perform searches, you will have to configure
+it with your developer API key. You can create a new API key using the
+[Google Cloud Console](https://console.cloud.google.com/). Once you have created your key, configure PipeDream with
+it like this:
+
+```ruby
+PipeDream.configure do |config|
+  config.api_key = '<your-api-key>'
+end
+```
+
+Now you can begin searching! Here is a basic example of how you can perform a search:
+
+```ruby
+req = PipeDream::Request.new('redlettermedia')
+res = PipeDream::Response.new(req.get)
+# The items method will return an array of objects that wrap the search results.
+items = res.items #=> [#<PipeDream::Result::Channel...]
+channel = items.first
+channel.title #=> 'RedLetterMedia'
+channel.description #=> 'Red Letter Media is responsible for the 70 minute Phantom Menace review as well as Space Cop, Half in the Bag, and Best of the Worst. Full time frauds.'
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[goronfreeman]/pipe_dream.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :console do
+  exec 'irb -r pipe_dream -I ./lib'
+end
+
+task default: :spec

data/bin/console

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

@@ -0,0 +1,21 @@
+require 'pipe_dream/version'
+require 'pipe_dream/configuration'
+require 'pipe_dream/response'
+require 'pipe_dream/result'
+require 'pipe_dream/request'
+require 'pipe_dream/utils'
+require 'pipe_dream/results/base'
+require 'pipe_dream/results/channel'
+require 'pipe_dream/results/playlist'
+require 'pipe_dream/results/video'
+
+module PipeDream
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+end

data/lib/pipe_dream/configuration.rb

@@ -0,0 +1,9 @@
+module PipeDream
+  class Configuration
+    attr_accessor :api_key
+
+    def initialize
+      @api_key = nil
+    end
+  end
+end

data/lib/pipe_dream/request.rb

@@ -0,0 +1,37 @@
+require 'net/http'
+require 'uri'
+
+require 'pipe_dream/utils'
+
+module PipeDream
+  class Request
+    include Utils
+
+    def initialize(search_term, options = {})
+      @search_term = search_term
+      @api_key     = PipeDream.configuration.api_key
+      @options     = camelize_keys(options)
+    end
+
+    def get
+      Net::HTTP.get(uri)
+    end
+
+    private
+
+    attr_reader :search_term, :api_key, :options
+
+    def uri
+      URI('https://www.googleapis.com').tap do |uri|
+        uri.path  = '/youtube/v3/search'
+        uri.query = URI.encode_www_form(params)
+      end
+    end
+
+    def params
+      { part: 'snippet',
+        key: api_key,
+        q: search_term }.merge(options)
+    end
+  end
+end

data/lib/pipe_dream/response.rb

@@ -0,0 +1,45 @@
+require 'json'
+
+module PipeDream
+  class Response
+    def initialize(data)
+      @data = JSON.parse(data)
+    end
+
+    def kind
+      @kind ||= data.fetch('kind')
+    end
+
+    def etag
+      @etag ||= JSON.parse(data.fetch('etag'))
+    end
+
+    def next_page_token
+      @next_page_token ||= data.fetch('nextPageToken')
+    end
+
+    def region_code
+      @region_code ||= data.fetch('regionCode')
+    end
+
+    def total_results
+      @total_results ||= page_info.fetch('totalResults')
+    end
+
+    def results_per_page
+      @results_per_page ||= page_info.fetch('resultsPerPage')
+    end
+
+    def items
+      @items ||= data.fetch('items').map { |item| Result.for(item) }
+    end
+
+    private
+
+    attr_reader :data
+
+    def page_info
+      @page_info ||= data.fetch('pageInfo')
+    end
+  end
+end

data/lib/pipe_dream/result.rb

@@ -0,0 +1,14 @@
+module PipeDream
+  module Result
+    def self.for(item)
+      case item.dig('id', 'kind')
+      when 'youtube#channel'
+        Channel
+      when 'youtube#playlist'
+        Playlist
+      when 'youtube#video'
+        Video
+      end.new(item)
+    end
+  end
+end

data/lib/pipe_dream/results/base.rb

@@ -0,0 +1,66 @@
+module PipeDream
+  module Result
+    class Base
+      def initialize(data)
+        @data = data
+      end
+
+      def published_at
+        @published_at ||= snippet.fetch('publishedAt')
+      end
+
+      def channel_id
+        @channel_id ||= snippet.fetch('channelId')
+      end
+
+      def title
+        @title ||= snippet.fetch('title')
+      end
+
+      def description
+        @description ||= snippet.fetch('description')
+      end
+
+      # TODO: Add thumbnail dimension info?
+      def thumbnail_url(size = :small)
+        @thumbnail_url ||=
+          snippet.dig('thumbnails', size_mappings.fetch(size, 'default'), 'url')
+      end
+
+      def channel_title
+        @channel_title ||= snippet.fetch('channelTitle')
+      end
+
+      def live_broadcast_content
+        @live_broadcast_content ||= snippet.fetch('liveBroadcastContent')
+      end
+
+      alias created_at published_at
+
+      private
+
+      attr_reader :data
+
+      def snippet
+        @snippet = data.fetch('snippet')
+      end
+
+      def size_mappings
+        { small: 'default',
+          medium: 'medium',
+          large: 'high' }
+      end
+
+      def id(key)
+        data.dig('id', key)
+      end
+
+      def url(path, params = {})
+        URI('https://www.youtube.com').tap do |uri|
+          uri.path = path
+          uri.query = URI.encode_www_form(params)
+        end.to_s
+      end
+    end
+  end
+end

data/lib/pipe_dream/results/channel.rb

@@ -0,0 +1,13 @@
+module PipeDream
+  module Result
+    class Channel < Base
+      def id
+        @id ||= super('channelId')
+      end
+
+      def url
+        @url ||= super("/channel/#{id}")
+      end
+    end
+  end
+end

data/lib/pipe_dream/results/playlist.rb

@@ -0,0 +1,13 @@
+module PipeDream
+  module Result
+    class Playlist < Base
+      def id
+        @id ||= super('playlistId')
+      end
+
+      def url
+        @url ||= super('/playlist', list: id)
+      end
+    end
+  end
+end

data/lib/pipe_dream/results/video.rb

@@ -0,0 +1,13 @@
+module PipeDream
+  module Result
+    class Video < Base
+      def id
+        @id ||= super('videoId')
+      end
+
+      def url
+        @url ||= super('/watch', v: id)
+      end
+    end
+  end
+end

data/lib/pipe_dream/utils.rb

@@ -0,0 +1,23 @@
+module PipeDream
+  module Utils
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def camelize_keys(hash)
+      hash.tap do |h|
+        affected_keys = h.each_key.select { |key| key.to_s.include?('_') }
+        return h if affected_keys.empty?
+
+        camelized_keys = affected_keys.map do |key|
+          key.to_s.split('_').map.with_index do |k, index|
+            next k if index.zero?
+            k.capitalize
+          end.join.to_sym
+        end
+
+        Hash[affected_keys.zip(camelized_keys)].each do |old, new|
+          h[new] = h.delete(old)
+        end
+      end
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+  end
+end

data/lib/pipe_dream/version.rb

@@ -0,0 +1,3 @@
+module PipeDream
+  VERSION = '0.1.0'.freeze
+end

data/pipe_dream.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pipe_dream/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pipe_dream'
+  spec.version       = PipeDream::VERSION
+  spec.authors       = ['Hunter Braun']
+  spec.email         = ['hunter.braun@gmail.com']
+
+  spec.summary       = 'A dreamy, zero-dependency YouTube API wrapper.'
+  spec.homepage      = 'https://github.com/goronfreeman/pipe_dream'
+
+  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.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: pipe_dream
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hunter Braun
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-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.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+description: 
+email:
+- hunter.braun@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pipe_dream.rb
+- lib/pipe_dream/configuration.rb
+- lib/pipe_dream/request.rb
+- lib/pipe_dream/response.rb
+- lib/pipe_dream/result.rb
+- lib/pipe_dream/results/base.rb
+- lib/pipe_dream/results/channel.rb
+- lib/pipe_dream/results/playlist.rb
+- lib/pipe_dream/results/video.rb
+- lib/pipe_dream/utils.rb
+- lib/pipe_dream/version.rb
+- pipe_dream.gemspec
+homepage: https://github.com/goronfreeman/pipe_dream
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A dreamy, zero-dependency YouTube API wrapper.
+test_files: []