tramway-api 1.8.6.3 → 1.8.6.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7f1b8dfe3e44248a5689bd7a38f15457cfdb51a5e86c57ced95eff20b177310
-  data.tar.gz: 6fd69e46c891249e0f9177b596b17242f209c4d2fc38eab9419dd208b64b1de2
+  metadata.gz: 7afaf17fee7b310b01015af00a05f9d8105bab57ee5c8f2582513088bf07a134
+  data.tar.gz: 10ccdf3863f5cd527bc5e007e39d2b5512cda862b668d64202583a58a1a01ac4
 SHA512:
-  metadata.gz: 0addb5574a3f3dd5308d94c2a7e023c41d864bf909119e34d258b0339245f94155105ea9605b406e32f9edb85ce2c9e15d0e30f7dfca2f6a401378a4314c020d
-  data.tar.gz: 23d22cdb67d958d36c39a80c1794b202eae925931553f4910637074024bb601429d516d0f498911be45d605454cf5879039ef72ddfbf8432ba57e5cdf6aa1a77
+  metadata.gz: 60433f37641ba07db8bbd32a55c318a0578df5fe92f5fb77b458a043c4e26b384772dcc744ed11d537a9cb72e8cb9f4f1b13e5cf85246f82f2a9ae33ebcfe311
+  data.tar.gz: 2ee8ae129c4165fe3ef452a63aea87b00b6115e30f9091adf34ac2f9552b2fbefbb78a68f00cbab2d54a0dc04587938a08f30364950b55d94c9468b329f00764

data/README.md

@@ -41,7 +41,6 @@ coming soon...
   ```ruby
   gem 'active_model_serializers', '0.10.5'
   gem 'tramway-core'
-  gem 'state_machine', github: 'seuros/state_machine'
   gem 'knock'
   gem 'audited'
   gem 'ransack'
@@ -105,10 +104,18 @@ To choose your own public ID method, just add this line to:
 *config/initializers/tramway.rb*
 
 ```ruby
-Tramway::Api.id_methods_of(User => :id)
+Tramway::Api.id_methods_of(User => { default: :id })
 ```
 If you want to use `uuid` by default, please, add it to your models
 
+### Also, you can add array of secondary methods as IDs, but you'll need to add their names to a request
+
+```ruby
+Tramway::Api.id_methods_of(User => { default: id, other: :email }
+```
+
+in this case your request will look like this `/api/v1/records/someEmail@mail.com?model=User&key=email`
+
 #### Add generating uuid by default to every model, that is accessible by API
 
 *db/migrate/add_uuid_to_some_model.rb*
@@ -138,7 +145,7 @@ end
 
 #### Configurate available models. Tramway will create end points according to this config
 
-```
+```ruby
 ::Tramway::Api.set_available_models({
   User => [
     {
@@ -286,7 +293,6 @@ RSpec.describe 'Post generate token', type: :feature do
 
   end
 end
-
 ```
 
 Run `rspec` to test
@@ -332,11 +338,6 @@ 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 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:
 
 * create
@@ -352,7 +353,7 @@ Every model you've added in initializer will be able by URL `api/v1/records?mode
 Just update your initializer:
 
 ```ruby
-::Tramway::Api.set_available_models user: { open: %i[create], closed: %i[update index] } # we've added index method
+::Tramway::Api.set_available_models({ User => { %i[index] })
 ```
 
 Create serializer
@@ -383,6 +384,8 @@ end
 
 You have your records in JSON API spec.
 
+You also able to use pagination, provided by `kaminari`
+
 ### Create
 
 *config/initializers/tramway.rb*
@@ -426,6 +429,46 @@ Params Structure
 }
 ```
 
+Also, you can test it with this 
+
+*spec/factories/your_models.rb*
+
+```ruby
+FactoryBot.define do
+  factory :your_model do
+    attribute1 { # some code which generate value for this attribute }
+    attribute2 { # some code which generate value for this attribute }
+    name { generate :name }
+  end
+end
+```
+
+*spec/api/your_model_spec.rb*
+
+```ruby
+require 'rails_helper'
+
+RSpec.describe 'Post generate token', type: :feature do
+  describe 'POST /api/v1/user_token' do
+    let(:user) { create :user, password: '123456789' }
+
+    it 'returns created status' do
+      post '/api/v1/user_token', params: { auth: { login: user.email, password: '123456789' }  }
+
+      expect(response.status).to eq 201
+    end
+    
+    it 'returns token' do
+      post '/api/v1/user_token', params: { auth: { login: user.email, password: '123456789' }  }
+
+      expect(json_response[:auth_token].present?).to be_truthy
+      expect(json_response[:user]).to include_json({ email: user.email, uuid: user.uuid })
+    end
+
+  end
+end
+```
+
 ### Update
 
 *config/initializers/tramway.rb*

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

@@ -58,9 +58,7 @@ module Tramway
 
       def current_user
         Tramway::Api.user_based_models.map do |user_based_model|
-          unless user_based_model == User
-            send("current_#{user_based_model.name.underscore}")
-          end
+          send("current_#{user_based_model.name.underscore}") unless user_based_model == User
         end.compact.first
       end
     end

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

@@ -4,6 +4,8 @@ module Tramway
   module Api
     module V1
       class ApplicationController < ::Tramway::Api::ApplicationController
+        before_action :application
+
         def render_errors_for(model)
           render json: model, status: :unprocessable_entity, serializer: ::Tramway::Api::V1::ErrorSerializer
         end
@@ -25,7 +27,7 @@ module Tramway
 
         def record
           if params[:key].present?
-            if Tramway::Api.other_id_methods_of(model: model_class).include? params[:key]
+            if Tramway::Api.other_id_methods_of(model: model_class).include? params[:key].to_sym
               @record = model_class.find_by! params[:key] => params[:id] if params[:id].present?
             end
           else
@@ -45,6 +47,7 @@ module Tramway
         def check_available_model_class
           unless model_class
             head(:unauthorized) && return unless current_user
+
             head(:unprocessable_entity) && return
           end
         end
@@ -69,7 +72,7 @@ module Tramway
           action_is_available = checking_roles.map do |role|
             Tramway::Api.action_is_available(
               action: action_name.to_sym,
-              project: (@application_engine || @application.name),
+              project: (@application_engine || application_name),
               role: role,
               model_name: params[:model],
               current_user: current_user
@@ -90,7 +93,7 @@ module Tramway
         def authenticate_user_if_needed
           action_is_open = Tramway::Api.action_is_available(
             action: action_name.to_sym,
-            project: (@application_engine || @application.name),
+            project: (@application_engine || application_name),
             model_name: params[:model]
           )
           head(:unauthorized) && return if !current_user && !action_is_open
@@ -108,12 +111,14 @@ module Tramway
 
         protected
 
+        def application_name
+          @application.present? ? @application.name : raise('Tramway::Api @application not initialized')
+        end
+
         def model_class
-          begin
-            params[:model].constantize
-          rescue ActiveSupport::Concern::MultipleIncludedBlocks => e
-            raise "#{e}. Maybe #{params[:model]} model doesn't exists or there is naming conflicts with it"
-          end
+          params[:model].constantize
+        rescue ActiveSupport::Concern::MultipleIncludedBlocks => e
+          raise "#{e}. Maybe #{params[:model]} model doesn't exists or there is naming conflicts with it"
         end
 
         def decorator_class(model_name = nil)

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

@@ -5,6 +5,7 @@ module Tramway::Api::V1
     before_action :check_available_model_class
     before_action :check_available_model_action_for_record, only: %i[show update destroy]
     before_action :authenticate_user_if_needed
+    before_action :application
 
     def index
       collection = available_action_for_collection
@@ -54,5 +55,11 @@ module Tramway::Api::V1
              include: '*',
              status: :no_content
     end
+
+    def application
+      if ::Tramway::Core.application
+        @application = Tramway::Core.application&.model_class&.first || Tramway::Core.application
+      end
+    end
   end
 end

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

@@ -16,25 +16,29 @@ class Tramway::Api::V1::ErrorSerializer < ActiveModel::Serializer
   def error_messages(object, path = []) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     error_messages = {}
 
-    object.errors.messages.each do |name, messages|
-      error_messages.merge!((path + [name]).join('/') => messages)
-    end
-
-    if object.model
-      object.model.errors.messages.each do |name, messages|
+    if object.respond_to? :errors
+      object.errors.messages.each do |name, messages|
         error_messages.merge!((path + [name]).join('/') => messages)
       end
     end
 
-    object.model&.attributes&.each do |attribute_key, attribute_value|
-      if attribute_value.is_a?(Array)
-        attribute_value.each_with_index do |array_attribute_value, array_attribute_key|
-          error_messages.merge!(
-            error_messages(
-              array_attribute_value,
-              path + [attribute_key] + [array_attribute_key]
+    if object.respond_to? :model
+      if object.model
+        object.model.errors.messages.each do |name, messages|
+          error_messages.merge!((path + [name]).join('/') => messages)
+        end
+      end
+
+      object.model&.attributes&.each do |attribute_key, attribute_value|
+        if attribute_value.is_a?(Array)
+          attribute_value.each_with_index do |array_attribute_value, array_attribute_key|
+            error_messages.merge!(
+              error_messages(
+                array_attribute_value,
+                path + [attribute_key] + [array_attribute_key]
+              )
             )
-          )
+          end
         end
       end
     end

data/lib/tramway/api.rb

@@ -96,7 +96,8 @@ module Tramway
       end
 
       def default_id_method_of(model:)
-        @@id_methods[model.to_s][:default]
+        @@id_methods ||= {}
+        @@id_methods.dig(model.to_s, :default)
       end
     end
   end

data/lib/tramway/api/version.rb

@@ -2,6 +2,6 @@
 
 module Tramway
   module Api
-    VERSION = '1.8.6.3'
+    VERSION = '1.8.6.8'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tramway-api
 version: !ruby/object:Gem::Version
-  version: 1.8.6.3
+  version: 1.8.6.8
 platform: ruby
 authors:
 - Pavel Kalashnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-26 00:00:00.000000000 Z
+date: 2021-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.9.2
+- !ruby/object:Gem::Dependency
+  name: uuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Engine for api
 email:
 - kalashnikovisme@gmail.com
@@ -102,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Engine for api