cleversafe 1.0.7 → 1.0.8

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,18 @@
+PATH
+  remote: .
+  specs:
+    cleversafe (1.0.7)
+      rest-client (~> 1.6.7)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    mime-types (1.22)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cleversafe!

data/README.md

@@ -0,0 +1,56 @@
+# Cleversafe SOH
+
+## Description
+This is a Ruby interface into the Cleversafe's SOH API.
+
+## Notes
+* Multipart uploads are not supported by Cleversafe's API. Coming soon.
+* If you upload a file with "X-Digest" you will get back a hash that includes :id and :x_content_digest. 
+
+## Todo
+* Support range requests for getting an object
+
+## Examples
+
+```ruby
+#Setup Conection
+request = Cleversafe::Connection.new("USERNAME", "PASSWORD", "HOSTNAME")
+
+#Does a vault exist?
+request.vault_exists?("VAULTNAME")
+
+# load vault
+vault = request.vault("VAULTNAME")
+
+# bytes used in vault
+vault.bytes_used
+
+# list objects in vault
+vault.objects(:limit => 10, :start_id => "1f1665dce23b515cedf29edaf1d033730000")
+
+# load object
+object = "1f1665dce23b515cedf29edaf1d033730000"
+
+# get etag of object
+vault.object(object).etag
+
+# download object
+File.open("downloaded.file", 'w') {|f| f.write(vault.object(object).data) }
+
+# upload object, don't use multipart, it is not supported
+uploaded_object = vault.create_object File.new("upload.file", "r"), :multipart => false, 'X-Digest' => "md5" 
+
+# uploaded object's digest
+uploaded_object[:id]
+
+# object's digest
+uploaded_object[:x_content_digest]
+
+# uploaded object exists?
+vault.object_exists?(uploaded_object[:id])
+
+# deleting the uploaded object
+vault.delete_object(uploaded_object[:id])
+
+```
+

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rake/testtask'
+
+Rake::TestTask.new
+task :default => :test

data/cleversafe.gemspec

@@ -0,0 +1,11 @@
+Gem::Specification.new do |s|
+  s.name    = "cleversafe"
+  s.summary = "A Ruby API into Cleversafe's REST interface."
+  s.author  = "John Williams"
+  s.email   = "john@37signals.com"
+  s.version = "1.0.8"
+
+  s.add_dependency 'rest-client', '~> 1.6.7'
+
+  s.files = Dir["#{File.dirname(__FILE__)}/**/*"]
+end

data/lib/cleversafe/connection.rb

@@ -1,11 +1,6 @@
 module Cleversafe
   class Connection
-    attr_reader   :username
-    attr_accessor :password
-    attr_accessor :host
-    attr_accessor :protocol
-    attr_accessor :vault
-    attr_accessor :method
+    attr_reader :username, :password, :host, :protocol, :open_timeout
 
     def initialize(*args)
       if args[0].is_a?(Hash)
@@ -22,25 +17,15 @@ module Cleversafe
         @protocol = args[3] || "http"
         @open_timeout = args[4] || 10
       end
-
-      @connection ||= begin
-        build_connection
-      end
-      return @connection
-    end
-
-    def build_connection
-      RestClient::Resource.new(base_url, :user => @username, :password => @password,
-        :raw_response => true, :open_timeout => @open_timeout)
     end
 
     def base_url
-      "#{@protocol}://#{@host}/"
+      "#{protocol}://#{host}/"
     end
 
     def url_for(vault, objectname, options={})
-      protocol = options.fetch(:protocol, @protocol)
-      host     = options.fetch(:host, @host)
+      protocol = options.fetch(:protocol, protocol)
+      host     = options.fetch(:host, host)
 
       "#{protocol}://#{host}/#{vault}/#{objectname}"
     end
@@ -55,29 +40,36 @@ module Cleversafe
     end
 
     def vault_exists?(vault_name)
-      begin
-        response = get(vault_name)
-        true
-      rescue => e
-        false
-      end
+      get(vault_name)
+      true
+    rescue RestClient::ResourceNotFound
+      false
     end
 
     def get(path, options = {})
-      @connection[path].get options
+      connection[path].get options
     end
 
     def head(path, options = {})
-      @connection[path].head options
+      connection[path].head options
     end
 
     def put(path, payload, options = {})
-      @connection[path].put payload, options
+      connection[path].put payload, options
     end
 
     def delete(path)
-      @connection[path].delete
+      connection[path].delete
     end
 
+    private
+      def connection
+        @connection ||= RestClient::Resource.new(base_url,
+          :user         => username,
+          :password     => password,
+          :open_timeout => open_timeout,
+          :raw_response => true
+        )
+      end
   end
 end

data/lib/cleversafe/errors.rb

@@ -1,5 +1,5 @@
 module Cleversafe
-  module Error
+  module Errors
     class Base < RuntimeError; end
     class NotFound < Base; end
   end

data/lib/cleversafe/object.rb

@@ -3,41 +3,44 @@ require 'fileutils'
 module Cleversafe
   class Object
 
-    attr_reader :name
-    attr_reader :vault
+    attr_reader :connection, :vault, :name
 
-    def initialize(vault, objectname = {})
-      @vault = vault.name
-      @name = objectname
+    def initialize(vault, name = {})
       @connection = vault.connection
+      @vault = vault.name
+      @name = name
+    end
+
+    def key
+      "#{vault}/#{name}"
     end
 
     def url(options={})
-      @connection.url_for(@vault, @name, options)
+      connection.url_for(vault, name, options)
     end
 
     def delete
       handle_errors do
-        @connection.delete("#{@vault}/#{@name}")
+        connection.delete(key)
       end
     end
 
     def exists?
       metadata
       true
-    rescue Error::NotFound
+    rescue Errors::NotFound
       false
     end
 
     def data(options={})
       handle_errors do
-        @connection.get("#{@vault}/#{@name}", options).to_s
+        connection.get(key, options).to_s
       end
     end
 
     def open(options={})
       handle_errors do
-        response = @connection.get("#{@vault}/#{@name}", options)
+        response = connection.get(key, options)
         begin
           yield response.file.open
         ensure
@@ -48,14 +51,16 @@ module Cleversafe
 
     def write_to(filename, options={})
       handle_errors do
-        response = @connection.get("#{@vault}/#{@name}", options)
+        response = connection.get(key, options)
         FileUtils.cp(response.file.path, filename)
         FileUtils.rm(response.file.path)
       end
     end
 
     def metadata
-      @metadata ||= handle_errors { @connection.head("#{@vault}/#{@name}").headers }
+      @metadata ||= handle_errors do
+        connection.head(key).headers
+      end
     end
 
     def etag
@@ -70,12 +75,8 @@ module Cleversafe
 
     def handle_errors
       yield
-    rescue RestClient::Exception => e
-      if (e.http_code.to_s == "404")
-        raise Error::NotFound, "object `#{@name}' does not exist", caller[0..-2]
-      else
-        raise
-      end
+    rescue RestClient::ResourceNotFound
+      raise Cleversafe::Errors::NotFound, "object `#{name}' does not exist", caller[0..-2]
     end
   end
 end

data/lib/cleversafe/vault.rb

@@ -1,8 +1,6 @@
 module Cleversafe
   class Vault
-
-    attr_reader :name
-    attr_reader :connection
+    attr_reader :connection, :name
 
     def initialize(connection, name)
       @connection = connection
@@ -10,7 +8,7 @@ module Cleversafe
     end
 
     def metadata
-      @metadata ||= JSON.parse(@connection.get(@name))
+      @metadata ||= JSON.parse(connection.get(name))
     end
 
     def bytes_used
@@ -27,15 +25,15 @@ module Cleversafe
       options['X-Operation'] = "list"
       options['X-List-Length-Limit'] = params[:limit] if params[:limit]
       options['X-Start-Id'] = params[:start_id] if params[:start_id]
-      @connection.get(@name, options).to_s.split("\n")
+      connection.get(name, options).to_s.split("\n")
     end
 
     def create_object(payload, options = {})
-      response = @connection.put("#{@name}", payload, options)
+      response = connection.put(name, payload, options)
       id = response.to_s.strip
 
       if response.headers[:x_content_digest]
-        {:id => id, :x_content_digest => response.headers[:x_content_digest] }
+        { :id => id, :x_content_digest => response.headers[:x_content_digest] }
       else
         id
       end

data/lib/cleversafe.rb

@@ -1,10 +1,7 @@
-#!/usr/bin/env ruby
-  require 'rubygems'
-  require 'rest-client'
-  require 'json'
+require 'rest-client'
+require 'json'
 
-  $:.unshift(File.dirname(__FILE__))
-  require 'cleversafe/errors'
-  require 'cleversafe/vault'
-  require 'cleversafe/object'
-  require 'cleversafe/connection'
+require 'cleversafe/errors'
+require 'cleversafe/vault'
+require 'cleversafe/object'
+require 'cleversafe/connection'

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 7
-  version: 1.0.7
+  - 8
+  version: 1.0.8
 platform: ruby
 authors: 
 - John Williams
@@ -22,11 +22,13 @@ dependencies:
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
-        - 0
-        version: "0"
+        - 1
+        - 6
+        - 7
+        version: 1.6.7
   type: :runtime
   version_requirements: *id001
 description: 
@@ -38,11 +40,17 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/cleversafe/connection.rb
-- lib/cleversafe/errors.rb
-- lib/cleversafe/object.rb
-- lib/cleversafe/vault.rb
-- lib/cleversafe.rb
+- ./cleversafe-1.0.7.gem
+- ./cleversafe.gemspec
+- ./Gemfile
+- ./Gemfile.lock
+- ./lib/cleversafe/connection.rb
+- ./lib/cleversafe/errors.rb
+- ./lib/cleversafe/object.rb
+- ./lib/cleversafe/vault.rb
+- ./lib/cleversafe.rb
+- ./Rakefile
+- ./README.md
 has_rdoc: true
 homepage: 
 licenses: []