tramway-api 1.8.3 → 1.8.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 151b3c808fba04666fdb2cccbd5368d45c86c6539878c52e1c9fa93905a3eb85
-  data.tar.gz: 8eeaf9cde77e40c5f170c3c1d242c88025003d10176947e943ae59dd10520b25
+  metadata.gz: 6ea920d1d95b5d0879e4761b50d32a53ae9cd09425fd7ce6f3c35cc6173821cf
+  data.tar.gz: 248fc9efe23a6b44db5ce5065fc4e15500c3c387f5c39380b83e677cb750434c
 SHA512:
-  metadata.gz: 989b0c66ec542b84a55f803f676b0778b78ccd012ced6579ae858c0aaa31f0d345f9ff4ea737a64e393735a37ffa6285fe153ceb862b0b1dc692a4f1f2999ee3
-  data.tar.gz: ac301bb8e6fc9a7dc5e8ae7a2100703977cc7d9d58a4f2c384bdb02130ed30b02b214b1c682874b4b32fdce38f33017faadfa89352b8cb4081fad439305c3d23
+  metadata.gz: 949028808784d424710d0a72e602eefe85144ef46ffd1cba3a1671ad787fb91c527ae2b52002a5c60ada7c4225c9b853c3ee0f944ccda9ac7d224d086d029402
+  data.tar.gz: 5ca4783d217ee96ab1aef6be3368dd1a8c0a71233a5b129b30147b34d77f74b868933986bddcb0a12229fc4f9d6454332c7a7a1351f4c883b2be8269223c0023

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

data/lib/tramway/api/version.rb

@@ -2,6 +2,6 @@
 
 module Tramway
   module Api
-    VERSION = '1.8.3'
+    VERSION = '1.8.3.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.3.1
 platform: ruby
 authors:
 - Pavel Kalashnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
+date: 2020-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers