aavimeodl 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aed416e7d1e8e4cff672097a464142d33ca8c226
-  data.tar.gz: 8631aef6e7a186944b502fb54f4d9a2a900b9b60
+  metadata.gz: abc6e606e4df8ecbc84b46ec13aaa66f6347d730
+  data.tar.gz: fee81ef0be3c0f76a3c6caeb2ab2051c6b70cfc5
 SHA512:
-  metadata.gz: eba3b866a011f4e128671cf7d512a5b7d0320ee8f780d22a8ead122636476c06e8232d11f5e357ebe8744f1df09f43cfae51286b5f38e7b494dd2d282e4c91e9
-  data.tar.gz: 10f115a296678f54dad591a9a24704474b65a3000638abf5f53fa9195d1249dc85ddc0d7b94c79ca48c0fb8ba4973d6205b38468aa93719b2404e50f9b51522b
+  metadata.gz: bc025b5c0598d9807da8b4872854bd901bca626ea8ba60cfbcb9d18323a109bab1e88ca090fbbd11f811e168e0c610e8a83899d7487731be15aead956c0d9b2c
+  data.tar.gz: 9d382af980a166970e57ed3a56f23e29873366cf8eda0f2f809dd23627b086d7f10ad791b94135bd0810ccd11f9d993cb163ccf890602f8287f9e6179a22e9bd

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 candyapplecorn
+Copyright (c) 2017 "Joseph Burger" -- candyapplecorn@gmail.com
 
 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/README.md

@@ -1,39 +1,77 @@
-# Aavimeodl
+# aa-vimeo-downloader
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/aavimeodl`. To experiment with that code, run `bin/console` for an interactive prompt.
+A script for App Academy students which downloads the day's videos
 
-TODO: Delete this and the text above, and describe your gem
+## Usage
+
+```bash
+getaavids <week+day> <url to readme raw>
+```
 
-## Installation
+"_<week+day>_" could be _w4d1_, _w2d2_, etc.
 
-Add this line to your application's Gemfile:
+To get the url for the readme raw, simply navigate to the README.md file and select _raw_. 
+Once your screen is filled with plain, unformatted text, grab the url.
 
-```ruby
-gem 'aavimeodl'
+Here's an example where the user wants to download all the week 2, day 4 videos (with the url truncated):
+
+```bash
+getaavids w2d4 https://raw.githubusercontent.com/appacademy/curriculum/.......
 ```
 
-And then execute:
+The program will make a folder called _W2D4_videos_ and place all the day's videos in that folder. It might be smart to
+navigate to the user's _Videos_ directory before running this script!
 
-    $ bundle
+## Install
 
-Or install it yourself as:
+### via copy-pasting this shell script into your terminal:
+```bash
+cd && \
+git clone https://github.com/candyapplecorn/aa-vimeo-downloader.git && \
+mv aa-vimeo-downloader .aa-vimeo-downloader && \
+cd .aa-vimeo-downloader && \
+bash install.sh && \
+exec bash
+```
 
-    $ gem install aavimeodl
+### Manual:
 
-## Usage
+After cloning this repository, run the install shell script like so:
 
-TODO: Write usage instructions here
+```bash 
+bash install.sh
+```
+
+This will add an alias to your `.profile`, `.bashrc`, `.asliases` or .`zshrc`, whichever one is found first.
+The alias will allow the user to run _getaavids.rb_ by entering `getaavids` in the command line.
+
+#### Troubleshooting:
 
-## Development
+If the script fails and you're using a Mac, try installing youtube-dl through brew. Once that's done, restart bash and try using the alias again (you can list all your aliases with ```alias -p```).
+
+```bash
+brew install youtube-dl
+exec bash
+getaavids ...
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Dependencies
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](http://rubygems.org).
+This program requires youtube-dl. I've added an automatic installer to the program, so the user doesn't have to install it manually.
+If you'd like to install it manually, refer to its website: [https://rg3.github.io/youtube-dl/](https://rg3.github.io/youtube-dl/)
 
-## Contributing
+## Video Playback
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/aavimeodl.
+If you don't have a video player which allows the playback speed to be adjusted, consider giving VLC a try. [https://www.videolan.org/vlc/index.html](https://www.videolan.org/vlc/index.html)
 
-## License
+## How I Turned this Into a Gem:		
+	
+[http://guides.rubygems.org/make-your-own-gem/](http://guides.rubygems.org/make-your-own-gem/)		
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+[http://robdodson.me/how-to-write-a-command-line-ruby-gem/](http://robdodson.me/how-to-write-a-command-line-ruby-gem/)		
+		
+[http://guides.rubygems.org/specification-reference/#add_runtime_dependency](http://guides.rubygems.org/specification-reference/#add_runtime_dependency)		
+		
+Example of an executable gem: [https://github.com/qrush/hola](https://github.com/qrush/hola), and the directions: [http://guides.rubygems.org/make-your-own-gem/#requiring-more-files](http://guides.rubygems.org/make-your-own-gem/#requiring-more-files)		
+		
+The 1st parts here are helpful: [https://bundler.io/v1.13/guides/creating_gem](https://bundler.io/v1.13/guides/creating_gem)

data/aavimeodl.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["candyapplecorn@gmail.com"]
 
   spec.summary       = %q{Downloads private App Academy videos from Vimeo}
-  spec.homepage      = "http://github.com/candyapplecorn/aa-vimeo-downloader/tree/youtube-dl_ruby_bindings"
+  spec.homepage      = "https://github.com/candyapplecorn/aa-vimeo-downloader"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'

data/lib/aavimeodl/AVD.rb

@@ -1,7 +1,4 @@
 require 'open-uri'
-require 'io/console'
-require 'pty'
-# No installation! Wew!
 require 'youtube-dl'
 
 class GitRaw
@@ -42,35 +39,6 @@ class LinkParser
   end
 end
 
-# should be able to remove this once binding works correctly
-def has_youtube_dl?
-  if `which youtube-dl` =~ /^$/
-    print <<~HEREDOC
-    The dependency 'youtube_dl' is not installed.
-    To install this program, see
-    https://rg3.github.io/youtube-dl/download.html
-
-    Are you using OSX or Linux and would like to
-    install youtube_dl automatically?
-    HEREDOC
-
-    print "[Y/N]: "
-
-    if STDIN.gets =~ /y/i
-      raise "Install failed; please install manually" unless install_youtube_dl
-      return true
-    else
-      abort('Install youtube_dl to use this program')
-    end
-  end
-end
-
-def install_youtube_dl
-  `sudo curl -L https://yt-dl.org/downloads/latest/youtube-dl -o /usr/local/bin/youtube-dl`
-  `sudo chmod a+rx /usr/local/bin/youtube-dl`
-  `which youtube-dl` =~ /^$/
-end
-
 class Credentials
   attr_reader :day, :url, :vimeo_password
   def initialize
@@ -115,23 +83,11 @@ end
 # Replace this with ruby binding
 def get_video(name, link, pass)
   title = "#{name}.%(ext)s"
-  command = %{youtube-dl --video-password "#{pass}" -o "#{title}" #{link}}
 
 	YoutubeDL.download link, {
 					"video-password": pass,
 					"o": title
 	}
-
-#  begin
-#    PTY.spawn(command) do |stdout, _stdin, _pid|
-#      begin
-#         stdout.each { |line| print line }
-#       rescue Errno::EIO
-#       end
-#    end
-#  rescue PTY::ChildExited
-#    puts "The child process exited!"
-#  end
 end
 
 class Aavimeodl::AVD
@@ -144,11 +100,6 @@ class Aavimeodl::AVD
 end
 
 if $PROGRAM_NAME == __FILE__
-  #has_youtube_dl? # This will go since ruby binding should work
-#  creds = Credentials.new
-#  raw = GitRaw.new creds.url
-#  links = LinkParser.new(raw, creds)
-#  make_video_dir(creds, links.links)
   Aavimeodl::AVD.new
 end
 

data/lib/aavimeodl/version.rb

@@ -1,3 +1,3 @@
 module Aavimeodl
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aavimeodl
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - candyapplecorn
@@ -86,9 +86,8 @@ files:
 - lib/aavimeodl.rb
 - lib/aavimeodl/AVD.rb
 - lib/aavimeodl/version.rb
-- pkg/aavimeodl-0.1.0.gem
 - pkg/aavimeodl-0.1.1.gem
-homepage: http://github.com/candyapplecorn/aa-vimeo-downloader/tree/youtube-dl_ruby_bindings
+homepage: https://github.com/candyapplecorn/aa-vimeo-downloader
 licenses:
 - MIT
 metadata: