tramway-api 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a9e653ce900aa4bdf9e55be5f193cee92778d4850ce5893b1189cad872d9692d
+  data.tar.gz: 4047b383d98729bff0a0181ff7194a4378f5b429358e06d88da02255914b3e70
+SHA512:
+  metadata.gz: 614e33c8a1e87e8b19c293594594274f3cba429d96cb344162586beb79e3b930a0d3d52f9f661d2378c91f39c175ccc1fc7e2a90410c3e2e1f86fb3fdb555325
+  data.tar.gz: f9d5292121d7f9881dee7c2a761aa72230ebc3a2f1bd0ce0b21c91268730e2fabd3d04d335285fe2d8e80a9f2d1b7fb1d5058bcf94e046e33323d78baa8db67e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Pavel Kalashnikov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Tramway::Api
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tramway-api'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install tramway-api
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Tramway::Api'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/tramway_api_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/tramway/api .js
+//= link_directory ../stylesheets/tramway/api .css

data/app/assets/javascripts/tramway/api/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/app/assets/stylesheets/tramway/api/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

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

@@ -0,0 +1,16 @@
+module Tramway
+  module Api
+    class ApplicationController < ::Tramway::Core::ApplicationController
+      include Knock::Authenticable
+      include AuthenticateHelper
+      protect_from_forgery with: :null_session, if: proc { |c| c.request.format == 'application/json' }
+      rescue_from ActiveRecord::RecordNotFound, with: :not_found
+
+      private
+
+      def not_found
+        render json: { data: [] }, status: :not_found
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module Tramway
+  module Api
+    module V1
+      class ApplicationController < ::Tramway::Api::ApplicationController
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Tramway::Api::V1
+  class RecordsController < ::Tramway::Api::V1::ApplicationController
+    def index
+      records = model_class.active.order(id: :desc).send params[:scope] || :all
+      render json: records,
+        meta: meta_pagination(records),
+        each_serializer: serializer,
+        status: :ok
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require 'tramway/api/authenticate_helper'
+
+class Tramway::Api::V1::UserTokensController < ::Tramway::Api::V1::ApplicationController
+  before_action :authenticate
+  include Tramway::Api::AuthenticateHelper
+
+  def create
+    token = auth_token
+    render json: {
+      auth_token: token,
+      user: {
+        email: @entity.email
+      }
+    }, status: :created
+  end
+end

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

@@ -0,0 +1,22 @@
+require 'tramway/helpers/class_name_helpers'
+
+class Tramway::Api::V1::UsersController < ::Tramway::Api::V1::ApplicationController
+  before_action :authenticate_user, only: :show
+  include Tramway::ClassNameHelpers
+
+  def create
+    user_form = form_class_name(Tramway::Api.user_based_model).new Tramway::Api.user_based_model.new
+    if user_form.validate params
+      user_form.save
+      token = ::Knock::AuthToken.new(payload: { sub: user_form.model.id }).token
+      serialized_user = OpenStruct.new user_form.model.attributes.merge authentication_token: token
+      render json: serialized_user, status: :created
+    else
+      render json: user_form.errors.details, status: :unprocessable_entity
+    end
+  end
+
+  def show
+    render json: current_user, status: :ok
+  end
+end

data/app/forms/tramway/api/authentication_form.rb

@@ -0,0 +1,3 @@
+class Tramway::Api::AuthenticationForm < Tramway::Core::ApplicationForm
+  properties :email, :password
+end

data/app/helpers/tramway/api/application_helper.rb

@@ -0,0 +1,6 @@
+module Tramway
+  module Api
+    module ApplicationHelper
+    end
+  end
+end

data/app/jobs/tramway/api/application_job.rb

@@ -0,0 +1,6 @@
+module Tramway
+  module Api
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/app/mailers/tramway/api/application_mailer.rb

@@ -0,0 +1,8 @@
+module Tramway
+  module Api
+    class ApplicationMailer < ActionMailer::Base
+      default from: 'from@example.com'
+      layout 'mailer'
+    end
+  end
+end

data/app/models/tramway/api/application_record.rb

@@ -0,0 +1,7 @@
+module Tramway
+  module Api
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/views/layouts/tramway/api/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Tramway api</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "tramway/api/application", media: "all" %>
+  <%= javascript_include_tag "tramway/api/application" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,6 @@
+Tramway::Api::Engine.routes.draw do
+  namespace :v1 do
+    resource :user_token, only: [ :create ]
+    resources :users, only: [ :create ]
+  end
+end

data/lib/tasks/tramway/api_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :tramway_api do
+#   # Task goes here
+# end

data/lib/tramway/api/authenticate_helper.rb

@@ -0,0 +1,26 @@
+module Tramway::Api::AuthenticateHelper
+  def authenticate
+    raise ActiveRecord::RecordNotFound unless entity.present? && entity.authenticate(auth_params[:password])
+  end
+
+  def auth_token
+    if entity.respond_to? :to_token_payload
+      Knock::AuthToken.new payload: entity.to_token_payload
+    else
+      Knock::AuthToken.new payload: { sub: entity.id }
+    end
+  end
+
+  def entity
+    @entity ||=
+      if Tramway::Api.user_based_model.respond_to? :from_token_request
+        Tramway::Api.user_based_model.from_token_request request
+      else
+        Tramway::Api.user_based_model.find_by email: auth_params[:email]
+      end
+  end
+
+  def auth_params
+    params.require(:auth).permit :email, :password
+  end
+end

data/lib/tramway/api/engine.rb

@@ -0,0 +1,7 @@
+module Tramway
+  module Api
+    class Engine < ::Rails::Engine
+      isolate_namespace Tramway::Api
+    end
+  end
+end

data/lib/tramway/api/version.rb

@@ -0,0 +1,5 @@
+module Tramway
+  module Api
+    VERSION = '0.2'
+  end
+end

data/lib/tramway/api.rb

@@ -0,0 +1,15 @@
+require 'tramway/api/engine'
+
+module Tramway
+  module Api
+    class << self
+      def user_based_model
+        @@user_based_model ||= ::Tramway::User::User
+      end
+
+      def user_based_model=(model_class)
+        @@user_based_model = model_class
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: tramway-api
+version: !ruby/object:Gem::Version
+  version: '0.2'
+platform: ruby
+authors:
+- Pavel Kalashnikov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: knock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Engine for api
+email:
+- kalashnikovisme@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/tramway_api_manifest.js
+- app/assets/javascripts/tramway/api/application.js
+- app/assets/stylesheets/tramway/api/application.css
+- app/controllers/tramway/api/application_controller.rb
+- app/controllers/tramway/api/v1/application_controller.rb
+- app/controllers/tramway/api/v1/records_controller.rb
+- app/controllers/tramway/api/v1/user_tokens_controller.rb
+- app/controllers/tramway/api/v1/users_controller.rb
+- app/forms/tramway/api/authentication_form.rb
+- app/helpers/tramway/api/application_helper.rb
+- app/jobs/tramway/api/application_job.rb
+- app/mailers/tramway/api/application_mailer.rb
+- app/models/tramway/api/application_record.rb
+- app/views/layouts/tramway/api/application.html.erb
+- config/routes.rb
+- lib/tasks/tramway/api_tasks.rake
+- lib/tramway/api.rb
+- lib/tramway/api/authenticate_helper.rb
+- lib/tramway/api/engine.rb
+- lib/tramway/api/version.rb
+homepage: https://github.com/kalashnikovisme/tramway-dev
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Engine for api
+test_files: []