tramway-api 1.8.1.1 → 1.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d1e2133a961aaba201c222f211ca45a609f559b89d44622c345e802f29f67a6
-  data.tar.gz: f8856dba0c3e478af5436cdf93df7a77cfb4b876fed6ce1c3a41c9f7da710674
+  metadata.gz: 151b3c808fba04666fdb2cccbd5368d45c86c6539878c52e1c9fa93905a3eb85
+  data.tar.gz: 8eeaf9cde77e40c5f170c3c1d242c88025003d10176947e943ae59dd10520b25
 SHA512:
-  metadata.gz: 8143cc790cebc76de7dcd2746204bc8503a4a74ed9b4eefb3068e65cc456b6920a775d0cc107acd01c9dd651cd4c87a6394cf6cf807ca37626a13bd2b60adc08
-  data.tar.gz: 45b9ec7765178d2d26869ec69bfc315b4c714fd5632aa1d86e537ea793617aac85a59dd3f08ea11f3139d5b008ebf49772888557c13859bd7a0975d68a8cd21e
+  metadata.gz: 989b0c66ec542b84a55f803f676b0778b78ccd012ced6579ae858c0aaa31f0d345f9ff4ea737a64e393735a37ffa6285fe153ceb862b0b1dc692a4f1f2999ee3
+  data.tar.gz: ac301bb8e6fc9a7dc5e8ae7a2100703977cc7d9d58a4f2c384bdb02130ed30b02b214b1c682874b4b32fdce38f33017faadfa89352b8cb4081fad439305c3d23

data/README.md

@@ -44,6 +44,7 @@ coming soon...
   gem 'state_machine', github: 'seuros/state_machine'
   gem 'knock'
   gem 'audited'
+  gem 'ransack'
   ```
 
 ## Usage
@@ -64,10 +65,24 @@ gem 'knock'
 
 Run `bundle install`
 
+### Initialize @application object
+
+[How-to](https://github.com/Purple-Magic/tramway-core/blob/develop/README.md#every-tramway-application-need-initialized-application-object-or-if-you-create-tramway-plugin-it-should-be-application_engine-object)
+
+*config/routes.rb*
+
+```ruby
+Rails.application.routes.draw do
+  # ...
+  mount Tramway::Api::Engine, at: '/api'
+  # ...
+end
+```
+
 Then generate User (you use another name, it's just an example) model
 
 ```
-rails g model user email:text password_digest:text username:text state:text uid:text
+rails g model user email:text password_digest:text username:text state:text uuid:uuid
 ```
 
 Enable extension in your database:
@@ -100,11 +115,26 @@ class User < Tramway::Core::ApplicationRecord
 end
 ```
 
-Create file `config/initializers/tramway.rb`
+#### Create file `config/initializers/tramway.rb`
+#### If you need JWT authentication add this line to the `config/initializers/tramway.rb`
 
 ```ruby
 ::Tramway::Api.auth_config = { user_model: User, auth_attributes: %i[email username] }
-::Tramway::Api.set_available_models user: { open: %i[create], closed: %i[update] }
+```
+
+#### Configurate available models. Tramway will create end points according to this config
+
+```
+::Tramway::Api.set_available_models({
+  User => [
+    {
+      show: lambda do |record, current_user|
+        record.id == current_user.id         # shows only current_user profile
+      end
+    }
+  ],
+  project: :your_project_name
+})
 ```
 
 Run `rails g tramway:core:install`
@@ -316,7 +346,7 @@ Create serializer
 *app/serializers/user_serializer.rb*
 
 ```ruby
-class UserSerializer < Tramway::Core::ApplicationSerializer
+class UserSerializer < Tramway::Api::V1::ApplicationSerializer
   attributes :username, :email
 end
 ```
@@ -353,9 +383,39 @@ Docs coming soon
 
 ### Show
 
-Production ready
+#### Description
 
-Docs coming soon
+It returns just one record, if it is not deleted.
+
+#### Using
+
+##### Allow method show in tramway initializer for `YourModel` 
+
+*config/initializers/tramway.rb*
+
+```ruby
+::Tramway::Api.set_available_models({ YourModel => [ :show ] }, project: :your_project_name })
+```
+
+##### Create serializer
+
+*app/serializers/user_serializer.rb*
+
+```ruby
+class UserSerializer < Tramway::Core::ApplicationSerializer
+  attributes :username, :email
+end
+```
+
+##### Run your server on the localhost `rails s`
+##### Made this query to test new API method (for example: you can create file `bin/test_tramway.rb` with this lines):
+
+```ruby
+require 'net/http'
+
+YourModel.create! attribute_1: 'some value', attribute_2: 'some_value'
+Net::HTTP.get('localhost:3000', "/api/v1/records/#{YourModel.last.id}?model=YourModel")
+```
 
 ### Destroy
 

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

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

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

@@ -15,10 +15,110 @@ module Tramway
         def snake_case(params)
           hash = {}
           params.each do |attribute, value|
-            hash.merge! attribute.to_s.gsub('-', '_') => value
+            key = UUID.validate(attribute) ? attribute : attribute.to_s.gsub('-', '_')
+            hash.merge! key => value
           end
           hash
         end
+
+        private
+
+        def record
+          id_method = Tramway::Api.id_method_of(model: model_class) || :uuid
+          @record = model_class.find_by! id_method => params[:id] if params[:id].present?
+        end
+
+        def records
+          collection = model_class.active.order(id: :desc).send params[:scope] || :all
+          collection = collection.full_text_search params[:search] if params[:search]
+          collection
+        end
+
+        def check_available_model_class
+          unless model_class
+            head(:unauthorized) && return unless current_user
+            head(:unprocessable_entity) && return
+          end
+        end
+
+        def check_available_model_action_for_record
+          action_is_available = check_action
+          action_is_available.tap do
+            if action_is_available.is_a?(Proc) && !action_is_available.call(record, current_user)
+              head(:unprocessable_entity) && return
+            end
+          end
+        end
+
+        def available_action_for_collection
+          action_is_available = check_action
+          return records if action_is_available == true
+
+          action_is_available.call records, current_user if action_is_available.is_a?(Proc)
+        end
+
+        def check_action
+          action_is_available = checking_roles.map do |role|
+            Tramway::Api.action_is_available(
+              action: action_name.to_sym,
+              project: (@application_engine || @application.name),
+              role: role,
+              model_name: params[:model],
+              current_user: current_user
+            )
+          end.compact.uniq - [false]
+
+          if action_is_available.count > 1
+            Tramway::Error.raise_error(:tramway, :api, :api, :v1, :records_controller, :available_action_for_collection, :duplicate_actions)
+          end
+
+          action_is_available = action_is_available.first
+
+          action_is_available.tap do
+            head(:unprocessable_entity) && return unless action_is_available
+          end
+        end
+
+        def authenticate_user_if_needed
+          action_is_open = Tramway::Api.action_is_available(
+            action: action_name.to_sym,
+            project: (@application_engine || @application.name),
+            model_name: params[:model]
+          )
+          head(:unauthorized) && return if !current_user && !action_is_open
+        end
+
+        def available_models_for_current_user
+          checking_roles.reduce([]) do |models, role|
+            models += ::Tramway::Api.available_models(role: role).map(&:to_s)
+          end
+        end
+
+        def checking_roles
+          [:open, current_user&.role].compact
+        end
+
+        protected
+
+        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
+        end
+
+        def decorator_class(model_name = nil)
+          "#{model_name || model_class}Decorator".constantize
+        end
+
+        def form_class(model_name = nil)
+          "#{model_name || model_class}Form".constantize
+        end
+
+        def serializer_class(model_name = nil)
+          "#{model_name || model_class}Serializer".constantize
+        end
       end
     end
   end

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

@@ -3,7 +3,7 @@
 module Tramway::Api::V1
   class RecordsController < ::Tramway::Api::V1::ApplicationController
     before_action :check_available_model_class
-    before_action :check_available_model_action_for_record, only: [ :show, :update, :destroy ]
+    before_action :check_available_model_action_for_record, only: %i[show update destroy]
     before_action :authenticate_user_if_needed
 
     def index
@@ -54,102 +54,5 @@ module Tramway::Api::V1
              include: '*',
              status: :no_content
     end
-
-    private
-    
-    def record
-      if params[:id].present?
-        @record = model_class.find_by! uuid: params[:id]
-      end
-    end
-
-    def records
-      collection = model_class.active.order(id: :desc).send params[:scope] || :all
-      collection = collection.full_text_search params[:search] if params[:search]
-      collection
-    end
-
-    def check_available_model_class
-      unless model_class
-        head(:unauthorized) && return unless current_user
-        head(:unprocessable_entity) && return
-      end
-    end
-
-    def check_available_model_action_for_record
-      action_is_available = check_action
-      action_is_available.tap do
-        head(:unprocessable_entity) && return if action_is_available.is_a?(Proc) && !action_is_available.call(record, current_user)
-      end
-    end
-
-    def available_action_for_collection
-      action_is_available = check_action
-      return records if action_is_available == true
-      action_is_available.call records, current_user if action_is_available.is_a?(Proc)
-    end
-
-    def check_action
-      action_is_available = checking_roles.map do |role|
-        Tramway::Api.action_is_available(
-          action: action_name.to_sym,
-          project: (@application_engine || @application.name),
-          role: role,
-          model_name: params[:model],
-          current_user: current_user
-        )
-      end.compact.uniq - [false]
-
-      if action_is_available.count > 1
-        Tramway::Error.raise_error(:tramway, :api, :api, :v1, :records_controller, :available_action_for_collection, :duplicate_actions)
-      end
-
-      action_is_available = action_is_available.first
-
-      action_is_available.tap do
-        head(:unprocessable_entity) && return unless action_is_available
-      end
-    end
-
-    def authenticate_user_if_needed
-      action_is_open = Tramway::Api.action_is_available(
-        action: action_name.to_sym,
-        project: (@application_engine || @application.name),
-        model_name: params[:model]
-      )
-      head(:unauthorized) && return if !current_user && !action_is_open
-    end
-
-    def model_class
-      if params[:model].to_s.in? available_models_for_current_user
-        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
-      end
-    end
-
-    def available_models_for_current_user
-      checking_roles.reduce([]) do |models, role|
-        models += ::Tramway::Api.available_models(role: role).map(&:to_s) 
-      end
-    end
-
-    def checking_roles
-      [ :open, current_user&.role ].compact
-    end
-
-    def decorator_class(model_name = nil)
-      "#{model_name || model_class}Decorator".constantize
-    end
-
-    def form_class(model_name = nil)
-      "#{model_name || model_class}Form".constantize
-    end
-
-    def serializer_class(model_name = nil)
-      "#{model_name || model_class}Serializer".constantize
-    end
   end
 end

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

@@ -6,7 +6,8 @@ class Tramway::Api::V1::ApplicationSerializer < ActiveModel::Serializer
   attribute :id
 
   def id
-    object.uuid
+    id_method = Tramway::Api.id_method_of(model: object.class) || :uuid
+    object.send(id_method)
   end
 
   def created_at

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

@@ -27,12 +27,8 @@ class Tramway::Api::V1::ErrorSerializer < ActiveModel::Serializer
     end
 
     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)
+      if 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,

data/lib/tramway/api.rb

@@ -56,7 +56,10 @@ module Tramway
 
       def action_is_available(project:, role: :open, model_name:, action:, current_user: nil)
         actions = select_actions(project: project, role: role, model_name: model_name)
-        raise "Looks like you did not used array type to define action permissions. Remember it should be this way: `#{model_name} => [ :#{action} ]` or `#{model_name} => [ { #{action}: lambda { |record, current_user| your_condition } } ]`" if actions.present? && !actions.is_a?(Array)
+        if actions.present? && !actions.is_a?(Array)
+          raise "Looks like you did not used array type to define action permissions. Remember it should be this way: `#{model_name} => [ :#{action} ]` or `#{model_name} => [ { #{action}: lambda { |record, current_user| your_condition } } ]`"
+        end
+
         availability = actions&.select do |a|
           if a.is_a? Symbol
             a == action.to_sym
@@ -80,6 +83,17 @@ module Tramway
           new_hash.merge! pair[0].to_s => pair[1]
         end
       end
+
+      def id_methods_of(options = {})
+        @@id_methods ||= {}
+        @@id_methods.merge!(options.reduce({}) do |hash, pair|
+          hash.merge! pair[0].to_s => pair[1]
+        end)
+      end
+
+      def id_method_of(model:)
+        @@id_methods[model.to_s]
+      end
     end
   end
 end

data/lib/tramway/api/version.rb

@@ -2,6 +2,6 @@
 
 module Tramway
   module Api
-    VERSION = '1.8.1.1'
+    VERSION = '1.8.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tramway-api
 version: !ruby/object:Gem::Version
-  version: 1.8.1.1
+  version: 1.8.3
 platform: ruby
 authors:
 - Pavel Kalashnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-26 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers