botr 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0566390f9e32ca9a61ffeefb7530242bffed7a02
-  data.tar.gz: 99a2af2ac184d15fd438d8aa99cc45caacdcdd3f
+  metadata.gz: ff0e34c44fecc55872d65243f45755214beeff7a
+  data.tar.gz: aba50853754c0a898cc7849ba8c2e114bc23c576
 SHA512:
-  metadata.gz: 68a8d8d211fb8403bed97cbbbffe2ec1deab740e693f7cb6d171e7bf680be909541b5b81ed9312bcdf3dfb75ee3af33eaad1f0465196a80ab0a55dcbf7b3791f
-  data.tar.gz: fc9e5e878caad0e0555a59fc399b831e3692a051868334914f1f2818b5b79d20e0c3e4df8fafd544c6ba2ea4539e6a6196f1a53a738be30ff7988ab89b1b1cf0
+  metadata.gz: efb5513746ee5b1c2185045e0f9df5502709d756a51222c14b1c97e376398dc49a0af1b28fb33cfe3f45751082cc60eb037cc05a62ee787b704600e4e318001e
+  data.tar.gz: 54c8e031503c4ef403f7f4c91c1382595677205deef61ff376d627402196febf4918430493c0ab9b4f4503dd7c1bc61b23c44ed0334fed5c53fb1ed9a20297a7

data/README.md

@@ -1,4 +1,4 @@
-# botr (BitsOnTheRun)
+# botr (BitsOnTheRun) [![Gem Version](https://badge.fury.io/rb/botr.png)](http://badge.fury.io/rb/botr) [![Dependency Status](https://gemnasium.com/bertrandk/botr.png)](https://gemnasium.com/bertrandk/botr) [![Code Climate](https://codeclimate.com/github/bertrandk/botr.png)](https://codeclimate.com/github/bertrandk/botr)
 
 ## Requirements
 
@@ -12,7 +12,8 @@
 
 ## Description
 
-A ruby API kit that manages the authentication, serialization and sending of API calls to the Bits on the Run online video platform. 
+A ruby API kit that manages the authentication, serialization and sending of API  
+calls to the Bits on the Run online video platform. 
 
 ## Features
 
@@ -22,242 +23,283 @@ The botr gem includes support for the following Bits on the Run API classes:
 * channels (video playlists)
 * players (based on JW Player)
 
+## Command-line Usage
+
+	$ gem install botr
+	$ botr upload /path/to/video.mp4 -k <API_KEY> -s <API_SECRET>
+
+See `botr help` or `botr help upload` for more information.
+
 ## Examples
 
     require 'botr'
 
 ### Configuration
-	BOTR.configure do |config|
-	  config.api_key = "<botr_api_key>"
-	  config.secret_key = "<botr_secret_key>"
-	end
 
-	NOTE: It is recommended to set the api key and the secret key as environment variables and reference them using the `ENV` hash (e.g. config.api_key = ENV["BOTR_API_KEY"]).
+```ruby
+BOTR.configure do |config|
+  config.api_key = "<botr_api_key>"
+  config.secret_key = "<botr_secret_key>"
+end
+
+# NOTE: It is recommended to set the api key and the secret key as environment  
+# variables and reference them using the `ENV` hash (e.g. config.api_key = ENV["BOTR_API_KEY"]).
+```
 
 ### Videos
 
-	# create a new video metadata container
-	vid = BOTR::Video.new
-	vid.create(title: "My cat video", author: "Me")
+```ruby
+# create a new video metadata container
+vid = BOTR::Video.new
+vid.create(title: "My cat video", author: "Me")
 
-	# upload actual video file
-	vid.upload("/Users/Me/Movies/grumpy_kitty.mov")
+# upload actual video file
+vid.upload("/Users/Me/Movies/grumpy_kitty.mov")
 
-	# update the properties of a video
-	vid.update(title: "My super awesome cat video", description: "Mr. Snicker apparently doesn't like being filmed.")
+# update the properties of a video
+vid.update(title: "My super awesome cat video", description: "Mr. Snicker  
+apparently doesn't like being filmed.")
 
-	# delete a given video and all its conversions
-	vid.delete
+# delete a given video and all its conversions
+vid.delete
 
-	# list all videos
-	BOTR::Video.all # => [#<BOTR::Video>, #<BOTR::Video>, ...]
+# list all videos
+BOTR::Video.all # => [#<BOTR::Video>, #<BOTR::Video>, ...]
 
-	# list only certain videos
-	BOTR::Video.list(search: "cat", order_by: "date")
+# list only certain videos
+BOTR::Video.list(search: "cat", order_by: "date")
 
-	# find a certain video by video key
-	cat_vid = BOTR::Video.show("<video_key>") # => #<BOTR::Video @key="[video_key]">
+# find a certain video by video key
+cat_vid = BOTR::Video.show("<video_key>") # => #<BOTR::Video @key="[video_key]">
+```
 
 ### Video Conversions
 
-	# create a new video conversion
-	480p_vid = BOTR::VideoConversion.new
-	480p_vid.create("<video_key>", "<template_key>")
+```ruby
+# create a new video conversion
+480p_vid = BOTR::VideoConversion.new
+480p_vid.create("<video_key>", "<template_key>")
 
-	# delete a given video conversion from the CDN
-	480p_vid.delete
+# delete a given video conversion from the CDN
+480p_vid.delete
 
-	# list all video conversions for a given video
-	BOTR::VideoConversion.list("<video_key>", result_limit: 5)
+# list all video conversions for a given video
+BOTR::VideoConversion.list("<video_key>", result_limit: 5)
 
-	# find a given video conversion by its conversion key
-	aac_vid = BOTR::VideoConversion.show("<conversion_key>")
+# find a given video conversion by its conversion key
+aac_vid = BOTR::VideoConversion.show("<conversion_key>")
+```
 
 ### Video Thumbnails
 
-	# find a video thumbnail
-	thumb = BOTR::VideoThumbnail.show("<video_key>")
+```ruby
+# find a video thumbnail
+thumb = BOTR::VideoThumbnail.show("<video_key>")
 
-	# update a video's thumbnail
-	thumb.update(position: 7.25) # updates the video's thumbnail to the image at 7.25 seconds
+# update a video's thumbnail
+thumb.update(position: 7.25) # updates the video's thumbnail to the image at  
+7.25 seconds
 
-	# upload a new video thumbnail
-	thumb.upload("/Users/Me/Pictures/snicker_smiles.png")
+# upload a new video thumbnail
+thumb.upload("/Users/Me/Pictures/snicker_smiles.png")
+```
 
 ### Video Captions
 
-	# create a new video caption
-	espanol = BOTR::VideoCaption.new
-	espanol.create(label: "esp")
+```ruby
+# create a new video caption
+espanol = BOTR::VideoCaption.new
+espanol.create(label: "esp")
 
-	# upload the actual caption file
-	espanol.upload("/Users/Me/Documents/grunon_gata.txt")
+# upload the actual caption file
+espanol.upload("/Users/Me/Documents/grunon_gata.txt")
 
-	# update the video caption
-	espanol.update(label: "Spanish")
+# update the video caption
+espanol.update(label: "Spanish")
 
-	# delete a video caption
-	espanol.delete("<caption_key>")
+# delete a video caption
+espanol.delete("<caption_key>")
 
-	# list the captions for a video
-	BOTR::VideoCaption.list("<video_key>", order_by: "label:asc")
+# list the captions for a video
+BOTR::VideoCaption.list("<video_key>", order_by: "label:asc")
 
-	# get the caption information for a video
-	cap = BOTR::VideoCaption.show("<video_key>")
+# get the caption information for a video
+cap = BOTR::VideoCaption.show("<video_key>")
+```
 
 ### Video Tags
 
-	# list a video's tags
-	BOTR::VideoTag.all
+```ruby
+# list a video's tags
+BOTR::VideoTag.all
 
-	# search for video tags matching a certain criteria
-	BOTR::VideoTag.list(search: "kitty")
+# search for video tags matching a certain criteria
+BOTR::VideoTag.list(search: "kitty")
+```
 
 ### Video Views
-	
-	date = Time.new(2002, 10, 31)
-	unix_timestamp = date.to_i
 
-	# list view statistics by video
-	BOTR::VideoView.list(start_date: unix_timestamp)
+```ruby	
+date = Time.new(2002, 10, 31)
+unix_timestamp = date.to_i
+
+# list view statistics by video
+BOTR::VideoView.list(start_date: unix_timestamp)
 
-	# list view statistics by day
-	BOTR::VideoView.list(list_by: "day", group_days: false)
+# list view statistics by day
+BOTR::VideoView.list(list_by: "day", group_days: false)
 
-	# list view statistics, grouping by day
-	BOTR::VideoView.list(list_by: "day", group_days: true)
+# list view statistics, grouping by day
+BOTR::VideoView.list(list_by: "day", group_days: true)
 
-	# list view statistics in aggregate
-	BOTR::VideoView.list(list_by: "day", aggregate: true)
+# list view statistics in aggregate
+BOTR::VideoView.list(list_by: "day", aggregate: true)
 
-	# find a video's statistics
-	BOTR::VideoView.show("<video_key>")
+# find a video's statistics
+BOTR::VideoView.show("<video_key>")
+```
 
 ### Video Engagements
-	
-	# display engagement analytics for a single video
-	BOTR::VideoEngagement.show("<video_key>")
+
+```ruby	
+# display engagement analytics for a single video
+BOTR::VideoEngagement.show("<video_key>")
+```
 
 ### Channels (Playlists)
-	
-	# create a manual playlist
-	my_picks = BOTR::Channel.new
-	my_picks.create(title: "My Picks", type: "manual")
 
-	# create a dynamic playlist
-	top_picks = BOTR::Channel.new
-	top_picks.create(title: "Trending", type: "automatic")
+```ruby	
+# create a manual playlist
+my_picks = BOTR::Channel.new
+my_picks.create(title: "My Picks", type: "manual")
+
+# create a dynamic playlist
+top_picks = BOTR::Channel.new
+top_picks.create(title: "Trending", type: "automatic")
 
-	# add videos to a dynamic playlist
-	top_picks.update(description: "Top 10 videos", tags: "kitty", sort_order: "views-desc", videos_max: 10)
+# add videos to a dynamic playlist
+top_picks.update(description: "Top 10 videos", tags: "kitty",  
+sort_order: "views-desc", videos_max: 10)
 
-	# delete a channel
-	top_picks.delete
+# delete a channel
+top_picks.delete
 
-	# get a list of all channels
-	BOTR::Channel.all
+# get a list of all channels
+BOTR::Channel.all
 
-	# get a list of all dynamic "picks" channels
-	BOTR::Channel.list(types_filter: "dynamic", search: "top")
+# get a list of all dynamic "picks" channels
+BOTR::Channel.list(types_filter: "dynamic", search: "top")
 
-	# get a specific channel
-	my_ch = BOTR::Channel.show("<channel_key>")
+# get a specific channel
+my_ch = BOTR::Channel.show("<channel_key>")
+```
 
 ### Channel Videos
-	
-	# get a list of videos in a channel
-	BOTR::ChannelVideo.list(top_picks.key)
 
-	# get video info. from a channel
-	second_vid = BOTR::ChannelVideo.show(my_picks.key, position: 2)
+```ruby	
+# get a list of videos in a channel
+BOTR::ChannelVideo.list(top_picks.key)
+
+# get video info. from a channel
+second_vid = BOTR::ChannelVideo.show(my_picks.key, position: 2)
 
-	# remove a video from a manual channel
-	second_vid.delete
+# remove a video from a manual channel
+second_vid.delete
 
-	# add a video to a manual channel
-	snicker_falls = BOTR::ChannelVideo.new({key: "<video_key>"})
-	snicker_falls.create(my_picks.key)
+# add a video to a manual channel
+snicker_falls = BOTR::ChannelVideo.new({key: "<video_key>"})
+snicker_falls.create(my_picks.key)
 
-	# move a video to a different position in a manual channel
-	BOTR::ChannelVideo.update(my_picks.key, position_from: 10, position_to: 2)
+# move a video to a different position in a manual channel
+BOTR::ChannelVideo.update(my_picks.key, position_from: 10, position_to: 2)
+```
 
 ### Channel Thumbnails
 
-	# update a channel's thumbnail
-	new_tumb = BOTR::ChannelThumbnail.new({key: "<channel_key>"})
-	new_thumb.update
-	new_thumb.upload("/Users/Me/Pictures/splash.png")
+```ruby
+# update a channel's thumbnail
+new_tumb = BOTR::ChannelThumbnail.new({key: "<channel_key>"})
+new_thumb.update
+new_thumb.upload("/Users/Me/Pictures/splash.png")
 
-	# get the status of a video thumbnail creation (it takes about 10 seconds before a new thumbnail is ready to show)
-	thumb_stat = BOTR::ChannelThumbnail.show("<channel_key>")
-	thumb_stat.status # => "ready"
+# get the status of a video thumbnail creation (it takes about 10 seconds  
+	before a new thumbnail is ready to show)
+thumb_stat = BOTR::ChannelThumbnail.show("<channel_key>")
+thumb_stat.status # => "ready"
+```
 
 ### Channel Views
 
-	# get view stats by channel
-	BOTR::ChannelView.list(list_by: "channel")
+```ruby
+# get view stats by channel
+BOTR::ChannelView.list(list_by: "channel")
 
-	# get channel view stats by day
-	BOTR::ChannelView.list(list_by: "day", group_days: false)
+# get channel view stats by day
+BOTR::ChannelView.list(list_by: "day", group_days: false)
 
-	# get channel view stats by grouped days (i.e. in months and years)
-	BOTR::ChannelView.list(list_by: "day", group_days: true)
+# get channel view stats by grouped days (i.e. in months and years)
+BOTR::ChannelView.list(list_by: "day", group_days: true)
 
-	# get aggregate channel view stats
-	BOTR::ChannelView.list(aggregate: true)
+# get aggregate channel view stats
+BOTR::ChannelView.list(aggregate: true)
 
-	# get view stats for a specific channel
-	ch_stats = BOTR::ChannelView.show("<channel_key>", group_days: false)
+# get view stats for a specific channel
+ch_stats = BOTR::ChannelView.show("<channel_key>", group_days: false)
 
-	# get view stats for a specific channel in months and years
-	ch_group_stats = BOTR::ChannelView.show("<channel_key>", group_days: true)
+# get view stats for a specific channel in months and years
+ch_group_stats = BOTR::ChannelView.show("<channel_key>", group_days: true)
 
-	# get aggregate view stats for a specific channel
-	ch_report = BOTR::ChannelView.show("<channel_key>", aggregate: true)
+# get aggregate view stats for a specific channel
+ch_report = BOTR::ChannelView.show("<channel_key>", aggregate: true)
+```
 
 ### Players
-	
-	# create a JW Player
-	new_player = BOTR::Player.new
-	new_player.create("Awesome Player", "<sharing_player_key>", autostart: false)
 
-	# update a player's settings
-	new_player.update(controlbar: bottom, repeat: always)
+```ruby	
+# create a JW Player
+new_player = BOTR::Player.new
+new_player.create("Awesome Player", "<sharing_player_key>", autostart: false)
 
-	# delete a player
-	new_player.delete
+# update a player's settings
+new_player.update(controlbar: bottom, repeat: always)
 
-	# get a list of all players
-	BOTR::Player.all
+# delete a player
+new_player.delete
 
-	# list only certain players
-	BOTR::Player.list(search: "awesome")
+# get a list of all players
+BOTR::Player.all
 
-	# get a specific player
-	my_player = BOTR::Player.show("<player_key>")
+# list only certain players
+BOTR::Player.list(search: "awesome")
+
+# get a specific player
+my_player = BOTR::Player.show("<player_key>")
+```
 
 ### Player Views
-	
-	# get views by player
-	BOTR::PlayerView.list(list_by: "player")
 
-	# get views by day
-	BOTR::PlayerView.list(list_by: "day", group_days: flase, include_empty_days: true)
+```ruby	
+# get views by player
+BOTR::PlayerView.list(list_by: "player")
+
+# get views by day
+BOTR::PlayerView.list(list_by: "day", group_days: flase, include_empty_days: true)
 
-	# get views by month and year
-	BOTR::PlayerView.list(list_by: "day", group_days: true)
+# get views by month and year
+BOTR::PlayerView.list(list_by: "day", group_days: true)
 
-	# get aggregate player view
-	BOTR::PlayerView.list(aggregate: true)
+# get aggregate player view
+BOTR::PlayerView.list(aggregate: true)
 
-	# get view stats for a specific player
-	player_stats = BOTR::PlayerView.show("<player_key>", group_days: false)
+# get view stats for a specific player
+player_stats = BOTR::PlayerView.show("<player_key>", group_days: false)
 
-	# get view stats for a specific player in months and years
-	player_group_stats = BOTR::PlayerView.show("<player_key>", group_days: true)
+# get view stats for a specific player in months and years
+player_group_stats = BOTR::PlayerView.show("<player_key>", group_days: true)
 
-	# get aggregate view stats for a specific player
-	player_report = BOTR::PlayerView.show("<player_key>", aggregate: true)
+# get aggregate view stats for a specific player
+player_report = BOTR::PlayerView.show("<player_key>", aggregate: true)
+```
 
 ## Todo
 

data/bin/botr

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+
+$:.unshift File.expand_path('../../lib/', __FILE__)
+
+require 'botr'
+
+BOTR::CLI.start(ARGV)

data/botr.gemspec

@@ -17,6 +17,8 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
+  gem.add_dependency 'thor', '~> 0.18.1'
+
   gem.add_development_dependency 'rspec', '~> 2.4'
   gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
   gem.add_development_dependency 'watchr', '~> 0.7'

data/lib/botr.rb

@@ -1,5 +1,6 @@
 require 'botr/version'
 require 'botr/configuration'
+require 'botr/cli'
 
 require 'botr/common/logger'
 

data/lib/botr/cli.rb

@@ -0,0 +1,67 @@
+require "thor"
+
+module BOTR
+
+	class CLI < Thor
+
+		desc "upload VIDEO_PATH", "Uploads the video specified by VIDEO_PATH"
+		long_desc <<-LONGDESC
+	      Uploads the video specified by VIDEO_PATH. You must also provide an api KEY and an api SECRET.
+
+	      With -t option, you may specify the title of the video.  
+
+	      With -g option, you may specify tags for the video; multiple tags should be comma-separated.  
+
+	      With -d option, you may specify a description for the video.  
+
+	      With -a option, you may specify the author of the video.  
+
+	      With -d option, you may specify the video creation date; the date must be in Unix timestamp format.  
+
+	      With -l option, you may specify the URL of the web page where this video will be published.
+	    LONGDESC
+		option :key, :aliases => :k, :type => :string, :required => true
+		option :secret, :aliases => :s, :type => :string, :required => true
+		option :title, :aliases => :t, :type => :string
+		option :tags, :aliases => :g, :type => :string
+		option :description, :aliases => :d, :type => :string
+		option :author, :aliases => :a, :type => :string
+		option :date, :aliases => :d, :type => :numeric
+		option :link, :aliases => :l, :type => :string
+		def upload(video_path)
+			_options = clean_options(options)
+			set_configurations(_options[:key], _options[:secret])
+
+			puts "\nStarting upload.\n\n"
+			prepare_video_container(_options)
+
+			puts "Uploading....\n\n"
+			upload_video(video_path)
+			
+			puts "Upload Complete.\n\n"
+		end
+
+		private
+
+			def clean_options(opt)
+				opt.reject { |k, v| v.nil? }
+			end
+
+			def set_configurations(key, secret)
+				BOTR.configure do |config|
+					config.api_key = key
+					config.secret_key = secret
+				end
+			end
+
+			def prepare_video_container(opt)
+				@video = BOTR::Video.new(opt)
+				@video.create
+			end
+
+			def upload_video(video_path)
+				@video.upload(video_path)
+			end
+	end
+
+end

data/lib/botr/version.rb

@@ -1,3 +1,3 @@
 module BOTR
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: botr
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - bertrandk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-21 00:00:00.000000000 Z
+date: 2013-08-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -69,7 +83,8 @@ dependencies:
 description: A ruby API kit that manages the authentication, serialization and sending
   of API calls to the Bits on the Run online video platform.
 email: b.karerangabo@gmail.com
-executables: []
+executables:
+- botr
 extensions: []
 extra_rdoc_files: []
 files:
@@ -81,6 +96,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/botr
 - botr.gemspec
 - botr.watchr
 - certs/cacert.pem
@@ -92,6 +108,7 @@ files:
 - lib/botr/channels/channel_thumbnail.rb
 - lib/botr/channels/channel_video.rb
 - lib/botr/channels/channel_view.rb
+- lib/botr/cli.rb
 - lib/botr/common/logger.rb
 - lib/botr/configuration.rb
 - lib/botr/http/http.rb