apicasso 0.4.6 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 285f7a239620529fadc3773625ad7c03228443339ef2c730dccab9bc5974ae8b
-  data.tar.gz: 90e3ed224db4b180f3498dd9c3465d7c472f6f8c97ed3aeaf808e265a1d99600
+  metadata.gz: cf4487870952607136a6a321524093ee1f0e0cd02935710110d4f5e94977b3be
+  data.tar.gz: 17633533e5faad631e27b8d0e3d6c169a86163ff5328da5d0d6cab61aabb88f7
 SHA512:
-  metadata.gz: 11af9ea91bffca509df5074001e47a6f0f0ae731efeac2f55100bc16126676edfe890bc73c424b2e81d0e925178a37653e0bdaf3a2748a3ef32100883f4eb83f
-  data.tar.gz: 307de7af6520e44516545fdbe757f0cfa3490053f8e386c257311dd5f267a89b98b45580981140e56bcf11000508c3d44f6720e864589fae8918e16eda4cdddf
+  metadata.gz: c036c58d2a4d9f1102cf47ca3d1125bbb5accbb6c69fcb583c82b7891c1801a6d68c55bfad3749e59f870c5608b48a00b1ead41b0c06c8dda60ba101785ea5d1
+  data.tar.gz: 22b512d38ff47b026bc0ea18c3173ce96c6d228e7623e5c2d61116d1450885a93bc19e348f97b0b3cc7f40af749d21c4487735d7996fd0d4bd6be2d991eb0f90

data/README.md

@@ -1,9 +1,22 @@
 <img src="https://raw.githubusercontent.com/ErvalhouS/APIcasso/master/APIcasso.png" width="300" /> [![Gem Version](https://badge.fury.io/rb/apicasso.svg)](https://badge.fury.io/rb/apicasso) [![Docs Coverage](https://inch-ci.org/github/autoforce/APIcasso.svg?branch=master)](https://inch-ci.org/github/autoforce/APIcasso.svg?branch=master) [![Maintainability](https://api.codeclimate.com/v1/badges/b58bbd6b9a0376f7cfc8/maintainability)](https://codeclimate.com/github/autoforce/APIcasso/maintainability) [![codecov](https://codecov.io/gh/autoforce/APIcasso/branch/master/graph/badge.svg)](https://codecov.io/gh/autoforce/APIcasso) [![Build Status](https://travis-ci.org/autoforce/APIcasso.svg?branch=master)](https://travis-ci.org/autoforce/APIcasso)
 
-JSON API development can get boring and time consuming. If you think it through, every time you make one you use almost the same route structure, pointing to the same controller actions, with the same ordering, filtering and pagination features.
+Create APIs in a fast and dynamic way, without the need to develop everything from scratch. You just need to create your models and let **APIcasso** do the rest for you. It is the perfect candidate to make your project development go faster or for legacy Rails projects that do not have an API.
+
+If you think it through, JSON API development can get boring and time consuming. Every time you use almost the same route structure, pointing to the same controller actions, with the same ordering, filtering and pagination features.
+
+**APIcasso** is intended to be used to speed-up development, acting as a full-fledged CRUD JSON API into all your models. It is a route-based abstraction that lets you create, read, list, update or delete any `ActiveRecord` object in your application. This makes it possible to make CRUD-only applications just by creating functional Rails' models. Access to your application's resources is managed by a `.scope` JSON object per API key. It uses that permission scope to restrict and extend access.
+
+You can make your own API with only 4 steps:
+
+### Step 1
+ Create your models
+### Step 2
+ Insert **APIcasso** engine into your routes
+### Step 3
+ [Create an Apicasso::Key](https://github.com/autoforce/APIcasso#authorization)
+### Step 4
+ Profit! :crown: Consume your REST API
 
-**APIcasso** is intended to be used as a full-fledged CRUD JSON API or as a base controller to speed-up development.
-It is a route-based resource abstraction using API key scoping. This makes it possible to make CRUD-only applications just by creating functional Rails' models. It is a perfect candidate for legacy Rails projects that do not have an API. Access to your application's resources is managed by a `.scope` JSON object per API key. It uses that permission scope to restrict and extend access.
 
 # Installation
 
@@ -81,7 +94,7 @@ This way you enjoy all our object finder, authorization and authentication featu
 
 > But exposing my models to the internet is permissive as hell! Haven't you thought about security?
 
-_Sure!_ The **APIcasso** suite is exposing your application using authentication through `Authorization: Token` [HTTP header authentication](http://tools.ietf.org/html/draft-hammer-http-token-auth-01). The API key objects are manageable through the `Apicasso::Key` model, which gets setup at install. When a new key is created a `.token` is generated using an [Universally Unique Identifier(RFC 4122)](https://tools.ietf.org/html/rfc4122). A authenticated request looks like this:
+_Sure!_ The **APIcasso** suite is exposing your application using authentication through `Authorization: Token` [HTTP header authentication](http://tools.ietf.org/html/draft-hammer-http-token-auth-01). The API key objects are manageable through the `Apicasso::Key` model, which gets setup at install. When a new key is created a `.token` is generated using an [Universally Unique Identifier(RFC 4122)](https://tools.ietf.org/html/rfc4122). An authenticated request looks like this:
 
 ```
 curl -X GET \

data/app/controllers/apicasso/application_controller.rb

@@ -154,13 +154,18 @@ module Apicasso
     # @TODO
     # Remove this in favor of a more controllable aproach of CORS
     def set_access_control_headers
-      response.headers['Access-Control-Allow-Origin'] = request.headers["Origin"]
+      response.headers['Access-Control-Allow-Origin'] = allow_origin
       response.headers['Access-Control-Allow-Methods'] = 'POST, GET, PUT, PATCH, DELETE, OPTIONS'
       response.headers['Access-Control-Allow-Credentials'] = 'true'
       response.headers['Access-Control-Allow-Headers'] = 'Origin, Content-Type, Accept, Authorization, Token, Auth-Token, Email, X-User-Token, X-User-Email'
       response.headers['Access-Control-Max-Age'] = '1728000'
     end
 
+    # A method to allow origin customizing through method overriding
+    def allow_origin
+      request.headers['Referer'] || request.headers['Origin'] || '*'
+    end
+
     # Checks if current request is a CORS preflight check
     def preflight?
       request.request_method == 'OPTIONS' &&

data/lib/apicasso/version.rb

@@ -1,3 +1,3 @@
 module Apicasso
-  VERSION = '0.4.6'.freeze
+  VERSION = '0.4.7'.freeze
 end

data/spec/dummy/app/models/used_model.rb

@@ -3,7 +3,7 @@ class UsedModel < ApplicationRecord
 
   validates :account_id, presence: true
   validates :unit_id, presence: true
-  validates :slug, presence: true, uniqueness: true
+  validates :slug, presence: true
 
   has_one_attached :file_highlighted
   has_many_attached :files

data/spec/dummy/db/seeds.rb

@@ -1,6 +1,6 @@
 require 'faker'
 
-9.times { UsedModel.create(
+30.times { UsedModel.create(
   active: Faker::Boolean.boolean,
   account_id: Faker::Number.number(1),
   unit_id: Faker::Number.number(1),
@@ -25,32 +25,4 @@ require 'faker'
   fuel: Faker::Number.number(1),
   fuel_text: Faker::Vehicle.fuel_type,
   shielded: Faker::Boolean.boolean
-)}
-
-1.times { UsedModel.create(
-  active: Faker::Boolean.boolean,
-  account_id: Faker::Number.number(1),
-  unit_id: Faker::Number.number(1),
-  slug: 'cr-v',
-  brand: Faker::Vehicle.make,
-  name: Faker::Vehicle.model,
-  model: Faker::Vehicle.model,
-  version: Faker::Number.decimal(1, 1),
-  model_year: Faker::Vehicle.year,
-  production_year: Faker::Vehicle.year,
-  kind: 'car',
-  new_vehicle: Faker::Boolean.boolean,
-  old_price: Faker::Number.decimal(4, 2).to_s,
-  price_value:  Faker::Number.decimal(4, 2),
-  price:  Faker::Number.decimal(4, 2).to_s,
-  category: Faker::Vehicle.car_type,
-  transmission: Faker::Vehicle.transmission,
-  km_value: Faker::Number.number(8),
-  km: Faker::Number.number(8).to_s,
-  plate: Faker::Number.number(4),
-  color: Faker::Vehicle.color,
-  doors: Faker::Number.number(1),
-  fuel: Faker::Number.number(1),
-  fuel_text: Faker::Vehicle.fuel_type,
-  shielded: Faker::Boolean.boolean
 )}

data/spec/models/used_model_spec.rb

@@ -7,15 +7,6 @@ RSpec.describe UsedModel, type: :model do
     it 'is valid with valid attributes' do
       expect(build :used_model).to be_valid
     end
-    it 'is invalid with slug duplicate' do
-      used_model = build(:used_model)
-      used_model.slug = 'duplicate'
-      used_model.save
-
-      used_model_dup = build(:used_model)
-      used_model_dup.slug = 'duplicate'
-      expect { used_model_dup.save! }.to raise_exception ActiveRecord::RecordInvalid
-    end
     it 'is invalid without valid slug attribute' do
       used_model = build(:used_model)
       used_model.slug = ''

data/spec/requests/requests_spec.rb

@@ -5,6 +5,7 @@ require 'rails_helper'
 RSpec.describe 'Used Model requests', type: :request do
   token = Apicasso::Key.create(scope: { manage: { used_model: true } }).token
   access_token = { 'AUTHORIZATION' => "Token token=#{token}" }
+
   describe 'GET /api/v1/used_model' do
     context 'with default pagination' do
       before(:all) do
@@ -14,8 +15,12 @@ RSpec.describe 'Used Model requests', type: :request do
       it 'returns status ok' do
         expect(response).to have_http_status(:ok)
       end
-      it 'returns all UsedModel' do
-        expect(JSON.parse(response.body)['entries'].size).to eq(UsedModel.all.size)
+      it 'returns UsedModel records equal to WillPaginate.per_page or all UsedModels' do
+        if JSON.parse(response.body)['last_page'] == false
+          expect(JSON.parse(response.body)['entries'].size).to eq(WillPaginate.per_page)
+        else
+          expect(JSON.parse(response.body)['entries'].size).to eq(UsedModel.count)
+        end
       end
     end
 
@@ -33,22 +38,26 @@ RSpec.describe 'Used Model requests', type: :request do
     end
 
     context 'with pagination' do
+      per_page = (1..UsedModel.count+1).to_a.sample
+      page = (1..5).to_a.sample
+
       before(:all) do
-        get '/api/v1/used_model', params: { per_page: 5, page: 1 }, headers: access_token
+        get '/api/v1/used_model', params: { per_page: per_page, page: page }, headers: access_token
       end
 
       it 'returns status ok' do
         expect(response).to have_http_status(:ok)
       end
 
-      it 'returns five records from UsedModel if not last page' do
-        expect(JSON.parse(response.body)['entries'].size).to be(5) if JSON.parse(response.body)['last_page'] == false
+      it 'returns size of records from UsedModel if not last page' do
+        expect(JSON.parse(response.body)['entries'].size).to be(per_page) if JSON.parse(response.body)['last_page'] == false
       end
     end
 
     context 'by searching' do
+      brand_to_search = UsedModel.all.sample.brand
       before(:all) do
-        get '/api/v1/used_model', params: { 'q[brand_matches]': 'Audi' }, headers: access_token
+        get '/api/v1/used_model', params: { 'q[brand_matches]': brand_to_search }, headers: access_token
       end
 
       it 'returns status ok' do
@@ -57,7 +66,7 @@ RSpec.describe 'Used Model requests', type: :request do
 
       it 'returns all records with brand queried' do
         JSON.parse(response.body)['entries'].each do |record|
-          expect(record['brand']).to eq('Audi')
+          expect(record['brand']).to eq(brand_to_search)
         end
       end
     end
@@ -93,8 +102,9 @@ RSpec.describe 'Used Model requests', type: :request do
     end
 
     context 'with field selecting' do
+      field_select = UsedModel.column_names.sample
       before(:all) do
-        get '/api/v1/used_model', params: { 'select': 'brand' }, headers: access_token
+        get '/api/v1/used_model', params: { 'select': field_select }, headers: access_token
       end
 
       it 'returns status ok' do
@@ -103,7 +113,7 @@ RSpec.describe 'Used Model requests', type: :request do
 
       it 'returns all records that have field queried' do
         JSON.parse(response.body)['entries'].each do |record|
-          expect(record.keys).to include('brand')
+          expect(record.keys).to include(field_select)
         end
       end
     end
@@ -142,8 +152,9 @@ RSpec.describe 'Used Model requests', type: :request do
   end
 
   describe 'GET /api/v1/used_model/:id' do
+    id_to_get_id = UsedModel.all.sample.id.to_s
     before(:all) do
-      get '/api/v1/used_model/1', headers: access_token
+      get '/api/v1/used_model/' + id_to_get_id, headers: access_token
     end
 
     it 'returns status ok' do
@@ -153,11 +164,16 @@ RSpec.describe 'Used Model requests', type: :request do
     it 'returns a record with attributes' do
       expect(JSON.parse(response.body).keys).to include('id', 'active', 'account_id', 'unit_id', 'brand', 'name', 'slug', 'model', 'version', 'model_year', 'production_year', 'kind', 'new_vehicle', 'old_price', 'price_value', 'price', 'category', 'transmission', 'km_value', 'km', 'plate', 'color', 'doors', 'fuel', 'fuel_text', 'note', 'chassis', 'shielded', 'featured', 'integrator', 'ordination', 'visits', 'bait_id', 'fipe_id', 'identifier', 'synced_at', 'deleted_at', 'created_at', 'updated_at')
     end
+
+    it 'return matches with object searched' do
+      expect(UsedModel.find(id_to_get_id.to_i).attributes.to_json).to eq(response.body)
+    end
   end
 
   describe 'GET /api/v1/used_model/:slug' do
+    id_to_get_slug = UsedModel.all.sample.slug.to_s
     before(:all) do
-      get '/api/v1/used_model/cr-v', headers: access_token
+      get '/api/v1/used_model/' + id_to_get_slug, headers: access_token
     end
 
     it 'returns status ok' do
@@ -167,17 +183,32 @@ RSpec.describe 'Used Model requests', type: :request do
     it 'returns a record with attributes' do
       expect(JSON.parse(response.body).keys).to include('id', 'active', 'account_id', 'unit_id', 'brand', 'name', 'slug', 'model', 'version', 'model_year', 'production_year', 'kind', 'new_vehicle', 'old_price', 'price_value', 'price', 'category', 'transmission', 'km_value', 'km', 'plate', 'color', 'doors', 'fuel', 'fuel_text', 'note', 'chassis', 'shielded', 'featured', 'integrator', 'ordination', 'visits', 'bait_id', 'fipe_id', 'identifier', 'synced_at', 'deleted_at', 'created_at', 'updated_at')
     end
+
+    it 'return matches with object searched' do
+      expect(UsedModel.friendly.find(id_to_get_slug).attributes.to_json).to eq(response.body)
+    end
   end
 
   describe 'POST /api/v1/used_model/' do
+    slug_to_post = Faker::Lorem.word
+
     context 'with valid params' do
       before(:all) do
-        post '/api/v1/used_model/', params: { 'used_model': { 'name': 'test', 'account_id': 1, 'unit_id': 1, 'slug': 'tests' }}, headers: access_token
+        @quantity = UsedModel.all.size
+        post '/api/v1/used_model/', params: { 'used_model': { 'name': 'test', 'account_id': 1, 'unit_id': 1, 'slug': slug_to_post, 'brand': 'BMW' }}, headers: access_token
       end
 
       it 'returns status created' do
         expect(response).to have_http_status(:created)
       end
+
+      it 'check records size into db' do
+        expect(UsedModel.all.size).to eq(@quantity + 1)
+      end
+
+      it 'find record into db' do
+        expect(UsedModel.find_by(slug: slug_to_post)).not_to eq nil
+      end
     end
 
     context 'with invalid params' do
@@ -189,9 +220,13 @@ RSpec.describe 'Used Model requests', type: :request do
   end
 
   describe 'PUT /api/v1/used_model/:id' do
+    id_to_put = UsedModel.all.sample.id.to_s
+    name_to_put = Faker::Lorem.word
+    slug_to_put = UsedModel.all.sample.slug
+
     context 'with valid params' do
       before(:all) do
-        patch '/api/v1/used_model/' + UsedModel.last.id.to_s, params: { 'used_model': { 'name': 'updated' }}, headers: access_token
+        patch '/api/v1/used_model/' + id_to_put, params: { 'used_model': { 'name': name_to_put }}, headers: access_token
       end
 
       it 'returns status ok' do
@@ -199,29 +234,38 @@ RSpec.describe 'Used Model requests', type: :request do
       end
 
       it 'updates requested record' do
-        expect(UsedModel.last.name).to eq('updated')
+        expect(UsedModel.find(id_to_put).name).to eq(name_to_put)
       end
     end
 
     context 'with invalid params' do
       it 'return a error' do
-        patch '/api/v1/used_model/' + UsedModel.last.id.to_s, params: { 'used_model': { 'slug': 'cr-v' }}, headers: access_token
+        patch '/api/v1/used_model/' + id_to_put, params: { 'used_model': { 'unit_id': nil }}, headers: access_token
         expect(response).to have_http_status(:unprocessable_entity)
       end
     end
   end
 
   describe 'DELETE /api/v1/used_model/:id' do
-    before(:all) do
-      delete '/api/v1/used_model/' + UsedModel.last.id.to_s, headers: access_token
-    end
+    id_to_del = UsedModel.all.sample.id.to_s
 
-    it 'returns status no content' do
-      expect(response).to have_http_status(:no_content)
-    end
+    context 'with valid params' do
+      before(:all) do
+        @quantity = UsedModel.all.size
+        delete '/api/v1/used_model/' + id_to_del, headers: access_token
+      end
+
+      it 'returns status no content' do
+        expect(response).to have_http_status(:no_content)
+      end
 
-    it 'detete a UsedModel record' do
-      expect(UsedModel.all.size).to eq(10)
+      it 'detete a UsedModel record' do
+        expect(UsedModel.all.size).to eq(@quantity - 1)
+      end
+
+      it 'check if record was deleted' do
+        expect{ UsedModel.find(id_to_del.to_i) }.to raise_exception(ActiveRecord::RecordNotFound)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apicasso
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.7
 platform: ruby
 authors:
 - Fernando Bellincanta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-08 00:00:00.000000000 Z
+date: 2018-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -307,7 +307,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.5
 signing_key: 
 specification_version: 4
 summary: An abstract API design as a mountable engine