duracloud-client 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 434249b9d6736f7d391be4fc5189270a542f59e0
-  data.tar.gz: 4af488c84ba6a92a239c971577c6cd5384c5c5a7
+  metadata.gz: 935b71b6483353f2dee2f6919df2844e31f51ba7
+  data.tar.gz: 369ec0668fbc416e23978241668a983e2bd92caa
 SHA512:
-  metadata.gz: 3fb21e2fd338b9273b5afafb5cfe1394f4052232bc12619d6a98f549e383c576a9371e046a3a43212fa6d9596f7c9c36e52a8a5c8355dd3b4c1183970dc4184f
-  data.tar.gz: 79cd8060222f7a4e7fc2fd0b9485d05f690900d2e1afb28bf6159ec1fedca56a3089c99cd2d60c88832cb8361ea362d7027d6081ea4f682191cdc3807a79d02b
+  metadata.gz: 6f8717da6c2ef7515e7bf791456d923c6156a445c541a3a5c21bd7b8d73730881ba4bd681ffc7539ca5717c9b2b25a887cd6de50107ad5c4149c4806aed553d4
+  data.tar.gz: 351a64019bdea2b4426d9288df4ac5c7f7fa166dfe89ee25d3cecd14930a8c20ae71f01a29a34a1d9118431eb8df1d173e72d055b583b5359639e5d30ec6dbca

data/README.md

@@ -103,6 +103,12 @@ D, [2016-04-29T12:15:12.593075 #28275] DEBUG -- : Duracloud::Client HEAD https:/
 
 A `Duracloud::NotFoundError` exception is raised if the space does not exist.
 
+NOTE: When the object count in a space exceeds 1000, Duracloud returns "1000+" as the count. Ruby's integer coercion `to_i`
+turns that string into the integer 1000.  Getting an exact count above 1000 requires (on the client side) enumerating the content_ids
+(below, fixed in v0.7.2 when count is >= 1000) which can take a long time for a space with a lot of content items,
+since a maxiumum of 1000 ids can be retrived at one time. If an up-to-the-minute
+count is not required, the storage report for the space (not yet implemented in this library) shows an exact count on a daily basis.
+
 #### Enumerate the content IDs of the space
 
 ```
@@ -322,7 +328,8 @@ D, [2016-05-19T15:39:33.538448 #29974] DEBUG -- : Duracloud::Client GET https://
 
 *New in version 0.6.0*
 
-The `bin/` directory of the gem now includes an executable `duracloud`.  Use `-h/--help` to display usage.  If the gem was installed with `bundler` you may need to run `bundle exec bin/duracloud`.
+The `bin/` directory of the gem now includes an executable `duracloud`.  Use `-h/--help` to display usage.
+If the gem was installed with `bundler` you may need to run `bundle exec bin/duracloud`.
 
 ## Versioning
 

data/bin/duracloud

@@ -2,4 +2,4 @@
 
 require 'duracloud'
 
-Duracloud::Command.call(*ARGV)
+Duracloud::CLI.call(*ARGV)

data/lib/duracloud.rb

@@ -7,8 +7,7 @@ module Duracloud
   autoload :BitIntegrityReport, "duracloud/bit_integrity_report"
   autoload :ChunkedContent, "duracloud/chunked_content"
   autoload :Client, "duracloud/client"
-  autoload :Command, "duracloud/command"
-  autoload :Commands, "duracloud/commands"
+  autoload :CLI, "duracloud/cli"
   autoload :Configuration, "duracloud/configuration"
   autoload :Connection, "duracloud/connection"
   autoload :Content, "duracloud/content"

data/lib/duracloud/{command.rb → cli.rb}

@@ -2,23 +2,34 @@ require 'optparse'
 require 'active_model'
 
 module Duracloud
-  class Command
+  class CLI
     include ActiveModel::Model
-    include Commands
 
-    COMMANDS = Commands.public_instance_methods.map(&:to_s)
-    USAGE = "Usage: duracloud [#{COMMANDS.join('|')}] [options]"
-    HELP = "Type 'duracloud --help' for usage."
+    COMMANDS = %w( sync validate manifest properties )
+
+    USAGE = <<-EOS
+Usage: duracloud [COMMAND] [options]
+
+Commands:
+    #{COMMANDS.sort.join("\n    ")}
+
+Options:
+EOS
+    HELP = "Type 'duracloud -h/--help' for usage."
 
     attr_accessor :command, :user, :password, :host, :port,
                   :space_id, :store_id, :content_id,
                   :content_type, :md5,
-                  :content_dir, :format,
+                  :content_dir, :format, :infile,
                   :logging
 
-    def self.error!(reason)
-      STDERR.puts reason
-      STDERR.puts HELP
+    validates_presence_of :space_id, message: "-s/--space-id option is required."
+
+    def self.error!(exception)
+      $stderr.puts exception.message
+      if [ CommandError, OptionParser::ParseError ].include?(exception.class)
+        $stderr.puts HELP
+      end
       exit(false)
     end
 
@@ -88,27 +99,47 @@ module Duracloud
                 "Local content directory") do |v|
           options[:content_dir] = v
         end
+
+        opts.on("-f", "--infile FILE",
+                "Input file") do |v|
+          options[:infile] = v
+        end
       end
 
       command = args.shift if COMMANDS.include?(args.first)
       parser.parse!(args)
 
-      new(options).execute(command)
-    rescue CommandError, OptionParser::ParseError => e
-      error!(e.message)
+      cli = new(options)
+      if cli.invalid?
+        message = cli.errors.map { |k, v| "ERROR: #{v}" }.join("\n")
+        raise CommandError, message
+      end
+      cli.execute(command)
+    rescue => e
+      error!(e)
     end
 
     def execute(command)
-      unless COMMANDS.include?(command)
-        raise CommandError, "Invalid command: #{command}."
-      end
-      begin
-        configure_client
-        send(command)
-      rescue Error => e
-        STDERR.puts e.message
-        exit(false)
-      end
+      configure_client
+      send(command).call(self)
+    end
+
+    protected
+
+    def sync
+      Commands::Sync
+    end
+
+    def validate
+      Commands::Validate
+    end
+
+    def manifest
+      Commands::DownloadManifest
+    end
+
+    def properties
+      Commands::GetProperties
     end
 
     private
@@ -126,3 +157,5 @@ module Duracloud
 
   end
 end
+
+Dir[File.expand_path("../commands/*.rb", __FILE__)].each { |m| require m }

data/lib/duracloud/commands/command.rb

@@ -0,0 +1,11 @@
+require 'delegate'
+
+module Duracloud::Commands
+  class Command < SimpleDelegator
+
+    def self.call(command)
+      new(command).call
+    end
+
+  end
+end

data/lib/duracloud/commands/download_manifest.rb

@@ -0,0 +1,13 @@
+require_relative "command"
+
+module Duracloud::Commands
+  class DownloadManifest < Command
+
+    def call
+      Duracloud::Manifest.download(space_id, store_id, format: format) do |chunk|
+        print chunk
+      end
+    end
+
+  end
+end

data/lib/duracloud/commands/get_properties.rb

@@ -0,0 +1,27 @@
+require_relative "command"
+
+module Duracloud::Commands
+  class GetProperties < Command
+
+    def call
+      proplist = content_id ? content_properties : space_properties
+      puts proplist
+    end
+
+    private
+
+    def content_properties
+      content = Duracloud::Content.find(space_id: space_id, store_id: store_id, content_id: content_id, md5: md5)
+      proplist = content.properties.map { |k, v| "#{k}: #{v}" }
+      proplist << "MD5: #{content.md5}"
+      proplist << "Size: #{content.size} (#{content.human_size})"
+      proplist << "Chunked?: #{content.chunked?}"
+    end
+
+    def space_properties
+      space = Duracloud::Space.find(space_id, store_id)
+      space.properties.map { |k, v| "#{k}: #{v}" }
+    end
+
+  end
+end

data/lib/duracloud/commands/sync.rb

@@ -0,0 +1,18 @@
+require_relative 'command'
+
+module Duracloud::Commands
+  class Sync < Command
+
+    def call
+      if infile
+        File.open(infile, "rb") do |f|
+          self.content_id ||= infile # XXX relativize to cwd?
+          Duracloud::Content.create(space_id: space_id, store_id: store_id, content_id: content_id, md5: md5, body: f)
+        end
+      else
+        Duracloud::Content.create(space_id: space_id, store_id: store_id, content_id: content_id, md5: md5, body: $stdin)
+      end
+    end
+
+  end
+end

data/lib/duracloud/commands/validate.rb

@@ -0,0 +1,11 @@
+require_relative "command"
+
+module Duracloud::Commands
+  class Validate < Command
+
+    def call
+      Duracloud::SyncValidation.call(space_id: space_id, store_id: store_id, content_dir: content_dir)
+    end
+
+  end
+end

data/lib/duracloud/version.rb

@@ -1,3 +1,3 @@
 module Duracloud
-  VERSION = "0.7.2"
+  VERSION = "0.8.0"
 end

data/spec/unit/cli_spec.rb

@@ -0,0 +1,43 @@
+module Duracloud
+  RSpec.describe CLI do
+
+    subject { described_class.new(**opts) }
+
+    describe "properties" do
+      let(:opts) { {space_id: "foo", content_id: "bar"} }
+      let(:command) { "properties" }
+      specify {
+        expect(Commands::GetProperties).to receive(:call).with(subject) { nil }
+        subject.execute(command)
+      }
+    end
+
+    describe "sync" do
+      let(:opts) { {space_id: "foo", content_id: "bar", infile: "foo/bar"} }
+      let(:command) { "sync" }
+      specify {
+        expect(Commands::Sync).to receive(:call).with(subject) { nil }
+        subject.execute(command)
+      }
+    end
+
+    describe "validate" do
+      let(:opts) { {space_id: "foo", content_dir: "/tmp"} }
+      let(:command) { "validate" }
+      specify {
+        expect(Commands::Validate).to receive(:call).with(subject) { nil }
+        subject.execute(command)
+      }
+    end
+
+    describe "manifest" do
+      let(:opts) { {space_id: "foo"} }
+      let(:command) { "manifest" }
+      specify {
+        expect(Commands::DownloadManifest).to receive(:call).with(subject) { nil }
+        subject.execute(command)
+      }
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duracloud-client
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - David Chandek-Stark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-25 00:00:00.000000000 Z
+date: 2017-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -167,9 +167,13 @@ files:
 - lib/duracloud/audit_log.rb
 - lib/duracloud/bit_integrity_report.rb
 - lib/duracloud/chunked_content.rb
+- lib/duracloud/cli.rb
 - lib/duracloud/client.rb
-- lib/duracloud/command.rb
-- lib/duracloud/commands.rb
+- lib/duracloud/commands/command.rb
+- lib/duracloud/commands/download_manifest.rb
+- lib/duracloud/commands/get_properties.rb
+- lib/duracloud/commands/sync.rb
+- lib/duracloud/commands/validate.rb
 - lib/duracloud/configuration.rb
 - lib/duracloud/connection.rb
 - lib/duracloud/content.rb
@@ -197,6 +201,7 @@ files:
 - spec/support/shared_examples_for_tsv.rb
 - spec/unit/audit_log_spec.rb
 - spec/unit/bit_integrity_report_spec.rb
+- spec/unit/cli_spec.rb
 - spec/unit/client_spec.rb
 - spec/unit/content_manifest_spec.rb
 - spec/unit/content_spec.rb
@@ -239,6 +244,7 @@ test_files:
 - spec/support/shared_examples_for_tsv.rb
 - spec/unit/audit_log_spec.rb
 - spec/unit/bit_integrity_report_spec.rb
+- spec/unit/cli_spec.rb
 - spec/unit/client_spec.rb
 - spec/unit/content_manifest_spec.rb
 - spec/unit/content_spec.rb

data/lib/duracloud/commands.rb

@@ -1,35 +0,0 @@
-module Duracloud
-  module Commands
-
-    def validate
-      SyncValidation.call(space_id: space_id, store_id: store_id, content_dir: content_dir)
-    end
-
-    def manifest
-      Manifest.download(space_id, store_id, format: format) do |chunk|
-        print chunk
-      end
-    end
-
-    def properties
-      proplist = content_id ? content_properties : space_properties
-      STDOUT.puts proplist
-    end
-
-    private
-
-    def content_properties
-      content = Content.find(space_id: space_id, store_id: store_id, content_id: content_id, md5: md5)
-      proplist = content.properties.map { |k, v| "#{k}: #{v}" }
-      proplist << "MD5: #{content.md5}"
-      proplist << "Size: #{content.size} (#{content.human_size})"
-      proplist << "Chunked?: #{content.chunked?}"
-    end
-
-    def space_properties
-      space = Space.find(space_id, store_id)
-      space.properties.map { |k, v| "#{k}: #{v}" }
-    end
-
-  end
-end