cleversafe 1.0.7 → 1.1.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 18677c6a6c521554741f3af8d8d1cb1b758e14c8
+  data.tar.gz: 13fc121e700597895df533e32cbc72235332ff6e
+SHA512:
+  metadata.gz: d50d22d53a7d2d1876d0a9827d34c5f7a6b2bf5d5106b35c52c7961cd5cd6c1ca383160946af8f602971e536156800cdefa7c7b6c4a586c563730ee53160329a
+  data.tar.gz: c94b1bdce16240613f90d1d2668fccd99f311650192c1aaf0ff75d9861a88eb8fce820a9e496e39d702e6c701936b26174445267de75ae71b835c6aa946931ad

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    cleversafe (1.1.10)
+      json
+      rest-client (~> 1.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.7)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    json (1.8.2)
+    mime-types (2.4.3)
+    minitest (5.5.1)
+    netrc (0.10.2)
+    rake (10.4.2)
+    rest-client (1.7.3)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    safe_yaml (1.0.4)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cleversafe!
+  minitest (~> 5)
+  rake
+  webmock (~> 1.7)

data/README.md

@@ -0,0 +1,30 @@
+# 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
+
+## Usage
+
+```ruby
+# Connect to Cleversafe
+connection = Cleversafe::Connection.new('http://127.0.0.1:1234')
+
+# Open a vault
+vault = connection.vault('pictures')
+
+# Upload, download, delete
+key = vault.create_object(open('~/cat.jpg'))
+
+vault[key].exists?
+vault[key].size
+vault[key].open { |io| ... }
+vault[key].delete
+
+```

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rake'
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << 'test/lib'
+  t.pattern = 'test/*_test.rb'
+end

data/cleversafe.gemspec

@@ -0,0 +1,16 @@
+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.1.10"
+
+  s.add_dependency 'json'
+  s.add_dependency 'rest-client', '~> 1.6'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'minitest', '~> 5'
+  s.add_development_dependency 'webmock', '~> 1.7'
+
+  s.files = Dir["#{File.dirname(__FILE__)}/**/*"]
+end

data/lib/cleversafe/connection.rb

@@ -1,83 +1,33 @@
+require 'json'
+require 'forwardable'
+
 module Cleversafe
   class Connection
-    attr_reader   :username
-    attr_accessor :password
-    attr_accessor :host
-    attr_accessor :protocol
-    attr_accessor :vault
-    attr_accessor :method
+    extend Forwardable
 
-    def initialize(*args)
-      if args[0].is_a?(Hash)
-        options = args[0]
-        @username = options[:username]
-        @password = options[:password]
-        @host = options[:host]
-        @protocol = options[:protocol] || "http"
-        @open_timeout = options[:open_timeout] || 10
-      else
-        @username = args[0]
-        @password = args[1]
-        @host = args[2]
-        @protocol = args[3] || "http"
-        @open_timeout = args[4] || 10
-      end
+    def_delegators :@http, :url, :url_for, :get, :head, :put, :delete
 
-      @connection ||= begin
-        build_connection
-      end
-      return @connection
+    def initialize(url, options = {})
+      @http = Cleversafe::HttpClient.new(url, options)
     end
 
-    def build_connection
-      RestClient::Resource.new(base_url, :user => @username, :password => @password,
-        :raw_response => true, :open_timeout => @open_timeout)
+    def ping
+      head '/'
+      true
+    rescue Exception
+      false
     end
 
-    def base_url
-      "#{@protocol}://#{@host}/"
+    def status
+      JSON.parse(get('/').to_s)
     end
 
-    def url_for(vault, objectname, options={})
-      protocol = options.fetch(:protocol, @protocol)
-      host     = options.fetch(:host, @host)
-
-      "#{protocol}://#{host}/#{vault}/#{objectname}"
+    def vaults
+      status['vaults'].map { |v| v['vault_name'] }
     end
 
     def vault(name)
       Cleversafe::Vault.new(self, name)
     end
-
-    def vaults
-      vaults = JSON.parse(get(nil))['vaults']
-      vaults.collect{|v| v['vault_name']}
-    end
-
-    def vault_exists?(vault_name)
-      begin
-        response = get(vault_name)
-        true
-      rescue => e
-        false
-      end
-    end
-
-    def get(path, options = {})
-      @connection[path].get options
-    end
-
-    def head(path, options = {})
-      @connection[path].head options
-    end
-
-    def put(path, payload, options = {})
-      @connection[path].put payload, options
-    end
-
-    def delete(path)
-      @connection[path].delete
-    end
-
   end
 end

data/lib/cleversafe/errors.rb

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

data/lib/cleversafe/http_client.rb

@@ -0,0 +1,42 @@
+module Cleversafe
+  class HttpClient
+    DEFAULTS = { :timeout => nil, :open_timeout => nil }
+
+    attr_reader :url
+
+    def initialize(url, options = {})
+      @url = url
+      @defaults = DEFAULTS.merge(options)
+    end
+
+    def url_for(*path)
+      File.join(url, *path)
+    end
+
+    def head(path, options = {})
+      request :head, path, options
+    end
+
+    def get(path, options = {})
+      request :get, path, options
+    end
+
+    def post(path, payload, options = {})
+      request :post, path, options.merge(:payload => payload)
+    end
+
+    def put(path, payload, options = {})
+      request :put, path, options.merge(:payload => payload)
+    end
+
+    def delete(path, options = {})
+      request :delete, path, options
+    end
+
+    private
+      def request(method, path, options = {})
+        options = @defaults.merge(options).merge(:method => method, :url => url_for(path))
+        RestClient::Request.execute(options)
+      end
+  end
+end

data/lib/cleversafe/object.rb

@@ -1,61 +1,61 @@
 require 'fileutils'
+require 'cgi'
 
 module Cleversafe
   class Object
 
-    attr_reader :name
-    attr_reader :vault
+    attr_reader :vault, :key, :connection
 
-    def initialize(vault, objectname = {})
-      @vault = vault.name
-      @name = objectname
+    def initialize(vault, key)
+      raise ArgumentError, "key is required" unless key =~ /\S/
+      @vault = vault
+      @key = key
       @connection = vault.connection
     end
 
-    def url(options={})
-      @connection.url_for(@vault, @name, options)
+    def path
+      "#{vault.path}/#{CGI.escape(key)}"
+    end
+
+    def url
+      connection.url_for(path)
     end
 
     def delete
       handle_errors do
-        @connection.delete("#{@vault}/#{@name}")
+        connection.delete(path)
       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
-      end
+    def data(options = {})
+      open(options) { |io| io.read }
     end
 
-    def open(options={})
+    def open(options = {})
       handle_errors do
-        response = @connection.get("#{@vault}/#{@name}", options)
+        response = connection.get(path, options.merge(:raw_response => true))
         begin
-          yield response.file.open
+          file = response.file
+          file.open
+          file.binmode
+          yield file
         ensure
-          response.file.unlink
+          file.unlink
         end
       end
     end
 
-    def write_to(filename, options={})
-      handle_errors do
-        response = @connection.get("#{@vault}/#{@name}", 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(path).headers
+      end
     end
 
     def etag
@@ -67,15 +67,10 @@ module Cleversafe
     end
 
     private
-
-    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
+      def handle_errors
+        yield
+      rescue RestClient::ResourceNotFound
+        raise Cleversafe::Errors::NotFound, "object `#{key}' does not exist", caller[0..-2]
       end
-    end
   end
 end

data/lib/cleversafe/vault.rb

@@ -1,45 +1,56 @@
+require 'cgi'
+
 module Cleversafe
   class Vault
-
-    attr_reader :name
-    attr_reader :connection
+    attr_reader :connection, :name, :path
 
     def initialize(connection, name)
       @connection = connection
       @name = name
+      @path = CGI.escape name
     end
 
     def metadata
-      @metadata ||= JSON.parse(@connection.get(@name))
+      @metadata ||= JSON.parse(connection.get(path).to_s)
     end
 
-    def bytes_used
-      metadata['vault_usage']['used_size']
+    def usage
+      metadata['vault_usage']
     end
 
-    def object(objectname)
-      Cleversafe::Object.new(self, objectname)
+    def object(key)
+      Cleversafe::Object.new(self, key)
     end
     alias [] object
 
-    def objects(params = {})
-      options = {}
-      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")
+    def objects(options = {})
+      headers = {}
+
+      headers['X-Operation'] = 'list'
+      headers['X-Start-Id']  = options[:start_id] if options[:start_id]
+      headers['X-List-Length-Limit'] = options[:limit] if options[:limit]
+
+      connection.get(path, :headers => headers).to_s.split("\n")
     end
 
     def create_object(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] }
-      else
-        id
+      handle_errors do
+        response = connection.put(path, payload, options)
+        id = response.to_s.strip
+
+        if response.headers[:x_content_digest]
+          { :id => id, :x_content_digest => response.headers[:x_content_digest] }
+        else
+          id
+        end
       end
     end
 
+    private
+    def handle_errors
+      yield
+    rescue RestClient::MethodNotAllowed
+      raise Cleversafe::Errors::VaultMisconfigured, "Vault has not been added to accessers.", caller[0..-2]
+    end
   end
 end

data/lib/cleversafe.rb

@@ -1,10 +1,14 @@
-#!/usr/bin/env ruby
-  require 'rubygems'
-  require 'rest-client'
-  require 'json'
+require 'cleversafe/connection'
+require 'cleversafe/http_client'
+require 'cleversafe/vault'
+require 'cleversafe/object'
+require 'cleversafe/errors'
 
-  $:.unshift(File.dirname(__FILE__))
-  require 'cleversafe/errors'
-  require 'cleversafe/vault'
-  require 'cleversafe/object'
-  require 'cleversafe/connection'
+require 'rest-client'
+
+# Monkeypatch RestClient to prevent it from closing IO objects after they're
+# uploaded, which it really shouldn't do.
+class RestClient::Payload::Streamed
+  def close
+  end
+end

data/test/connection_test.rb

@@ -0,0 +1,7 @@
+require 'cleversafe/test_helper'
+
+class ConnectionTest < Minitest::Test
+  def test_truth
+    assert true
+  end
+end

data/test/http_client_test.rb

@@ -0,0 +1,14 @@
+require 'cleversafe/test_helper'
+
+class HttpClientTest < Minitest::Test
+  def test_url_for
+    client = Cleversafe::HttpClient.new('http://example.com')
+
+    assert_equal 'http://example.com/',    client.url_for('')
+    assert_equal 'http://example.com/',    client.url_for('/')
+    assert_equal 'http://example.com/a/b', client.url_for('/a/b')
+    assert_equal 'http://example.com/a/b', client.url_for('a/b')
+    assert_equal 'http://example.com/a/b', client.url_for('a', 'b')
+    assert_equal 'http://example.com/a%2Fb', client.url_for('a%2Fb')
+  end
+end

data/test/lib/cleversafe/test_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'cleversafe'
+
+require 'minitest/autorun'
+require 'webmock/minitest'

data/test/object_test.rb

@@ -0,0 +1,19 @@
+require 'cleversafe/test_helper'
+
+class ObjectTest < Minitest::Test
+  def setup
+    connection = Cleversafe::Connection.new('http://test.host')
+    @vault = Cleversafe::Vault.new(connection, 'test_vault')
+  end
+
+  def test_name_is_required
+    assert_raises ArgumentError do
+      Cleversafe::Object.new(@vault, '')
+    end
+  end
+
+  def test_path_is_escaped
+    object = Cleversafe::Object.new(@vault, 'foo/bar[1].png')
+    assert_equal 'test_vault/foo%2Fbar%5B1%5D.png', object.path
+  end
+end

data/test/vault_test.rb

@@ -0,0 +1,18 @@
+require 'cleversafe/test_helper'
+
+class VaultTest < Minitest::Test
+  def setup
+    @connection = Cleversafe::Connection.new('http://test.host')
+  end
+
+  def test_path_is_escaped
+    assert_equal 'test%2Fvault', Cleversafe::Vault.new(@connection, 'test/vault').path
+  end
+  
+  def test_vault_is_configured_correctly
+    stub_request(:put, "http://test.host/assets").with(:body => "foo").to_return(:status => 405, :body => "", :headers => {})
+    vault = Cleversafe::Vault.new(@connection, 'assets')
+    error = assert_raises(Cleversafe::Errors::VaultMisconfigured) { vault.create_object('foo') }
+    assert_equal 'Vault has not been added to accessers.', error.message
+  end
+end

metadata

@@ -1,77 +1,131 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: cleversafe
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 7
-  version: 1.0.7
+version: !ruby/object:Gem::Version
+  version: 1.1.10
 platform: ruby
-authors: 
+authors:
 - John Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-04-16 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rest-client
+date: 2022-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 description: 
 email: john@37signals.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- lib/cleversafe/connection.rb
-- lib/cleversafe/errors.rb
-- lib/cleversafe/object.rb
-- lib/cleversafe/vault.rb
-- lib/cleversafe.rb
-has_rdoc: true
+files:
+- "./Gemfile"
+- "./Gemfile.lock"
+- "./README.md"
+- "./Rakefile"
+- "./cleversafe-1.1.10.gem"
+- "./cleversafe-1.1.11.gem"
+- "./cleversafe-1.1.12.gem"
+- "./cleversafe.gemspec"
+- "./lib/cleversafe.rb"
+- "./lib/cleversafe/connection.rb"
+- "./lib/cleversafe/errors.rb"
+- "./lib/cleversafe/http_client.rb"
+- "./lib/cleversafe/object.rb"
+- "./lib/cleversafe/vault.rb"
+- "./test/connection_test.rb"
+- "./test/http_client_test.rb"
+- "./test/lib/cleversafe/test_helper.rb"
+- "./test/object_test.rb"
+- "./test/vault_test.rb"
 homepage: 
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 2.5.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Ruby API into Cleversafe's REST interface.
 test_files: []
-