swift-storage 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3246e84c36a57fc2892b66434fda76d6a0985c5
+  data.tar.gz: 76f1ad2fa5f6b47e0d704ca2ec2095d3ac1ee7fc
+SHA512:
+  metadata.gz: 9d0bee3254a69d404e1ef30e9ee454cc81d894dcb59a69dd7c2e5d4e8269ce5a38b402a5cfaf54527bbbada5f80190ddd16094eaf2703094fb28ff069c5f6a79
+  data.tar.gz: 5035e8d1b0ac40516926bf47aab4e6d3a8597c23bc3acff638cce78018b1da0b18000281b9cb67b4f19878c6fe2ce8fc18bd74d37cc42343061f3eab28d17705

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.envrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in swift-ruby.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^spec/[^/]+\.rb$}) { "spec" }
+  watch(%r{^lib/.+rb$}) { "spec" }
+end
+
+
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nicolas Goy
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# Swift::Ruby
+
+Ruby client for Openstack swift
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swift-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install swift-ruby
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/swift-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/swift-storage.rb

@@ -0,0 +1,15 @@
+require "net/http"
+require "swift_storage/version"
+require "swift_storage/errors"
+require "swift_storage/utils"
+require "swift_storage/headers"
+require "swift_storage/node"
+require "swift_storage/account"
+require "swift_storage/container"
+require "swift_storage/container_collection"
+require "swift_storage/object"
+require "swift_storage/object_collection"
+require "swift_storage/service"
+
+module SwiftStorage
+end

data/lib/swift_storage/account.rb

@@ -0,0 +1,35 @@
+class SwiftStorage::Account < SwiftStorage::Node
+
+  parent_node          :service
+
+
+  # Write account meta data
+  #
+  # @param temp_url_key [String]
+  #  The shared secret used to sign temporary URLs.
+  #  Changing this key will invalidate all temporary URLs signed with the older
+  #  key.
+  #
+  def write(temp_url_key: nil)
+    h = {}
+    h[H::ACCOUNT_TEMP_URL_KEY] = temp_url_key if temp_url_key
+
+    request(relative_path, :method => :post, :headers => h)
+  end
+
+  # Returns the temporary URL key
+  #
+  # @return [String]
+  #  Key used to sign temporary URLs
+  #
+  def temp_url_key
+    metadata.temp_url_key rescue nil
+  end
+
+  def relative_path
+    ''
+  end
+
+
+end
+

data/lib/swift_storage/container.rb

@@ -0,0 +1,67 @@
+class SwiftStorage::Container < SwiftStorage::Node
+
+  parent_node          :service
+
+
+  def relative_path
+    name
+  end
+
+  header_attributes          :bytes_used,
+                             :object_count
+
+
+  # Returns the object collection for this container
+  #
+  # @return [SwiftStorage::ObjectCollection]
+  #  The object collection.
+  #
+  def objects
+    @objects ||= SwiftStorage::ObjectCollection.new(self)
+  end
+
+  # Create the container
+  #
+  def create
+    request(relative_path, :method => :put)
+  end
+
+  # Write the container meta data
+  #
+  # @note This overrides all ACL set on the container.
+  #
+  # Each ACL is a string in the following format:
+  #
+  # - `team:jon` give access to user "jon" of account "team"
+  #
+  # @param read_acl [Array<String>]
+  #  An array of ACL.
+  #
+  # @param write_acl [Array<String>]
+  #  An array of ACL.
+  #
+  def write(write_acl: nil, read_acl: nil)
+    h = {}
+    read_acl = read_acl.join(',') if read_acl.respond_to?(:to_ary)
+    write_acl = write_acl.join(',') if write_acl.respond_to?(:to_ary)
+
+    h[H::CONTAINER_READ] = read_acl
+    h[H::CONTAINER_WRITE] = write_acl
+
+    request(relative_path, :method => :post, :headers => h)
+  end
+
+  # Read the container meta data
+  #
+  # @return [Struct]
+  #  A struct with `read` and `write` ACL, each entry contains an Array of
+  #  String.
+  def acl
+    r = headers.read.split(',') rescue nil
+    w = headers.write.split(',') rescue nil
+    struct(:read => r, :write => w)
+  end
+
+
+end
+

data/lib/swift_storage/container_collection.rb

@@ -0,0 +1,34 @@
+class SwiftStorage::ContainerCollection < SwiftStorage::Node
+
+  parent_node          :service
+
+
+  # Return all containers
+  #
+  # @note This method will return only the first 1000 containers.
+  #
+  # @return [Array<SwiftStorage::Container>]
+  #  Containers in this collection.
+  #
+  def all
+    get_lines('').map { |name| SwiftStorage::Container.new(service, name)}
+  end
+
+  # Return a particular container
+  #
+  # @note This always return a container, regadeless of it's existence
+  #  on the server. This call do NOT contact the server.
+  #
+  # @param name [String]
+  #  The name (sometimes named key) of the container
+  #
+  # @return [SwiftStorage::Object]
+  #  Container with given name
+  #
+  def [](name)
+    SwiftStorage::Container.new(service, name)
+  end
+
+end
+
+

data/lib/swift_storage/errors.rb

@@ -0,0 +1,15 @@
+module SwiftStorage::Errors
+
+  class AuthError < StandardError
+  end
+
+  class NotFoundError < StandardError
+  end
+
+  class ServerError < StandardError
+  end
+
+  class ForbiddenError < StandardError
+  end
+
+end

data/lib/swift_storage/headers.rb

@@ -0,0 +1,23 @@
+module SwiftStorage
+
+  module Headers
+    STORAGE_URL = 'X-Storage-Url'.freeze
+    AUTH_TOKEN = 'X-Auth-Token'.freeze
+    AUTH_USER = 'X-Auth-User'.freeze
+    AUTH_KEY = 'X-Auth-Key'.freeze
+    STORAGE_TOKEN = 'X-Storage-Token'.freeze
+    CONNECTION = 'Connection'.freeze
+    PROXY_CONNECTION = 'Proxy-Connection'.freeze
+    CONTENT_TYPE = 'Content-Type'.freeze
+    CONTENT_DISPOSITION = 'Content-Disposition'.freeze
+    DELETE_AT = 'X-Delete-At'.freeze
+    DELETE_AFTER = 'X-Delete-After'.freeze
+    CACHE_CONTROL = 'Cache-Control'.freeze
+    EXPIRES = 'Expires'.freeze
+    OBJECT_MANIFEST = 'X-Object-Manifest'.freeze
+    CONTAINER_READ = 'X-Container-Read'.freeze
+    CONTAINER_WRITE = 'X-Container-Write'.freeze
+    ACCOUNT_TEMP_URL_KEY = 'X-Account-Meta-Temp-URL-Key'.freeze
+  end
+
+end

data/lib/swift_storage/node.rb

@@ -0,0 +1,133 @@
+class SwiftStorage::Node
+
+  include SwiftStorage::Utils
+
+  attr_accessor          :parent,
+                         :name
+
+  def initialize(parent, name=nil)
+    @parent = parent
+    @name = name
+  end
+
+  def request(*args)
+    service.request(*args)
+  end
+
+  # Returns the service for this node
+  #
+  # @return [SwiftStorage::Service]
+  #  The service this node is bound to
+  #
+  def service
+    unless defined?(@service)
+      p = parent
+      while p && !(SwiftStorage::Service === p)
+         p = p.parent
+      end
+      @service = p
+    end
+    @service
+  end
+
+  def get_lines(path)
+    headers = {'Accept' => 'text/plain'}
+    response = request(path, :headers => headers)
+    body = response.body
+    if body.nil? || body.empty?
+      []
+    else
+      body.lines.map(&:strip)
+    end
+  end
+
+  def to_s
+    "#<#{self.class.name} #{name}>"
+  end
+
+  def relative_path
+    raise NotImplemented
+  end
+
+  def headers
+    return @headers if @headers
+
+    response ||= request(relative_path, :method => :head)
+
+    h = {}
+    metadata = h[:metadata] = {}
+    response.to_hash.each_pair do |k,v|
+      if k =~ /^X-#{self.class.header_name}-Meta-?(.+)/i
+        k = $1
+        t = metadata
+      elsif k =~ /^X-#{self.class.header_name}-?(.+)/i
+        k = $1
+        t = h
+      else
+        t = h
+      end
+      k = k.downcase.gsub(/\W/, '_')
+      v = v.first if v.respond_to?(:to_ary)
+      t[k] = v
+    end
+    @headers = struct(h)
+  end
+
+  def metadata
+    @metadata ||= struct(headers.metadata)
+  end
+
+  def clear_cache
+    @headers = nil
+    @metadata = nil
+  end
+
+  def exists?
+    request(relative_path, :method => :head) && true
+  rescue SwiftStorage::Errors::NotFoundError
+    false
+  end
+
+  def delete
+    request(relative_path, :method => :delete)
+  end
+
+
+  private
+
+  def self.header_name
+    self.name.split(':').last
+  end
+
+
+  def self.header_attributes(*args)
+    args.each do |a|
+      define_method(a.to_sym) do
+        headers[a]
+      end
+    end
+  end
+
+  def self.parent_node(name)
+    define_method(name.to_sym) do
+      parent
+    end
+  end
+
+  def merge_metadata(headers, metadata)
+    return if metadata.nil?
+    metadata.each do |k,v|
+      sanitized_key = k.to_s.gsub(/\W/, '-')
+      sanitized_key = sanitized_key.split('-').reject{|o| o.nil? || o.empty?}
+      full_key = ['X', self.class.header_name, 'Meta'] + sanitized_key
+      full_key = full_key.map(&:capitalize).join('-')
+      headers[full_key] = v.to_s
+    end
+  end
+
+  private
+  H = SwiftStorage::Headers
+
+end
+
+