dragonfly-mongo_data_store 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c43fa4eab4ad2e74095650d1eb9e82725d45428
+  data.tar.gz: 7663d2bfc58ce2d652d9b5ca3b5156fc521d282c
+SHA512:
+  metadata.gz: 2f5820727acf128a5a930404c99955b7ab81e3290a1dfa63deec3a529e650c92fa7ac463bddac91d08600e993e611b6c38ad81a8a9cfdc94f66f42a76dd1669a
+  data.tar.gz: be43db014ca8ba243fd35d3ed2799e490f789caba75e92c02a734b364e6353ae363edc4c4d5cde2db803ec8ee41ba3a00fa7092e3de32cdbe4f59cb679ff7e56

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

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,44 @@
+# Dragonfly::MongoDataStore
+
+Mongo data store for use with the [Dragonfly](http://github.com/markevans/dragonfly) gem.
+
+## Gemfile
+
+```ruby
+gem 'dragonfly-mongo_data_store'
+```
+
+## Usage
+
+In your dragonfly config block (with default options):
+
+```ruby
+Dragonfly.app.configure do
+  # ...
+
+  datastore :mongo
+
+  # ...
+end
+```
+
+Or with options:
+
+```ruby
+datastore :mongo, host: 'my.host', database: 'my_database'
+```
+
+### Available options
+
+```ruby
+:host              # e.g. 'my.domain'
+:hosts             # for replica sets, e.g. ['n1.mydb.net:27017', 'n2.mydb.net:27017']
+:connection_opts   # hash that passes through to Mongo::Connection or Mongo::ReplSetConnection
+:port              # e.g. 27017
+:database          # defaults to 'dragonfly'
+:username
+:password
+:connection        # use this if you already have a Mongo::Connection object
+:db                # use this if you already have a Mongo::DB object
+```
+

data/Rakefile

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

data/dragonfly-mongo_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/mongo_data_store/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dragonfly-mongo_data_store"
+  spec.version       = Dragonfly::MongoDataStore::VERSION
+  spec.authors       = ["Mark Evans"]
+  spec.email         = ["mark@new-bamboo.co.uk"]
+  spec.description   = %q{Mongo data store for Dragonfly}
+  spec.summary       = %q{Data store for storing content (e.g. images) handled with the Dragonfly gem in a mongo database.}
+  spec.homepage      = "http://github.com/markevans/dragonfly-mongo_data_store"
+  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 "mongo", "~> 1.7"
+  spec.add_development_dependency "rspec", "~> 2.0"
+end
+

data/lib/dragonfly/mongo_data_store.rb

@@ -0,0 +1,86 @@
+require 'mongo'
+require 'dragonfly'
+
+Dragonfly::App.register_datastore(:mongo){ Dragonfly::MongoDataStore }
+
+module Dragonfly
+  class MongoDataStore
+
+    include Serializer
+
+    def initialize(opts={})
+      @host            = opts[:host]
+      @hosts           = opts[:hosts]
+      @connection_opts = opts[:connection_opts] || {}
+      @port            = opts[:port]
+      @database        = opts[:database] || 'dragonfly'
+      @username        = opts[:username]
+      @password        = opts[:password]
+      @connection      = opts[:connection]
+      @db              = opts[:db]
+    end
+
+    attr_accessor :host, :hosts, :connection_opts, :port, :database, :username, :password
+
+    def write(content, opts={})
+      ensure_authenticated!
+      content.file do |f|
+        mongo_id = grid.put(f, :content_type => content.mime_type, :metadata => content.meta)
+        mongo_id.to_s
+      end
+    end
+
+    def read(uid)
+      ensure_authenticated!
+      grid_io = grid.get(bson_id(uid))
+      meta = extract_meta(grid_io)
+      [grid_io.read, meta]
+    rescue Mongo::GridFileNotFound, BSON::InvalidObjectId => e
+      nil
+    end
+
+    def destroy(uid)
+      ensure_authenticated!
+      grid.delete(bson_id(uid))
+    rescue Mongo::GridFileNotFound, BSON::InvalidObjectId => e
+      Dragonfly.warn("#{self.class.name} destroy error: #{e}")
+    end
+
+    def connection
+      @connection ||= if hosts
+        Mongo::ReplSetConnection.new(hosts, connection_opts)
+      else
+        Mongo::Connection.new(host, port, connection_opts)
+      end
+    end
+
+    def db
+      @db ||= connection.db(database)
+    end
+
+    def grid
+      @grid ||= Mongo::Grid.new(db)
+    end
+
+    private
+
+    def ensure_authenticated!
+      if username
+        @authenticated ||= db.authenticate(username, password)
+      end
+    end
+
+    def bson_id(uid)
+      BSON::ObjectId.from_string(uid)
+    end
+
+    def extract_meta(grid_io)
+      meta = grid_io.metadata
+      meta = Utils.stringify_keys(marshal_b64_decode(meta)) if meta.is_a?(String) # Deprecated encoded meta
+      meta.merge!('stored_at' => grid_io.upload_date)
+      meta
+    end
+
+  end
+end
+

data/lib/dragonfly/mongo_data_store/version.rb

@@ -0,0 +1,6 @@
+module Dragonfly
+  class MongoDataStore
+    VERSION = "1.0.0"
+  end
+end
+

data/spec/mongo_data_store_spec.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'dragonfly/mongo_data_store'
+require 'dragonfly/spec/data_store_examples'
+require 'mongo'
+
+describe Dragonfly::MongoDataStore do
+
+  let(:app) { Dragonfly.app }
+  let(:content) { Dragonfly::Content.new(app, "Pernumbucano") }
+  let(:new_content) { Dragonfly::Content.new(app) }
+
+  before(:each) do
+    @data_store = Dragonfly::MongoDataStore.new :database => 'dragonfly_test'
+  end
+
+  describe "configuring the app" do
+    it "can be configured with a symbol" do
+      app.configure do
+        datastore :mongo
+      end
+      app.datastore.should be_a(Dragonfly::MongoDataStore)
+    end
+  end
+
+  it_should_behave_like 'data_store'
+
+  describe "connecting to a replica set" do
+    it "should initiate a replica set connection if hosts is set" do
+      @data_store.hosts = ['1.2.3.4:27017', '1.2.3.4:27017']
+      @data_store.connection_opts = {:name => 'testingset'}
+      Mongo::ReplSetConnection.should_receive(:new).with(['1.2.3.4:27017', '1.2.3.4:27017'], :name => 'testingset')
+      @data_store.connection
+    end
+  end
+
+  describe "authenticating" do
+    it "should not attempt to authenticate if a username is not given" do
+      @data_store.db.should_not_receive(:authenticate)
+      @data_store.write(content)
+    end
+
+    it "should attempt to authenticate once if a username is given" do
+      @data_store.username = 'terry'
+      @data_store.password = 'butcher'
+      @data_store.db.should_receive(:authenticate).exactly(:once).with('terry','butcher').and_return(true)
+      uid = @data_store.write(content)
+      @data_store.read(uid)
+    end
+  end
+
+  describe "sharing already configured stuff" do
+    before(:each) do
+      @connection = Mongo::Connection.new
+    end
+
+    it "should allow sharing the connection" do
+      data_store = Dragonfly::MongoDataStore.new :connection => @connection
+      @connection.should_receive(:db).and_return(db=double)
+      data_store.db.should == db
+    end
+
+    it "should allow sharing the db" do
+      db = @connection.db('dragonfly_test_yo')
+      data_store = Dragonfly::MongoDataStore.new :db => db
+      data_store.grid.instance_eval{@db}.should == db # so wrong
+    end
+  end
+
+  describe "content type" do
+    it "should serve straight from mongo with the correct content type (taken from ext)" do
+      content.name = 'text.txt'
+      uid = @data_store.write(content)
+      response = @data_store.grid.get(BSON::ObjectId(uid))
+      response.content_type.should == 'text/plain'
+      response.read.should == content.data
+    end
+  end
+
+  describe "already stored stuff" do
+    it "still works" do
+      uid = @data_store.grid.put("DOOBS", :metadata => {'some' => 'meta'}).to_s
+      new_content.update(*@data_store.read(uid))
+      new_content.data.should == "DOOBS"
+      new_content.meta['some'].should == 'meta'
+    end
+
+    it "still works when meta was stored as a marshal dumped hash (but stringifies keys)" do
+      uid = @data_store.grid.put("DOOBS", :metadata => Dragonfly::Serializer.marshal_b64_encode(:some => 'stuff')).to_s
+      c, meta = @data_store.read(uid)
+      meta['some'].should == 'stuff'
+    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,100 @@
+--- !ruby/object:Gem::Specification
+name: dragonfly-mongo_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: mongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: Mongo data store for Dragonfly
+email:
+- mark@new-bamboo.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dragonfly-mongo_data_store.gemspec
+- lib/dragonfly/mongo_data_store.rb
+- lib/dragonfly/mongo_data_store/version.rb
+- spec/mongo_data_store_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/markevans/dragonfly-mongo_data_store
+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 mongo database.
+test_files:
+- spec/mongo_data_store_spec.rb
+- spec/spec_helper.rb