tramway-api 1.4.1.1 → 1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04f5055e00ef3608b436ae004240b26578fb7c9862eee1935e6fbfb6c299e1c6
-  data.tar.gz: 8269beafa9c7c8ca209d6eb4f35ce5ba7f7539106acd8e2ec1d984c386cff225
+  metadata.gz: be852b8025894c89dbc01109337011ac3178b1fcc14cb8d7655bebfcbf8083ec
+  data.tar.gz: 8a13ec95aee745c0b262664658cf14807eb823ada87d845ae34e21a4b3c4720c
 SHA512:
-  metadata.gz: 86986d7a77393d34502750ffeb93240c71acdba6666df665f33916a815ce25b25038296a0bd5b603acfdda793354c5497f5a3b3375feeb3b4d11bcdba4aa6388
-  data.tar.gz: a6aed10bc3451c21abf1528893e06f778beb2b669ac89a17b0ca04dc500bf098628e35d8c34f674e5a34ef00dcba3bd51b5dcaeeadc8a7686cfc476411ff0c8b
+  metadata.gz: 47512dbe567f7b258f2f1b411545503bf0c7a964b822030061e328dee94865c9d93a4c549183ef00386af44177b818fcd2339b3658f78bd81225246256188489
+  data.tar.gz: d45547b8ca370a7357a6123330f51a90451d48663408f682fabe81ff1081955b219cef6608c0eda484284c0f6863371f456c419905513b5632b394b40ea09390

data/README.md

@@ -185,7 +185,9 @@ require 'rails_helper'
 
 RSpec.describe 'Post creating user', type: :feature do
   describe 'POST /api/v1/user with model User' do
-    let(:attributes) { attributes_for :user }
+    let(:attributes) do
+      kebab_case_converter attributes_for :user
+    end
 
     it 'returns created status' do
       post '/api/v1/user', params: { user: attributes }
@@ -284,6 +286,67 @@ Enabled methods:
 * index
 * destroy
 
+### Index
+
+Every model you've added in initializer will be able by URL `api/v1/records?model=#{model_class}`.
+
+Just update your initializer:
+
+```ruby
+::Tramway::Api.set_available_models user: { open: %i[create], closed: %i[update index] } # we've added index method
+```
+
+Create serializer
+
+*app/serializers/user_serializer.rb*
+
+```ruby
+class UserSerializer < Tramway::Core::ApplicationSerializer
+  attributes :username, :email
+end
+```
+
+Then write test:
+
+```ruby
+it 'returns status' do
+  get '/api/v1/records', params: { model: 'User' }, headers: headers
+
+  expect(response.status).to eq 200
+end
+
+it 'returns needed count' do
+  get '/api/v1/records', params: { model: 'User' }, headers: headers
+
+  expect(json_response[:data].size).to eq User.active.count
+end
+```
+
+You have your records in JSON API spec.
+
+### Create
+
+Production ready
+
+Docs coming soon
+
+### Update
+
+Production ready
+
+Docs coming soon
+
+### Show
+
+Production ready
+
+Docs coming soon
+
+### Destroy
+
+Production ready
+
+Docs coming soon
 
 ## Contributing
 Contribution directions go here.

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

@@ -9,6 +9,14 @@ module Tramway
         def render_error_with_text(text)
           render json: { text: text }, status: :bad_request
         end
+
+        def snake_case(params)
+          hash = {}
+          params.each do |attribute, value|
+            hash.merge! attribute.to_s.gsub('-', '_') => value
+          end
+          hash
+        end
       end
     end
   end

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

@@ -6,16 +6,19 @@ module Tramway::Api::V1
 
     def index
       records = model_class.active.order(id: :desc).send params[:scope] || :all
+      records = records.full_text_search params[:search] if params[:search]
       render json: records,
         each_serializer: serializer_class,
+        include: '*',
         status: :ok
     end
 
     def create
       record_form = form_class.new model_class.new
-      if record_form.submit params[:data][:attributes]
+      if record_form.submit snake_case params[:data][:attributes]
         render json: record_form.model,
           serializer: serializer_class,
+          include: '*',
           status: :created
       else
         render_errors_for record_form
@@ -24,9 +27,10 @@ module Tramway::Api::V1
 
     def update
       record_form = form_class.new model_class.active.find params[:id]
-      if record_form.submit params[:data][:attributes]
+      if record_form.submit snake_case params[:data][:attributes]
         render json: record_form.model,
           serializer: serializer_class,
+          include: '*',
           status: :ok
       else
         render_errors_for record_form
@@ -37,6 +41,7 @@ module Tramway::Api::V1
       record = model_class.active.find params[:id]
       render json: record,
         serializer: serializer_class,
+        include: '*',
         status: :ok
     end
 
@@ -45,6 +50,7 @@ module Tramway::Api::V1
       record.remove
       render json: record,
         serializer: serializer_class,
+        include: '*',
         status: :no_content
     end
 
@@ -68,7 +74,11 @@ module Tramway::Api::V1
 
     def model_class
       if params[:model].to_s.in? ::Tramway::Api.available_models.keys.map(&:to_s)
-        params[:model].constantize
+        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
     end
 

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

@@ -8,7 +8,7 @@ class Tramway::Api::V1::UsersController < ::Tramway::Api::V1::ApplicationControl
     user_form = sign_up_form_class_name(Tramway::Api.user_based_model).new Tramway::Api.user_based_model.new
     # Implement JSON API spec here
     if user_form.submit params[Tramway::Api.user_based_model.name.underscore]
-      token = ::Knock::AuthToken.new(payload: { sub: user_form.model.id }).token
+      token = ::Knock::AuthToken.new(payload: { sub: user_form.model.uid }).token
       # FIXME refactor this bullshit
       serialized_user = OpenStruct.new(
         user_form.model.attributes.merge(

data/config/initializers/json_param_key_transform.rb

@@ -0,0 +1,6 @@
+ActionDispatch::Request.parameter_parsers[:json] = -> (raw_post) {
+  data = ActiveSupport::JSON.decode(raw_post)
+  data = { _json: data } unless data.is_a?(Hash)
+
+  data.deep_transform_keys!(&:underscore)
+}

data/lib/tramway/api/version.rb

@@ -1,5 +1,5 @@
 module Tramway
   module Api
-    VERSION = '1.4.1.1'
+    VERSION = '1.5'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tramway-api
 version: !ruby/object:Gem::Version
-  version: 1.4.1.1
+  version: '1.5'
 platform: ruby
 authors:
 - Pavel Kalashnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-10 00:00:00.000000000 Z
+date: 2019-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: knock
@@ -76,6 +76,7 @@ files:
 - app/serializers/tramway/api/v1/error_serializer.rb
 - app/views/layouts/tramway/api/application.html.erb
 - config/initializers/active_model_serializers.rb
+- config/initializers/json_param_key_transform.rb
 - config/routes.rb
 - lib/tasks/tramway/api_tasks.rake
 - lib/tramway/api.rb