braque 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 695090ace904e767afca4305c5f8ee985d57081f
-  data.tar.gz: 3f2507fd0e00192d70753abf29fdc9dcf60fcceb
+  metadata.gz: dab5d5d54312bfdbc5dd8893a06e73b82efced16
+  data.tar.gz: e0ee2e72c8075d1c754fbe25492c439cc6aec1d5
 SHA512:
-  metadata.gz: d381d640d339f61c5125d7ee44bb0435c177710e5f0a0737585fbb8c324d8a11663ae1a88d19e1b0605a8f95288c3ac069aa405596fb071aaf08aa4955cead3d
-  data.tar.gz: dbae5083decd83a6a31d8d30431ebdc03a3925e50e6594a7c3d48ff4d14665079cc518192a5eca6cc92c76eb4d6123aa1c1d8f4c1f1df9d3a6e833bf2be18237
+  metadata.gz: a48933aecf76a78a67bc9704ee3a5fe740be0507ec29d61f10ed6b643cb8a29d7afb8cbdc064c25b542b254a71521ac45c910bcddb053e9f5ece5abf885149c1
+  data.tar.gz: 83f22620eb6fc152e500a9236f9605f0acab47310c27b94fd6947c9e924f3f94b5386b1ba88bd91dd06baf30553db36edaa5e9383955dee49a2f41c91b847a25

data/lib/braque/helpers/hypermedia_responses_helper.rb

@@ -1,16 +1,18 @@
 module Braque
   module Helpers
     module HypermediaResponsesHelper
-      def hypermedia_root_json_for(hyperclient_model_class)
+      def hypermedia_root_json_for(hyperclient_model_class, options = {})
+        collection_query_options = options[:collection_query] || '{?page,size}'
+        resource_path_options = options[:resource_path] || '{id}'
         root_hash = {}
         root_hash[:_links] = {}
         root_hash[:_links][:self] = { href: hyperclient_model_class.api_root }
-        root_hash[:_links][hyperclient_model_class.collection_method_name] = { href: "#{hyperclient_model_class.api_root}/#{hyperclient_model_class.collection_method_name}{?page,size}", templated: true }
-        root_hash[:_links][hyperclient_model_class.instance_method_name] = { href: "#{hyperclient_model_class.api_root}/#{hyperclient_model_class.collection_method_name}/{id}", templated: true }
+        root_hash[:_links][hyperclient_model_class.collection_method_name] = { href: "#{hyperclient_model_class.api_root}/#{hyperclient_model_class.collection_method_name}#{collection_query_options}", templated: true }
+        root_hash[:_links][hyperclient_model_class.instance_method_name] = { href: "#{hyperclient_model_class.api_root}/#{hyperclient_model_class.collection_method_name}/#{resource_path_options}", templated: true }
         JSON.parse root_hash.to_json
       end
 
-      def hypermedia_collection_json_for(hyperclient_model_collection)
+      def hypermedia_collection_json_for(hyperclient_model_collection, options = {})
         hyperclient_model = hyperclient_model_collection.first
         collection_hash = {}
         collection_hash[:total_count] = 1
@@ -21,30 +23,32 @@ module Braque
         collection_hash[:_links][:next] = { href: "#{hyperclient_model_collection.first.class.api_root}/#{hyperclient_model_collection.first.class.collection_method_name}" }
         collection_hash[:_links][:prev] = { href: "#{hyperclient_model_collection.first.class.api_root}/#{hyperclient_model_collection.first.class.collection_method_name}" }
         collection_hash[:_embedded] = {}
-        collection_hash[:_embedded][hyperclient_model_collection.first.class.collection_method_name] = embedded_elements_for_collection(hyperclient_model_collection)
+        collection_hash[:_embedded][hyperclient_model_collection.first.class.collection_method_name] = embedded_elements_for_collection(hyperclient_model_collection, options)
         JSON.parse collection_hash.to_json
       end
 
-      def hypermedia_resource_json_for(hyperclient_model)
-        resource_hash = embedded_element(hyperclient_model)
+      def hypermedia_resource_json_for(hyperclient_model, options = {})
+        resource_hash = embedded_element(hyperclient_model, options)
         JSON.parse resource_hash.to_json
       end
 
-      def embedded_elements_for_collection(hyperclient_model_collection)
+      def embedded_elements_for_collection(hyperclient_model_collection, options = {})
         embedded_elements = []
         hyperclient_model_collection.each do |model|
-          embedded_elements << embedded_element(model)
+          embedded_elements << embedded_element(model, options)
         end
         embedded_elements
       end
 
-      def embedded_element(model)
+      def embedded_element(model, options = {})
+        resource_path_str = eval(options[:resource_path].to_s) if options[:resource_path]
+        resource_path = resource_path_str || model.id
         hyperclient_element = {}
         model.attributes.keys.each do |key|
           hyperclient_element[key] = model.send(key)
         end
         hyperclient_element[:_links] = {}
-        hyperclient_element[:_links][:self] = { href: "#{model.class.api_root}/#{model.class.collection_method_name}/#{model.id}" }
+        hyperclient_element[:_links][:self] = { href: "#{model.class.api_root}/#{model.class.collection_method_name}/#{resource_path}" }
         hyperclient_element
       end
     end

data/lib/braque/version.rb

@@ -1,3 +1,3 @@
 module Braque
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/spec/braque/helpers/hypermedia_responses_helper_spec.rb

@@ -5,6 +5,8 @@ RSpec.describe Braque::Helpers::HypermediaResponsesHelper do
   include Braque::Helpers::HypermediaResponsesHelper
 
   context 'with a Braque::Model class' do
+    let(:article) { Article.new(id: 1, title: 'Sculpture in the Expanded Field', key: 'october-spring-1979') }
+
     before(:all) do
       class Article
         include ::Braque::Model
@@ -12,69 +14,132 @@ RSpec.describe Braque::Helpers::HypermediaResponsesHelper do
         self.api_token = 'replace-me'
         attribute :id
         attribute :title
+        attribute :key
       end
     end
 
     context 'hypermedia_root_json_for' do
-      before(:each) do
-        @root_json = hypermedia_root_json_for Article
-      end
+      context 'defaults' do
+        before(:each) do
+          @root_json = hypermedia_root_json_for Article
+        end
 
-      it 'returns the self link' do
-        expect(@root_json['_links']['self']['href']).to eq Article.api_root
-      end
+        it 'returns the self link' do
+          expect(@root_json['_links']['self']['href']).to eq Article.api_root
+        end
 
-      it 'returns the collection link' do
-        expect(@root_json['_links']['articles']['href']).to eq "#{Article.api_root}/articles{?page,size}"
+        it 'returns the collection link' do
+          expect(@root_json['_links']['articles']['href']).to eq "#{Article.api_root}/#{Article.collection_method_name}{?page,size}"
+        end
+
+        it 'returns the resource link' do
+          expect(@root_json['_links']['article']['href']).to eq "#{Article.api_root}/#{Article.collection_method_name}/{id}"
+        end
       end
+      context 'options' do
+        before(:each) do
+          @root_json = hypermedia_root_json_for Article, collection_query: '{?page}', resource_path: '{id}?key={key}'
+        end
+
+        it 'returns the self link' do
+          expect(@root_json['_links']['self']['href']).to eq Article.api_root
+        end
 
-      it 'returns the resource link' do
-        expect(@root_json['_links']['article']['href']).to eq "#{Article.api_root}/articles/{id}"
+        it 'returns the collection link using the collection_query option' do
+          expect(@root_json['_links']['articles']['href']).to eq "#{Article.api_root}/#{Article.collection_method_name}{?page}"
+        end
+
+        it 'returns the resource link using the resource_path option' do
+          expect(@root_json['_links']['article']['href']).to eq "#{Article.api_root}/#{Article.collection_method_name}/{id}?key={key}"
+        end
       end
     end
 
     context 'hypermedia_collection_json_for' do
-      before(:each) do
-        @article = Article.new(id: 1, title: 'Sculpture in the Expanded Field')
-        @collection_json = hypermedia_collection_json_for [@article]
-      end
+      context 'defaults' do
+        before(:each) do
+          @collection_json = hypermedia_collection_json_for [article]
+        end
 
-      it 'returns the _links node' do
-        expect(@collection_json['_links']['self']['href']).to eq "#{Article.api_root}/articles"
-        expect(@collection_json['_links']['next']['href']).to eq "#{Article.api_root}/articles"
-        expect(@collection_json['_links']['prev']['href']).to eq "#{Article.api_root}/articles"
-      end
+        it 'returns the _links node' do
+          expect(@collection_json['_links']['self']['href']).to eq "#{Article.api_root}/#{Article.collection_method_name}"
+          expect(@collection_json['_links']['next']['href']).to eq "#{Article.api_root}/#{Article.collection_method_name}"
+          expect(@collection_json['_links']['prev']['href']).to eq "#{Article.api_root}/#{Article.collection_method_name}"
+        end
 
-      it 'returns the _embedded node' do
-        expect(@collection_json['_embedded']['articles']).to eq [{ 'id' => @article.id, 'title' => @article.title, '_links' => { 'self' => { 'href' => 'http://localhost:9292/articles/1' } } }]
-      end
+        it 'returns the _embedded node' do
+          expect(@collection_json['_embedded']['articles']).to eq [{ 'id' => article.id, 'title' => article.title, 'key' => article.key, '_links' => { 'self' => { 'href' => "#{Article.api_root}/#{Article.collection_method_name}/#{article.id}" } } }]
+        end
 
-      it 'returns the current_page' do
-        expect(@collection_json['current_page']).to eq 1
-      end
+        it 'returns the current_page' do
+          expect(@collection_json['current_page']).to eq 1
+        end
+
+        it 'returns the total_count' do
+          expect(@collection_json['total_count']).to eq 1
+        end
 
-      it 'returns the total_count' do
-        expect(@collection_json['total_count']).to eq 1
+        it 'returns the total_pages' do
+          expect(@collection_json['total_pages']).to eq 1
+        end
       end
+      context 'options' do
+        before(:each) do
+          @collection_json = hypermedia_collection_json_for [article], resource_path: '"#{model.id}?key=#{model.key}"'
+        end
+
+        it 'returns the _links node' do
+          expect(@collection_json['_links']['self']['href']).to eq "#{Article.api_root}/#{Article.collection_method_name}"
+          expect(@collection_json['_links']['next']['href']).to eq "#{Article.api_root}/#{Article.collection_method_name}"
+          expect(@collection_json['_links']['prev']['href']).to eq "#{Article.api_root}/#{Article.collection_method_name}"
+        end
+
+        it 'returns the _embedded node' do
+          expect(@collection_json['_embedded']['articles']).to eq [{ 'id' => article.id, 'title' => article.title, 'key' => article.key, '_links' => { 'self' => { 'href' => "#{Article.api_root}/#{Article.collection_method_name}/#{article.id}?key=#{article.key}" } } }]
+        end
+
+        it 'returns the current_page' do
+          expect(@collection_json['current_page']).to eq 1
+        end
 
-      it 'returns the total_pages' do
-        expect(@collection_json['total_pages']).to eq 1
+        it 'returns the total_count' do
+          expect(@collection_json['total_count']).to eq 1
+        end
+
+        it 'returns the total_pages' do
+          expect(@collection_json['total_pages']).to eq 1
+        end
       end
     end
 
     context 'hypermedia_resource_json_for' do
-      before(:each) do
-        @article = Article.new(id: 1, title: 'Sculpture in the Expanded Field')
-        @resource_json = hypermedia_resource_json_for @article
-      end
+      context 'default' do
+        before(:each) do
+          @resource_json = hypermedia_resource_json_for article
+        end
 
-      it 'returns the _links node' do
-        expect(@resource_json['_links']['self']['href']).to eq "#{Article.api_root}/articles/1"
+        it 'returns the _links node' do
+          expect(@resource_json['_links']['self']['href']).to eq "#{Article.api_root}/#{Article.collection_method_name}/#{article.id}"
+        end
+
+        it 'returns the resource attributes' do
+          expect(@resource_json['id']).to eq article.id
+          expect(@resource_json['title']).to eq article.title
+        end
       end
+      context 'options' do
+        before(:each) do
+          @resource_json = hypermedia_resource_json_for article, resource_path: '"#{model.id}?key=#{model.key}"'
+        end
+
+        it 'returns the _links node' do
+          expect(@resource_json['_links']['self']['href']).to eq "#{Article.api_root}/#{Article.collection_method_name}/#{article.id}?key=#{article.key}"
+        end
 
-      it 'returns the resource attributes' do
-        expect(@resource_json['id']).to eq @article.id
-        expect(@resource_json['title']).to eq @article.title
+        it 'returns the resource attributes' do
+          expect(@resource_json['id']).to eq article.id
+          expect(@resource_json['title']).to eq article.title
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: braque
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Dylan Fareed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-05 00:00:00.000000000 Z
+date: 2015-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hyperclient
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Braque provides a simple interface for interacting with Hypermedia API services