ddy_remote_resource 0.4.11 → 1.0.0.rc1

data/spec/integration/find_spec.rb

@@ -0,0 +1,139 @@
+require 'spec_helper'
+
+RSpec.describe '.find' do
+
+  class Post
+    include RemoteResource::Base
+
+    self.site         = 'https://www.example.com'
+    self.collection   = true
+    self.root_element = :data
+
+    attribute :title, String
+    attribute :body, String
+    attribute :created_at, Time
+  end
+
+  let(:response_body) do
+    {
+      data: {
+        id:         12,
+        title:      'Lorem Ipsum',
+        body:       'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
+        created_at: Time.new(2015, 10, 4, 9, 30, 0),
+      }
+    }
+  end
+
+  let(:expected_default_headers) do
+    { 'Accept' => 'application/json', 'User-Agent' => "RemoteResource #{RemoteResource::VERSION}" }
+  end
+
+  describe 'default behaviour' do
+    let!(:expected_request) do
+      mock_request = stub_request(:get, 'https://www.example.com/posts/12.json')
+      mock_request.with(query: nil, body: nil, headers: expected_default_headers)
+      mock_request.to_return(status: 200, body: response_body.to_json)
+      mock_request
+    end
+
+    it 'performs the correct HTTP GET request' do
+      Post.find(12)
+      expect(expected_request).to have_been_requested
+    end
+
+    it 'builds the correct resource' do
+      post = Post.find(12)
+
+      aggregate_failures do
+        expect(post.id).to eql 12
+        expect(post.title).to eql 'Lorem Ipsum'
+        expect(post.body).to eql 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'
+        expect(post.created_at).to eql Time.new(2015, 10, 4, 9, 30, 0)
+      end
+    end
+  end
+
+  describe 'with connection_options[:params]' do
+    let!(:expected_request) do
+      mock_request = stub_request(:get, 'https://www.example.com/posts/12.json')
+      mock_request.with(query: { pseudonym: 'pseudonym' }, body: nil, headers: expected_default_headers)
+      mock_request.to_return(status: 200, body: response_body.to_json)
+      mock_request
+    end
+
+    it 'performs the correct HTTP GET request' do
+      Post.find(12, params: { pseudonym: 'pseudonym' })
+      expect(expected_request).to have_been_requested
+    end
+  end
+
+  describe 'with connection_options[:headers]' do
+    let!(:expected_request) do
+      mock_request = stub_request(:get, 'https://www.example.com/posts/12.json')
+      mock_request.with(query: nil, body: nil, headers: { 'X-Pseudonym' => 'pseudonym' })
+      mock_request.to_return(status: 200, body: response_body.to_json)
+      mock_request
+    end
+
+    it 'performs the correct HTTP GET request' do
+      Post.find(12, headers: { 'X-Pseudonym' => 'pseudonym' })
+      expect(expected_request).to have_been_requested
+    end
+  end
+
+  describe 'with a 404 response' do
+    let!(:expected_request) do
+      mock_request = stub_request(:get, 'https://www.example.com/posts/12.json')
+      mock_request.with(query: { pseudonym: 'pseudonym' }, body: nil, headers: expected_default_headers.merge({ 'X-Pseudonym' => 'pseudonym' }))
+      mock_request.to_return(status: 404)
+      mock_request
+    end
+
+    it 'raises the not found error' do
+      expect { Post.find(12, params: { pseudonym: 'pseudonym' }, headers: { 'X-Pseudonym' => 'pseudonym' }) }.to raise_error RemoteResource::HTTPNotFound
+    end
+
+    it 'adds metadata to the raised error' do
+      begin
+        Post.find(12, params: { pseudonym: 'pseudonym' }, headers: { 'X-Pseudonym' => 'pseudonym' })
+      rescue RemoteResource::HTTPNotFound => error
+        aggregate_failures do
+          expect(error.message).to eql 'HTTP request failed for Post with response_code=404 with http_action=get with request_url=https://www.example.com/posts/12.json'
+          expect(error.request_url).to eql 'https://www.example.com/posts/12.json'
+          expect(error.response_code).to eql 404
+          expect(error.request_query).to eql(RemoteResource::Util.encode_params_to_query({ pseudonym: 'pseudonym' }))
+          expect(error.request_headers).to eql(expected_default_headers.merge({ 'X-Pseudonym' => 'pseudonym' }))
+        end
+      end
+    end
+  end
+
+  describe 'with a 500 response' do
+    let!(:expected_request) do
+      mock_request = stub_request(:get, 'https://www.example.com/posts/12.json')
+      mock_request.with(query: { pseudonym: 'pseudonym' }, body: nil, headers: expected_default_headers.merge({ 'X-Pseudonym' => 'pseudonym' }))
+      mock_request.to_return(status: 500)
+      mock_request
+    end
+
+    it 'raises the server error' do
+      expect { Post.find(12, params: { pseudonym: 'pseudonym' }, headers: { 'X-Pseudonym' => 'pseudonym' }) }.to raise_error RemoteResource::HTTPServerError
+    end
+
+    it 'adds metadata to the raised error' do
+      begin
+        Post.find(12, params: { pseudonym: 'pseudonym' }, headers: { 'X-Pseudonym' => 'pseudonym' })
+      rescue RemoteResource::HTTPServerError => error
+        aggregate_failures do
+          expect(error.message).to eql 'HTTP request failed for Post with response_code=500 with http_action=get with request_url=https://www.example.com/posts/12.json'
+          expect(error.request_url).to eql 'https://www.example.com/posts/12.json'
+          expect(error.response_code).to eql 500
+          expect(error.request_query).to eql(RemoteResource::Util.encode_params_to_query({ pseudonym: 'pseudonym' }))
+          expect(error.request_headers).to eql(expected_default_headers.merge({ 'X-Pseudonym' => 'pseudonym' }))
+        end
+      end
+    end
+  end
+
+end

data/spec/integration/headers_spec.rb

@@ -0,0 +1,222 @@
+require 'spec_helper'
+
+RSpec.describe 'headers in connection_options' do
+
+  class Post
+    include RemoteResource::Base
+
+    self.site         = 'https://www.example.com'
+    self.collection   = true
+    self.root_element = :data
+
+    attribute :title, String
+    attribute :body, String
+    attribute :featured, Boolean
+    attribute :created_at, Time
+  end
+
+  let(:response_body) do
+    {
+      data: {
+        id:         12,
+        title:      'Aliquam lobortis',
+        body:       'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
+        featured:   false,
+        created_at: Time.new(2015, 10, 4, 9, 30, 0),
+      }
+    }
+  end
+
+  describe 'default behaviour' do
+    let(:expected_headers) do
+      {
+        'Accept'     => 'application/json',
+        'User-Agent' => "RemoteResource #{RemoteResource::VERSION}"
+      }
+    end
+
+    let!(:expected_request) do
+      mock_request = stub_request(:get, 'https://www.example.com/posts/12.json')
+      mock_request.with(headers: expected_headers)
+      mock_request.to_return(status: 200, body: response_body.to_json)
+      mock_request
+    end
+
+    it 'performs the correct HTTP GET request with the default headers' do
+      Post.find(12)
+      expect(expected_request).to have_been_requested
+    end
+  end
+
+  describe 'connection_options[:headers]' do
+    let(:expected_headers) do
+      {
+        'Accept'     => 'application/json',
+        'User-Agent' => "RemoteResource #{RemoteResource::VERSION}",
+        'X-Locale'   => 'From connection_options[:headers]'
+      }
+    end
+
+    let!(:expected_request) do
+      mock_request = stub_request(:get, 'https://www.example.com/posts/12.json')
+      mock_request.with(headers: expected_headers)
+      mock_request.to_return(status: 200, body: response_body.to_json)
+      mock_request
+    end
+
+    it 'performs the correct HTTP GET request with the default headers and connection_options[:headers]' do
+      Post.find(12, { headers: { 'X-Locale' => 'From connection_options[:headers]' } })
+      expect(expected_request).to have_been_requested
+    end
+  end
+
+  describe 'connection_options[:default_headers]' do
+    let(:expected_headers) do
+      {
+        'User-Agent' => 'From connection_options[:default_headers]',
+        'X-Locale' => 'From connection_options[:headers]'
+      }
+    end
+
+    let!(:expected_request) do
+      mock_request = stub_request(:get, 'https://www.example.com/posts/12.json')
+      mock_request.with(headers: expected_headers)
+      mock_request.to_return(status: 200, body: response_body.to_json)
+      mock_request
+    end
+
+    it 'performs the correct HTTP GET request overriding the default headers with the connection_options[:default_headers]' do
+      Post.find(12, { headers: { 'X-Locale' => 'From connection_options[:headers]' }, default_headers: { 'User-Agent' => 'From connection_options[:default_headers]' } })
+      expect(expected_request).to have_been_requested
+    end
+  end
+
+  describe '.default_headers' do
+    let(:expected_headers) do
+      {
+        'User-Agent' => 'From .default_headers',
+        'X-Locale' => 'From connection_options[:headers]'
+      }
+    end
+
+    let!(:expected_request) do
+      mock_request = stub_request(:get, 'https://www.example.com/posts/12.json')
+      mock_request.with(headers: expected_headers)
+      mock_request.to_return(status: 200, body: response_body.to_json)
+      mock_request
+    end
+
+    before { Post.default_headers = { 'User-Agent' => 'From .default_headers' } }
+    after { Post.default_headers = {} }
+
+    it 'performs the correct HTTP GET request overriding the default headers with the .default_headers headers' do
+      Post.find(12, { headers: { 'X-Locale' => 'From connection_options[:headers]' } })
+      expect(expected_request).to have_been_requested
+    end
+  end
+
+  describe 'connection_options[:default_headers] and .default_headers' do
+    let(:expected_headers) do
+      {
+        'User-Agent' => 'From connection_options[:default_headers]',
+        'X-Locale' => 'From connection_options[:headers]'
+      }
+    end
+
+    let!(:expected_request) do
+      mock_request = stub_request(:get, 'https://www.example.com/posts/12.json')
+      mock_request.with(headers: expected_headers)
+      mock_request.to_return(status: 200, body: response_body.to_json)
+      mock_request
+    end
+
+    before { Post.default_headers = { 'User-Agent' => 'From .default_headers' } }
+    after { Post.default_headers = {} }
+
+    it 'performs the correct HTTP GET request overriding the default headers with the connection_options[:default_headers]' do
+      Post.find(12, { headers: { 'X-Locale' => 'From connection_options[:headers]' }, default_headers: { 'User-Agent' => 'From connection_options[:default_headers]' } })
+      expect(expected_request).to have_been_requested
+    end
+  end
+
+  describe 'RemoteResource::Base.global_headers' do
+    let(:expected_headers) do
+      {
+        'Accept'        => 'application/json',
+        'User-Agent'    => 'From RemoteResource::Base.global_headers',
+        'Authorization' => 'From RemoteResource::Base.global_headers',
+        'X-Locale'      => 'From connection_options[:headers]',
+      }
+    end
+
+    let!(:expected_request) do
+      mock_request = stub_request(:get, 'https://www.example.com/posts/12.json')
+      mock_request.with(headers: expected_headers)
+      mock_request.to_return(status: 200, body: response_body.to_json)
+      mock_request
+    end
+
+    before { RemoteResource::Base.global_headers = { 'User-Agent' => 'From RemoteResource::Base.global_headers', 'X-Locale' => 'From RemoteResource::Base.global_headers', 'Authorization' => 'From RemoteResource::Base.global_headers' } }
+    after { RemoteResource::Base.global_headers = nil }
+
+    it 'performs the correct HTTP GET request with the default headers and the .global_headers headers' do
+      Post.find(12, { headers: { 'X-Locale' => 'From connection_options[:headers]' } })
+      expect(expected_request).to have_been_requested
+    end
+  end
+
+  describe '.with_connection_options' do
+    let(:expected_headers) do
+      {
+        'Accept'        => 'application/json',
+        'User-Agent'    => 'From .with_connection_options',
+        'Authorization' => 'From .with_connection_options',
+        'X-Locale'      => 'From connection_options[:headers]',
+      }
+    end
+
+    let!(:expected_request) do
+      mock_request = stub_request(:get, 'https://www.example.com/posts/12.json')
+      mock_request.with(headers: expected_headers)
+      mock_request.to_return(status: 200, body: response_body.to_json)
+      mock_request
+    end
+
+    it 'performs the correct HTTP GET request with the default headers and the .with_connection_options headers' do
+      Post.with_connection_options({ headers: { 'User-Agent' => 'From .with_connection_options', 'X-Locale' => 'From .with_connection_options', 'Authorization' => 'From .with_connection_options' } }) do
+        Post.find(12, { headers: { 'X-Locale' => 'From connection_options[:headers]' } })
+      end
+      expect(expected_request).to have_been_requested
+    end
+  end
+
+  describe 'RemoteResource::Base.global_headers and .with_connection_options' do
+    let(:expected_headers) do
+      {
+        'Accept'        => 'application/json',
+        'User-Agent'    => 'From RemoteResource::Base.global_headers',
+        'Authorization' => 'From .with_connection_options',
+        'X-Locale'      => 'From connection_options[:headers]',
+        'X-Country'     => 'From connection_options[:headers]',
+      }
+    end
+
+    let!(:expected_request) do
+      mock_request = stub_request(:get, 'https://www.example.com/posts/12.json')
+      mock_request.with(headers: expected_headers)
+      mock_request.to_return(status: 200, body: response_body.to_json)
+      mock_request
+    end
+
+    before { RemoteResource::Base.global_headers = { 'User-Agent' => 'From RemoteResource::Base.global_headers', 'X-Locale' => 'From RemoteResource::Base.global_headers', 'Authorization' => 'From RemoteResource::Base.global_headers' } }
+    after { RemoteResource::Base.global_headers = nil }
+
+    it 'performs the correct HTTP GET request with the default headers and the .global_headers headers and the and .with_connection_options headers' do
+      Post.with_connection_options({ headers: { 'Authorization' => 'From .with_connection_options' } }) do
+        Post.find(12, { headers: { 'X-Locale' => 'From connection_options[:headers]', 'X-Country' => 'From connection_options[:headers]' } })
+      end
+      expect(expected_request).to have_been_requested
+    end
+  end
+
+end

data/spec/integration/naming_spec.rb

@@ -0,0 +1,138 @@
+require 'spec_helper'
+
+RSpec.describe 'connection_options for naming' do
+
+  class Post
+    include RemoteResource::Base
+
+    self.site         = 'https://www.example.com'
+    self.collection   = true
+    self.root_element = :data
+
+    attribute :title, String
+    attribute :body, String
+    attribute :featured, Boolean
+    attribute :created_at, Time
+  end
+
+  describe 'connection_options[:site]' do
+    let(:response_body) do
+      {
+        data: {
+          id:         12,
+          title:      'Aliquam lobortis',
+          body:       'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
+          featured:   false,
+          created_at: Time.new(2015, 10, 4, 9, 30, 0),
+        }
+      }
+    end
+
+    let!(:expected_request) do
+      mock_request = stub_request(:get, 'https://api.example.com/posts/12.json')
+      mock_request.to_return(status: 200, body: response_body.to_json)
+      mock_request
+    end
+
+    it 'performs the correct HTTP GET request' do
+      Post.find(12, { site: 'https://api.example.com' })
+      Post.find(12, { site: 'https://api.example.com/' })
+      expect(expected_request).to have_been_requested.times(2)
+    end
+  end
+
+  describe 'connection_options[:version]' do
+    let(:response_body) do
+      {
+        data: {
+          id:         12,
+          title:      'Aliquam lobortis',
+          body:       'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
+          featured:   false,
+          created_at: Time.new(2015, 10, 4, 9, 30, 0),
+        }
+      }
+    end
+
+    let!(:expected_request) do
+      mock_request = stub_request(:get, 'https://www.example.com/api/v2/posts/12.json')
+      mock_request.to_return(status: 200, body: response_body.to_json)
+      mock_request
+    end
+
+    it 'performs the correct HTTP GET request' do
+      Post.find(12, { version: '/api/v2' })
+      Post.find(12, { version: 'api/v2' })
+      Post.find(12, { version: '/api/v2/' })
+      expect(expected_request).to have_been_requested.times(3)
+    end
+  end
+
+  describe 'connection_options[:version] and connection_options[:path_prefix]' do
+    let(:response_body) do
+      {
+        data: {
+          id:         12,
+          title:      'Aliquam lobortis',
+          body:       'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
+          featured:   false,
+          created_at: Time.new(2015, 10, 4, 9, 30, 0),
+        }
+      }
+    end
+
+    let!(:expected_request) do
+      mock_request = stub_request(:get, 'https://www.example.com/api/v2/archive/posts/12.json')
+      mock_request.to_return(status: 200, body: response_body.to_json)
+      mock_request
+    end
+
+    it 'performs the correct HTTP GET request' do
+      Post.find(12, { version: '/api/v2', path_prefix: '/archive' })
+      Post.find(12, { version: 'api/v2', path_prefix: 'archive' })
+      Post.find(12, { version: '/api/v2/', path_prefix: '/archive/' })
+      expect(expected_request).to have_been_requested.times(3)
+    end
+  end
+
+  describe 'connection_options[:path_postfix]' do
+    let(:response_body) do
+      {
+        data: {
+          id:         12,
+          title:      'Aliquam lobortis',
+          body:       'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
+          featured:   false,
+          created_at: Time.new(2015, 10, 4, 9, 30, 0),
+        }
+      }
+    end
+
+    let!(:expected_request_singular) do
+      mock_request = stub_request(:get, 'https://www.example.com/posts/12/featured.json')
+      mock_request.to_return(status: 200, body: response_body.to_json)
+      mock_request
+    end
+
+    let!(:expected_request_collection) do
+      mock_request = stub_request(:get, 'https://www.example.com/posts/featured.json')
+      mock_request.to_return(status: 200, body: response_body.to_json)
+      mock_request
+    end
+
+    it 'performs the correct HTTP GET request for a singular resource' do
+      Post.find(12, { path_postfix: '/featured' })
+      Post.find(12, { path_postfix: 'featured' })
+      Post.find(12, { path_postfix: '/featured/' })
+      expect(expected_request_singular).to have_been_requested.times(3)
+    end
+
+    it 'performs the correct HTTP GET request for a collection resource' do
+      Post.all({ path_postfix: '/featured' })
+      Post.all({ path_postfix: 'featured' })
+      Post.all({ path_postfix: '/featured/' })
+      expect(expected_request_collection).to have_been_requested.times(3)
+    end
+  end
+
+end