tramway-api 1.8.6 → 1.8.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed93d90eaaed7aa48a6b22b4961a91ee4ffccb7ca89e5572e605b4fbb438fde7
-  data.tar.gz: 5dfddda7b69e8d16ac6822f33d2980fdf689b10eb6fa207e5c111bc9cb87c69b
+  metadata.gz: a073d2cac39ca7ee025468a271a4a85ba900c81693d62556ac76f1c7962882e2
+  data.tar.gz: 34fadb2c4df760f32bc76d14a2c25fa2c1e9819c3c6a738a82e0ba05d7535b1a
 SHA512:
-  metadata.gz: e10d5588bf40fd00da3f56deeac9999d64b487e52f053e70f747116b08cef9db8b5673f35a7fb177ac8833089111f0e8c44763981fb95cd1527ab507e80abe03
-  data.tar.gz: '0953fe2122cbda3f51a493978ca23f908d40e8689d48410a518fb41ff05184d579779dc03c2f416af5bd1be691fd2eedc5c783aef70043d4ec7df1917e8b5fc7'
+  metadata.gz: 8a5f6ce365af846d668d355b7858e1ae31f3c8c4dd9afabaa8f9348cfb786c0fd470300bf904e1c381e14cd9499e286154cabd62401fee14e8c896062b6443ea
+  data.tar.gz: c8ab7d0c75fb7d51ea2c9b2d9173120114387eaed83541f3e0ca9d41c12c874c311e492163769410a06c980648633ed1dbfa55b5a1a412be209b62ab980d6fbb

data/README.md

@@ -105,10 +105,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*
@@ -383,6 +391,8 @@ end
 
 You have your records in JSON API spec.
 
+You also able to use pagination, provided by `kaminari`
+
 ### Create
 
 *config/initializers/tramway.rb*

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

@@ -25,7 +25,7 @@ module Tramway
 
         def record
           if params[:key].present?
-            if ids_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

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/app/serializers/tramway/api/v1/error_serializer.rb

@@ -16,8 +16,10 @@ 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)
+    if object.respond_to? :errors
+      object.errors.messages.each do |name, messages|
+        error_messages.merge!((path + [name]).join('/') => messages)
+      end
     end
 
     if object.model

data/lib/tramway/api/version.rb

@@ -2,6 +2,6 @@
 
 module Tramway
   module Api
-    VERSION = '1.8.6'
+    VERSION = '1.8.6.5'
   end
 end

metadata

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