paperclip-swift-swauth 0.1.0

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2013 DropMyEmail Pte Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,34 @@
+# Paperclip Swift Swauth
+
+This gem is a [Paperclip](https://github.com/thoughtbot/paperclip/) store for [OpenStack Swift](swift.openstack.org). This is different from the [paperclip-swift](https://github.com/helios-technologies/paperclip-swift/) library in the authentication. This library uses [swauth](https://github.com/gholt/swauth) for authentication.
+
+## Installation
+
+```
+gem install paperclip-swift-swauth
+```
+
+## Usage
+
+You should specify the following variables in your environment. We don't like storing passwords in the plain.
+
+```
+export SWIFT_USER="user"
+export SWIFT_PASSWORD="some-secret-password"
+export SWIFT_URL="https://your-swift-server.com"
+export SWIFT_TENANT="tenant-name"
+export SWIFT_CONTAINER="container-name"
+```
+
+Set the storage to be __swift_swauth__. The usual Paperclip configuration should be applicable.
+
+``` ruby
+class User < ActiveRecord::Base
+  has_attached_file :avatar,
+    :storage => :swift_swauth
+end
+```
+
+## License
+
+Apache 2.0. See LICENSE for details.

data/lib/paperclip-swift-swauth.rb

@@ -0,0 +1,2 @@
+require 'paperclip/storage/swift_swauth'
+require 'paperclip/swift/swauth_client'

data/lib/paperclip/storage/swift_swauth.rb

@@ -0,0 +1,97 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'swift', 'swauth_client'))
+
+# Public: Paperclip storage adaptor for Openstack Swift.
+# Swift authentication is assumed to be on Swauth
+module Paperclip
+  module Storage
+    module SwiftSwauth
+
+      # Public: Hook for the base class to run
+      def self.extended(base)
+      end
+
+      # Public: Checks that the file exists
+      #
+      # style - The string which represents the file(default: default_style)
+      #
+      # Examples
+      #
+      #   swift_swauth.exists 'foo'
+      #   => true
+      #
+      # Returns a Boolean
+      def exists?(style=default_style)
+        client.object_exists?(path(style))
+      end
+
+      # Public: Performs the write operations stored in the write queue
+      #
+      # Examples
+      #
+      #   swift_swauth.flush_writes
+      #   => {}
+      #
+      # Returns nothing
+      def flush_writes
+        @queued_for_write.each do |style, file|
+          write_opts = { content_type: instance_read(:content_type) }
+          client.create_object(path(style), write_opts, file)
+        end
+        after_flush_writes # allows attachment to clean up temp files
+        @queued_for_write = {}
+      end
+
+      # Public: Performs the delete operations stored in the delete queue
+      #
+      # Examples
+      #
+      #   swift_swauth.flush_deletes
+      #   => []
+      #
+      # Returns nothing
+      def flush_deletes
+        @queued_for_delete.each do |path|
+          client.delete_object(path) if client.object_exists?(path)
+        end
+        @queue_for_delete = []
+      end
+
+      # Public: Performs the delete operations stored in the delete queue
+      #
+      # style           - The string which represents the file
+      # local_dest_path - The string which represents the location to save the file to
+      #
+      # Examples
+      #
+      #   swift_swauth.copy_to_local_file('foo', '/path/to/foo')
+      #   => nil
+      #
+      # Returns nothing
+      def copy_to_local_file(style, local_dest_path)
+        if exists?(style)
+          local_file = File.open(local_dest_path, 'wb')
+          local_file.write(client.object(path(style)).data)
+          local_file.close
+        end
+      end
+
+      protected
+
+      # Private: Returns the swift client for performing the operations
+      #
+      # Examples
+      #
+      #   swift_swauth.client
+      #   => <Paperclip::Swift::SwauthClient>
+      #
+      # Returns an instance of SwauthClient
+      def client
+        if @client.nil?
+          @client = Paperclip::Swift::SwauthClient.new
+        end
+        @client
+      end
+
+    end
+  end
+end

data/lib/paperclip/swift/swauth_client.rb

@@ -0,0 +1,115 @@
+require 'openstack'
+
+module Paperclip
+  module Swift
+    class SwauthClient
+      SERVICE_TYPE = 'object-store'
+
+      # Public: Constructor. Assumes all the needed variables are
+      # found in the environment
+      def initialize
+        @swift_opts = {
+          user:      ENV['SWIFT_USER'] || '',
+          password:  ENV['SWIFT_PASSWORD'] || '',
+          url:       ENV['SWIFT_URL'] || '',
+          tenant:    ENV['SWIFT_TENANT'] || '',
+          container: ENV['SWIFT_CONTAINER'] || ''
+        }
+      end
+
+      # Public: Checks if the object exists in the container
+      #
+      # path - The String which represents the object
+      #
+      # Examples
+      #
+      #   swauth_client.object_exists 'foo'
+      #   => true
+      #
+      # Returns a Boolean
+      def object_exists?(path)
+        container.object_exists? path
+      end
+
+      # Public: Creates the object given the path, options and data
+      #
+      # path - The String which represents the object
+      # opts - The Hash which contains the options for the object
+      # data - The File or String which represents the data
+      #
+      # Examples
+      #
+      #   swauth_client.create_object 'foo', {}, File.open('foo.pdf')
+      #   => nil
+      #
+      # Returns nothing
+      def create_object(path, opts={}, data)
+        container.create_object path, opts, data
+      end
+
+      # Public: Deletes the object given the path
+      #
+      # path - The String which represents the object
+      #
+      # Examples
+      #
+      #   swauth_client.delete_object 'foo'
+      #   => nil
+      #
+      # Returns nothing
+      def delete_object(path)
+        container.delete_object path
+      end
+
+      # Public: Returns the object given the path
+      #
+      # path - The String which represents the object
+      #
+      # Examples
+      #
+      #   swauth_client.object 'foo'
+      #   => <OpenStack::Swift::Container::Object>
+      #
+      # Returns an instance of OpenStack::Swift::Container::Object
+      def object(path)
+        container.object path
+      end
+
+      protected
+
+      # Private: Returns the container object for the connection
+      #
+      # Examples
+      #
+      #   swauth_client.container
+      #   => <OpenStack::Swift::Container>
+      #
+      # Returns an instance of OpenStack::Swift::Container
+      def container
+        if @connection.nil?
+          @connection = OpenStack::Connection.create(connection_opts)
+        end
+        @connection.container(@swift_opts[:container])
+      end
+
+      # Private: Returns the connection options
+      #
+      # Examples
+      #
+      #   swauth_client.connection_opts
+      #   => {...}
+      #
+      # Returns a Hash of options
+      def connection_opts
+        {
+          username: @swift_opts[:user],
+          api_key: @swift_opts[:password],
+          auth_url: @swift_opts[:url],
+          authtenant_name: @swift_opts[:tenant],
+          auth_method: @swift_opts[:password],
+          service_type: SERVICE_TYPE
+        }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: paperclip-swift-swauth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Wong Liang Zan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: shoulda
+  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: A store for paperclip that uses openstack swift. Authenication is assumed
+  to be swauth.
+email:
+- zan@liangzan.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/paperclip/storage/swift_swauth.rb
+- lib/paperclip/swift/swauth_client.rb
+- lib/paperclip-swift-swauth.rb
+- LICENSE
+- README.md
+homepage: https://github.com/DropMyEmail/paperclip-swift-swauth
+licenses: []
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Paperclip store for openstack swift with swauth authentication
+test_files: []