mfs 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9b00957745dcb112bcc396dbcd39eaef86f59b4
-  data.tar.gz: 99ff1f459474364f5aaedac07a7b8cb6d0388dbd
+  metadata.gz: dcea98d53fb089d933a1eae596871bdac6c4b6ba
+  data.tar.gz: eb34cc820cf860ee89868c4259ddf6c0d2d8de6c
 SHA512:
-  metadata.gz: 4c06ae52675d8b0f2e417169b4e76b86559b53e30d8b19bf19dcf70b3f5ce6228cdc22a32c309f2c5d03a97b97e0ab15d0d36d0ed10abd387a9b31fa65ee73b8
-  data.tar.gz: 8d29687b9187c832cc6767ebf66f00ab2c6fe74f7cd40070cdf3005bda929f4f1f0539e4db1a6e21b1f8478b95924fa3be077cb3212580eeaa7651bed6a042db
+  metadata.gz: 0a1594cff6da3ae6b2d441f26615de65217f4d295cd2bee50654211e6dbaa45fe6a9b653fb99f7db52d03b7d58cfa1af00d9530523e035b9e3338889b2416091
+  data.tar.gz: 17912fa43733acb15db6920cdf2f538385c6f8e070f03bfa8857f372178f6b44136dfc9af78c4dd0adf2210e70f865fb798d0263dc2c683284b5bc4610fd62b3

data/README.md

@@ -24,26 +24,29 @@ Usage
 -----
 ```ruby
 require 'mfs'
-entry = Mfs::Loader.load_file('path/to/file')
+entry = Mfs::Entry.load_file('path/to/file')
 entry.filepath
 entry.filename
 entry.created_at
 entry.data
 
 # Set arbitrary Meta-data fields
-Mfs::Loader.load_file('path/to/file',test_field: true)
+Mfs::Entry.load_file('path/to/file',test_field: true)
 entry = Mfs::Entry.where(test_field: true).first
 
 # Load all files in a directory structure
-entries = Mfs::Loader.load_directory('path/to/files')
+entries = Mfs::Entry.load_directory('path/to/files')
 
 # Load all files and set meta-data
-entries = Mfs::Loader.load_directory('path/to/files') do |filename|
+entries = Mfs::Entry.load_directory('path/to/files') do |filename|
     {has_a: filename.include('a')}
 end
 
 ```
 
+Create your own file types.
+As an example see [Mfs::Types::Certificate](lib/types/certificate.rb) and its [Spec](spec/types/certificate_spec.rb)
+
 Limitations
 -----------
 * No File Hierarchy

data/lib/mfs.rb

@@ -2,9 +2,9 @@ require 'bundler/setup'
 require 'mongoid'
 
 require "mfs/version"
-require "mfs/loader"
+require "mfs/can_be_created_from_files"
 require "mfs/entry"
-
+require "mfs/types/certificate"
 
 
 module Mfs

data/lib/mfs/can_be_created_from_files.rb

@@ -0,0 +1,24 @@
+module Mfs
+  module CanBeCreatedFromFiles
+
+    def load_directory(path)
+      Dir.glob("#{path}/**/*").map do |file|
+        next if File.directory?(file)
+
+        additional_metadata = block_given? ? yield(file) : {}
+
+        load_file(file, additional_metadata)
+      end.compact
+    end
+
+    def load_file(filename, additional_metadata = {})
+      create(
+          additional_metadata.merge(
+              data: File.read(filename),
+              filename: filename
+          )
+      )
+    end
+
+  end
+end

data/lib/mfs/entry.rb

@@ -2,10 +2,12 @@ module Mfs
   class Entry
     include Mongoid::Document
     include Mongoid::Timestamps
+    extend CanBeCreatedFromFiles
 
     field :data
     field :filename, type: String
     field :filepath
+    field :filetype
 
     validates_presence_of :filename
     before_create :calculate_metadata

data/lib/mfs/types/certificate.rb

@@ -0,0 +1,17 @@
+module Mfs
+  module Types
+    class Certificate < Entry
+      field :filetype, default: "certificate"
+
+
+      def certificate
+        @certificate ||= OpenSSL::X509::Certificate.new data
+      end
+
+      def dn
+        certificate.subject.to_s
+      end
+
+    end
+  end
+end

data/lib/mfs/version.rb

@@ -1,3 +1,3 @@
 module Mfs
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/can_be_created_from_files_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+module Mfs
+
+  describe CanBeCreatedFromFiles do
+
+    class FileHolder
+      extend CanBeCreatedFromFiles
+
+      attr_reader :hash
+
+      def self.create(params)
+        new(params)
+      end
+
+      def initialize(initialization_hash)
+        @hash = initialization_hash
+      end
+
+    end
+
+
+    describe "can load files from directory" do
+      before do
+        @file_holders = FileHolder.load_directory('spec/fixtures/files') do |filename|
+          {additional_field: filename}
+        end
+      end
+      subject { @file_holders }
+      its(:size) { should eq 11 }
+
+      specify "they should all have additional_field" do
+        @file_holders.reject { |file| file.hash[:additional_field].match /#{file.hash[:filename]}/ }.should be_empty
+      end
+
+    end
+
+    describe "can load file" do
+      before do
+        @file_holder = FileHolder.load_file('spec/fixtures/files/file1')
+      end
+      subject { @file_holder }
+      its(:hash) { should have_key :data }
+      it "should have file contents" do
+        @file_holder.hash[:data].should eq 'This is File One'
+      end
+    end
+  end
+
+end

data/spec/entry_spec.rb

@@ -8,9 +8,9 @@ module Mfs
         @entry = Entry.new
       end
 
-      subject {@entry}
+      subject { @entry }
 
-      it { should_not be_valid}
+      it { should_not be_valid }
     end
 
     describe "has proper fields" do
@@ -18,17 +18,20 @@ module Mfs
         @entry = Entry.create(
             data: "HarderBetterFasterStronger",
             filename: "spec/fixtures/file1",
-            filepath: "spec/fixtures"
+            filepath: "spec/fixtures",
+            filetype: "fake"
         )
       end
 
       subject { @entry }
 
-      it {should be_valid}
+      it { should be_valid }
       its(:data) { should eq "HarderBetterFasterStronger" }
       its(:filename) { should eq "file1" }
       its(:filepath) { should match "spec/fixtures" }
+      its(:filetype) { should eq "fake"}
       its(:created_at) { should be }
     end
+
   end
 end

data/spec/integration_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module Mfs
   describe "Integration" do
     before do
-      Loader.load_directory('spec/fixtures/files') do |filename|
+      Entry.load_directory('spec/fixtures/files') do |filename|
         {even: (filename[-1].to_i % 2 == 0) ? true : false}
       end
     end

data/spec/types/certificate_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+module Mfs
+  module Types
+
+    describe Certificate do
+      describe "has correct filetype" do
+        before do
+          @certificate = Certificate.load_file("spec/fixtures/test.pem")
+        end
+        subject { @certificate}
+        its(:filetype) {should eq "certificate"}
+        its(:dn) { should eq "/C=US/ST=NJ/O=SoftwareWithFriends/CN=Tim"}
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mfs
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Tim Johson
@@ -84,10 +84,12 @@ files:
 - Rakefile
 - config/mongoid.yml
 - lib/mfs.rb
+- lib/mfs/can_be_created_from_files.rb
 - lib/mfs/entry.rb
-- lib/mfs/loader.rb
+- lib/mfs/types/certificate.rb
 - lib/mfs/version.rb
 - mfs.gemspec
+- spec/can_be_created_from_files_spec.rb
 - spec/entry_spec.rb
 - spec/fixtures/files/file1
 - spec/fixtures/files/file10
@@ -101,9 +103,9 @@ files:
 - spec/fixtures/files/file9
 - spec/fixtures/files/sub/file11
 - spec/integration_spec.rb
-- spec/loader_spec.rb
 - spec/mfs_spec.rb
 - spec/spec_helper.rb
+- spec/types/certificate_spec.rb
 homepage: https://github.com/SoftwareWithFriends/mfs
 licenses:
 - MIT
@@ -129,6 +131,7 @@ signing_key:
 specification_version: 4
 summary: MongoFileStore stores files in mongo.
 test_files:
+- spec/can_be_created_from_files_spec.rb
 - spec/entry_spec.rb
 - spec/fixtures/files/file1
 - spec/fixtures/files/file10
@@ -142,6 +145,6 @@ test_files:
 - spec/fixtures/files/file9
 - spec/fixtures/files/sub/file11
 - spec/integration_spec.rb
-- spec/loader_spec.rb
 - spec/mfs_spec.rb
 - spec/spec_helper.rb
+- spec/types/certificate_spec.rb

data/lib/mfs/loader.rb

@@ -1,24 +0,0 @@
-module Mfs
-  module Loader
-
-    def self.load_directory(path)
-      Dir.glob("#{path}/**/*").map do |file|
-        unless File.directory?(file)
-          additional_metadata = block_given? ? yield(file) : {}
-          load_file(file, additional_metadata)
-        end
-      end.compact!
-    end
-
-    def self.load_file(filename, additional_metadata = {})
-
-      Entry.create(
-          additional_metadata.merge(
-              data: File.read(filename),
-              filename: filename
-          )
-      )
-    end
-
-  end
-end

data/spec/loader_spec.rb

@@ -1,31 +0,0 @@
-require 'spec_helper'
-
-module Mfs
-
-  describe Loader do
-
-    describe "can load files from directory" do
-      before do
-        @files = Loader.load_directory('spec/fixtures/files') do |filename|
-          {additional_field: filename}
-        end
-      end
-      subject { @files }
-      its(:size) { should eq 11 }
-
-      specify "they should all have additional_field" do
-        @files.reject { |file| file.additional_field.match /#{file.filename}/ }.should be_empty
-      end
-
-    end
-
-    describe "can load file" do
-      before do
-        @file = Loader.load_file('spec/fixtures/files/file1')
-      end
-      subject { @file }
-      its(:data) { should eq 'This is File One' }
-    end
-  end
-
-end