json_api_ruby 0.0.1.alpha

data/spec/json_api_ruby/resource_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+RSpec.describe JsonApi::Resource do
+  subject(:serialized_person) do
+    person = Person.new('Brad J. Armbruster', 'ace@airforce.mil')
+    PersonResource.new(person).to_hash
+  end
+
+  it 'is follows the JSON API spec' do
+    expect(serialized_person).to be_valid_json_api
+  end
+
+  it 'has a name with the value "Brad J. Armbruster"' do
+    expect(serialized_person).to have_attribute(:name).with_value('Brad J. Armbruster')
+  end
+
+  it 'has an email with the value "ace@airforce.mil"' do
+    expect(serialized_person).to have_attribute(:email_address).with_value('ace@airforce.mil')
+  end
+
+  it 'has a created_at field' do
+    expect(serialized_person).to have_attribute(:created_at)
+  end
+
+  it 'has an updated_at timestamp' do
+    expect(serialized_person).to have_attribute(:updated_at)
+  end
+
+  describe 'relationships' do
+    subject(:serialized_article) do
+      article = Person.new('Anatoly Fyodorovich Krimov', 'red_star@kremlin.mil').articles.first
+      ArticleResource.new(article, include: [:author, :comments]).to_hash
+    end
+
+    context 'with a cardinality of one' do
+      it 'includes the relationship keys' do
+        expect(serialized_article).to have_relationship('author')
+      end
+
+      it 'have a valid author relationship' do
+        expect(serialized_article['relationships']['author']['data']).to be_valid_json_api
+      end
+    end
+
+    context 'with a cardinality of many' do
+      it 'includes relationship data' do
+        expect(serialized_article).to have_relationship('comments')
+      end
+
+      it 'includes the type for the relationship' do
+        serialized_article['relationships']['comments']['data'].map do |comment|
+          expect(comment).to be_valid_json_api
+          expect(comment['type']).to eq 'comments'
+        end
+      end
+
+      it 'includes the id for the relationship' do
+        serialized_article['relationships']['comments']['data'].map do |comment|
+          expect(comment['id'].length).to eq 36
+        end
+      end
+    end
+
+    context 'relationship links' do
+      subject(:serialized_article) do
+        article = Person.new('Anatoly Fyodorovich Krimov', 'red_star@kremlin.mil').articles.first
+        ArticleResource.new(article).to_hash
+      end
+
+      it 'includes links to for the comments relationship' do
+        expect(serialized_article).to have_links_for('comments')
+      end
+
+      it 'includes links for the author relationship' do
+        expect(serialized_article).to have_links_for('author')
+      end
+    end
+  end
+
+  describe 'link paths' do
+    let(:person) { Person.new('Sherman R. Guderian', 'heavy_metal@airforce.mil') }
+    subject(:serialized_person) do
+      PersonResource.new(person).to_hash
+    end
+
+    it 'returns a full URL to the resource' do
+      expect(serialized_person['links']['self']).to eq("http://localhost:3000/people/#{person.id}")
+    end
+  end
+end

data/spec/json_api_ruby/resources/discover_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+RSpec.describe JsonApi::Resources::Discovery do
+  describe 'resource discovery' do
+    it 'finds a resource class created within the same namespace' do
+      rs1 = Namespace::OneResource.new(nil)
+      expect(JsonApi::Resources::Discovery.resource_for_name(Two.new, {parent_resource: rs1})).to eq Namespace::TwoResource
+    end
+
+    it 'allows specifying a different namespace' do
+      expect(JsonApi::Resources::Discovery.resource_for_name(Three.new, namespace: 'different_namespace')).to eq DifferentNamespace::ThreeResource
+    end
+
+    it 'allows explicitly providing a resource class' do
+      expect(JsonApi::Resources::Discovery.resource_for_name(Two.new, resource_class: 'DifferentNamespace::ThreeResource')).to eq DifferentNamespace::ThreeResource
+    end
+
+    it "raises an error if the resource can't be found" do
+      expect {
+        JsonApi::Resources::Discovery.resource_for_name(nil)
+      }.to raise_error JsonApi::ResourceNotFound
+    end
+  end
+end

data/spec/json_api_ruby/resources/relationships_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+RSpec.describe JsonApi::Resources::Relationships do
+  let(:article) do
+    Article.new('How to raise Triops', 'Triops are hardy little creatures whose eggs can be frozen for as long as 40 years')
+  end
+
+  let(:article_resource) do
+    ArticleResource.new(article)
+  end
+
+  let(:author_relation) do
+    article_resource.class.relationships.find do |rel|
+      rel.name == 'author'
+    end
+  end
+
+  let(:comments_relation) do
+    article_resource.class.relationships.find do |rel|
+      rel.name == 'comments'
+    end
+  end
+
+  describe 'link serialization' do
+    subject(:links_object) do
+      author_relation.build_resources(parent_resource: article_resource)
+      author_relation.to_hash
+    end
+
+    it 'includes a links object' do
+      expect(links_object).to include('links')
+    end
+
+    it 'has a "self" object' do
+      expect(links_object['links']).to include('self')
+    end
+
+    it 'has a "related" object' do
+      expect(links_object['links']).to include('related')
+    end
+
+    describe 'self object' do
+      it 'is a link to the relationship on the parent object' do
+        expect(links_object['links']['self']).to eq "http://localhost:3000/articles/#{article.uuid}/relationships/author"
+      end
+    end
+
+    describe 'related object' do
+      it 'is a link to the base resource of the related object' do
+        expect(links_object['links']['related']).to eq "http://localhost:3000/articles/#{article.uuid}/author"
+      end
+    end
+  end
+
+  describe 'data serialization' do
+    subject(:serialized_object) do
+      author_relation.build_resources(parent_resource: article_resource, included: true)
+      author_relation.to_hash
+    end
+
+    it 'has a data top level object' do
+      expect(serialized_object).to include('data')
+    end
+
+    describe 'data object' do
+      context 'when an array' do
+        subject(:serialized_object) do
+          comments_relation.build_resources(parent_resource: article_resource, included: true)
+          comments_relation.to_hash
+        end
+
+        it 'has an identity hash for each object' do
+          expect(serialized_object['data'].flat_map(&:keys).uniq).to eq ['id', 'type']
+        end
+      end
+
+      context 'when a single object' do
+        it 'has an identity hash' do
+          expect(serialized_object['data'].keys).to eq ['id', 'type']
+        end
+      end
+    end
+  end
+
+  describe 'identity hash' do
+    it 'returns an identity hash given a model and parent resource' do
+      author_relation.build_resources(parent_resource: article_resource, included: true)
+      serialized_object = author_relation.to_hash
+      expect(serialized_object['data'].keys).to eq ['id', 'type']
+    end
+  end
+
+  describe 'relationship serialization' do
+    context 'when the option "include" is true' do
+      it 'includes the data object' do
+        author_relation.build_resources(parent_resource: article_resource, included: true)
+        serialized_data = author_relation.to_hash
+        expect(serialized_data).to include('data')
+      end
+    end
+
+    context 'when the option "include" is falsey' do
+      it 'does not include data object' do
+        author_relation.build_resources(parent_resource: article_resource)
+        serialized_data = author_relation.to_hash
+        expect(serialized_data).to_not include('data')
+      end
+    end
+  end
+end

data/spec/json_api_ruby/serializer_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+RSpec.describe JsonApi::Serializer do
+  context 'a single object' do
+    let(:person) do
+      Person.new('Brad J. Armbruster', 'ace@airforce.mil')
+    end
+
+    subject(:serialized_data) do
+      JsonApi.serialize(person, meta: { meta_key: 'meta value' })
+    end
+
+    it 'has a top level data object' do
+      expect(serialized_data).to have_data
+    end
+
+    it 'passes meta through' do
+      expect(serialized_data).to have_meta
+    end
+
+    context 'with included resources' do
+      subject(:serialized) do
+        JsonApi.serialize(person, meta: { meta_key: 'meta value' }, include: [:articles])
+      end
+      it 'has a top level included object' do
+        expect(serialized['included']).to be_present
+      end
+
+      it 'includes the resources as expected' do
+        found_document = serialized['included'].select do |document|
+          document['id'] == person.articles.first.uuid
+        end
+        expect(found_document).to be_present
+      end
+    end
+  end
+
+  context 'a collection of objects' do
+    let(:people) do
+      [
+        Person.new('Brad J. Armbruster', 'ace@airforce.mil'),
+        Person.new('Sabastian Bludd', 'sbludd@cobra.mil'),
+        Person.new('John Zullo', 'ace@specops.mil')
+      ]
+    end
+
+    context 'without included resources' do
+      subject(:serialized_resources) do
+        JsonApi.serialize(people, meta: {'I' => 'have meta'})
+      end
+
+      it 'has three data objects' do
+        expect(serialized_resources).to have_data
+      end
+
+      it 'passes meta through' do
+        expect(serialized_resources).to have_meta
+      end
+    end
+
+    context 'with included resources' do
+      subject(:serialized_resources) do
+        JsonApi.serialize(people, meta: {'I' => 'have meta'}, include: [:articles])
+      end
+
+      it 'has included resources' do
+        expect(serialized_resources['included']).to be_present
+      end
+
+      it 'includes resources only once' do
+        included_identifiers = serialized_resources['included'].map do |resource|
+          resource['id'] + resource['type']
+        end
+        unique_identifiers = included_identifiers.uniq
+        unique_identifiers.each do |id|
+          all_ids = included_identifiers.select {|inc_id| inc_id == id}
+          expect(all_ids.length).to eq 1
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,102 @@
+require 'active_support'
+require 'active_support/core_ext'
+require 'pry-byebug'
+require_relative '../lib/json_api_ruby'
+require_relative 'support/resource_objects'
+require_relative 'support/json_api_matchers'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/support/json_api_matchers.rb

@@ -0,0 +1,54 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :have_relationship do |expected|
+  match do |actual|
+    relationships = Hash(actual).stringify_keys['relationships']
+    Hash(relationships).keys.include?(expected)
+  end
+end
+
+RSpec::Matchers.define :have_data do
+  match do |actual|
+    data = Hash(actual).stringify_keys['data']
+    data.present?
+  end
+end
+
+RSpec::Matchers.define :have_meta do
+  match do |actual|
+    data = Hash(actual).stringify_keys['meta']
+    data.present?
+  end
+end
+
+RSpec::Matchers.define :have_attribute do |key_name|
+  match do |actual|
+    attributes = Hash(actual).stringify_keys['attributes']
+    return false unless attributes.keys.include?(key_name.to_s)
+    return true if @chained.blank?
+    attributes[key_name.to_s] == @expected_value
+  end
+
+  chain :with_value do |key_value|
+    @chained = true
+    @expected_value = key_value
+  end
+end
+
+RSpec::Matchers.define :be_valid_json_api do
+  match do |actual|
+    is_a_hash = actual.is_a?(Hash)
+    actual = Hash(actual).stringify_keys
+    has_id_and_type = actual['id'].present? && actual['type'].present?
+
+    is_a_hash && has_id_and_type
+  end
+end
+
+RSpec::Matchers.define :have_links_for do |expected|
+  match do |actual|
+    relationships = Hash(actual).stringify_keys['relationships']
+    relation = Hash(relationships)[expected]
+    Hash(relation).keys.include?('links')
+  end
+end

data/spec/support/resource_objects.rb

@@ -0,0 +1,114 @@
+module Identifiers
+  def id
+    self.object_id
+  end
+
+  def uuid
+    @uuid ||= SecureRandom.uuid
+  end
+end
+
+class Comment
+  include Identifiers
+  attr_accessor :author, :comment_text, :created_at, :updated_at
+
+  def initialize(comment_text)
+    @created_at = 1.day.ago
+    @updated_at = 30.minutes.ago
+    assign_author
+  end
+
+  def assign_author
+    @author = Person.new('Archibald Monev', 'dr_venom@cobra.mil')
+  end
+end
+
+class Article
+  include Identifiers
+  attr_accessor :publish_date, :title, :short_description, :created_at, :updated_at
+  attr_reader :author
+  attr_reader :comments
+
+  def initialize(title, desc, author=nil)
+    @publish_date = Time.now
+    @created_at = 2.days.ago
+    @updated_at = 1.day.ago
+    @title = title
+    @short_description = desc
+    @author = author
+    generate_comments
+  end
+
+  def author
+    @author ||= Person.new('Ettienne R. LaFitte', 'gung_ho@recondo.mil')
+  end
+
+  def generate_comments
+    @comments = [
+      Comment.new("This article really cleared it up for me"),
+      Comment.new("No idea what comment 1 is all about, this article was a muddled mess")
+    ]
+  end
+end
+
+class Person
+  include Identifiers
+  attr_accessor :name, :email_address, :created_at, :updated_at
+
+  def initialize(name, email)
+    @name = name
+    @email_address = email
+    @created_at = 1.month.ago
+    @updated_at = 1.month.ago
+  end
+
+  def articles
+    @articles ||= [ Article.new("How to Conquer the World", "10 simple steps to world domination", self) ]
+  end
+end
+
+class PersonResource < JsonApi::Resource
+  attribute :name
+  attribute :email_address
+  attribute :created_at
+  attribute :updated_at
+
+  has_many :articles
+end
+
+class ArticleResource < JsonApi::Resource
+  id_field :uuid
+  attributes :publish_date, :title, :short_description, :created_at, :updated_at
+
+  has_one :author
+  has_many :comments
+end
+
+class CommentResource < JsonApi::Resource
+  id_field :uuid
+  attribute :author
+  attribute :comment_text
+  attribute :created_at
+  attribute :updated_at
+end
+
+# namespaced resources
+class Two
+end
+
+class Three
+end
+
+module Namespace
+  class OneResource < JsonApi::Resource
+  end
+
+  class TwoResource < JsonApi::Resource
+  end
+end
+
+module DifferentNamespace
+  class ThreeResource < JsonApi::Resource
+  end
+end
+