duracloud-client 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ffaf9ecb1c5717ae700751a890c3710300fbff5
-  data.tar.gz: 31350ff200eac0de8019a199c6efdee0d1c1d9c0
+  metadata.gz: 59d7bfce0068c8362b66814cb1b02804fda5bba8
+  data.tar.gz: e01c0afa6b9369450862d5189ea0954cf2c90491
 SHA512:
-  metadata.gz: e0ee33db9ade2fa348d8cc32932eedf32b5e0597588c6dec72d670de5c38fca36d7fed32eb3eccf003395c75855a453c8749d4b4824b47b840d00c5e494977b8
-  data.tar.gz: 4c83da5b63a58eec84f43224f4bcedb9fa60e7f0a542bf2be8de0a47e939421c03cea9cbce170aa708a70a9790dd8279c0ebb2492749edbcaf6e53103fd78bb8
+  metadata.gz: 8ec2713a12f89c42e7b9fb9117d94051ebed80c610f64123ec33ef8226c0c72934c2369cbaba4799da6a6511baecdd9be4946bd88c10c909f08f025fe5787c7c
+  data.tar.gz: b779ccb8781e2a9fc40208766dd87442024f70c2e6c1e643fc0a7270892093c2d00f5bfce7c6e3efa341cfef9a61f4f966a5e6a2900da44a2b73de3e55ebba39

data/README.md

@@ -192,6 +192,49 @@ D, [2016-04-29T18:29:03.935451 #32379] DEBUG -- : Duracloud::Client HEAD https:/
  => false
 ```
 
+### Reports
+
+The audit logs, bit integrity reports and manifests are accessible in their original TSV format and in normalized CSV tables.
+
+#### Audit Log
+
+```
+>> space = Duracloud::Space.find("rest-api-testing")
+>> audit_log = space.audit_log
+ => #<Duracloud::AuditLog:0x007fd44c077f38 @space_id="rest-api-testing", @store_id=nil, @response=nil>
+
+>> audit_log.csv
+D, [2016-05-19T13:36:49.107520 #28754] DEBUG -- : Duracloud::Client GET https://duke.duracloud.org/durastore/audit/rest-api-testing 200 OK
+ => #<CSV::Table mode:col_or_row row_count:168>
+```
+
+#### Manifest
+
+```
+>> space = Duracloud::Space.find("rest-api-testing")
+>> manifest = space.manifest
+ => #<Duracloud::Manifest:0x007fd44d3c7048 @space_id="rest-api-testing", @store_id=nil, @tsv_response=nil, @bagit_response=nil>
+
+>> manifest.csv
+D, [2016-05-19T13:37:39.831013 #28754] DEBUG -- : Duracloud::Client GET https://duke.duracloud.org/durastore/manifest/rest-api-testing 200 OK
+ => #<CSV::Table mode:col_or_row row_count:10>
+
+>> manifest.csv.headers
+ => ["space_id", "content_id", "md5"]
+```
+
+#### Bit Integrity Report
+
+```
+>> space = Duracloud::Space.find("rest-api-testing")
+>> bit_integrity_report = space.bit_integrity_report
+ => #<Duracloud::BitIntegrityReport:0x007f88e39a2950 @space_id="rest-api-testing", @store_id=nil, @report=nil, @properties=nil>
+
+>> bit_integrity_report.csv
+D, [2016-05-19T15:39:33.538448 #29974] DEBUG -- : Duracloud::Client GET https://duke.duracloud.org/durastore/bit-integrity/rest-api-testing 200 OK
+ => #<CSV::Table mode:col_or_row row_count:8> 
+```
+
 ## Versioning
 
 We endeavor to follow semantic versioning.  In particular, versions < 1.0 may introduce backward-incompatible changes without notice.  Use at your own risk.  Version 1.0 signals a stable API.

data/lib/duracloud/audit_log.rb

@@ -1,5 +1,6 @@
 module Duracloud
   class AuditLog
+    include TSV
 
     attr_reader :space_id, :store_id
 
@@ -9,10 +10,6 @@ module Duracloud
       @response = nil
     end
 
-    def csv(opts = {})
-      CSVReader.call(tsv, opts)
-    end
-
     def tsv
       response.body
     end

data/lib/duracloud/bit_integrity_report.rb

@@ -2,6 +2,7 @@ require "date"
 
 module Duracloud
   class BitIntegrityReport
+    include TSV
 
     SUCCESS = "SUCCESS".freeze
     FAILURE = "FAILURE".freeze
@@ -29,10 +30,6 @@ module Duracloud
       properties[RESULT_HEADER].first
     end
 
-    def csv(opts = {})
-      CSVReader.new(tsv, opts)
-    end
-
     def success?
       result == SUCCESS
     end

data/lib/duracloud/manifest.rb

@@ -1,8 +1,6 @@
 module Duracloud
   class Manifest
-
-    BAGIT = "BAGIT".freeze
-    TSV   = "TSV".freeze
+    include TSV
 
     attr_reader :space_id, :store_id
 
@@ -13,10 +11,6 @@ module Duracloud
       @bagit_response = nil
     end
 
-    def csv(opts = {})
-      CSVReader.call(tsv, opts)
-    end
-
     def tsv
       tsv_response.body
     end
@@ -28,11 +22,11 @@ module Duracloud
     private
 
     def tsv_response
-      @tsv_response ||= get_response(TSV)
+      @tsv_response ||= get_response("TSV")
     end
 
     def bagit_response
-      @bagit_response ||= get_response(BAGIT)
+      @bagit_response ||= get_response("BAGIT")
     end
 
     def get_response(format)

data/lib/duracloud/space.rb

@@ -170,7 +170,7 @@ module Duracloud
     # Return the bit integrity report for the space
     # @return [Duracloud::BitIntegrityReport] the report
     def bit_integrity_report
-      BitIntergrityReport.new(space_id, store_id)
+      BitIntegrityReport.new(space_id, store_id)
     end
 
     # Return the manifest for the space

data/lib/duracloud/tsv.rb

@@ -0,0 +1,32 @@
+require "csv"
+
+module Duracloud
+  module TSV
+    # @return [CSV::Table]
+    def csv
+      @csv ||= CSV::Table.new([]).tap do |csv|
+        header_line, rows = tsv.split(/\r?\n/, 2)
+        headers = header_line.split("\t").map { |h| h.downcase.gsub(/-/, "_") }
+        header_row = CSV::Row.new(headers, headers, true)
+        csv << header_row
+        rows.split(/\r?\n/).each do |row|
+          csv << row.split("\t")
+        end
+      end
+    end
+
+    # @return [Enumerator] rows as hashes
+    def rows
+      Enumerator.new do |e|
+        csv.by_row!.each do |row|
+          next if row.header_row?
+          e << row.to_hash
+        end
+      end
+    end
+
+    def tsv
+      raise NotImplementedError, "Including module must implement `tsv`."
+    end
+  end
+end

data/lib/duracloud/version.rb

@@ -1,3 +1,3 @@
 module Duracloud
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/duracloud.rb

@@ -9,7 +9,6 @@ module Duracloud
   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"
@@ -23,4 +22,5 @@ module Duracloud
   autoload :SpaceAcls, "duracloud/space_acls"
   autoload :SpaceProperties, "duracloud/space_properties"
   autoload :Store, "duracloud/store"
+  autoload :TSV, "duracloud/tsv"
 end

data/spec/fixtures/audit_log.tsv

@@ -0,0 +1,7 @@
+account	store-id	space-id	content-id	content-md5	content-size	content-mimetype	content-properties	space-acls	source-space-id	source-content-id	timestamp	action	username
+example	1065	myspace									2016-04-27T18:34:18.018	CREATE_SPACE	bob@example.com
+example	1065	myspace						{acl-bob@example.com=WRITE}			2016-04-27T18:34:20.020	SET_SPACE_ACLS	bob@example.com
+example	1065	myspace	METADATA/d6/42/0c/9c/d6420c9c-82f8-4f6a-baf7-37b9be7f4c5f/20160502_172925/manifest-md5.txt	21fef474787860ccfb67bdd99ddee93a	55	text/plain	{  "content-file-path" : "/duracloud/METADATA/d6/42/0c/9c/d6420c9c-82f8-4f6a-baf7-37b9be7f4c5f/20160502_172925/manifest-md5.txt",  "creator" : "bob@example.com",  "content-file-created" : "2016-05-02T15:04:59.059",  "content-file-last-accessed" : "2016-05-02T15:04:59.059",  "content-mimetype" : "text/plain",  "content-file-modified" : "2016-05-02T15:04:59.059"}				2016-05-02T21:06:45.045	ADD_CONTENT	bob@example.com
+example	1065	myspace	METADATA/d6/42/0c/9c/d6420c9c-82f8-4f6a-baf7-37b9be7f4c5f/20160502_172925/data/object-desc.rdf	e5f8c32a4997d808538df98b893caee0	2383	application/octet-stream	{  "content-file-path" : "/duracloud/METADATA/d6/42/0c/9c/d6420c9c-82f8-4f6a-baf7-37b9be7f4c5f/20160502_172925/data/object-desc.rdf",  "creator" : "bob@example.com",  "content-file-created" : "2016-05-02T15:04:59.059",  "content-file-last-accessed" : "2016-05-02T15:11:31.031",  "content-mimetype" : "application/octet-stream",  "content-file-modified" : "2016-05-02T15:04:59.059"}				2016-05-02T21:06:46.046	ADD_CONTENT	bob@example.com
+example	1065	myspace	METADATA/d6/42/0c/9c/d6420c9c-82f8-4f6a-baf7-37b9be7f4c5f/20160502_172925.zip	edeb8560a822aad5cfb43dd2d563903b	2406	application/zip	{  "content-file-path" : "/duracloud/METADATA/d6/42/0c/9c/d6420c9c-82f8-4f6a-baf7-37b9be7f4c5f/20160502_172925.zip",  "creator" : "bob@example.com",  "content-file-created" : "2016-05-02T15:04:59.059",  "content-file-last-accessed" : "2016-05-02T15:11:15.015",  "content-mimetype" : "application/zip",  "content-file-modified" : "2016-05-02T15:04:59.059"}				2016-05-02T21:06:46.046	ADD_CONTENT	bob@example.com
+example	1065	myspace	METADATA/f1/ee/ac/99/f1eeac99-4d9a-49d1-8e17-02a61e244642/20160426_120239.zip	f69d67c54d2aa7f97fb55cb40f357f79	6858	application/zip	{  "content-file-path" : "/duracloud/METADATA/f1/ee/ac/99/f1eeac99-4d9a-49d1-8e17-02a61e244642/20160426_120239.zip",  "creator" : "bob@example.com",  "content-file-created" : "2016-05-02T15:43:40.040",  "content-file-last-accessed" : "2016-05-02T15:43:40.040",  "content-mimetype" : "application/zip",  "content-file-modified" : "2016-05-02T15:43:40.040"}				2016-05-02T21:06:53.053	ADD_CONTENT	bob@example.com

data/spec/fixtures/bit_integrity_report.tsv

@@ -0,0 +1,4 @@
+date-checked	account	store-id	store-type	space-id	content-id	result	content-checksum	provider-checksum	manifest-checksum	details
+2016-05-15T04:11:14	example	1065	AMAZON_S3	myspace	BINARIES/00/00/e8/0000e819ac3e67d039d288adaab5b5e44c3c21d9	SUCCESS	27333f3c06a6d259863384799be68d30	27333f3c06a6d259863384799be68d30	27333f3c06a6d259863384799be68d30	--
+2016-05-15T04:11:21	example	1065	AMAZON_S3	myspace	BINARIES/00/03/4a/00034a58075c694f54be09393cf59d90c683954f	SUCCESS	12283b9c2772b45b290962753cd8f66d	12283b9c2772b45b290962753cd8f66d	12283b9c2772b45b290962753cd8f66d	--
+2016-05-15T04:11:19	example	1065	AMAZON_S3	myspace	BINARIES/00/03/7e/00037e755c26c7ddebedd159a87e98c8149461a2	SUCCESS	26cf06d36cbfe4f9fe50e5b14204eed1	26cf06d36cbfe4f9fe50e5b14204eed1	26cf06d36cbfe4f9fe50e5b14204eed1	--

data/spec/fixtures/manifest.tsv

@@ -0,0 +1,4 @@
+space-id	content-id	MD5
+myspace	METADATA/d6/42/0c/9c/d6420c9c-82f8-4f6a-baf7-37b9be7f4c5f/20160502_172925/manifest-md5.txt	21fef474787860ccfb67bdd99ddee93a
+myspace	METADATA/d6/42/0c/9c/d6420c9c-82f8-4f6a-baf7-37b9be7f4c5f/20160502_172925/data/object-desc.rdf	e5f8c32a4997d808538df98b893caee0
+myspace	METADATA/d6/42/0c/9c/d6420c9c-82f8-4f6a-baf7-37b9be7f4c5f/20160502_172925.zip	8de045d0dd989e0d778272a262645835

data/spec/unit/audit_log_spec.rb

@@ -1,5 +1,22 @@
 module Duracloud
   RSpec.describe AuditLog do
 
+    let(:tsv) { File.read(File.join(File.expand_path('../../fixtures/audit_log.tsv', __FILE__))) }
+
+    before {
+      allow(subject).to receive(:tsv) { tsv }
+    }
+
+    subject { described_class.new("myspace") }
+
+    describe "CSV" do
+      specify {
+        expect(subject.csv.headers).to eq(%w(account store_id space_id content_id content_md5 content_size content_mimetype content_properties space_acls source_space_id source_content_id timestamp action username))
+        expect(subject.csv.size).to eq(7)
+        expect(subject.csv.to_s.split("\n").first).to eq("account,store_id,space_id,content_id,content_md5,content_size,content_mimetype,content_properties,space_acls,source_space_id,source_content_id,timestamp,action,username")
+        expect(subject.rows.next).to eq({"account"=>"example", "store_id"=>"1065", "space_id"=>"myspace", "content_id"=>"", "content_md5"=>"", "content_size"=>"", "content_mimetype"=>"", "content_properties"=>"", "space_acls"=>"", "source_space_id"=>"", "source_content_id"=>"", "timestamp"=>"2016-04-27T18:34:18.018", "action"=>"CREATE_SPACE", "username"=>"bob@example.com"})
+      }
+    end
+
   end
 end

data/spec/unit/bit_integrity_report_spec.rb

@@ -1,5 +1,22 @@
 module Duracloud
   RSpec.describe BitIntegrityReport do
 
+    let(:tsv) { File.read(File.join(File.expand_path('../../fixtures/bit_integrity_report.tsv', __FILE__))) }
+
+    before {
+      allow(subject).to receive(:tsv) { tsv }
+    }
+
+    subject { described_class.new("myspace") }
+
+    describe "CSV" do
+      specify {
+        expect(subject.csv.headers).to eq(%w(date_checked account store_id store_type space_id content_id result content_checksum provider_checksum manifest_checksum details))
+        expect(subject.csv.size).to eq(4)
+        expect(subject.csv.to_s.split("\n").first).to eq("date_checked,account,store_id,store_type,space_id,content_id,result,content_checksum,provider_checksum,manifest_checksum,details")
+        expect(subject.rows.next).to eq({"date_checked"=>"2016-05-15T04:11:14", "account"=>"example", "store_id"=>"1065", "store_type"=>"AMAZON_S3", "space_id"=>"myspace", "content_id"=>"BINARIES/00/00/e8/0000e819ac3e67d039d288adaab5b5e44c3c21d9", "result"=>"SUCCESS", "content_checksum"=>"27333f3c06a6d259863384799be68d30", "provider_checksum"=>"27333f3c06a6d259863384799be68d30", "manifest_checksum"=>"27333f3c06a6d259863384799be68d30", "details"=>"--"})
+      }
+    end
+
   end
 end

data/spec/unit/content_spec.rb

@@ -109,11 +109,13 @@ module Duracloud
 
     describe "#properties" do
       before {
-        stub_request(:head, url)
-          .to_return(status: 200, headers: {'x-dura-meta-creator'=>'testuser'})
+        allow(Client).to receive(:get_content_properties)
+                          .with("foo", "bar", hash_including(storeID: nil)) {
+          double(headers: {'x-dura-meta-creator'=>'testuser'},
+                 content_type: 'text/plain')
+        }
       }
       specify {
-        pending "A problem with Webmock / HTTPClient?"
         content = Content.find("foo", "bar")
         expect(content.properties.x_dura_meta_creator).to eq('testuser')
       }

data/spec/unit/manifest_spec.rb

@@ -1,12 +1,22 @@
 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
+    let(:tsv) { File.read(File.join(File.expand_path('../../fixtures/manifest.tsv', __FILE__))) }
+
+    before {
+      allow(subject).to receive(:tsv) { tsv }
     }
 
+    subject { described_class.new("myspace") }
+
+    describe "CSV" do
+      specify {
+        expect(subject.csv.headers).to eq(%w(space_id content_id md5))
+        expect(subject.csv.size).to eq(4)
+        expect(subject.csv.to_s.split("\n").first).to eq("space_id,content_id,md5")
+        expect(subject.rows.next).to eq({"space_id"=>"myspace", "content_id"=>"METADATA/d6/42/0c/9c/d6420c9c-82f8-4f6a-baf7-37b9be7f4c5f/20160502_172925/manifest-md5.txt", "md5"=>"21fef474787860ccfb67bdd99ddee93a"})
+      }
+    end
+
   end
 end

data/spec/unit/space_spec.rb

@@ -101,40 +101,70 @@ EOS
       }
       let(:url) { "https://example.com/durastore/foo" }
       before {
-        stub_request(:head, url)
-          .to_return(headers: {
-                       'x-dura-meta-space-count'=>'3',
-                       'x-dura-meta-space-created'=>'2016-04-05T17:59:11'
-                     })
-        stub_request(:get, url).to_return(body: body)
+        stub_request(:head, "#{url}/foo1")
+        stub_request(:head, "#{url}/foo2")
+        stub_request(:head, "#{url}/foo3")
+        allow(Client).to receive(:get_space)
+                          .with("foo", hash_including(storeID: nil)) {
+          double(body: body,
+                 headers: {
+                   'x-dura-meta-space-count'=>'3',
+                   'x-dura-meta-space-created'=>'2016-04-05T17:59:11'
+                 })
+        }
+        allow(Client).to receive(:get_space_properties)
+                          .with("foo", hash_including(storeID: nil)) {
+          double(body: "",
+                 headers: {
+                   'x-dura-meta-space-count'=>'3',
+                   'x-dura-meta-space-created'=>'2016-04-05T17:59:11'
+                 })
+        }
       }
-      describe ".content_ids", pending: "Correcting the stub request" do
-        subject { Space.content_ids("foo") }
-        its(:to_a) { is_expected.to eq(["foo1", "foo2", "foo3"]) }
+      describe "class methods" do
+        specify {
+          expect(Space.content_ids("foo").to_a).to eq(["foo1", "foo2", "foo3"])
+        }
+        specify {
+          expect(Space.items("foo").map(&:id)).to eq(["foo1", "foo2", "foo3"])
+        }
+        specify {
+          expect(Space.count("foo")).to eq(3)
+        }
       end
-      describe "#content_ids" do
+      describe "instance methods" do
         subject { Space.find("foo") }
         specify {
-          pending "Correcting the stub request"
           expect(subject.content_ids.to_a).to eq(["foo1", "foo2", "foo3"])
         }
+        specify {
+          expect(subject.items.map(&:id)).to eq(["foo1", "foo2", "foo3"])
+        }
+        its(:count) { is_expected.to eq(3) }
       end
-
-      describe ".items"
-      describe "#items"
-
-      describe ".count"
-      describe "#count"
     end
 
-    describe ".audit_log"
-    describe "#audit_log"
-
-    describe ".bit_integrity_report"
-    describe "#bit_integrity_report"
-
-    describe ".manifest"
-    describe "#manifest"
-
+    describe "reports" do
+      describe "class methods" do
+        before {
+          stub_request(:head, "https://example.com/durastore/foo")
+        }
+        specify {
+          expect(Space.audit_log("foo")).to be_a(AuditLog)
+        }
+        specify {
+          expect(Space.bit_integrity_report("foo")).to be_a(BitIntegrityReport)
+        }
+        specify {
+          expect(Space.manifest("foo")).to be_a(Manifest)
+        }
+      end
+      describe "instance methods" do
+        subject { described_class.new("foo") }
+        its(:audit_log) { is_expected.to be_a(AuditLog) }
+        its(:bit_integrity_report) { is_expected.to be_a(BitIntegrityReport) }
+        its(:manifest) { is_expected.to be_a(Manifest) }
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duracloud-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - David Chandek-Stark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-03 00:00:00.000000000 Z
+date: 2016-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -160,7 +160,6 @@ files:
 - lib/duracloud/connection.rb
 - lib/duracloud/content.rb
 - lib/duracloud/content_properties.rb
-- lib/duracloud/csv_reader.rb
 - lib/duracloud/durastore_request.rb
 - lib/duracloud/error.rb
 - lib/duracloud/error_handler.rb
@@ -175,7 +174,11 @@ files:
 - lib/duracloud/space_acls.rb
 - lib/duracloud/space_properties.rb
 - lib/duracloud/store.rb
+- lib/duracloud/tsv.rb
 - lib/duracloud/version.rb
+- spec/fixtures/audit_log.tsv
+- spec/fixtures/bit_integrity_report.tsv
+- spec/fixtures/manifest.tsv
 - spec/spec_helper.rb
 - spec/unit/audit_log_spec.rb
 - spec/unit/bit_integrity_report_spec.rb
@@ -210,6 +213,9 @@ signing_key:
 specification_version: 4
 summary: Ruby client for communicating with DuraCloud
 test_files:
+- spec/fixtures/audit_log.tsv
+- spec/fixtures/bit_integrity_report.tsv
+- spec/fixtures/manifest.tsv
 - spec/spec_helper.rb
 - spec/unit/audit_log_spec.rb
 - spec/unit/bit_integrity_report_spec.rb

data/lib/duracloud/csv_reader.rb

@@ -1,19 +0,0 @@
-require "csv"
-
-module Duracloud
-  class CSVReader
-
-    CSV_OPTS = {
-      col_sep: '\t',
-      headers: :first_row,
-      write_headers: true,
-      return_headers: false,
-      header_converters: [ ->(h){ h.downcase.gsub(/-/, "_") } ]
-    }
-
-    def self.call(data, opts = {})
-      CSV.new(data, CSV_OPTS.merge(opts))
-    end
-
-  end
-end