braque 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7877495074bf14604179991d76599e5bfc508716
-  data.tar.gz: c08da9d09ed4e53b9179b5c3188073dd025e2b95
+  metadata.gz: 3e8bbfc9dc19e8eb3f4130366f9aa757bbb122ae
+  data.tar.gz: e574170f094b58b9f624a04461986978cd35de83
 SHA512:
-  metadata.gz: f9df5a71dc0428f62e763b14dd3b68e5c363ef7a1d6118b407878cd6e0627ef54dfc1c13d54544e81fc73c93ec6d3e5c027bd986ee738f18d74644c29d4ac45a
-  data.tar.gz: 02fcb2222b97b54c8216b5024f12b8fb57f55e9ec4901fd2d7e81dd2b82c1451065fb62e340318aae7546299d9b2434636e3379e9fb8c2146a6bc746f51cf1cd
+  metadata.gz: 8900c7e630a9e9a68c0ed67141895543205949bae1dde1192c543821b8394c75bf9922298449886120ae558f25c0a58243040fd372ccd859770e8ebf54bd94b2
+  data.tar.gz: 6ea404e052ea8412412635cc5d1abba74ae5a270ca29d0e8ab621d3a342f18d91db2e46a7e99bba928fe7780889e665e675dbce6bf51c571af99a7eb9e73ad6e

data/lib/braque/helpers/hypermedia_responses_helper.rb

@@ -19,11 +19,11 @@ module Braque
         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[:_links][:self] = { href: "#{hyperclient_model.class.api_root}/#{hyperclient_model.class.collection_method_name}" }
+        collection_hash[:_links][:next] = { href: "#{hyperclient_model.class.api_root}/#{hyperclient_model.class.collection_method_name}" }
+        collection_hash[:_links][:prev] = { href: "#{hyperclient_model.class.api_root}/#{hyperclient_model.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, options)
+        collection_hash[:_embedded][hyperclient_model.class.collection_method_name] = embedded_elements_for_collection(hyperclient_model_collection, options)
         JSON.parse collection_hash.to_json
       end
 

data/lib/braque/model.rb

@@ -6,6 +6,7 @@ module Braque
     included do
       class_attribute :api_root
       class_attribute :api_token
+      class_attribute :accept_header
 
       # NOTE: This assumes that the related API uses an ID attribute to
       # define the resource. Rails will use this field to construct
@@ -15,7 +16,7 @@ module Braque
       # in client apps if some other scheme is more advisable.
       #
       def to_param
-        "#{id}"
+        id.to_s
       end
 
       # NOTE: This assumes that the related API uses an ID field exclusively
@@ -35,7 +36,7 @@ module Braque
       end
 
       def destroy
-        response = self.class.client.method(self.class.instance_method_name).call(resource_find_options)._delete
+        self.class.client.method(self.class.instance_method_name).call(resource_find_options)._delete
       end
 
       class_eval <<-WRITER
@@ -86,7 +87,8 @@ module Braque
 
       def client
         Hyperclient.new(api_root) do |client|
-          client.headers['Http-Authorization'] = api_token
+          client.headers['Http-Authorization'] = api_token if api_token
+          client.headers['Accept'] = accept_header if accept_header
         end
       end
     end

data/lib/braque/version.rb

@@ -1,3 +1,3 @@
 module Braque
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/spec/braque/client_headers_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+RSpec.describe 'Hyperclient header configuration' do
+  let(:root_request) { WebMock.stub_request(:get, 'http://localhost:9292/') }
+
+  before do
+    root_request
+  end
+
+  context 'with a Braque::Model class that defines an api token' do
+    class Mantle
+      include ::Braque::Model
+      self.api_root = 'http://localhost:9292'
+      self.api_token = 'replace-me'
+    end
+
+    it 'passes api_token via Http-Authorization headers with requests' do
+      Mantle.client._get
+      expect(
+        root_request
+        .with(headers: { 'Http-Authorization' => Mantle.api_token })
+      ).to have_been_requested
+    end
+
+    it 'passes default Hyperclient Accept headers with requests' do
+      Mantle.client._get
+      expect(
+        root_request
+        .with(headers: { 'Accept' => 'application/hal+json,application/json' })
+      ).to have_been_requested
+    end
+  end
+
+  context 'with a Braque::Model class that defines an accept_header' do
+    class Subduction
+      include ::Braque::Model
+      self.api_root = 'http://localhost:9292'
+      self.accept_header = 'application/vnd.earth-v1+json'
+    end
+
+    it 'includes class defined accept_header with request headers' do
+      Subduction.client._get
+      expect(
+        root_request
+        .with(headers: { 'Accept' => 'application/vnd.earth-v1+json' })
+      ).to have_been_requested
+    end
+  end
+end

data/spec/braque/collection_spec.rb

@@ -1,7 +1,5 @@
 require 'spec_helper'
 
-require 'spec_helper'
-
 RSpec.describe Braque::Collection do
   before(:all) do
     class BraqueClass
@@ -58,9 +56,9 @@ RSpec.describe Braque::Collection do
           expect(@linked_array.first.id).to eq 1
           expect(@linked_array.first.title).to eq @array.first[:title]
           expect(@linked_array.first.class.name).to eq 'BraqueClass'
-          expect(@linked_array[1].id).to eq 2
-          expect(@linked_array[1].title).to eq @array[1][:title]
-          expect(@linked_array[1].class.name).to eq 'BraqueClass'
+          expect(@linked_array.last.id).to eq 2
+          expect(@linked_array.last.title).to eq @array[1][:title]
+          expect(@linked_array.last.class.name).to eq 'BraqueClass'
         end
 
         it 'responds to previous_link with the correct value' do

data/spec/braque/model_spec.rb

@@ -6,6 +6,7 @@ RSpec.describe Braque::Model, type: :model do
       include ::Braque::Model
       self.api_root = 'http://localhost:9292'
       self.api_token = 'replace-me'
+      self.accept_header = 'application/vnd.el-nino-v1+json'
       attribute :id
       attribute :title
       attribute :token
@@ -20,12 +21,14 @@ RSpec.describe Braque::Model, type: :model do
   let(:root_request) do
     WebMock.stub_request(:get, "#{Breeze.api_root}/")
       .with(headers: { 'Http-Authorization' => Breeze.api_token })
+      .with(headers: { 'Accept' => Breeze.accept_header })
       .to_return(status: 200, body: root_response)
   end
 
   let(:root_request_with_token_resource_path) do
     WebMock.stub_request(:get, "#{Breeze.api_root}/")
       .with(headers: { 'Http-Authorization' => Breeze.api_token })
+      .with(headers: { 'Accept' => Breeze.accept_header })
       .to_return(status: 200, body: root_response_with_token_resource_path)
   end
 
@@ -48,6 +51,7 @@ RSpec.describe Braque::Model, type: :model do
           root_request
           @collection_request = WebMock.stub_request(:get, "#{Breeze.api_root}/breezes")
                                 .with(headers: { 'Http-Authorization' => Breeze.api_token })
+                                .with(headers: { 'Accept' => Breeze.accept_header })
                                 .to_return(status: 200, body: collection_response)
           @breezes = Breeze.list
         end
@@ -58,16 +62,18 @@ RSpec.describe Braque::Model, type: :model do
           expect(@collection_request).to have_been_requested
         end
         it 'returns an array of items' do
-          expect(@breezes.count).to be 1
+          expect(@breezes.count).to be 2
           expect(@breezes.first).to be_a_kind_of Breeze
+          expect(@breezes).to be_a_kind_of Array
         end
         it 'returns items with the correct class' do
           expect(@breezes.first).to be_a_kind_of Breeze
         end
         it 'returns an array of items with the correct attributes' do
-          breeze = @breezes.first
-          expect(breeze.id).to eq collection_response['_embedded']['breezes'].first['id']
-          expect(breeze.title).to eq collection_response['_embedded']['breezes'].first['title']
+          @breezes.each_with_index do |breeze, index|
+            expect(breeze.id).to eq collection_response['_embedded']['breezes'][index]['id']
+            expect(breeze.title).to eq collection_response['_embedded']['breezes'][index]['title']
+          end
         end
       end
       context 'with an errored response' do
@@ -75,6 +81,7 @@ RSpec.describe Braque::Model, type: :model do
           root_request
           @collection_request = WebMock.stub_request(:get, "#{Breeze.api_root}/breezes")
                                 .with(headers: { 'Http-Authorization' => Breeze.api_token })
+                                .with(headers: { 'Accept' => Breeze.accept_header })
                                 .to_return(status: 500)
         end
         it 'returns a Faraday::ClientError error' do
@@ -90,6 +97,7 @@ RSpec.describe Braque::Model, type: :model do
           root_request
           @collection_request = WebMock.stub_request(:get, "#{Breeze.api_root}/breezes")
                                 .with(headers: { 'Http-Authorization' => Breeze.api_token })
+                                .with(headers: { 'Accept' => Breeze.accept_header })
                                 .with(query: 'ids%5B0%5D=1&ids%5B1%5D=2')
                                 .to_return(status: 200, body: collection_response)
           @breezes = Breeze.list('ids[]' => [1, 2])
@@ -106,6 +114,7 @@ RSpec.describe Braque::Model, type: :model do
           root_request
           @resource_request = WebMock.stub_request(:get, "#{Breeze.api_root}/breezes/1")
                               .with(headers: { 'Http-Authorization' => Breeze.api_token })
+                              .with(headers: { 'Accept' => Breeze.accept_header })
                               .to_return(status: 200, body: resource_response)
           @breeze = Breeze.find(id: 1)
         end
@@ -128,6 +137,7 @@ RSpec.describe Braque::Model, type: :model do
           root_request
           @resource_request = WebMock.stub_request(:get, "#{Breeze.api_root}/breezes/1")
                               .with(headers: { 'Http-Authorization' => Breeze.api_token })
+                              .with(headers: { 'Accept' => Breeze.accept_header })
                               .to_return(status: 500)
         end
         it 'returns a Faraday::ClientError error' do
@@ -149,6 +159,7 @@ RSpec.describe Braque::Model, type: :model do
           root_request_with_token_resource_path
           @resource_request = WebMock.stub_request(:get, "#{Breeze.api_root}/breezes/1?token=123")
                               .with(headers: { 'Http-Authorization' => Breeze.api_token })
+                              .with(headers: { 'Accept' => Breeze.accept_header })
                               .to_return(status: 200, body: resource_response)
           @breeze = Breeze.find(id: 1, token: 123)
         end
@@ -175,6 +186,7 @@ RSpec.describe Braque::Model, type: :model do
           root_request
           @create_request = WebMock.stub_request(:post, "#{Breeze.api_root}/breezes")
                             .with(headers: { 'Http-Authorization' => Breeze.api_token })
+                            .with(headers: { 'Accept' => Breeze.accept_header })
                             .to_return(status: 201, body: resource_response)
           @params = { title: 'What a nice breeze.' }
           @breeze = Breeze.create(@params)
@@ -199,6 +211,7 @@ RSpec.describe Braque::Model, type: :model do
         root_request
         @create_request = WebMock.stub_request(:post, "#{Breeze.api_root}/breezes")
                           .with(headers: { 'Http-Authorization' => Breeze.api_token })
+                          .with(headers: { 'Accept' => Breeze.accept_header })
                           .to_return(status: 500)
       end
       it 'returns a Faraday::ClientError error' do
@@ -221,6 +234,7 @@ RSpec.describe Braque::Model, type: :model do
           root_request
           @save_request = WebMock.stub_request(:patch, "#{Breeze.api_root}/breezes/1")
                           .with(headers: { 'Http-Authorization' => Breeze.api_token })
+                          .with(headers: { 'Accept' => Breeze.accept_header })
                           .to_return(status: 200, body: resource_response)
           @params = { title: 'What a nice breeze.' }
           @breeze = Breeze.new(id: 1).save(@params)
@@ -245,6 +259,7 @@ RSpec.describe Braque::Model, type: :model do
           root_request
           @save_request = WebMock.stub_request(:patch, "#{Breeze.api_root}/breezes/1")
                           .with(headers: { 'Http-Authorization' => Breeze.api_token })
+                          .with(headers: { 'Accept' => Breeze.accept_header })
                           .to_return(status: 500)
         end
         it 'returns a Faraday::ClientError error' do
@@ -267,6 +282,7 @@ RSpec.describe Braque::Model, type: :model do
           root_request_with_token_resource_path
           @save_request = WebMock.stub_request(:patch, "#{Breeze.api_root}/breezes/1?token=123")
                           .with(headers: { 'Http-Authorization' => Breeze.api_token })
+                          .with(headers: { 'Accept' => Breeze.accept_header })
                           .to_return(status: 200, body: resource_response)
           @params = { title: 'What a nice breeze.' }
           @breeze = Breeze.new(id: 1, token: 123).save(@params)
@@ -297,6 +313,7 @@ RSpec.describe Braque::Model, type: :model do
           root_request
           @destroy_request = WebMock.stub_request(:delete, "#{Breeze.api_root}/breezes/1")
                              .with(headers: { 'Http-Authorization' => Breeze.api_token })
+                             .with(headers: { 'Accept' => Breeze.accept_header })
                              .to_return(status: 200)
           @breeze = Breeze.new(id: 1).destroy
         end
@@ -313,6 +330,7 @@ RSpec.describe Braque::Model, type: :model do
           root_request
           @destroy_request = WebMock.stub_request(:delete, "#{Breeze.api_root}/breezes/1")
                              .with(headers: { 'Http-Authorization' => Breeze.api_token })
+                             .with(headers: { 'Accept' => Breeze.accept_header })
                              .to_return(status: 500)
         end
         it 'returns a Faraday::ClientError error' do
@@ -335,6 +353,7 @@ RSpec.describe Braque::Model, type: :model do
           root_request_with_token_resource_path
           @destroy_request = WebMock.stub_request(:delete, "#{Breeze.api_root}/breezes/1?token=123")
                              .with(headers: { 'Http-Authorization' => Breeze.api_token })
+                             .with(headers: { 'Accept' => Breeze.accept_header })
                              .to_return(status: 200)
           @breeze = Breeze.new(id: 1, token: 123).destroy
         end

data/spec/fixtures/collection.json

@@ -10,9 +10,19 @@
    "_embedded":{
       "breezes":[
          {
-            "id":1,
+            "id":0,
             "token":123,
             "title":"Southerly Breeze",
+            "_links":{
+               "self":{
+                  "href":"http://localhost:9292/breezes/0"
+               }
+            }
+         },
+         {
+            "id":1,
+            "token":234,
+            "title":"Westerly Breeze",
             "_links":{
                "self":{
                   "href":"http://localhost:9292/breezes/1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: braque
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Dylan Fareed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-17 00:00:00.000000000 Z
+date: 2015-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hyperclient
@@ -28,16 +28,16 @@ dependencies:
   name: active_attr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.5
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.5
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -68,6 +68,7 @@ files:
 - lib/braque/helpers/hypermedia_responses_helper.rb
 - lib/braque/model.rb
 - lib/braque/version.rb
+- spec/braque/client_headers_spec.rb
 - spec/braque/collection_spec.rb
 - spec/braque/helpers/hypermedia_responses_helper_spec.rb
 - spec/braque/model_spec.rb
@@ -98,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Braque provides a simple interface for interacting with Hypermedia API services