api_me 0.9.4 → 0.10.0

data/api_me.gemspec

@@ -1,33 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'api_me/version'
-
-Gem::Specification.new do |s|
-  s.name        = 'api_me'
-  s.version     = ApiMe::VERSION
-  s.authors     = ['Sam Clopton', 'Joe Weakley']
-  s.email       = ['samsinite@gmail.com']
-  s.homepage    = 'https://github.com/wildland/api_me'
-  s.summary     = 'Api Me'
-  s.description = "This friendly library gives you helpers and generators to assist building RESTful API's in your Rails app."
-  s.license     = 'MIT'
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
-  s.require_paths = %w(lib app)
-
-  s.add_runtime_dependency 'activerecord',             '>= 4.1.16'
-  s.add_runtime_dependency 'activesupport',            '>= 4.1.16'
-  s.add_runtime_dependency 'pundit',                   '~> 1.1.0'
-  s.add_runtime_dependency 'active_model_serializers', '~> 0.10.0'
-  s.add_runtime_dependency 'search_object',            '~> 1.0'
-  s.add_runtime_dependency 'kaminari',                 '~> 0.16.3'
-
-  s.add_development_dependency 'combustion',  '~> 0.5.1'
-  s.add_development_dependency 'rspec-rails', '~> 3'
-  s.add_development_dependency 'sqlite3',     '~> 1.3.7'
-  s.add_development_dependency 'rubocop', '~> 0.49'
-  s.add_development_dependency 'rake-notes', '>= 0.2.0'
-end

data/config.ru

@@ -1,7 +0,0 @@
-require 'rubygems'
-require 'bundler'
-
-Bundler.require :default, :development
-
-Combustion.initialize!
-run Combustion::Application

data/spec/acceptance/api/v1/fails_spec.rb

@@ -1,12 +0,0 @@
-require 'spec_helper'
-
-describe 'fails API' do
-  it 'fails in the before action' do
-    get '/api/v1/fails'
-
-    expect(last_response.status).to eq(404)
-    json = JSON.parse(last_response.body)
-
-    expect(json['status']).to eq('failed')
-  end
-end

data/spec/acceptance/api/v1/posts_spec.rb

@@ -1,154 +0,0 @@
-require 'spec_helper'
-
-describe 'Posts API' do
-  it 'sends the list of posts using the default filter' do
-    posts = [
-      Post.create(name: 'test'),
-      Post.create(name: 'test 2')
-    ]
-
-    get '/api/v1/posts'
-
-    expect(last_response.status).to eq(200)
-    json = JSON.parse(last_response.body)
-
-    expect(json['posts'].length).to eq(posts.count)
-  end
-
-  it 'is paging with page offset using default page size and restricting size' do
-    40.times do
-      Post.create(name: 'page item')
-    end
-
-    get '/api/v1/posts?page%5Boffset%5D=1'
-    json = JSON.parse(last_response.body)
-    expect(json['posts'].length).to eq(25)
-  end
-
-  it 'is page offset of 2 working for size of 40 default page size of 25' do
-    40.times do
-      Post.create(name: 'page item')
-    end
-
-    get '/api/v1/posts?page%5Boffset%5D=2'
-    json = JSON.parse(last_response.body)
-    expect(json['posts'].length).to eq(15)
-  end
-
-  it 'is page offset of -1 working for size of 40 default page size of 25' do
-    # min page offset is 1, anything less gets converted to 1 and results in page size records
-    40.times do
-      Post.create(name: 'page item')
-    end
-
-    get '/api/v1/posts?page%5Boffset%5D=-1'
-    json = JSON.parse(last_response.body)
-    expect(json['posts'].length).to eq(25)
-  end
-
-  it 'is page offset of 3 working for size of 40 default page size of 25' do
-    # overflow on page offset will result in 0 records
-    40.times do
-      Post.create(name: 'page item')
-    end
-
-    get '/api/v1/posts?page%5Boffset%5D=3'
-    json = JSON.parse(last_response.body)
-    expect(json['posts'].length).to eq(0)
-  end
-
-  it 'is page size of 10 working for default offset of 1' do
-    # overflow on page offset will result in 0 records
-    40.times do
-      Post.create(name: 'page item')
-    end
-
-    get '/api/v1/posts?page%5Bsize%5D=10'
-    json = JSON.parse(last_response.body)
-    expect(json['posts'].length).to eq(10)
-  end
-
-  it 'is page size working when the value is negative' do
-    # overflow on page offset will result in 0 records
-    40.times do
-      Post.create(name: 'page item')
-    end
-
-    get '/api/v1/posts?page%5Bsize%5D=-10'
-    json = JSON.parse(last_response.body)
-    expect(json['posts'].length).to eq(25)
-  end
-
-  it 'is page size working when the value is higher than the total record count' do
-    # overflow on page offset will result in 0 records
-    40.times do
-      Post.create(name: 'page item')
-    end
-
-    get '/api/v1/posts?page%5Bsize%5D=100'
-    json = JSON.parse(last_response.body)
-    expect(json['posts'].length).to eq(40)
-  end
-
-  it 'is the result all records when no page paramas are sent' do
-    # overflow on page offset will result in 0 records
-    100.times do
-      Post.create(name: 'page item')
-    end
-
-    get '/api/v1/posts'
-    json = JSON.parse(last_response.body)
-    expect(json['posts'].length).to eq(100)
-  end
-
-  it 'restricts page_size when max_per_page config is less' do
-    100.times do
-      Post.create(name: 'page item')
-    end
-
-    Kaminari.config.max_per_page = 10
-
-    get '/api/v1/posts?page%5Bsize%5D=100'
-    json = JSON.parse(last_response.body)
-    expect(json['posts'].length).to eq(10)
-  end
-
-  it 'sends posts filtered by ids' do
-    all_posts = [
-      Post.create(name: 'test'),
-      Post.create(name: 'test 2'),
-      Post.create(name: 'test 3')
-    ]
-
-    filtered_posts = [all_posts[0], all_posts[2]]
-
-    get '/api/v1/posts?ids%5B%5D=' + filtered_posts[0].id.to_s +
-        '&ids%5B%5D=' + filtered_posts[1].id.to_s
-
-    expect(last_response.status).to eq(200)
-    json = JSON.parse(last_response.body)
-
-    expect(json['posts'].length).to eq(filtered_posts.count)
-  end
-
-  it 'sends posts reverse sorted by id' do
-    20.times do |i|
-      Post.create(name: 'Post' + i.to_s)
-    end
-
-    get '/api/v1/posts?sort%5Bcriteria%5D=id&sort%5Breverse%5D=true'
-    json = JSON.parse(last_response.body)
-    expect(json['posts'].last['name']).to eq('Post0')
-  end
-
-  it 'sends posts reverse sorted by id and paginated with a size of 10 and an offset of 1' do
-    20.times do |i|
-      Post.create(name: 'Post' + i.to_s)
-    end
-
-    get '/api/v1/posts?page%5Boffset%5D=1&page%5Bsize%5D=10&sort%5Bcriteria%5D=id&sort%5Breverse%5D=true'
-    json = JSON.parse(last_response.body)
-    expect(json['posts'].first['name']).to eq('Post19')
-    expect(json['posts'].length).to eq(10)
-  end
-end

data/spec/acceptance/api/v1/users_spec.rb

@@ -1,96 +0,0 @@
-require 'spec_helper'
-
-describe 'Users API' do
-  it 'sends the list of users' do
-    users = [
-      User.create(username: 'Test'),
-      User.create(username: 'Test 2')
-    ]
-
-    get '/api/v1/users'
-
-    expect(last_response.status).to eq(200)
-    json = JSON.parse(last_response.body)
-
-    expect(json['users'].length).to eq(users.count)
-  end
-
-  it 'returns a 404 for a user that does not exist' do
-    invalid_user_id = User.maximum(:id).to_i + 1
-
-    get '/api/v1/users/' + invalid_user_id.to_s + '/'
-
-    expect(last_response.status).to eq(404)
-  end
-
-  it 'returns a 404 for new' do
-
-    get '/api/v1/users/new'
-
-    expect(last_response.status).to eq(404)
-  end
-
-  it 'returns a 404 for edit' do
-    user = User.create(username: 'Foo')
-
-    expect(user.username).to eq('Foo')
-
-    get '/api/v1/users/' + user.id.to_s + '/edit'
-
-    expect(last_response.status).to eq(404)
-  end
-
-  it 'creates a new user' do
-    user_params = {
-      username: 'Test'
-    }
-
-    post '/api/v1/users/', user: user_params
-
-    expect(last_response.status).to eq(201)
-    json = JSON.parse(last_response.body)
-
-    expect(json['user']['username']).to eq(user_params[:username])
-  end
-
-  it 'updates an existing user' do
-    user = User.create(username: 'Foo')
-
-    expect(user.username).to eq('Foo')
-
-    put '/api/v1/users/' + user.id.to_s + '/', user: { username: 'Bar' }
-
-    updated_user = User.find(user.id)
-    expect(last_response.status).to eq(204)
-    expect(updated_user.username).to eq('Bar')
-  end
-
-  it 'destroys an existing user' do
-    user = User.create(username: 'Foo')
-
-    expect(user.id).to_not eq(nil)
-
-    delete '/api/v1/users/' + user.id.to_s + '/'
-
-    does_user_exist = User.where(id: user.id).exists?
-    expect(last_response.status).to eq(204)
-    expect(does_user_exist).to eq(false)
-  end
-
-  it 'sends a filtered list of users' do
-    all_users = [
-      User.create(username: 'Test'),
-      User.create(username: 'Demo'),
-      User.create(username: 'Test 2')
-    ]
-
-    filtered_users = [all_users[0], all_users[2]]
-
-    get '/api/v1/users?filters%5Bsearch%5D=Test'
-
-    expect(last_response.status).to eq(200)
-    json = JSON.parse(last_response.body)
-
-    expect(json['users'].length).to eq(filtered_users.count)
-  end
-end

data/spec/acceptance/multi_word_resource_spec.rb

@@ -1,12 +0,0 @@
-require 'spec_helper'
-
-describe 'multi-word API resource' do
-  it 'succeeds creating a new object using a resource that consists of multiple words' do
-    post '/api/v1/multi_word_resources', test_model: { test: true }
-
-    expect(last_response.status).to eq(201)
-    json = JSON.parse(last_response.body)
-
-    expect(json['test_model']['created']).to eq(true)
-  end
-end

data/spec/internal/app/controllers/api/v1/fails_controller.rb

@@ -1,11 +0,0 @@
-class Api::V1::FailsController < ApplicationController # rubocop:disable ClassAndModuleChildren
-  include ApiMe
-
-  before_action :fail
-
-  private
-
-  def fail
-    render json: { status: 'failed' }, status: 404
-  end
-end

data/spec/internal/app/controllers/api/v1/multi_word_resources_controller.rb

@@ -1,6 +0,0 @@
-class Api::V1::MultiWordResourcesController < ApplicationController # rubocop:disable ClassAndModuleChildren, LineLength
-  include ApiMe
-
-  model TestModel
-  serializer TestModelSerializer
-end

data/spec/internal/app/controllers/api/v1/posts_controller.rb

@@ -1,3 +0,0 @@
-class Api::V1::PostsController < ApplicationController # rubocop:disable ClassAndModuleChildren
-  include ApiMe
-end

data/spec/internal/app/controllers/api/v1/users_controller.rb

@@ -1,3 +0,0 @@
-class Api::V1::UsersController < ApplicationController # rubocop:disable ClassAndModuleChildren
-  include ApiMe
-end

data/spec/internal/app/controllers/application_controller.rb

@@ -1,12 +0,0 @@
-class ApplicationController < ActionController::Base
-  # Prevent CSRF attacks by raising an exception.
-  # For APIs, you may want to use :null_session instead.
-  protect_from_forgery with: :exception
-
-  private
-
-  # Needed by pundit
-  def current_user
-    nil
-  end
-end

data/spec/internal/app/filters/user_filter.rb

@@ -1,7 +0,0 @@
-require 'search_object'
-
-class UserFilter < ApiMe::BaseFilter
-  include ::SearchObject.module
-
-  option(:search) { |scope, value| scope.where('username LIKE ?', "%#{value}%") }
-end

data/spec/internal/app/models/post.rb

@@ -1,3 +0,0 @@
-class Post < ActiveRecord::Base
-  belongs_to :user
-end

data/spec/internal/app/models/test_model.rb

@@ -1,21 +0,0 @@
-require 'active_model_serializers/model'
-
-class TestModel < ActiveModelSerializers::Model
-  def self.create
-    @created = true
-  end
-
-  def self.created
-    @created ||= false
-  end
-
-  def initialize(*_args); end
-
-  def save!(*_args)
-    TestModel.create
-  end
-
-  def created
-    TestModel.created
-  end
-end

data/spec/internal/app/models/user.rb

@@ -1,3 +0,0 @@
-class User < ActiveRecord::Base
-  has_many :posts
-end

data/spec/internal/app/policies/application_policy.rb

@@ -1,65 +0,0 @@
-class ApplicationPolicy
-  attr_reader :user, :record
-
-  def initialize(user, record)
-    @user = user
-    @record = record
-  end
-
-  def index?
-    true
-  end
-
-  def show?
-    scope.where(id: record.id).exists?
-  end
-
-  def create?
-    true
-  end
-
-  def new?
-    create?
-  end
-
-  def update?
-    true
-  end
-
-  def edit?
-    update?
-  end
-
-  def destroy?
-    true
-  end
-
-  def scope
-    Pundit.policy_scope!(user, record.class)
-  end
-
-  class Scope
-    attr_reader :user, :scope
-
-    def initialize(user, scope)
-      @user = user
-      @scope = scope
-    end
-
-    def resolve
-      readable
-    end
-
-    def readable
-      scope
-    end
-
-    def modifyable
-      scope
-    end
-
-    def destroyable
-      scope
-    end
-  end
-end