tramway-api 1.8.2.3 → 1.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 022a3e30c40c67f5ea395f36d02ad064888501855af9e9d3cd3c17084ec4ae90
-  data.tar.gz: ce519fcc07c446ca740141be4f737109a3bada820e22b813e497cfc4de5b165c
+  metadata.gz: 151b3c808fba04666fdb2cccbd5368d45c86c6539878c52e1c9fa93905a3eb85
+  data.tar.gz: 8eeaf9cde77e40c5f170c3c1d242c88025003d10176947e943ae59dd10520b25
 SHA512:
-  metadata.gz: 5b38ee6bf57cbd0d3490c8f92e7d514454a1bbacaef1d792a28128b300ad4280cb15526c259c6fa4f146a297840989ded8104f27dcaa37509a582449356e7d32
-  data.tar.gz: 29869a70b7712a098743976745a9bc497b37ab27154673a4048ccfa608e95529a52d03cef159646a1a1d1db0429e20747d422ce9c1cc2aa045a3e792c380d9d4
+  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

@@ -24,7 +24,8 @@ 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
@@ -100,12 +101,10 @@ module Tramway
         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.3'
+    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.2.3
+  version: 1.8.3
 platform: ruby
 authors:
 - Pavel Kalashnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-30 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers