tramway-api 1.8.2.2 → 1.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf2d5329ba186ae429c9be23d63ff3afcbff06f8d02d54b4671639c3bdf82265
-  data.tar.gz: a72979a2d919cc22b2e60fe6bed54e2a44eee5f3e37fe6e19d55be93f47cc669
+  metadata.gz: 5a4acbd7817b429de6d718ee675810614a832cad7a9138c0f594cf603a5acc8c
+  data.tar.gz: fff87179a2ad5f22c4183b32af51fe38f0119426ffb4746316d6a72a30e42f19
 SHA512:
-  metadata.gz: 6f3f0e9de37be1606e31fb77de127f1f3321b6ecfb0fb3c0c406b22e1566fe7433c17218799886f0ac630fbdf51bb242c05cc3a8cfd2ba12be018b3c95184b26
-  data.tar.gz: b11dbcf1a53909ccc125976c9ae348783f41c6ba795b4d687314e40676cdcb23d97d7b2b77c58f8bbffe17dd2e20340d566ce20e9cd2f3c0542b8e2df17f549a
+  metadata.gz: 4f5e4e5362f56106305c71b38b21202b19f7b204434fd8f3df2a7722d7634606caf759513ae13fa975559eed995b4189df9c8c06289a97c502a7e8ef06f7744f
+  data.tar.gz: 51cb8206094060d4815eb4abb23b211ec0632f364f7718f8be3e2c3a346c1f3a0c7bba0b6da566b60584dfc9e09cd59b11a20d5ca4e5556010c96e4506b9a2dc

data/README.md

@@ -44,6 +44,7 @@ coming soon...
   gem 'state_machine', github: 'seuros/state_machine'
   gem 'knock'
   gem 'audited'
+  gem 'ransack'
   ```
 
 ## Usage
@@ -64,23 +65,51 @@ 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:
 
 *db/migrate/enable_extension.rb*
-```
-def change
-  enable_extension 'uuid-ossp'
+```ruby
+class EnableExtensionUUIDOSSP < ActiveRecord::Migration
+  def change
+    enable_extension 'uuid-ossp'
+  end
 end
 ```
 
+### You can choose a method, which will be using as public ID method
+
+By default, it's a `uuid` method
+
+To choose your own public ID method, just add this line to:
 
-Add generating uuid by default to every model, that is accessible by API
+*config/initializers/tramway.rb*
+
+```ruby
+Tramway::Api.id_methods_of(User => :id)
+```
+If you want to use `uuid` by default, please, add it to your models
+
+#### Add generating uuid by default to every model, that is accessible by API
 
 *db/migrate/add_uuid_to_some_model.rb*
 
@@ -100,11 +129,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 +360,7 @@ Create serializer
 *app/serializers/user_serializer.rb*
 
 ```ruby
-class UserSerializer < Tramway::Core::ApplicationSerializer
+class UserSerializer < Tramway::Api::V1::ApplicationSerializer
   attributes :username, :email
 end
 ```
@@ -341,21 +385,125 @@ You have your records in JSON API spec.
 
 ### Create
 
-Production ready
+*config/initializers/tramway.rb*
 
-Docs coming soon
+```ruby
+::Tramway::Api.set_available_models({ YourModel => [ :create ] }, project: :your_project_name })
+```
+
+*app/forms/your_model_form.rb*
+
+```ruby
+class YourModelForm < Tramway::Core::ApplicationForm
+  properties :attribute1, :attribute2, :name
+  
+  association :another_association_model
+  
+  def name=(value)
+    model.first_name = value.split(' ')[0]
+    model.first_name = value.split(' ')[1]
+  end
+end
+```
+
+Now you can your request. It has such structure
+
+**POST** `/api/v1/records?model=YourModel`
+
+```
+Params Structure
+{
+  data: {
+    attributes: {
+      attribute1: 'some value',
+      attribute2: 'some value',
+      name: 'some full name',
+      another_association_model: {
+        # here a list of attributes, which you described in AnotherAssociationModelForm
+      }
+    }
+  }
+}
+```
 
 ### Update
 
-Production ready
+*config/initializers/tramway.rb*
 
-Docs coming soon
+```ruby
+::Tramway::Api.set_available_models({ YourModel => [ :update ] }, project: :your_project_name })
+```
+
+*app/forms/your_model_form.rb*
+
+```ruby
+class YourModelForm < Tramway::Core::ApplicationForm
+  properties :attribute1, :attribute2, :name
+  
+  association :another_association_model
+  
+  def name=(value)
+    model.first_name = value.split(' ')[0]
+    model.first_name = value.split(' ')[1]
+  end
+end
+```
+
+Now you can your request. It has such structure
+
+**PATCH** `/api/v1/records/#{object_id}?model=YourModel`
+
+```
+Params Structure
+{
+  data: {
+    attributes: {
+      attribute1: 'some value',
+      attribute2: 'some value',
+      name: 'some full name',
+      another_association_model: {
+        # here a list of attributes, which you described in AnotherAssociationModelForm
+      }
+    }
+  }
+}
+```
 
 ### 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,7 +15,7 @@ module Tramway
         def snake_case(params)
           hash = {}
           params.each do |attribute, value|
-            key = UUID.validate attribute ? attribute : attribute.to_s.gsub('-', '_')
+            key = ::UUID.validate(attribute) ? attribute : attribute.to_s.gsub('-', '_')
             hash.merge! key => value
           end
           hash
@@ -24,12 +24,15 @@ module Tramway
         private
 
         def record
-          @record = model_class.find_by! uuid: params[:id] if params[:id].present?
+          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]
+          active_records = model_class.respond_to?(:active) ? model_class.active : model_class.all
+          collection = active_records.order(id: :desc).send params[:scope] || :all
+          collection = collection.page(params[:page]).per(params[:per]) if params[:page].present?
+          collection = collection.full_text_search params[:search] if params[:search].present?
           collection
         end
 
@@ -96,15 +99,14 @@ module Tramway
         def checking_roles
           [:open, current_user&.role].compact
         end
+
         protected
 
         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
+          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
 

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/lib/tramway/api.rb

@@ -83,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.2.2'
+    VERSION = '1.8.5'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tramway-api
 version: !ruby/object:Gem::Version
-  version: 1.8.2.2
+  version: 1.8.5
 platform: ruby
 authors:
 - Pavel Kalashnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2020-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers