duracloud-client 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 597a70d0d1ce9abc360fe01770e5dd4ed058604c
-  data.tar.gz: ef764b6b7e68c8dfe9899ff46f5ab3f325a006d5
+  metadata.gz: 16480155d0d2f9036d3f8c199f5a46d2b85f7a25
+  data.tar.gz: 573389d2175aa32650c97f06933688dee8526bf3
 SHA512:
-  metadata.gz: f7da0a6da94606f9d25e3164c84999c602d7ece4c9ea62930abe5b3b7816f0f551ef797303a04a3b6af7ed48e8509b66925121c9a3e38cc6c27746c59035ae77
-  data.tar.gz: e05f77e6a948cf0008ccddb0de25f0f9ed0c07d5fc1a9f5b77796c9e0fee6f4ab7d0341f9a31d6ca283bcdd36ff18a3fe217b05fe5ee7d9fcb3e0a81b4b2c9b6
+  metadata.gz: 06f61f2484247a0f729d96bdefda8836fbe5220b8e2986c5ddf6bbc56e8f9add646161d70d7b5664307f6fdc32e2cfbf5690371c15ae67f29655dd11c41bd2a1
+  data.tar.gz: 8c3b83a4b8fc005e24cccac9346a1b95318ec90adc881b2d6d24a9ac311775b7463f6442cbb142f10fcf9f2ebee0a616030d94e072997425811bbd4d1427809a

data/README.md

@@ -40,7 +40,7 @@ end
 
 ```
 > c = Duracloud::Client.new
- => #<Duracloud::Client:0x007fe953a1c630 @config=#<Duracloud::Configuration host="foo.duracloud.org", port=nil, user="bob@example.com", password="******">>
+ => #<Duracloud::Client:0x007fe953a1c630 @config=#<Duracloud::Configuration host="foo.duracloud.org", port=nil, user="bob@example.com">>
  ```
 
 #### Logging
@@ -53,29 +53,80 @@ Duracloud::Client.configure do |config|
 end
 ```
 
+You can also silence logging:
+
+```ruby
+Duracloud::Client.configure do |config|
+  config.silence_logging! # sets logger device to null device
+end
+```
+
 ### List Storage Providers
 
 ```
-> stores = Duracloud::Store.all
+>> stores = Duracloud::Store.all
  => [#<Duracloud::Store:0x007faa592e9068 @owner_id="0", @primary="0", @id="1", @provider_type="AMAZON_GLACIER">, #<Duracloud::Store:0x007faa592dbd78 @owner_id="0", @primary="1", @id="2", @provider_type="AMAZON_S3">]
 
-> stores.first.primary?
- => false 
+>> stores.first.primary?
+ => false
+
+>> Duracloud::Store.primary
+ => #<Duracloud::Store:0x007faa592dbd78 @owner_id="0", @primary="1", @id="2", @provider_type="AMAZON_S3">
 ```
 
-### Space Methods
+### Spaces
 
-TODO
+#### Create a new space
 
-### Content Methods
+```
+>> space = Duracloud::Space.create("rest-api-testing2")
+D, [2016-04-29T12:12:32.641574 #28275] DEBUG -- : Duracloud::Client PUT https://foo.duracloud.org/durastore/rest-api-testing2 201 Created
+ => #<Duracloud::Space space_id="rest-api-testing2", store_id="(default)"> 
+```
 
-#### Create a new content item and store it in DuraCloud
+A `Duracloud::BadRequestError` is raise if the space ID is invalid (illegal characters, too long, etc.).
 
-1. Initialize instance of `Duracloud::Content` and save:
+#### Retrieve a space and view its properties
 
 ```
->> new_content = Duracloud::Content.new(space_id: "rest-api-testing", id: "ark:/99999/fk4zzzz")
- => #<Duracloud::Content space_id="rest-api-testing", id="ark:/99999/fk4zzzz">
+>> space = Duracloud::Space.find("rest-api-testing")
+D, [2016-04-29T12:15:12.593075 #28275] DEBUG -- : Duracloud::Client HEAD https://foo.duracloud.org/durastore/rest-api-testing 200 OK
+ => #<Duracloud::Space space_id="rest-api-testing", store_id="(default)">
+ 
+>> space.count
+ => 8
+
+>> space.created
+ => #<DateTime: 2016-04-05T17:59:11+00:00 ((2457484j,64751s,0n),+0s,2299161j)> 
+```
+
+A `Duracloud::NotFoundError` exception is raise if the space does not exist.
+
+#### Enumerate the content IDs of the space
+
+```
+> space.content_ids.each { |id| puts id }
+ark:/99999/fk4zzzz
+foo
+foo2
+foo22
+foo3
+foo5
+foo7
+foo8
+ => nil
+
+> space.content_ids.to_a
+ => ["ark:/99999/fk4zzzz", "foo", "foo2", "foo22", "foo3", "foo5", "foo7", "foo8"] 
+```
+
+### Content
+
+#### Create a new content item and store it in DuraCloud
+
+```
+>> new_content = Duracloud::Content.new("rest-api-testing", "ark:/99999/fk4zzzz")
+ => #<Duracloud::Content space_id="rest-api-testing", content_id="ark:/99999/fk4zzzz", store_id=(default)>
  
 >> new_content.body = "test"
  => "test"
@@ -84,32 +135,62 @@ TODO
  => "text/plain"
  
 >> new_content.save
- => #<Duracloud::Content space_id="rest-api-testing", id="ark:/99999/fk4zzzz">
+ => #<Duracloud::Content space_id="rest-api-testing", content_id="ark:/99999/fk4zzzz", store_id=(default)>
 ```
 
-2. Create with class method `Duracloud::Content.create`:
+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.
+
+#### Retrieve an existing content item from DuraCloud
 
 ```
->> Duracloud::Content.create(space_id: "rest-api-testing", id="ark:/99999/fk4zzzz") do |c|
-     c.body = "test"
-     c.content_type = "text/plain"
-   end
- => #<Duracloud::Content space_id="rest-api-testing", id="ark:/99999/fk4zzzz">
+>> Duracloud::Content.find("spaceID", "contentID")
+ => #<Duracloud::Content space_id="spaceID", content_id="contentID", store_id=(default)>
 ```
 
-#### Retrieve an existing content item from DuraCloud
+If the space or content ID does not exist, a `Duracloud::NotFoundError` is raised.
+
+#### Update the properties for a content item
 
-```ruby
-Duracloud::Content.find(id: "contentID", space_id: "spaceID") 
 ```
+>> space = Duracloud::Space.find("rest-api-testing")
+ => #<Duracloud::Space space_id="rest-api-testing", store_id="(default)">
+
+>> content = space.find_content("foo3")
+D, [2016-04-29T18:31:16.975749 #32379] DEBUG -- : Duracloud::Client HEAD https://foo.duracloud.org/durastore/rest-api-testing/foo3 200 OK
+ => #<Duracloud::Content space_id="rest-api-testing", content_id="foo3", store_id=(default)>
 
-#### Update the properties for an item
+>> content.properties
+ => #<Duracloud::ContentProperties x-dura-meta-owner="ellen@example.com">
 
-TODO
+>> content.properties.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
+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"
+```     
 
 #### Delete a content item
 
-TODO
+```
+>> space = Duracloud::Space.find("rest-api-testing")
+ => #<Duracloud::Space space_id="rest-api-testing", store_id="(default)">
+
+>> content = space.find_content("foo2")
+ => #<Duracloud::Content space_id="rest-api-testing", content_id="foo2", store_id=(default)>
+
+>> content.delete
+D, [2016-04-29T18:28:31.459962 #32379] DEBUG -- : Duracloud::Client DELETE https://foo.duracloud.org/durastore/rest-api-testing/foo2 200 OK
+I, [2016-04-29T18:28:31.460069 #32379]  INFO -- : Content foo2 deleted successfully
+ => #<Duracloud::Content space_id="rest-api-testing", content_id="foo2", store_id=(default)>
+
+>> Duracloud::Content.exist?("rest-api-testing", "foo2")
+D, [2016-04-29T18:29:03.935451 #32379] DEBUG -- : Duracloud::Client HEAD https://foo.duracloud.org/durastore/rest-api-testing/foo2 404 Not Found
+ => false
+```
 
 ## Versioning
 

data/duracloud.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activemodel", "~> 4.2"
   spec.add_dependency "nokogiri", "~> 1.6"
 
+  spec.add_development_dependency "webmock", "~> 2.0"
   spec.add_development_dependency "rspec", "~> 3.4"
   spec.add_development_dependency "rspec-its", "~> 1.2"
   spec.add_development_dependency "bundler", "~> 1.7"

data/lib/duracloud/audit_log.rb

@@ -0,0 +1,35 @@
+module Duracloud
+  class AuditLog
+
+    attr_reader :space_id, :store_id
+
+    def initialize(space_id, store_id = nil)
+      @space_id = space_id
+      @store_id = store_id
+      @response = nil
+    end
+
+    def csv(opts = {})
+      CSVReader.call(tsv, opts)
+    end
+
+    def tsv
+      response.body
+    end
+
+    def to_s
+      tsv
+    end
+
+    private
+
+    def response
+      @response ||= Client.get_manifest(space_id, **query)
+    end
+
+    def query
+      { storeID: store_id }
+    end
+
+  end
+end

data/lib/duracloud/bit_integrity_report.rb

@@ -1,5 +1,4 @@
 require "date"
-require "csv"
 
 module Duracloud
   class BitIntegrityReport
@@ -7,56 +6,71 @@ module Duracloud
     SUCCESS = "SUCCESS".freeze
     FAILURE = "FAILURE".freeze
 
-    CSV_OPTS = {
-      col_sep: '\t',
-      headers: :first_row,
-      write_headers: true,
-      return_headers: true,
-    }
+    COMPLETION_DATE_HEADER = "Bit-Integrity-Report-Completion-Date".freeze
+    RESULT_HEADER          = "Bit-Integrity-Report-Result".freeze
 
-    def self.success?(space_id)
-      new(space_id).success?
-    end
-
-    attr_reader :space_id
+    attr_reader :space_id, :store_id
 
-    def initialize(space_id)
+    def initialize(space_id, store_id = nil)
       @space_id = space_id
+      @store_id = store_id
+      @report, @properties = nil, nil
     end
 
-    def data
+    def tsv
       report.body
     end
 
     def completion_date
-      DateTime.parse(properties["Bit-Integrity-Report-Completion-Date"].first)
+      DateTime.parse(properties[COMPLETION_DATE_HEADER].first)
     end
 
     def result
-      properties["Bit-Integrity-Report-Result"].first
+      properties[RESULT_HEADER].first
     end
 
     def csv(opts = {})
-      CSV.new(data, CSV_OPTS.merge(opts))
+      CSVReader.new(tsv, opts)
     end
 
     def success?
       result == SUCCESS
     end
 
-    private
-
     def report
-      @report ||= Client.get_bit_integrity_report(space_id)
+      @report ||= fetch_report
+    end
+
+    def report_loaded?
+      !@report.nil?
     end
 
     def properties
-      @properties ||= if @report
-                        report.headers
-                      else
-                        response = Client.get_bit_integrity_report_properties(space_id)
-                        response.headers
-                      end
+      @properties ||= fetch_properties
+    end
+
+    private
+
+    def fetch_report
+      reset_properties
+      Client.get_bit_integrity_report(space_id, **query)
+    end
+
+    def reset_properties
+      @properties = nil
+    end
+
+    def fetch_properties
+      if report_loaded?
+        report.headers
+      else
+        response = Client.get_bit_integrity_report_properties(space_id, **query)
+        response.headers
+      end
+    end
+
+    def query
+      { storeID: store_id }
     end
 
   end

data/lib/duracloud/configuration.rb

@@ -6,6 +6,10 @@ module Duracloud
 
     class << self
       attr_accessor :host, :port, :user, :password, :logger
+
+      def silence_logging!
+        self.logger = Logger.new(File::NULL)
+      end
     end
 
     attr_reader :host, :port, :user, :password, :logger
@@ -15,7 +19,7 @@ module Duracloud
       @port     = port     || default(:port)
       @user     = user     || default(:user)
       @password = password || default(:password)
-      @logger   = logger   || Logger.new(STDERR)
+      @logger   = logger   || self.class.logger || Logger.new(STDERR)
       freeze
     end
 
@@ -24,8 +28,8 @@ module Duracloud
     end
 
     def inspect
-      "#<#{self.class} host=#{host.inspect}, port=#{port.inspect}, user=#{user.inspect}," \
-      " password=\"******\", logger=#{logger.inspect}>"
+      "#<#{self.class} host=#{host.inspect}, port=#{port.inspect}," \
+      " user=#{user.inspect}>"
     end
 
     private

data/lib/duracloud/content.rb

@@ -1,4 +1,3 @@
-require "uri"
 require "stringio"
 require "active_model"
 
@@ -13,67 +12,59 @@ module Duracloud
 
     after_save :changes_applied
 
-    # Find content in DuraCloud.
-    #
-    # @param id [String] the content ID
-    # @param space_id [String] the space ID.
-    # @return [Duraclound::Content] the content
-    # @raise [Duracloud::NotFoundError] the space or content ID does not exist.
-    def self.find(id:, space_id:)
-      new(id: id, space_id: space_id) do |content|
-        content.load_properties
-      end
+    # Does the content exist in DuraCloud?
+    # @see .new for arguments
+    # @return [Boolean] whether the content exists
+    def self.exist?(*args)
+      find(*args) && true
+    rescue NotFoundError
+      false
     end
 
-    # Store content in DuraCloud
-    #
-    # @param id [String] The content ID
-    # @param space_id [String] The space ID.
-    # @param body [String, #read] The content body
-    # @return [Duracloud::Content] the content
-    # @raise [Duracloud::NotFoundError] if the space ID does not exist
-    # @raise [Duracloud::Error] if the body is empty.
-    def self.create(id:, space_id:, body:)
-      new(id: id, space_id: space_id) do |content|
-        content.body = body
-        yield content if block_given?
-        content.save
-      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 }
     end
 
-    attr_reader :id, :space_id
+    attr_reader :space_id, :content_id, :store_id
+    alias_method :id, :content_id
 
-    define_attribute_methods :content_type, :body, :md5
+    define_attribute_methods :content_type, :body
 
-    # Initialize a new piece of content
-    #
-    # @param id [String] The content ID
-    # @param space_id [String] The space ID
-    #
+    # @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(id: mycontent.txt", space_id: "myspace")
-    def initialize(id:, space_id:)
-      @id = id.freeze
-      @space_id = space_id.freeze
-      @body = nil
-      @content_type = nil
-      @md5 = nil
+    #   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
 
+    # Return the space associated with this content.
+    # @return [Duracloud::Space] the space.
+    # @raise [Duracloud::NotFoundError] the space or store does not exist.
     def space
-      Space.find(space_id)
+      Space.find(space_id, store_id)
     end
 
     def inspect
-      "#<#{self.class} id=#{id.inspect}, space_id=#{space_id.inspect}>"
+      "#<#{self.class} space_id=#{space_id.inspect}," \
+      " content_id=#{content_id.inspect}," \
+      " store_id=#{store_id || '(default)'}>"
     end
 
     # @api private
     # @raise [Duracloud::NotFoundError] the content does not exist in DuraCloud.
     def load_body
-      response = Client.get_content(url)
-      @body = response.body # don't use setter
+      response = Client.get_content(*args, **query)
+      set_body(response) # don't use setter b/c marks as dirty
       persisted!
     end
 
@@ -85,18 +76,19 @@ module Duracloud
     end
 
     def body=(str_or_io)
-      val = read_string_or_io(str_or_io)
-      raise ArgumentError, "Cannot set body to empty string." if val.empty?
-      self.md5 = Digest::MD5.hexdigest(val)
-      body_will_change! if md5_changed?
-      @body = StringIO.new(val, "r")
+      set_body(str_or_io)
+      body_will_change!
     end
 
+    # Return the content body, loading from DuraCloud if necessary.
+    # @return [String, StringIO] the content body
     def body
       load_body if persisted? && empty?
       @body
     end
 
+    # Is the content empty?
+    # @return [Boolean] whether the content is empty (nil or empty string)
     def empty?
       @body.nil? || @body.size == 0
     end
@@ -110,34 +102,34 @@ module Duracloud
       @content_type
     end
 
-    def md5
-      @md5
-    end
-
     private
 
-    def md5=(val)
-      md5_will_change! unless val == @md5
-      @md5 = val
+    def set_body(str_or_io)
+      @body = StringIO.new(read_string_or_io(str_or_io), "r")
     end
 
     def set_properties
       headers = properties.to_h
       headers["Content-Type"] = content_type if content_type_changed?
-      response = Client.set_content_properties(url, headers: headers)
-      # response.body is a text message -- log?
+      options = { headers: headers, query: query }
+      Client.set_content_properties(*args, **options)
     end
 
     def store
-      headers = { "Content-MD5" => md5,
-                  "Content-Type" => content_type || "application/octet-stream" }
+      headers = {
+        "Content-MD5"  => md5,
+        "Content-Type" => content_type || "application/octet-stream"
+      }
       headers.merge!(properties)
-      response = Client.store_content(url, body: body, headers: headers)
-      # response.body is a text message -- log?
+      options = { body: body, headers: headers, query: query }
+      Client.store_content(*args, **options)
     end
 
-    def url
-      [space_id, id].join("/")
+    def md5
+      body.rewind
+      Digest::MD5.hexdigest(body.read)
+    ensure
+      body.rewind
     end
 
     def properties_class
@@ -145,11 +137,11 @@ module Duracloud
     end
 
     def get_properties_response
-      Client.get_content_properties(url)
+      Client.get_content_properties(*args, **query)
     end
 
     def do_delete
-      Client.delete_content(url)
+      Client.delete_content(*args, **query)
     end
 
     def do_save
@@ -181,5 +173,13 @@ module Duracloud
       end
     end
 
+    def args
+      [ space_id, content_id ]
+    end
+
+    def query
+      { storeID: store_id }
+    end
+
   end
 end

data/lib/duracloud/csv_reader.rb

@@ -0,0 +1,18 @@
+require "csv"
+
+module Duracloud
+  class CSVReader
+
+    CSV_OPTS = {
+      col_sep: '\t',
+      headers: :first_row,
+      write_headers: true,
+      return_headers: true,
+    }
+
+    def self.call(data, opts = {})
+      CSV.new(data, CSV_OPTS.merge(opts))
+    end
+
+  end
+end

data/lib/duracloud/durastore_request.rb

@@ -1,6 +1,6 @@
 module Duracloud
   class DurastoreRequest < Request
-   def base_path
+    def base_path
       '/durastore/'
     end
   end

data/lib/duracloud/error.rb

@@ -2,6 +2,6 @@ module Duracloud
   class Error < ::StandardError; end
   class ServerError < Error; end
   class NotFoundError < Error; end
-  class ChecksumError < Error; end
-  class InvalidContentIDError < Error; end
+  class BadRequestError < Error; end
+  class ConflictError < Error; end
 end

data/lib/duracloud/error_handler.rb

@@ -37,10 +37,18 @@ module Duracloud
       Error
     end
 
+    def handle_400
+      BadRequestError
+    end
+
     def handle_404
       NotFoundError
     end
 
+    def handle_409
+      ConflictError
+    end
+
     def response_has_error_message?
       response.plain_text? && response.has_body?
     end

data/lib/duracloud/has_properties.rb

@@ -10,11 +10,18 @@ module Duracloud
       end
     end
 
+    # Return the properties associated with this resource,
+    #   loading from Duracloud if necessary.
+    # @return [Duracloud::Properties] the properties
+    # @raise [Duracloud::NotFoundError] if the resource is marked persisted
+    #   but does not exist in Duracloud
     def properties
       load_properties if persisted? && @properties.nil?
       @properties ||= properties_class.new
     end
 
+    # @api private
+    # @raise [Duracloud::NotFoundError] the resource does not exist in DuraCloud.
     def load_properties
       response = get_properties_response
       self.properties = response.headers