braque 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7a9f3bb1b0fa79bccb708a0bf57e0b6a52f9e2b
-  data.tar.gz: 1e41b55a3b55791b8e5b66aacdffadddee401427
+  metadata.gz: 70e62e768e37c2ede2e426564c4751b5f35fb672
+  data.tar.gz: cec0db7ad8f7ff1e3da6f2be88827898ba20009e
 SHA512:
-  metadata.gz: 69f0e4507806a662441bbde237a173b17bd5d4067ef31d11208aa40f77efb437e0578e6f48d7c22af29849dac032760da27bafc45b50d5b97747268a067e9336
-  data.tar.gz: b0c7e6a4e5a7dd55ce7d39f48227edf1efd1280ff7e0579ea47230cabd099a4288f3b06adbe9e356428ba70b49ef9feb8fd5b8efa20e1a851449a985555f388b
+  metadata.gz: 1718329d5f9e8545eadeae1edc06d432950f216e7eb36e8fb35890c9354ae9e64ee1c53856b513dabd18d5bc88f638c70029a694299fd8468538a8bb306f63fc
+  data.tar.gz: ae99d0fcbd624392b30b8f0b441993631747ea2950172e4f37deba0c2563e98510096321f20b100157d6194baa8f5a4e8703df84b90f6d76bc8350cd0fadf60c

data/README.md

@@ -26,6 +26,51 @@ end
 
 Braque::Model adds familiar "Active Record"-like `create`, `find`, and `list` class methods to the embedding class (`Article` in the example above) as well as `save` and `destroy` instance methods. These methods wrap Hyperclient to make calls to a remote hypermedia API.
 
+### Usage
+
+In a Rails app, once you've set up your model, you can use the following familiar syntax to query the remote API:
+
+```ruby
+class ArticlesController < ApplicationController
+  before_filter :find_article, except: [:index, :new]
+
+  def index
+    @articles = Article.list(page: params[:page], size: params[:size])
+  end
+
+  def new
+  end
+
+  def create
+    @article = Article.create params[:article]
+    redirect_to article_path(@article)
+  end
+
+  def show
+  end
+
+  def edit
+  end
+
+  def update
+    @article = @article.save params[:article]
+    redirect_to article_path(@article.id)
+  end
+
+  def destroy
+    @article.destroy
+    redirect_to articles_path
+  end
+
+  private
+
+  def find_article
+    @article = Article.find(id: params[:id])
+  end
+end
+
+```
+
 ### Relations
 
 If your remote API includes associated resources in the `_links` node for a given resource, you can use Braque's relations helpers to make navigating to those associated resources somewhat simpler.
@@ -114,51 +159,6 @@ This method supports passing params to the remote API as well.
 articles = magazine.articles(page: 2, size: 20)
 ```
 
-### Controllers
-
-In a Rails app, once you've set up your model, you can use the following familiar syntax to query the remote API:
-
-```ruby
-class ArticlesController < ApplicationController
-  before_filter :find_article, except: [:index, :new]
-
-  def index
-    @articles = Article.list(page: params[:page], size: params[:size])
-  end
-
-  def new
-  end
-
-  def create
-    @article = Article.create params[:article]
-    redirect_to article_path(@article)
-  end
-
-  def show
-  end
-
-  def edit
-  end
-
-  def update
-    @article = @article.save params[:article]
-    redirect_to article_path(@article.id)
-  end
-
-  def destroy
-    @article.destroy
-    redirect_to articles_path
-  end
-
-  private
-
-  def find_article
-    @article = Article.find(id: params[:id])
-  end
-end
-
-```
-
 ### Subclassing
 
 Braque supports inheritance for shared setup across multiple models in your app that make calls to the same remote API.

data/lib/braque/model.rb

@@ -74,7 +74,13 @@ module Braque
       include Braque::Collection
       include Braque::Relations
 
-      [:api_root_url, :accept_header, :authorization_header, :http_authorization_header].each do |config_option|
+      [
+        :api_root_url,
+        :accept_header,
+        :authorization_header,
+        :http_authorization_header,
+        :remote_resource_name
+      ].each do |config_option|
         define_method config_option do |value|
           config[config_option] = value
         end
@@ -102,7 +108,7 @@ module Braque
       end
 
       def collection_method_name
-        name.tableize
+        (config[:remote_resource_name].present? ? config[:remote_resource_name] : name).tableize
       end
 
       def instance_method_name

data/lib/braque/version.rb

@@ -1,3 +1,3 @@
 module Braque
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/spec/braque/custom_name_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+RSpec.describe Braque::Model, type: :model do
+  context 'with a custom defined resource name' do
+    before do
+      class OceanBreeze
+        include ::Braque::Model
+        api_root_url 'http://localhost:9292'
+        remote_resource_name 'Breeze'
+        attribute :id
+        attribute :title
+      end
+    end
+
+    let(:root_response) { JSON.parse(File.read 'spec/fixtures/root.json') }
+    let(:breeze_response) { JSON.parse(File.read 'spec/fixtures/resource.json') }
+
+    let(:root_request) do
+      WebMock.stub_request(:get, "#{OceanBreeze.config[:api_root_url]}/")
+        .to_return(status: 200, body: root_response)
+    end
+
+    let(:breeze_request) do
+      WebMock.stub_request(:get, "#{OceanBreeze.config[:api_root_url]}/breezes/1")
+        .to_return(status: 200, body: breeze_response)
+    end
+
+    let(:ocean_breeze) { OceanBreeze.new id: 1 }
+
+    before do
+      root_request
+      breeze_request
+      @ocean_breeze = OceanBreeze.find(id: 1)
+    end
+
+    it 'performs the API root request' do
+      expect(root_request).to have_been_requested
+    end
+
+    it 'performs the collection request' do
+      expect(breeze_request).to have_been_requested
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: braque
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Dylan Fareed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-14 00:00:00.000000000 Z
+date: 2015-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hyperclient
@@ -70,6 +70,7 @@ files:
 - spec/braque/api_root_spec.rb
 - spec/braque/client_headers_spec.rb
 - spec/braque/collection_spec.rb
+- spec/braque/custom_name_spec.rb
 - spec/braque/model_attributes_spec.rb
 - spec/braque/model_spec.rb
 - spec/braque/multiple_model_spec.rb