tramway-api 1.3.1 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61be23f5286206cfab7b53a7d5d9b5675ac90323034b7382220f3f6e7dfb97cf
-  data.tar.gz: d144a30fa41a7d22394710c137f84c2eb1066ed7d0bc2123cd92bb30eb918084
+  metadata.gz: a1ce2e992ce1a5fd8274e579b0ba721e3a2d2e0a2c832e3d4e64e22118818aca
+  data.tar.gz: fe4439d634d44737883aca3e08d16537cffced5445a71b18462dba9356f3f827
 SHA512:
-  metadata.gz: 96071be124def6faf1c5820d620b5df917c78754b773a4c1bf6a127fe7b0518d88d3752d44bde2cdaa59c3478e8fedcd95a2eed12b02ceeca97535119f11aec9
-  data.tar.gz: b189159882e907f4a308134def79b8f2d370b4d74dec513639c5cad2c9e644a8983e817c539a37fa25a3b3c905b222d03140a4bbabb2b48d915def5a6ab30116
+  metadata.gz: 052bda57f4c9c1e2d63e576c4714dfb2d243efb645c7b1271b823525b0114323f593f88bfe8c967ec5b1fed77e9534d60395f379620a9a946a84851c2c2ce49b
+  data.tar.gz: 2ec5e631e6492390fb5b3f19d33873f50dbc1ab2c6804646082d48d89653b293aa12e12b60d0102439f765937101144cc3692316a24f59aae4f2299631af9101

data/README.md

@@ -89,7 +89,7 @@ Create file `config/initializers/tramway.rb`
 
 ```ruby
 ::Tramway::Api.auth_config = { user_model: User, auth_attributes: %i[email username] }
-::Tramway::Api.set_available_models user: %i[create update]
+::Tramway::Api.set_available_models user: { open: %i[create], closed: %i[update] }
 ```
 
 Run `rails g tramway:core:install`
@@ -271,7 +271,10 @@ this model must have field `password_digest`, because we use `bcrypt` gem for au
 
 Sets ActiveRecord models which will be used in API
 
-Argument is a hash. Keys are underscored models names, values are arrays of available methods for every model.
+Argument is a hash. Keys are underscored models names, values are hashes with actions of available methods for every model.
+* `open` key means that this action will be used without authentication
+* `closed` key means that this action will be used with authentication
+
 
 Enabled methods:
 

data/app/controllers/tramway/api/application_controller.rb

@@ -25,7 +25,7 @@ module Tramway
         if entity.respond_to? :to_token_payload
           ::Knock::AuthToken.new payload: entity.to_token_payload
         else
-          ::Knock::AuthToken.new payload: { sub: entity.id }
+          ::Knock::AuthToken.new payload: { sub: entity.uid }
         end
       end
 

data/app/controllers/tramway/api/v1/records_controller.rb

@@ -2,11 +2,13 @@ module Tramway::Api::V1
   class RecordsController < ::Tramway::Api::V1::ApplicationController
     before_action :check_available_model_class
     before_action :check_available_model_action
+    before_action :authenticate_user_if_needed
 
     def index
       records = model_class.active.order(id: :desc).send params[:scope] || :all
       render json: records,
         each_serializer: serializer_class,
+        include: '*',
         status: :ok
     end
 
@@ -15,6 +17,7 @@ module Tramway::Api::V1
       if record_form.submit params[:data][:attributes]
         render json: record_form.model,
           serializer: serializer_class,
+          include: '*',
           status: :created
       else
         render_errors_for record_form
@@ -26,6 +29,7 @@ module Tramway::Api::V1
       if record_form.submit params[:data][:attributes]
         render json: record_form.model,
           serializer: serializer_class,
+          include: '*',
           status: :ok
       else
         render_errors_for record_form
@@ -36,6 +40,7 @@ module Tramway::Api::V1
       record = model_class.active.find params[:id]
       render json: record,
         serializer: serializer_class,
+        include: '*',
         status: :ok
     end
 
@@ -44,6 +49,7 @@ module Tramway::Api::V1
       record.remove
       render json: record,
         serializer: serializer_class,
+        include: '*',
         status: :no_content
     end
 
@@ -54,7 +60,15 @@ module Tramway::Api::V1
     end
 
     def check_available_model_action
-      head :unprocessable_entity and return unless action_name.in? Tramway::Api.available_models[model_class.to_s].map(&:to_s)
+      open_actions = Tramway::Api.available_models[model_class.to_s][:open]&.map(&:to_s) || []
+      closed_actions =  Tramway::Api.available_models[model_class.to_s][:closed]&.map(&:to_s) || []
+      head :unprocessable_entity and return unless action_name.in? open_actions + closed_actions
+    end
+
+    def authenticate_user_if_needed
+      if action_name.in? Tramway::Api::available_models[model_class.to_s][:closed]&.map(&:to_s) || []
+        authenticate_user
+      end
     end
 
     def model_class

data/app/controllers/tramway/api/v1/users_controller.rb

@@ -8,7 +8,7 @@ class Tramway::Api::V1::UsersController < ::Tramway::Api::V1::ApplicationControl
     user_form = sign_up_form_class_name(Tramway::Api.user_based_model).new Tramway::Api.user_based_model.new
     # Implement JSON API spec here
     if user_form.submit params[Tramway::Api.user_based_model.name.underscore]
-      token = ::Knock::AuthToken.new(payload: { sub: user_form.model.id }).token
+      token = ::Knock::AuthToken.new(payload: { sub: user_form.model.uid }).token
       # FIXME refactor this bullshit
       serialized_user = OpenStruct.new(
         user_form.model.attributes.merge(

data/lib/tramway/api/version.rb

@@ -1,5 +1,5 @@
 module Tramway
   module Api
-    VERSION = '1.3.1'
+    VERSION = '1.4.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tramway-api
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.3
 platform: ruby
 authors:
 - Pavel Kalashnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-09 00:00:00.000000000 Z
+date: 2019-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: knock