duracloud-client 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ea05804282811db4ddae6b49a04e87f30f3eec7
-  data.tar.gz: 8ab80ee402b9ff8f17dde4e6aeb445af13af77d0
+  metadata.gz: 37ba6ce5cc5015994ed96ce7d5fc1ad987b5ef96
+  data.tar.gz: 34d6471b5dbc0a84b65c06f8c2604f7e3c5b0f88
 SHA512:
-  metadata.gz: 0b67d6ac687c02438b8814b54ba3b2eec6e84ce1db77370aacd76789e8f22298af0370eda6a666dfc392533515db25608d4490d99819fa0ac8afc1203e823030
-  data.tar.gz: b832eed79711148ef5a0ab4be82d6f7d29186138ef66c403b3b99b71ca504e7f55975f840ee9fc64451848f6876629a182058ee155e165270eace05feb3da711
+  metadata.gz: 239504e09b5efb3d8db2e46afd0d24d935dcd8258c67ab996b302946ba9bb3a1322f6f385864e1f955be4d073a0790e8fd57202f6a788c7b6303189c7a137c23
+  data.tar.gz: 85b33cbfb16b8f4529fb88b6120904929407fe5532c7699c0a4a350d51fc9dcf9c645a7e1d25ec31eea399dd569de3cfd07339a4751ad51c22ba29fdce2e92bb

data/README.md

@@ -192,13 +192,13 @@ D, [2016-04-29T18:31:16.975749 #32379] DEBUG -- : Duracloud::Client HEAD https:/
 >> content.properties
  => #<Duracloud::ContentProperties x-dura-meta-owner="ellen@example.com">
 
->> content.properties.creator = "bob@example.com"
+>> content.properties["x-dura-meta-creator"] = "bob@example.com"
 >> content.save
 D, [2016-04-29T18:31:52.770195 #32379] DEBUG -- : Duracloud::Client POST https://foo.duracloud.org/durastore/rest-api-testing/foo3 200 OK
 I, [2016-04-29T18:31:52.770293 #32379]  INFO -- : Content foo3 updated successfully
  => true
 
->> content.properties.creator
+>> content.properties["x-dura-meta-creator"]
 D, [2016-04-29T18:32:06.465928 #32379] DEBUG -- : Duracloud::Client HEAD https://foo.duracloud.org/durastore/rest-api-testing/foo3 200 OK
  => "bob@example.com"
 ```     

data/lib/duracloud/abstract_entity.rb

@@ -42,7 +42,7 @@ module Duracloud
     #   but does not exist in Duracloud
     def properties
       load_properties if persisted? && @properties.nil?
-      @properties ||= properties_class.new
+      @properties ||= Properties.new
     end
 
 
@@ -76,8 +76,7 @@ module Duracloud
     end
 
     def properties=(props)
-      filtered = props ? properties_class.filter(props) : props
-      @properties = properties_class.new(filtered)
+      @properties = Properties.new(props)
     end
 
     def reset_properties

data/lib/duracloud/chunked_content.rb

@@ -34,6 +34,7 @@ module Duracloud
       self.properties = manifest.properties.dup
       self.content_type = manifest.source.content_type
       self.size = manifest.source.size
+      self.modified = manifest.content.modified
     end
 
   end

data/lib/duracloud/content.rb

@@ -46,7 +46,7 @@ module Duracloud
     end
 
     attr_accessor :space_id, :content_id, :store_id,
-                  :body, :md5, :content_type, :size
+                  :body, :md5, :content_type, :size, :modified
     alias_method :id, :content_id
     validates_presence_of :space_id, :content_id
 
@@ -168,6 +168,7 @@ module Duracloud
       self.properties = response.headers
       self.content_type = response.content_type
       self.size = response.size
+      self.modified = response.modified
     end
 
     def do_delete

data/lib/duracloud/properties.rb

@@ -6,109 +6,30 @@ module Duracloud
   #
   # Encapsulates Duracloud "properties" which are transmitted via HTTP headers.
   #
-  # @abstract
-  #
   class Properties < Hashie::Mash
 
     PREFIX = "x-dura-meta-".freeze
+    PREFIX_RE = /\A#{PREFIX}/i
 
-    # Space properties
-    SPACE = /\A#{PREFIX}space-(count|created)\z/
-
-    # Space ACL headers
-    SPACE_ACLS = /\A#{PREFIX}acl-/
-
-    # Copy Content headers
-    COPY_CONTENT = /\A#{PREFIX}copy-source(-store)?\z/
-
-    # DuraCloud internal content properties
-    INTERNAL = /\A#{PREFIX}content-(mimetype|size|checksum|modified)\z/
-
-    # Properties set by the DuraCloud SyncTool
-    SYNCTOOL = /\A#{PREFIX}(creator|(content-file-(created|modified|last-accessed|path)))\z/
-
-    # Is the property valid for this class of properties?
-    # @note Subclasses should override this method rather than the `#property?'
-    #   instance method.
+    # Is the property name valid?
     # @param prop [String] the property name
     # @return [Boolean]
     def self.property?(prop)
-      duracloud_property?(prop)
-    end
-
-    # Filter the hash of properties, selecting only the properties valid
-    #   for this particular usage (subclass).
-    # @param hsh [Hash] the unfiltered properties
-    # @return [Hash] the filtered properties
-    def self.filter(hsh)
-      hsh.select { |k, v| property?(k) }
-    end
-
-    # Is the property a (theoretically) valid DuraCloud property?
-    # @param prop [String] the property name
-    # @return [Boolean]
-    def self.duracloud_property?(prop)
-      prop.start_with?(PREFIX)
-    end
-
-    # Is the property a reserved "internal" DuraCloud property?
-    # @param prop [String] the property name
-    # @return [Boolean]
-    def self.internal_property?(prop)
-      INTERNAL =~ prop
+      !!( PREFIX_RE =~ prop.to_s )
     end
 
-    # Is the property a space property?
-    # @param prop [String] the property name
-    # @return [Boolean]
-    def self.space_property?(prop)
-      SPACE =~ prop
+    def initialize(source = nil, default = nil, &block)
+      source.select! { |k, v| property?(k) } if source
+      super
     end
 
-    # Is the property a space ACL?
-    # @param prop [String] the property name
-    # @return [Boolean]
-    def self.space_acl?(prop)
-      SPACE_ACLS =~ prop
-    end
-
-    # Is the property used for copying content?
-    # @param prop [String] the property name
-    # @return [Boolean]
-    def self.copy_content_property?(prop)
-      COPY_CONTENT =~ prop
-    end
-
-    # Is the property valid for this class of properties?
-    # @note Subclasses should not override this method, but instead
-    #   override the `.property?' class method.
-    # @param prop [String] the property name
-    # @return [Boolean]
-    # @api private
     def property?(prop)
       self.class.property?(prop)
     end
 
-    # Filter the hash of properties, selecting only the properties valid
-    #   for this particular usage (subclass).
-    # @param hsh [Hash] the unfiltered properties
-    # @return [Hash] the filtered properties
-    def filter(hsh)
-      self.class.filter(hsh)
-    end
-
-    # @api private
-    def regular_writer(key, value)
-      if property?(key)
-        super
-      else
-        raise Error, "#{self.class}: Unrecognized or restricted property \"#{key}\"."
-      end
-    end
-
     # @api private
     def convert_key(key)
-      force_ascii(duracloud_property!(super))
+      force_ascii(key)
     end
 
     # @api private
@@ -127,15 +48,6 @@ module Duracloud
 
     private
 
-    # Coerce to a DuraCloud property
-    def duracloud_property!(prop)
-      prop.dup.tap do |p|
-        p.gsub!(/_/, '-')
-        p.downcase!
-        p.prepend(PREFIX) unless self.class.duracloud_property?(p)
-      end
-    end
-
     def convert_array(value)
       value.uniq!
       if value.length > 1

data/lib/duracloud/response.rb

@@ -1,4 +1,5 @@
 require "forwardable"
+require "date"
 
 module Duracloud
   class Response
@@ -43,5 +44,9 @@ module Duracloud
     def size
       header["content-length"].first.to_i rescue nil
     end
+
+    def modified
+      DateTime.parse(header["last-modified"].first) rescue nil
+    end
   end
 end

data/lib/duracloud/space.rb

@@ -141,16 +141,18 @@ module Duracloud
 
     # Return the number of items in the space
     # @return [Fixnum] the number of items
+    # @note If the count is over 1000, DuraCloud sets the
+    #   x-dura-meta-space-count header to "1000+".
+    #   This method will in that case return 1000, indicating
+    #   that the exact count must be retrieved by other means.
     def count
-      properties.space_count.to_i
+      properties["x-dura-meta-space-count"].to_i
     end
 
     # Return the creation date of the space, if persisted, or nil.
     # @return [DateTime] the date
     def created
-      if space_created = properties.space_created
-        DateTime.parse(space_created)
-      end
+      DateTime.parse(properties["x-dura-meta-space-created"]) rescue nil
     end
 
     # Find a content item in the space

data/lib/duracloud/space_acls.rb

@@ -6,18 +6,15 @@ module Duracloud
 
     ACL_PREFIX = (PREFIX + "acl-").freeze
 
-    def self.property?(prop)
-      space_acl?(prop)
-    end
-
     attr_reader :space
 
     def initialize(space)
-      super()
       @space = space
       if space.persisted?
         response = Client.get_space_acls(space.space_id, **query)
-        update filter(response.headers)
+        super(response.headers)
+      else
+        super()
       end
     end
 

data/lib/duracloud/version.rb

@@ -1,3 +1,3 @@
 module Duracloud
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/lib/duracloud.rb

@@ -13,7 +13,6 @@ module Duracloud
   autoload :Connection, "duracloud/connection"
   autoload :Content, "duracloud/content"
   autoload :ContentManifest, "duracloud/content_manifest"
-  autoload :ContentProperties, "duracloud/content_properties"
   autoload :DurastoreRequest, "duracloud/durastore_request"
   autoload :ErrorHandler, "duracloud/error_handler"
   autoload :HasProperties, "duracloud/has_properties"
@@ -25,7 +24,6 @@ module Duracloud
   autoload :RestMethods, "duracloud/rest_methods"
   autoload :Space, "duracloud/space"
   autoload :SpaceAcls, "duracloud/space_acls"
-  autoload :SpaceProperties, "duracloud/space_properties"
   autoload :Store, "duracloud/store"
   autoload :SyncValidation, "duracloud/sync_validation"
   autoload :TSV, "duracloud/tsv"

data/spec/spec_helper.rb

@@ -4,6 +4,18 @@ require "webmock/rspec"
 
 WebMock.disable_net_connect!(allow_localhost: true)
 
+# Monkey-patches WebMock to not alter header names
+WebMock::Util::Headers.class_eval do
+  def self.normalize_headers(headers)
+    return nil unless headers
+    headers.each do |name, value|
+      if value.is_a?(Array) && value.size == 1
+        headers[name] = value.first
+      end
+    end
+  end
+end
+
 Duracloud::Client.configure do |config|
   config.host = "example.com"
   config.user = "testuser"

data/spec/unit/content_spec.rb

@@ -8,21 +8,37 @@ module Duracloud
       describe "when it exists" do
         subject { described_class.find(space_id: "foo", content_id: "bar") }
         describe "and it is not chunked" do
-          before { stub_request(:head, url) }
+          before {
+            stub_request(:head, url)
+              .to_return(headers: {
+                           "Content-MD5"=>"164e9aee34c0c42915716e11d5d539b5",
+                           "Content-Length"=>"1811970",
+                           "Content-Type"=>"image/jpeg",
+                           "Last-Modified"=>"2017-06-12T17:36:58",
+                         })
+          }
           it { is_expected.to be_a described_class }
           it { is_expected.to_not be_chunked }
+          its(:md5) { is_expected.to eq "164e9aee34c0c42915716e11d5d539b5" }
+          its(:size) { is_expected.to eq 1811970 }
+          its(:content_type) { is_expected.to eq "image/jpeg" }
+          its(:modified) { is_expected.to eq DateTime.parse("2017-06-12T17:36:58") }
         end
         describe "and it is chunked" do
           let(:manifest_xml) { File.read(File.expand_path("../../fixtures/content_manifest.xml", __FILE__)) }
           before do
             stub_request(:head, url).to_return(status: 404)
             stub_request(:head, manifest_url)
+              .to_return(headers: {
+                           "Last-Modified"=>"2017-06-26T16:38:42",
+                         })
             stub_request(:get, manifest_url).to_return(body: manifest_xml)
           end
           it { is_expected.to be_a described_class }
           its(:md5) { is_expected.to eq "164e9aee34c0c42915716e11d5d539b5" }
           its(:size) { is_expected.to eq 4227858432 }
           its(:content_type) { is_expected.to eq "application/octet-stream" }
+          its(:modified) { is_expected.to eq DateTime.parse("2017-06-26T16:38:42") }
           it { is_expected.to be_chunked }
         end
       end
@@ -153,7 +169,7 @@ module Duracloud
               .with(headers: {'x-dura-meta-creator'=>'testuser'})
           }
           it "updates the properties" do
-            subject.properties.creator = "testuser"
+            subject.properties["x-dura-meta-creator"] = "testuser"
             subject.save
           end
         end
@@ -199,9 +215,9 @@ module Duracloud
                                'Content-MD5'=>'08a008a01d498c404b0c30852b39d3b8'})
       end
       specify {
-        pending "Research Webmock problem with return headers"
         content = Content.find(space_id: "foo", content_id: "bar")
-        expect(content.properties.x_dura_meta_creator).to eq('testuser')
+        puts content.properties.to_h
+        expect(content.properties["x-dura-meta-creator"]).to eq('testuser')
       }
     end
 

data/spec/unit/properties_spec.rb

@@ -1,13 +1,15 @@
 module Duracloud
   RSpec.describe Properties do
 
-    describe ".filter"
-    describe ".property?"
-    describe ".duraspace_property?"
-    describe ".internal_property?"
-    describe ".space_property?"
-    describe ".space_acl?"
-    describe ".copy_content_property?"
+    describe "ignores non-DuraCloud keys" do
+      subject { described_class.new("access-control-allow-headers"=>"Content-Type, Authorization", "access-control-allow-methods"=>"GET, POST, PUT, DELETE", "access-control-allow-origin"=>"*", "cache-control"=>"no-cache=\"set-cookie\"", "content-type"=>"application/octet-stream", "date"=>"Wed, 12 Jul 2017 14:52:41 GMT", "expires"=>"0", "pragma"=>"no-cache", "server"=>"Apache-Coyote/1.1", "strict-transport-security"=>"max-age=31536000 ; includeSubDomains", "vary"=>"Accept-Encoding", "x-content-type-options"=>"nosniff", "x-dura-meta-space-count"=>"1000+", "x-dura-meta-space-created"=>"2017-07-06T20:35:39", "x-frame-options"=>"DENY", "x-xss-protection"=>"1; mode=block", "connection"=>"keep-alive") }
+      its(:to_h) { is_expected.to eq({"x-dura-meta-space-count"=>"1000+", "x-dura-meta-space-created"=>"2017-07-06T20:35:39"}) }
+    end
+
+    describe "preserves original keys" do
+      subject { described_class.new("x-dura-meta-acl-foo_bar"=>"READ", "x-dura-meta-acl-group-spam-eggs"=>"WRITE") }
+      its(:to_h) { is_expected.to eq({"x-dura-meta-acl-foo_bar"=>"READ", "x-dura-meta-acl-group-spam-eggs"=>"WRITE"}) }
+    end
 
   end
 end

data/spec/unit/space_spec.rb

@@ -52,9 +52,15 @@ EOS
       describe "when found" do
         before {
           stub_request(:head, url)
+            .to_return(headers: {
+                         "x-dura-meta-space-count"=>"1000+",
+                         "x-dura-meta-space-created"=>"2017-05-18T20:03:18",
+                       })
         }
         it { is_expected.to be_a(Space) }
         its(:space_id) { is_expected.to eq("foo") }
+        its(:count) { is_expected.to eq 1000 }
+        its(:created) { is_expected.to eq DateTime.parse("2017-05-18T20:03:18") }
       end
       describe "when not found" do
         before {
@@ -123,22 +129,17 @@ EOS
         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'
-                 })
-        }
+        stub_request(:get, "#{url}?maxResults=1000")
+          .to_return(body: body,
+                     headers: {
+                       'X-Dura-Meta-Space-Count'=>'3',
+                       'X-Dura-Meta-Space-Created'=>'2016-04-05T17:59:11'
+                     })
+        stub_request(:head, url)
+          .to_return(headers: {
+                       'x-dura-meta-space-count'=>'3',
+                       'x-dura-meta-space-created'=>'2016-04-05T17:59:11'
+                     })
       }
       describe "class methods" do
         specify {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duracloud-client
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - David Chandek-Stark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-29 00:00:00.000000000 Z
+date: 2017-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -174,7 +174,6 @@ files:
 - lib/duracloud/connection.rb
 - lib/duracloud/content.rb
 - lib/duracloud/content_manifest.rb
-- lib/duracloud/content_properties.rb
 - lib/duracloud/durastore_request.rb
 - lib/duracloud/error.rb
 - lib/duracloud/error_handler.rb
@@ -185,7 +184,6 @@ files:
 - lib/duracloud/rest_methods.rb
 - lib/duracloud/space.rb
 - lib/duracloud/space_acls.rb
-- lib/duracloud/space_properties.rb
 - lib/duracloud/store.rb
 - lib/duracloud/sync_validation.rb
 - lib/duracloud/tsv.rb

data/lib/duracloud/content_properties.rb

@@ -1,7 +0,0 @@
-module Duracloud
-  class ContentProperties < Properties
-    def self.property?(prop)
-      super && !( space_property?(prop) || space_acl?(prop) || copy_content_property?(prop) )
-    end
-  end
-end

data/lib/duracloud/space_properties.rb

@@ -1,9 +0,0 @@
-require "date"
-
-module Duracloud
-  class SpaceProperties < Properties
-    def self.property?(prop)
-      space_property?(prop)
-    end
-  end
-end