braque 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ab231c18ebc05e007531d66f7503b7b149213b6
-  data.tar.gz: d07db5d4abf55f5d8138dd73a904e672df2c064a
+  metadata.gz: 695090ace904e767afca4305c5f8ee985d57081f
+  data.tar.gz: 3f2507fd0e00192d70753abf29fdc9dcf60fcceb
 SHA512:
-  metadata.gz: 5f031712669fc5e2ed29f3a08e95744375d8f60a3608f50172eca74b121c830c68b7f860454080755f60de3df506d716615d4d359ca532f4bdbb038193d653bd
-  data.tar.gz: deb8befc3e96e1f3ae4d3358d0fb9053517a4217a7ce63f46a7dbc05784cacfd861f8ef400de548fb5e7d85eb808264a6bbd3ed824aea21d10b1815cf1a2dde0
+  metadata.gz: d381d640d339f61c5125d7ee44bb0435c177710e5f0a0737585fbb8c324d8a11663ae1a88d19e1b0605a8f95288c3ac069aa405596fb071aaf08aa4955cead3d
+  data.tar.gz: dbae5083decd83a6a31d8d30431ebdc03a3925e50e6594a7c3d48ff4d14665079cc518192a5eca6cc92c76eb4d6123aa1c1d8f4c1f1df9d3a6e833bf2be18237

data/README.md

@@ -51,7 +51,7 @@ class ArticlesController < ApplicationController
 
   def update
     @article = @article.save params[:article]
-    redirect_to article_path(id: @article.id)
+    redirect_to article_path(@article.id)
   end
 
   def destroy
@@ -62,7 +62,7 @@ class ArticlesController < ApplicationController
   private
 
   def find_article
-    @article = Article.find params[:id]
+    @article = Article.find(id: params[:id])
   end
 end
 

data/lib/braque/model.rb

@@ -4,17 +4,35 @@ module Braque
     include ::ActiveAttr::Model
 
     included do
+      # NOTE: This assumes that the related API uses an ID attribute to
+      # define the resource. Rails will use this field to construct
+      # resource routes in client applications.
+      #
+      # to_param can be overridden when defining Braque::Model classes
+      # in client apps if some other scheme is more advisable.
+      #
       def to_param
         "#{id}"
       end
 
+      # NOTE: This assumes that the related API uses an ID field exclusively
+      # to locate this resource. resource_find_options is used to build the
+      # url path to the API resource
+      #
+      # resource_find_options can be overridden when defining Braque::Model
+      # classes in client apps if some other scheme is more advisable.
+      #
+      def resource_find_options
+        { id: id }
+      end
+
       def save(params = {})
-        response = self.class.client.method(self.class.instance_method_name).call(id: id)._patch("#{self.class.instance_method_name}" => params)
+        response = self.class.client.method(self.class.instance_method_name).call(resource_find_options)._patch("#{self.class.instance_method_name}" => params)
         self.class.new response
       end
 
       def destroy
-        response = self.class.client.method(self.class.instance_method_name).call(id: id)._delete
+        response = self.class.client.method(self.class.instance_method_name).call(resource_find_options)._delete
       end
 
       class_eval <<-WRITER
@@ -37,8 +55,8 @@ module Braque
         LinkedArray.new response, self
       end
 
-      def find(id)
-        response = client.method(instance_method_name).call(id: id)
+      def find(options = {})
+        response = client.method(instance_method_name).call(options)
         new response
       end
 

data/lib/braque/version.rb

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

data/spec/braque/model_spec.rb

@@ -8,18 +8,27 @@ RSpec.describe Braque::Model, type: :model do
       self.api_token = 'replace-me'
       attribute :id
       attribute :title
+      attribute :token
     end
   end
 
   let(:root_response) { JSON.parse(File.read 'spec/fixtures/root.json') }
+  let(:root_response_with_token_resource_path) { JSON.parse(File.read 'spec/fixtures/root_with_token_resource_path.json') }
   let(:collection_response) { JSON.parse(File.read 'spec/fixtures/collection.json') }
   let(:resource_response) { JSON.parse(File.read 'spec/fixtures/resource.json') }
+
   let(:root_request) do
     WebMock.stub_request(:get, "#{Breeze.api_root}/")
       .with(headers: { 'Http-Authorization' => Breeze.api_token })
       .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 })
+      .to_return(status: 200, body: root_response_with_token_resource_path)
+  end
+
   context 'class methods' do
     it 'responds to find, create, and list' do
       expect(Breeze).to respond_to(:find, :create, :list)
@@ -77,25 +86,56 @@ RSpec.describe Braque::Model, type: :model do
     end
 
     context '.find' do
-      before(:each) do
-        root_request
-        @resource_request = WebMock.stub_request(:get, "#{Breeze.api_root}/breezes/1")
-                            .with(headers: { 'Http-Authorization' => Breeze.api_token })
-                            .to_return(status: 200, body: resource_response)
-        @breeze = Breeze.find 1
-      end
-      it 'performs the API root request' do
-        expect(root_request).to have_been_requested
-      end
-      it 'performs the resource request' do
-        expect(@resource_request).to have_been_requested
-      end
-      it 'returns an item with the correct class' do
-        expect(@breeze).to be_a_kind_of Breeze
+      context 'under normal conditions' do
+        before(:each) do
+          root_request
+          @resource_request = WebMock.stub_request(:get, "#{Breeze.api_root}/breezes/1")
+                              .with(headers: { 'Http-Authorization' => Breeze.api_token })
+                              .to_return(status: 200, body: resource_response)
+          @breeze = Breeze.find(id: 1)
+        end
+        it 'performs the API root request' do
+          expect(root_request).to have_been_requested
+        end
+        it 'performs the resource request' do
+          expect(@resource_request).to have_been_requested
+        end
+        it 'returns an item with the correct class' do
+          expect(@breeze).to be_a_kind_of Breeze
+        end
+        it 'returns an item with the correct attributes' do
+          expect(@breeze.id).to eq resource_response['id']
+          expect(@breeze.title).to eq resource_response['title']
+        end
       end
-      it 'returns an item with the correct attributes' do
-        expect(@breeze.id).to eq resource_response['id']
-        expect(@breeze.title).to eq resource_response['title']
+      context 'when overriding resource_find_options' do
+        before(:each) do
+          class Breeze
+            def resource_find_options
+              { id: id, token: token }
+            end
+          end
+
+          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 })
+                              .to_return(status: 200, body: resource_response)
+          @breeze = Breeze.find(id: 1, token: 123)
+        end
+
+        it 'performs the API root request' do
+          expect(root_request_with_token_resource_path).to have_been_requested
+        end
+        it 'performs the resource request' do
+          expect(@resource_request).to have_been_requested
+        end
+        it 'returns an item with the correct class' do
+          expect(@breeze).to be_a_kind_of Breeze
+        end
+        it 'returns an item with the correct attributes' do
+          expect(@breeze.id).to eq resource_response['id']
+          expect(@breeze.title).to eq resource_response['title']
+        end
       end
     end
 
@@ -129,45 +169,102 @@ RSpec.describe Braque::Model, type: :model do
     end
 
     context '#save' do
-      before(:each) do
-        root_request
-        @save_request = WebMock.stub_request(:patch, "#{Breeze.api_root}/breezes/1")
-                        .with(headers: { 'Http-Authorization' => Breeze.api_token })
-                        .to_return(status: 200, body: resource_response)
-        @params = { title: 'What a nice breeze.' }
-        @breeze = Breeze.new(id: 1).save(@params)
-      end
-      it 'performs the API root request' do
-        expect(root_request).to have_been_requested
-      end
-      it 'performs the save request' do
-        expect(@save_request).to have_been_requested
-      end
-      it 'returns an item with the correct class' do
-        expect(@breeze).to be_a_kind_of Breeze
+      context 'under normal conditions' do
+        before(:each) do
+          root_request
+          @save_request = WebMock.stub_request(:patch, "#{Breeze.api_root}/breezes/1")
+                          .with(headers: { 'Http-Authorization' => Breeze.api_token })
+                          .to_return(status: 200, body: resource_response)
+          @params = { title: 'What a nice breeze.' }
+          @breeze = Breeze.new(id: 1).save(@params)
+        end
+        it 'performs the API root request' do
+          expect(root_request).to have_been_requested
+        end
+        it 'performs the save request' do
+          expect(@save_request).to have_been_requested
+        end
+        it 'returns an item with the correct class' do
+          expect(@breeze).to be_a_kind_of Breeze
+        end
+        it 'returns an item with the correct attributes' do
+          expect(@breeze.id).to eq resource_response['id']
+          expect(@breeze.title).to eq resource_response['title']
+        end
       end
-      it 'returns an item with the correct attributes' do
-        expect(@breeze.id).to eq resource_response['id']
-        expect(@breeze.title).to eq resource_response['title']
+
+      context 'when overriding resource_find_options' do
+        before(:each) do
+          class Breeze
+            def resource_find_options
+              { id: id, token: token }
+            end
+          end
+
+          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 })
+                          .to_return(status: 200, body: resource_response)
+          @params = { title: 'What a nice breeze.' }
+          @breeze = Breeze.new(id: 1, token: 123).save(@params)
+        end
+
+        it 'performs the API root request' do
+          expect(root_request_with_token_resource_path).to have_been_requested
+        end
+
+        it 'performs the save request' do
+          expect(@save_request).to have_been_requested
+        end
+
+        it 'returns an item with the correct class' do
+          expect(@breeze).to be_a_kind_of Breeze
+        end
+
+        it 'returns an item with the correct attributes' do
+          expect(@breeze.id).to eq resource_response['id']
+          expect(@breeze.title).to eq resource_response['title']
+        end
       end
     end
 
     context '#destroy' do
-      before(:each) do
-        root_request
-        @destroy_request = WebMock.stub_request(:delete, "#{Breeze.api_root}/breezes/1")
-                           .with(headers: { 'Http-Authorization' => Breeze.api_token })
-                           .to_return(status: 200)
-        @resource_request = WebMock.stub_request(:get, "#{Breeze.api_root}/breezes/1")
-                            .with(headers: { 'Http-Authorization' => Breeze.api_token })
-                            .to_return(status: 200, body: resource_response)
-        @breeze = Breeze.new(id: 1).destroy
-      end
-      it 'performs the API root request' do
-        expect(root_request).to have_been_requested
+      context 'under normal conditions' do
+        before(:each) do
+          root_request
+          @destroy_request = WebMock.stub_request(:delete, "#{Breeze.api_root}/breezes/1")
+                             .with(headers: { 'Http-Authorization' => Breeze.api_token })
+                             .to_return(status: 200)
+          @breeze = Breeze.new(id: 1).destroy
+        end
+        it 'performs the API root request' do
+          expect(root_request).to have_been_requested
+        end
+        it 'performs the destroy request' do
+          expect(@destroy_request).to have_been_requested
+        end
       end
-      it 'performs the destroy request' do
-        expect(@destroy_request).to have_been_requested
+
+      context 'when overriding resource_find_options' do
+        before(:each) do
+          class Breeze
+            def resource_find_options
+              { id: id, token: token }
+            end
+          end
+
+          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 })
+                             .to_return(status: 200)
+          @breeze = Breeze.new(id: 1, token: 123).destroy
+        end
+        it 'performs the API root request' do
+          expect(root_request_with_token_resource_path).to have_been_requested
+        end
+        it 'performs the destroy request' do
+          expect(@destroy_request).to have_been_requested
+        end
       end
     end
   end

data/spec/fixtures/collection.json

@@ -11,6 +11,7 @@
       "breezes":[
          {
             "id":1,
+            "token":123,
             "title":"Southerly Breeze",
             "_links":{
                "self":{

data/spec/fixtures/resource.json

@@ -1,5 +1,6 @@
 {
    "id":1,
+   "token":123,
    "title":"Southerly Breeze",
    "created_at":"2015-02-11T18:59:01.669Z",
    "updated_at":"2015-02-12T00:26:22.255Z",

data/spec/fixtures/root_with_token_resource_path.json

@@ -0,0 +1,18 @@
+{
+   "_links":{
+      "self":{
+         "href":"http://localhost:9292"
+      },
+      "health":{
+         "href":"http://localhost:9292/health"
+      },
+      "breezes":{
+         "href":"http://localhost:9292/breezes{?page,size,ids%5B%5D*}",
+         "templated":true
+      },
+      "breeze":{
+         "href":"http://localhost:9292/breezes/{id}?token={token}",
+         "templated":true
+      }
+   }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: braque
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Dylan Fareed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-03 00:00:00.000000000 Z
+date: 2015-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hyperclient
@@ -74,6 +74,7 @@ files:
 - spec/fixtures/collection.json
 - spec/fixtures/resource.json
 - spec/fixtures/root.json
+- spec/fixtures/root_with_token_resource_path.json
 - spec/spec_helper.rb
 homepage: https://github.com/dylanfareed/braque
 licenses: