daengine 0.0.9.alpha → 0.0.10.alpha

data/README.md

@@ -0,0 +1,64 @@
+daengine - Digital Asset File parsing and search for OFI
+========================================================
+
+daengine is a rails engine plugin gem that provides access to digital assets, aka
+SSC documents/pdfs such as fund documents from the rails applications.  It also
+includes the parser code that reads digital-asset metadata produced by the 
+Teamsite legacy CMS and ingests it into a MongoDB instance for use by the client
+API.
+
+Installation
+-----------------------
+
+To install the gem for use as a server process
+
+    $ gem install daengine
+
+To install within a rails app as an engine (for client API use)
+
+    # Use the digital-asset api
+    gem "daengine"
+
+daengine Server Process
+------------------------
+
+The server process of daengine is packaged as an executable inside the gem called
+`process_assets`.  You execute the server portion of the gem on a single-instance
+where the Teamsite tuple .xml files are accessible and you must provide a configuration
+.yml file to the executable that specifies the location of the tuple files and the 
+MongoDB connection settings ala...
+
+    $ cat config_prod.yml
+    hosts: [[prod-db1,22785], [prod-db3,22785]]
+    database: the_database_where_you_want_stuff_to_go
+    assets_path: /tmp/some/teamsite/tuple/file/dir/
+
+You then execute the server process as so:
+
+    $ process_assets config_prod.yml
+
+
+
+daengine Client API
+----------------------
+
+The data produced by the daengine server process can be consumed by any rails app
+that includes the daengine gem and has an existing Mongoid connection to the MongoDB
+database that the producer side writes to.  Client access is either directly thru
+the *DigitalAssets* model class, or via the engine-provided REST API 
+ie *http://localhost:3000/digital_assets.json*
+
+Querying for Digital Assets
+----------------------------
+
+Querying assets via the Model Class...
+
+    DigitalAsset.guid_is('/asdfasdflasdfalasdfasdfasdf.asfdasdf.foo')
+    DigitalAsset.path_is('/digitalAssets/some-crazy-guid.pdf')
+    DigitalAsset.sami_is('FOOBAR.001')
+
+Query via the REST API...
+
+    get 'http://localhost:3000/digital_assets/search?sami=FOOBAR.001'
+    get 'http://localhost:3000/digital_assets/search?funds=12345'
+

data/lib/daengine.rb

@@ -12,8 +12,9 @@ module Daengine
 
   @mongoid_config = {
     'database' => 'ssc_assets', # mongoid database name
-    'hosts' => '[foo:27017]', # mongoid server
-    # 'port' => 27017 # mongodb server port
+    'host' => nil, # mongoid server
+    'port' => nil, # mongodb server port
+    'hosts' => nil
   }
 
   @valid_mongoid_keys = @mongoid_config.keys

data/lib/daengine/version.rb

@@ -1,3 +1,3 @@
 module Daengine
-  VERSION = "0.0.9.alpha"
+  VERSION = "0.0.10.alpha"
 end

metadata

@@ -1,63 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: daengine
 version: !ruby/object:Gem::Version
-  prerelease: 6
-  version: 0.0.9.alpha
+  prerelease: 7
+  version: 0.0.10.alpha
 platform: ruby
 authors:
 - sbhatia
+- ! '@john_s_in_co'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-06-19 00:00:00.000000000Z
+date: 2012-06-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  version_requirements: &2056 !ruby/object:Gem::Requirement
+  version_requirements: &2058 !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.3
     none: false
-  requirement: *2056
+  requirement: *2058
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
   name: mongoid
-  version_requirements: &2074 !ruby/object:Gem::Requirement
+  version_requirements: &2076 !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
     none: false
-  requirement: *2074
+  requirement: *2076
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
   name: factory_girl
-  version_requirements: &2090 !ruby/object:Gem::Requirement
+  version_requirements: &2092 !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
     none: false
-  requirement: *2090
+  requirement: *2092
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  version_requirements: &2108 !ruby/object:Gem::Requirement
+  version_requirements: &2110 !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
     none: false
-  requirement: *2108
+  requirement: *2110
   prerelease: false
   type: :development
 description: Daengine handles digital asset processing.
 email:
-- samcojava@yahoo.com
+- ML-WebDevelopers@oppenheimerfunds.com
 executables:
 - process_assets
 extensions: []
@@ -83,7 +84,7 @@ files:
 - lib/tasks/daengine_tasks.rake
 - MIT-LICENSE
 - Rakefile
-- README.rdoc
+- README.md
 - Gemfile
 - spec/factories.rb
 - spec/spec_helper.rb
@@ -123,7 +124,7 @@ files:
 - spec/lib/teamsite_metadata_parser_spec.rb
 - spec/models/digital_asset_spec.rb
 - bin/process_assets
-homepage: http://www.globalizeyourthinking.com
+homepage: https://github.com/johnsinco/daengine
 licenses: []
 post_install_message:
 rdoc_options: []

data/README.rdoc

@@ -1,3 +0,0 @@
-= Daengine
-
-This project rocks and uses MIT-LICENSE.