swift_client 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Benjamin Vetter
+
+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,27 @@
+# SwiftClient
+
+Small but powerful client to interact with OpenStack Swift.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swift_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install swift_client
+
+## Contributing
+
+1. Fork it ( https://github.com/mrkamel/swift_client/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,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+

data/lib/swift_client/version.rb

@@ -0,0 +1,5 @@
+
+class SwiftClient
+  VERSION = "0.0.1"
+end
+

data/lib/swift_client.rb

@@ -0,0 +1,143 @@
+
+require "swift_client/version"
+
+require "httparty"
+require "mime-types"
+
+class SwiftClient
+  class AuthenticationError < StandardError; end
+  class OptionError < StandardError; end
+  class EmptyNameError < StandardError; end
+
+  class ResponseError < StandardError
+    attr_accessor :code, :message
+
+    def initialize(code, message)
+      self.code = code
+      self.message = message
+    end
+
+    def to_s
+      "#{code} #{message}"
+    end
+  end
+
+  attr_accessor :options, :auth_token, :storage_url
+
+  def initialize(options = {})
+    [:auth_url, :username, :api_key].each do |key|
+      raise(OptionError, "#{key} is missing") unless options.key?(key)
+    end
+
+    self.options = options
+
+    authenticate
+  end
+
+  def get_containers(query = {})
+    request :get, "/", :query => query
+  end
+
+  def get_container(name, query = {})
+    raise(EmptyNameError) if name.empty?
+
+    request :get, "/#{name}", :query => query
+  end
+
+  def head_container(name)
+    raise(EmptyNameError) if name.empty?
+
+    request :head, "/#{name}"
+  end
+
+  def put_container(name, headers = {})
+    raise(EmptyNameError) if name.empty?
+
+    request :put, "/#{name}", :headers => headers
+  end
+
+  def post_container(name, headers = {})
+    raise(EmptyNameError) if name.empty?
+
+    request :post, "/#{name}", :headers => headers
+  end
+
+  def delete_container(name)
+    raise(EmptyNameError) if name.empty?
+
+    request :delete, "/#{name}"
+  end
+
+  def put_object(name, data_or_io, container, headers = {})
+    raise(EmptyNameError) if name.empty? || container.empty?
+
+    mime_type = MIME::Types.of(name).first
+
+    extended_headers = headers.dup
+    extended_headers["Content-Type"] ||= mime_type.content_type if mime_type
+
+    request :put, "/#{container}/#{name}", :body => data_or_io.respond_to?(:read) ? data_or_io.read : data_or_io, :headers => extended_headers
+  end
+
+  def post_object(name, container, headers = {})
+    raise(EmptyNameError) if name.empty? || container.empty?
+
+    request :post, "/#{container}/#{name}", :headers => headers
+  end
+
+  def get_object(name, container)
+    raise(EmptyNameError) if name.empty? || container.empty?
+
+    request :get, "/#{container}/#{name}"
+  end
+
+  def head_object(name, container)
+    raise(EmptyNameError) if name.empty? || container.empty?
+
+    request :head, "/#{container}/#{name}"
+  end
+
+  def delete_object(name, container)
+    raise(EmptyNameError) if name.empty? || container.empty?
+
+    request :delete, "/#{container}/#{name}"
+  end
+
+  def get_objects(container, query = {})
+    raise(EmptyNameError) if container.empty?
+
+    request :get, "/#{container}", :query => query
+  end
+
+  private
+
+  def request(method, path, opts = {})
+    opts[:headers] ||= {}
+    opts[:headers]["X-Auth-Token"] = auth_token
+    opts[:headers]["Accept"] = "application/json"
+
+    response = HTTParty.send(method, "#{storage_url}#{path}", opts)
+
+    if response.code == 401
+      authenticate
+
+      return request(method, path, opts)
+    end
+
+    raise(ResponseError.new(response.code, response.message)) unless response.success?
+
+    response
+  end
+
+  def authenticate
+    response = HTTParty.get(options[:auth_url], :headers => { "X-Auth-User" => options[:username], "X-Auth-Key" => options[:api_key] })
+
+    raise(AuthenticationError, "#{response.code}: #{response.message}") unless response.success?
+
+    self.auth_token = response.headers["X-Auth-Token"]
+    self.storage_url = response.headers["X-Storage-Url"]
+
+    storage_url.gsub!(/^http:/, "https:") if options[:auth_url] =~ /^https:/
+  end
+end
+

data/swift_client.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'swift_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "swift_client"
+  spec.version       = SwiftClient::VERSION
+  spec.authors       = ["Benjamin Vetter"]
+  spec.email         = ["vetter@plainpicture.de"]
+  spec.summary       = %q{Small but powerful client to interact with OpenStack Swift}
+  spec.description   = %q{Small but powerful client to interact with OpenStack Swift}
+  spec.homepage      = "https://github.com/mrkamel/swift_client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty"
+  spec.add_dependency "mime-types"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "webmock"
+end

data/test/swift_client_test.rb

@@ -0,0 +1,118 @@
+
+require File.expand_path("../test_helper", __FILE__)
+
+class SwiftClientTest < MiniTest::Test
+  def setup
+    stub_request(:get, "https://example.com/auth/v1.0").with(:headers => { "X-Auth-Key" => "secret", "X-Auth-User" => "account:username" }).to_return(:status => 200, :body => "", :headers => { "X-Auth-Token" => "Token", "X-Storage-Url" => "https://example.com/v1/AUTH_account" })
+
+    @swift_client = SwiftClient.new(:auth_url => "https://example.com/auth/v1.0", :username => "account:username", :api_key => "secret")
+
+    assert_equal "Token", @swift_client.auth_token
+    assert_equal "https://example.com/v1/AUTH_account", @swift_client.storage_url
+  end
+
+  def test_get_containers
+    containers = [
+      { "count" => 1, "bytes" => 1, "name" => "container-1" },
+      { "count" => 1, "bytes" => 1, "name" => "container-2" }
+    ]
+
+    stub_request(:get, "https://example.com/v1/AUTH_account/").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => 200, :body => JSON.dump(containers), :headers => { "Content-Type" => "application/json" })
+
+    assert_equal containers, @swift_client.get_containers.parsed_response
+  end
+
+  def test_get_container
+    objects = [
+      { "hash" => "Hash", "last_modified" => "Last modified", "bytes" => 1, "name" => "object-2", "content_type" => "Content type" },
+      { "hash" => "Hash", "last_modified" => "Last modified", "bytes" => 1, "name" => "object-3", "content_type" => "Content type" }
+    ]
+
+    stub_request(:get, "https://example.com/v1/AUTH_account/container-1?limit=2&marker=object-2").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => 200, :body => JSON.dump(objects), :headers => { "Content-Type" => "application/json" })
+
+    assert_equal objects, @swift_client.get_container("container-1", :limit => 2, :marker => "object-2").parsed_response
+  end
+
+  def test_head_container
+    stub_request(:head, "https://example.com/v1/AUTH_account/container-1").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => 204, :body => "", :headers => { "Content-Type" => "application/json" })
+
+    assert 204, @swift_client.head_container("container-1").code
+  end
+
+  def test_put_container
+    stub_request(:put, "https://example.com/v1/AUTH_account/container").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token", "X-Container-Read" => ".r:*" }).to_return(:status => 201, :body => "", :headers => {})
+
+    assert_equal 201, @swift_client.put_container("container", "X-Container-Read" => ".r:*").code
+  end
+
+  def test_post_container
+    stub_request(:post, "https://example.com/v1/AUTH_account/container").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token", "X-Container-Read" => ".r:*" }).to_return(:status => 204, :body => "", :headers => {})
+
+    assert_equal 204, @swift_client.post_container("container", "X-Container-Read" => ".r:*").code
+  end
+
+  def test_delete_container
+    stub_request(:delete, "https://example.com/v1/AUTH_account/container").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => 204, :body => "", :headers => {})
+
+    assert_equal 204, @swift_client.delete_container("container").code
+  end
+
+  def test_put_object
+    stub_request(:put, "https://example.com/v1/AUTH_account/container/object").with(:body => "data", :headers => { "Accept" => "application/json", "X-Auth-Token" => "Token", "X-Object-Meta-Test" => "Test" }).to_return(:status => 201, :body => "", :headers => {})
+
+    assert_equal 201, @swift_client.put_object("object", "data", "container", "X-Object-Meta-Test" => "Test").code
+  end
+
+  def test_put_object_with_io
+    stub_request(:put, "https://example.com/v1/AUTH_account/container/object").with(:body => "data", :headers => { "Accept" => "application/json", "X-Auth-Token" => "Token", "X-Object-Meta-Test" => "Test" }).to_return(:status => 201, :body => "", :headers => {})
+
+    assert_equal 201, @swift_client.put_object("object", StringIO.new("data"), "container", "X-Object-Meta-Test" => "Test").code
+  end
+
+  def test_post_object
+    stub_request(:post, "https://example.com/v1/AUTH_account/container/object").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token", "X-Object-Meta-Test" => "Test" }).to_return(:status => 201, :body => "", :headers => {})
+
+    assert_equal 201, @swift_client.post_object("object", "container", "X-Object-Meta-Test" => "Test").code
+  end
+
+  def test_get_object
+    stub_request(:get, "https://example.com/v1/AUTH_account/container/object").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => 200, :body => "Body", :headers => {})
+
+    assert_equal "Body", @swift_client.get_object("object", "container").body
+  end
+
+  def test_head_object
+    stub_request(:head, "https://example.com/v1/AUTH_account/container/object").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => 200, :body => "", :headers => {})
+
+    assert_equal 200, @swift_client.head_object("object", "container").code
+  end
+
+  def test_delete_object
+    stub_request(:delete, "https://example.com/v1/AUTH_account/container/object").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => 204, :body => "", :headers => {})
+
+    assert_equal 204, @swift_client.delete_object("object", "container").code
+  end
+
+  def test_get_objects
+    objects = [
+      { "hash" => "Hash", "last_modified" => "Last modified", "bytes" => 1, "name" => "object-2", "content_type" => "Content type" },
+      { "hash" => "Hash", "last_modified" => "Last modified", "bytes" => 1, "name" => "object-3", "content_type" => "Content type" }
+    ]
+
+    stub_request(:get, "https://example.com/v1/AUTH_account/container-1?limit=2&marker=object-2").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => 200, :body => JSON.dump(objects), :headers => { "Content-Type" => "application/json" })
+
+    assert_equal objects, @swift_client.get_container("container-1", :limit => 2, :marker => "object-2").parsed_response
+  end
+
+  def test_not_found
+    stub_request(:get, "https://example.com/v1/AUTH_account/container/object").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => [404, "Not Found"], :body => "", :headers => { "Content-Type" => "application/json" })
+
+    begin
+      @swift_client.get_object("object", "container")
+    rescue SwiftClient::ResponseError => e
+      assert_equal 404, e.code
+      assert_equal "Not Found", e.message
+    end
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+
+require "swift_client"
+require "minitest"
+require "minitest/autorun"
+require "webmock/minitest"
+

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: swift_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Benjamin Vetter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Small but powerful client to interact with OpenStack Swift
+email:
+- vetter@plainpicture.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/swift_client.rb
+- lib/swift_client/version.rb
+- swift_client.gemspec
+- test/swift_client_test.rb
+- test/test_helper.rb
+homepage: https://github.com/mrkamel/swift_client
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Small but powerful client to interact with OpenStack Swift
+test_files:
+- test/swift_client_test.rb
+- test/test_helper.rb