shaf 0.4.1 → 0.5.0

data/templates/api/controllers/docs_controller.rb

@@ -4,10 +4,12 @@ class DocsController < BaseController
   register_uri :documentation,  '/doc/:resource'
 
   get doc_curie_uri_template do
+    cache_control(:private, http_cache_max_age: :long)
     doc.link(params[:rel])
   end
 
   get documentation_uri_template do
+    cache_control(:private, http_cache_max_age: :long)
     doc.to_s
   end
 

data/templates/api/controllers/root_controller.rb

@@ -1,10 +1,9 @@
 class RootController < BaseController
 
-  HTTP_CACHE_MAX_AGE = 86400 # 60 * 60 * 24 = 1 day
   register_uri :root, '/'
 
-  get root_uri do
-    cache_control(:private, max_age: HTTP_CACHE_MAX_AGE) if Shaf::Settings.http_cache
+  get :root_uri do
+    cache_control(:private, http_cache_max_age: :long)
     respond_with nil, serializer: RootSerializer
   end
 end

data/templates/api/policies/base_policy.rb

@@ -0,0 +1,3 @@
+class BasePolicy
+  include HALPresenter::Policy::DSL
+end

data/templates/api/serializers/base_serializer.rb

@@ -0,0 +1,4 @@
+class BaseSerializer
+  extend HALPresenter
+  extend Shaf::UriHelper
+end

data/templates/api/serializers/error_serializer.rb

@@ -1,5 +1,6 @@
-class ErrorSerializer
-  extend HALPresenter
+require 'serializers/base_serializer'
+
+class ErrorSerializer < BaseSerializer
 
   model Shaf::Errors::ServerError
 

data/templates/api/serializers/form_serializer.rb

@@ -1,7 +1,7 @@
+require 'serializers/base_serializer'
 require 'shaf/formable'
 
-class FormSerializer
-  extend HALPresenter
+class FormSerializer < BaseSerializer
 
   model Shaf::Formable::Form
 

data/templates/api/serializers/root_serializer.rb

@@ -1,6 +1,6 @@
-class RootSerializer
-  extend HALPresenter
-  extend Shaf::UriHelper
+require 'serializers/base_serializer'
+
+class RootSerializer < BaseSerializer
 
   # Auto generated doc:  
   # Link to the root resource. All clients should fetch this resource

data/templates/config/initializers/db_migrations.rb

@@ -2,17 +2,30 @@ require 'sequel'
 require 'config/database'
 
 Sequel.extension :migration
-return unless Dir[File.join(MIGRATIONS_DIR, "*")].any?
-return if Sequel::Migrator.is_current?(DB, MIGRATIONS_DIR)
+Dir[File.join(MIGRATIONS_DIR, "*")]
 
-environment = ENV['RACK_ENV']
+def is_current?
+  return true unless Dir[File.join(MIGRATIONS_DIR, "*")].any?
+  Sequel::Migrator.is_current?(DB, MIGRATIONS_DIR)
+end
+
+def environment
+  ENV['RACK_ENV']
+end
 
-if environment == 'test'
-  $logger.info "Running migrations in 'test' environment.."
-  Sequel::Migrator.run(DB, "#{APP_ROOT}/db/migrations")
-else
-  msg = "Database for environment '#{environment}' is not " \
-    "updated to the latest migration"
-  STDERR.puts msg
-  $logger&.warn msg
+def init
+  return if is_current?
+
+  if environment == 'test'
+    $logger.info "Running migrations in 'test' environment.."
+    Sequel::Migrator.run(DB, "#{APP_ROOT}/db/migrations")
+  else
+    msg = "Database for environment '#{environment}' is not " \
+      "updated to the latest migration"
+    STDERR.puts msg
+    $logger&.warn msg
+  end
 end
+
+init
+

data/templates/config/initializers/hal_presenter.rb

@@ -1,6 +1 @@
-if Sinatra::Application.settings.environment == :development
-  port = Shaf::Settings.port ? ":#{Shaf::Settings.port}" : ""
-  HALPresenter.base_href = "http://localhost#{port}"
-end
-
 HALPresenter.paginate = true

data/templates/config/settings.yml

@@ -1,6 +1,5 @@
 ---
 default: &default
-  port: 3000
   public_folder: frontend/assets
   views_folder: frontend/views
   documents_dir: doc/api
@@ -8,14 +7,20 @@ default: &default
   fixtures_dir: spec/fixtures
   paginate_per_page: 25
   http_cache: on
+  http_cache_max_age_long: 86400 # 60 * 60 * 24 = 1 day
+  http_cache_max_age_short: 3600 #      60 * 60 = 1 hour
+  hostname: localhost
+  protocol: http
+  port: 3000
 
 production:
   <<: *default
-  port: 80
+  port: 443
+  protocol: https
 
 development:
   <<: *default
 
 test:
   <<: *default
-  port: 3000
+  port: 3030

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shaf
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Sammy Henningsson
@@ -30,7 +30,7 @@ cert_chain:
   ZMhjYR7sRczGJx+GxGU2EaR0bjRsPVlC4ywtFxoOfRG3WaJcpWGEoAoMJX6Z0bRv
   M40=
   -----END CERTIFICATE-----
-date: 2018-07-22 00:00:00.000000000 Z
+date: 2018-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -39,19 +39,75 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.10'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: A framework for building hypermedia driven APIs with sinatra and sequel.
 email: sammy.henningsson@gmail.com
 executables:
@@ -65,6 +121,7 @@ files:
 - lib/shaf/api_doc/document.rb
 - lib/shaf/app.rb
 - lib/shaf/command.rb
+- lib/shaf/command/base.rb
 - lib/shaf/command/console.rb
 - lib/shaf/command/generate.rb
 - lib/shaf/command/new.rb
@@ -81,10 +138,12 @@ files:
 - lib/shaf/extensions/symbolic_routes.rb
 - lib/shaf/formable.rb
 - lib/shaf/generator.rb
+- lib/shaf/generator/base.rb
 - lib/shaf/generator/controller.rb
 - lib/shaf/generator/migration.rb
 - lib/shaf/generator/migration/add_column.rb
 - lib/shaf/generator/migration/add_index.rb
+- lib/shaf/generator/migration/base.rb
 - lib/shaf/generator/migration/create_table.rb
 - lib/shaf/generator/migration/drop_column.rb
 - lib/shaf/generator/migration/empty.rb
@@ -101,6 +160,7 @@ files:
 - lib/shaf/generator/templates/spec/model.rb.erb
 - lib/shaf/generator/templates/spec/serializer_spec.rb.erb
 - lib/shaf/helpers.rb
+- lib/shaf/helpers/cache_control.rb
 - lib/shaf/helpers/json_html.rb
 - lib/shaf/helpers/paginate.rb
 - lib/shaf/helpers/payload.rb
@@ -135,6 +195,8 @@ files:
 - templates/api/controllers/base_controller.rb
 - templates/api/controllers/docs_controller.rb
 - templates/api/controllers/root_controller.rb
+- templates/api/policies/base_policy.rb
+- templates/api/serializers/base_serializer.rb
 - templates/api/serializers/error_serializer.rb
 - templates/api/serializers/form_serializer.rb
 - templates/api/serializers/root_serializer.rb
@@ -159,6 +221,7 @@ files:
 - templates/spec/serializers/root_serializer_spec.rb
 - templates/spec/spec_helper.rb
 - upgrades/0.4.0.tar.gz
+- upgrades/0.5.0.tar.gz
 homepage: https://github.com/sammyhenningsson/shaf
 licenses:
 - MIT
@@ -180,7 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Sinatra Hypermedia Api Framework