flexirest 1.3.35 → 1.4.0

data/spec/lib/json_api_spec.rb

@@ -0,0 +1,392 @@
+require 'spec_helper'
+
+class JsonAPIAssociationExampleAuthor < Flexirest::Base; end
+
+class JsonAPIAssociationExampleTag < Flexirest::Base
+  proxy :json_api
+  has_many :authors, JsonAPIAssociationExampleAuthor
+end
+
+class JsonAPIAssociationExampleAuthor < Flexirest::Base
+  proxy :json_api
+  has_one :tag, JsonAPIAssociationExampleTag
+end
+
+class JsonAPIExampleArticle < Flexirest::Base
+  proxy :json_api
+  has_many :tags, JsonAPIAssociationExampleTag
+  has_one :author, JsonAPIAssociationExampleAuthor
+
+  faker1 = {
+    data: {
+      id: 1, type: 'articles', attributes: { item: 'item one' },
+      relationships: {
+        'tags' => { data: [{ id: 1, type: 'tags' }, { id: 2, type: 'tags' }] }
+      }
+    },
+    included: [
+      { id: 1, type: 'tags', attributes: { item: 'item two' } },
+      { id: 2, type: 'tags', attributes: { item: 'item three' } }
+    ]
+  }
+  faker2 = {
+    data: [
+      {
+        id: 1, type: 'articles', attributes: { item: 'item one' },
+        relationships: {
+          'tags' => { data: [{ id: 1, type: 'tags' }, { id: 2, type: 'tags' }] }
+        }
+      },
+      {
+        id: 2, type: 'articles', attributes: { item: 'item four' },
+        relationships: {
+          'tags' => { data: [{ id: 2, type: 'tags' }] }
+        }
+      }
+    ],
+    included: [
+      { id: 1, type: 'tags', attributes: { item: 'item two' } },
+      { id: 2, type: 'tags', attributes: { item: 'item three' } }
+    ]
+  }
+  faker3 = {
+    data: {
+      id: 1, type: 'articles', attributes: { item: 'item one' },
+      relationships: { 'author' => { data: { id: 1, type: 'authors' } } }
+    },
+    included: [{ id: 1, type: 'authors', attributes: { item: 'item two' } }]
+  }
+  faker4 = {
+    data: {
+      id: 1, type: 'articles', attributes: { item: 'item one' },
+      relationships: { 'author' => { data: { id: 1, type: 'authors' } } }
+    },
+    included: [
+      { id: 1, type: 'authors', attributes: { item: 'item two' },
+        relationships: { 'tag' => { data: { id: 1, type: 'tags' } } } },
+      { id: 1, type: 'tags', attributes: { item: 'item three' } }
+    ]
+  }
+  faker5 = {
+    data: {
+      id: 1, type: 'articles', attributes: { item: 'item one' },
+      relationships: { 'tags' => { data: [{ id: 1, type: 'tags' }] } }
+    },
+    included: [
+      { id: 1, type: 'tags', attributes: { item: 'item three' },
+        relationships: { 'authors' => { data: [{ id: 1, type: 'tags' }] } } },
+      { id: 1, type: 'authors', attributes: { item: 'item two' } }
+    ]
+  }
+  faker6 = {
+    data: {
+      id: 1, type: 'articles', attributes: { item: 'item one' },
+      relationships: { 'tags' => { data: [] }, 'author' => { data: nil } }
+    }
+  }
+
+  get(
+    :find,
+    '/articles/:id',
+    fake: faker1.to_json,
+    fake_content_type: 'application/vnd.api+json'
+  )
+
+  get(
+    :find_all,
+    '/articles',
+    fake: faker2.to_json,
+    fake_content_type: 'application/vnd.api+json'
+  )
+
+  get(
+    :find_single_author,
+    '/articles/:id',
+    fake: faker3.to_json,
+    fake_content_type: 'application/vnd.api+json'
+  )
+
+  get(
+    :find_single_nested,
+    '/articles/:id',
+    fake: faker4.to_json,
+    fake_content_type: 'application/vnd.api+json'
+  )
+
+  get(
+    :find_multi_nested,
+    '/articles/:id',
+    fake: faker5.to_json,
+    fake_content_type: 'application/vnd.api+json'
+  )
+
+  get(
+    :no_assocs,
+    '/articles/:id',
+    fake: faker6.to_json,
+    fake_content_type: 'application/vnd.api+json'
+  )
+end
+
+module JsonAPIExample
+  class Author < Flexirest::Base
+    proxy :json_api
+    base_url 'http://www.example.com'
+
+    author_faker = {
+      data: { id: 1, type: 'authors', attributes: { item: 'item three' } }
+    }
+
+    get(
+      :find_author,
+      '/articles/:article_id/author',
+      fake: author_faker.to_json,
+      fake_content_type: 'application/vnd.api+json'
+    )
+  end
+
+  class Tag < Flexirest::Base
+    proxy :json_api
+    base_url 'http://www.example.com'
+
+    tags_faker = {
+      data: [{ id: 1, type: 'tags', attributes: { item: 'item two' } }]
+    }
+
+    get(
+      :find_tags,
+      '/articles/:article_id/tags',
+      fake: tags_faker.to_json,
+      fake_content_type: 'application/vnd.api+json'
+    )
+  end
+
+  class Article < Flexirest::Base
+    base_url 'http://www.example.com'
+    proxy :json_api
+    has_one :author, Author
+    has_many :tags, Tag
+
+    faker = {
+      data: { id: 1, type: 'articles', attributes: { item: 'item one' } }
+    }
+
+    faker_lazy = {
+      data: {
+        id: 1, type: 'articles', attributes: { item: 'item one' },
+        relationships: {
+          'tags' => {
+            links: {
+              self: 'http://www.example.com/articles/1/relationships/tags',
+              related: 'http://www.example.com/articles/1/tags'
+            }
+          },
+          'author' => {
+            links: {
+              self: 'http://www.example.com/articles/1/relationships/author',
+              related: 'http://www.example.com/articles/1/author'
+            }
+          }
+        }
+      }
+    }
+
+    get(
+      :find_lazy,
+      '/articles/:id',
+      fake: faker_lazy.to_json,
+      fake_content_type: 'application/vnd.api+json'
+    )
+
+    get(
+      :find,
+      '/articles/:id',
+      fake: faker.to_json,
+      fake_content_type: 'application/vnd.api+json'
+    )
+
+    post :create, '/articles', fake_content_type: 'application/vnd.api+json'
+
+    patch(
+      :update,
+      '/articles/:id',
+      fake_content_type: 'application/vnd.api+json'
+    )
+
+    delete(
+      :delete,
+      '/articles/:id',
+      fake_content_type: 'application/vnd.api+json'
+    )
+  end
+
+  class AuthorAlias < Flexirest::Base
+    alias_type :authors
+    proxy :json_api
+  end
+
+  class ArticleAlias < Flexirest::Base
+    alias_type :articles
+    base_url 'http://www.example.com'
+    proxy :json_api
+    has_one :author, AuthorAlias
+
+    faker = {
+      data: { id: 1, type: 'articles', attributes: { item: 'item one' } }
+    }
+
+    get(
+      :find,
+      '/articles/:id',
+      fake: faker.to_json,
+      fake_content_type: 'application/vnd.api+json'
+    )
+
+    patch :update, '/articles/:id'
+  end
+end
+
+describe 'JSON API' do
+  let(:subject) { JsonAPIExampleArticle }
+  let(:article) { JsonAPIExample::Article }
+  let(:tags) { JsonAPIExample::Tag }
+  let(:author) { JsonAPIExample::Author }
+
+  context 'responses' do
+    it 'should return the data object if the response contains only one data instance' do
+      expect(subject.find(1)).to be_an_instance_of(JsonAPIExampleArticle)
+    end
+
+    it 'should return a Flexirest::ResultIterator if the response contains more than one data instance' do
+      expect(subject.find_all).to be_an_instance_of(Flexirest::ResultIterator)
+    end
+  end
+
+  context 'attributes' do
+    it 'should return the attributes as part of the data instance' do
+      expect(subject.find(1).item).to_not be_nil
+    end
+
+    it 'should return the association\'s attributes as part of the association instance' do
+      expect(subject.includes(:author).find_single_author(1).author.item).to_not be_nil
+    end
+  end
+
+  context 'associations' do
+    it 'should retrieve the resource\'s associations via its relationships object' do
+      expect(subject.includes(:tags).find(1).tags.size).to eq(2)
+    end
+
+    it 'should retrieve the response object if the relationship type is singular' do
+      expect(subject.includes(:author).find_single_author(1).author).to be_an_instance_of(JsonAPIAssociationExampleAuthor)
+    end
+
+    it 'should retrieve a Flexirest::ResultIterator if the relationship type is plural' do
+      expect(subject.includes(:tags).find(1).tags).to be_an_instance_of(Flexirest::ResultIterator)
+    end
+
+    it 'should retrieve nested linked resources' do
+      expect(subject.includes(author: [:tag]).find_single_nested(1).author.tag).to be_an_instance_of(JsonAPIAssociationExampleTag)
+      expect(subject.includes(author: [:tag]).find_single_nested(1).author.tag.id).to_not be_nil
+      expect(subject.includes(tags: [:authors]).find_multi_nested(1).tags.first.authors.first).to be_an_instance_of(JsonAPIAssociationExampleAuthor)
+      expect(subject.includes(tags: [:authors]).find_multi_nested(1).tags.first.authors.first.id).to_not be_nil
+    end
+
+    it 'should retrieve a nil if the singular relationship type is empty' do
+      expect(subject.includes(:author).no_assocs(1).author).to be_nil
+    end
+
+    it 'should retrieve empty array if the plural relationship type is empty' do
+      expect(subject.includes(:tags).no_assocs(1).tags).to be_empty
+    end
+  end
+
+  context 'lazy loading' do
+    it 'should fetch association lazily' do
+      stub_request(:get, /www.example.com\/articles\/1\/tags/)
+        .to_return(body: tags.find_tags(article_id: 1).to_json)
+      stub_request(:get, /www.example.com\/articles\/1\/author/)
+        .to_return(body: author.find_author(article_id: 1).to_json)
+
+      expect(article.find_lazy(1).tags).to be_an_instance_of(Flexirest::LazyAssociationLoader)
+      expect(article.find_lazy(1).tags.count).to be_an(Integer)
+      expect(article.find_lazy(1).tags.first.id).to_not be_nil
+      expect(article.find_lazy(1).author).to be_an_instance_of(JsonAPIExample::Author)
+      expect(article.find_lazy(1).author.id).to_not be_nil
+    end
+  end
+
+  context 'client' do
+    it 'should request with json api format, and expect a json api response' do
+      expect_any_instance_of(Flexirest::Connection).to receive(:post) { |_, _, _, options|
+        expect(options[:headers]).to include('Content-Type' => 'application/vnd.api+json')
+        expect(options[:headers]).to include('Accept' => 'application/vnd.api+json')
+      }.and_return(::FaradayResponseMock.new(OpenStruct.new(body:'{}', response_headers:{})))
+      JsonAPIExample::Article.new.create
+    end
+
+    it 'should perform a post request in proper json api format' do
+      expect_any_instance_of(Flexirest::Connection).to receive(:post) { |_, path, data|
+        hash = MultiJson.load(data)
+        expect(path).to eq('/articles')
+        expect(hash['data']).to_not be_nil
+        expect(hash['data']['id']).to be_nil
+        expect(hash['data']['type']).to eq('articles')
+        expect(hash['data']['relationships']['author']['data']['type']).to eq('authors')
+        expect(hash['data']['relationships']['tags']['data'].first['type']).to eq('tags')
+      }.and_return(::FaradayResponseMock.new(OpenStruct.new(body:'{}', response_headers:{})))
+      author = JsonAPIExample::Author.new
+      tag = JsonAPIExample::Tag.new
+      article = JsonAPIExample::Article.new
+      article.item = 'item one'
+      article.author = author
+      article.tags = [tag]
+      article.create
+    end
+
+    it 'should raise a Flexirest error when two different classes are in one relationship' do
+      author = JsonAPIExample::Author.new
+      tag = JsonAPIExample::Tag.new
+      article = JsonAPIExample::Article.new
+      article.item = 'item one'
+      article.tags = [tag, author]
+      expect(lambda { article.create }).to raise_error(Exception)
+    end
+
+    it 'should perform a patch request in proper json api format' do
+      expect_any_instance_of(Flexirest::Connection).to receive(:patch) { |_, path, data|
+        hash = MultiJson.load(data)
+        expect(path).to eq('/articles/1')
+        expect(hash['data']).to_not be_nil
+        expect(hash['data']['id']).to_not be_nil
+        expect(hash['data']['type']).to_not be_nil
+      }.and_return(::FaradayResponseMock.new(OpenStruct.new(body:'{}', response_headers:{})))
+      article = JsonAPIExample::Article.find(1)
+      article.item = 'item one'
+      article.update
+    end
+
+    it 'should perform a delete request in proper json api format' do
+      expect_any_instance_of(Flexirest::Connection).to receive(:delete) { |_, path, data|
+        expect(path).to eq('/articles/1')
+        expect(data).to eq('')
+      }.and_return(::FaradayResponseMock.new(OpenStruct.new(body:'{}', response_headers:{})))
+      JsonAPIExample::Article.find(1).delete
+    end
+
+    it 'should have placed the right type value in the request' do
+      expect_any_instance_of(Flexirest::Connection).to receive(:patch) { |_, _, data|
+        hash = MultiJson.load(data)
+        expect(hash['data']['type']).to eq(JsonAPIExample::ArticleAlias.alias_type.to_s)
+        expect(hash['data']['relationships']['author']['data']['type']).to eq(JsonAPIExample::AuthorAlias.alias_type.to_s)
+      }.and_return(::FaradayResponseMock.new(OpenStruct.new(body:'{}', response_headers:{})))
+      author = JsonAPIExample::AuthorAlias.new
+      author.id = 1
+      article = JsonAPIExample::ArticleAlias.find(1)
+      article.item = 'item one'
+      article.author = author
+      article.update
+    end
+
+  end
+end

data/spec/lib/request_spec.rb

@@ -501,6 +501,7 @@ describe Flexirest::Request do
       with("/create", "first_name=John&should_disappear=true", an_instance_of(Hash)).
       and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"first_name\":\"John\", \"id\":1234}", response_headers:{}, status:200)))
     expect(Flexirest::Logger).to receive(:info).with(%r'Requesting http://www.example.com/create')
+    allow(Flexirest::Logger).to receive(:debug)
     expect(Flexirest::Logger).to receive(:debug).at_least(1).times.with(%r'(Response received \d+ bytes|Trying to read from cache)')
 
     object = ExampleClient.new(first_name:"John", should_disappear:true)
@@ -514,6 +515,7 @@ describe Flexirest::Request do
       with("/create", "first_name=John&should_disappear=true", an_instance_of(Hash)).
       and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"first_name\":\"John\", \"id\":1234}", response_headers:{}, status:200)))
     expect(Flexirest::Logger).to receive(:info).with(%r'Requesting http://www.example.com/create')
+    allow(Flexirest::Logger).to receive(:debug)
     expect(Flexirest::Logger).to receive(:debug).at_least(1).times.with(%r'(Response received \d+ bytes|Trying to read from cache)')
 
     object = ExampleClient.new(first_name:"John", should_disappear:true)
@@ -526,7 +528,7 @@ describe Flexirest::Request do
       with("/create", "first_name=John&should_disappear=true", an_instance_of(Hash)).
       and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"first_name\":\"John\", \"id\":1234}", response_headers:{}, status:200)))
     expect(Flexirest::Logger).to receive(:debug).with(/ POST /)
-    allow(Flexirest::Logger).to receive(:debug).with(any_args)
+    allow(Flexirest::Logger).to receive(:debug)
 
     object = VerboseExampleClient.new(first_name:"John", should_disappear:true)
     object.create

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.3.35
+  version: 1.4.0
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-13 00:00:00.000000000 Z
+date: 2017-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -242,6 +242,7 @@ files:
 - lib/flexirest/connection_manager.rb
 - lib/flexirest/headers_list.rb
 - lib/flexirest/instrumentation.rb
+- lib/flexirest/json_api_proxy.rb
 - lib/flexirest/lazy_association_loader.rb
 - lib/flexirest/lazy_loader.rb
 - lib/flexirest/logger.rb
@@ -266,6 +267,7 @@ files:
 - spec/lib/flexirest_spec.rb
 - spec/lib/headers_list_spec.rb
 - spec/lib/instrumentation_spec.rb
+- spec/lib/json_api_spec.rb
 - spec/lib/lazy_association_loader_spec.rb
 - spec/lib/lazy_loader_spec.rb
 - spec/lib/logger_spec.rb
@@ -317,6 +319,7 @@ test_files:
 - spec/lib/flexirest_spec.rb
 - spec/lib/headers_list_spec.rb
 - spec/lib/instrumentation_spec.rb
+- spec/lib/json_api_spec.rb
 - spec/lib/lazy_association_loader_spec.rb
 - spec/lib/lazy_loader_spec.rb
 - spec/lib/logger_spec.rb