braque 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4c1ebc21906dfa95cf2c91d86d5280cb674798e
-  data.tar.gz: 21240b5b4080d20712490a9be9f2f8785e2a7fd3
+  metadata.gz: 117d19be143c1b7314093816acc359f136666c06
+  data.tar.gz: abb1836ab553182c46553ea2578fb530c5b018be
 SHA512:
-  metadata.gz: e75f45268a9392bbaf483483d779e9e7f25467cf9bb18f70cd7da537e76cb10c176be63c82d87f8e80863be1d442a5b013d532ea87f9de96ea3bbcee0517f54c
-  data.tar.gz: 50a7a00106e3e8c6b5b723aee03ec9f3060ac619442d2a891de756a67d2ce6cdbd66cd6f8f39e2e6c822676837f3edd97bd8b686487cf823fcdd709350b01d03
+  metadata.gz: 54f0b02909ea21b7345b5718ba90738c24a7a613a6d77b346b606f5eb87e81218972a1e64f869429ae176a906c6c5bf2fe1eaaef7be1087fc030583c11f51534
+  data.tar.gz: b6959ce75f02e30fb785896ebb8fd43c70dac27eb0a8b614f3d8edebe8fa74227d248e23688b14dad4939135dcba5c2d8dc718dfc70a8d06a6f6a94fe347ae76

data/README.md

@@ -13,7 +13,7 @@ Braque is an early-stage and exploratory project. That said, at [Artsy](https://
 ```ruby
 class Article
   include Braque::Model
-  self.api_root = Rails.application.config_for(:articles_service)['url']
+  api_root_url Rails.application.config_for(:articles_service)['url']
 
   attribute :id
   attribute :title
@@ -33,8 +33,8 @@ For example, `http_authorization_header` credentials defined here are added to t
 ```ruby
 class Article
   include Braque::Model
-  self.api_root = Rails.application.config_for(:articles_service)['url']
-  self.http_authorization_header = Rails.application.config_for(:articles_service)['token']
+  api_root_url Rails.application.config_for(:articles_service)['url']
+  http_authorization_header Rails.application.config_for(:articles_service)['token']
 
   attribute :id
   attribute :title
@@ -46,8 +46,8 @@ Defining an `accept_header` credential will replace Hyperclient's default `Accep
 ```ruby
 class Article
   include Braque::Model
-  self.api_root = Rails.application.config_for(:articles_service)['url']
-  self.accept_header = Rails.application.config_for(:articles_service)['accept_header']
+  api_root_url Rails.application.config_for(:articles_service)['url']
+  accept_header Rails.application.config_for(:articles_service)['accept_header']
 
   attribute :id
   attribute :title

data/lib/braque/helpers/hypermedia_responses_helper.rb

@@ -6,9 +6,9 @@ module Braque
         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}#{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 }
+        root_hash[:_links][:self] = { href: hyperclient_model_class.config[:api_root_url] }
+        root_hash[:_links][hyperclient_model_class.collection_method_name] = { href: "#{hyperclient_model_class.config[:api_root_url]}/#{hyperclient_model_class.collection_method_name}#{collection_query_options}", templated: true }
+        root_hash[:_links][hyperclient_model_class.instance_method_name] = { href: "#{hyperclient_model_class.config[:api_root_url]}/#{hyperclient_model_class.collection_method_name}/#{resource_path_options}", templated: true }
         JSON.parse root_hash.to_json
       end
 
@@ -19,9 +19,9 @@ module Braque
         collection_hash[:total_pages] = 1
         collection_hash[:current_page] = 1
         collection_hash[:_links] = {}
-        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[:_links][:self] = { href: "#{hyperclient_model.class.config[:api_root_url]}/#{hyperclient_model.class.collection_method_name}" }
+        collection_hash[:_links][:next] = { href: "#{hyperclient_model.class.config[:api_root_url]}/#{hyperclient_model.class.collection_method_name}" }
+        collection_hash[:_links][:prev] = { href: "#{hyperclient_model.class.config[:api_root_url]}/#{hyperclient_model.class.collection_method_name}" }
         collection_hash[:_embedded] = {}
         collection_hash[:_embedded][hyperclient_model.class.collection_method_name] = embedded_elements_for_collection(hyperclient_model_collection, options)
         JSON.parse collection_hash.to_json
@@ -44,11 +44,11 @@ module Braque
         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|
+        model.attributes.each_key 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}/#{resource_path}" }
+        hyperclient_element[:_links][:self] = { href: "#{model.class.config[:api_root_url]}/#{model.class.collection_method_name}/#{resource_path}" }
         hyperclient_element
       end
     end

data/lib/braque/model.rb

@@ -4,12 +4,8 @@ module Braque
     include ::ActiveAttr::Model
 
     included do
-      # NOTE: This adds class attributes to Braque::Model that will be
-      # used to set up Hyperclient in the client method.
-      #
-      [:api_root, :accept_header, :authorization_header, :http_authorization_header].each do |sym|
-        class_attribute sym
-      end
+      class_attribute :config
+      self.config = {}
 
       # NOTE: This assumes that the related API uses an ID attribute to
       # define the resource. Rails will use this field to construct
@@ -19,6 +15,7 @@ module Braque
       # in client apps if some other scheme is more advisable.
       #
       def to_param
+        fail 'Please overide to_param or add id to your model attributes.' unless attributes.include? 'id'
         id.to_s
       end
 
@@ -30,6 +27,7 @@ module Braque
       # classes in client apps if some other scheme is more advisable.
       #
       def resource_find_options
+        fail 'Please overide resource_find_options or add id to your model attributes.' unless attributes.include? 'id'
         { id: id }
       end
 
@@ -52,6 +50,8 @@ module Braque
 
         def self.inherited(subclass)
           subclass.class_eval do
+            self.config = self.config.dup
+
             define_singleton_method subclass.instance_method_name do
             end
 
@@ -65,6 +65,12 @@ module Braque
     module ClassMethods
       include Braque::Collection
 
+      [:api_root_url, :accept_header, :authorization_header, :http_authorization_header].each do |config_option|
+        define_method config_option do |value|
+          config[config_option] = value
+        end
+      end
+
       def list(options = {})
         options = Hash[options.map { |k, v| [CGI.escape(k.to_s), v] }]
         response = client.method(collection_method_name).call(options)
@@ -77,7 +83,8 @@ module Braque
       end
 
       def create(params = {})
-        response = client.method(collection_method_name).call._post("#{instance_method_name}" => params)
+        response = client.method(collection_method_name).call
+                   ._post("#{instance_method_name}" => params)
         new response
       end
 
@@ -90,10 +97,11 @@ module Braque
       end
 
       def client
-        Hyperclient.new(api_root) do |client|
-          client.headers['Http-Authorization'] = http_authorization_header if http_authorization_header
-          client.headers['Authorization'] = authorization_header if authorization_header
-          client.headers['Accept'] = accept_header if accept_header
+        fail 'Please define api_root for all Braque::Model classes' unless config[:api_root_url]
+        Hyperclient.new(config[:api_root_url]) do |client|
+          client.headers['Http-Authorization'] = config[:http_authorization_header] if config[:http_authorization_header]
+          client.headers['Authorization'] = config[:authorization_header] if config[:authorization_header]
+          client.headers['Accept'] = config[:accept_header] if config[:accept_header]
         end
       end
     end

data/lib/braque/version.rb

@@ -1,3 +1,3 @@
 module Braque
-  VERSION = '0.1.5'
+  VERSION = '0.1.7'
 end

data/spec/braque/api_root_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+RSpec.describe 'api_root' do
+  context 'with a Braque::Model class that does not define api_root' do
+    class Rodinia
+      include ::Braque::Model
+    end
+
+    it 'raises an error' do
+      expect { Rodinia.client }.to raise_error(
+        RuntimeError, 'Please define api_root for all Braque::Model classes'
+      )
+    end
+  end
+
+  context 'with a Braque::Model class that defines api_root' do
+    class Magma
+      include ::Braque::Model
+      api_root_url 'http://localhost:9292'
+    end
+
+    it 'does not raise an error' do
+      expect { Magma.client }.to_not raise_error
+    end
+  end
+end

data/spec/braque/client_headers_spec.rb

@@ -10,15 +10,15 @@ RSpec.describe 'Hyperclient header configuration' do
   context 'with a Braque::Model class that defines an api token' do
     class Mantle
       include ::Braque::Model
-      self.api_root = 'http://localhost:9292'
-      self.http_authorization_header = 'replace-me'
+      api_root_url 'http://localhost:9292'
+      http_authorization_header 'replace-me'
     end
 
     it 'passes http_authorization_header via Http-Authorization headers with requests' do
       Mantle.client._get
       expect(
         root_request
-        .with(headers: { 'Http-Authorization' => Mantle.http_authorization_header })
+        .with(headers: { 'Http-Authorization' => Mantle.config[:http_authorization_header] })
       ).to have_been_requested
     end
 
@@ -34,8 +34,8 @@ RSpec.describe 'Hyperclient header configuration' do
   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'
+      api_root_url 'http://localhost:9292'
+      accept_header 'application/vnd.earth-v1+json'
     end
 
     it 'includes class defined accept_header with request headers' do
@@ -50,15 +50,15 @@ RSpec.describe 'Hyperclient header configuration' do
   context 'with a Braque::Model class that defines an authorization header' do
     class Lithoshpere
       include ::Braque::Model
-      self.api_root = 'http://localhost:9292'
-      self.authorization_header = 'Farallon Plate'
+      api_root_url 'http://localhost:9292'
+      authorization_header 'Farallon Plate'
     end
 
     it 'includes correct Authorization header with request headers' do
       Lithoshpere.client._get
       expect(
         root_request
-        .with(headers: { 'Authorization' => Lithoshpere.authorization_header })
+        .with(headers: { 'Authorization' => Lithoshpere.config[:authorization_header] })
       ).to have_been_requested
     end
   end

data/spec/braque/helpers/hypermedia_responses_helper_spec.rb

@@ -10,8 +10,8 @@ RSpec.describe Braque::Helpers::HypermediaResponsesHelper do
     before(:all) do
       class Article
         include ::Braque::Model
-        self.api_root = 'http://localhost:9292'
-        self.http_authorization_header = 'replace-me'
+        api_root_url 'http://localhost:9292'
+        http_authorization_header 'replace-me'
         attribute :id
         attribute :title
         attribute :key
@@ -25,15 +25,15 @@ RSpec.describe Braque::Helpers::HypermediaResponsesHelper do
         end
 
         it 'returns the self link' do
-          expect(@root_json['_links']['self']['href']).to eq Article.api_root
+          expect(@root_json['_links']['self']['href']).to eq Article.config[:api_root_url]
         end
 
         it 'returns the collection link' do
-          expect(@root_json['_links']['articles']['href']).to eq "#{Article.api_root}/#{Article.collection_method_name}{?page,size}"
+          expect(@root_json['_links']['articles']['href']).to eq "#{Article.config[:api_root_url]}/#{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}"
+          expect(@root_json['_links']['article']['href']).to eq "#{Article.config[:api_root_url]}/#{Article.collection_method_name}/{id}"
         end
       end
       context 'options' do
@@ -42,15 +42,15 @@ RSpec.describe Braque::Helpers::HypermediaResponsesHelper do
         end
 
         it 'returns the self link' do
-          expect(@root_json['_links']['self']['href']).to eq Article.api_root
+          expect(@root_json['_links']['self']['href']).to eq Article.config[:api_root_url]
         end
 
         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}"
+          expect(@root_json['_links']['articles']['href']).to eq "#{Article.config[:api_root_url]}/#{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}"
+          expect(@root_json['_links']['article']['href']).to eq "#{Article.config[:api_root_url]}/#{Article.collection_method_name}/{id}?key={key}"
         end
       end
     end
@@ -62,13 +62,13 @@ RSpec.describe Braque::Helpers::HypermediaResponsesHelper do
         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}"
+          expect(@collection_json['_links']['self']['href']).to eq "#{Article.config[:api_root_url]}/#{Article.collection_method_name}"
+          expect(@collection_json['_links']['next']['href']).to eq "#{Article.config[:api_root_url]}/#{Article.collection_method_name}"
+          expect(@collection_json['_links']['prev']['href']).to eq "#{Article.config[:api_root_url]}/#{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}" } } }]
+          expect(@collection_json['_embedded']['articles']).to eq [{ 'id' => article.id, 'title' => article.title, 'key' => article.key, '_links' => { 'self' => { 'href' => "#{Article.config[:api_root_url]}/#{Article.collection_method_name}/#{article.id}" } } }]
         end
 
         it 'returns the current_page' do
@@ -89,13 +89,14 @@ RSpec.describe Braque::Helpers::HypermediaResponsesHelper do
         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}"
+          expect(@collection_json['_links']['self']['href']).to eq "#{Article.config[:api_root_url]}/#{Article.collection_method_name}"
+          expect(@collection_json['_links']['next']['href']).to eq "#{Article.config[:api_root_url]}/#{Article.collection_method_name}"
+          expect(@collection_json['_links']['prev']['href']).to eq "#{Article.config[:api_root_url]}/#{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}" } } }]
+          expect(@collection_json['_embedded']['articles'])
+            .to eq [{ 'id' => article.id, 'title' => article.title, 'key' => article.key, '_links' => { 'self' => { 'href' => "#{Article.config[:api_root_url]}/#{Article.collection_method_name}/#{article.id}?key=#{article.key}" } } }]
         end
 
         it 'returns the current_page' do
@@ -119,7 +120,7 @@ RSpec.describe Braque::Helpers::HypermediaResponsesHelper do
         end
 
         it 'returns the _links node' do
-          expect(@resource_json['_links']['self']['href']).to eq "#{Article.api_root}/#{Article.collection_method_name}/#{article.id}"
+          expect(@resource_json['_links']['self']['href']).to eq "#{Article.config[:api_root_url]}/#{Article.collection_method_name}/#{article.id}"
         end
 
         it 'returns the resource attributes' do
@@ -133,7 +134,7 @@ RSpec.describe Braque::Helpers::HypermediaResponsesHelper do
         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}"
+          expect(@resource_json['_links']['self']['href']).to eq "#{Article.config[:api_root_url]}/#{Article.collection_method_name}/#{article.id}?key=#{article.key}"
         end
 
         it 'returns the resource attributes' do

data/spec/braque/model_attributes_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+RSpec.describe 'Braque::Model attribute definitions', type: :model do
+  context 'with multiple defined Braque::Model classes' do
+    let(:identifier) { 1234 }
+    class Agate
+      include ::Braque::Model
+    end
+
+    class AbsoluteTime
+      include ::Braque::Model
+      attribute :id
+    end
+
+    class Aftershock
+      include ::Braque::Model
+      attribute :slug
+
+      def to_param
+        slug
+      end
+
+      def resource_find_options
+        { slug: slug }
+      end
+    end
+
+    class Amygdule < AbsoluteTime
+      attribute :slug
+
+      def to_param
+        slug
+      end
+
+      def resource_find_options
+        { slug: slug }
+      end
+    end
+
+    class Anticline < AbsoluteTime
+      attribute :identity
+
+      def to_param
+        identity
+      end
+
+      def resource_find_options
+        { identity: identity }
+      end
+    end
+
+    context '.to_param' do
+      it 'raises an error unless id is defined or the method overridden' do
+        expect { Agate.new.to_param }.to raise_error(
+          RuntimeError, 'Please overide to_param or add id to your model attributes.'
+        )
+      end
+
+      it 'sets to_param string based on instance.id' do
+        expect(AbsoluteTime.new(id: identifier).to_param).to eq identifier.to_s
+      end
+
+      it 'sets to_param based the overide' do
+        expect(Aftershock.new(slug: identifier).to_param).to eq identifier
+      end
+
+      it 'sets to_param based the overide' do
+        expect(Amygdule.new(slug: identifier).to_param).to eq identifier
+      end
+
+      it 'sets to_param based the overide' do
+        expect(Anticline.new(identity: identifier).to_param).to eq identifier
+      end
+    end
+
+    context '.resource_find_options' do
+      it 'raises an error unless id is defined or the method is overridden' do
+        expect { Agate.new.resource_find_options }.to raise_error(
+          RuntimeError, 'Please overide resource_find_options or add id to your model attributes.'
+        )
+      end
+
+      it 'returns a hash with the ID' do
+        expect(AbsoluteTime.new(id: identifier).resource_find_options).to eq(id: identifier)
+      end
+
+      it 'returns the overide' do
+        expect(Aftershock.new(slug: identifier).resource_find_options).to eq(slug: identifier)
+      end
+
+      it 'returns the overide' do
+        expect(Amygdule.new(slug: identifier).resource_find_options).to eq(slug: identifier)
+      end
+
+      it 'returns the overide' do
+        expect(Anticline.new(identity: identifier).resource_find_options).to eq(identity: identifier)
+      end
+    end
+  end
+end

data/spec/braque/model_spec.rb

@@ -4,9 +4,10 @@ RSpec.describe Braque::Model, type: :model do
   before(:all) do
     class Breeze
       include ::Braque::Model
-      self.api_root = 'http://localhost:9292'
-      self.http_authorization_header = 'replace-me'
-      self.accept_header = 'application/vnd.el-nino-v1+json'
+      api_root_url 'http://localhost:9292'
+      http_authorization_header 'replace-me'
+      accept_header 'application/vnd.el-nino-v1+json'
+
       attribute :id
       attribute :title
       attribute :token
@@ -19,16 +20,16 @@ RSpec.describe Braque::Model, type: :model do
   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.http_authorization_header })
-      .with(headers: { 'Accept' => Breeze.accept_header })
+    WebMock.stub_request(:get, "#{Breeze.config[:api_root_url]}/")
+      .with(headers: { 'Http-Authorization' => Breeze.config[:http_authorization_header] })
+      .with(headers: { 'Accept' => Breeze.config[: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.http_authorization_header })
-      .with(headers: { 'Accept' => Breeze.accept_header })
+    WebMock.stub_request(:get, "#{Breeze.config[:api_root_url]}/")
+      .with(headers: { 'Http-Authorization' => Breeze.config[:http_authorization_header] })
+      .with(headers: { 'Accept' => Breeze.config[:accept_header] })
       .to_return(status: 200, body: root_response_with_token_resource_path)
   end
 
@@ -49,9 +50,9 @@ RSpec.describe Braque::Model, type: :model do
       context 'with results' do
         before(:each) do
           root_request
-          @collection_request = WebMock.stub_request(:get, "#{Breeze.api_root}/breezes")
-                                .with(headers: { 'Http-Authorization' => Breeze.http_authorization_header })
-                                .with(headers: { 'Accept' => Breeze.accept_header })
+          @collection_request = WebMock.stub_request(:get, "#{Breeze.config[:api_root_url]}/breezes")
+                                .with(headers: { 'Http-Authorization' => Breeze.config[:http_authorization_header] })
+                                .with(headers: { 'Accept' => Breeze.config[:accept_header] })
                                 .to_return(status: 200, body: collection_response)
           @breezes = Breeze.list
         end
@@ -70,18 +71,21 @@ RSpec.describe Braque::Model, type: :model do
           expect(@breezes.first).to be_a_kind_of Breeze
         end
         it 'returns an array of items with the correct attributes' do
-          @breezes.each_with_index do |breeze, index|
+          index = 0
+          while index < @breezes.size
+            breeze = @breezes[index]
             expect(breeze.id).to eq collection_response['_embedded']['breezes'][index]['id']
             expect(breeze.title).to eq collection_response['_embedded']['breezes'][index]['title']
+            index += 1
           end
         end
       end
       context 'with an errored response' do
         before(:each) do
           root_request
-          @collection_request = WebMock.stub_request(:get, "#{Breeze.api_root}/breezes")
-                                .with(headers: { 'Http-Authorization' => Breeze.http_authorization_header })
-                                .with(headers: { 'Accept' => Breeze.accept_header })
+          @collection_request = WebMock.stub_request(:get, "#{Breeze.config[:api_root_url]}/breezes")
+                                .with(headers: { 'Http-Authorization' => Breeze.config[:http_authorization_header] })
+                                .with(headers: { 'Accept' => Breeze.config[:accept_header] })
                                 .to_return(status: 500)
         end
         it 'returns a Faraday::ClientError error' do
@@ -95,9 +99,9 @@ RSpec.describe Braque::Model, type: :model do
       context 'with array params' do
         before(:each) do
           root_request
-          @collection_request = WebMock.stub_request(:get, "#{Breeze.api_root}/breezes")
-                                .with(headers: { 'Http-Authorization' => Breeze.http_authorization_header })
-                                .with(headers: { 'Accept' => Breeze.accept_header })
+          @collection_request = WebMock.stub_request(:get, "#{Breeze.config[:api_root_url]}/breezes")
+                                .with(headers: { 'Http-Authorization' => Breeze.config[:http_authorization_header] })
+                                .with(headers: { 'Accept' => Breeze.config[: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])
@@ -112,9 +116,9 @@ RSpec.describe Braque::Model, type: :model do
       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.http_authorization_header })
-                              .with(headers: { 'Accept' => Breeze.accept_header })
+          @resource_request = WebMock.stub_request(:get, "#{Breeze.config[:api_root_url]}/breezes/1")
+                              .with(headers: { 'Http-Authorization' => Breeze.config[:http_authorization_header] })
+                              .with(headers: { 'Accept' => Breeze.config[:accept_header] })
                               .to_return(status: 200, body: resource_response)
           @breeze = Breeze.find(id: 1)
         end
@@ -135,9 +139,9 @@ RSpec.describe Braque::Model, type: :model do
       context 'with an errored response' do
         before(:each) do
           root_request
-          @resource_request = WebMock.stub_request(:get, "#{Breeze.api_root}/breezes/1")
-                              .with(headers: { 'Http-Authorization' => Breeze.http_authorization_header })
-                              .with(headers: { 'Accept' => Breeze.accept_header })
+          @resource_request = WebMock.stub_request(:get, "#{Breeze.config[:api_root_url]}/breezes/1")
+                              .with(headers: { 'Http-Authorization' => Breeze.config[:http_authorization_header] })
+                              .with(headers: { 'Accept' => Breeze.config[:accept_header] })
                               .to_return(status: 500)
         end
         it 'returns a Faraday::ClientError error' do
@@ -157,9 +161,9 @@ RSpec.describe Braque::Model, type: :model do
           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.http_authorization_header })
-                              .with(headers: { 'Accept' => Breeze.accept_header })
+          @resource_request = WebMock.stub_request(:get, "#{Breeze.config[:api_root_url]}/breezes/1?token=123")
+                              .with(headers: { 'Http-Authorization' => Breeze.config[:http_authorization_header] })
+                              .with(headers: { 'Accept' => Breeze.config[:accept_header] })
                               .to_return(status: 200, body: resource_response)
           @breeze = Breeze.find(id: 1, token: 123)
         end
@@ -184,9 +188,9 @@ RSpec.describe Braque::Model, type: :model do
       context 'with a successful response' do
         before(:each) do
           root_request
-          @create_request = WebMock.stub_request(:post, "#{Breeze.api_root}/breezes")
-                            .with(headers: { 'Http-Authorization' => Breeze.http_authorization_header })
-                            .with(headers: { 'Accept' => Breeze.accept_header })
+          @create_request = WebMock.stub_request(:post, "#{Breeze.config[:api_root_url]}/breezes")
+                            .with(headers: { 'Http-Authorization' => Breeze.config[:http_authorization_header] })
+                            .with(headers: { 'Accept' => Breeze.config[:accept_header] })
                             .to_return(status: 201, body: resource_response)
           @params = { title: 'What a nice breeze.' }
           @breeze = Breeze.create(@params)
@@ -209,9 +213,9 @@ RSpec.describe Braque::Model, type: :model do
     context 'with an errored response' do
       before(:each) do
         root_request
-        @create_request = WebMock.stub_request(:post, "#{Breeze.api_root}/breezes")
-                          .with(headers: { 'Http-Authorization' => Breeze.http_authorization_header })
-                          .with(headers: { 'Accept' => Breeze.accept_header })
+        @create_request = WebMock.stub_request(:post, "#{Breeze.config[:api_root_url]}/breezes")
+                          .with(headers: { 'Http-Authorization' => Breeze.config[:http_authorization_header] })
+                          .with(headers: { 'Accept' => Breeze.config[:accept_header] })
                           .to_return(status: 500)
       end
       it 'returns a Faraday::ClientError error' do
@@ -232,9 +236,9 @@ RSpec.describe Braque::Model, type: :model do
       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.http_authorization_header })
-                          .with(headers: { 'Accept' => Breeze.accept_header })
+          @save_request = WebMock.stub_request(:patch, "#{Breeze.config[:api_root_url]}/breezes/1")
+                          .with(headers: { 'Http-Authorization' => Breeze.config[:http_authorization_header] })
+                          .with(headers: { 'Accept' => Breeze.config[:accept_header] })
                           .to_return(status: 200, body: resource_response)
           @params = { title: 'What a nice breeze.' }
           @breeze = Breeze.new(id: 1).save(@params)
@@ -257,9 +261,9 @@ RSpec.describe Braque::Model, type: :model do
       context 'with an errored response' do
         before(:each) do
           root_request
-          @save_request = WebMock.stub_request(:patch, "#{Breeze.api_root}/breezes/1")
-                          .with(headers: { 'Http-Authorization' => Breeze.http_authorization_header })
-                          .with(headers: { 'Accept' => Breeze.accept_header })
+          @save_request = WebMock.stub_request(:patch, "#{Breeze.config[:api_root_url]}/breezes/1")
+                          .with(headers: { 'Http-Authorization' => Breeze.config[:http_authorization_header] })
+                          .with(headers: { 'Accept' => Breeze.config[:accept_header] })
                           .to_return(status: 500)
         end
         it 'returns a Faraday::ClientError error' do
@@ -280,9 +284,9 @@ RSpec.describe Braque::Model, type: :model do
           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.http_authorization_header })
-                          .with(headers: { 'Accept' => Breeze.accept_header })
+          @save_request = WebMock.stub_request(:patch, "#{Breeze.config[:api_root_url]}/breezes/1?token=123")
+                          .with(headers: { 'Http-Authorization' => Breeze.config[:http_authorization_header] })
+                          .with(headers: { 'Accept' => Breeze.config[:accept_header] })
                           .to_return(status: 200, body: resource_response)
           @params = { title: 'What a nice breeze.' }
           @breeze = Breeze.new(id: 1, token: 123).save(@params)
@@ -311,9 +315,9 @@ RSpec.describe Braque::Model, type: :model do
       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.http_authorization_header })
-                             .with(headers: { 'Accept' => Breeze.accept_header })
+          @destroy_request = WebMock.stub_request(:delete, "#{Breeze.config[:api_root_url]}/breezes/1")
+                             .with(headers: { 'Http-Authorization' => Breeze.config[:http_authorization_header] })
+                             .with(headers: { 'Accept' => Breeze.config[:accept_header] })
                              .to_return(status: 200)
           @breeze = Breeze.new(id: 1).destroy
         end
@@ -328,9 +332,9 @@ RSpec.describe Braque::Model, type: :model do
       context 'with an errored response' do
         before(:each) do
           root_request
-          @destroy_request = WebMock.stub_request(:delete, "#{Breeze.api_root}/breezes/1")
-                             .with(headers: { 'Http-Authorization' => Breeze.http_authorization_header })
-                             .with(headers: { 'Accept' => Breeze.accept_header })
+          @destroy_request = WebMock.stub_request(:delete, "#{Breeze.config[:api_root_url]}/breezes/1")
+                             .with(headers: { 'Http-Authorization' => Breeze.config[:http_authorization_header] })
+                             .with(headers: { 'Accept' => Breeze.config[:accept_header] })
                              .to_return(status: 500)
         end
         it 'returns a Faraday::ClientError error' do
@@ -351,9 +355,9 @@ RSpec.describe Braque::Model, type: :model do
           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.http_authorization_header })
-                             .with(headers: { 'Accept' => Breeze.accept_header })
+          @destroy_request = WebMock.stub_request(:delete, "#{Breeze.config[:api_root_url]}/breezes/1?token=123")
+                             .with(headers: { 'Http-Authorization' => Breeze.config[:http_authorization_header] })
+                             .with(headers: { 'Accept' => Breeze.config[:accept_header] })
                              .to_return(status: 200)
           @breeze = Breeze.new(id: 1, token: 123).destroy
         end

data/spec/braque/multiple_model_spec.rb

@@ -5,22 +5,22 @@ RSpec.describe Braque::Model, type: :model do
     before do
       class Wind
         include ::Braque::Model
-        self.api_root = 'http://localhost:9292'
-        self.http_authorization_header = 'replace-me'
+        api_root_url 'http://localhost:9292'
+        http_authorization_header 'replace-me'
       end
 
       class Tide
         include ::Braque::Model
-        self.api_root = 'http://localhost:9393'
-        self.http_authorization_header = 'do-replace-me-as-well'
+        api_root_url 'http://localhost:9393'
+        http_authorization_header 'do-replace-me-as-well'
       end
     end
 
     it 'sets the correct api_root and http_authorization_header for each class' do
-      expect(Tide.api_root).to eq 'http://localhost:9393'
-      expect(Tide.http_authorization_header).to eq 'do-replace-me-as-well'
-      expect(Wind.api_root).to eq 'http://localhost:9292'
-      expect(Wind.http_authorization_header).to eq 'replace-me'
+      expect(Tide.config[:api_root_url]).to eq 'http://localhost:9393'
+      expect(Tide.config[:http_authorization_header]).to eq 'do-replace-me-as-well'
+      expect(Wind.config[:api_root_url]).to eq 'http://localhost:9292'
+      expect(Wind.config[:http_authorization_header]).to eq 'replace-me'
     end
   end
 end

data/spec/braque/subclassed_model_spec.rb

@@ -5,41 +5,41 @@ RSpec.describe Braque::Model, type: :model do
     before do
       class GeologicModel
         include ::Braque::Model
-        self.api_root = 'http://localhost:9292'
-        self.http_authorization_header = 'replace-me'
+        api_root_url 'http://localhost:9292'
+        http_authorization_header 'replace-me'
       end
 
       class ContinentalDrift < GeologicModel
       end
 
       class Convection < GeologicModel
-        self.api_root = 'http://localhost:9595'
-        self.http_authorization_header = 'ok-another-one-to-replace'
+        api_root_url 'http://localhost:9595'
+        http_authorization_header 'ok-another-one-to-replace'
       end
 
       class SeafloorSpreading
         include ::Braque::Model
-        self.api_root = 'http://localhost:9393'
-        self.http_authorization_header = 'do-replace-me-as-well'
+        api_root_url 'http://localhost:9393'
+        http_authorization_header 'do-replace-me-as-well'
       end
     end
 
     context 'api configuration' do
       it 'sets the correct api_root and api_token for the base class' do
-        expect(GeologicModel.api_root).to eq 'http://localhost:9292'
-        expect(GeologicModel.http_authorization_header).to eq 'replace-me'
+        expect(GeologicModel.config[:api_root_url]).to eq 'http://localhost:9292'
+        expect(GeologicModel.config[:http_authorization_header]).to eq 'replace-me'
       end
       it 'sets the correct api_root and api_token for a subclassed class' do
-        expect(ContinentalDrift.api_root).to eq 'http://localhost:9292'
-        expect(ContinentalDrift.http_authorization_header).to eq 'replace-me'
+        expect(ContinentalDrift.config[:api_root_url]).to eq 'http://localhost:9292'
+        expect(ContinentalDrift.config[:http_authorization_header]).to eq 'replace-me'
       end
       it 'sets the correct api_root and api_token for a subclassed class with variable overrides' do
-        expect(Convection.api_root).to eq 'http://localhost:9595'
-        expect(Convection.http_authorization_header).to eq 'ok-another-one-to-replace'
+        expect(Convection.config[:api_root_url]).to eq 'http://localhost:9595'
+        expect(Convection.config[:http_authorization_header]).to eq 'ok-another-one-to-replace'
       end
       it 'sets the correct api_root and api_token for a new Braque::Model class' do
-        expect(SeafloorSpreading.api_root).to eq 'http://localhost:9393'
-        expect(SeafloorSpreading.http_authorization_header).to eq 'do-replace-me-as-well'
+        expect(SeafloorSpreading.config[:api_root_url]).to eq 'http://localhost:9393'
+        expect(SeafloorSpreading.config[:http_authorization_header]).to eq 'do-replace-me-as-well'
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: braque
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Dylan Fareed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-04 00:00:00.000000000 Z
+date: 2015-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hyperclient
@@ -68,9 +68,11 @@ files:
 - lib/braque/helpers/hypermedia_responses_helper.rb
 - lib/braque/model.rb
 - lib/braque/version.rb
+- spec/braque/api_root_spec.rb
 - spec/braque/client_headers_spec.rb
 - spec/braque/collection_spec.rb
 - spec/braque/helpers/hypermedia_responses_helper_spec.rb
+- spec/braque/model_attributes_spec.rb
 - spec/braque/model_spec.rb
 - spec/braque/multiple_model_spec.rb
 - spec/braque/subclassed_model_spec.rb