shaf 1.6.1 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data.tar.gz.sig +0 -0
- data/iana_link_relations.csv.gz +0 -0
- data/lib/shaf.rb +6 -0
- data/lib/shaf/alps/attribute_serializer.rb +41 -0
- data/lib/shaf/alps/json_serializer.rb +50 -0
- data/lib/shaf/alps/relation_serializer.rb +70 -0
- data/lib/shaf/api_doc/link_relations.rb +77 -0
- data/lib/shaf/authenticator.rb +56 -0
- data/lib/shaf/authenticator/base.rb +161 -0
- data/lib/shaf/authenticator/basic_auth.rb +25 -0
- data/lib/shaf/authenticator/challenge.rb +32 -0
- data/lib/shaf/authenticator/parameter.rb +31 -0
- data/lib/shaf/authenticator/request.rb +17 -0
- data/lib/shaf/command/console.rb +1 -1
- data/lib/shaf/command/generate.rb +5 -2
- data/lib/shaf/command/new.rb +20 -7
- data/lib/shaf/command/templates/Gemfile.erb +1 -0
- data/{templates/config/settings.yml → lib/shaf/command/templates/config/settings.yml.erb} +1 -5
- data/lib/shaf/errors.rb +11 -0
- data/lib/shaf/extensions.rb +3 -3
- data/lib/shaf/extensions/api_routes.rb +60 -0
- data/lib/shaf/extensions/authorize.rb +11 -9
- data/lib/shaf/extensions/log.rb +1 -1
- data/lib/shaf/extensions/resource_uris.rb +139 -63
- data/lib/shaf/extensions/symbolic_routes.rb +22 -19
- data/lib/shaf/formable.rb +1 -2
- data/lib/shaf/formable/form.rb +1 -1
- data/lib/shaf/generator.rb +2 -0
- data/lib/shaf/generator/base.rb +2 -3
- data/lib/shaf/generator/controller.rb +11 -7
- data/lib/shaf/generator/doc.rb +17 -0
- data/lib/shaf/generator/forms.rb +1 -0
- data/lib/shaf/generator/helper.rb +2 -1
- data/lib/shaf/generator/migration/base.rb +7 -3
- data/lib/shaf/generator/migration/type.rb +4 -26
- data/lib/shaf/generator/migration/types.rb +45 -16
- data/lib/shaf/generator/model.rb +1 -2
- data/lib/shaf/generator/profile.rb +52 -0
- data/lib/shaf/generator/serializer.rb +38 -73
- data/lib/shaf/generator/templates/api/policy.rb.erb +2 -2
- data/lib/shaf/generator/templates/api/profile.rb.erb +16 -0
- data/lib/shaf/generator/templates/api/serializer.rb.erb +2 -2
- data/lib/shaf/generator/templates/spec/integration_spec.rb.erb +1 -2
- data/lib/shaf/generator/templates/spec/serializer_spec.rb.erb +5 -5
- data/lib/shaf/helpers.rb +4 -0
- data/lib/shaf/helpers/authentication.rb +79 -0
- data/lib/shaf/helpers/payload.rb +14 -34
- data/lib/shaf/helpers/vary.rb +8 -0
- data/lib/shaf/logger.rb +12 -0
- data/lib/shaf/parser.rb +65 -0
- data/lib/shaf/parser/base.rb +44 -0
- data/lib/shaf/parser/form_data.rb +15 -0
- data/lib/shaf/parser/json.rb +26 -0
- data/lib/shaf/profile.rb +110 -0
- data/lib/shaf/profile/attribute.rb +29 -0
- data/lib/shaf/profile/evaluator.rb +46 -0
- data/lib/shaf/profile/relation.rb +29 -0
- data/lib/shaf/profile/unique_id.rb +58 -0
- data/lib/shaf/profiles.rb +42 -0
- data/lib/shaf/profiles/shaf_basic.rb +20 -0
- data/lib/shaf/profiles/shaf_error.rb +48 -0
- data/lib/shaf/profiles/shaf_form.rb +109 -0
- data/lib/shaf/responder.rb +41 -2
- data/lib/shaf/responder/alps_json.rb +25 -0
- data/lib/shaf/responder/base.rb +20 -17
- data/lib/shaf/responder/hal.rb +65 -4
- data/lib/shaf/responder/html.rb +43 -16
- data/lib/shaf/responder/problem_json.rb +1 -1
- data/lib/shaf/serializer.rb +31 -0
- data/lib/shaf/settings.rb +25 -12
- data/lib/shaf/spec.rb +1 -0
- data/lib/shaf/spec/authenticator.rb +13 -0
- data/lib/shaf/spec/base.rb +1 -1
- data/lib/shaf/spec/http_method_utils.rb +1 -1
- data/lib/shaf/spec/integration_spec.rb +25 -13
- data/lib/shaf/spec/payload_utils.rb +2 -2
- data/lib/shaf/supported_http_methods.rb +15 -0
- data/lib/shaf/tasks/api_doc_task.rb +24 -3
- data/lib/shaf/tasks/routes_task.rb +14 -17
- data/lib/shaf/upgrade/manifest.rb +11 -2
- data/lib/shaf/upgrade/package.rb +73 -43
- data/lib/shaf/upgrade/version.rb +11 -10
- data/lib/shaf/utils.rb +19 -5
- data/lib/shaf/version.rb +3 -1
- data/lib/shaf/yard.rb +34 -0
- data/lib/shaf/yard/attribute_method_handler.rb +19 -0
- data/lib/shaf/yard/attribute_object.rb +30 -0
- data/lib/shaf/yard/base_method_handler.rb +30 -0
- data/lib/shaf/yard/link_method_handler.rb +39 -0
- data/lib/shaf/yard/link_object.rb +60 -0
- data/lib/shaf/yard/nested_attributes.rb +37 -0
- data/lib/shaf/yard/parser.rb +64 -0
- data/lib/shaf/yard/profile_method_handler.rb +51 -0
- data/lib/shaf/yard/profile_object.rb +21 -0
- data/lib/shaf/yard/resource_object.rb +55 -0
- data/lib/shaf/yard/serializer_handler.rb +27 -0
- data/templates/api/controllers/base_controller.rb +0 -10
- data/templates/api/controllers/docs_controller.rb +5 -3
- data/templates/api/controllers/root_controller.rb +7 -1
- data/templates/api/policies/base_policy.rb +2 -0
- data/templates/api/serializers/base_serializer.rb +1 -3
- data/templates/api/serializers/error_serializer.rb +1 -5
- data/templates/api/serializers/form_serializer.rb +1 -5
- data/templates/api/serializers/validation_error_serializer.rb +1 -5
- data/templates/config/bootstrap.rb +1 -2
- data/templates/config/directories.rb +52 -44
- data/templates/config/helpers.rb +1 -1
- data/templates/config/initializers.rb +52 -8
- data/templates/config/initializers/authentication.rb +18 -0
- data/templates/config/initializers/db_migrations.rb +2 -2
- data/templates/config/initializers/logging.rb +2 -2
- data/templates/spec/spec_helper.rb +2 -0
- data/upgrades/0.5.0.tar.gz +0 -0
- data/upgrades/1.0.4.tar.gz +0 -0
- data/upgrades/1.1.0.tar.gz +0 -0
- data/upgrades/2.0.0.tar.gz +0 -0
- data/yard_templates/api_doc/doc_index/html/body.erb +3 -0
- data/yard_templates/api_doc/doc_index/setup.rb +8 -0
- data/yard_templates/api_doc/html/css/api-doc.css +222 -0
- data/yard_templates/api_doc/html/favicon.ico +0 -0
- data/yard_templates/api_doc/html/js/switch_tab.js +17 -0
- data/yard_templates/api_doc/html/setup.rb +59 -0
- data/yard_templates/api_doc/layout/html/footer.erb +3 -0
- data/yard_templates/api_doc/layout/html/header.erb +7 -0
- data/yard_templates/api_doc/layout/html/layout.erb +13 -0
- data/yard_templates/api_doc/layout/setup.rb +24 -0
- data/yard_templates/api_doc/profile/html/attributes.erb +10 -0
- data/yard_templates/api_doc/profile/html/profile.erb +6 -0
- data/yard_templates/api_doc/profile/html/relations.erb +10 -0
- data/yard_templates/api_doc/profile/setup.rb +38 -0
- data/yard_templates/api_doc/profile_attribute/html/attribute.erb +23 -0
- data/yard_templates/api_doc/profile_attribute/setup.rb +21 -0
- data/yard_templates/api_doc/profile_relation/html/relation.erb +37 -0
- data/yard_templates/api_doc/profile_relation/setup.rb +41 -0
- data/yard_templates/api_doc/resource/html/attributes.erb +10 -0
- data/yard_templates/api_doc/resource/html/profile.erb +14 -0
- data/yard_templates/api_doc/resource/html/relations.erb +10 -0
- data/yard_templates/api_doc/resource/html/resource.erb +5 -0
- data/yard_templates/api_doc/resource/setup.rb +56 -0
- data/yard_templates/api_doc/resource_attribute/html/attribute.erb +23 -0
- data/yard_templates/api_doc/resource_attribute/setup.rb +20 -0
- data/yard_templates/api_doc/resource_relation/html/relation.erb +47 -0
- data/yard_templates/api_doc/resource_relation/setup.rb +80 -0
- data/yard_templates/api_doc/setup.rb +31 -0
- data/yard_templates/api_doc/sidebar/html/profile_list.erb +8 -0
- data/yard_templates/api_doc/sidebar/html/search.erb +7 -0
- data/yard_templates/api_doc/sidebar/html/serializer_list.erb +8 -0
- data/yard_templates/api_doc/sidebar/html/sidebar.erb +13 -0
- data/yard_templates/api_doc/sidebar/setup.rb +56 -0
- metadata +137 -30
- metadata.gz.sig +1 -3
- data/lib/shaf/extensions/current_user.rb +0 -48
- data/lib/shaf/responder/hal_serializable.rb +0 -64
metadata.gz.sig
CHANGED
@@ -1,3 +1 @@
|
|
1
|
-
9�
|
2
|
-
Tќ��"M��K�(ҜU�~�9O`iv(0�-o� ��s%������R*��3�SL��<h�d�����t���9"��9M�"�`�EL�K����+ユc��+$�%���z{jM�+��ߧ�!s�Z���>�ܽ���� yR�\݆wAZ����*������DkNz'1ހ���?~��]V�����5W���j�_�~$^W<?p�s���
|
3
|
-
i�A~�Y`�
|
1
|
+
��� !B�R6X���Zg��Q�x9����v��a�p�F)�Wu��p9q�����hE�G��H��?YK��E����ġ9{�C�<<�3�u�'�ק
|
@@ -1,48 +0,0 @@
|
|
1
|
-
require 'digest'
|
2
|
-
|
3
|
-
module Shaf
|
4
|
-
module CurrentUser
|
5
|
-
def self.registered(settings)
|
6
|
-
return unless settings.respond_to?(:current_user) && settings.current_user
|
7
|
-
|
8
|
-
settings.log.info 'Using Shaf::CurrentUser'
|
9
|
-
settings.helpers Helpers
|
10
|
-
end
|
11
|
-
|
12
|
-
def self.digest(token)
|
13
|
-
Digest::SHA256.hexdigest(token) if token
|
14
|
-
end
|
15
|
-
end
|
16
|
-
|
17
|
-
module Helpers
|
18
|
-
ERR_MSG = 'The default Shaf implementation of #current_user requires a ' \
|
19
|
-
'User model with a column auth_token_digest'.freeze
|
20
|
-
|
21
|
-
def auth_token
|
22
|
-
header = Utils.rackify_header(settings.auth_token_header)
|
23
|
-
request.env[header]
|
24
|
-
end
|
25
|
-
|
26
|
-
def current_user
|
27
|
-
return @current_user if defined?(@current_user)
|
28
|
-
|
29
|
-
return unless check_user_model
|
30
|
-
digest = Shaf::CurrentUser.digest(auth_token) || return
|
31
|
-
@current_user = User.where(auth_token_digest: digest).first
|
32
|
-
end
|
33
|
-
|
34
|
-
def authenticated?
|
35
|
-
!current_user.nil?
|
36
|
-
end
|
37
|
-
|
38
|
-
def authenticate!
|
39
|
-
authenticated? || raise(Shaf::Errors::UnauthorizedError)
|
40
|
-
end
|
41
|
-
|
42
|
-
def check_user_model
|
43
|
-
return true if defined?(User) && User.columns.include?(:auth_token_digest)
|
44
|
-
log.warn ERR_MSG
|
45
|
-
false
|
46
|
-
end
|
47
|
-
end
|
48
|
-
end
|
@@ -1,64 +0,0 @@
|
|
1
|
-
require 'hal_presenter'
|
2
|
-
require 'shaf/errors'
|
3
|
-
|
4
|
-
module Shaf
|
5
|
-
module Responder
|
6
|
-
module HalSerializable
|
7
|
-
def lookup_rel(rel, response)
|
8
|
-
hal = response.serialized_hash
|
9
|
-
links = hal&.dig(:_links, rel.to_sym)
|
10
|
-
return [] unless links
|
11
|
-
|
12
|
-
links = [links] unless links.is_a? Array
|
13
|
-
links.map do |link|
|
14
|
-
{
|
15
|
-
href: link[:href],
|
16
|
-
as: 'fetch',
|
17
|
-
crossorigin: 'anonymous'
|
18
|
-
}
|
19
|
-
end
|
20
|
-
end
|
21
|
-
|
22
|
-
def collection?
|
23
|
-
!!options.fetch(:collection, false)
|
24
|
-
end
|
25
|
-
|
26
|
-
def serializer
|
27
|
-
@serializer ||= options[:serializer] || HALPresenter.lookup_presenter(resource)
|
28
|
-
end
|
29
|
-
|
30
|
-
def serialized_hash
|
31
|
-
return {} unless serializer
|
32
|
-
|
33
|
-
@serialized_hash ||=
|
34
|
-
if collection?
|
35
|
-
serializer.to_collection(resource, current_user: user, as_hash: true, **options)
|
36
|
-
else
|
37
|
-
serializer.to_hal(resource, current_user: user, as_hash: true, **options)
|
38
|
-
end
|
39
|
-
|
40
|
-
# hal_presenter versions before v1.5.0 does not understand the :as_hash
|
41
|
-
# keyword argument and will always return a String from
|
42
|
-
# to_hal/to_collection, thus we need to parse it if its a String.
|
43
|
-
if @serialized_hash.is_a? String
|
44
|
-
@body = @serialized_hash
|
45
|
-
@serialized_hash = JSON.parse(@serialized_hash, symbolize_names: true)
|
46
|
-
end
|
47
|
-
|
48
|
-
@serialized_hash
|
49
|
-
end
|
50
|
-
|
51
|
-
def profile
|
52
|
-
@profile ||= options[:profile]
|
53
|
-
return unless @profile || serializer
|
54
|
-
|
55
|
-
@profile ||= serializer.semantic_profile
|
56
|
-
end
|
57
|
-
|
58
|
-
def generate_json
|
59
|
-
# FIXME: change to Oj??
|
60
|
-
JSON.generate(serialized_hash)
|
61
|
-
end
|
62
|
-
end
|
63
|
-
end
|
64
|
-
end
|