apicasso 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab5b6196d2e1a9675b5b4eca26522f6ff1dabe63
-  data.tar.gz: 1715dc2d29b09e97deba8f41b811709059a3520c
+  metadata.gz: e1bf6652d93e5464765b0c05924a1a948efa9337
+  data.tar.gz: 0f599b807751c7151fd2ca943e0dbb840d33d810
 SHA512:
-  metadata.gz: f9a542fe03655f97043183cb6040d0ff92a0d533a337faf43a4a4771cc0ba75e2ce73c2494d98b0c8436b049bcf548ae0e14cdd8ba26ae0a1b42be2f3186f502
-  data.tar.gz: 5ff7a98726754f89f1cf6f50038b2f5c062f49d204626b5dda58da7eb85d08643ddbc0aa0d9c057f5241a3cb47044f6146431be6453159f933464b47c6b49892
+  metadata.gz: 7db2ffa761b81b282cf62d33b40f0a884fdbbd35d71ff0915a1050c74c60203eb7c7ed5b51e9393fa9711ff547f5c3525168b631987e208960a35fdb539811eb
+  data.tar.gz: 0aaec104200af5337d282d93e00711b4e4f6be38033620d2e7f8295d6a175529ccb21f92c03fed79f448c58fef5b3f52bddb013a48d5eeae1111c61877da5cbd

data/README.md

@@ -19,7 +19,7 @@ And then execute this to generate the required migrations:
 $ bundle install && rails g apicasso:install
 ```
 
-You will need to use a database with JSON fields support to use this gem.
+### You will must have PostgreSQL as database to be able to use this gem.
 
 # Usage
 
@@ -176,7 +176,7 @@ If there is any method or relation that you want to be inserted on the payload,
 ?include=pictures,suggestions
 ```
 
-This will insert the contents of `.pictures` and `.suggestions` on the payload, along with the records' data. **This method can be used both on index and show actions**
+This will insert the contents of `.pictures` and `.suggestions` on the payload, along with the records' data. This means you can populate the payload both with methods or relations contents. **This method can be used both on index and show actions**
 
 ### Grouping operations
 
@@ -206,9 +206,10 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Ervalh
 
 ### TODO
 
-- Abstract a configurable CORS approach, maybe using middleware.
+- Add support to other databases
+- Abstract a configurable CORS approach, maybe using middleware
 - Add gem options like: Token rotation, Alternative authentication methods
-- Add latest auto-documentation feature into README
+- Refine and document auto-documentation feature
 - Rate limiting
 - Testing suite
 - Travis CI

data/Rakefile

@@ -1,32 +1,23 @@
+#!/usr/bin/env rake
 begin
   require 'bundler/setup'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Apicasso'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
 load 'rails/tasks/engine.rake'
 
-load 'rails/tasks/statistics.rake'
+Bundler::GemHelper.install_tasks
 
-require 'bundler/gem_tasks'
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
 
-require 'rake/testtask'
+require 'rspec/core'
+require 'rspec/core/rake_task'
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
 
-task default: :test
+task default: :spec

data/app/controllers/apicasso/crud_controller.rb

@@ -67,7 +67,7 @@ module Apicasso
                     resource: resource.name.underscore.to_sym,
                     object: @object)
       if @object.save
-        render json: @object, status: :created, location: @object
+        render json: @object, status: :created
       else
         render json: @object.errors, status: :unprocessable_entity
       end
@@ -205,7 +205,41 @@ module Apicasso
     # Only allow a trusted parameter "white list" through,
     # based on resource's schema.
     def object_params
-      params.fetch(resource.name.underscore.to_sym, resource_schema.keys)
+      params.require(resource.name.underscore.to_sym)
+            .permit(resource_params)
+    end
+
+    # Resource params mapping, with a twist:
+    # Including relations as they are needed
+    def resource_params
+      built = resource_schema.keys
+      built += has_one_params if has_one_params.present?
+      built += has_many_params if has_many_params.present?
+      built
+    end
+
+    # A wrapper to has_one relations parameter building
+    def has_one_params
+      resource.reflect_on_all_associations(:has_one).map do |one|
+        if one.class_name.starts_with?('ActiveStorage')
+          next if one.class_name.ends_with?('Blob')
+          one.name.to_s.gsub(/(_attachment)$/, '').to_sym
+        else
+          one.name
+        end
+      end.compact
+    end
+
+    # A wrapper to has_many parameter building
+    def has_many_params
+      resource.reflect_on_all_associations(:has_many).map do |many|
+        if many.class_name.starts_with?('ActiveStorage')
+          next if many.class_name.ends_with?('Blob')
+          { many.name.to_s.gsub(/(_attachments)$/, '').to_sym => [] }
+        else
+          { many.name.to_sym => [] }
+        end
+      end.compact
     end
   end
 end

data/app/models/apicasso/ability.rb

@@ -16,7 +16,7 @@ module Apicasso
             # To have a key reading all channels and all accouts
             # you would have a scope:
             # => `{read: {channel: true, accout: true}}`
-            can permission.to_sym, klass.underscore.to_sym
+            can permission.to_sym, klass.underscore.singularize.to_sym
             can permission.to_sym, klass.classify.constantize
           elsif clearance.class == Hash
             # Usage:
@@ -24,7 +24,7 @@ module Apicasso
             # you would have a scope:
             # => `{read: {banner: {owner_id: [999]}}}`
             can permission.to_sym,
-                klass.underscore.to_sym
+                klass.underscore.singularize.to_sym
             clearance.each do |by_field, values|
               can permission.to_sym,
                   klass.classify.constantize,

data/db/migrate/20180826141433_create_apicasso_tables.rb

@@ -1,5 +1,8 @@
 class CreateApicassoTables < ActiveRecord::Migration[5.0]
   def change
+    execute <<-SQL
+      CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
+    SQL
     create_table :apicasso_keys, id: :uuid do |t|
       t.json :scope
       t.integer :scope_type

data/lib/apicasso/engine.rb

@@ -1,6 +1,13 @@
 # frozen_string_literal: true
 
 module Apicasso
+  # Behavior control for the Apicasso::Engine
   class Engine < ::Rails::Engine
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+      g.assets false
+      g.helper false
+    end
   end
 end

data/lib/apicasso/version.rb

@@ -1,3 +1,3 @@
 module Apicasso
-  VERSION = '0.3.3'.freeze
+  VERSION = '0.4.0'.freeze
 end

data/lib/apicasso.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+require 'cancancan'
+require 'swagger/blocks'
+require 'ransack'
+require 'will_paginate'
 require 'apicasso/version'
 require 'apicasso/engine'
 require 'apicasso/active_record_extension'

data/spec/apicasso_spec.rb

@@ -0,0 +1,5 @@
+RSpec.describe Apicasso do
+  it "has a version number" do
+    expect(Apicasso::VERSION).not_to be nil
+  end
+end

data/spec/controllers/apicasso/aplication_controller_spec.rb

@@ -0,0 +1,18 @@
+require 'rails_helper'
+
+RSpec.describe Apicasso::ApplicationController, type: :controller do
+
+  describe "#current_ability" do
+    it "instantiates a @current_ability object" do
+      Apicasso::ApplicationController.current_ability
+      expect(@current_ability).not_to be nil
+    end
+  end
+
+  describe "#restrict_access" do
+    it "instantiates an @api_key object" do
+      Apicasso::ApplicationController.current_ability
+      expect(@api_key).not_to be nil
+    end
+  end
+end

data/spec/controllers/apicasso/crud_controller_spec.rb

@@ -0,0 +1,107 @@
+require 'rails_helper'
+
+RSpec.describe Apicasso::ApplicationController, type: :controller do
+
+  # This should return the minimal set of values that should be in the session
+  # in order to pass any filters (e.g. authentication) defined in
+  # AppointmentsController. Be sure to keep this updated too.
+  let(:valid_session) { {} }
+
+  describe "GET #index" do
+    it "returns a success response" do
+      Appointment.create! valid_attributes
+      get :index, params: {}, session: valid_session
+      expect(response).to be_successful
+    end
+  end
+
+  describe "GET #show" do
+    it "returns a success response" do
+      appointment = Appointment.create! valid_attributes
+      get :show, params: {id: appointment.to_param}, session: valid_session
+      expect(response).to be_successful
+    end
+  end
+
+  describe "GET #new" do
+    it "returns a success response" do
+      get :new, params: {}, session: valid_session
+      expect(response).to be_successful
+    end
+  end
+
+  describe "GET #edit" do
+    it "returns a success response" do
+      appointment = Appointment.create! valid_attributes
+      get :edit, params: {id: appointment.to_param}, session: valid_session
+      expect(response).to be_successful
+    end
+  end
+
+  describe "POST #create" do
+    context "with valid params" do
+      it "creates a new Appointment" do
+        expect {
+          post :create, params: {appointment: valid_attributes}, session: valid_session
+        }.to change(Appointment, :count).by(1)
+      end
+
+      it "redirects to the created appointment" do
+        post :create, params: {appointment: valid_attributes}, session: valid_session
+        expect(response).to redirect_to(Appointment.last)
+      end
+    end
+
+    context "with invalid params" do
+      it "returns a success response (i.e. to display the 'new' template)" do
+        post :create, params: {appointment: invalid_attributes}, session: valid_session
+        expect(response).to be_successful
+      end
+    end
+  end
+
+  describe "PUT #update" do
+    context "with valid params" do
+      let(:new_attributes) {
+        skip("Add a hash of attributes valid for your model")
+      }
+
+      it "updates the requested appointment" do
+        appointment = Appointment.create! valid_attributes
+        put :update, params: {id: appointment.to_param, appointment: new_attributes}, session: valid_session
+        appointment.reload
+        skip("Add assertions for updated state")
+      end
+
+      it "redirects to the appointment" do
+        appointment = Appointment.create! valid_attributes
+        put :update, params: {id: appointment.to_param, appointment: valid_attributes}, session: valid_session
+        expect(response).to redirect_to(appointment)
+      end
+    end
+
+    context "with invalid params" do
+      it "returns a success response (i.e. to display the 'edit' template)" do
+        appointment = Appointment.create! valid_attributes
+        put :update, params: {id: appointment.to_param, appointment: invalid_attributes}, session: valid_session
+        expect(response).to be_successful
+      end
+    end
+  end
+
+  describe "DELETE #destroy" do
+    it "destroys the requested appointment" do
+      appointment = Appointment.create! valid_attributes
+      expect {
+        delete :destroy, params: {id: appointment.to_param}, session: valid_session
+      }.to change(Appointment, :count).by(-1)
+    end
+
+    it "redirects to the appointments list" do
+      appointment = Appointment.create! valid_attributes
+      delete :destroy, params: {id: appointment.to_param}, session: valid_session
+      expect(response).to redirect_to(appointments_url)
+    end
+  end
+
+end

data/spec/dummy/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_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/spec/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/bin/update

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/bin/yarn

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path('..', __dir__)
+Dir.chdir(APP_ROOT) do
+  begin
+    exec "yarnpkg", *ARGV
+  rescue Errno::ENOENT
+    $stderr.puts "Yarn executable was not detected in the system."
+    $stderr.puts "Download Yarn at https://yarnpkg.com/en/docs/install"
+    exit 1
+  end
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,19 @@
+require_relative 'boot'
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require 'apicasso'
+
+module Dummy
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 5.2
+
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration can go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded after loading
+    # the framework and any gems in your application.
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/spec/dummy/config/cable.yml

@@ -0,0 +1,10 @@
+development:
+  adapter: async
+
+test:
+  adapter: async
+
+production:
+  adapter: redis
+  url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
+  channel_prefix: dummy_production

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!