tramway-api 1.8.3 → 1.8.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 151b3c808fba04666fdb2cccbd5368d45c86c6539878c52e1c9fa93905a3eb85
-  data.tar.gz: 8eeaf9cde77e40c5f170c3c1d242c88025003d10176947e943ae59dd10520b25
+  metadata.gz: '099a8be3907e271356fd1862d50e6b45f91a611baf481dc719a2fbf74d0f2277'
+  data.tar.gz: 3b1a738428b4f0c147b4a4b3911fd80f84e9c3cfce6deed23eb7b66e2999947d
 SHA512:
-  metadata.gz: 989b0c66ec542b84a55f803f676b0778b78ccd012ced6579ae858c0aaa31f0d345f9ff4ea737a64e393735a37ffa6285fe153ceb862b0b1dc692a4f1f2999ee3
-  data.tar.gz: ac301bb8e6fc9a7dc5e8ae7a2100703977cc7d9d58a4f2c384bdb02130ed30b02b214b1c682874b4b32fdce38f33017faadfa89352b8cb4081fad439305c3d23
+  metadata.gz: 2c4467c3a491b5a6154e4d67e302d412444f0dfc96087a8778e303350635b8928ac3820e137b5cde37adcd886b561706e27af3d5c543240901cbccc8ab7b148c
+  data.tar.gz: 583afa7ea8e70fbda137a4bd701cfb37369fdc4944114347dd889911ffb6f1da3c3377ecf3497931d41cd2f9fbc52fd1596ca95c097acdf46eda6ba3bf2d740c

data/README.md

@@ -88,14 +88,28 @@ rails g model user email:text password_digest:text username:text state:text 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:
+
+*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
+#### Add generating uuid by default to every model, that is accessible by API
 
 *db/migrate/add_uuid_to_some_model.rb*
 
@@ -371,15 +385,89 @@ 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
 

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,13 +24,21 @@ module Tramway
         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?
+          if params[:key].present?
+            if ids_methods_of(model: model_class).include? params[:key]
+              @record = model_class.find_by! params[:key] => params[:id] if params[:id].present?
+            end
+          else
+            default_id_method = Tramway::Api.default_id_method_of(model: model_class) || :uuid
+            @record = model_class.find_by! default_id_method => params[:id] if params[:id].present?
+          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]
+          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
 

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

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

data/lib/tramway/api.rb

@@ -91,8 +91,12 @@ module Tramway
         end)
       end
 
-      def id_method_of(model:)
-        @@id_methods[model.to_s]
+      def other_id_methods_of(model:)
+        @@id_methods[model.to_s][:other]
+      end
+
+      def default_id_method_of(model:)
+        @@id_methods[model.to_s][:default]
       end
     end
   end

data/lib/tramway/api/version.rb

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

metadata

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