braque 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7c808e05c6710b54706c5a3dfdcca8a36af7e41
-  data.tar.gz: d90bcc7ed6d6cb29677ea06b92a344a72eb99f5d
+  metadata.gz: df25bde58e0019d26eee97463a92e1b2cb4603db
+  data.tar.gz: 68d1599459c8aaa9dd3028b83fb8ba86b027a710
 SHA512:
-  metadata.gz: f093efaacf01e01ad2028759609f21768efad162bea40d28e8e0617bbe278ff4338d05be7af922555dff9b96cdf5ccaf744cbe3d29ebf92d1cb35e83fc512d68
-  data.tar.gz: 12acb696429f1f62af2c8983a14b52da695cae0a8584b4626fcd4ac8348c1270379d6d5461e6f4c4d66f47bf5ff751c7fe9f8b7f2888ce276c20619f6cdf95ee
+  metadata.gz: c623a2dcf30dcb360c19de218020682932b07e4c269d9201acd863349ba7c3077bd1bc30dd44ed8e5ef7a5e95bce4456d980a809206ee7df9bee5b80d4757b8b
+  data.tar.gz: eed91132bcf818cca39b339cc673acc9393f2161df657d0614cd933a5fc67f186375b8e5892bb67e1cd7f887aa0357a26cacb7d4e27480ff4b22f328c08b5bf7

data/README.md

@@ -4,6 +4,8 @@ Braque aims to provide a simple and familiar interface for setting up clients to
 
 Braque is an early-stage and exploratory project.
 
+[ ![Codeship Status for dylanfareed/braque](https://codeship.com/projects/c41fd480-9f37-0132-ec49-02db7f3f2d41/status?branch=master)](https://codeship.com/projects/65077)
+
 ### Model setup
 
 ```Braque::Model``` is ActiveSupport concern. You can use Braque::Model to map a remote resource to a class in your application. Do so by including Braque::Model in the class, defining the API service's root url and authentication details, and listing attributes which we expect from the API.
@@ -27,7 +29,7 @@ In a Rails app, you can then use this model simply:
 
 ```ruby
 class ArticlesController < ApplicationController
-  before_filter :find_article, except: :index
+  before_filter :find_article, except: [:index, :new]
 
   def index
     @articles = Article.list(page: params[:page], size: params[:size])

data/lib/braque/helpers/hypermedia_responses_helper.rb

@@ -0,0 +1,52 @@
+module Braque
+  module Helpers
+    module HypermediaResponsesHelper
+      def hypermedia_root_json_for(hyperclient_model_class)
+        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 }
+        JSON.parse root_hash.to_json
+      end
+
+      def hypermedia_collection_json_for(hyperclient_model_collection)
+        hyperclient_model = hyperclient_model_collection.first
+        collection_hash = {}
+        collection_hash[:total_count] = 1
+        collection_hash[:total_pages] = 1
+        collection_hash[:current_page] = 1
+        collection_hash[:_links] = {}
+        collection_hash[:_links][:self] = { href: "#{hyperclient_model_collection.first.class.api_root}/#{hyperclient_model_collection.first.class.collection_method_name}" }
+        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)
+        JSON.parse collection_hash.to_json
+      end
+
+      def hypermedia_resource_json_for(hyperclient_model)
+        resource_hash = embedded_element(hyperclient_model)
+        JSON.parse resource_hash.to_json
+      end
+
+      def embedded_elements_for_collection(hyperclient_model_collection)
+        embedded_elements = []
+        hyperclient_model_collection.each do |model|
+          embedded_elements << embedded_element(model)
+        end
+        embedded_elements
+      end
+
+      def embedded_element(model)
+        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
+      end
+    end
+  end
+end

data/lib/braque/helpers.rb

@@ -0,0 +1,6 @@
+require 'braque/helpers/hypermedia_responses_helper'
+
+module Braque
+  module Helpers
+  end
+end

data/lib/braque/version.rb

@@ -1,3 +1,3 @@
 module Braque
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/braque/helpers/hypermedia_responses_helper_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+require 'braque/helpers'
+
+RSpec.describe Braque::Helpers::HypermediaResponsesHelper do
+  include Braque::Helpers::HypermediaResponsesHelper
+
+  context 'with a Braque::Model class' do
+    before(:all) do
+      class Article
+        include ::Braque::Model
+        self.api_root = 'http://localhost:9292'
+        self.api_token = 'replace-me'
+        attribute :id
+        attribute :title
+      end
+    end
+
+    context 'hypermedia_root_json_for' 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 collection link' do
+        expect(@root_json['_links']['articles']['href']).to eq "#{Article.api_root}/articles{?page,size}"
+      end
+
+      it 'returns the resource link' do
+        expect(@root_json['_links']['article']['href']).to eq "#{Article.api_root}/articles/{id}"
+      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
+
+      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 _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 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_pages' do
+        expect(@collection_json['total_pages']).to eq 1
+      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
+
+      it 'returns the _links node' do
+        expect(@resource_json['_links']['self']['href']).to eq "#{Article.api_root}/articles/1"
+      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
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: braque
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dylan Fareed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-23 00:00:00.000000000 Z
+date: 2015-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hyperclient
@@ -64,9 +64,12 @@ files:
 - README.md
 - lib/braque.rb
 - lib/braque/collection.rb
+- lib/braque/helpers.rb
+- lib/braque/helpers/hypermedia_responses_helper.rb
 - lib/braque/model.rb
 - lib/braque/version.rb
 - spec/braque/collection_spec.rb
+- spec/braque/helpers/hypermedia_responses_helper_spec.rb
 - spec/braque/model_spec.rb
 - spec/fixtures/collection.json
 - spec/fixtures/resource.json
@@ -92,7 +95,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