grape-transformations 0.0.1

data/spec/api/animal_spec.rb

@@ -0,0 +1,37 @@
+describe 'Animal Endpoint', :type => :request do
+
+  context :v1 do
+
+    let(:first_animal) { Animal.new name: 'Cow', description: 'Are the most common type of large domesticated ungulates. They are a prominent modern member of the subfamily Bovinae', phylum: 'Chordata', diet: 'vegetarian' }
+    let(:second_animal) { Animal.new name: 'Capybara', description: 'is the largest rodent in the world. Its closest relatives are guinea pigs and rock cavies', phylum: 'Chordata', diet: 'vegetarian' }
+
+    context 'GET' do
+      describe '/foo' do
+        before(:each){ allow(::Animal).to receive(:all) { [first_animal, second_animal] } }
+        
+        it 'gets all animals with default transformation' do
+          expected_response = "[{\"name\":\"Cow\",\"description\":\"Are the most common type of large domesticated ungulates. They are a prominent modern member of the subfamily Bovinae\",\"phylum\":\"Chordata\",\"diet\":\"vegetarian\"},{\"name\":\"Capybara\",\"description\":\"is the largest rodent in the world. Its closest relatives are guinea pigs and rock cavies\",\"phylum\":\"Chordata\",\"diet\":\"vegetarian\"}]"      
+          get '/api/v1/animals/foo'
+          expect(response.status).to eq 200
+          expect(response.body).to match expected_response
+          #RSpec::Mocks.space.proxy_for(::User).reset # It is not necessary
+        end
+
+      end
+      describe '/bar/:id' do
+        before(:each){ allow(::Animal).to receive(:find) { first_animal } }
+
+        it 'gets specific animal with default transformation' do
+          expected_response = "{\"name\":\"Cow\",\"description\":\"Are the most common type of large domesticated ungulates. They are a prominent modern member of the subfamily Bovinae\"}"
+          get '/api/v1/animals/bar/0'
+          expect(response.status).to eq 200
+          expect(response.body).to match expected_response
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/api/user_spec.rb

@@ -0,0 +1,55 @@
+describe 'User Endpoint', :type => :request do
+
+  context :v1 do
+      
+    let(:first_user) { User.new name: 'Allam Britto', age: 24, birthday: Date.parse('15-06-1990'), phone: '555-5555', address: 'Fake st. 1-23' }
+    let(:second_user) { User.new name: 'Elva Lasso', age: 25, birthday: Date.parse('15-06-1989'), phone: '777-5555', address: 'Fake st. 1-25' }
+
+    context 'GET' do
+      describe 'default transformation' do
+        before(:each){ allow(::User).to receive(:all) { [first_user, second_user] } }
+        describe '/' do
+          it 'gets all users with default transformation' do
+            expected_response = "[{\"name\":\"Allam Britto\",\"age\":24,\"birthday\":\"1990-06-15T00:00:00.000+00:00\",\"phone\":\"555-5555\",\"address\":\"Fake st. 1-23\"},{\"name\":\"Elva Lasso\",\"age\":25,\"birthday\":\"1989-06-15T00:00:00.000+00:00\",\"phone\":\"777-5555\",\"address\":\"Fake st. 1-25\"}]"      
+            get '/api/v1/users'
+            expect(response.status).to eq 200
+            expect(response.body).to match expected_response
+            #RSpec::Mocks.space.proxy_for(::User).reset # It is not necessary
+          end
+        end
+
+        describe '/compact' do
+          it 'gets all users with compact transformation' do
+            expected_response = "[{\"name\":\"Allam Britto\",\"phone\":\"555-5555\"},{\"name\":\"Elva Lasso\",\"phone\":\"777-5555\"}]"
+            get '/api/v1/users/compact'
+            expect(response.status).to eq 200
+            expect(response.body).to match expected_response
+          end
+        end
+      end
+      describe 'compact transformation' do
+        before(:each){ allow(::User).to receive(:find) { first_user } }
+        describe '/:id' do
+          it 'gets specific user with default transformation' do
+            expected_response = "{\"name\":\"Allam Britto\",\"age\":24,\"birthday\":\"1990-06-15T00:00:00.000+00:00\",\"phone\":\"555-5555\",\"address\":\"Fake st. 1-23\"}"
+            get '/api/v1/users/0'
+            expect(response.status).to eq 200
+            expect(response.body).to match expected_response
+          end
+        end
+
+        describe 'compact/:id' do
+          it 'gets specific user with default transformation' do
+            expected_response = "{\"name\":\"Allam Britto\",\"phone\":\"555-5555\"}"  
+            get '/api/v1/users/compact/0'
+            expect(response.status).to eq 200
+            expect(response.body).to match expected_response
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/generators/entity_generator_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+require 'grape/generators/transformations/entity_generator'
+
+describe Grape::Generators::Transformations::EntityGenerator, :type => :generator do
+
+  destination File.expand_path('../../../tmp/tests', __FILE__)
+
+  before { prepare_destination }
+
+  context 'entity generating process' do
+
+    describe 'simple entity' do
+
+      before(:each){ run_generator %w(user) }
+
+      subject { file 'app/api/test_app/entities/users/default.rb' }
+
+      it { should exist }
+
+    end
+
+  end
+
+end

data/spec/generators/install_generator_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+require 'grape/generators/transformations/install_generator'
+
+describe Grape::Generators::Transformations::InstallGenerator, :type => :generator do
+
+  destination File.expand_path('../../../tmp/tests', __FILE__)
+
+  before { prepare_destination }
+
+  context 'the generated files' do
+
+    before { run_generator }
+
+    describe 'initializer' do
+
+      subject { file 'config/initializers/grape-transformations.rb' }
+
+      it { should exist }
+
+    end
+
+    describe 'entities folder' do
+
+      subject { file 'app/api/test_app/entities/.keep' }
+
+      it { should exist }
+
+    end
+
+  end
+
+end

data/spec/grapi_spec.rb

@@ -0,0 +1,132 @@
+describe Grape::Transformations do
+  it 'verifies if Grape::Transformations is defined' do
+    expect(defined?(Grape::Transformations)).to_not be_nil
+  end
+  context 'when grape-transformations conventions have been followed' do
+    describe 'grape-transformations paths' do
+      it 'verifies the root api path' do
+        expected_response = 'grape-transformations/spec/test_app/app/api'
+        root_api_path = Grape::Transformations.root_api_path
+        expect(root_api_path).to end_with expected_response
+      end
+      it 'verifies the relative path to entities' do
+        expected_response = 'test_app/entities'
+        relative_path_to_entities = Grape::Transformations.relative_path_to_entities
+        expect(relative_path_to_entities).to match expected_response
+      end
+      it 'verifies the namespace related to entities' do
+        expected_response = 'TestApp::Entities'
+        root_entity_namespace = Grape::Transformations.root_entity_namespace
+        expect(root_entity_namespace).to match expected_response
+      end
+      it 'verifies full path to entities' do
+        expected_response = 'grape-transformations/spec/test_app/app/api/test_app/entities'
+        full_path_to_entities = Grape::Transformations.full_path_to_entities
+        expect(full_path_to_entities).to end_with expected_response
+      end
+    end
+    context 'when there are multiple entities already created' do
+      it 'has registered entities' do
+        expected_response = {
+          "Food" => "TestApp::Entities::Food",
+          "User" => "TestApp::Entities::Users::Default"
+        }
+        registered_entities = Grape::Transformations.registered_entities
+        expect(registered_entities).to match expected_response
+      end
+      describe 'User' do
+        it 'verifies all entities' do
+          expected_response = '[TestApp::Entities::Users::Compact, TestApp::Entities::Users::Default]'
+          all_entities_for_user = Grape::Transformations.all_entities_for(User).inspect
+          expect(all_entities_for_user).to match expected_response
+        end
+        it 'verifies entity for compact transformation' do
+          expected_response = 'TestApp::Entities::Users::Compact'
+          entity_for_compact_transformation = Grape::Transformations.entity_for_transformation('User', 'Compact').inspect
+          expect(entity_for_compact_transformation).to match expected_response
+        end
+        it 'verifies entity for default transformation' do
+          expected_response = 'TestApp::Entities::Users::Default'
+          entity_for_compact_transformation = Grape::Transformations.entity_for_transformation('User', 'Default').inspect
+          expect(entity_for_compact_transformation).to match expected_response
+        end
+        it 'verifies all available entity transformations' do
+          expected_response = '[TestApp::Entities::Users::Compact]'
+          all_available_entity_transformations = Grape::Transformations.all_transformation_entities_for('User').inspect
+          expect(all_available_entity_transformations).to match expected_response
+        end
+        it 'verifies the registered entities' do
+          expected_response = 'TestApp::Entities::Users::Default'
+          registered_entity = Grape::Transformations.registered_entity_for 'User'
+          expect(registered_entity).to match expected_response
+        end
+        it 'verifies all available entity transformations' do
+          expected_response = '[:compact]'
+          all_available_transformations = Grape::Transformations.transformations_for('User').inspect
+          expect(all_available_transformations).to match expected_response
+        end
+      end
+      describe 'Food' do
+        it 'verifies the registered entities' do
+          expected_response = 'TestApp::Entities::Food'
+          registered_entity = Grape::Transformations.registered_entity_for 'Food'
+          expect(registered_entity).to match expected_response
+        end
+        it 'verifies all available entity transformations' do
+          expected_response = '[]'
+          all_available_transformations = Grape::Transformations.transformations_for('Food').inspect
+          expect(all_available_transformations).to match expected_response
+        end
+      end
+    end
+    describe 'Grape::Endpoint' do
+      describe 'User' do
+        let(:user) { User.new name: 'Allam Britto', age: 24, birthday: Date.parse('15-06-1990'), phone: '555-5555', address: 'Fake st. 1-23' }
+        let(:endpoint) { Grape::Endpoint.new({}, path: '/', method: 'get')}
+
+        it 'presents a default representation' do
+          endpoint.instance_variable_set :@env, {}
+          expected_response = "{\"name\":\"Allam Britto\",\"age\":24,\"birthday\":\"1990-06-15T00:00:00.000+00:00\",\"phone\":\"555-5555\",\"address\":\"Fake st. 1-23\"}"
+          representation = endpoint.present(user).to_json
+          expect(representation).to match expected_response
+        end
+        it 'presents a compact representation' do
+          endpoint.instance_variable_set :@env, {}
+          expected_response = "{\"name\":\"Allam Britto\",\"phone\":\"555-5555\"}"
+          representation = endpoint.present(user, with: TestApp::Entities::Users::Compact).to_json
+          expect(representation).to match expected_response
+        end
+      end
+      describe 'Food' do
+        let(:food) { Food.new name: 'Omelette', description: 'In cuisine, an omelette or omelet is a dish made from beaten eggs quickly cooked with butter or oil in a frying pan' }
+        let(:endpoint) { Grape::Endpoint.new({}, path: '/', method: 'get')}
+
+        it 'presents a default representation' do
+          endpoint.instance_variable_set :@env, {}
+          expected_response = "{\"name\":\"Omelette\",\"description\":\"In cuisine, an omelette or omelet is a dish made from beaten eggs quickly cooked with butter or oil in a frying pan\"}"
+          representation = endpoint.present(food).to_json
+          expect(representation).to match expected_response
+        end
+      end
+    end
+  end
+  context 'when grape-transformations conventions have not been followed' do
+    describe 'Animal' do
+      let(:animal) { Animal.new name: 'Cow', description: 'Are the most common type of large domesticated ungulates. They are a prominent modern member of the subfamily Bovinae', phylum: 'Chordata', diet: 'vegetarian' }
+      let(:endpoint) { Grape::Endpoint.new({}, path: '/', method: 'get')}
+
+      it 'presents without entity representation' do
+        endpoint.instance_variable_set :@env, {}
+        expected_response = "{\"name\":\"Cow\",\"description\":\"Are the most common type of large domesticated ungulates. They are a prominent modern member of the subfamily Bovinae\",\"phylum\":\"Chordata\",\"diet\":\"vegetarian\"}"
+        representation = endpoint.present(animal).to_json
+        expect(representation).to match expected_response
+      end
+      it 'presents with compact entity representation' do
+        endpoint.instance_variable_set :@env, {}
+        expected_response = "{\"name\":\"Cow\",\"description\":\"Are the most common type of large domesticated ungulates. They are a prominent modern member of the subfamily Bovinae\"}"    
+        representation = endpoint.present(animal, with: TestApp::Entities::Animals::Compact).to_json
+        expect(representation).to match expected_response
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,78 @@
+# 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
+require 'codeclimate-test-reporter'
+require 'simplecov'
+
+formatters = [SimpleCov::Formatter::HTMLFormatter]
+if ENV['CODECLIMATE_REPO_TOKEN']
+  formatters << CodeClimate::TestReporter::Formatter
+  CodeClimate::TestReporter.start
+end
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[*formatters]
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+require 'grape/transformations'
+require 'pry'
+require 'grape'
+require 'grape_entity'
+
+require File.expand_path("../test_app/config/environment", __FILE__)
+
+require 'rails/all'
+require 'rspec/rails'
+require 'rspec/mocks'
+
+require 'ammeter/init'
+
+RSpec.configure do |config|
+
+  config.after(:suite) do
+    # Removes the tests directory used for generators testing
+     File.join File.expand_path("../", __FILE__), "/tmp/tests"
+  end
+
+  config.include RSpec::Rails::RequestExampleGroup, type: :request, parent_example_group: { file_path: /spec\/api/ }
+
+  # 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
+
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end

data/spec/test_app/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/test_app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/test_app/app/api/api.rb

@@ -0,0 +1,7 @@
+class API < Grape::API
+  prefix 'api'
+  # Separate the api into smaller
+  # modules like this
+  mount TestApp::Modules::User
+  mount TestApp::Modules::Animal
+end

data/spec/test_app/app/api/test_app/entities/animals/compact.rb

@@ -0,0 +1,10 @@
+module TestApp
+  module Entities
+    module Animals
+      class Compact < Grape::Entity
+        expose :name, documentation: { type: "string", desc: "animal name", example: 'Cow' }
+        expose :description, documentation: { type: "string", desc: "animal name", example: 'Are the most common type of large domesticated ungulates. They are a prominent modern member of the subfamily Bovinae' }
+      end
+    end
+  end
+end

data/spec/test_app/app/api/test_app/entities/animals/full.rb

@@ -0,0 +1,12 @@
+module TestApp
+  module Entities
+    module Animals
+      class Full < Grape::Entity
+        expose :name, documentation: { type: "string", desc: "animal name", example: 'Cow' }
+        expose :description, documentation: { type: "string", desc: "animal name", example: 'Are the most common type of large domesticated ungulates. They are a prominent modern member of the subfamily Bovinae' }
+        expose :phylum, documentation: { type: "string", desc: "user age", example: 'Chordata' }
+        expose :diet, documentation: { type: "string", desc: "address", example: 'vegetarian' }
+      end
+    end
+  end
+end

data/spec/test_app/app/api/test_app/entities/food.rb

@@ -0,0 +1,8 @@
+module TestApp
+  module Entities
+    class Food < Grape::Entity
+      expose :name, documentation: { type: "string", desc: "food name", example: 'Mondongo' }
+      expose :description, documentation: { type: "string", desc: "food description", example: 'is a soup made from diced tripe (the stomach of a cow) slow-cooked with vegetables such as bell peppers, onions, carrots, cabbage, celery, tomatoes, cilantro (coriander), garlic or root vegetables.' }
+    end
+  end
+end