rapid_api 0.1.0

data/lib/rapid_api/auth/support.rb

@@ -0,0 +1,9 @@
+require 'rapid_api/auth/support/jwt'
+
+module RapidApi
+  module Auth
+    module Support
+
+    end
+  end
+end

data/lib/rapid_api/auth.rb

@@ -0,0 +1,8 @@
+require 'rapid_api/auth/concerns'
+require 'rapid_api/auth/support'
+
+module RapidApi
+  module Auth
+
+  end
+end

data/lib/rapid_api/configuration.rb

@@ -0,0 +1,11 @@
+module RapidApi
+  class Configuration
+    include Singleton
+
+    attr_accessor :model_adapter,
+                  :serializer_adapter,
+                  :auth_model,
+                  :response_codes
+
+  end
+end

data/lib/rapid_api/model_adapters/abstract.rb

@@ -0,0 +1,33 @@
+module RapidApi
+  module ModelAdapters
+    class Abstract
+
+      attr_accessor :klass
+
+      def initialize(klass)
+        @klass = klass
+      end
+
+      def find(_id, _scope=nil)
+        raise NotImplementedError
+      end
+
+      def find_all(_params=nil, _scope=nil)
+        raise NotImplementedError
+      end
+
+      def create(_params, _scope=nil)
+        raise NotImplementedError
+      end
+
+      def update(_id, _params, _scope=nil)
+        raise NotImplementedError
+      end
+
+      def destroy(_id, _scope=nil)
+        raise NotImplementedError
+      end
+
+    end
+  end
+end

data/lib/rapid_api/model_adapters/active_record_adapter.rb

@@ -0,0 +1,49 @@
+module RapidApi
+  module ModelAdapters
+    class ActiveRecordAdapter < Abstract
+
+      def find(id, scope=nil)
+        member = _find_member_with_scope(id, scope)
+        QueryResult.new data: member
+      end
+
+      def find_all(params=nil, scope=nil)
+        params ||= {}
+        scope  ||= {}
+        scoped_params = params.merge scope
+        collection = klass.where(scoped_params)
+        QueryResult.new data: collection
+      end
+
+      def create(params, scope=nil)
+        scope ||= {}
+        create_params = params.merge scope
+        member = klass.create create_params
+        _query_result_for_member member
+      end
+
+      def update(id, params, scope=nil)
+        member = _find_member_with_scope(id, scope)
+        member.update_attributes params
+        _query_result_for_member member
+      end
+
+      def destroy(id, scope=nil)
+        member = _find_member_with_scope(id, scope)
+        member.destroy
+        _query_result_for_member member
+      end
+
+      private
+
+      def _query_result_for_member(member)
+        QueryResult.new data: member, errors: member.errors
+      end
+
+      def _find_member_with_scope(id, scope)
+        klass.where(scope).where(id: id).first
+      end
+
+    end
+  end
+end

data/lib/rapid_api/model_adapters/query_result.rb

@@ -0,0 +1,22 @@
+module RapidApi
+  module ModelAdapters
+
+    class QueryResult
+      attr_accessor :errors, :data
+
+      def initialize(data: nil, errors: nil)
+        @data   = data
+        @errors = errors
+      end
+
+      def has_errors?
+        errors.present?
+      end
+
+      def found?
+        data.present?
+      end
+    end
+
+  end
+end

data/lib/rapid_api/model_adapters.rb

@@ -0,0 +1,9 @@
+require 'rapid_api/model_adapters/abstract'
+require 'rapid_api/model_adapters/query_result'
+require 'rapid_api/model_adapters/active_record_adapter'
+
+module RapidApi
+  module ModelAdapters
+
+  end
+end

data/lib/rapid_api/serializer_adapters/abstract.rb

@@ -0,0 +1,22 @@
+module RapidApi
+  module SerializerAdapters
+    class Abstract
+
+      attr_accessor :klass, :root_key
+
+      def initialize(klass, root_key)
+        @klass    = klass
+        @root_key = root_key
+      end
+
+      def serialize(_member)
+        raise NotImplementedError
+      end
+
+      def serialize_collection(_collection)
+        raise NotImplementedError
+      end
+
+    end
+  end
+end

data/lib/rapid_api/serializer_adapters/ams_adapter.rb

@@ -0,0 +1,20 @@
+module RapidApi
+  module SerializerAdapters
+    class AmsAdapter < Abstract
+
+      def serialize(member)
+        serializer = klass.new(member)
+        serializer.to_json
+      end
+
+      def serialize_collection(collection)
+        array_serializer = ActiveModel::ArraySerializer.new collection, {
+                             each_serializer: klass
+                           }
+        array_serializer.root = root_key.pluralize
+        array_serializer.to_json
+      end
+
+    end
+  end
+end

data/lib/rapid_api/serializer_adapters.rb

@@ -0,0 +1,8 @@
+require 'rapid_api/serializer_adapters/abstract'
+require 'rapid_api/serializer_adapters/ams_adapter'
+
+module RapidApi
+  module SerializerAdapters
+
+  end
+end

data/lib/rapid_api/version.rb

@@ -0,0 +1,3 @@
+module RapidApi
+  VERSION = "0.1.0"
+end

data/lib/rapid_api.rb

@@ -0,0 +1,36 @@
+require 'rapid_api/version'
+require 'active_support/concern'
+require 'rapid_api/model_adapters'
+require 'rapid_api/serializer_adapters'
+require 'rapid_api/action_controller'
+require 'rapid_api/auth'
+require 'rapid_api/configuration'
+
+module RapidApi
+
+  Configuration.instance.tap do |c|
+    c.model_adapter      = ModelAdapters::ActiveRecordAdapter
+    c.serializer_adapter = SerializerAdapters::AmsAdapter
+    c.response_codes = {
+      :ok                    => :ok,
+      :created               => :created,
+      :not_found             => :not_found,
+      :unprocessable_entity  => :unprocessable_entity,
+      :unauthorized          => :unauthorized,
+      :internal_server_error => :internal_server_error
+    }
+  end
+
+  def self.config
+    Configuration.instance
+  end
+
+end
+
+if defined?(ActionController::Base)
+  ActionController::Base.send :include, RapidApi::ActionController::Macros
+end
+
+if defined?(ActionController::API)
+  ActionController::API.send :include, RapidApi::ActionController::Macros
+end

data/test/integration/ams_ar_test.rb

@@ -0,0 +1,44 @@
+require File.expand_path '../../test_helper.rb', __FILE__
+
+class AmsArTest < ActionController::TestCase
+  class AmsArIntegrationController < ActionController::Base
+    include RapidApi::ActionController::Errors
+
+    rapid_actions model: Brick, serializer: BrickSerializer
+
+    scope_by :user_id do |controller|
+      controller.params['user_id']
+    end
+
+    permit_params :color, :weight, :material
+  end
+
+  tests AmsArIntegrationController
+
+  def setup
+    super
+    DatabaseCleaner.start
+    Brick.delete_all
+    @user1 = User.create
+    @user2 = User.create
+  end
+
+  def teardown
+    DatabaseCleaner.clean
+  end
+
+  def test_index
+    Brick.destroy_all
+    brick1 = @user1.bricks.create color: 'yellow',  weight: 10, material: 'gold'
+    brick2 = @user1.bricks.create color: 'red',     weight: 1,  material: 'clay'
+    brick3 = @user2.bricks.create color: 'magenta', weight: 0,  material: 'feathers'
+    get :index, { user_id: @user1.id }
+    assert_equal "{\"bricks\":[{\"color\":\"yellow\",\"weight\":\"10.0\",\"material\":\"gold\"},{\"color\":\"red\",\"weight\":\"1.0\",\"material\":\"clay\"}]}", response.body
+  end
+
+  def test_show
+    brick = Brick.create color: 'red',    weight: 1,  material: 'clay'
+    get :show, {id: brick.id}
+    assert_equal "{\"brick\":{\"color\":\"red\",\"weight\":\"1.0\",\"material\":\"clay\"}}", response.body
+  end
+end

data/test/support/code_climate.rb

@@ -0,0 +1,2 @@
+# require "codeclimate-test-reporter"
+# CodeClimate::TestReporter.start

data/test/support/models.rb

@@ -0,0 +1,24 @@
+require 'active_record'
+require 'database_cleaner'
+
+ActiveRecord::Base.establish_connection adapter:  :sqlite3,
+                                        database: 'memory'
+
+DatabaseCleaner.strategy = :transaction
+
+class Brick < ActiveRecord::Base
+  validates_uniqueness_of :color
+  before_destroy :prevent_destroy
+  belongs_to :user
+
+  def prevent_destroy
+    errors.add(:base, "Destroy prevented") if color == 'prevent_destroy'
+  end
+end
+
+class User < ActiveRecord::Base
+  has_many :bricks
+  def find_and_authenticate(params)
+    where(username: params[:username], password: params[:password]).first
+  end
+end

data/test/support/schema.rb

@@ -0,0 +1,14 @@
+ActiveRecord::Schema.define do
+  connection.drop_table :bricks if connection.table_exists? :bricks
+  connection.drop_table :users  if connection.table_exists? :users
+  create_table :bricks do |t|
+    t.string  :color
+    t.decimal :weight
+    t.string  :material
+    t.integer :user_id
+  end
+  create_table :users do |t|
+    t.string :username
+    t.string :password
+  end
+end

data/test/support/serializers.rb

@@ -0,0 +1,7 @@
+require 'active_model_serializers'
+
+class BrickSerializer < ActiveModel::Serializer
+  attributes :color,
+             :weight,
+             :material
+end

data/test/support/test_model_adapter.rb

@@ -0,0 +1,23 @@
+class TestModelAdapter < RapidApi::ModelAdapters::Abstract
+
+    def find(params, scope)
+      return nil
+    end
+
+    def find_all(params, scope)
+      return nil
+    end
+
+    def create(params, scope)
+      return nil
+    end
+
+    def update(params, scope)
+      return nil
+    end
+
+    def destroy(params, scope)
+      return nil
+    end
+
+end

data/test/support/test_module/test_model_adapter.rb

@@ -0,0 +1,25 @@
+module TestModule
+  class TestModelAdapter < RapidApi::ModelAdapters::Abstract
+
+      def find(params)
+        return nil
+      end
+
+      def find_all(params)
+        return nil
+      end
+
+      def create(params)
+        return nil
+      end
+
+      def update(params)
+        return nil
+      end
+
+      def destroy(params)
+        return nil
+      end
+
+  end
+end

data/test/support/test_serializer_adapter.rb

@@ -0,0 +1,10 @@
+class TestSerializerAdapter < RapidApi::SerializerAdapters::Abstract
+  def serialize(member)
+    return nil
+  end
+
+  def serializer_collection(collection)
+    return nil
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,28 @@
+require 'bundler/setup'
+require 'pry'
+require 'rails'
+require 'action_controller'
+require 'action_controller/test_case'
+require 'rapid_api'
+require 'minitest/autorun'
+
+Dir['./test/support/**/*.rb'].each {|f| require f}
+
+module TestHelper
+  Routes = ActionDispatch::Routing::RouteSet.new
+  Routes.draw do
+    get ':controller(/:action(/:id))'
+    get ':controller(/:action)'
+  end
+
+  ActionController::Base.send :include, Routes.url_helpers
+end
+
+ActionController::TestCase.class_eval do
+  def setup
+    @routes = TestHelper::Routes
+  end
+
+  def teardown
+  end
+end

data/test/unit/rapid_api/action_controller/errors_test.rb

@@ -0,0 +1,53 @@
+require File.expand_path '../../../../test_helper.rb', __FILE__
+
+class ActionControllerErrorsTest < ActionController::TestCase
+
+  class TestErroneousController < ActionController::Base
+    include RapidApi::ActionController::Errors
+
+    def unauthenticated_action
+      not_authenticated!
+    end
+
+    def not_found_action
+      not_found!
+    end
+
+    def not_processable_action
+      brick = Brick.create
+      brick.errors.add(:base, 'Sample Error')
+      not_processable!(brick.errors)
+    end
+
+    def server_error_action
+      raise "server error message"
+    end
+
+  end
+
+  tests TestErroneousController
+
+  def test_unauthenticated_error
+    get :unauthenticated_action
+    assert_response :unauthorized
+    assert_equal ['Not Authenticated'], JSON.parse(@controller.response.body)['errors']
+  end
+
+  def test_server_error
+    get :server_error_action
+    assert_response :internal_server_error
+    assert_equal ['Server Error: server error message'], JSON.parse(@controller.response.body)['errors']
+  end
+
+  def test_not_found_error
+    get :not_found_action
+    assert_response :not_found
+    assert_equal ['Not Found'], JSON.parse(@controller.response.body)['errors']
+  end
+
+  def test_not_processable_error
+    get :not_processable_action
+    assert_response :unprocessable_entity
+    assert_equal ['Sample Error'], JSON.parse(@controller.response.body)['errors']['base']
+  end
+end

data/test/unit/rapid_api/action_controller/filterable_params_test.rb

@@ -0,0 +1,32 @@
+require File.expand_path '../../../../test_helper.rb', __FILE__
+
+module ActionController
+
+  class FilterableParamsTest < ActionController::TestCase
+
+    class TestFilterableParamsController < ActionController::Base
+      include RapidApi::ActionController::FilterableParams
+
+      filterable_params :color
+
+      def filterable_bricks
+        render json: filterable_params, status: :ok
+      end
+    end
+
+    tests TestFilterableParamsController
+
+    def test_permitted_filterable_params
+      assert :color.in?(@controller.class.permitted_filterable_params), "Attribute not added to filterable params."
+    end
+
+    def test_filterable_params
+      post :filterable_bricks, { color: 'blue', material: 'steel' }
+      body = JSON.parse(@controller.response.body)
+      expected = { 'color' => 'blue' }
+      assert_equal expected, body
+    end
+
+  end
+
+end

data/test/unit/rapid_api/action_controller/permitted_params_test.rb

@@ -0,0 +1,30 @@
+require File.expand_path '../../../../test_helper.rb', __FILE__
+
+module ActionController
+
+  class PermittedParamsTest < ActionController::TestCase
+
+    class BricksController < ActionController::Base
+      include RapidApi::ActionController::PermittedParams
+
+      permit_params :color
+
+      def permissive_bricks
+        render json: _permitted_params_for(:brick).to_json, status: :ok
+      end
+    end
+
+    tests BricksController
+
+    def test_permits_params
+      assert :color.in?(@controller.permitted_params), "Attribute not added to permitted params."
+    end
+
+    def test_permitted_params_for
+      post :permissive_bricks, {brick: {color: 'red', weight: 1}}
+      refute response.body.include?("\"weight\":\"1.0\""), ":attribute should not have been permitted."
+      assert response.body.include?("\"color\":\"red\""), ":attribute should have been permitted."
+    end
+  end
+
+end