tramway-api 1.5 → 1.6.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be852b8025894c89dbc01109337011ac3178b1fcc14cb8d7655bebfcbf8083ec
-  data.tar.gz: 8a13ec95aee745c0b262664658cf14807eb823ada87d845ae34e21a4b3c4720c
+  metadata.gz: 14b227fe2c5a72ce92a967c1a1abf17b0f3a3480cee4f4e9fc5a1a53c978aca4
+  data.tar.gz: ffe812022a1229e947c0db0edbda374c174d7632970099107f0d8f556a7ebcd1
 SHA512:
-  metadata.gz: 47512dbe567f7b258f2f1b411545503bf0c7a964b822030061e328dee94865c9d93a4c549183ef00386af44177b818fcd2339b3658f78bd81225246256188489
-  data.tar.gz: d45547b8ca370a7357a6123330f51a90451d48663408f682fabe81ff1081955b219cef6608c0eda484284c0f6863371f456c419905513b5632b394b40ea09390
+  metadata.gz: 14f9d4a3aff794718f346dc0ace3ec0a92f1abe05d2123164ae8d1dc0b9b5f9ad5f2c08dee24264e691bbc798d0af758bb48fcb8079423c1833795b105ca83a0
+  data.tar.gz: cbbd904561dee654dccf93f2279f7a1e6dcf6069e85f705cd4efdef58175c99138647a18e14d1878b7f726535089239683966b4fbb4e01d8c8822737e5f5b58c

data/README.md

@@ -43,6 +43,7 @@ coming soon...
   gem 'tramway-core'
   gem 'state_machine', github: 'seuros/state_machine'
   gem 'knock'
+  gem 'audited'
   ```
 
 ## Usage
@@ -82,6 +83,10 @@ t.uuid :uid, default: 'uuid_generate_v4()'
 ```ruby
 class User < Tramway::Core::ApplicationRecord
   has_secure_password
+  
+  def self.from_token_payload(payload)
+    find_by uid: payload['sub']
+  end
 end
 ```
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -14,7 +16,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
 load 'rails/tasks/engine.rake'
 
 load 'rails/tasks/statistics.rake'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tramway
   module Api
     class ApplicationController < ::Tramway::Core::ApplicationController
@@ -18,7 +20,7 @@ module Tramway
       protected
 
       def authenticate
-        return unauthorized unless current_user
+        return unauthorized if current_user.nil? || !params[:user_based_model].in?(Tramway::Api.user_based_models)
       end
 
       def auth_token
@@ -30,17 +32,19 @@ module Tramway
       end
 
       def entity
+        user_based_model = params[:user_based_model].constantize
         @entity ||=
-          if Tramway::Api.user_based_model.respond_to? :from_token_request
-            Tramway::Api.user_based_model.active.from_token_request request
+          if user_based_model.respond_to? :from_token_request
+            user_based_model.active.from_token_request request
           else
             params[:auth] && find_user_by_auth_attributes
           end
       end
 
       def find_user_by_auth_attributes
-        Tramway::Api.auth_attributes.each do |attribute|
-          object = Tramway::Api.user_based_model.active.where.not(attribute => nil).find_by(attribute => auth_params[:login])
+        user_based_model = params[:user_based_model].constantize
+        Tramway::Api.auth_attributes[user_based_model].each do |attribute|
+          object = user_based_model.active.where.not(attribute => nil).find_by(attribute => auth_params[:login])
           return object if object
         end
         nil
@@ -49,6 +53,12 @@ module Tramway
       def auth_params
         params[:auth]&.permit(:login, :password)
       end
+
+      def current_user
+        Tramway::Api.user_based_models.map do |user_based_model|
+          send("current_#{user_based_model.name.underscore}")
+        end.compact.first
+      end
     end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tramway
   module Api
     module V1

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tramway::Api::V1
   class RecordsController < ::Tramway::Api::V1::ApplicationController
     before_action :check_available_model_class
@@ -8,18 +10,18 @@ module Tramway::Api::V1
       records = model_class.active.order(id: :desc).send params[:scope] || :all
       records = records.full_text_search params[:search] if params[:search]
       render json: records,
-        each_serializer: serializer_class,
-        include: '*',
-        status: :ok
+             each_serializer: serializer_class,
+             include: '*',
+             status: :ok
     end
 
     def create
       record_form = form_class.new model_class.new
       if record_form.submit snake_case params[:data][:attributes]
         render json: record_form.model,
-          serializer: serializer_class,
-          include: '*',
-          status: :created
+               serializer: serializer_class,
+               include: '*',
+               status: :created
       else
         render_errors_for record_form
       end
@@ -29,9 +31,9 @@ module Tramway::Api::V1
       record_form = form_class.new model_class.active.find params[:id]
       if record_form.submit snake_case params[:data][:attributes]
         render json: record_form.model,
-          serializer: serializer_class,
-          include: '*',
-          status: :ok
+               serializer: serializer_class,
+               include: '*',
+               status: :ok
       else
         render_errors_for record_form
       end
@@ -40,36 +42,34 @@ module Tramway::Api::V1
     def show
       record = model_class.active.find params[:id]
       render json: record,
-        serializer: serializer_class,
-        include: '*',
-        status: :ok
+             serializer: serializer_class,
+             include: '*',
+             status: :ok
     end
 
     def destroy
       record = model_class.active.find params[:id]
       record.remove
       render json: record,
-        serializer: serializer_class,
-        include: '*',
-        status: :no_content
+             serializer: serializer_class,
+             include: '*',
+             status: :no_content
     end
 
     private
 
     def check_available_model_class
-      head :unprocessable_entity and return unless model_class
+      head(:unprocessable_entity) && return unless model_class
     end
 
     def check_available_model_action
       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
+      closed_actions = Tramway::Api.available_models[model_class.to_s][:closed]&.map(&:to_s) || []
+      head(:unprocessable_entity) && 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
+      head :unauthorized and return if action_name.in?(Tramway::Api.available_models[model_class.to_s][:closed]&.map(&:to_s) || []) && !current_user
     end
 
     def model_class

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Tramway::Api::V1::UserTokensController < ::Tramway::Api::V1::ApplicationController
   def create
     if entity.present? && entity.authenticate(auth_params[:password])
@@ -7,7 +8,8 @@ class Tramway::Api::V1::UserTokensController < ::Tramway::Api::V1::ApplicationCo
         auth_token: token,
         user: {
           email: @entity.email,
-          uid: @entity.uid
+          uid: @entity.uid,
+          id: @entity.id
         }
       }, status: :created
     else

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'tramway/helpers/class_name_helpers'
 
 class Tramway::Api::V1::UsersController < ::Tramway::Api::V1::ApplicationController
@@ -5,11 +7,11 @@ class Tramway::Api::V1::UsersController < ::Tramway::Api::V1::ApplicationControl
   include Tramway::ClassNameHelpers
 
   def create
-    user_form = sign_up_form_class_name(Tramway::Api.user_based_model).new Tramway::Api.user_based_model.new
+    user_form = sign_up_form_class_name(user_based_model).new user_based_model.new
     # Implement JSON API spec here
-    if user_form.submit params[Tramway::Api.user_based_model.name.underscore]
+    if user_form.submit snake_case params[user_based_model.name.underscore]
       token = ::Knock::AuthToken.new(payload: { sub: user_form.model.uid }).token
-      # FIXME refactor this bullshit
+      # FIXME: refactor this bullshit
       serialized_user = OpenStruct.new(
         user_form.model.attributes.merge(
           authentication_token: token,
@@ -31,4 +33,8 @@ class Tramway::Api::V1::UsersController < ::Tramway::Api::V1::ApplicationControl
   def sign_up_form_class_name(model_class)
     form_class_name "#{model_class}SignUp"
   end
+
+  def user_based_model
+    params[:user_based_model].constantize if params[:user_based_model].in? Tramway::Api.user_based_models.map(&:to_s)
+  end
 end

data/app/forms/tramway/api/authentication_form.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Tramway::Api::AuthenticationForm < Tramway::Core::ApplicationForm
   properties :email, :password
 end

data/app/helpers/tramway/api/application_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tramway
   module Api
     module ApplicationHelper

data/app/jobs/tramway/api/application_job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tramway
   module Api
     class ApplicationJob < ActiveJob::Base

data/app/mailers/tramway/api/application_mailer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tramway
   module Api
     class ApplicationMailer < ActionMailer::Base

data/app/models/tramway/api/application_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tramway
   module Api
     class ApplicationRecord < ActiveRecord::Base

data/app/serializers/tramway/api/v1/error_serializer.rb

@@ -26,21 +26,19 @@ class Tramway::Api::V1::ErrorSerializer < ActiveModel::Serializer
       end
     end
 
-    if object.model
-      object.model.attributes.each do |attribute_key, attribute_value|
-        if attribute_value.is_a?(Reform::Form)
-          error_messages.merge!(error_messages(attribute_value, path + [attribute_key]))
-        elsif attribute_value.is_a?(Array)
-          attribute_value.each_with_index do |array_attribute_value, array_attribute_key|
-            next unless array_attribute_value.is_a?(Reform::Form)
-
-            error_messages.merge!(
-              error_messages(
-                array_attribute_value,
-                path + [attribute_key] + [array_attribute_key]
-              )
+    object.model&.attributes&.each do |attribute_key, attribute_value|
+      if attribute_value.is_a?(Reform::Form)
+        error_messages.merge!(error_messages(attribute_value, path + [attribute_key]))
+      elsif attribute_value.is_a?(Array)
+        attribute_value.each_with_index do |array_attribute_value, array_attribute_key|
+          next unless array_attribute_value.is_a?(Reform::Form)
+
+          error_messages.merge!(
+            error_messages(
+              array_attribute_value,
+              path + [attribute_key] + [array_attribute_key]
             )
-          end
+          )
         end
       end
     end

data/config/initializers/json_param_key_transform.rb

@@ -1,4 +1,6 @@
-ActionDispatch::Request.parameter_parsers[:json] = -> (raw_post) {
+# frozen_string_literal: true
+
+ActionDispatch::Request.parameter_parsers[:json] = lambda { |raw_post|
   data = ActiveSupport::JSON.decode(raw_post)
   data = { _json: data } unless data.is_a?(Hash)
 

data/config/routes.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 Tramway::Api::Engine.routes.draw do
   namespace :v1 do
-    resource :user_token, only: [ :create ]
-    resource :user, only: [ :create, :show ]
+    resource :user_token, only: [:create]
+    resource :user, only: %i[create show]
     resources :records
   end
 end

data/lib/tasks/tramway/api_tasks.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # desc "Explaining what the task does"
 # task :tramway_api do
 #   # Task goes here

data/lib/tramway/api.rb

@@ -1,22 +1,32 @@
+# frozen_string_literal: true
+
 require 'tramway/api/engine'
 
 module Tramway
   module Api
     class << self
       def auth_config
-        @@auth_config ||= { user_model: ::Tramway::User::User, auth_attributes: :email }
+        @@auth_config ||= [{ user_model: ::Tramway::User::User, auth_attributes: :email }]
       end
 
-      def auth_config=(**params)
-        @@auth_config = params
+      def auth_config=(params)
+        if params.is_a? Hash
+          @@auth_config = [params]
+        elsif params.is_a? Array
+          @@auth_config = params
+        end
       end
 
-      def user_based_model
-        @@auth_config[:user_model]
+      def user_based_models
+        @@auth_config.map do |conf|
+          conf[:user_model]
+        end
       end
 
       def auth_attributes
-        @@auth_config[:auth_attributes]
+        @@auth_config.reduce({}) do |hash, conf|
+          hash.merge! conf[:user_model] => conf[:auth_attributes]
+        end
       end
 
       def set_available_models(**models)

data/lib/tramway/api/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tramway
   module Api
     class Engine < ::Rails::Engine

data/lib/tramway/api/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Tramway
   module Api
-    VERSION = '1.5'
+    VERSION = '1.6.0.2'
   end
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: tramway-api
 version: !ruby/object:Gem::Version
-  version: '1.5'
+  version: 1.6.0.2
 platform: ruby
 authors:
 - Pavel Kalashnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-22 00:00:00.000000000 Z
+date: 2019-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: knock
+  name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.5
 - !ruby/object:Gem::Dependency
-  name: tramway-core
+  name: knock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.2
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.2
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: active_model_serializers
+  name: tramway-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.5
+        version: 1.9.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.5
+        version: 1.9.2
 description: Engine for api
 email:
 - kalashnikovisme@gmail.com