conglomerate 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35e29cbdebf5437c615db1edc75d9b24accf5494
-  data.tar.gz: d9061aea37cc1b044ff55a23767d418311b8ba1d
+  metadata.gz: c59715a987bfcf05b5005344ef0c1a72330193a9
+  data.tar.gz: 5fdd51b3702d7a807473064c048351ff411c73af
 SHA512:
-  metadata.gz: 0a90ff5aec3808eb7fa85e6177c9b0342d6ccd6b492cd23650b38026dc0d3a3c03996127781d54bdfc5b9c321d34dcd616c339689bfecfc78b9e7a5b45fed3d9
-  data.tar.gz: 904ba11b106db17f93037080ec86627f6e0376a92f57c0c78e6cc4992236a40c57f1f7ba133be0c7efddf59c7ad92062d39f61b4f2344cd5c4ea10d4263084ab
+  metadata.gz: b9255df416476d667a41e07d141aa613ae57704c59b798f501df9c61bb3d779e566ce0383d2a4eaae4c880ae99d84cf5a4284788e9a4db8b2ab4c7cac306eeb7
+  data.tar.gz: e40f478b4a9d83bc8bd697cba3c666608cd30e494a2855a5809a6440dda256fcf2c447e82a3258a172845afa0dad7100351ee3ec2db2a666d5a0117a24469248

data/README.md

@@ -48,6 +48,8 @@ class TeamSerializer
   link :root { root_url }
 
   query :search, :data => :id { search_teams_url }
+
+  command :populate, :data => :id { populate_teams_url }
 end
 
 # Step 2: Serialize any object
@@ -105,6 +107,15 @@ end
         ]
       }
     ],
+    "commands": [
+      {
+        "rel": "populate",
+        "href": "http://example.com/teams/populate",
+        "data": [
+          {"name": "id", "value": ""}
+        ]
+      }
+    ],
     "template": {
       "data": [
         {"name": "name", "value": ""}

data/lib/conglomerate.rb

@@ -8,6 +8,7 @@ require_relative "conglomerate/datum"
 require_relative "conglomerate/template"
 require_relative "conglomerate/item"
 require_relative "conglomerate/query"
+require_relative "conglomerate/command"
 require_relative "conglomerate/collection"
 require_relative "conglomerate/tree_deserializer"
 

data/lib/conglomerate/collection.rb

@@ -11,5 +11,6 @@ module Conglomerate
     array :items, :contains => Item
     array :links, :contains => Link
     array :queries, :contains => Query
+    array :commands, :contains => Command
   end
 end

data/lib/conglomerate/command.rb

@@ -0,0 +1,12 @@
+module Conglomerate
+  class Command
+    include Conglomerate::Particle
+
+    attribute :href, :type => String, :required => true
+    attribute :rel, :type => String, :required => true
+    attribute :name, :type => String
+    attribute :prompt, :type => String
+
+    array :data, :contains => Datum
+  end
+end

data/lib/conglomerate/serializer.rb

@@ -22,7 +22,7 @@ module Conglomerate
     attr_accessor :objects, :context
 
     def actions
-      [:version, :href, :queries, :items, :template, :links]
+      [:version, :href, :queries, :commands, :items, :template, :links]
     end
 
     def apply_version(collection)
@@ -78,6 +78,20 @@ module Conglomerate
       end
     end
 
+    def apply_commands(collection)
+      commands = self.class._commands.map do |command|
+        build_command(
+          command[:rel], command[:data], command[:prompt], command[:block]
+        )
+      end
+
+      if commands.empty?
+        collection
+      else
+        collection.merge({"commands" => commands})
+      end
+    end
+
     def apply_items(collection)
       items = objects.map do |object|
         item = {}
@@ -166,6 +180,13 @@ module Conglomerate
       apply_data(query, :data => data, :default_value => "")
     end
 
+    def build_command(rel, data, prompt, block)
+      command = {"rel" => rel.to_s}
+      command = apply_href(command, :proc => block)
+      command["prompt"] = prompt if prompt
+      apply_data(command, :data => data, :default_value => "")
+    end
+
     def build_item_link(rel, proc: nil, object: nil)
       link = {"rel" => rel.to_s}
       apply_href(link, :proc => proc, :object => object)
@@ -229,6 +250,14 @@ module Conglomerate
         }
       end
 
+      def command(rel, data: [], prompt: nil, &block)
+        data = [*data]
+        data = data.map { |datum| {:name => datum} }
+        self._commands = self._commands << {
+          :rel => rel, :data => data, :prompt => prompt, :block => block
+        }
+      end
+
       def attribute(
         name, template: false, rel: nil, type: :value, prompt: nil, &block
       )
@@ -257,7 +286,7 @@ module Conglomerate
       end
 
       attr_writer :_href, :_item_href, :_queries, :_attributes, :_links,
-        :_item_links, :_templates
+        :_item_links, :_templates, :_commands
 
       def _href
         @_href || nil
@@ -271,6 +300,10 @@ module Conglomerate
         @_queries || []
       end
 
+      def _commands
+        @_commands || []
+      end
+
       def _attributes
         @_attributes || []
       end

data/lib/conglomerate/tree_deserializer.rb

@@ -1,6 +1,8 @@
 module Conglomerate
   class TreeDeserializer
-    PARTICLES = [Collection, Item, Error, Template, Datum, Query, Item]
+    PARTICLES = [
+      Collection, Item, Error, Template, Datum, Query, Command, Item
+    ]
 
     def initialize(object)
       self.object = object
@@ -26,7 +28,7 @@ module Conglomerate
         end
       end
 
-      particle = klass.new(attributes)
+      klass.new(attributes)
     end
 
     def deserialize_attribute(attribute, attr_metadata)

data/lib/conglomerate/version.rb

@@ -1,3 +1,3 @@
 module Conglomerate
-  VERSION = "0.8.1"
+  VERSION = "0.9.0"
 end

data/spec/collection_spec.rb

@@ -37,4 +37,16 @@ describe Conglomerate::Collection do
       expect(Conglomerate.serialize(collection)["queries"]).to include(Conglomerate.serialize(query))
     end
   end
+
+  context "commands" do
+    it "serializes commands correctly" do
+      command = Conglomerate::Command.new(
+        :href => "http://this.is.a.command",
+        :rel => "Something"
+      )
+
+      collection.commands << command
+      expect(Conglomerate.serialize(collection)["commands"]).to include(Conglomerate.serialize(command))
+    end
+  end
 end

data/spec/command_spec.rb

@@ -0,0 +1,30 @@
+require_relative "spec_helper"
+require_relative "../lib/conglomerate"
+
+describe Conglomerate::Command do
+  let(:command) {
+    Conglomerate::Command.new(
+      :href => "http://this.is.a.command/",
+      :rel => "some_command"
+    )
+  }
+
+  context "required attributes" do
+    specify "href" do
+      expect { Conglomerate::Command.new(:rel => "") }.to raise_error("MissingAttribute")
+    end
+
+    specify "rel" do
+      expect { Conglomerate::Command.new(:href => "") }.to raise_error("MissingAttribute")
+    end
+  end
+
+  context "data" do
+    it "serializes properly" do
+      datum = Conglomerate::Datum.new(:name => "name")
+
+      command.data << datum
+      expect(Conglomerate.serialize(command)["data"]).to include(Conglomerate.serialize(datum))
+    end
+  end
+end

data/spec/conglomerate_spec.rb

@@ -34,6 +34,10 @@ class ConglomerateTestSerializer
     search_items_url
   end
 
+  command :populate, :data => :id, :prompt => "test 123" do
+    populate_items_url
+  end
+
   template :repeats, :prompt => "true|false"
 end
 
@@ -70,6 +74,7 @@ describe Conglomerate do
       "Context",
       :request => request,
       :search_items_url => "https://example.com/items/search",
+      :populate_items_url => "https://example.com/items/populate",
     ).tap do |context|
       allow(context).to receive(:item_url).with(1) {
         "https://example.com/items/1"
@@ -145,6 +150,27 @@ describe Conglomerate do
     end
   end
 
+  describe "#command" do
+    it "doesn't include any command templates if none are provided" do
+      expect(null_collection.keys).to_not include("commands")
+    end
+
+    it "adds a command template to the collection" do
+      expect(test_collection["commands"]).to match_array(
+        [
+          {
+            "href" => "https://example.com/items/populate",
+            "rel" => "populate",
+            "prompt" => "test 123",
+            "data" => [
+              {"name" => "id", "value" => ""}
+            ]
+          }
+        ]
+      )
+    end
+  end
+
   describe "#attribute(s)" do
     context "items" do
       it "skips items if there are no attributes" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: conglomerate
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Shane Emmons
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-19 00:00:00.000000000 Z
+date: 2014-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,6 +69,7 @@ files:
 - lib/conglomerate.rb
 - lib/conglomerate/array.rb
 - lib/conglomerate/collection.rb
+- lib/conglomerate/command.rb
 - lib/conglomerate/datum.rb
 - lib/conglomerate/error.rb
 - lib/conglomerate/item.rb
@@ -82,6 +83,7 @@ files:
 - lib/conglomerate/tree_serializer.rb
 - lib/conglomerate/version.rb
 - spec/collection_spec.rb
+- spec/command_spec.rb
 - spec/conglomerate_spec.rb
 - spec/datum_spec.rb
 - spec/link_spec.rb
@@ -115,6 +117,7 @@ specification_version: 4
 summary: A library to serialize Ruby objects into collection+json
 test_files:
 - spec/collection_spec.rb
+- spec/command_spec.rb
 - spec/conglomerate_spec.rb
 - spec/datum_spec.rb
 - spec/link_spec.rb