get_freaky 0.1.2.pre → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6338916db36a7680f7feff7d3aa07cd38518b59
-  data.tar.gz: e3489dac1296caf08995d929eaa7eb118c622522
+  metadata.gz: 47c57b669caf236bdfc64a796c895331b9629fb9
+  data.tar.gz: f65a8e1c888d6f59f4ca31d7c889f8ff412bda21
 SHA512:
-  metadata.gz: 01e26f4c372b41713b28eb890f66b720cb13aac8ec5ed83d628c95036d5fcd91918ddc454ab4c47c377b7e16c3732ea3cac67a822780df612196ffbb6532b0ae
-  data.tar.gz: 0209cba65873ddda0855e0efd5709a4461d546d8c1872960444a507a8345c646840f5de3e57852eb6224ee42e3c3be1c51c7279939fc542ff1d275001d83592d
+  metadata.gz: ade9ef4ab79dc358e3ca4780357cf569a1c68a98eef6f27a66797e3aabda3af0445a95a285f77adbb38f8b1c2b4ac791245c19000107463a6200d891484788b2
+  data.tar.gz: e7a9480ae2e64f88b452a20188c2499dd5e22739ffa55e3eeaccd45dc751dae14cfa61259e03494f04e694436dd10c57986202c6d76babad5df20a93dcaaf6b7

data/README.md

@@ -0,0 +1,59 @@
+# GetFreaky
+
+All around the world there are great conferences on software, programming languages, web development and more. But conferences are expensive! [Confreaks](confreaks.tv) is a website that posts videos from over two hundred conferences. ```get_freaky``` is a ruby gem that aims to provide a simple command-line interface to the confreaks api to make it easier to browse videos from confreaks.tv and download them for offline viewing.
+
+## Installation
+
+Just install locally with rubygems:
+
+    $ gem install get_freaky
+
+## For the Impatient
+
+Just run
+
+    $ get_freaky featured
+
+You'll get the title and a short description of the current *featured video* and if you'd like, you can download it automatically. Not an interesting subject to you? Run the command again--the featured video changes each time. (I'm actually not sure how featured is chosen but just anecdotally they seem to be popular videos from more well-known speakers) so you can run the command again to get a look at a different video.
+
+And if you already know a video you want, you can start downloading a video right away:
+
+    $ get_freaky download "The Future of Online Learning" railsberry2013
+
+passing in the name of the video and the event its from.
+
+## Usage
+
+The command for the executable is the same as the name of the gem: ```get_freaky```. You can get going right out of the box by running the command in your terminal where you'll be shown the current help information. Check out the commands by running them with the --help flag to see examples.
+
+    $ get_freaky
+
+By itself shows you all the currently available commands and is generally more up to date than this readme.
+
+    $ get_freaky conf CONF_NAME
+
+    $ get_freaky event EVENT_NAME
+
+    $ get_freaky download EVENT_NAME TALK_TITLE
+
+For any of these commands the ```--help``` flag will give you more usage details.
+
+Adding the ```--download``` option will download the video automatically without prompting. This can be nice for scripting purposes, if you want to create a cron job to automatically download a conference video every week for example.
+
+    $ get_freaky featured --download
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+This is my first gem so any suggestions, tips, pull request, etc. are greatly appreciated!
+
+0. Check out the [code of conduct](https://github.com/smcabrera/get_freaky/blob/master/CODE_OF_CONDUCT.md) for contributors (TL;DR [be excellent to each other](http://giphy.com/gifs/POekkUcKs16gg/html5))
+1. [Fork it](https://github.com/smcabrera/get_freaky/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "get_freaky"
+
+# 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

data/bin/get_freaky

@@ -6,7 +6,6 @@ require 'commander/import'
 require_relative '../lib/get_freaky'
 
 program :name, "get_freaky"
-#program :version, GetFreaky::Version # I should be able to call this dynamically the same way my gemspec does
 program :version, GetFreaky::VERSION
 program :description, Info::DESCRIPTION
 program :help, 'Author', 'Stephen Mariano Cabrera <smcabrera.github.io>'
@@ -25,7 +24,10 @@ command :conf do |c|
       if conf.name == "Not Found"
         puts "Sorry, there was no conference found by that name."
       else
-        puts conf.event_list
+        events = conf.event_list
+        event_title = choose("Choose an event you'd like to see more information about it:\n\n", *events)
+        event = Event.find(event_title)
+        puts event
       end
     end
   end
@@ -38,21 +40,30 @@ command :event do |c|
   c.description = c.summary
   c.example 'Display information about the railsberry2013', 'get_freaky event railsberry2013'
   c.action do |args, options|
-    event = Event.find(args[0])
-    puts event.video_list
+    unless args[0]
+      puts `get_freaky conf --help`
+    else
+      event = Event.find(args[0])
+      videos = event.video_list
+      video_title = choose("Choose a talk to see more information about it:\n\n", *videos)
+      video = Video.find(event.name, video_title)
+      puts video
+      ask_to_download(video)
+    end
   end
 end
 
 command :download do |c|
   c.syntax = 'get_freaky download VIDEO_NAME EVENT_NAME [options]'
-  #c.summary = 'Displays information about an event (an instance of a conference in a particular year)'
   c.summary = 'Downloads a confreaks video locally using the viddl-rb library. Note that the "event name" given needs to be formatted in the same way as the listing show by the "event" command. Be sure to put quotes around video titles of multiple words and escape special exclamation points'
   c.description = c.summary
   c.example 'Download "The Future of Online Learning" from Railsberry 2013', 'get_freaky download "The Future of Online Learning" railsberry2013'
   c.example 'Download "Sleep!" from Railsberry 2013', 'get_freaky download Sleep! railsberry2013'
   c.action do |args, options|
     if args[0] == "featured"
-      Video.find_featured
+      video = Video.find_featured
+      puts video
+      ask_to_download(video, options.download)
     else
       video_title = args[0]
       event = Event.find(args[1])
@@ -69,12 +80,21 @@ command :featured do |c|
   c.summary = 'Shows information on the  "featured video" on confreaks.tv'
   c.description = c.summary
   c.example 'Show the current featured video on confreaks.tv', 'get_freaky featured'
+  c.option '--download', 'Automatically download the video without being prompted'
   c.action do |args, options|
     video = Video.find_featured
     puts video
-    puts agree("Would you like to download this video?") ? video.download : %Q(Okay. Here's the link if you change your mind #{video.url})
+    ask_to_download(video, options.download)
   end
 end
 
+def ask_to_download(video, download_option = false)
+  unless download_option
+    puts agree(Paint["\nWould you like to download this video? (y/n)", :blue]) ? video.download : %Q(Okay. Here's the link if you change your mind \n#{video.url})
+  else
+    puts "\nDownloading automatically with viddl-rb...\n"
+    video.download
+  end
+end
 
 default_command :help

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/get_freaky/event.rb

@@ -2,13 +2,15 @@ class Event
   include HTTParty
   BASE_URI = "http://confreaks.tv/api/v1"
   base_uri "http://confreaks.tv/api/v1"
-  attr_accessor :short_code, :conference_name, :conference_id, :video_count, :video_list
+  attr_accessor :short_code, :conference_name, :conference_id, :video_count, :date
 
-  def initialize(short_code, conference_name, conference_id, video_count)
+  # TODO: I'm pretty sure that at this number of arguments it should just take a hash
+  def initialize(short_code, conference_name, conference_id, video_count, date)
     self.short_code = short_code
     self.conference_name = conference_name
     self.conference_id = conference_id
     self.video_count = video_count
+    self.date = date
   end
 
   # Alias short_code as name; "short_code" is consistent with the api, but "name" is easier to remember
@@ -16,14 +18,30 @@ class Event
     short_code
   end
 
+  def to_s
+    %Q{\nConference: #{conference_name}\nNumber of Videos: #{video_count}}
+  end
+
   def self.find(short_code)
     response = get("/events/#{short_code}.json")
-    if response.success?
+    if response["status"] == 404
+      # TODO: The below is totally embarrassing...need to figure out a better way to handle this (though it's still better than nil)
+      # Look into using NULL Objects?
+      # Better exceptions?
+      self.new(
+        "Not Found",
+        "Not Found",
+        "Not Found",
+        "Not Found",
+        "Not Found"
+      )
+    elsif response.success?
       self.new(
         response["short_code"],
         response["conference"]["name"],
         response["conference"]["id"],
-        response["video_count"]
+        response["video_count"],
+        fix_date(response["start_at"])
       )
     else
       # This raises the net/http response that was raised
@@ -51,9 +69,18 @@ class Event
   # Probably should do something like store the list of video names as strings as soon as you create the object and then keep that array for future use
   # This seems slightly better but I'm still not sure it's ideal
   def video_list
-    self.video_list = videos.map { |video| video["title"] }
+    if self.videos == "Not Found"
+      "There was no conference found by that name."
+    else
+      videos.map { |video| video["title"] }
+    end
   end
 
-  def find_video
+  def self.fix_date(date)
+    year, month, day = date[0..3].to_i, date[5..6].to_i, date[8..9].to_i
+    Date.new(year, month, day)
   end
+
+  private
+
 end

data/lib/get_freaky/info.rb

@@ -1,4 +1,3 @@
 module Info
-  DATE = %q{2015-5-7}
   DESCRIPTION = %q{Wrapper for the confreaks API. Browse and download convention videos from the command line.}
 end

data/lib/get_freaky/version.rb

@@ -1,4 +1,4 @@
 module GetFreaky
-  VERSION = "0.1.2.pre"
-  DATE = %q{2015-05-08}
+  VERSION = "0.2.0"
+  DATE = %q{2015-05-14}
 end

data/lib/get_freaky/video.rb

@@ -1,3 +1,5 @@
+require 'paint'
+
 class Video
   include HTTParty
   BASE_URI = "http://confreaks.tv/api/v1"
@@ -42,11 +44,7 @@ class Video
   end
 
   def to_s
-    info = %Q{
-      Title: #{title}
-      Description: #{abstract}
-      Link: #{url}
-    }
+    %Q{\n#{Paint['Title:', :green]} #{title}\n#{Paint["Description:", :green]} #{abstract}\n}
   end
 
   def url

data/lib/get_freaky.rb

@@ -2,9 +2,9 @@ require 'httparty'
 require 'slugify'
 require 'viddl-rb'
 
-require 'get_freaky/conference'
-require 'get_freaky/event'
-require 'get_freaky/video'
-require "get_freaky/version"
-require "get_freaky/info"
+require_relative 'get_freaky/conference'
+require_relative 'get_freaky/event'
+require_relative 'get_freaky/video'
+require_relative "get_freaky/version"
+require_relative "get_freaky/info"
 

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: get_freaky
 version: !ruby/object:Gem::Version
-  version: 0.1.2.pre
+  version: 0.2.0
 platform: ruby
 authors:
 - Stephen Mariano Cabrera
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-08 00:00:00.000000000 Z
+date: 2015-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: table_print
+  name: commander
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: 4.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: 4.3.4
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: fabricas
   requirement: !ruby/object:Gem::Requirement
@@ -144,7 +158,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- bin/console
 - bin/get_freaky
+- bin/setup
 - lib/get_freaky.rb
 - lib/get_freaky/conference.rb
 - lib/get_freaky/event.rb
@@ -167,9 +184,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2