jsonapi-consumer 0.1.1 → 1.0.0

data/spec/fixtures/resources.rb

@@ -1,45 +0,0 @@
-class Base
-  include JSONAPI::Consumer::Resource
-
-  self.host = 'http://localhost:3000/api/'
-end
-
-
-class BasicResource < Base
-
-end
-
-class BuildRequest < Base
-  self.request_new_object_on_build = true
-end
-
-
-# BEGIN - Blog example
-module Blog
-  class Author < Base
-    has_many :posts, class_name: 'Blog::Post'
-  end
-
-  class Post < Base
-    has_one :user, class_name: 'Blog::User'
-    has_many :comments, class_name: 'Blog::Comment'
-  end
-
-  class User < Base
-
-  end
-
-  class Comment < Base
-    # belongs_to :post, class_name: 'Blog::Post'
-    # has_one :author, class_name: 'Blog::Author'
-  end
-end
-# END - Blog example
-
-
-class NotCalled < Faraday::Response::Middleware
-  class ::NotCalledError < StandardError; end
-  def parse(body)
-    raise NotCalledError, "this should not be called"
-  end
-end

data/spec/fixtures/responses.rb

@@ -1,64 +0,0 @@
-module Responses
-  def self.sideload
-    {
-      posts: [
-        {
-          links: {
-            comments: [
-              "82083863-bba9-480e-a281-f5d34e7dc0ca",
-              "3b402e8a-7c35-4915-8c72-07ea7779ab76"
-            ],
-            user: "6a45992f-cd20-497a-a753-21b2a1a82356"
-          },
-          id: "e6d1b7ac-80d8-40dd-877d-f5bd40feabfb",
-          title: "Friday Post",
-          created_at: "2014-10-19T22:32:52.913Z",
-          updated_at: "2014-10-19T22:32:52.967Z"
-        },
-        {
-          links: {
-            comments: [
-              "9c9ba83b-024c-4d4c-9573-9fd41b95fc14",
-              "27fcf6e8-24b0-41db-94b1-812046a10f54"
-            ],
-            user: "d65dda70-73eb-461a-bb34-5484e6e8c194"
-          },
-          id: "ea006f14-6d05-4e87-bfe7-ee8ae3358840",
-          title: "Monday Post",
-          created_at: "2014-10-19T22:32:52.933Z",
-          updated_at: "2014-10-19T22:32:52.969Z"
-        }
-      ],
-      linked: {
-        users: [
-          {
-            id: "6a45992f-cd20-497a-a753-21b2a1a82356",
-            name: "Jane Smith"
-          },
-          {
-            id: "d65dda70-73eb-461a-bb34-5484e6e8c194",
-            name: "Jim Bob"
-          }
-        ],
-        comments: [
-          {
-            id: "82083863-bba9-480e-a281-f5d34e7dc0ca",
-            content: "Awesome article",
-            created_at: "2014-10-19T22:32:52.933Z",
-            updated_at: "2014-10-19T22:32:52.969Z"
-          },
-          {
-            id: "3b402e8a-7c35-4915-8c72-07ea7779ab76",
-            content: "Hated it",
-            created_at: "2014-10-19T22:32:52.933Z",
-            updated_at: "2014-10-19T22:32:52.969Z"
-          }
-        ]
-      },
-      links: {
-        :"posts.comments" => "http://localhost:3000/api/comments/{posts.comments}",
-        :"posts.user" => "http://localhost:3000/api/comments/{posts.user}"
-      }
-    }.with_indifferent_access
-  end
-end

data/spec/jsonapi/consumer/associations_spec.rb

@@ -1,166 +0,0 @@
-RSpec.describe 'Associations', 'has_many' do
-  let(:user_class) do
-    User ||= Class.new do
-      include JSONAPI::Consumer::Resource
-
-      has_many :posts, class_name: 'Post'
-    end
-  end
-
-  let!(:post_class) do
-    Post ||= Class.new do
-      include JSONAPI::Consumer::Resource
-    end
-  end
-
-  subject(:user_instance) { user_class.new(username: 'foobar') }
-
-  it 'lists association names in #association_names' do
-    expect(user_instance.association_names).to eql([:posts])
-  end
-
-  describe 'defined accessors for assocation' do
-    it { is_expected.to respond_to(:posts) }
-    it { is_expected.to respond_to(:posts=) }
-  end
-
-  describe 'adding objects to array' do
-    it 'can be added as a single value' do
-      expect {
-        user_instance.posts = '1'
-      }.to change{user_instance.post_ids}.from(nil).to(['1'])
-    end
-
-    it 'can be added as a list of items' do
-      expect {
-        user_instance.posts = ['1','2','3']
-      }.to change{user_instance.post_ids}.from(nil).to(['1','2','3'])
-    end
-
-    it 'can be blanked out' do
-      user_instance.posts = '1'
-      expect {
-        user_instance.posts = nil
-      }.to change{user_instance.post_ids}.from(['1']).to(nil)
-    end
-  end
-
-  describe 'the links payload' do
-    subject(:payload_hash) { user_instance.serializable_hash }
-
-    describe 'when populated' do
-      before do
-        user_instance.posts = ['1']
-      end
-
-      it 'has links in output, if present' do
-        expect(payload_hash).to have_key(:links)
-        expect(payload_hash[:links]).to eql({posts: ['1']})
-        expect(payload_hash[:links][:posts]).to eql(["1"])
-      end
-    end
-
-    describe 'when empty' do
-      it 'has no links in output' do
-        expect(payload_hash).to_not have_key(:links)
-      end
-    end
-
-    describe 'when persisted and empty' do
-      before do
-        allow(user_instance).to receive(:persisted?).and_return(true)
-      end
-
-      it 'has a links hash in the output' do
-        expect(payload_hash).to have_key(:links)
-        expect(payload_hash[:links]).to eql({posts: []})
-      end
-    end
-  end
-end
-
-RSpec.describe 'Associations', 'belongs_to' do
-  let(:comment_class) do
-    Comment ||= Class.new do
-      include JSONAPI::Consumer::Resource
-
-      # belongs_to :comment, class_name: 'Comment'
-      belongs_to :user, class_name: 'User'
-    end
-  end
-
-  let!(:user_class) do
-    User ||= Class.new do
-      include JSONAPI::Consumer::Resource
-    end
-  end
-
-  subject(:comment_instance) { comment_class.new }
-
-  it 'lists association names in #association_names' do
-    expect(comment_instance.association_names).to eql([:user])
-  end
-
-  describe 'defined accessors for assocation' do
-    it { is_expected.to respond_to(:user) }
-    it { is_expected.to respond_to(:user=) }
-  end
-
-  describe 'adding objects to belongs_to relationship' do
-    it 'can be added as a single value' do
-      expect {
-        comment_instance.user = '1'
-      }.to change{comment_instance.user_id}.from(nil).to('1')
-    end
-
-    it 'can be blanked out' do
-      comment_instance.user = '1'
-      expect {
-        comment_instance.user = nil
-      }.to change{comment_instance.user_id}.from('1').to(nil)
-    end
-  end
-end
-
-RSpec.describe 'Associations', 'has_one' do
-  let(:post_class) do
-    Poster ||= Class.new do
-      include JSONAPI::Consumer::Resource
-
-      has_one :author, class_name: 'Customer'
-    end
-  end
-
-  let!(:user_class) do
-    Customer ||= Class.new do
-      include JSONAPI::Consumer::Resource
-    end
-  end
-
-  subject(:post_instance) { post_class.new }
-
-  it 'lists association names in #association_names' do
-    expect(post_instance.association_names).to eql([:author])
-  end
-
-  describe 'defined accessors for assocation' do
-    it { is_expected.to respond_to(:author) }
-    it { is_expected.to respond_to(:author=) }
-  end
-
-  describe 'adding objects to belongs_to relationship' do
-    it 'can be added as a single value' do
-      expect {
-        post_instance.author = '1'
-      }.to change{post_instance.author_id}.from(nil).to('1')
-    end
-
-    it 'can be blanked out' do
-      post_instance.author = '1'
-      expect {
-        post_instance.author = nil
-      }.to change{post_instance.author_id}.from('1').to(nil)
-    end
-  end
-end
-

data/spec/jsonapi/consumer/attributes_spec.rb

@@ -1,27 +0,0 @@
-RSpec.describe 'Attributes' do
-  let(:test_class) do
-    Class.new do
-      include JSONAPI::Consumer::Resource
-    end
-  end
-
-  subject(:obj) { test_class.new }
-
-  its(:primary_key) { is_expected.to eql(:id) }
-
-  describe 'changing the primary key' do
-    it 'is updatable on the class' do
-      expect {
-        obj.class.primary_key = :name
-      }.to change{obj.primary_key}.to(:name)
-    end
-  end
-
-  describe '#persisted?' do
-    it 'uses the primary key to decide' do
-      expect {
-        obj.id = '8'
-      }.to change{obj.persisted?}.from(false).to(true)
-    end
-  end
-end

data/spec/jsonapi/consumer/connection_spec.rb

@@ -1,147 +0,0 @@
-RSpec.describe 'Connection' do
-  let(:test_class) do
-    Record ||= Class.new do
-      include JSONAPI::Consumer::Resource
-      self.host = 'http://localhost:3000/api/'
-
-      has_one :domain
-    end
-  end
-
-  let(:obj) { test_class.new(name: 'jsonapi.example') }
-
-  describe 'custom connection middleware' do
-
-    it 'handles custom middleware' do
-      stub_request(:get, "http://localhost:3000/api/basic_resources")
-        .with(headers: {accept: 'application/json'})
-        .to_return(headers: {content_type: "application/json"}, body: {
-          basic_resources: [
-            {id: '1'}
-          ]
-        }.to_json)
-
-      expect { BasicResource.all }.to_not raise_error
-
-      BasicResource.middleware do |conn|
-        conn.use NotCalled
-      end
-
-      expect { BasicResource.all }.to raise_error(NotCalledError)
-    end
-  end
-
-  describe '.all' do
-    it 'returns all results as objects' do
-      stub_request(:get, "http://localhost:3000/api/records")
-        .with(headers: {accept: 'application/json'})
-        .to_return(headers: {content_type: "application/json"}, body: {
-          records: [
-            {id: '1', name: "foo.example"},
-            {id: '2', name: "bar.example"},
-            {id: '3', name: "baz.example"}
-          ]
-        }.to_json)
-
-      records = test_class.all
-      expect(records.size).to eql(3)
-
-      record = records.first
-      expect(record).to be_a(Record)
-    end
-
-    it 'accepts additional params' do
-      stub_request(:get, "http://localhost:3000/api/records")
-        .with(headers: {accept: 'application/json'})
-        .to_return(headers: {content_type: "application/json"}, body: {
-          records: []
-        }.to_json) # This should not get called.
-
-      stub_request(:get, "http://localhost:3000/api/records?name=foo&email=bar@example.com")
-        .with(headers: {accept: 'application/json'})
-        .to_return(headers: {content_type: "application/json"}, body: {
-          records: [
-            {id: '1', name: 'bar', email: "bar.example"},
-            {id: '2', name: 'foo', email: "bar.example"},
-          ]
-        }.to_json)
-
-      records = test_class.all(name: 'foo', email: 'bar@example.com')
-      expect(records.size).to eql(2)
-    end
-  end
-
-  describe '.find' do
-    it 'returns proper objects' do
-      stub_request(:get, "http://localhost:3000/api/records/1")
-        .with(headers: {accept: 'application/json'})
-        .to_return(headers: {content_type: "application/json"}, body: {
-          records: [
-            {id: '1', name: "foobar.example"}
-          ]
-        }.to_json)
-
-      records = test_class.find(1)
-      expect(records.size).to eql(1)
-
-      record = records.first
-      expect(record).to be_a(Record)
-      expect(record.id).to eql('1')
-      expect(record.name).to eql('foobar.example')
-    end
-  end
-
-  describe '#save' do
-    it 'can save successfully if called on a new item' do
-      stub_request(:post, "http://localhost:3000/api/records")
-        .with(headers: {accept: 'application/json', content_type: "application/json"})
-        .to_return(headers: {content_type: "application/json"}, status: 201, body: {
-          records: [
-            {id: '1', name: "foobar.example", created_at: "2014-10-16T18:49:40Z", updated_at: "2014-10-18T18:59:40Z"}
-          ]
-        }.to_json)
-
-      expect(obj.save).to eql(true)
-
-      expect(obj.id).to eql('1')
-      expect(obj.name).to eql('foobar.example')
-
-      expect(obj.created_at).to eql('2014-10-16T18:49:40Z')
-      expect(obj.updated_at).to eql('2014-10-18T18:59:40Z')
-
-      expect(obj).to respond_to(:created_at)
-      expect(obj).to respond_to(:updated_at)
-      expect(obj.persisted?).to eql(true)
-    end
-
-    it 'can update when called on an existing item' do
-      stub_request(:put, "http://localhost:3000/api/records/1")
-        .with(headers: {accept: 'application/json', content_type: "application/json"})
-        .to_return(headers: {content_type: "application/json"}, body: {
-          records: [
-            {id: '1', name: "foobar.example", created_at: "2014-10-16T18:49:40Z", updated_at: "2016-10-18T18:59:40Z"}
-          ]
-        }.to_json)
-
-      obj.id = '1'
-      obj.updated_at = "2014-10-18T18:59:40Z"
-      expect(obj.updated_at).to eql("2014-10-18T18:59:40Z")
-
-      expect(obj.save).to eql(true)
-      expect(obj.updated_at).to eql("2016-10-18T18:59:40Z")
-    end
-  end
-
-  describe '#destroy' do
-    before { obj.id = '1' }
-
-    it 'returns true when successful' do
-      stub_request(:delete, "http://localhost:3000/api/records/1")
-        .with(headers: {accept: "application/json"})
-        .to_return(status: 204, body: nil)
-
-      expect(obj.destroy).to eql(true)
-    end
-  end
-end
-

data/spec/jsonapi/consumer/error_handling_spec.rb

@@ -1,37 +0,0 @@
-RSpec.describe 'Error handling' do
-  let(:test_class) do
-    Record ||= Class.new do
-      include JSONAPI::Consumer::Resource
-      self.host = 'http://localhost:3000/api/'
-
-      has_one :domain
-    end
-  end
-
-  let(:obj) { test_class.new(name: 'jsonapi.example') }
-
-  context 'on model' do
-    it 'adds to the errors object on the model' do
-      stub_request(:post, "http://localhost:3000/api/records")
-        .to_return(headers: {content_type: "application/json"}, status: 400, body: {
-          errors: [
-            {title: 'cannot be blank', path: "/name", detail: 'name cannot be blank'},
-            {title: 'is invalid', path: '/type', detail: 'type is invalid'}
-          ]
-        }.to_json)
-
-      expect(obj.save).to eql(false)
-      expect(obj.is_valid?).to eql(false)
-    end
-  end
-
-  context 'in general' do
-    it 'handles timeout errors' do
-      stub_request(:any, "http://localhost:3000/api/records").to_timeout
-
-      expect {
-        obj.save
-      }.to raise_error(JSONAPI::Consumer::Errors::ServerNotResponding)
-    end
-  end
-end

data/spec/jsonapi/consumer/object_build_spec.rb

@@ -1,20 +0,0 @@
-RSpec.describe 'Object building' do
-  let(:class_name) { BuildRequest }
-
-  subject(:obj) { class_name.build }
-
-  it 'returns an object with populated items' do
-    stub_request(:get, "http://localhost:3000/api/build_requests/new")
-      .to_return(headers: {content_type: "application/json"}, body: {
-          build_requests: [
-            {name: "", title: "default value"}
-          ]
-        }.to_json)
-
-    expect(obj).to respond_to(:name)
-    expect(obj).to respond_to(:title)
-
-    expect(obj.name).to be_blank
-    expect(obj.title).to eql("default value")
-  end
-end

data/spec/jsonapi/consumer/parser_spec.rb

@@ -1,39 +0,0 @@
-RSpec.describe 'Response Parsing' do
-  let(:response) { OpenStruct.new(body: Responses.sideload) }
-  let(:parser) { JSONAPI::Consumer::Parser.new(Blog::Post, response) }
-
-  subject(:results) { parser.build }
-
-  it 'can handle linked associations' do
-    stub_request(:get, 'http://localhost:3000/api/comments/9c9ba83b-024c-4d4c-9573-9fd41b95fc14')
-      .to_return(headers: {content_type: "application/json"}, body: {
-          comments: [
-            {
-              id: '9c9ba83b-024c-4d4c-9573-9fd41b95fc14',
-              content: "i found this useful."
-            }
-          ]
-        }.to_json)
-
-    stub_request(:get, 'http://localhost:3000/api/comments/27fcf6e8-24b0-41db-94b1-812046a10f54')
-      .to_return(headers: {content_type: "application/json"}, body: {
-          comments: [
-            {
-              id: '27fcf6e8-24b0-41db-94b1-812046a10f54',
-              content: "i found this useful too."
-            }
-          ]
-        }.to_json)
-
-    expect(results.size).to eql(2)
-
-    result = results.first
-    expect(result.comments.size).to eql(2)
-    expect(result.user).to be_a(Blog::User)
-
-    last = results.last
-    expect(last.comments.first).to be_a(Blog::Comment)
-    expect(last.comments.first.id).to eql("9c9ba83b-024c-4d4c-9573-9fd41b95fc14")
-    expect(last.comments.first.content).to eql("i found this useful.")
-  end
-end

data/spec/jsonapi/consumer/resource_spec.rb

@@ -1,62 +0,0 @@
-RSpec.describe 'Resource' do
-  let(:sample_attrs) {
-    {
-      id: SecureRandom.uuid,
-      name: 'foo',
-      content: 'bar'
-    }
-  }
-
-  subject(:test_class) do
-    Paper ||= Class.new do
-      include JSONAPI::Consumer::Resource
-    end
-  end
-
-  it 'it errors on undefined methods' do
-    obj = test_class.new
-    expect {
-      obj.paper
-    }.to raise_error(NoMethodError)
-  end
-
-  describe 'accepts any passed in params through #attributes=' do
-    subject(:instance) { test_class.new }
-
-    before do
-      instance.attributes = sample_attrs
-    end
-
-    it { is_expected.to respond_to(:id) }
-    it { is_expected.to respond_to(:name) }
-    it { is_expected.to respond_to(:content) }
-  end
-
-  describe 'accepts attributes through .new' do
-    subject(:instance) { test_class.new(sample_attrs) }
-
-    it { is_expected.to respond_to(:id) }
-    it { is_expected.to respond_to(:name) }
-    it { is_expected.to respond_to(:content) }
-  end
-
-  describe '#serializable_hash' do
-    subject(:obj_hash) { test_class.new(sample_attrs).serializable_hash }
-
-    it 'has proper keys' do
-      expect(obj_hash).to have_key(:id)
-      expect(obj_hash).to have_key(:name)
-      expect(obj_hash).to have_key(:content)
-    end
-  end
-
-  describe '#to_json' do
-    subject(:obj_hash) { test_class.new(sample_attrs).to_json }
-
-    it 'has all attributes root key' do
-      json_hash = JSON.parse(obj_hash)
-      expect(json_hash.keys).to eql(['id', 'name', 'content'])
-    end
-  end
-
-end

data/spec/jsonapi/consumer/serializer_spec.rb

@@ -1,41 +0,0 @@
-RSpec.describe 'Serializer' do
-  let(:test_class) do
-    SerializerTestClass ||= Class.new do
-      include JSONAPI::Consumer::Resource
-
-      has_many :users, class_name: 'Account'
-      has_one :owner, class_name: 'Owner'
-    end
-  end
-
-  let(:owner) {
-    Owner ||= Class.new do
-      include JSONAPI::Consumer::Resource
-
-      def to_param
-        1
-      end
-    end
-  }
-
-  let(:user) {
-    Account ||= Class.new do
-      include JSONAPI::Consumer::Resource
-    end
-  }
-
-  subject(:obj_hash) { test_class.new(id: '76', owner: owner.new, users: [user.new(id: 'a'), user.new(id: 'b')]).serializable_hash }
-
-  it 'outputs the associated has_one' do
-    expect(obj_hash).to have_key(:links)
-    expect(obj_hash[:links]).to have_key(:owner)
-    expect(obj_hash[:links][:owner]).to eql(1)
-  end
-
-  it 'outputs the associated has_many' do
-    expect(obj_hash).to have_key(:links)
-    expect(obj_hash[:links]).to have_key(:users)
-    expect(obj_hash[:links][:users]).to eql(['a', 'b'])
-  end
-
-end