sony-ci-api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e46eaec1fb159a4878b3de71bb97d137edac1fa
-  data.tar.gz: aec8169706b592d208d5450104e9db8726b8c6b1
+  metadata.gz: 78ddca4a90c4040cd7dd9061255f8093be1f6ad0
+  data.tar.gz: 7dc66ce63747e28bba420c2002a8ee521559060c
 SHA512:
-  metadata.gz: 495f880cc910fe823189d0bf2f5ba780fbf65a511f9eec51a5e8dcd06a9ad149efe67a4cbc6282bde04f22334620dccd6346273d735f34d171146a589b9f522c
-  data.tar.gz: 703f9211ff50685b2144fe96b6e8428bf2453d718618e2c5b90730a789899e37b04dab2c10e440d9e4e6f1916906801d28b0bdf926fe673004c3266af8e652dc
+  metadata.gz: cb0604d3a6b3b1dabafc68c8ea32637b5855fcc9bd747e1eb2d4ef5c02c826100160c983432f09df973aa7533d183173483fe6cf7779f7318046dbefaf39fd49
+  data.tar.gz: d037bef8500d5b8f45f6e9f363306ee4871ce295a9e38e260a132861352368040183a4a4e7395a4bfbd30b825d86487f9e75b9cf56a90b437487c1e2da3c4bb6

data/bin/sony-ci-api

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/sony-ci-api/sony_ci_admin'
+
+args = begin
+  Hash[ARGV.slice_before { |a| a.match(/^--/) }.to_a.map { |a| [a[0].gsub(/^--/, ''), a[1..-1]] }]
+rescue
+  {}
+end
+
+ci = SonyCiAdmin.new(
+  # verbose: true,
+  credentials_path: 'ci.yml')
+
+begin
+  case args.keys.sort
+
+  when ['log', 'up']
+    fail ArgumentError.new if args['log'].empty? || args['up'].empty?
+    args['up'].each { |path| ci.upload(path, args['log'].first) }
+
+  when ['down']
+    fail ArgumentError.new if args['down'].empty?
+    args['down'].each { |id| puts ci.download(id) }
+
+  when ['list']
+    fail ArgumentError.new unless args['list'].empty?
+    ci.each { |asset| puts "#{asset['name']}\t#{asset['id']}" }
+
+  when ['recheck']
+    fail ArgumentError.new if args['recheck'].empty?
+    args['recheck'].each do |file|
+      File.foreach(file) do |line|
+        line.chomp!
+        id = line.split("\t")[2]
+        detail = ci.detail(id).to_s.gsub("\n", ' ')
+        puts line + "\t" + detail
+      end
+    end
+
+  else
+    fail ArgumentError.new
+  end
+rescue ArgumentError
+  abort 'Usage: --up GLOB --log LOG_FILE | --down ID | --list | --recheck LOG_FILE'
+end

data/lib/sony-ci-api.rb

@@ -0,0 +1,2 @@
+require_relative 'sony-ci-api/sony_ci_basic'
+require_relative 'sony-ci-api/sony_ci_admin'

data/lib/{sony_ci_admin.rb → sony-ci-api/sony_ci_admin.rb}

@@ -6,32 +6,39 @@ require_relative 'sony_ci_basic'
 class SonyCiAdmin < SonyCiBasic
   include Enumerable
 
+  # Upload a document to Ci. Underlying API treats large and small files
+  # differently, but this should treat both alike.
   def upload(file_path, log_file)
     Uploader.new(self, file_path, log_file).upload
   end
 
+  # Just the names of items in the workspace. This may include directories.
   def list_names
     list.map { |item| item['name'] } - ['Workspace']
     # A self reference is present even in an empty workspace.
   end
 
+  # Full metadata for a windowed set of items.
   def list(limit=50, offset=0)
     Lister.new(self).list(limit, offset)
   end
 
+  # Iterate over all items.
   def each
     Lister.new(self).each { |asset| yield asset }
   end
 
+  # Delete items by asset ID.
   def delete(asset_id)
     Deleter.new(self).delete(asset_id)
   end
 
+  # Get detailed metadata by asset ID.
   def detail(asset_id)
     Detailer.new(self).detail(asset_id)
   end
 
-  class CiClient
+  class CiClient #:nodoc:
     # This class hierarchy might be excessive, but it gives us:
     # - a single place for the `perform` method
     # - and an isolated container for related private methods
@@ -47,7 +54,7 @@ class SonyCiAdmin < SonyCiBasic
     end
   end
 
-  class Detailer < CiClient
+  class Detailer < CiClient #:nodoc:
     def initialize(ci)
       @ci = ci
     end
@@ -60,7 +67,7 @@ class SonyCiAdmin < SonyCiBasic
     end
   end
 
-  class Deleter < CiClient
+  class Deleter < CiClient #:nodoc:
     def initialize(ci)
       @ci = ci
     end
@@ -72,7 +79,7 @@ class SonyCiAdmin < SonyCiBasic
     end
   end
 
-  class Lister < CiClient
+  class Lister < CiClient #:nodoc:
     include Enumerable
 
     def initialize(ci)
@@ -99,7 +106,7 @@ class SonyCiAdmin < SonyCiBasic
     end
   end
 
-  class Uploader < CiClient
+  class Uploader < CiClient #:nodoc:
     def initialize(ci, path, log_path)
       @ci = ci
       @path = path
@@ -172,49 +179,3 @@ class SonyCiAdmin < SonyCiBasic
   end
 end
 
-if __FILE__ == $PROGRAM_NAME
-  args = begin
-    Hash[ARGV.slice_before { |a| a.match(/^--/) }.to_a.map { |a| [a[0].gsub(/^--/, ''), a[1..-1]] }]
-  rescue
-    {}
-  end
-
-  ci = Ci.new(
-    # verbose: true,
-    credentials_path: Rails.root + 'config/ci.yml')
-
-  begin
-    case args.keys.sort
-
-    when ['log', 'up']
-      fail ArgumentError.new if args['log'].empty? || args['up'].empty?
-      args['up'].each { |path| ci.upload(path, args['log'].first) }
-
-    when ['down']
-      fail ArgumentError.new if args['down'].empty?
-      args['down'].each { |id| puts ci.download(id) }
-
-    when ['list']
-      fail ArgumentError.new unless args['list'].empty?
-      ci.each { |asset| puts "#{asset['name']}\t#{asset['id']}" }
-
-    when ['recheck']
-      fail ArgumentError.new if args['recheck'].empty?
-      args['recheck'].each do |file|
-        File.foreach(file) do |line|
-          line.chomp!
-          id = line.split("\t")[2]
-          detail = ci.detail(id).to_s.gsub("\n", ' ')
-          puts line + "\t" + detail
-        end
-      end
-
-    else
-      fail ArgumentError.new
-    end
-  rescue ArgumentError
-    abort 'Usage: --up GLOB --log LOG_FILE | --down ID | --list | --recheck LOG_FILE'
-  end
-
-end
-

data/lib/{sony_ci_basic.rb → sony-ci-api/sony_ci_basic.rb}

@@ -7,6 +7,7 @@ class SonyCiBasic
   attr_reader :verbose
   attr_reader :workspace_id
 
+  # Either +credentials_path+ or a +credentials+ object itself must be supplied.
   def initialize(opts={}) # rubocop:disable PerceivedComplexity, CyclomaticComplexity
     unrecognized_opts = opts.keys - [:verbose, :credentials_path, :credentials]
     fail "Unrecognized options #{unrecognized_opts}" unless unrecognized_opts == []
@@ -44,11 +45,12 @@ class SonyCiBasic
     @workspace_id = credentials['workspace_id']
   end
 
+  # Generate a temporary download URL for an asset.
   def download(asset_id)
     Downloader.new(self).download(asset_id)
   end
 
-  class CiClient
+  class CiClient #:nodoc:
     # This class hierarchy might be excessive, but it gives us:
     # - a single place for the `perform` method
     # - and an isolated container for related private methods
@@ -64,7 +66,7 @@ class SonyCiBasic
     end
   end
 
-  class Downloader < CiClient
+  class Downloader < CiClient #:nodoc:
     @@cache = {}
 
     def initialize(ci)
@@ -84,49 +86,3 @@ class SonyCiBasic
     end
   end
 end
-
-if __FILE__ == $PROGRAM_NAME
-  args = begin
-    Hash[ARGV.slice_before { |a| a.match(/^--/) }.to_a.map { |a| [a[0].gsub(/^--/, ''), a[1..-1]] }]
-  rescue
-    {}
-  end
-
-  ci = Ci.new(
-    # verbose: true,
-    credentials_path: Rails.root + 'config/ci.yml')
-
-  begin
-    case args.keys.sort
-
-    when ['log', 'up']
-      fail ArgumentError.new if args['log'].empty? || args['up'].empty?
-      args['up'].each { |path| ci.upload(path, args['log'].first) }
-
-    when ['down']
-      fail ArgumentError.new if args['down'].empty?
-      args['down'].each { |id| puts ci.download(id) }
-
-    when ['list']
-      fail ArgumentError.new unless args['list'].empty?
-      ci.each { |asset| puts "#{asset['name']}\t#{asset['id']}" }
-
-    when ['recheck']
-      fail ArgumentError.new if args['recheck'].empty?
-      args['recheck'].each do |file|
-        File.foreach(file) do |line|
-          line.chomp!
-          id = line.split("\t")[2]
-          detail = ci.detail(id).to_s.gsub("\n", ' ')
-          puts line + "\t" + detail
-        end
-      end
-
-    else
-      fail ArgumentError.new
-    end
-  rescue ArgumentError
-    abort 'Usage: --up GLOB --log LOG_FILE | --down ID | --list | --recheck LOG_FILE'
-  end
-
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sony-ci-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Chuck McCallum
@@ -12,12 +12,15 @@ date: 2015-05-28 00:00:00.000000000 Z
 dependencies: []
 description: Wrapper for the Sony Ci API (http://developers.cimediacloud.com/)
 email: chuck_mccallum@wgbh.org
-executables: []
+executables:
+- sony-ci-api
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/sony_ci_admin.rb
-- lib/sony_ci_basic.rb
+- bin/sony-ci-api
+- lib/sony-ci-api.rb
+- lib/sony-ci-api/sony_ci_admin.rb
+- lib/sony-ci-api/sony_ci_basic.rb
 homepage: https://github.com/WGBH/sony-ci-api
 licenses:
 - MIT