daengine 0.6.16 → 0.6.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be941fa075d96ebe4ee85610fd0563907f8c1ff0
-  data.tar.gz: dc26c4412fabc9f45338fac32dc0bf7bb81894d7
+  metadata.gz: fc3d0461ac1c9337ae22dbdf014261e342f8ff2d
+  data.tar.gz: db9e2cb957aed90668d113cde843e1cd66d05e3a
 SHA512:
-  metadata.gz: b4c300c613aa619b193c91c603f372d48f2bc1fdf63fbe30f8fd802c1812854ce31ecab0de42b9761d96b4449c915e8afeadb623849755b7b457cd63cb46ef6a
-  data.tar.gz: 6ebeafeab9bd53bec379713ffb22b916aaa788af04717002a33e8691a45b4a87b42306a9ad082c52bcf94c7db9e3a0037a5c37dfea674ed8dec93076cef1af77
+  metadata.gz: 3ec076eec326d72752ce4de5b7b2764257d7581ade1380ec116f23ef4594946b0b07dd9b64bdb72153e9b6e4bf2ac031f431a19112990e09f245624e1cf609f5
+  data.tar.gz: 772e62c3bc2a8141a54d416f5c70bbe9271736b7143605b7f3d4a73482ce70cb69d5c44e1cfe5942958e8f43c592fe5e7d461b772506f59b7bd8b68a4fcc1e55

data/app/controllers/content_folder_controller.rb

@@ -0,0 +1,30 @@
+class ContentFolderController < ApplicationController
+  respond_to :json
+
+  rescue_from 'Mongoid::Errors::DocumentNotFound' do |exception|
+    render json: {errors: [exception.message]}, status: 404
+  end
+
+  # GET /content_folder
+  # GET /content_folder.json
+  def index
+    content_folder = ContentFolder.last
+    if content_folder.nil?
+      render json: {}, status: :not_found
+    else
+      render json: content_folder
+    end
+  end
+
+  # POST /content_folder
+  # POST /content_folder.json
+  def create
+    content_folder = ContentFolder.new(params[:content_folder])
+    ContentFolder.delete_all # TODO:  need to validate prior to delete
+    if content_folder.save
+      render json: content_folder, status: :created
+    else
+      render json: content_folder.errors, status: :unprocessable_entity
+    end
+  end
+end

data/app/controllers/digital_assets_controller.rb

@@ -48,12 +48,12 @@ class DigitalAssetsController < ApplicationController
   end
 
   def updated_time
-    ids = params[:ids]
-    updated_time = Hash.new
-    ids.each do |id|
-      da = DigitalAsset.where(:digital_asset_id => id) 
-      updated_time[id] = da[0].doc_changed_at if da.present?
+    if(params[:ids].present?)
+      assets = DigitalAsset.where(:digital_asset_id.in => params[:ids])  
+    else
+      assets = DigitalAsset.all
     end
+    updated_time = Hash[assets.map{|a| [a.digital_asset_id, a.doc_changed_at]}]
     render json: updated_time.to_json, status: :ok
   end  
 

data/app/models/content_folder.rb

@@ -0,0 +1,49 @@
+require 'mongoid'
+
+class ContentFolder
+  include Mongoid::Document
+  #include Mongoid::Timestamps
+
+  field :folder_id, type: String
+  field :label, type: String
+  field :document_ids, type: Array, default: []
+
+  #recursively_embeds_many
+  embeds_many :child_folders, :class_name => "ContentFolder", :cyclic => true
+  accepts_nested_attributes_for :child_folders
+
+  key :folder_id
+
+  validates_presence_of :folder_id, :label
+  validate :validate_has_content
+
+  def validate_has_content
+    if child_folders.empty? && (document_ids.nil? || document_ids.empty?)
+      errors[:base] << 'Either child_folders or document_ids are required'
+    end
+  end
+
+  def self.lit_center_folder
+    find_folder(FolderIds::LIT_CENTER)
+  end
+
+  def self.merrill_lynch_folder
+    find_folder(FolderIds::MERRILL_LYNCH)
+  end
+
+  def self.plan_529_folder
+    find_folder(FolderIds::PLANS_529)
+  end
+
+  def self.find_folder(id)
+    root = ContentFolder.last
+    child_folders = root.nil? ? [] : Array(root.child_folders)
+    child_folders.find { |folder| id == folder.folder_id } unless child_folders.nil?
+  end
+end
+
+class ContentFolder::FolderIds
+  LIT_CENTER = 'lit_center'
+  MERRILL_LYNCH = 'merrill_lynch'
+  PLANS_529 = '529'
+end

data/config/routes.rb

@@ -1,5 +1,5 @@
 Rails.application.routes.draw do
-  resources :digital_assets, except: [:new, :edit], defaults: {format: 'json'} do 
+  resources :digital_assets, except: [:new, :edit], defaults: {format: 'json'} do
     collection do
       get 'fund_docs'
       get 'search', to: 'digital_assets#search'
@@ -7,4 +7,6 @@ Rails.application.routes.draw do
       post 'updated_time'
     end
   end
+
+  resources :content_folder, only: [:index, :create], defaults: {format: 'json'}
 end

data/lib/daengine/version.rb

@@ -1,3 +1,3 @@
 module Daengine
-  VERSION = "0.6.16"
+  VERSION = "0.6.17"
 end

data/spec/acceptance/content_folder_controller_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+require 'rspec_api_documentation'
+require 'rspec_api_documentation/dsl'
+require 'securerandom'
+
+resource 'Content Folder', :api => true do
+  get '/content_folder' do
+    context 'has a content folder' do
+      example 'returns the content folder' do
+        folder_id = 'folder id'
+        folder = ContentFolder.new(:folder_id => folder_id, :label => 'folder label', :document_ids => %w(id1 id2))
+        ContentFolder.stub(:last).and_return(folder)
+
+        do_request
+        expect(status).to eq(200)
+        result = JSON.parse(response_body)
+        expect(result).not_to be_nil
+        expect(result['folder_id']).to eq(folder_id)
+      end
+
+      example 'returns 404 when the folder does not exist' do
+        ContentFolder.stub(:last).and_return(nil)
+
+        do_request
+        expect(status).to eq(404)
+      end
+    end
+  end
+
+  post '/content_folder' do
+    parameter :folder_id, 'folder id', :require => true, :scope => 'content_folder'
+    parameter :label, 'folder label', :require => true, :scope => 'content_folder'
+    parameter :document_ids, 'array of document ids associated with folder', :require => true, :scope => 'content_folder'
+    parameter :child_folders, 'array of child folder hashes', :require => true, :scope => 'content_folder'
+
+    context 'successful' do
+      folder_id = 'folder id'
+      label = 'label'
+      document_ids = %w(id1 id2)
+      child_folders = nil
+
+      let(:folder_id) { folder_id }
+      let(:label) { label }
+      let(:document_ids) { document_ids }
+      let(:child_folders) { [{:folder_id => 'child folder id', :label => 'child label', :document_ids => document_ids}] }
+
+      example 'stores the content folder and returns the content folder instance' do
+        do_request
+        expect(status).to eq(201)
+        result = JSON.parse(response_body)
+        expect(result).not_to be_nil
+      end
+    end
+
+    context 'missing required values' do
+      folder_id = 'folder id'
+      label = 'label'
+      document_ids = nil
+      child_folders = nil
+
+      let(:folder_id) { folder_id }
+      let(:label) { label }
+      let(:document_ids) { document_ids }
+      let(:child_folders) { child_folders }
+
+      example 'returns status 422 when missing document id and child_folders' do
+        do_request
+        expect(status).to eq(422)
+      end
+    end
+  end
+end

data/spec/factories.rb

@@ -37,4 +37,22 @@ FactoryGirl.define do
     fund_codes []
     display_on_website true
   end
+
+  factory :content_folder, aliases: [:child_folder] do
+    sequence(:folder_id) { |n| "id-content-folder-#{n}" }
+    label 'Folder Label'
+
+    trait :document_ids do
+      document_ids ['doc_id1', 'doc_id2']
+    end
+
+    factory :content_folder_with_child_folders do
+      sequence(:folder_id) { |n| "id-content-folder-#{n}" }
+      label 'Root Label'
+
+      child_folders { build_list(:content_folder, 1, document_ids: ['child_doc_id']) }
+    end
+
+    factory :content_folder_with_document_ids, traits: [:document_ids]
+  end
 end

data/spec/models/content_folder_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe ContentFolder do
+
+  context 'fields' do
+    subject { FactoryGirl.build :content_folder }
+
+    let(:defined_fields) {
+      [:folder_id, :label, :document_ids, :child_folders]
+    }
+    it 'has all defined fields' do
+      defined_fields.each { |f| should respond_to(f) }
+    end
+  end
+
+  context 'validation' do
+    subject { FactoryGirl.build :content_folder_with_document_ids }
+    let(:basic_subject) { FactoryGirl.build :content_folder }
+    let(:subject_with_folders) { FactoryGirl.build :content_folder_with_child_folders }
+
+    required_fields = [:folder_id, :label]
+    required_fields.each do |f|
+      it "validates #{f} is required" do
+        should be_valid
+        subject.send("#{f}=", nil)
+        should be_invalid "should be invalid if #{f} is missing"
+      end
+    end
+
+    it 'cannot have empty child_folders AND document_ids' do
+      basic_subject.should be_invalid
+    end
+
+    it 'is valid when document_ids are present' do
+      subject.should be_valid
+    end
+
+    it 'is valid when child_folders are present' do
+      subject_with_folders.should be_valid
+    end
+  end
+
+  context 'selectors' do
+    subject { FactoryGirl.build :content_folder_with_document_ids }
+
+    # TODO:  add tests for known ids
+  end
+
+  context 'db operations' do
+    let(:subject_with_folders) { FactoryGirl.build :content_folder_with_child_folders }
+
+    it 'saves and can be retrieved' do
+      id = subject_with_folders.folder_id
+      subject_with_folders.save
+      found = ContentFolder.find(id)
+      found.should_not be_nil
+    end
+  end
+
+  context 'folder retrieval' do
+    before do
+      ContentFolder.delete_all
+      root = FactoryGirl.build :content_folder_with_document_ids
+      lit_center = FactoryGirl.build :content_folder_with_document_ids, :folder_id => ContentFolder::FolderIds::LIT_CENTER
+      merrill_lynch = FactoryGirl.build :content_folder_with_document_ids, :folder_id => ContentFolder::FolderIds::MERRILL_LYNCH
+      plan_529 = FactoryGirl.build :content_folder_with_document_ids, :folder_id => ContentFolder::FolderIds::PLANS_529
+      other = FactoryGirl.build :content_folder_with_document_ids, :folder_id => 'abcdefg'
+      root.child_folders = [lit_center, merrill_lynch, plan_529, other]
+      root.save
+    end
+
+    it 'should return the lit center folder' do
+      result = ContentFolder.lit_center_folder
+      result.should_not be_nil
+      result.folder_id.should == ContentFolder::FolderIds::LIT_CENTER
+    end
+
+    it 'should return the merrill lynch folder' do
+      result = ContentFolder.merrill_lynch_folder
+      result.should_not be_nil
+      result.folder_id.should == ContentFolder::FolderIds::MERRILL_LYNCH
+    end
+
+    it 'should return the 529 folder' do
+      result = ContentFolder.plan_529_folder
+      result.should_not be_nil
+      result.folder_id.should == ContentFolder::FolderIds::PLANS_529
+    end
+
+    it 'should return nil for an unknown folder' do
+      result = ContentFolder.find_folder('zyxw')
+      result.should be_nil
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: daengine
 version: !ruby/object:Gem::Version
-  version: 0.6.16
+  version: 0.6.17
 platform: ruby
 authors:
 - sbhatia
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-02-26 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -147,8 +147,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- app/controllers/content_folder_controller.rb
 - app/controllers/digital_assets_controller.rb
 - app/helpers/digital_assets_helper.rb
+- app/models/content_folder.rb
 - app/models/content_service_resource.rb
 - app/models/digital_asset.rb
 - app/models/service_digital_asset.rb
@@ -177,6 +179,7 @@ files:
 - Gemfile
 - spec/factories.rb
 - spec/spec_helper.rb
+- spec/acceptance/content_folder_controller_spec.rb
 - spec/acceptance/digital_assets_spec.rb
 - spec/controllers/digital_assets_controller_spec.rb
 - spec/dummy/config.ru
@@ -236,6 +239,7 @@ files:
 - spec/mock_data/digitalAssets/TEST_FINRA_DOC.doc
 - spec/mock_data/taxonomy/taxonomy.xml
 - spec/mock_data/taxonomy/taxonomyengine.yml
+- spec/models/content_folder_spec.rb
 - spec/models/digital_asset_spec.rb
 - spec/models/service_digital_asset_spec.rb
 - spec/service/digital_asset_lookup_service_spec.rb
@@ -268,6 +272,7 @@ summary: Daengine GEM.
 test_files:
 - spec/factories.rb
 - spec/spec_helper.rb
+- spec/acceptance/content_folder_controller_spec.rb
 - spec/acceptance/digital_assets_spec.rb
 - spec/controllers/digital_assets_controller_spec.rb
 - spec/dummy/config.ru
@@ -327,6 +332,7 @@ test_files:
 - spec/mock_data/digitalAssets/TEST_FINRA_DOC.doc
 - spec/mock_data/taxonomy/taxonomy.xml
 - spec/mock_data/taxonomy/taxonomyengine.yml
+- spec/models/content_folder_spec.rb
 - spec/models/digital_asset_spec.rb
 - spec/models/service_digital_asset_spec.rb
 - spec/service/digital_asset_lookup_service_spec.rb