outpost-aggregator 1.0.0

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/CHANGELOG.md

@@ -0,0 +1,16 @@
+### 1.0.0 (2013-06-13)
+* The method to use is now `accepts_json_input_for`, and requires 
+  a single argument: the name of the association.
+* Does not do a `published?` check anymore. That's up to you to check when
+  building the association.
+* Method to specify how to build the association is now 
+  `build_#{name.singularize}_association`. For example, if you have 
+  `accepts_json_input_for :assets`, then you should define 
+  `build_asset_association`. This is where you should do any validations
+  on the content - `published?`, `persisted?`, etc.
+
+
+### v0.1.1
+* Merge in the passed-in params (such as api token) to the params for 
+  "by_url" requests. This allows one to use their internal/private API
+  with the by_url requests.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in outpost-aggregator.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Bryan Ricker
+
+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,117 @@
+# Outpost::Aggregator
+
+Provides UI and server-side handling for building associations between
+any two objects.
+
+## Installation
+
+    gem 'outpost-aggregator'
+
+
+## Dependencies
+
+This is a pretty simple gem... you can probably get away with using this gem without Outpost. Just be sure you have a few things setup:
+
+* A client-side `window.outpost` object for the javascript.
+* `Outpost.obj_by_key` - to find an object by the passed-in object key.
+  This is defined in outpost.
+* The join model must respond to `position` and `obj_key` if you want to
+  use the SimpleJson module. This module is dead-simple, so you definitely
+  could just copy and paste its contents into your model and customize it
+  there.
+
+
+## Usage
+
+The aggregator writes a JSON string to a hidden input, and that's
+what gets submitted to and parsed by the server.
+
+In your model:
+
+```ruby
+class Post < ActiveRecord::Base
+  has_many :related_posts, order: "position", dependent: :destroy
+  accepts_json_input_for :related_posts
+end
+```
+
+In the form, you need to provide a div for the aggregator to be built in,
+the hidden input for the JSON string, and then initialize the Aggregator with
+bootstrapped content. Using simple_form, and assuming the record's association
+is called "content" (which is the default), it might look like this:
+
+```erb
+<div id="aggregator" class="aggregator"></div>
+<%= f.input :related_posts_json, as: :hidden, input_html: { id: "related_posts_json" } %>
+
+<script>
+    aggregator = new outpost.Aggregator(
+      "#aggregator", "#related_posts_json",
+      <%= j record.related_posts.includes(:post).map(&:post).to_json.html_safe %>, 
+      <%= raw options.to_json %>);
+</script>
+```
+
+You should also define an `outpost.ContentAPI`, to tell the Aggregator how to get in touch with your server.
+
+```coffee
+class outpost.ContentAPI
+
+    #-----------------------------
+
+    class @Content extends Backbone.Model
+        #----------
+        # simpleJSON is an object of just the attributes
+        # we care about for SCPRv4. Everything else will
+        # filled out server-side.
+        simpleJSON: ->
+            {
+                id:       @get 'id'
+                position: @get 'position'
+            }
+    
+    #-----------------------------
+    
+    class @ContentCollection extends Backbone.Collection
+        url: "/api/content/"
+        model: ContentAPI.Content
+            
+        #----------
+        # Sort by position attribute
+        comparator: (model) ->
+            model.get 'position'
+        
+        #----------
+        # An array of content turned into simpleJSON. See
+        # Content#simpleJSON for more.
+        simpleJSON: ->
+            contents = []
+            @each (content) -> contents.push(content.simpleJSON())
+            contents
+
+    #-----------------------------
+    
+    class @PrivateContentCollection extends @ContentCollection
+        url: "/api/private/content"
+        
+    #-----------------------------
+```
+
+Your API should have a `by_url` path, and should accept query params for 
+the search and URL import to work.
+
+See the `content_full` and `content_small` templates to see what the aggregator
+expects the response object to look.
+
+
+## TODO
+* Write tests
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+#!/usr/bin/env rake
+RAKED = true
+
+require 'bundler/setup'
+require 'rdoc/task'
+require 'rspec/core/rake_task'
+require 'combustion'
+
+Bundler.require :default, :test
+Combustion.initialize! :active_record
+Combustion::Application.load_tasks
+
+RSpec::Core::RakeTask.new(:test)
+task default: :test

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize!
+run Combustion::Application