apicasso 0.4.5 → 0.4.6

data/app/models/apicasso/application_record.rb

@@ -1,6 +1,6 @@
-module Apicasso
-  class ApplicationRecord < ActiveRecord::Base
-    self.abstract_class = true
-    self.table_name_prefix = 'apicasso_'
-  end
-end
+module Apicasso
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+    self.table_name_prefix = 'apicasso_'
+  end
+end

data/app/models/apicasso/key.rb

@@ -1,25 +1,25 @@
-# frozen_string_literal: true
-
-require 'securerandom'
-module Apicasso
-  # A model to abstract API access, with scope options, token generation, request limiting
-  class Key < Apicasso::ApplicationRecord
-    before_create :set_auth_token
-
-    private
-
-    # Method that generates `SecureRandom.uuid` as token until
-    # an unique one has been acquired
-    def set_auth_token
-      loop do
-        self.token = generate_auth_token
-        break unless self.class.exists?(token: token)
-      end
-    end
-
-    # RFC4122 style token
-    def generate_auth_token
-      SecureRandom.uuid.delete('-')
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'securerandom'
+module Apicasso
+  # A model to abstract API access, with scope options, token generation, request limiting
+  class Key < Apicasso::ApplicationRecord
+    before_create :set_auth_token
+
+    private
+
+    # Method that generates `SecureRandom.uuid` as token until
+    # an unique one has been acquired
+    def set_auth_token
+      loop do
+        self.token = generate_auth_token
+        break unless self.class.exists?(token: token)
+      end
+    end
+
+    # RFC4122 style token
+    def generate_auth_token
+      SecureRandom.uuid.delete('-')
+    end
+  end
+end

data/app/models/apicasso/request.rb

@@ -1,8 +1,8 @@
-# frozen_string_literal: true
-
-module Apicasso
-  # A model to abstract API access, with scope options, token generation, request limiting
-  class Request < Apicasso::ApplicationRecord
-    belongs_to :api_key, class_name: 'Apicasso::Key'
-  end
-end
+# frozen_string_literal: true
+
+module Apicasso
+  # A model to abstract API access, with scope options, token generation, request limiting
+  class Request < Apicasso::ApplicationRecord
+    belongs_to :api_key, class_name: 'Apicasso::Key'
+  end
+end

data/config/routes.rb

@@ -1,14 +1,14 @@
-Apicasso::Engine.routes.draw do
-  scope module: :apicasso do
-    resources :apidocs, only: [:index]
-    get '/:resource/', to: 'crud#index', via: :get
-    match '/:resource/', to: 'crud#create', via: :post
-    get '/:resource/:id', to: 'crud#show', via: :get
-    match '/:resource/:id', to: 'crud#update', via: :patch
-    match '/:resource/:id', to: 'crud#destroy', via: :delete
-    match '/:resource/:id/:nested/', to: 'crud#nested_index', via: :get
-    match '/:resource/', to: 'crud#schema', via: :options
-    match '/:resource/:id', to: 'crud#schema', via: :options
-    match '/:resource/:id/:nested/', to: 'crud#schema', via: :options
-  end
-end
+Apicasso::Engine.routes.draw do
+  scope module: :apicasso do
+    resources :apidocs, only: [:index]
+    get '/:resource/', to: 'crud#index', via: :get
+    match '/:resource/', to: 'crud#create', via: :post
+    get '/:resource/:id', to: 'crud#show', via: :get
+    match '/:resource/:id', to: 'crud#update', via: :patch
+    match '/:resource/:id', to: 'crud#destroy', via: :delete
+    match '/:resource/:id/:nested/', to: 'crud#nested_index', via: :get
+    match '/:resource/', to: 'crud#schema', via: :options
+    match '/:resource/:id', to: 'crud#schema', via: :options
+    match '/:resource/:id/:nested/', to: 'crud#schema', via: :options
+  end
+end

data/lib/apicasso/active_record_extension.rb

@@ -29,50 +29,6 @@ module Apicasso
         validated_attrs_for(:presence)
       end
     end
-    included do
-      include ::Swagger::Blocks
-      @@klass = self
-      swagger_schema @@klass.name.to_sym do
-        key :required, %i[*presence_validators] if @@klass.presence_validators?
-        @@klass.columns_hash.each do |name, type|
-          property name.to_sym do
-            key :type, type.type
-          end
-        end
-      end
-      swagger_schema "#{@@klass.name}Input".to_sym do
-        allOf do
-          schema do
-            key :'$ref', "#{@@klass.name}Input".to_sym
-          end
-          schema do
-            key :required, %i[*presence_validators] if @@klass.presence_validators?
-            @@klass.columns_hash.each do |name, type|
-              property name.to_sym do
-                key :type, type.type
-              end
-            end
-          end
-        end
-      end
-      swagger_schema "#{@@klass.name}Metadata".to_sym do
-        allOf do
-          schema do
-            key :'$ref', "#{@@klass.name}Metadata".to_sym
-          end
-          schema do
-            @@klass.columns_hash.each do |name, type|
-              property name.to_sym do
-                key :description, type.type
-                key :type, :string
-              end
-            end
-          end
-        end
-      end
-    rescue ActiveRecord::ConnectionNotEstablished
-      puts "No database connection to setup APIcasso routes in documentation"
-    end
   end
 end
 

data/lib/apicasso/engine.rb

@@ -1,13 +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
+# 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.4.5'.freeze
-end
+module Apicasso
+  VERSION = '0.4.6'.freeze
+end

data/lib/apicasso.rb

@@ -1,13 +1,15 @@
-# 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'
-
-module Apicasso
-  # Your code goes here...
-end
+# frozen_string_literal: true
+
+require 'cancancan'
+require 'swagger/blocks'
+require 'ransack'
+require 'will_paginate/array'
+require 'will_paginate'
+require 'apicasso/version'
+require 'apicasso/engine'
+require 'apicasso/active_record_extension'
+require 'friendly_id'
+
+module Apicasso
+  # Your code goes here...
+end

data/lib/generators/apicasso/install/install_generator.rb

@@ -1,25 +1,25 @@
-require 'rails/generators/migration'
-
-module Apicasso
-  module Generators
-    class InstallGenerator < ::Rails::Generators::Base
-      include Rails::Generators::Migration
-      source_root File.expand_path('../templates', __FILE__)
-      desc 'Add the required migrations to run APIcasso'
-
-      def self.next_migration_number(path)
-        if @prev_migration_nr
-          @prev_migration_nr += 1
-        else
-          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
-        end
-        @prev_migration_nr.to_s
-      end
-
-      def copy_migrations
-        migration_template 'create_apicasso_tables.rb',
-                           'db/migrate/create_apicasso_tables.rb'
-      end
-    end
-  end
-end
+require 'rails/generators/migration'
+
+module Apicasso
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      desc 'Add the required migrations to run APIcasso'
+
+      def self.next_migration_number(path)
+        if @prev_migration_nr
+          @prev_migration_nr += 1
+        else
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        end
+        @prev_migration_nr.to_s
+      end
+
+      def copy_migrations
+        migration_template 'create_apicasso_tables.rb',
+                           'db/migrate/create_apicasso_tables.rb'
+      end
+    end
+  end
+end

data/lib/generators/apicasso/install/templates/create_apicasso_tables.rb

@@ -1,20 +1,20 @@
-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
-      t.json :request_limiting
-      t.text :token
-      t.datetime :deleted_at
-      t.timestamps null: false
-    end
-    create_table :apicasso_requests, id: :uuid do |t|
-      t.text :api_key_id
-      t.json :object
-      t.timestamps null: false
-    end
-  end
-end
+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
+      t.json :request_limiting
+      t.text :token
+      t.datetime :deleted_at
+      t.timestamps null: false
+    end
+    create_table :apicasso_requests, id: :uuid do |t|
+      t.text :api_key_id
+      t.json :object
+      t.timestamps null: false
+    end
+  end
+end

data/spec/dummy/Gemfile

@@ -0,0 +1,56 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby '2.5.1'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '~> 5.2.0'
+# Use postgresql as the database for Active Record
+gem 'pg', '>= 0.18', '< 2.0'
+# Use Puma as the app server
+gem 'puma', '~> 3.11'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+# gem 'jbuilder', '~> 2.5'
+# Use Redis adapter to run Action Cable in production
+gem 'redis', '~> 4.0'
+# Use ActiveModel has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use ActiveStorage variant
+# gem 'mini_magick', '~> 4.8'
+
+# Use Capistrano for deployment
+# gem 'capistrano-rails', group: :development
+
+# Reduces boot times through caching; required in config/boot.rb
+gem 'bootsnap', '>= 1.1.0', require: false
+
+# Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible
+# gem 'rack-cors'
+
+# gem 'cancancan'
+# gem 'ransack'
+# gem 'will_paginate'
+gem 'apicasso'
+gem 'redis-rails'
+gem 'redis-namespace'
+gem 'active_model_serializers'
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+  gem 'rspec-rails'
+  gem 'factory_bot_rails'
+  gem 'faker', :git => 'https://github.com/stympy/faker.git', :branch => 'master'
+end
+
+group :development do
+  gem 'listen', '>= 3.0.5', '< 3.2'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+  gem 'spring-watcher-listen', '~> 2.0.0'
+end
+
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

data/spec/dummy/Gemfile.lock

@@ -0,0 +1,237 @@
+GIT
+  remote: https://github.com/stympy/faker.git
+  revision: 62b5857970218fc7615deb12d844fc4645c4c69f
+  branch: master
+  specs:
+    faker (1.9.1)
+      i18n (>= 0.7)
+
+PATH
+  remote: ../APIcasso
+  specs:
+    apicasso (0.4.4)
+      cancancan (~> 2.0)
+      friendly_id (~> 5.2.0)
+      rails (> 5)
+      ransack
+      swagger-blocks
+      will_paginate (~> 3.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.1)
+      actionpack (= 5.2.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.1)
+      actionview (= 5.2.1)
+      activesupport (= 5.2.1)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.1)
+      activesupport (= 5.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    active_model_serializers (0.10.8)
+      actionpack (>= 4.1, < 6)
+      activemodel (>= 4.1, < 6)
+      case_transform (>= 0.2)
+      jsonapi-renderer (>= 0.1.1.beta1, < 0.3)
+    activejob (5.2.1)
+      activesupport (= 5.2.1)
+      globalid (>= 0.3.6)
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
+      arel (>= 9.0)
+    activestorage (5.2.1)
+      actionpack (= 5.2.1)
+      activerecord (= 5.2.1)
+      marcel (~> 0.3.1)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    bootsnap (1.3.2)
+      msgpack (~> 1.0)
+    builder (3.2.3)
+    byebug (10.0.2)
+    cancancan (2.3.0)
+    case_transform (0.2)
+      activesupport
+    concurrent-ruby (1.1.1)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubi (1.7.1)
+    factory_bot (4.11.1)
+      activesupport (>= 3.0.0)
+    factory_bot_rails (4.11.1)
+      factory_bot (~> 4.11.1)
+      railties (>= 3.0.0)
+    ffi (1.9.25)
+    friendly_id (5.2.4)
+      activerecord (>= 4.0.0)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    jsonapi-renderer (0.2.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.1)
+    mimemagic (0.3.2)
+    mini_mime (1.0.1)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    msgpack (1.2.4)
+    nio4r (2.3.1)
+    nokogiri (1.8.5)
+      mini_portile2 (~> 2.3.0)
+    pg (1.1.3)
+    puma (3.12.0)
+    rack (2.0.5)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.1)
+      actioncable (= 5.2.1)
+      actionmailer (= 5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
+      activemodel (= 5.2.1)
+      activerecord (= 5.2.1)
+      activestorage (= 5.2.1)
+      activesupport (= 5.2.1)
+      bundler (>= 1.3.0)
+      railties (= 5.2.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.1)
+      actionpack (= 5.2.1)
+      activesupport (= 5.2.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (12.3.1)
+    ransack (2.1.0)
+      actionpack (>= 5.0)
+      activerecord (>= 5.0)
+      activesupport (>= 5.0)
+      i18n
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    redis (4.0.3)
+    redis-actionpack (5.0.2)
+      actionpack (>= 4.0, < 6)
+      redis-rack (>= 1, < 3)
+      redis-store (>= 1.1.0, < 2)
+    redis-activesupport (5.0.7)
+      activesupport (>= 3, < 6)
+      redis-store (>= 1.3, < 2)
+    redis-namespace (1.6.0)
+      redis (>= 3.0.4)
+    redis-rack (2.0.4)
+      rack (>= 1.5, < 3)
+      redis-store (>= 1.2, < 2)
+    redis-rails (5.0.2)
+      redis-actionpack (>= 5.0, < 6)
+      redis-activesupport (>= 5.0, < 6)
+      redis-store (>= 1.2, < 2)
+    redis-store (1.6.0)
+      redis (>= 2.2, < 5)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-rails (3.8.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    ruby_dep (1.5.0)
+    spring (2.0.2)
+      activesupport (>= 4.2)
+    spring-watcher-listen (2.0.1)
+      listen (>= 2.7, < 4.0)
+      spring (>= 1.2, < 3.0)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    swagger-blocks (2.0.2)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+    will_paginate (3.1.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_model_serializers
+  apicasso!
+  bootsnap (>= 1.1.0)
+  byebug
+  factory_bot_rails
+  faker!
+  listen (>= 3.0.5, < 3.2)
+  pg (>= 0.18, < 2.0)
+  puma (~> 3.11)
+  rails (~> 5.2.0)
+  redis (~> 4.0)
+  redis-namespace
+  redis-rails
+  rspec-rails
+  spring
+  spring-watcher-listen (~> 2.0.0)
+  tzinfo-data
+
+RUBY VERSION
+   ruby 2.5.1p57
+
+BUNDLED WITH
+   1.16.6

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

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

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

@@ -0,0 +1,42 @@
+class UsedModel < ApplicationRecord
+  include Rails.application.routes.url_helpers
+
+  validates :account_id, presence: true
+  validates :unit_id, presence: true
+  validates :slug, presence: true, uniqueness: true
+
+  has_one_attached :file_highlighted
+  has_many_attached :files
+
+  extend FriendlyId
+  friendly_id :name, use: :slugged
+
+  def file_highlighted_url
+    rails_blob_path(file_highlighted, only_path: true) if nil? { file_highlighted_url = nil }
+  end
+
+  def files_url
+    used_model_attachments = self.files.attachments
+    urls = []
+    used_model_attachments.each do |attachment|
+      urls << rails_blob_path(attachment, only_path: true)
+    end
+    urls
+  end
+
+  def cache_key(*timestamp_names)
+    case
+    when new_record?
+      "#{model_name.cache_key}/new"
+    when timestamp_names.any?
+      timestamp = max_updated_column_timestamp(timestamp_names = timestamp_attributes_for_update_in_model)
+      timestamp = timestamp.utc.to_s(cache_timestamp_format)
+      "#{model_name.cache_key}/#{id}-#{timestamp}"
+    when timestamp = max_updated_column_timestamp
+      timestamp = timestamp.utc.to_s(cache_timestamp_format)
+      "#{model_name.cache_key}/#{id}-#{timestamp}"
+    else
+      "#{model_name.cache_key}/#{id}"
+    end
+  end
+end

data/spec/dummy/app/serializers/used_model_serializer.rb

@@ -0,0 +1,3 @@
+class UsedModelSerializer < ActiveModel::Serializer
+  cache key: 'cache_key', expires_in: 24.hours
+end

data/spec/dummy/bin/rails

@@ -1,4 +1,9 @@
 #!/usr/bin/env ruby
+begin
+  load File.expand_path('../spring', __FILE__)
+rescue LoadError => e
+  raise unless e.message.include?('spring')
+end
 APP_PATH = File.expand_path('../config/application', __dir__)
 require_relative '../config/boot'
 require 'rails/commands'