tramway-api 1.4.4 → 1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eed51b344d38bb111854f4e32d985856ea3504b76fbf901fee56735183eae415
-  data.tar.gz: d430ca30613c117aed36db0493885b4399d4015d53d12f34470fd8bf60fe7d71
+  metadata.gz: be852b8025894c89dbc01109337011ac3178b1fcc14cb8d7655bebfcbf8083ec
+  data.tar.gz: 8a13ec95aee745c0b262664658cf14807eb823ada87d845ae34e21a4b3c4720c
 SHA512:
-  metadata.gz: f84dd206d408c41f1d3c230079418445ff4b7fffbb4808637297695c3f033dec031e3e7f3f29f699a58d865e950d1afac1d1f8a3f6116c1ea40469fabc06bf0d
-  data.tar.gz: c746cad5ecbce016799e6337ea9f23a38287bd2cbee543a9460a5750e301238e10459bd0f4da0cb0e9bb3f3fd885665daa998b4e59982f2cb014034a48297ed1
+  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

@@ -15,7 +15,7 @@ module Tramway::Api::V1
 
     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: '*',
@@ -27,7 +27,7 @@ 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: '*',

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.4'
+    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.4
+  version: '1.5'
 platform: ruby
 authors:
 - Pavel Kalashnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-16 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