tramway-api 1.4.4 → 1.6.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eed51b344d38bb111854f4e32d985856ea3504b76fbf901fee56735183eae415
-  data.tar.gz: d430ca30613c117aed36db0493885b4399d4015d53d12f34470fd8bf60fe7d71
+  metadata.gz: 0f21707e10ef82a1c378250e9c82339400ee41739d7a6009001ecd1c8a17c4e0
+  data.tar.gz: 22732d5ad75036e1bf59831171f4d82af30f95805432900df283566b2b24619c
 SHA512:
-  metadata.gz: f84dd206d408c41f1d3c230079418445ff4b7fffbb4808637297695c3f033dec031e3e7f3f29f699a58d865e950d1afac1d1f8a3f6116c1ea40469fabc06bf0d
-  data.tar.gz: c746cad5ecbce016799e6337ea9f23a38287bd2cbee543a9460a5750e301238e10459bd0f4da0cb0e9bb3f3fd885665daa998b4e59982f2cb014034a48297ed1
+  metadata.gz: 313b31746731d79afe528f6100daa910260707e03c4d68d5c0961b6a046591d485006a58e3438b9b3bf4c1dcb7b79009511834b7a58905e293834d679c47bb66
+  data.tar.gz: 6b9a2570cd6b8e68d039de8706d9923651081c010f0a4cebce5347a06f442033b2c3833b7c07194bd4eea3b9bb3a2b7b81d629078d18380df4488f35b90ba63f

data/README.md

@@ -43,6 +43,7 @@ coming soon...
   gem 'tramway-core'
   gem 'state_machine', github: 'seuros/state_machine'
   gem 'knock'
+  gem 'audited'
   ```
 
 ## Usage
@@ -82,6 +83,10 @@ t.uuid :uid, default: 'uuid_generate_v4()'
 ```ruby
 class User < Tramway::Core::ApplicationRecord
   has_secure_password
+  
+  def self.from_token_payload(payload)
+    find_by uid: payload['sub']
+  end
 end
 ```
 
@@ -185,7 +190,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 +291,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/application_controller.rb

@@ -18,7 +18,7 @@ module Tramway
       protected
 
       def authenticate
-        return unauthorized unless current_user
+        return unauthorized if current_user.nil? || !params[:user_based_model].in?(Tramway::Api.user_based_models)
       end
 
       def auth_token
@@ -30,17 +30,19 @@ module Tramway
       end
 
       def entity
+        user_based_model = params[:user_based_model].constantize
         @entity ||=
-          if Tramway::Api.user_based_model.respond_to? :from_token_request
-            Tramway::Api.user_based_model.active.from_token_request request
+          if user_based_model.respond_to? :from_token_request
+            user_based_model.active.from_token_request request
           else
             params[:auth] && find_user_by_auth_attributes
           end
       end
 
       def find_user_by_auth_attributes
-        Tramway::Api.auth_attributes.each do |attribute|
-          object = Tramway::Api.user_based_model.active.where.not(attribute => nil).find_by(attribute => auth_params[:login])
+        user_based_model = params[:user_based_model].constantize
+        Tramway::Api.auth_attributes[user_based_model].each do |attribute|
+          object = user_based_model.active.where.not(attribute => nil).find_by(attribute => auth_params[:login])
           return object if object
         end
         nil
@@ -49,6 +51,12 @@ module Tramway
       def auth_params
         params[:auth]&.permit(:login, :password)
       end
+
+      def current_user
+        Tramway::Api.user_based_models.map do |user_based_model|
+          send("current_#{user_based_model.name.underscore}")
+        end.compact.first
+      end
     end
   end
 end

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: '*',
@@ -68,7 +68,7 @@ module Tramway::Api::V1
 
     def authenticate_user_if_needed
       if action_name.in? Tramway::Api::available_models[model_class.to_s][:closed]&.map(&:to_s) || []
-        authenticate_user
+        current_user
       end
     end
 

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

@@ -7,7 +7,8 @@ class Tramway::Api::V1::UserTokensController < ::Tramway::Api::V1::ApplicationCo
         auth_token: token,
         user: {
           email: @entity.email,
-          uid: @entity.uid
+          uid: @entity.uid,
+          id: @entity.id
         }
       }, status: :created
     else

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

@@ -5,9 +5,9 @@ class Tramway::Api::V1::UsersController < ::Tramway::Api::V1::ApplicationControl
   include Tramway::ClassNameHelpers
 
   def create
-    user_form = sign_up_form_class_name(Tramway::Api.user_based_model).new Tramway::Api.user_based_model.new
+    user_form = sign_up_form_class_name(user_based_model).new user_based_model.new
     # Implement JSON API spec here
-    if user_form.submit params[Tramway::Api.user_based_model.name.underscore]
+    if user_form.submit snake_case params[user_based_model.name.underscore]
       token = ::Knock::AuthToken.new(payload: { sub: user_form.model.uid }).token
       # FIXME refactor this bullshit
       serialized_user = OpenStruct.new(
@@ -31,4 +31,8 @@ class Tramway::Api::V1::UsersController < ::Tramway::Api::V1::ApplicationControl
   def sign_up_form_class_name(model_class)
     form_class_name "#{model_class}SignUp"
   end
+
+  def user_based_model
+    params[:user_based_model].constantize if params[:user_based_model].in? Tramway::Api.user_based_models.map(&:to_s)
+  end
 end

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.rb

@@ -4,19 +4,27 @@ module Tramway
   module Api
     class << self
       def auth_config
-        @@auth_config ||= { user_model: ::Tramway::User::User, auth_attributes: :email }
+        @@auth_config ||= [{ user_model: ::Tramway::User::User, auth_attributes: :email }]
       end
 
-      def auth_config=(**params)
-        @@auth_config = params
+      def auth_config=(params)
+        if params.is_a? Hash
+          @@auth_config = [params]
+        elsif params.is_a? Array
+          @@auth_config = params
+        end
       end
 
-      def user_based_model
-        @@auth_config[:user_model]
+      def user_based_models
+        @@auth_config.map do |conf|
+          conf[:user_model]
+        end
       end
 
       def auth_attributes
-        @@auth_config[:auth_attributes]
+        @@auth_config.reduce({}) do |hash, conf|
+          hash.merge! conf[:user_model] => conf[:auth_attributes]
+        end
       end
 
       def set_available_models(**models)

data/lib/tramway/api/version.rb

@@ -1,5 +1,5 @@
 module Tramway
   module Api
-    VERSION = '1.4.4'
+    VERSION = '1.6.0.1'
   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.6.0.1
 platform: ruby
 authors:
 - Pavel Kalashnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-16 00:00:00.000000000 Z
+date: 2019-10-11 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