dragonfly-couch_data_store 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ac3670ecae746c881b2f5267c043a40675fb702
+  data.tar.gz: c8d2b02a1d5a31ce2d37f70f1ccbb121727e5b82
+SHA512:
+  metadata.gz: 0b99e0cf0b098df6159e968ff201f8ad9982cb733c113cddb3a49c19212f227c71e37a50ab7628391bcfaa3d279bb77286b12b43882ec0cd88318acbd34ac4c8
+  data.tar.gz: 4725d751fb33455ad332b8d580ed082438d4964221567740513c1441b3aa50ce092c4485d6f4a671c3b7c41b54ee7eb3d916f9c39164a9aa6fd2b1f90767fa8d

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+dragonfly.log
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mark Evans
+
+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,51 @@
+# Dragonfly::CouchDataStore
+
+Couch data store for use with the [Dragonfly](http://github.com/markevans/dragonfly) gem.
+
+## Gemfile
+
+```ruby
+gem 'dragonfly-couch_data_store'
+```
+
+## Usage
+
+In your dragonfly config block (with default options):
+
+```ruby
+Dragonfly.app.configure do
+  # ...
+
+  datastore :couch
+
+  # ...
+end
+```
+
+Or with options:
+
+```ruby
+datastore :couch, username: 'potatoman', password: 'spudulike'
+```
+
+### Available options
+
+```ruby
+:host              # default 'localhost'
+:port              # default 5984
+:database          # default 'dragonfly'
+:username          # not needed in 'admin party' mode
+:password          # not needed in 'admin party' mode
+```
+
+### Serving directly from Couch
+
+```ruby
+Dragonfly.app.remote_url_for('some/uid')
+```
+
+or
+
+```ruby
+my_model.attachment.remote_url
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/dragonfly-couch_data_store.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dragonfly/couch_data_store/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dragonfly-couch_data_store"
+  spec.version       = Dragonfly::CouchDataStore::VERSION
+  spec.authors       = ["Mark Evans"]
+  spec.email         = ["mark@new-bamboo.co.uk"]
+  spec.description   = %q{Couch data store for Dragonfly}
+  spec.summary       = %q{Data store for storing content (e.g. images) handled with the Dragonfly gem in a couch database}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_runtime_dependency "dragonfly", "~> 1.0"
+  spec.add_runtime_dependency "couchrest"
+  spec.add_development_dependency "rspec", "~> 2.0"
+end
+

data/lib/dragonfly/couch_data_store.rb

@@ -0,0 +1,82 @@
+require 'couchrest'
+require 'dragonfly'
+
+Dragonfly::App.register_datastore(:couch){ Dragonfly::CouchDataStore }
+
+module Dragonfly
+  class CouchDataStore
+
+    include Serializer
+
+    def initialize(opts={})
+      @host = opts[:host] || 'localhost'
+      @port = opts[:port] || '5984'
+      @database = opts[:database] || 'dragonfly'
+      @username = opts[:username]
+      @password = opts[:password]
+    end
+
+    attr_reader :host, :port, :database, :username, :password
+
+    def write(content, opts={})
+      name = content.name || 'file'
+
+      content.file do |f|
+        doc = CouchRest::Document.new(:meta => content.meta)
+        response = db.save_doc(doc)
+        doc.put_attachment(name, f.dup, :content_type => content.mime_type)
+        form_uid(response['id'], name)
+      end
+    end
+
+    def read(uid)
+      doc_id, attachment = parse_uid(uid)
+      doc = db.get(doc_id)
+      [doc.fetch_attachment(attachment), extract_meta(doc)]
+    rescue RestClient::ResourceNotFound => e
+      nil
+    end
+
+    def destroy(uid)
+      doc_id, attachment = parse_uid(uid)
+      doc = db.get(doc_id)
+      db.delete_doc(doc)
+    rescue RestClient::ResourceNotFound => e
+      Dragonfly.warn("#{self.class.name} destroy error: #{e}")
+    end
+
+    def db
+      @db ||= begin
+        url = "http://#{auth}#{host}:#{port}"
+        CouchRest.new(url).database!(database)
+      end
+    end
+
+    def url_for(uid, opts={})
+      doc_id, attachment = parse_uid(uid)
+      "http://#{host}:#{port}/#{database}/#{doc_id}/#{attachment}"
+    end
+
+    private
+
+    def auth
+      username ? "#{username}:#{password}@" : nil
+    end
+
+    def form_uid(doc_id, attachment)
+      "#{doc_id}/#{attachment}"
+    end
+
+    def parse_uid(uid)
+      doc_id, attachment = uid.split('/')
+      [doc_id, (attachment || 'file')]
+    end
+
+    def extract_meta(doc)
+      meta = doc['meta']
+      meta = Utils.stringify_keys(marshal_b64_decode(meta)) if meta.is_a?(String) # Deprecated encoded meta
+      meta
+    end
+
+  end
+end

data/lib/dragonfly/couch_data_store/version.rb

@@ -0,0 +1,5 @@
+module Dragonfly
+  module CouchDataStore
+    VERSION = "1.0.0"
+  end
+end

data/spec/couch_data_store_spec.rb

@@ -0,0 +1,80 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'net/http'
+require 'uri'
+require 'dragonfly/couch_data_store'
+require 'dragonfly/spec/data_store_examples'
+
+describe Dragonfly::CouchDataStore do
+
+  before(:each) do
+    @data_store = Dragonfly::CouchDataStore.new(:database => "dragonfly_test")
+  end
+
+  it_should_behave_like 'data_store'
+
+  let (:app) { Dragonfly.app }
+  let (:content) { Dragonfly::Content.new(app, "gollum") }
+  let (:new_content) { Dragonfly::Content.new(app) }
+
+  describe "configuring the app" do
+    it "can be configured with a symbol" do
+      app.configure do
+        datastore :couch
+      end
+      app.datastore.should be_a(Dragonfly::CouchDataStore)
+    end
+  end
+
+  describe "url_for" do
+    it "should give the correct url" do
+      @data_store.url_for('asd7fas9df/thing.txt').should == 'http://localhost:5984/dragonfly_test/asd7fas9df/thing.txt'
+    end
+
+    it "should assume the attachment is called 'file' if not given" do
+      @data_store.url_for('asd7fas9df').should == 'http://localhost:5984/dragonfly_test/asd7fas9df/file'
+    end
+  end
+
+  describe "serving from couchdb" do
+
+    def get_content(url)
+      uri = URI.parse(url)
+      Net::HTTP.start(uri.host, uri.port) {|http|
+        http.get(uri.path)
+      }
+    end
+
+    it "serves with the correct data type (taken from ext)" do
+      content.name = 'doogie.png'
+      uid = @data_store.write(content)
+      response = get_content(@data_store.url_for(uid))
+      response.body.should == 'gollum'
+      response['Content-Type'].should == 'image/png'
+    end
+
+ end
+
+  describe "already stored stuff" do
+    def store_pdf(meta)
+      doc = CouchRest::Document.new(:meta => meta)
+      doc_id = @data_store.db.save_doc(doc)['id']
+      doc.put_attachment("pdf", "PDF data here")
+      doc_id
+    end
+
+    it "still works" do
+      doc_id = store_pdf('some' => 'cool things')
+      new_content.update(*@data_store.read("#{doc_id}/pdf"))
+      new_content.data.should == "PDF data here"
+      new_content.meta['some'].should == 'cool things'
+    end
+
+    it "still works when meta was stored as a marshal dumped hash (but stringifies its keys)" do
+      doc_id = store_pdf(Dragonfly::Serializer.marshal_b64_encode(:some => 'shizzle'))
+      new_content.update(*@data_store.read("#{doc_id}/pdf"))
+      new_content.meta['some'].should == 'shizzle'
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end
+

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: dragonfly-couch_data_store
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mark Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dragonfly
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: couchrest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Couch data store for Dragonfly
+email:
+- mark@new-bamboo.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dragonfly-couch_data_store.gemspec
+- lib/dragonfly/couch_data_store.rb
+- lib/dragonfly/couch_data_store/version.rb
+- spec/couch_data_store_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Data store for storing content (e.g. images) handled with the Dragonfly gem
+  in a couch database
+test_files:
+- spec/couch_data_store_spec.rb
+- spec/spec_helper.rb