frenetic 1.0.0 → 2.0.0

data/spec/concerns/member_rest_methods_spec.rb

@@ -11,15 +11,25 @@ describe Frenetic::MemberRestMethods do
     end
   end
 
+  let(:my_filtered_resource) do
+    cfg = test_cfg
+
+    Class.new(Frenetic::Resource) do
+      api_client { Frenetic.new(cfg) }
+    end
+  end
+
   before do
     stub_const 'MyTempResource', my_temp_resource
     MyTempResource.send :include, described_class
   end
 
   describe '.find' do
+    let(:params) { 1 }
+
     before { @stubs.api_description }
 
-    subject { MyTempResource.find 1 }
+    subject { MyTempResource.find(params) }
 
     context 'for a known instance' do
       before { @stubs.known_instance }
@@ -41,7 +51,33 @@ describe Frenetic::MemberRestMethods do
       before { @stubs.unknown_instance }
 
       it 'raises an error' do
-        expect{subject}.to raise_error Frenetic::ClientError
+        expect{subject}.to(
+          raise_error Frenetic::ResourceNotFound, "Couldn't find MyTempResource with id=1"
+        )
+      end
+
+      context 'with an unparseable response' do
+        before { @stubs.invalid_unknown_instance }
+
+        it 'raises an error' do
+          expect{subject}.to(
+            raise_error Frenetic::ResourceNotFound, "Couldn't find MyTempResource with id=1"
+          )
+        end
+      end
+    end
+
+    context 'that results in a client-level error' do
+      before do
+        @stubs.api_error(
+          status: 422,
+          body: 'Unprocessable Entity',
+          url: 'example.com/api/my_temp_resources/1'
+        )
+      end
+
+      it 'raises an error' do
+        expect{subject}.to raise_error Frenetic::ClientError, '422 Unprocessable Entity'
       end
     end
 
@@ -56,6 +92,35 @@ describe Frenetic::MemberRestMethods do
       it 'returns a mock resource' do
         expect(subject).to be_an_instance_of MyMockResource
       end
+
+      context 'with blank parameters' do
+        let(:params) { {} }
+
+        it 'raises an error' do
+          expect{subject}.to(
+            raise_error Frenetic::ResourceNotFound, "Couldn't find MyTempResource without an ID"
+          )
+        end
+      end
+    end
+  end
+
+  describe '.find_by' do
+    before { @stubs.api_description }
+
+    subject { MyTempResource.find_by(id:1) }
+
+    it 'delegates to .find' do
+      allow(MyTempResource).to receive(:find).and_return(nil)
+      subject
+      expect(MyTempResource).to have_received(:find)
+    end
+
+    context 'for an unknown resource' do
+      it 'returns nil' do
+        allow(MyTempResource).to receive(:find).and_raise(Frenetic::ClientError.new({}))
+        expect{subject}.to_not raise_error
+      end
     end
   end
 
@@ -83,5 +148,23 @@ describe Frenetic::MemberRestMethods do
         expect(subject).to be_empty
       end
     end
+
+    context 'with additional parameters' do
+      before do
+        stub_const('MyFilteredResource', my_filtered_resource)
+        MyFilteredResource.send(:include, described_class)
+        @stubs.filtered_resource
+      end
+
+      subject { MyFilteredResource.all(filter: 'bar') }
+
+      it 'returns a resource collection' do
+        expect(subject).to be_an_instance_of Frenetic::ResourceCollection
+      end
+
+      it 'instantiates all resources in the collection' do
+        expect(subject.first).to be_an_instance_of MyFilteredResource
+      end
+    end
   end
 end

data/spec/concerns/persistence_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe Frenetic::Persistence do
+  let(:test_cfg) { { url:'http://example.com/api' } }
+
+  let(:my_temp_resource) do
+    cfg = test_cfg
+
+    Class.new(Frenetic::Resource) do
+      api_client { Frenetic.new(cfg) }
+    end
+  end
+
+  before do
+    stub_const 'MyTempResource', my_temp_resource
+    MyTempResource.send(:include, described_class)
+  end
+
+  subject(:instance) { MyTempResource.new }
+
+  describe '#save' do
+    before { @stubs.api_description }
+
+    subject { super().save }
+
+    context 'for a valid resource' do
+      before { @stubs.valid_created_resource }
+
+      it 'returns TRUE' do
+        expect(subject).to eql true
+      end
+
+      it 'returns a valid instance' do
+        subject
+        expect(instance.valid?).to eql true
+      end
+    end
+
+    context 'for an invalid resource' do
+      before { @stubs.invalid_created_resource }
+
+      it 'returns FALSE' do
+        expect(subject).to eql false
+      end
+
+      it 'returns an invalid instance' do
+        subject
+        expect(instance.valid?).to eql false
+      end
+
+      it 'maps resource errors onto the instance' do
+        subject
+        expect(instance.errors).to include 'name' => ['cannot be blank', 'must be a name']
+      end
+    end
+
+    context 'that triggers an exception' do
+      let(:mock_api) { double('api_client') }
+
+      before do
+        @stubs.valid_created_resource
+        allow(mock_api).to receive(:post).and_raise(StandardError)
+        expect(instance).to receive(:api).and_return(mock_api)
+      end
+
+      it 're-raises the exception' do
+        expect{subject}.to raise_error(StandardError)
+      end
+    end
+  end
+
+  describe '#save!' do
+    before { @stubs.api_description }
+
+    subject { super().save! }
+
+    context 'for a valid resource' do
+      before { @stubs.valid_created_resource }
+
+      it 'returns TRUE' do
+        expect(subject).to eql true
+      end
+    end
+
+    context 'for an invalid resource' do
+      before { @stubs.invalid_created_resource }
+
+      it 'raises an error' do
+        # rubocop:disable Metrics/LineLength
+        expect{subject}.to raise_error(Frenetic::ClientError, 'Validation failed: Name cannot be blank, Name must be a name, Cannot be valid')
+        # rubocop:enable Metrics/LineLength
+      end
+    end
+  end
+end

data/spec/fixtures/test_api_requests.rb

@@ -1,5 +1,6 @@
 require 'json'
 
+# rubocop:disable Metrics/ClassLength
 class HttpStubs
   def initialize(rspec)
     @rspec = rspec
@@ -29,22 +30,12 @@ class HttpStubs
       .to_return response(body:'Non-JSON response', status:200)
   end
 
-  def api_server_error(type = :json)
-    body = '500 Server Error'
+  def api_error(type: :json, body: 'Not Found', status: 404, url: 'example.com/api')
+    body = "#{status} #{body}"
+    body = { 'error' => body } if type == :json
 
-    body = { 'error' => body }.to_json if type == :json
-
-    @rspec.stub_request(:any, 'example.com/api')
-      .to_return response(body:body, status:500)
-  end
-
-  def api_client_error(type = :json)
-    body = '404 Not Found'
-
-    body = { 'error' => body }.to_json if type == :json
-
-    @rspec.stub_request(:any, 'example.com/api')
-      .to_return defaults.merge(body:body, status:404)
+    @rspec.stub_request(:get, url)
+      .to_return response(body:body, status:status.to_i)
   end
 
   def api_description
@@ -57,6 +48,11 @@ class HttpStubs
       .to_return response(body:{ 'error' => '404 Not Found' }, status:404)
   end
 
+  def invalid_unknown_instance
+    @rspec.stub_request(:get, 'example.com/api/my_temp_resources/1')
+      .to_return response(body:'Unparseable Not Found', status:404)
+  end
+
   def known_instance
     @rspec.stub_request(:get, 'example.com/api/my_temp_resources/1')
       .to_return response(body:{ 'name' => 'Resource Name' })
@@ -68,13 +64,46 @@ class HttpStubs
         body: {
           '_embedded' => {
             'my_temp_resources' => [
-              { 'name' => 'Resource Name' }
+              persisted_resource
             ]
           }
         }
       )
   end
 
+  def filtered_resource
+    @rspec.stub_request(:get, 'example.com/api/my_filtered_resources/filters/bar')
+      .to_return response(
+        body: {
+          '_embedded' => {
+            'my_filtered_resources' => [
+              persisted_resource
+            ]
+          }
+        }
+      )
+  end
+
+  def valid_created_resource
+    @rspec.stub_request(:post, 'example.com/api/my_temp_resources/')
+      .to_return response(
+        body: persisted_resource
+      )
+  end
+
+  def invalid_created_resource
+    @rspec.stub_request(:post, 'example.com/api/my_temp_resources/')
+      .to_return response(
+        status: 422,
+        body: persisted_resource.merge(
+          'errors' => {
+            'name' => ['cannot be blank', 'must be a name'],
+            'base' => ['cannot be valid']
+          }
+        )
+      )
+  end
+
   # rubocop:disable Metrics/MethodLength
   def schema
     {
@@ -87,6 +116,13 @@ class HttpStubs
               name: 'string'
             }
           },
+          my_filtered_resource: {
+            description: 'Humanized resource description',
+            properties: {
+              id:   'number',
+              name: 'string'
+            }
+          },
           abstract_resource: {
             description: 'A random thing',
             properties: {
@@ -103,6 +139,10 @@ class HttpStubs
         my_temp_resources: {
           href: '/api/my_temp_resources'
         },
+        my_filtered_resources: {
+          href: '/api/my_filtered_resources/filters/{filter}',
+          templated: true
+        },
         my_temp_resource: {
           href: '/api/my_temp_resources/{id}',
           templated: true
@@ -114,7 +154,21 @@ class HttpStubs
     }
   end
   # rubocop:enable Metrics/MethodLength
+
+  def persisted_resource(params = {})
+    id = params.fetch('id', 1)
+    {
+      'id' => id,
+      'name' => 'Resource Name',
+      '_links' => {
+        'self' => {
+          'href' => "/api/my_temp_resources/#{id}"
+        }
+      }
+    }.merge!(params)
+  end
 end
+# rubocop:enable Metrics/ClassLength
 
 RSpec.configure do |c|
   c.before :all do

data/spec/frenetic_spec.rb

@@ -54,190 +54,176 @@ describe Frenetic do
     end
   end
 
-  # describe '#connection' do
-  #   subject { super().connection }
-
-  #   it 'returns a Faraday Connection' do
-  #     expect(subject).to be_a Faraday::Connection
-  #   end
-
-  #   context 'when Frenetic is initialized with a block' do
-  #     subject do
-  #       builder = nil
-  #       described_class.new(test_cfg) do |b|
-  #         builder = b
-  #       end.connection
-  #       builder
-  #     end
-
-  #     it 'yields the Faraday builder to the block argument' do
-  #       expect(subject).to be_a Faraday::Connection
-  #     end
-  #   end
-
-  #   describe 'middleware' do
-  #     subject { super().builder.handlers }
-
-  #     context 'configured with a :username' do
-  #       let(:test_cfg) { super().merge username:'foo' }
-
-  #       it 'includes Basic Auth middleware' do
-  #         expect(subject).to include Faraday::Request::BasicAuthentication
-  #       end
-  #     end
-
-  #     context 'configured with a :api_token' do
-  #       let(:test_cfg) { super().merge api_token:'API_TOKEN' }
-
-  #       it 'includes Token Authentication middleware' do
-  #         expect(subject).to include Faraday::Request::TokenAuthentication
-  #       end
-  #     end
-
-  #     context 'configured to use Rack::Cache' do
-  #       let(:test_cfg) { super().merge cache: :rack }
-
-  #       it 'includes Rack middleware' do
-  #         expect(subject).to include FaradayMiddleware::RackCompatible
-  #       end
-  #     end
-  #   end
-  # end
-
-  # describe '#description' do
-  #   subject { super().description }
-
-  #   context 'with a URL that returns a' do
-  #     context 'valid response' do
-  #       before { @stubs.api_description }
-
-  #       it 'includes meta Hypermedia properties' do
-  #         expect(subject).to include '_embedded'
-  #         expect(subject).to include '_links'
-  #       end
-  #     end
-
-  #     context 'server error' do
-  #       before { @stubs.api_server_error }
-
-  #       it 'raises an error' do
-  #         expect{subject}.to raise_error Frenetic::ServerParsingError
-  #       end
-  #     end
-
-  #     context 'client error' do
-  #       before { @stubs.api_client_error :json }
-
-  #       it 'raises an error' do
-  #         expect{subject}.to raise_error Frenetic::ClientError
-  #       end
-  #     end
-
-  #     context 'JSON parsing error' do
-  #       context 'for an otherwise successful response' do
-  #         before { @stubs.api_html_response }
-
-  #         it 'raises an error' do
-  #           expect{subject}.to raise_error Frenetic::UnknownParsingError
-  #         end
-  #       end
-
-  #       context 'for a server error' do
-  #         before { @stubs.api_server_error :text }
-
-  #         it 'raises an error' do
-  #           expect{subject}.to raise_error Frenetic::ServerParsingError
-  #         end
-  #       end
-
-  #       context 'for a client error' do
-  #         before { @stubs.api_client_error :text }
-
-  #         it 'raises an error' do
-  #           expect{subject}.to raise_error Frenetic::ClientParsingError
-  #         end
-  #       end
-  #     end
-  #   end
-  # end
-
-  # describe '.schema' do
-  #   before { @stubs.api_description }
-
-  #   subject { super().schema }
-
-  #   it 'includes a list of defined resources' do
-  #     expect(subject).to include 'my_temp_resource'
-  #   end
-  # end
-
-  # describe '#get' do
-  #   subject { super().get '/foo' }
-
-  #   it 'delegates to Faraday' do
-  #     allow(instance.connection).to receive(:get)
-  #     subject
-  #     expect(instance.connection).to have_received(:get)
-  #   end
-  # end
-
-  # describe '#put' do
-  #   subject { super().put '/foo' }
-
-  #   it 'delegates to Faraday' do
-  #     allow(instance.connection).to receive(:put)
-  #     subject
-  #     expect(instance.connection).to have_received(:put)
-  #   end
-  # end
-
-  # describe '#patch' do
-  #   subject { super().patch '/foo' }
-
-  #   it 'delegates to Faraday' do
-  #     allow(instance.connection).to receive(:patch)
-  #     subject
-  #     expect(instance.connection).to have_received(:patch)
-  #   end
-  # end
-
-  # describe '#head' do
-  #   subject { instance.head '/foo' }
-
-  #   it 'delegates to Faraday' do
-  #     allow(instance.connection).to receive(:head)
-  #     subject
-  #     expect(instance.connection).to have_received(:head)
-  #   end
-  # end
-
-  # describe '#options' do
-  #   subject { instance.options '/foo' }
-
-  #   it 'delegates to Faraday' do
-  #     allow(instance.connection).to receive(:options)
-  #     subject
-  #     expect(instance.connection).to have_received(:options)
-  #   end
-  # end
-
-  # describe '#post' do
-  #   subject { super().post '/foo' }
-
-  #   it 'delegates to Faraday' do
-  #     allow(instance.connection).to receive(:post)
-  #     subject
-  #     expect(instance.connection).to have_received(:post)
-  #   end
-  # end
-
-  # describe '#delete' do
-  #   subject { super().delete '/foo' }
-
-  #   it 'delegates to Faraday' do
-  #     allow(instance.connection).to receive(:delete)
-  #     subject
-  #     expect(instance.connection).to have_received(:delete)
-  #   end
-  # end
+  describe '#connection' do
+    subject { super().connection }
+
+    it 'returns a Frenetic Connection instance' do
+      expect(subject).to be_a Frenetic::Connection
+    end
+
+    describe 'middleware' do
+      subject { super().builder.handlers }
+
+      context 'configured with a :username' do
+        let(:test_cfg) { super().merge username:'foo' }
+
+        it 'includes Basic Auth middleware' do
+          expect(subject).to include Faraday::Request::BasicAuthentication
+        end
+      end
+
+      context 'configured with a :api_token' do
+        let(:test_cfg) { super().merge api_token:'API_TOKEN' }
+
+        it 'includes Token Authentication middleware' do
+          expect(subject).to include Faraday::Request::TokenAuthentication
+        end
+      end
+
+      context 'configured to use Rack::Cache' do
+        let(:test_cfg) { super().merge cache: :rack }
+
+        it 'includes Rack middleware' do
+          expect(subject).to include FaradayMiddleware::RackCompatible
+        end
+      end
+    end
+  end
+
+  describe '#description' do
+    subject { super().description }
+
+    context 'with a URL that returns a' do
+      context 'valid response' do
+        before { @stubs.api_description }
+
+        it 'includes meta Hypermedia properties' do
+          expect(subject).to include '_embedded'
+          expect(subject).to include '_links'
+        end
+      end
+
+      context 'server error' do
+        before { @stubs.api_error(type: :text, status: 500) }
+
+        it 'raises an error' do
+          expect{subject}.to raise_error Frenetic::ServerParsingError
+        end
+      end
+
+      context 'client error' do
+        before { @stubs.api_error }
+
+        it 'raises an error' do
+          expect{subject}.to raise_error Frenetic::ClientError
+        end
+      end
+
+      context 'JSON parsing error' do
+        context 'for an otherwise successful response' do
+          before { @stubs.api_html_response }
+
+          it 'raises an error' do
+            expect{subject}.to raise_error Frenetic::UnknownParsingError
+          end
+        end
+
+        context 'for a server error' do
+          before { @stubs.api_error(type: :text, status: 500) }
+
+          it 'raises an error' do
+            expect{subject}.to raise_error Frenetic::ServerParsingError
+          end
+        end
+
+        context 'for a client error' do
+          before { @stubs.api_error(type: :text) }
+
+          it 'raises an error' do
+            expect{subject}.to raise_error Frenetic::ClientParsingError
+          end
+        end
+      end
+    end
+  end
+
+  describe '.schema' do
+    before { @stubs.api_description }
+
+    subject { super().schema }
+
+    it 'includes a list of defined resources' do
+      expect(subject).to include 'my_temp_resource'
+    end
+  end
+
+  describe '#get' do
+    subject { super().get '/foo' }
+
+    it 'delegates to Faraday' do
+      allow(instance.connection).to receive(:get)
+      subject
+      expect(instance.connection).to have_received(:get)
+    end
+  end
+
+  describe '#put' do
+    subject { super().put '/foo' }
+
+    it 'delegates to Faraday' do
+      allow(instance.connection).to receive(:put)
+      subject
+      expect(instance.connection).to have_received(:put)
+    end
+  end
+
+  describe '#patch' do
+    subject { super().patch '/foo' }
+
+    it 'delegates to Faraday' do
+      allow(instance.connection).to receive(:patch)
+      subject
+      expect(instance.connection).to have_received(:patch)
+    end
+  end
+
+  describe '#head' do
+    subject { instance.head '/foo' }
+
+    it 'delegates to Faraday' do
+      allow(instance.connection).to receive(:head)
+      subject
+      expect(instance.connection).to have_received(:head)
+    end
+  end
+
+  describe '#options' do
+    subject { instance.options '/foo' }
+
+    it 'delegates to Faraday' do
+      allow(instance.connection).to receive(:options)
+      subject
+      expect(instance.connection).to have_received(:options)
+    end
+  end
+
+  describe '#post' do
+    subject { super().post '/foo' }
+
+    it 'delegates to Faraday' do
+      allow(instance.connection).to receive(:post)
+      subject
+      expect(instance.connection).to have_received(:post)
+    end
+  end
+
+  describe '#delete' do
+    subject { super().delete '/foo' }
+
+    it 'delegates to Faraday' do
+      allow(instance.connection).to receive(:delete)
+      subject
+      expect(instance.connection).to have_received(:delete)
+    end
+  end
 end