apes 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b17680f70819d6bf72c0169dc4b3239d2ce027a1
+  data.tar.gz: 433a38eb075debb0ce24c0175e4b3dfa7cd3448c
+SHA512:
+  metadata.gz: 0acdbf772972650d5c1378590943f4fa93e887075431fbe2ad0170bbf2252674efa7809f50a98c77cbfa09fe9beb8be3e1b93a2c3ee50a6c137b4a4ad378ba5a
+  data.tar.gz: 08bfc68f9d5327ea22ba316bd319ea423004658eafa6ea060bc883dbe083b1b9eb749602a2bad91e6d21f967387566d08f12c4f481fce79e0a4a6ac762e62798

data/.gitignore

@@ -0,0 +1,7 @@
+Gemfile.lock
+coverage/
+pkg/
+tmp/
+.idea/
+.yardoc/
+.bundle

data/.rubocop.yml

@@ -0,0 +1,82 @@
+#
+# This file is part of the apes gem. Copyright (C) 2016 and above Shogun <shogun@cowtech.it>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Include:
+    - "*/**/.rb"
+    - "config.ru"
+    - "Rakefile"
+    - "Gemfile"
+  Exclude:
+    - "config/**/*"
+    - "db/**/*"
+    - "spec/**/*"
+
+Alias:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+BracesAroundHashParameters:
+  Enabled: false
+
+CyclomaticComplexity:
+  Max: 15
+
+ClassLength:
+  Max: 150
+
+Documentation:
+  Enabled: false
+
+EachWithObject:
+  Enabled: false
+
+FormatString:
+  Enabled: false
+
+FrozenStringLiteralComment:
+  Enabled: false
+
+IndentationConsistency:
+  Enabled: false
+
+LineLength:
+  Max: 160
+
+MethodLength:
+  Max: 15
+
+ModuleLength:
+  Max: 200
+
+MultilineMethodCallIndentation:
+  Enabled: false
+
+ParameterLists:
+  Max: 8
+
+RegexpLiteral:
+  Enabled: false
+
+SignalException:
+  Enabled: false
+
+SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+StringLiterals:
+  Enabled: false
+
+StringLiteralsInInterpolation:
+  Enabled: false
+
+StringReplacement:
+  Enabled: false
+
+WordArray:
+  Enabled: false

data/.travis-gemfile

@@ -0,0 +1,15 @@
+#
+# This file is part of the apes gem. Copyright (C) 2016 and above Shogun <shogun@cowtech.it>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+source "http://rubygems.org"
+
+gemspec
+
+# Testing
+gem "sqlite3", "~> 1.3"
+gem "rspec", "~> 3.4"
+gem "rake", "~> 11.0"
+gem "simplecov", "~> 0.11"
+gem "coveralls", "~> 0.8", require: false

data/.travis.yml

@@ -0,0 +1,15 @@
+#
+# This file is part of the apes gem. Copyright (C) 2016 and above Shogun <shogun@cowtech.it>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+language: ruby
+rvm:
+  - 2.3.0
+script: bundle exec rake spec:ci
+gemfile: .travis-gemfile
+notifications:
+  email: false
+addons:
+  code_climate:
+    repo_token:

data/.yardopts

@@ -0,0 +1 @@
+-m markdown

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 2016-06-04 / 1.0.0
+
+* Initial version.

data/Gemfile

@@ -0,0 +1,22 @@
+#
+# This file is part of the apes gem. Copyright (C) 2016 and above Shogun <shogun@cowtech.it>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+source "http://rubygems.org"
+
+gemspec
+
+# Testing
+gem "sqlite3", "~> 1.3"
+gem "rspec", "~> 3.4"
+gem "rake", "~> 11.0"
+
+# Documentation
+gem "simplecov", "~> 0.11"
+gem "coveralls", "~> 0.8", require: false
+gem "pry", "~> 0.10"
+gem "yard", "~> 0.8"
+gem "kramdown", "~> 1.10"
+gem "github-markup", "~> 1.4"
+gem "rubocop", "~> 0.39"

data/README.md

@@ -0,0 +1,177 @@
+# apes
+
+[![Gem Version](https://badge.fury.io/rb/apes.png)](http://badge.fury.io/rb/apes)
+[![Dependency Status](https://gemnasium.com/ShogunPanda/apes.png?travis)](https://gemnasium.com/ShogunPanda/apes)
+[![Build Status](https://secure.travis-ci.org/ShogunPanda/apes.png?branch=master)](http://travis-ci.org/ShogunPanda/apes)
+[![Coverage Status](https://coveralls.io/repos/ShogunPanda/apes/badge.png)](https://coveralls.io/r/ShogunPanda/apes)
+
+A tiny JSON API framework for Ruby on Rails.
+
+https://sw.cowtech.it/apes
+
+https://github.com/ShogunPanda/apes
+
+# Introduction
+
+Apes makes it easy to deal with [JSON API](http://jsonapi.org/) by abstracting all the oddities of the specification.
+
+## Routes
+
+There's no requirement at all here, but a good start point for your routes might be the following:
+
+```ruby
+Rails.application.routes.draw do
+  # This is to enable AJAX cross domain
+  match '*path', to: 'application#handle_cors', via: :options
+
+  # Insert your routes here
+
+  # Catch alls
+  match("/*unused", via: :all, to: "application#error_handle_not_found")
+  root(to: "application#error_handle_not_found")
+end
+```
+
+## Controller
+
+Once your controller inherits from `Apes::Controller`, you can implement a CRUD in virtually no time:
+
+```ruby
+class UsersController < Apes::Controller
+  before_action :find_user, except: [:index, :create]
+
+  def index
+    @objects = paginate(User.all)
+  end
+
+  def show
+  end
+
+  def create
+    @object = User.new
+    attributes = request_extract_model(@object)
+    @object.update_attributes!(request_cast_attributes(@object, attributes))
+
+    response.header["Location"] = user_url(@object)
+    response.status = :created
+  end
+
+  def update
+    attributes = request_extract_model(@object)
+    @object.update_attributes!(request_cast_attributes(@object, attributes))
+  end
+
+  def destroy
+    @object.destroy!
+    render(nothing: true, status: :no_content)
+  end
+
+  private
+
+  def find_user
+    @object = User.find(params[:id])
+  end
+end
+```
+
+By definining the `ATTRIBUTES` and `RELATIONSHIPS` in your model, you can ensure no invalid attributes are provided.
+
+```
+class Appointment < ApplicationRecord
+  ATTRIBUTES = [:user, :assignee, :date, :reason].freeze
+  RELATIONSHIPS = {user: nil, assignee: User}.freeze
+end
+```
+
+## Model
+
+If your model imports `Apes::Model`, it will earn two extra nice things: additional validations and enhanced search.
+
+Additional validations use the same infrastructure of `ActiveModel::Validations` but it's not bound to any attribute and it's not reset when performing validations.
+
+For instance, you can do:
+
+```ruby
+class User < ApplicationRecord
+  include Apes::Model
+end
+
+u = User.new
+u.additional_errors.add("whatever", "I don't like my name!")
+u.validate!
+p u.errors
+p u.all_validation_errors
+```
+
+Enhanced searching, instead allow to perform single or multiple rows searching using `find_with_any` (including `find_with_any!` variant) or `search`.
+
+The latter will perform full text search on one or more fields returning all matching rows:
+
+```ruby
+ZipCode.search(params: params, query: collection, fields: ["zip", "name", "county", "state"])
+```
+
+The former instead, with perform a exact search basing on the model definition and returning the first matching row:
+
+```ruby
+ZipCode.find_with_any!(params[:id])
+```
+
+You can customize which fields is searching on by defining the constants `SECONDARY_KEY` or `SECONDARY_QUERY` in your model.
+
+Note that UUID are always matched against the `id` column.
+
+## View
+
+There's nothing much to say here. `Apes::Controller` handles views and error rendering.
+
+All you need to do is to define a partial view in `app/views/models` using JBuilder.
+If your action defines `@objects` or `@object` variables, Apes will render a collection or a single object automagically.
+
+Example (`app/views/models/_appointment.json.jbuilder`):
+
+```ruby
+json.type "appointment"
+json.id object.to_param
+
+json.attributes do
+  json.extract! object, :date, :reason
+end
+
+json.relationships do
+  included = local_assigns.fetch(:included, false)
+
+  json.assignee do
+    json.data({type: "user", id: object.assignee.to_param})
+    json.links({related: user_url(object.assignee)})
+    response_included(object.assignee) unless included
+  end
+  
+  json.user do
+    json.data({type: "user", id: object.user.to_param})
+    json.links({related: user_url(object.user)})
+    response_included(object.user) unless included
+  end
+end
+
+json.links do
+  json.self appointment_url(object)
+end
+
+json.meta(meta) if local_assigns.key?(:meta)
+```
+
+## Contributing to apes
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+
+## Copyright
+
+Copyright (C) 2016 and above Shogun <shogun@cowtech.it>.
+
+Licensed under the MIT license, which can be found at http://opensource.org/licenses/MIT.

data/Rakefile

@@ -0,0 +1,44 @@
+#
+# This file is part of the apes gem. Copyright (C) 2016 and above Shogun <shogun@cowtech.it>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+# Compatibility layer for Rake 11.0
+Rake.application.class.send(:alias_method, :last_comment, :last_description) unless Rake.application.respond_to?(:last_comment)
+
+RSpec::Core::RakeTask.new("spec")
+
+RSpec::Core::RakeTask.new("spec:coverage") do
+  ENV["COVERAGE"] = "true"
+end
+
+RSpec::Core::RakeTask.new("spec:ci") do
+  ENV["COVERAGE"] = "true"
+  ENV["NO_COLOR"] = "true"
+end
+
+desc "Performs linting of the code using rubocop"
+task "lint" do
+  Kernel.exec("rubocop -ED lib")
+end
+
+desc "Generates the documentation"
+task :docs do
+  system("yardoc") || raise("Failed Execution of: yardoc")
+end
+
+desc "Gets the current release version"
+task :version, :with_name do |_, args|
+  gem = Bundler::GemHelper.instance.gemspec
+  puts [args[:with_name] == "true" ? gem.name : nil, gem.version].compact.join("-")
+end
+
+desc "Prepares the release"
+task :prerelease => ["spec:coverage", "docs"] do
+  ["git add -A", "git commit -am \"Version #{Bundler::GemHelper.instance.gemspec.version}\""].each do |cmd|
+    system(cmd) || raise("Failed Execution of: #{cmd}")
+  end
+end

data/apes.gemspec

@@ -0,0 +1,34 @@
+#
+# This file is part of the apes gem. Copyright (C) 2016 and above Shogun <shogun@cowtech.it>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require File.expand_path("../lib/apes/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = "apes"
+  gem.version = Apes::Version::STRING
+  gem.homepage = "https://github.com/ShogunPanda/apes"
+  gem.summary = %q{A tiny JSON API framework for Ruby on Rails.}
+  gem.description = %q{A tiny JSON API framework for Ruby on Rails.}
+  gem.rubyforge_project = "apes"
+
+  gem.authors = ["Shogun"]
+  gem.email = ["shogun@cowtech.it"]
+  gem.license = "MIT"
+
+  gem.files = `git ls-files`.split($\)
+  gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.required_ruby_version = ">= 2.3.0"
+
+  # Add gem dependencies here
+  gem.add_dependency("lazier", "~> 4.2")
+  gem.add_dependency("mustache", "~> 1.0")
+  gem.add_dependency("jwt", "~> 1.5")
+  gem.add_dependency("jbuilder", "~> 2.5")
+  gem.add_dependency("rails", "~> 4.2")
+  gem.add_dependency("rails-api", "~> 0.4")
+end

data/doc/Apes.html

@@ -0,0 +1,130 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Module: Apes
+  
+    &mdash; Documentation by YARD 0.8.7.6
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!Apes.html";
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index (A)</a> &raquo;
+    
+    
+    <span class="title">Apes</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Module: Apes
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/apes/model.rb<span class="defines">,<br />
+  lib/apes/errors.rb,<br /> lib/apes/version.rb,<br /> lib/apes/validators.rb,<br /> lib/apes/controller.rb,<br /> lib/apes/urls_parser.rb,<br /> lib/apes/serializers.rb,<br /> lib/apes/concerns/errors.rb,<br /> lib/apes/concerns/request.rb,<br /> lib/apes/pagination_cursor.rb,<br /> lib/apes/concerns/response.rb,<br /> lib/apes/concerns/pagination.rb,<br /> lib/apes/runtime_configuration.rb</span>
+</dd>
+  
+</dl>
+<div class="clear"></div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>This file is part of the apes gem. Copyright (C) 2016 and above Shogun <a href="&#109;&#097;&#105;&#108;&#116;&#111;:&#115;&#104;&#111;&#103;&#117;&#110;&#064;&#099;&#111;&#119;&#116;&#101;&#099;&#104;&#046;&#105;&#116;">&#115;&#104;&#111;&#103;&#117;&#110;&#064;&#099;&#111;&#119;&#116;&#101;&#099;&#104;&#046;&#105;&#116;</a>.
+Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+  
+    
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Apes/Concerns.html" title="Apes::Concerns (module)">Concerns</a></span>, <span class='object_link'><a href="Apes/Errors.html" title="Apes::Errors (module)">Errors</a></span>, <span class='object_link'><a href="Apes/Model.html" title="Apes::Model (module)">Model</a></span>, <span class='object_link'><a href="Apes/Serializers.html" title="Apes::Serializers (module)">Serializers</a></span>, <span class='object_link'><a href="Apes/Validators.html" title="Apes::Validators (module)">Validators</a></span>, <span class='object_link'><a href="Apes/Version.html" title="Apes::Version (module)">Version</a></span>
+    
+  
+    
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Apes/Controller.html" title="Apes::Controller (class)">Controller</a></span>, <span class='object_link'><a href="Apes/PaginationCursor.html" title="Apes::PaginationCursor (class)">PaginationCursor</a></span>, <span class='object_link'><a href="Apes/RuntimeConfiguration.html" title="Apes::RuntimeConfiguration (class)">RuntimeConfiguration</a></span>, <span class='object_link'><a href="Apes/UrlsParser.html" title="Apes::UrlsParser (class)">UrlsParser</a></span>
+    
+  
+</p>
+
+
+
+
+
+
+
+
+
+</div>
+
+    <div id="footer">
+  Generated on Sat Jun  4 12:41:53 2016 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.6 (ruby-2.3.0).
+</div>
+
+  </body>
+</html>