duracloud-client 0.0.3 → 0.1.0

data/lib/duracloud/space_properties.rb

@@ -2,20 +2,8 @@ require "date"
 
 module Duracloud
   class SpaceProperties < Properties
-
     def self.property?(prop)
       space_property?(prop)
     end
-
-    def count
-      space_count.to_i
-    end
-
-    def created
-      DateTime.parse(space_created)
-    rescue ArgumentError
-      space_created
-    end
-
   end
 end

data/lib/duracloud/store.rb

@@ -1,16 +1,28 @@
 require "nokogiri"
 
 module Duracloud
+  #
+  # A Duracloud storage provider account.
+  #
   class Store
 
+   # @return [Array<Duracloud::Store>] the list of available storage provider accounts.
     def self.all
       response = Client.get_stores
       doc = Nokogiri::XML(response.body)
       doc.css('storageAcct').map { |acct| new(acct) }
     end
 
+    # @return [Duracloud::Store] the primary storage provider account.
+    def self.primary
+      all.detect { |store| store.primary? }
+    end
+
+    private_class_method :new
+
     attr_reader :id, :owner_id, :primary, :provider_type
 
+    # @api private
     def initialize(xml_node)
       @owner_id = xml_node['ownerId']
       @primary = xml_node['isPrimary']

data/lib/duracloud/version.rb

@@ -1,3 +1,3 @@
 module Duracloud
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/duracloud.rb

@@ -2,12 +2,14 @@ require "duracloud/version"
 require "duracloud/error"
 
 module Duracloud
+  autoload :AuditLog, "duracloud/audit_log"
   autoload :BitIntegrityReport, "duracloud/bit_integrity_report"
   autoload :Client, "duracloud/client"
   autoload :Configuration, "duracloud/configuration"
   autoload :Connection, "duracloud/connection"
   autoload :Content, "duracloud/content"
   autoload :ContentProperties, "duracloud/content_properties"
+  autoload :CSVReader, "duracloud/csv_reader"
   autoload :DurastoreRequest, "duracloud/durastore_request"
   autoload :ErrorHandler, "duracloud/error_handler"
   autoload :HasProperties, "duracloud/has_properties"

data/spec/spec_helper.rb

@@ -1,23 +1,16 @@
 require "duracloud"
 require "rspec/its"
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# The generated `.rspec` file contains `--require spec_helper` which will cause
-# this file to always be loaded, without a need to explicitly require it in any
-# files.
-#
-# Given that it is always loaded, you are encouraged to keep this file as
-# light-weight as possible. Requiring heavyweight dependencies from this file
-# will add to the boot time of your test suite on EVERY test run, even for an
-# individual file that may not need all of that loaded. Instead, consider making
-# a separate helper file that requires the additional dependencies and performs
-# the additional setup, and require it from the spec files that actually need
-# it.
-#
-# The `.rspec` file also contains a few flags that are not defaults but that
-# users commonly want.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require "webmock/rspec"
+
+WebMock.disable_net_connect!(allow_localhost: true)
+
+Duracloud::Client.configure do |config|
+  config.host = "example.com"
+  config.user = "testuser"
+  config.password = "testpass"
+  config.silence_logging!
+end
+
 RSpec.configure do |config|
   # rspec-expectations config goes here. You can use an alternate
   # assertion/expectation library such as wrong or the stdlib/minitest
@@ -72,13 +65,13 @@ RSpec.configure do |config|
     # Use the documentation formatter for detailed output,
     # unless a formatter has already been configured
     # (e.g. via a command-line flag).
-    config.default_formatter = 'doc'
+    # config.default_formatter = 'doc'
   end
 
   # Print the 10 slowest examples and example groups at the
   # end of the spec run, to help surface which specs are running
   # particularly slow.
-  config.profile_examples = 10
+  # config.profile_examples = 10
 
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing

data/spec/unit/audit_log_spec.rb

@@ -0,0 +1,5 @@
+module Duracloud
+  RSpec.describe AuditLog do
+
+  end
+end

data/spec/unit/bit_integrity_report_spec.rb

@@ -0,0 +1,5 @@
+module Duracloud
+  RSpec.describe BitIntegrityReport do
+
+  end
+end

data/spec/unit/client_spec.rb

@@ -1,9 +1,280 @@
 module Duracloud
   RSpec.describe Client do
-    describe "#get_content"
-    describe "#get_content_properties"
-    describe "#set_content_properties"
-    describe "#store_content"
-    describe "#delete_content"
+    describe "get_stores" do
+      specify {
+        stub = stub_request(:get, "https://example.com/durastore/stores")
+        subject.get_stores
+        expect(stub).to have_been_requested
+      }
+    end
+
+    describe "get_spaces" do
+      specify {
+        stub = stub_request(:get, "https://example.com/durastore/spaces")
+        subject.get_spaces
+        expect(stub).to have_been_requested
+      }
+      specify {
+        stub = stub_request(:get, "https://example.com/durastore/spaces")
+                           .with(query: {storeID: 1})
+        subject.get_spaces(storeID: 1)
+        expect(stub).to have_been_requested
+      }
+    end
+
+    describe "get_space" do
+      specify {
+        stub = stub_request(:get, "https://example.com/durastore/foo")
+        subject.get_space("foo")
+        expect(stub).to have_been_requested
+      }
+      specify {
+        stub = stub_request(:get, "https://example.com/durastore/foo")
+               .with(query: {storeID: 1, prefix: "bar", maxResults: 50, marker: "item1"})
+        subject.get_space("foo", storeID: 1, prefix: "bar", maxResults: 50, marker: "item1")
+        expect(stub).to have_been_requested
+      }
+    end
+
+    describe "create_space" do
+      specify {
+        stub = stub_request(:put, "https://example.com/durastore/foo")
+        subject.create_space("foo")
+        expect(stub).to have_been_requested
+      }
+      specify {
+        stub = stub_request(:put, "https://example.com/durastore/foo")
+                           .with(query: {storeID: 1})
+        subject.create_space("foo", storeID: 1)
+        expect(stub).to have_been_requested
+      }
+    end
+
+    describe "delete_space" do
+      specify {
+        stub = stub_request(:delete, "https://example.com/durastore/foo")
+        subject.delete_space("foo")
+        expect(stub).to have_been_requested
+      }
+      specify {
+        stub = stub_request(:delete, "https://example.com/durastore/foo")
+                           .with(query: {storeID: 1})
+        subject.delete_space("foo", storeID: 1)
+        expect(stub).to have_been_requested
+      }
+    end
+
+    describe "get_space_acls" do
+      specify {
+        stub = stub_request(:head, "https://example.com/durastore/acl/foo")
+        subject.get_space_acls("foo")
+        expect(stub).to have_been_requested
+      }
+      specify {
+        stub = stub_request(:head, "https://example.com/durastore/acl/foo")
+               .with(query: {storeID: 1})
+        subject.get_space_acls("foo", storeID: 1)
+        expect(stub).to have_been_requested
+      }
+    end
+
+    describe "set_space_acls" do
+      specify {
+        stub = stub_request(:post, "https://example.com/durastore/acl/foo")
+               .with(headers: {'x-dura-meta-acl-user0'=>'WRITE',
+                               'x-dura-meta-acl-user1'=>'WRITE',
+                               'x-dura-meta-acl-group-curators'=>'READ'})
+        subject.set_space_acls("foo",
+                               headers: {'x-dura-meta-acl-user0'=>'WRITE',
+                                         'x-dura-meta-acl-user1'=>'WRITE',
+                                         'x-dura-meta-acl-group-curators'=>'READ'})
+        expect(stub).to have_been_requested
+      }
+      specify {
+        stub = stub_request(:post, "https://example.com/durastore/acl/foo")
+               .with(headers: {'x-dura-meta-acl-user0'=>'WRITE',
+                               'x-dura-meta-acl-user1'=>'WRITE',
+                               'x-dura-meta-acl-group-curators'=>'READ'},
+                     query: {storeID: 1})
+        subject.set_space_acls("foo",
+                               storeID: 1,
+                               headers: {'x-dura-meta-acl-user0'=>'WRITE',
+                                         'x-dura-meta-acl-user1'=>'WRITE',
+                                         'x-dura-meta-acl-group-curators'=>'READ'})
+        expect(stub).to have_been_requested
+      }
+    end
+
+    describe "get_content" do
+      specify {
+        stub = stub_request(:get, "https://example.com/durastore/foo/bar")
+        subject.get_content("foo", "bar")
+        expect(stub).to have_been_requested
+      }
+      specify {
+        stub = stub_request(:get, "https://example.com/durastore/foo/bar")
+               .with(query: {storeID: 1})
+        subject.get_content("foo", "bar", storeID: 1)
+        expect(stub).to have_been_requested
+      }
+    end
+
+    describe "get_content_properties" do
+      specify {
+        stub = stub_request(:head, "https://example.com/durastore/foo/bar")
+        subject.get_content_properties("foo", "bar")
+        expect(stub).to have_been_requested
+      }
+      specify {
+        stub = stub_request(:head, "https://example.com/durastore/foo/bar")
+               .with(query: {storeID: 1})
+        subject.get_content_properties("foo", "bar", storeID: 1)
+        expect(stub).to have_been_requested
+      }
+    end
+
+    describe "set_content_properties" do
+      specify {
+        stub = stub_request(:post, "https://example.com/durastore/foo/bar")
+               .with(headers: {'x-dura-meta-owner'=>'testuser'})
+        subject.set_content_properties("foo", "bar",
+                                       headers: {'x-dura-meta-owner'=>'testuser'})
+        expect(stub).to have_been_requested
+      }
+      specify {
+        stub = stub_request(:post, "https://example.com/durastore/foo/bar")
+               .with(headers: {'x-dura-meta-owner'=>'testuser'},
+                     query: {storeID: 1})
+        subject.set_content_properties("foo", "bar",
+                                       headers: {'x-dura-meta-owner'=>'testuser'},
+                                       storeID: 1)
+        expect(stub).to have_been_requested
+      }
+    end
+
+    describe "store_content" do
+      specify {
+        stub = stub_request(:put, "https://example.com/durastore/foo/bar")
+               .with(body: "File content",
+                     headers: {
+                       'Content-Type'=>'text/plain',
+                       'Content-MD5'=>'8bb2564936980e92ceec8a5759ec34a8'
+                     })
+        subject.store_content("foo", "bar",
+                              body: "File content",
+                              headers: {
+                                'Content-Type'=>'text/plain',
+                                'Content-MD5'=>'8bb2564936980e92ceec8a5759ec34a8'
+                              })
+        expect(stub).to have_been_requested
+      }
+      specify {
+        stub = stub_request(:put, "https://example.com/durastore/foo/bar")
+               .with(body: "File content",
+                     headers: {
+                       'Content-Type'=>'text/plain',
+                       'Content-MD5'=>'8bb2564936980e92ceec8a5759ec34a8'
+                     },
+                     query: {storeID: 1})
+        subject.store_content("foo", "bar",
+                              body: "File content",
+                              headers: {
+                                'Content-Type'=>'text/plain',
+                                'Content-MD5'=>'8bb2564936980e92ceec8a5759ec34a8'
+                              },
+                              storeID: 1)
+        expect(stub).to have_been_requested
+      }
+    end
+
+    describe "delete_content" do
+      specify {
+        stub = stub_request(:delete, "https://example.com/durastore/foo/bar")
+        subject.delete_content("foo", "bar")
+        expect(stub).to have_been_requested
+      }
+      specify {
+        stub = stub_request(:delete, "https://example.com/durastore/foo/bar")
+               .with(query: {storeID: 1})
+        subject.delete_content("foo", "bar", storeID: 1)
+        expect(stub).to have_been_requested
+      }
+    end
+
+    describe "copy_content" do
+      specify {
+        expect { subject.copy_content("foo", "bar", headers: {'x-dura-meta-copy-source'=>'space-id/content-id'}) }
+          .to raise_error(NotImplementedError)
+      }
+    end
+
+    describe "get_audit_log" do
+      specify {
+        stub = stub_request(:get, "https://example.com/durastore/audit/foo")
+        subject.get_audit_log("foo")
+        expect(stub).to have_been_requested
+      }
+      specify {
+        stub = stub_request(:get, "https://example.com/durastore/audit/foo")
+               .with(query: {storeID: 1})
+        subject.get_audit_log("foo", storeID: 1)
+        expect(stub).to have_been_requested
+      }
+    end
+
+    describe "get_manifest" do
+      specify {
+        stub = stub_request(:get, "https://example.com/durastore/manifest/foo")
+        subject.get_manifest("foo")
+        expect(stub).to have_been_requested
+      }
+      specify {
+        stub = stub_request(:get, "https://example.com/durastore/manifest/foo")
+               .with(query: {format: "BAGIT", storeID: 1})
+        subject.get_manifest("foo", format: "BAGIT", storeID: 1)
+        expect(stub).to have_been_requested
+      }
+    end
+
+    describe "get_bit_integrity_report" do
+      specify {
+        stub = stub_request(:get, "https://example.com/durastore/bit-integrity/foo")
+        subject.get_bit_integrity_report("foo")
+        expect(stub).to have_been_requested
+      }
+      specify {
+        stub = stub_request(:get, "https://example.com/durastore/bit-integrity/foo")
+               .with(query: {storeID: 1})
+        subject.get_bit_integrity_report("foo", storeID: 1)
+        expect(stub).to have_been_requested
+      }
+    end
+
+    describe "get_bit_integrity_report_properties" do
+      specify {
+        stub = stub_request(:head, "https://example.com/durastore/bit-integrity/foo")
+        subject.get_bit_integrity_report_properties("foo")
+        expect(stub).to have_been_requested
+      }
+      specify {
+        stub = stub_request(:head, "https://example.com/durastore/bit-integrity/foo")
+               .with(query: {storeID: 1})
+        subject.get_bit_integrity_report_properties("foo", storeID: 1)
+        expect(stub).to have_been_requested
+      }
+    end
+
+    describe "get_tasks" do
+      specify {
+        expect { subject.get_tasks }.to raise_error(NotImplementedError)
+      }
+    end
+
+    describe "perform_task" do
+      specify {
+        expect { subject.perform_task("enable-streaming") }
+          .to raise_error(NotImplementedError)
+      }
+    end
   end
 end

data/spec/unit/content_spec.rb

@@ -1,29 +1,122 @@
 module Duracloud
   RSpec.describe Content do
 
+    let(:url) { "https://example.com/durastore/foo/bar" }
+
     describe ".find" do
-      subject { Content.find(space_id: "foo", id: "bar") }
-      before {
-        allow_any_instance_of(Content).to receive(:load_properties) { nil }
-      }
-      it { is_expected.to be_a(Content) }
-      its(:url) { is_expected.to eq("foo/bar") }
+      describe "when it exists" do
+        before { stub_request(:head, url) }
+        specify {
+          expect(Content.find("foo", "bar")).to be_a(Content)
+        }
+      end
+      describe "when it does not exist" do
+        before { stub_request(:head, url).to_return(status: 404) }
+        specify {
+          expect { Content.find("foo", "bar") }.to raise_error(NotFoundError)
+        }
+      end
     end
 
-    describe ".create" do
-      let(:body) { "Contents of the file" }
-      subject { Content.create(space_id: "foo", id: "bar", body: body) }
-      before {
-        allow_any_instance_of(Content).to receive(:save) { nil }
-      }
-      it { is_expected.to be_a(Content) }
-      its(:url) { is_expected.to eq("foo/bar") }
+    describe ".exist?" do
+      subject { Content.exist?("foo", "bar") }
+      describe "when it exists" do
+        before { stub_request(:head, url) }
+        it { is_expected.to be true }
+      end
+      describe "when it does not exist" do
+        before { stub_request(:head, url).to_return(status: 404) }
+        it { is_expected.to be false }
+      end
     end
 
     describe "#save" do
+      subject { Content.new("foo", "bar") }
+      describe "when not persisted" do
+        describe "when empty" do
+          it "raises an exception" do
+            expect { subject.save }.to raise_error(Error)
+          end
+        end
+        describe "when not empty" do
+          before { subject.body = "Some file content" }
+          describe "and the space does not exist" do
+            before {
+              stub_request(:put, url).with(body: "Some file content")
+                .to_return(status: 404)
+            }
+            it "raises an exception" do
+              expect { subject.save }.to raise_error(NotFoundError)
+            end
+          end
+          describe "and the space exists" do
+            before {
+              stub_request(:put, url).with(body: "Some file content")
+                .to_return(status: 201)
+            }
+            it "stores the content" do
+              subject.save
+              expect(subject).to be_persisted
+            end
+          end
+        end
+      end
+      describe "when persisted" do
+        before {
+          allow(subject).to receive(:persisted?) { true }
+          stub_request(:head, url)
+        }
+        describe "and the body has changed" do
+          before {
+            stub_request(:put, url).with(body: "Some file content")
+              .to_return(status: 201)
+          }
+          it "stores the content" do
+            subject.body = "Some file content"
+            subject.save
+          end
+        end
+        describe "and the body has not changed" do
+          before {
+            allow(subject).to receive(:body_changed?) { false }
+            stub_request(:post, url)
+              .with(headers: {'x-dura-meta-creator'=>'testuser'})
+          }
+          it "updates the properties" do
+            subject.properties.creator = "testuser"
+            subject.save
+          end
+        end
+      end
     end
 
     describe "#delete" do
+      subject { Content.new("foo", "bar") }
+      describe "when not found" do
+        before { stub_request(:delete, url).to_return(status: 404) }
+        it "raises an exception" do
+          expect { subject.delete }.to raise_error(NotFoundError)
+        end
+      end
+      describe "when found" do
+        before { stub_request(:delete, url) }
+        it "deletes the content" do
+          subject.delete
+          expect(subject).to be_deleted
+        end
+      end
+    end
+
+    describe "#properties" do
+      before {
+        stub_request(:head, url)
+          .to_return(status: 200, headers: {'x-dura-meta-creator'=>'testuser'})
+      }
+      specify {
+        pending "A problem with Webmock / HTTPClient?"
+        content = Content.find("foo", "bar")
+        expect(content.properties.x_dura_meta_creator).to eq('testuser')
+      }
     end
 
   end

data/spec/{fixtures/responses/GetManifest.tsv → unit/manifest_spec.rb}

@@ -1,3 +1,12 @@
+module Duracloud
+  RSpec.describe Manifest do
+
+    let(:body) { <<-EOS
 space-id	content-id	MD5
 auditlogs	localhost/51/auditlogs/localhost_51_auditlogs-2014-09-10-15-56-07.tsv	6992f8e57dafb17335f766aa2acf5942
 auditlogs	localhost/51/photos/localhost_51_photos-2014-09-10-15-55-01.tsv		820e786633fb495db447dc5d5cf0b2bd
+EOS
+    }
+
+  end
+end