carrierwave-riak 0.1.0

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format nested

data/Gemfile

@@ -0,0 +1,9 @@
+source :rubygems
+gem "rake"
+gem 'riak-client'
+gem 'carrierwave'
+
+group :test do
+  gem 'rails', '3.0.0'
+  gem 'rspec','~> 2.6.0'
+end

data/README.md

@@ -0,0 +1,61 @@
+# CarrierWave for [Riak](http://wiki.basho.com/Riak.html)
+
+This gem adds storage support for [Riak](http://wiki.basho.com/Riak.html) to [CarrierWave](https://github.com/jnicklas/carrierwave/)
+
+This module should work for basic uploads, but hasn't been tested with all features of carrierrwave and is very new.  The code was initially based
+on [carrierwave-upyun](https://github.com/nowa/carrierwave-upyun) but also uses ideas taken from the built in Fog storage provider.
+
+## Installation
+
+    gem install carrierwave-riak
+
+## Or using Bundler, in `Gemfile`
+
+    gem 'riak-client'
+    gem 'carrierwave-riak', :require => "carrierwave/riak"
+
+## Configuration
+
+You'll need to configure the Riak client in config/initializes/carrierwave.rb
+
+```ruby
+CarrierWave.configure do |config|
+  config.storage = :riak
+  config.riak_host = 'localhost'
+  config.riak_port = 8098
+end
+```
+
+## Usage example
+
+Note that for your uploader, your should extend the CarrierWave::Uploader::Riak class.
+
+```ruby
+class DocumentUploader < CarrierWave::Uploader::Riak
+
+    # If key method is not defined, Riak generated keys will be used and returned as the identifier
+
+    def key
+        original_filename
+    end
+
+    def bucket
+      "my_bucket"
+    end
+end
+```
+
+### Using Riak generated keys ###
+
+Because the orm record is saved before the storage object is, the orm record needs to be updated after
+saving to storage if a Riak generated key is to be used as the identifier.  The CarrierWave::Uploader::Riak
+class defines an :after callback to facilitate this.  This only works for ActiveRecord and is likely pretty
+hacky.  Maybe someone can suggest a better way to deal with this.
+
+## TODO ###
+
+- Write specs.  Bad programmer.
+
+## Contributing ##
+
+If this is helpful to you, but isn't quite working please send me pull requests.

data/carrierwave-riak.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "carrierwave-riak"
+  s.version     = "0.1.0"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Kevin Motschiedler"]
+  s.email       = ["kdmotschiedler@gmail.com"]
+  s.homepage    = "https://github.com/motske/carrierwave-riak"
+  s.summary     = %q{Riak Storage support for CarrierWave}
+  s.description = %q{Riak Storage support for CarrierWave}
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "carrierwave"
+  s.add_development_dependency "riak-client", ["~> 1.0.0"]
+  s.add_development_dependency "rails", ["~> 3.0.5"]
+  s.add_development_dependency "rspec", ["~> 2.6"]
+  s.add_development_dependency "rake", ["~> 0.9"]
+end

data/lib/carrierwave/riak.rb

@@ -0,0 +1,8 @@
+require "carrierwave/storage/riak"
+require "carrierwave/riak/configuration"
+CarrierWave.configure do |config|
+  config.storage_engines.merge!({:riak => "CarrierWave::Storage::Riak"})
+end
+
+CarrierWave::Uploader::Base.send(:include, CarrierWave::Riak::Configuration)
+require "carrierwave/uploader/riak"

data/lib/carrierwave/riak/configuration.rb

@@ -0,0 +1,35 @@
+module CarrierWave
+  module Riak
+    module Configuration
+      extend ActiveSupport::Concern
+      included do
+        add_config :riak_bucket
+        add_config :riak_host
+        add_config :riak_port
+      end
+    end
+
+    module ClassMethods
+      def add_config(name)
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def self.#{name}(value=nil)
+            @#{name} = value if value
+            return @#{name} if self.object_id == #{self.object_id} || defined?(@#{name})
+            name = superclass.#{name}
+            return nil if name.nil? && !instance_variable_defined?("@#{name}")
+            @#{name} = name && !name.is_a?(Module) && !name.is_a?(Symbol) && !name.is_a?(Numeric) && !name.is_a?(TrueClass) && !name.is_a?(FalseClass) ? name.dup : name
+          end
+
+          def self.#{name}=(value)
+            @#{name} = value
+          end
+
+          def #{name}
+            value = self.class.#{name}
+            value.instance_of?(Proc) ? value.call : value
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/carrierwave/storage/riak.rb

@@ -0,0 +1,228 @@
+# encoding: utf-8
+require 'carrierwave'
+require 'riak'
+
+module CarrierWave
+  module Storage
+
+    ##
+    #
+    #     CarrierWave.configure do |config|
+    #       config.riak_host = "http://localhost
+    #       config.riak_port = 8098
+    #     end
+    #
+    #
+    class Riak < Abstract
+
+      class Connection
+        def initialize(options={})
+          @riak_bucket = options[:riak_bucket]
+          @host = options[:riak_host]
+          @port = options[:riak_port]
+          @client = ::Riak::Client.new(:host => @host, :http_port => @port)
+        end
+
+        def store(bucket, key, payload, headers = {})
+          bucket = @client.bucket(bucket)
+          robject = ::Riak::RObject.new(bucket, key)
+          robject.content_type = headers[:content_type]
+          robject.raw_data = payload
+          robject.store
+        end
+
+        def get(bucket, key)
+          bucket = @client.bucket(bucket)
+          bucket.get(key)
+        end
+
+        def delete(bucket, key)
+          bucket = @client.bucket(bucket)
+          bucket.delete(key)
+        end
+
+        def post(path, payload, headers = {})
+          @http["#{escaped(path)}"].post(payload, headers)
+        end
+
+        def escaped(path)
+          CGI.escape(path)
+        end
+      end
+
+      class File
+
+        def initialize(uploader, base, bucket, key)
+          @uploader = uploader
+          @bucket = bucket
+          @key = key
+          @base = base
+        end
+
+        ##
+        # Returns the key of the riak file
+        #
+        # === Returns
+        #
+        # [String] A filename
+        #
+        def key
+          @key
+        end
+
+        ##
+        # Lookup value for file content-type header
+        #
+        # === Returns
+        #
+        # [String] value of content-type
+        #
+        def content_type
+          @content_type || file.content_type
+        end
+
+        ##
+        # Set non-default content-type header (default is file.content_type)
+        #
+        # === Returns
+        #
+        # [String] returns new content type value
+        #
+        def content_type=(new_content_type)
+          @content_type = new_content_type
+        end
+
+        ##
+        # Return riak meta data
+        #
+        # === Returns
+        #
+        # [Haash] A hash of X-Riak-Meta-* headers
+        #
+        def meta
+          file.meta
+        end
+
+        ##
+        # Return size of file body
+        #
+        # === Returns
+        #
+        # [Integer] size of file body
+        #
+        def size
+          file.raw_data.length
+        end
+
+        ##
+        # Reads the contents of the file from Riak
+        #
+        # === Returns
+        #
+        # [String] contents of the file
+        #
+        def read
+          file.raw_data
+        end
+
+        ##
+        # Remove the file from Riak
+        #
+        def delete
+          begin
+            riak_client.delete(@bucket, @key)
+            true
+          rescue Exception => e
+            # If the file's not there, don't panic
+            nil
+          end
+        end
+
+        ##
+        # Writes the supplied data into Riak
+        #
+        # === Returns
+        #
+        # boolean
+        #
+        def store(file)
+          @file = riak_client.store(@bucket, @key, file.read, {:content_type => file.content_type})
+          @key = @file.key
+          @uploader.key = @key
+          true
+        end
+
+        private
+
+          def headers
+            @headers ||= {  }
+          end
+
+          def connection
+            @base.connection
+          end
+
+          ##
+          # lookup file
+          #
+          # === Returns
+          #
+          # [Riak::RObject] file data from remote service
+          #
+          def file
+            @file ||= riak_client.get(@bucket, @key)
+          end
+
+          def riak_client
+            if @riak_client
+              @riak_client
+            else
+              config = {
+                :riak_bucket => @uploader.riak_bucket,
+                :riak_host => @uploader.riak_host,
+                :riak_port => @uploader.riak_port
+              }
+              @riak_client ||= CarrierWave::Storage::Riak::Connection.new(config)
+            end
+          end
+
+      end
+
+      ##
+      # Store the file on Riak
+      #
+      # === Parameters
+      #
+      # [file (CarrierWave::SanitizedFile)] the file to store
+      #
+      # === Returns
+      #
+      # [CarrierWave::Storage::Riak::File] the stored file
+      #
+      def store!(file)
+        f = CarrierWave::Storage::Riak::File.new(uploader, self, uploader.bucket, uploader.key)
+        f.store(file)
+        f
+      end
+
+      # Do something to retrieve the file
+      #
+      # @param [String] identifier uniquely identifies the file
+      #
+      # [identifier (String)] uniquely identifies the file
+      #
+      # === Returns
+      #
+      # [CarrierWave::Storage::Riak::File] the stored file
+      #
+      def retrieve!(key)
+        CarrierWave::Storage::Riak::File.new(uploader, self, uploader.bucket, key)
+      end
+
+      def identifier
+        uploader.key
+      end
+
+    end # CloudFiles
+  end # Storage
+end # CarrierWave

data/lib/carrierwave/uploader/riak.rb

@@ -0,0 +1,23 @@
+require 'carrierwave'
+require 'riak'
+
+module CarrierWave
+  module Uploader
+    class Riak < Base
+
+      attr_accessor :key
+
+      storage :riak
+
+      if defined?(Rails)
+        after :store, :updatemodel
+
+        def updatemodel(file)
+          if(model.read_attribute(:"#{self.mounted_as}").nil?)
+            model.update_attribute(:"#{self.mounted_as}", self.key)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'rspec'
+require 'rspec/autorun'
+require 'rails'
+require 'active_record'
+require "carrierwave"
+require 'carrierwave/orm/activerecord'
+require 'carrierwave/processing/mini_magick'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require "carrierwave/riak"
+
+
+module Rails
+  class <<self
+    def root
+      [File.expand_path(__FILE__).split('/')[0..-3].join('/'),"spec"].join("/")
+    end
+  end
+end
+
+ActiveRecord::Migration.verbose = false
+
+CarrierWave.configure do |config|
+  config.storage = :riak
+  config.riak_bucket = "rspec"
+  config.riak_host = "localhost"
+end
+
+def load_file(fname)
+  File.open([Rails.root,fname].join("/"))
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification 
+name: carrierwave-riak
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kevin Motschiedler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-07 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: carrierwave
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: riak-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 3
+        - 0
+        - 5
+        version: 3.0.5
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :development
+  version_requirements: *id005
+description: Riak Storage support for CarrierWave
+email: 
+- kdmotschiedler@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .rspec
+- Gemfile
+- README.md
+- carrierwave-riak.gemspec
+- lib/carrierwave/riak.rb
+- lib/carrierwave/riak/configuration.rb
+- lib/carrierwave/storage/riak.rb
+- lib/carrierwave/uploader/riak.rb
+- spec/spec_helper.rb
+homepage: https://github.com/motske/carrierwave-riak
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Riak Storage support for CarrierWave
+test_files: 
+- spec/spec_helper.rb
+has_rdoc: