streamio-cli 0.0.1 → 0.5.0

data/README.md

@@ -1,29 +1,46 @@
-# Streamio::Exporter
+# Streamio CLI (Command Line Interface)
 
-TODO: Write a gem description
+A gem for interacting with Streamio through the command line.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+    gem install streamio-exporter
 
-    gem 'streamio-exporter'
+## Usage
 
-And then execute:
+After installation you can use the streamio command from your
+terminal. To get a list of available tasks run `streamio` without
+any arguments.
 
-    $ bundle
+To get help on a specific task run `streamio help name_of_task`.
+For example run `streamio help export` to get usage scenario
+and available options for the export task.
 
-Or install it yourself as:
+### Export
 
-    $ gem install streamio-exporter
+You can use the export task to download all videos and audios
+from your Streamio account. First use your terminal to navigate
+to a directory where you wish the export to be downloaded to.
+Then use the command together with your api username and password
+found under Account Settings > API when logged in to streamio.com.
 
-## Usage
+    streamio export -u api_username -p api_password
+
+By default only the original files will be downloaded. If you
+wish to include transcodings you may add the `-i` parameter.
+
+    streamio export -u api_username -p api_password -i
+
+The export will use the following file structure for the downloads:
+
+    streamio-export/videos/<video_id>/<video_filename>
+    streamio-export/audios/<audio_id>/<audio_filename>
 
-TODO: Write usage instructions here
+A json file containing the metadata of each resource will also
+be availible:
 
-## Contributing
+    streamio-export/videos/<video_id>/<video_id>.json
+    streamio-export/videos/<audio_id>/<audio_id>.json
 
-1. Fork it
-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 new Pull Request
+Note that it is likely that you will need a developer to actually
+make use of the exported material.

data/lib/streamio-cli.rb

@@ -6,11 +6,11 @@ require 'streamio'
 require 'ruby-progressbar'
 require 'streamio-cli/version'
 
-module Streamio
+module Streamio::CLI
   class SlowDownloadError < StandardError
   end
 
-  class CLI < Thor
+  class App < Thor
     desc "export", "export data from target account"
     method_option :username, :desc => 'api username', :aliases => '-u', :required => true
     method_option :password, :desc => 'api password', :aliases => '-p', :required => true
@@ -34,12 +34,12 @@ module Streamio
     end
 
     def download_videos
-      number_of_items = Video.count
+      number_of_items = ::Streamio::Video.count
       current_item = 0
       requests_needed = (number_of_items / 100) + 1
 
       requests_needed.times do |i|
-        Video.all(:skip => i * 100, :limit => 100).each do |video|
+        ::Streamio::Video.all(:skip => i * 100, :limit => 100).each do |video|
           current_item += 1
           puts "\nVideo #{current_item} / #{number_of_items} - #{video.title} - #{video.id}"
 
@@ -59,12 +59,12 @@ module Streamio
     end
 
     def download_audios
-      number_of_items = Audio.count
+      number_of_items = ::Streamio::Audio.count
       current_item = 0
       requests_needed = (number_of_items / 100) + 1
 
       requests_needed.times do |i|
-        Audio.all(:skip => i * 100, :limit => 100).each do |audio|
+        ::Streamio::Audio.all(:skip => i * 100, :limit => 100).each do |audio|
           current_item += 1
           puts "\nAudio #{current_item} / #{number_of_items}: #{audio.title}"
 
@@ -130,4 +130,4 @@ module Streamio
   end
 end
 
-Streamio::CLI.start
+Streamio::CLI::App.start

data/lib/streamio-cli/version.rb

@@ -1,5 +1,5 @@
 module Streamio
-  module Exporter
-    VERSION = "0.0.1"
+  module CLI
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: streamio-cli
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -103,7 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -340215124816893152
+      hash: -2975853809125404003
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -112,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -340215124816893152
+      hash: -2975853809125404003
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24