duracloud-client 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f562bbe280990009391a82bc2480a8b829622eff
-  data.tar.gz: 25b2dec1653acd45e707a21b0b2d80c27728baaf
+  metadata.gz: 45e670a025414a048dd0e4043e25a370ef6085ee
+  data.tar.gz: 43ec5144e26fa7fb3334652bece16f293ddf3324
 SHA512:
-  metadata.gz: 742c9b3da2bb773f25f0cd4521981cb65fa1e620f74a8028ff31ddafc5d3eb0359e1a4ed2450fc718b7d25d9c2de2da6d57282d77e22b750306f07862eda183d
-  data.tar.gz: d909359cb467c461d89854eca31cc5c116db8c6d782ea5fed0daf13db8a1a540fbddf6ded1fc550772cd7420cec62d92685255c8b81cf0c949ab59960d1f229e
+  metadata.gz: cc638f78a134b5be821ceab5269ed84abe98d8f09bfa3d4122c1bf878dd1ab43d846fe8caf75c933e75fc868c9f3b80df8c7f98314702296535c7d6d10201c33
+  data.tar.gz: 84dbd31e44ebbc41c3f62ecbc2d9e2c1164f3ef5823818ebb88e4ec9c9051d4d6d15b6334210bf4a226f19851a1e40c3b2186dcd64a5ad568e53f2b19701a4ad

data/.travis.yml

@@ -1,8 +1,6 @@
 language: ruby
 rvm:
-  - 2.1
   - 2.2
-  - 2.3.0
+  - 2.3.1
 gemfile:
-  - gemfiles/Gemfile.activemodel-4.1
   - gemfiles/Gemfile.activemodel-4.2

data/Gemfile

@@ -1,4 +1,7 @@
 source 'https://rubygems.org'
+ruby '2.3.1'
 
 # Specify your gem's dependencies in duracloud.gemspec
 gemspec
+
+gem 'activemodel', '~> 4.2.7'

data/README.md

@@ -6,7 +6,7 @@ Ruby client for communicating with DuraCloud
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'duracloud'
+gem 'duracloud-client'
 ```
 
 And then execute:
@@ -15,7 +15,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install duracloud
+    $ gem install duracloud-client
 
 ## Usage
 
@@ -125,7 +125,7 @@ foo8
 #### Create a new content item and store it in DuraCloud
 
 ```
->> new_content = Duracloud::Content.new("rest-api-testing", "ark:/99999/fk4zzzz")
+>> new_content = Duracloud::Content.new(space_id: "rest-api-testing", content_id: "ark:/99999/fk4zzzz")
  => #<Duracloud::Content space_id="rest-api-testing", content_id="ark:/99999/fk4zzzz", store_id=(default)>
  
 >> new_content.body = "test"
@@ -138,16 +138,20 @@ foo8
  => #<Duracloud::Content space_id="rest-api-testing", content_id="ark:/99999/fk4zzzz", store_id=(default)>
 ```
 
-When storing content a `Duracloud::NotFoundError` is raised if the space does not exist. A `Duracloud::BadRequestError` is raised if the content ID is invalid.
+When storing content a `Duracloud::NotFoundError` is raised if the space does not exist.
+A `Duracloud::BadRequestError` is raised if the content ID is invalid.
+A `Duracloud::ConflictError` is raised if the provided MD5 digest does not match the stored digest.
 
 #### Retrieve an existing content item from DuraCloud
 
 ```
->> Duracloud::Content.find("spaceID", "contentID")
+>> Duracloud::Content.find(space_id: "spaceID", content_id: "contentID")
  => #<Duracloud::Content space_id="spaceID", content_id="contentID", store_id=(default)>
 ```
 
 If the space or content ID does not exist, a `Duracloud::NotFoundError` is raised.
+If an MD5 digest is provided (:md5 attribute), a `Duracloud::MessageDigestError` is
+raised if the content ID exists and the stored digest does not match.
 
 #### Update the properties for a content item
 

data/duracloud.gemspec

@@ -18,11 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.1"
+  spec.required_ruby_version = ">= 2.2"
 
   spec.add_dependency "hashie", "~> 3.4"
   spec.add_dependency "httpclient", "~> 2.7"
-  spec.add_dependency "activemodel", "~> 4.1"
+  spec.add_dependency "activemodel", ">= 4.2", "< 6"
   spec.add_dependency "nokogiri", "~> 1.6"
 
   spec.add_development_dependency "webmock", "~> 2.0"

data/gemfiles/{Gemfile.activemodel-4.1 → Gemfile.activemodel-5.0}

@@ -1,3 +1,3 @@
 source 'https://rubygems.org'
-gem "activemodel", "~> 4.1.16"
+gem "activemodel", "~> 5.0.1"
 gemspec path: "../"

data/lib/duracloud/content.rb

@@ -1,4 +1,3 @@
-require "stringio"
 require "active_model"
 
 module Duracloud
@@ -6,6 +5,7 @@ module Duracloud
   # A piece of content in DuraCloud
   #
   class Content
+    include ActiveModel::Model
     include ActiveModel::Dirty
     include Persistence
     include HasProperties
@@ -15,39 +15,31 @@ module Duracloud
     after_save :changes_applied
 
     # Does the content exist in DuraCloud?
-    # @see .new for arguments
     # @return [Boolean] whether the content exists
-    def self.exist?(*args)
-      find(*args) && true
+    # @raise [Duracloud::MessageDigestError] the provided digest in the :md5 attribute
+    #   does not match the stored value
+    def self.exist?(params={})
+      find(params) && true
     rescue NotFoundError
       false
     end
 
     # Find content in DuraCloud.
-    # @see .new for arguments
     # @return [Duraclound::Content] the content
     # @raise [Duracloud::NotFoundError] the space, content, or store does not exist.
-    def self.find(*args)
-      new(*args) { |content| content.load_properties }
+    # @raise [Duracloud::MessageDigestError] the provided digest in the :md5 attribute
+    #   does not match the stored value
+    def self.find(params={})
+      new(params).tap do |content|
+        content.load_properties
+      end
     end
 
-    attr_reader :space_id, :content_id, :store_id
+    attr_accessor :space_id, :content_id, :store_id
     alias_method :id, :content_id
+    validates_presence_of :space_id, :content_id
 
-    define_attribute_methods :content_type, :body
-
-    # @param space_id [String] The space ID (required)
-    # @param content_id [String] The content ID (required)
-    # @param store_id [String] the store ID (optional)
-    # @example
-    #   new("myspace", "mycontent.txt")
-    def initialize(space_id, content_id, store_id = nil)
-      @content_id = content_id
-      @space_id = space_id
-      @store_id = store_id
-      @body, @content_type = nil, nil
-      yield self if block_given?
-    end
+    define_attribute_methods :content_type, :body, :md5
 
     # Return the space associated with this content.
     # @return [Duracloud::Space] the space.
@@ -66,13 +58,15 @@ module Duracloud
     # @raise [Duracloud::NotFoundError] the content does not exist in DuraCloud.
     def load_body
       response = Client.get_content(*args, **query)
+      set_md5!(response)
       @body = response.body # don't use setter b/c marks as dirty
       persisted!
     end
 
     def load_properties
       super do |response|
-        # don't mark content_type as changed
+        # don't mark content_type or md5 as changed
+        set_md5!(response)
         @content_type = response.content_type
       end
     end
@@ -104,8 +98,28 @@ module Duracloud
       @content_type
     end
 
+    def md5=(val)
+      md5_will_change! unless val == @md5
+      @md5 = val
+    end
+
+    def md5
+      @md5
+    end
+
     private
 
+    def set_md5!(response)
+      if md5
+        if md5 != response.md5
+          raise MessageDigestError,
+                "Expected MD5 digest (#{md5}) does not match response header: #{response.md5}"
+        end
+      else
+        @md5 = response.md5
+      end
+    end
+
     def io_like?
       body.respond_to?(:read) && body.respond_to?(:rewind)
     end
@@ -119,7 +133,7 @@ module Duracloud
 
     def store
       headers = {
-        "Content-MD5"  => md5,
+        "Content-MD5"  => md5 || calculate_md5,
         "Content-Type" => content_type || "application/octet-stream"
       }
       headers.merge!(properties)
@@ -127,7 +141,7 @@ module Duracloud
       Client.store_content(*args, **options)
     end
 
-    def md5
+    def calculate_md5
       digest = Digest::MD5.new
       if io_like?
         body.rewind

data/lib/duracloud/error.rb

@@ -4,4 +4,5 @@ module Duracloud
   class NotFoundError < Error; end
   class BadRequestError < Error; end
   class ConflictError < Error; end
+  class MessageDigestError < Error; end
 end

data/lib/duracloud/properties.rb

@@ -25,7 +25,7 @@ module Duracloud
     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/
+    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?'

data/lib/duracloud/space.rb

@@ -160,7 +160,7 @@ module Duracloud
     # @return [Duracloud::Content] the content item.
     # @raise [Duracloud::NotFoundError] if the content item does not exist.
     def find_content(content_id)
-      Content.find(space_id, content_id, store_id)
+      Content.find(space_id: space_id, content_id: content_id, store_id: store_id)
     end
 
     # Return the audit log for the space

data/lib/duracloud/version.rb

@@ -1,3 +1,3 @@
 module Duracloud
-  VERSION = "0.1.5"
+  VERSION = "0.2.0"
 end

data/spec/unit/content_spec.rb

@@ -7,31 +7,64 @@ module Duracloud
       describe "when it exists" do
         before { stub_request(:head, url) }
         specify {
-          expect(Content.find("foo", "bar")).to be_a(Content)
+          expect(Content.find(space_id: "foo", content_id: "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)
+          expect { Content.find(space_id: "foo", content_id: "bar") }.to raise_error(NotFoundError)
         }
       end
+      describe "when providing an MD5" do
+        before do
+          stub_request(:head, url).to_return(headers: {'Content-MD5'=>'foo'})
+        end
+        describe "that is correct" do
+          specify {
+            expect(Content.find(space_id: "foo", content_id: "bar", md5: "foo")).to be_a(Content)
+          }
+        end
+        describe "that is incorrect" do
+          specify {
+            expect { Content.find(space_id: "foo", content_id: "bar", md5: "bar") }.to raise_error(MessageDigestError)
+          }
+        end
+      end
     end
 
     describe ".exist?" do
-      subject { Content.exist?("foo", "bar") }
       describe "when it exists" do
         before { stub_request(:head, url) }
-        it { is_expected.to be true }
+        specify {
+          expect(Content.exist?(space_id: "foo", content_id: "bar")).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 }
+        specify {
+          expect(Content.exist?(space_id: "foo", content_id: "bar")).to be false
+        }
+      end
+      describe "when providing an MD5" do
+        before do
+          stub_request(:head, url).to_return(headers: {'Content-MD5'=>'foo'})
+        end
+        describe "that is correct" do
+          specify {
+            expect(Content.exist?(space_id: "foo", content_id: "bar", md5: "foo")).to be true
+          }
+        end
+        describe "that is incorrect" do
+          specify {
+            expect { Content.exist?(space_id: "foo", content_id: "bar", md5: "bar") }.to raise_error(MessageDigestError)
+          }
+        end
       end
     end
 
     describe "#save" do
-      subject { Content.new("foo", "bar") }
+      subject { Content.new(space_id: "foo", content_id: "bar") }
       describe "when not persisted" do
         describe "when empty" do
           it "raises an exception" do
@@ -51,7 +84,9 @@ module Duracloud
           end
           describe "and the space exists" do
             before {
-              stub_request(:put, url).with(body: "Some file content")
+              stub_request(:put, url)
+                .with(body: "Some file content",
+                      headers: {"Content-MD5"=>"92bbcf620ceb5f5bf38f08e9a1f31e7b"})
                 .to_return(status: 201)
             }
             it "stores the content" do
@@ -68,7 +103,9 @@ module Duracloud
         }
         describe "and the body has changed" do
           before {
-            stub_request(:put, url).with(body: "Some file content")
+            stub_request(:put, url)
+              .with(body: "Some file content",
+                    headers: {"Content-MD5"=>"92bbcf620ceb5f5bf38f08e9a1f31e7b"})
               .to_return(status: 201)
           }
           it "stores the content" do
@@ -91,10 +128,12 @@ module Duracloud
       describe "when the body is a file" do
         let(:path) { File.expand_path('../../fixtures/lorem_ipsum.txt', __FILE__) }
         let(:file) { File.new(path, "rb") }
-        before {
-          stub_request(:put, url).with(body: File.read(path))
+        before do
+          stub_request(:put, url)
+            .with(body: File.read(path),
+                  headers: {"Content-MD5"=>"039d7100bea9ef2efbe151db953726ce"})
             .to_return(status: 201)
-        }
+        end
         it "stores the file content" do
           subject.body = file
           subject.save
@@ -103,7 +142,7 @@ module Duracloud
     end
 
     describe "#delete" do
-      subject { Content.new("foo", "bar") }
+      subject { Content.new(space_id: "foo", content_id: "bar") }
       describe "when not found" do
         before { stub_request(:delete, url).to_return(status: 404) }
         it "raises an exception" do
@@ -124,11 +163,12 @@ module Duracloud
         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')
+                 content_type: 'text/plain',
+                 md5: '08a008a01d498c404b0c30852b39d3b8')
         }
       }
       specify {
-        content = Content.find("foo", "bar")
+        content = Content.find(space_id: "foo", content_id: "bar")
         expect(content.properties.x_dura_meta_creator).to eq('testuser')
       }
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duracloud-client
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - David Chandek-Stark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-30 00:00:00.000000000 Z
+date: 2017-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -42,16 +42,22 @@ dependencies:
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -151,8 +157,8 @@ files:
 - README.md
 - Rakefile
 - duracloud.gemspec
-- gemfiles/Gemfile.activemodel-4.1
 - gemfiles/Gemfile.activemodel-4.2
+- gemfiles/Gemfile.activemodel-5.0
 - lib/duracloud-client.rb
 - lib/duracloud.rb
 - lib/duracloud/audit_log.rb
@@ -204,7 +210,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -212,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Ruby client for communicating with DuraCloud