conglomerate 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9008dac9ea7c50dfb488faa1eb897070f62499f4
-  data.tar.gz: f4260d896b2b80ca6e5581fb79eb08d212914f27
+  metadata.gz: e38daf11ae81750e9556260e06001b9c8510a7d5
+  data.tar.gz: 0c7edf5b484cbd0d4c3d3953fef6ab1cbffda34f
 SHA512:
-  metadata.gz: e8a62475f4429d00aa29ab15dcc08affc5bf18444f57e50e2efa37c892111de6b173008f4504bf3ddd76931e3999a7450cbdce972b7f9bba2185dbacf5c24c82
-  data.tar.gz: e4dc81daac27fed5f17bdc1b3796a1f638c164bffe02a30f9cc13bdb66bb4e785c22aa8dc5e797793d4d4fff48d4f7004855a51cd656f0ff640cfa71ce63db25
+  metadata.gz: 97da55cdc7a6e5128d2317779d3e44a4339a7fc11e7d09c1e2d34cf56449778062adec8dc8ed5a1cfa838e78803ce3669626ab73efb705a3f55b74f5770c669c
+  data.tar.gz: 3a7d31e8647b1d367b8cebc6039dd1547d1fe03dad3fca2fd32f04e8521b10947eefc1db46310fa8a8b6d60f4ae62804418faba9755c4db284fd15a63b2fe879

data/Gemfile

@@ -1,3 +1,5 @@
 source "https://rubygems.org"
 
+gem "coveralls", :require => false
+
 gemspec

data/README.md

@@ -1,6 +1,8 @@
 # Conglomerate
 
 [![Gem Version](https://badge.fury.io/rb/conglomerate.png)](http://badge.fury.io/rb/conglomerate)
+[![Semaphore](https://semaphoreapp.com/api/v1/projects/7b914dac-6aa6-43dd-94a9-53698ef1922a/120842/shields_badge.png
+)](https://semaphoreapp.com/minter/conglomerate)
 [![Code Climate](https://codeclimate.com/github/teamsnap/conglomerate.png)](https://codeclimate.com/github/teamsnap/conglomerate)
 [![Coverage Status](https://coveralls.io/repos/teamsnap/conglomerate/badge.png?branch=master)](https://coveralls.io/r/teamsnap/conglomerate?branch=master)
 [![Dependency Status](https://gemnasium.com/teamsnap/conglomerate.png)](https://gemnasium.com/teamsnap/conglomerate)
@@ -10,6 +12,11 @@ A library to serialize Ruby objects into collection+json.
 
 ![conglomerate](http://i.imgur.com/QkKZ0ru.jpg)
 
+This library focuses just on converting Ruby objects into Collection+JSON. It
+aims to have the simplest format possible when constructing serializers
+specific to Collection+JSON. It also tries to provide all common
+Collection+JSON extensions to make it easy to create your API.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -27,9 +34,90 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-# TODO
+# Step 1: Create a serializer
+class TeamSerializer
+  include Conglomerate.serializer
+
+  href { teams_url }
+  item_href { |item| team_url(item.id) }
+
+  attribute :id
+  attribute :name, :template => true
+  attribute :event_ids, :rel => :events { |item| event_url(item.event_ids.join(",")) }
+
+  link :root { root_url }
+
+  query :search, :data => :id { search_teams_url }
+end
+
+# Step 2: Serialize any object
+
+class TeamsController < ApplicationController
+  def index
+    teams = [
+      OpenStruct.new(:id => 1, :name => "Team 01", :event_ids => [1,2,3]),
+      OpenStruct.new(:id => 2, :name => "Team 02", :event_ids => [4,5,6]),
+    ]
+    render :json => TeamSerializer.new(teams, :context => self).serialize
+  end
+end
+
+# Note, context is optional. It allows you to call helper methods such as url helpers easily inside the serializer.
+```
+
+```json
+{
+  "collection": {
+    "href": "http://example.com/teams",
+    "items": [
+      {
+        "href": "http://example.com/teams/1",
+        "data": [
+          {"name": "id", "value": 1},
+          {"name": "name", "value": "Team 01"},
+          {"name": "event_ids", "value": [1,2,3]}
+        ],
+        "links": [
+          {"rel": "events", "href": "http://example.com/events/1,2,3"}
+        ]
+      },
+      {
+        "href": "http://example.com/teams/2",
+        "data": [
+          {"name": "id", "value": 2},
+          {"name": "name", "value": "Team 2"},
+          {"name": "event_ids", "value": [4,5,6]}
+        ],
+        "links": [
+          {"rel": "events", "href": "http://example.com/events/4,5,6"}
+        ]
+      }
+    ],
+    "links": [
+      {"rel": "root", "href": "http://example.com"}
+    ],
+    "queries": [
+      {
+        "rel": "search",
+        "href": "http://example.com/teams/search",
+        "data": [
+          {"name": "id", "value": ""}
+        ]
+      }
+    ],
+    "template": {
+      "data": [
+        {"name": "name", "value": ""}
+      ]
+    }
+  }
+}
 ```
 
+## Roadmap
+
+- Use more defaults to simplify the creation of serializers.
+
 ## Contributing
 
 1. Fork it ( http://github.com/teamsnap/conglomerate/fork )

data/lib/conglomerate/serializer.rb

@@ -106,7 +106,7 @@ module Conglomerate
     def apply_links(collection, links: self.class._links, object: nil)
       if object && !links.empty?
         links = links.map do |link|
-          if object.send(link[:name])
+          if present?(object.send(link[:name]))
             build_item_link(
               link[:rel], :proc => link[:block], :object => object
             )
@@ -147,6 +147,18 @@ module Conglomerate
       apply_href(link, :proc => proc, :object => object)
     end
 
+    def blank?(value)
+      if value.is_a?(String)
+        value !~ /[^[:space:]]/
+      else
+        value.respond_to?(:empty?) ? value.empty? : !value
+      end
+    end
+
+    def present?(value)
+      !blank?(value)
+    end
+
     module ClassMethods
       def href(&block)
         self._href = block

data/lib/conglomerate/version.rb

@@ -1,3 +1,3 @@
 module Conglomerate
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/conglomerate_spec.rb

@@ -18,6 +18,9 @@ class ConglomerateTestSerializer
   attribute :team_ids, :rel => :teams do |item|
     team_url(item.team_ids.join(","))
   end
+  attribute :user_ids, :rel => :users do |item|
+    user_url(item.user_ids.join(","))
+  end
 
   link :events do
     events_url
@@ -46,7 +49,8 @@ describe Conglomerate do
       :description => "Tasty Burgers",
       :event_id => 2,
       :roster_id => nil,
-      :team_ids => [1,2]
+      :team_ids => [1,2],
+      :user_ids => []
     )
   end
 
@@ -152,7 +156,8 @@ describe Conglomerate do
                 {"name" => "id", "value" => 1},
                 {"name" => "event_id", "value" => 2},
                 {"name" => "roster_id", "value" => nil},
-                {"name" => "team_ids", "value" => [1,2]}
+                {"name" => "team_ids", "value" => [1,2]},
+                {"name" => "user_ids", "value" => []}
               ],
               "links" => [
                 {"rel" => "event", "href" => "https://example.com/events/2"},

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require "coveralls"
+Coveralls.wear!
+
 RSpec.configure do |config|
   config.order = "random"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: conglomerate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Shane Emmons
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-30 00:00:00.000000000 Z
+date: 2013-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler