grape-roar 0.4.0 → 0.4.1

data/spec/extensions/relations/validations/active_record_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+describe Grape::Roar::Extensions::Relations::Validations::ActiveRecord, active_record: true do
+  let(:model_klass) { double }
+
+  subject do
+    klass = Class.new do
+      def initialize(klass)
+        @klass = klass
+      end
+
+      attr_reader :klass
+    end
+
+    klass.include(described_class)
+    klass.new(model_klass)
+  end
+
+  before do
+    expect(model_klass).to receive(:reflections).twice
+                                                .and_return(reflections)
+  end
+
+  %w[
+    belongs_to
+    has_many
+    has_one
+    has_and_belongs_to_many
+  ].each do |relation|
+    context "##{relation}_valid?" do
+      let(:relation_klass) do
+        "::ActiveRecord::Reflection::#{relation.camelize}"\
+          'Reflection'.constantize.allocate
+      end
+
+      let(:reflections) { { test: relation_klass, fail: Class.new } }
+
+      it 'properly validates the relation' do
+        expect(subject.send("#{relation}_valid?", :test)).to eql(true)
+        expect { subject.send("#{relation}_valid?", :fail) }.to raise_error(
+          Grape::Roar::Extensions::Relations::\
+          Exceptions::InvalidRelationError
+        )
+      end
+    end
+  end
+end

data/spec/extensions/relations/validations/mongoid_spec.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+describe Grape::Roar::Extensions::Relations::Validations::Mongoid, mongoid: true do
+  let(:model_klass) { double }
+
+  subject do
+    klass = Class.new do
+      def initialize(klass)
+        @klass = klass
+      end
+
+      attr_reader :klass
+    end
+
+    klass.include(described_class)
+    klass.new(model_klass)
+  end
+
+  let(:map_reflection) do
+    proc do |r|
+      case r
+      when /and/     then 'ManyToMany'
+      when /many/    then 'Many'
+      when /one/     then 'One'
+      when /belongs/ then 'In'
+      end
+    end
+  end
+
+  before do
+    expect(model_klass).to receive(:reflect_on_association).twice do |r|
+      if r == :test_rel
+        {
+          relation: "Mongoid::Relations::#{relation_klass}"\
+                    "::#{map_reflection.call(test_method)}".constantize
+        }
+      else
+        { relation: double }
+      end
+    end
+  end
+
+  context 'referenced' do
+    let(:relation_klass) { 'Referenced' }
+
+    %i[
+      belongs_to
+      has_and_belongs_to_many
+      has_many
+      has_one
+    ].each do |test_method|
+      context "##{test_method}_valid? validates the relation" do
+        let(:test_method) { test_method }
+
+        it 'properly validates the relation' do
+          expect(subject.send("#{test_method}_valid?", :test_rel)).to eql(true)
+
+          expect do
+            subject.send("#{test_method}_valid?", :fail)
+          end.to raise_error(
+            Grape::Roar::Extensions::Relations::\
+            Exceptions::InvalidRelationError
+          )
+        end
+      end
+    end
+  end
+
+  context 'referenced' do
+    let(:relation_klass) { 'Embedded' }
+
+    %i[embeds_one embeds_many].each do |test_method|
+      context "##{test_method}_valid? validates the relation" do
+        let(:test_method) { test_method }
+
+        it 'properly validates the relation' do
+          expect(subject.send("#{test_method}_valid?", :test_rel)).to eql(true)
+
+          expect do
+            subject.send("#{test_method}_valid?", :fail)
+          end.to raise_error(
+            Grape::Roar::Extensions::Relations::\
+            Exceptions::InvalidRelationError
+          )
+        end
+      end
+    end
+  end
+end

data/spec/nested_representer_spec.rb

@@ -1,20 +1,11 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe Grape::Roar do
-  subject do
-    Class.new(Grape::API)
-  end
 
-  before do
-    subject.format :json
-    subject.formatter :json, Grape::Formatter::Roar
-  end
-
-  def app
-    subject
-  end
 
+describe Grape::Roar do
   context 'nested representer' do
+    include_context 'Grape API App'
+
     before do
       subject.get('/order/:id') do
         order = Order.new(id: params[:id], client_id: 42)

data/spec/present_with_spec.rb

@@ -1,18 +1,9 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe Grape::Roar do
-  subject do
-    Class.new(Grape::API)
-  end
 
-  before do
-    subject.format :json
-    subject.formatter :json, Grape::Formatter::Roar
-  end
 
-  def app
-    subject
-  end
+describe Grape::Roar do
+  include_context 'Grape API App'
 
   context 'using present' do
     before do

data/spec/relations_spec.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+describe Grape::Roar::Extensions::Relations do
+  context '.included' do
+    subject { Class.new }
+    after { subject.include(described_class) }
+
+    it 'mixes DSLMethods into the singleton class of its target' do
+      expect(subject.singleton_class).to receive(:include).with(
+        Grape::Roar::Extensions::Relations::DSLMethods
+      )
+    end
+  end
+
+  context 'with mongoid', mongoid: true do
+    include_context 'Grape API App'
+
+    # Make sure Mongo is empty
+    before(:each) { Mongoid::Config.purge! }
+
+    let(:result) { JSON.parse(last_response.body) }
+
+    context 'has_many, embedded: false' do
+      before do
+        subject.get('/carts/:id') do
+          cart = Cart.create(id: params[:id])
+          Array.new(5).map { Item.create(cart: cart) }
+          present(cart, with: MongoidCartRepresenter)
+        end
+
+        get '/carts/1'
+      end
+
+      it 'correctly generates the self link' do
+        expect(result['_links']['self']['href']).to eql(
+          'http://example.org/carts/1'
+        )
+      end
+
+      it 'correctly generates links for items' do
+        expect(result['_links']['items'].map { |l| l['href'] }).to all(
+          match(/^http:\/\/example\.org\/items\/[A-Za-z0-9]*$/)
+        )
+      end
+    end
+
+    context 'belongs_to, embedded: true' do
+      before do
+        subject.get('/items/:id') do
+          present(
+            Item.create(id: params[:id], cart: Cart.create),
+            with: MongoidItemRepresenter
+          )
+        end
+
+        get '/items/1'
+      end
+
+      it 'correctly generates the self link' do
+        expect(result['_links']['self']['href']).to eql(
+          'http://example.org/items/1'
+        )
+      end
+
+      it 'correctly represents the embedded cart' do
+        expect(result['_embedded']['cart']['_links']['self']['href'])
+          .to match(/^http:\/\/example\.org\/carts\/[A-Za-z0-9]*$/)
+
+        expect(result['_embedded']['cart']['_links']['items'].count).to eql(1)
+        expect(result['_embedded']['cart']['_links']['items'].first).to eql(
+          result['_links']['self']
+        )
+      end
+    end
+  end
+end

data/spec/representer_spec.rb

@@ -1,18 +1,9 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe Grape::Roar do
-  subject do
-    Class.new(Grape::API)
-  end
 
-  before do
-    subject.format :json
-    subject.formatter :json, Grape::Formatter::Roar
-  end
 
-  def app
-    subject
-  end
+describe Grape::Roar do
+  include_context 'Grape API App'
 
   context 'representer' do
     before do

data/spec/spec_helper.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 require 'bundler'
 Bundler.setup :default, :test
+Bundler.require
 
 require 'grape'
 
@@ -12,10 +15,21 @@ require 'roar/hypermedia'
 
 require 'grape/roar'
 require 'rack/test'
+
 require 'rspec'
 
 RSpec.configure do |config|
   config.include Rack::Test::Methods
+  config.filter_run_excluding(
+    active_record: true, mongoid: true
+  )
 end
 
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+Dir["#{File.dirname(__FILE__)}/support/all/**/*.rb"].each { |f| require f }
+
+# For Relational Extension Tests
+if defined?(Mongoid)
+  ENV['MONGOID_ENV'] ||= 'test'
+  Mongoid.load!('./spec/config/mongoid.yml')
+  Dir["#{File.dirname(__FILE__)}/support/mongoid/**/*.rb"].each { |f| require f }
+end

data/spec/support/{article.rb → all/article.rb}

@@ -1,4 +1,6 @@
-require 'support/article_representer'
+# frozen_string_literal: true
+
+require 'support/all/article_representer'
 
 class Article
   include Roar::JSON

data/spec/support/{article_representer.rb → all/article_representer.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ArticleRepresenter
   include Roar::JSON
   include Roar::Hypermedia

data/spec/support/all/grape_app_context.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+
+
+shared_context 'Grape API App' do
+  subject do
+    Class.new(Grape::API)
+  end
+
+  before do
+    subject.format :json
+    subject.formatter :json, Grape::Formatter::Roar
+  end
+
+  def app
+    subject
+  end
+end

data/spec/support/{order.rb → all/order.rb}

@@ -1,4 +1,6 @@
-require 'support/order_representer'
+# frozen_string_literal: true
+
+require 'support/all/order_representer'
 
 class Order
   include Roar::JSON

data/spec/support/{order_representer.rb → all/order_representer.rb}

@@ -1,4 +1,6 @@
-require 'support/article'
+# frozen_string_literal: true
+
+require 'support/all/article'
 
 module OrderRepresenter
   include Roar::JSON

data/spec/support/{product.rb → all/product.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Product
   attr_accessor :title, :id
 

data/spec/support/{product_representer.rb → all/product_representer.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'roar/json/hal'
 
 module ProductRepresenter
@@ -10,6 +12,6 @@ module ProductRepresenter
 
   link :self do |opts|
     request = Grape::Request.new(opts[:env])
-    "#{request.url}"
+    request.url.to_s
   end
 end

data/spec/support/{user.rb → all/user.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class User
   attr_accessor :id, :name
 

data/spec/support/{user_representer.rb → all/user_representer.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class UserRepresenter < Grape::Roar::Decorator
   include Roar::JSON
   include Roar::Hypermedia

data/spec/support/mongoid/relational_models/cart.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Cart
+  include ::Mongoid::Document
+
+  has_many :items
+end

data/spec/support/mongoid/relational_models/item.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Item
+  include ::Mongoid::Document
+
+  belongs_to :cart
+end

data/spec/support/mongoid/relational_models/mongoid_cart_representer.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module MongoidCartRepresenter
+  include Roar::JSON
+  include Roar::JSON::HAL
+  include Roar::Hypermedia
+
+  include Grape::Roar::Extensions::Relations
+
+  relation :has_many, :items
+
+  link_self
+end
+
+# Class style below, but want to test module
+
+# class MongoidCartRepresenter < Grape::Roar::Decorator
+#   include Roar::JSON
+#   include Roar::JSON::HAL
+#   include Roar::Hypermedia
+
+#   include Grape::Roar::Extensions::Relations
+
+#   relation :has_many, :items
+
+#   link_self
+# end