introspective_grape 0.0.4 → 0.1.9

data/lib/introspective_grape/filters.rb

@@ -0,0 +1,66 @@
+module IntrospectiveGrape::Filters
+  #
+  # Allow filters on all whitelisted model attributes (from api_params)
+  #
+  def simple_filters(klass, model, api_params)
+    @simple_filters ||= api_params.select {|p| p.is_a? Symbol }.map { |field|
+      (klass.param_type(model,field) == DateTime ? ["#{field}_start", "#{field}_end"] : field.to_s)
+    }.flatten
+  end
+
+  def timestamp_filter(klass,model,field)
+    filter = field.sub(/_(end|start)\z/,'')
+    if field =~ /_(end|start)\z/ && klass.param_type(model,filter) == DateTime
+      filter
+    else
+      false
+    end
+  end
+
+  def identifier_filter(klass,model,field)
+    if field.ends_with?('id') && klass.param_type(model,field) == Integer
+      field
+    else
+      false
+    end
+  end
+
+  def declare_filter_params(dsl, klass, model, api_params)
+    # Declare optional parameters for filtering parameters, create two parameters per
+    # timestamp, a Start and an End, to apply a date range.
+    simple_filters(klass, model, api_params).each do |field|
+      if timestamp_filter(klass,model,field)
+        terminal = field.ends_with?("_start") ? "initial" : "terminal" 
+        dsl.optional field, type: klass.param_type(model,field), description: "Constrain #{field} by #{terminal} date."
+      elsif identifier_filter(klass,model,field)
+        dsl.optional field, type: Array[Integer], coerce_with: ->(val) { val.split(',') }
+      else
+        dsl.optional field, type: klass.param_type(model,field), description: "Filter on #{field} by value."
+      end
+    end
+    dsl.optional :filter, type: String, description: "JSON of conditions for query. If you're familiar with ActiveRecord's query conventions you can build more complex filters, e.g. against included child associations, e.g. {\"<association_name>_<parent>\":{\"field\":\"value\"}}"
+
+  end
+
+  def apply_filter_params(klass, model, api_params, params, records)
+    simple_filters(klass, model, api_params).each do |field|
+      next if params[field].blank?
+
+      if timestamp_filter(klass,model,field)
+        op      = field.ends_with?("_start") ? ">=" : "<="
+        records = records.where("#{timestamp_filter(klass,model,field)} #{op} ?", Time.zone.parse(params[field]))
+      else
+        records = records.where(field => params[field])
+      end
+    end
+
+    if params[:filter].present?
+      filters = JSON.parse( params[:filter].delete('\\') )
+      filters.each do |key, value|
+        records = records.where(key => value) if value.present?
+      end
+    end
+
+    records
+  end
+end

data/lib/introspective_grape/formatter/camel_json.rb

@@ -0,0 +1,14 @@
+# Add a formatter to grape that converts all snake case hash keys from ruby to camel case.
+module IntrospectiveGrape
+  module Formatter
+    module CamelJson
+      def self.call(object, _env)
+        if object.respond_to?(:to_json)
+          JSON.parse(object.to_json).with_camel_keys.to_json
+        else
+          MultiJson.dump(object).with_camel_keys.to_json
+        end
+      end
+    end
+  end
+end

data/lib/introspective_grape/helpers.rb

@@ -0,0 +1,63 @@
+module IntrospectiveGrape::Helpers
+  API_ACTIONS = [:index,:show,:create,:update,:destroy].freeze
+  def authentication_method=(method)
+    # IntrospectiveGrape::API.authentication_method=
+    @authentication_method = method
+  end
+
+  def authentication_method(context)
+    # Default to "authenticate!" or as grape docs once suggested, "authorize!"
+    if @authentication_method 
+      @authentication_method
+    elsif context.respond_to?('authenticate!')
+      'authenticate!'
+    elsif context.respond_to?('authorize!')
+      'authorize!'
+    end
+  end
+
+  def paginate(args={})
+    @pagination = args
+  end
+
+  def pagination
+    @pagination
+  end
+
+  def exclude_actions(model, *args)
+    @exclude_actions ||= {}; @exclude_actions[model.name] ||= []
+    args.flatten!
+    args = API_ACTIONS if args.include?(:all) 
+    args = []          if args.include?(:none)
+
+    undefined_actions = args.compact-API_ACTIONS
+    raise "#{model.name} defines invalid actions: #{undefined_actions}" if undefined_actions.present?
+
+    @exclude_actions[model.name] = args.present? ? args.compact : @exclude_actions[model.name] || []
+  end
+
+  def include_actions(model, *args)
+    @exclude_actions ||= {}; @exclude_actions[model.name] ||= []
+    @exclude_actions[model.name] = API_ACTIONS-exclude_actions(model, args)
+  end
+
+
+  def default_includes(model, *args)
+    @default_includes ||= {}
+    @default_includes[model.name] = args.present? ? args.flatten : @default_includes[model.name] || []
+  end
+  
+  def whitelist(whitelist=nil)
+    return @whitelist if !whitelist
+    @whitelist = whitelist
+  end
+
+  def skip_presence_validations(fields=nil)
+    return @skip_presence_fields||[] if !fields
+    @skip_presence_fields = [fields].flatten
+  end
+
+
+end
+
+

data/lib/introspective_grape/traversal.rb

@@ -0,0 +1,54 @@
+module IntrospectiveGrape::Traversal
+  # For deeply nested endpoints we want to present the record being affected, these
+  # methods traverse down from the parent instance to the child model associations
+  # of the deeply nested route.
+
+  def find_leaves(routes, record, params)
+    # Traverse down our route and find the leaf's siblings from its parent, e.g.
+    # project/#/teams/#/team_users ~> project.find.teams.find.team_users
+    # (the traversal of the intermediate nodes occurs in find_leaf())
+    return record if routes.size < 2 # the leaf is the root
+    record = find_leaf(routes, record, params)
+    if record 
+      assoc  = routes.last
+      if assoc.many? 
+        leaves = record.send( assoc.reflection.name ).includes( default_includes(assoc.model) )
+        verify_records_found(leaves, routes)
+        leaves
+      else 
+        # has_one associations don't return a CollectionProxy and so don't support 
+        # eager loading.
+        record.send( assoc.reflection.name )
+      end
+    end
+  end
+
+  def verify_records_found(leaves, routes)
+    unless (leaves.map(&:class) - [routes.last.model]).empty? 
+      raise ActiveRecord::RecordNotFound.new("Records contain the wrong models, they should all be #{routes.last.model.name}, found #{records.map(&:class).map(&:name).join(',')}")
+    end
+  end
+
+  def find_leaf(routes, record, params)
+    return record unless routes.size > 1
+    # For deeply nested routes we need to search from the root of the API to the leaf
+    # of its nested associations in order to guarantee the validity of the relationship,
+    # the authorization on the parent model, and the sanity of passed parameters. 
+    routes[1..-1].each_with_index do |r|
+      if record && params[r.key]
+        ref = r.reflection
+        record = record.send(ref.name).where( id: params[r.key] ).first if ref
+      end
+    end
+
+    verify_record_found(routes, params, record)
+    record
+  end
+
+  def verify_record_found(routes, params, record)
+    if params[routes.last.key] && record.class != routes.last.model
+      raise ActiveRecord::RecordNotFound.new("No #{routes.last.model.name} with ID '#{params[routes.last.key]}'")
+    end
+  end
+
+end

data/lib/introspective_grape/version.rb

@@ -1,3 +1,3 @@
 module IntrospectiveGrape
-  VERSION = "0.0.4"
+  VERSION = "0.1.9".freeze
 end

data/lib/introspective_grape.rb

@@ -1,4 +1,15 @@
 module IntrospectiveGrape
   autoload :API,        'introspective_grape/api'
   autoload :CamelSnake, 'introspective_grape/camel_snake'
+  autoload :Filters,    'introspective_grape/filters'
+  autoload :Helpers,    'introspective_grape/helpers'
+  autoload :Traversal,  'introspective_grape/traversal'
+
+  module Formatter
+    autoload :CamelJson, 'introspective_grape/formatter/camel_json'
+  end
+
+  def self.config
+    @config = OpenStruct.new(camelize_parameters: true)
+  end
 end

data/spec/dummy/Gemfile

@@ -1,4 +1,6 @@
-
+source 'https://rubygems.org'
+gem 'grape-kaminari'
 gem 'pundit'
-gem 'paperclip', '3.4.2'
-gem 'delayed_paperclip', git: 'https://github.com/buermann/delayed_paperclip.git'
+#gem 'byebug'
+gem 'paperclip'
+gem 'delayed_paperclip'

data/spec/dummy/app/api/api_helpers.rb

@@ -1,5 +1,4 @@
 module ApiHelpers
-  include IntrospectiveGrape::CamelSnake
   def warden
     env['warden']
   end
@@ -8,13 +7,13 @@ module ApiHelpers
     warden.user || params[:api_key].present? && @user = User.find_by_authentication_token(params[:api_key])
   end
 
-  def authorize!
-    unauthorized! unless current_user 
+  def authenticate!
+    unauthenticated! unless current_user 
   end
 
-  # returns an 'unauthorized' response
-  def unauthorized!(error_type = nil)
-    respond_error!('unauthorized', error_type, 401)
+  # returns an 'unauthenticated' response
+  def unauthenticated!(error_type = nil)
+    respond_error!('unauthenticated', error_type, 401)
   end
 
   # returns a error response with given type, message_key and status

data/spec/dummy/app/api/dummy/chat_api.rb

@@ -1,8 +1,7 @@
 class Dummy::ChatAPI < DummyAPI
-  Chat.default_includes :chat
 
   before do 
-    authorize!
+    authenticate!
   end
 
   resource :chats do  

data/spec/dummy/app/api/dummy/company_api.rb

@@ -1,5 +1,20 @@
 class Dummy::CompanyAPI < IntrospectiveGrape::API
-  restful Company
+  paginate
+
+  restful Company do
+
+    desc "Test default values in an extra endpoint"
+    params do
+      optional :boolean_default, type: Boolean, default: false
+      optional :string_default, type: String, default: "foo"
+      optional :integer_default, type: Integer, default: 123
+    end
+    get '/special/list' do
+      authorize Company.new, :index?
+      present params
+    end
+    
+  end
 
   class CompanyEntity < Grape::Entity
     expose :id, :name, :short_name, :created_at, :updated_at

data/spec/dummy/app/api/dummy/location_api.rb

@@ -1,10 +1,10 @@
 class Dummy::LocationAPI < IntrospectiveGrape::API
+  exclude_actions Location, :none 
+  include_actions LocationBeacon, :index 
+  include_actions LocationGps, :index
 
   default_includes Location, :child_locations, :gps, :beacons, :locatables
 
-  exclude_actions LocationBeacon, :show,:create,:update,:destroy
-  exclude_actions LocationGps, :show,:create,:update,:destroy
-
   restful Location, [:name, :kind,
     {gps_attributes: [:id, :lat, :lng, :alt, :_destroy]},
     {beacons_attributes: [:id, :company_id, :mac_address, :uuid, :major, :minor, :_destroy]},

data/spec/dummy/app/api/dummy/project_api.rb

@@ -9,6 +9,7 @@ class Dummy::ProjectAPI < IntrospectiveGrape::API
   exclude_actions Team, :show
   exclude_actions TeamUser, :show,:update
 
+  paginate per_page: 2, max_per_page: 10, offset: 2
 
   restful Project, [:id, teams_attributes: [:id,:name,:_destroy, team_users_attributes: [:id, :user_id, :_destroy] ]] 
 

data/spec/dummy/app/api/dummy/sessions.rb

@@ -16,15 +16,10 @@ class Dummy::Sessions < Grape::API
       if user && user.valid_password?(params[:password]) && user.valid_for_authentication?
 
         # commented out for now, User model is not yet confirmable
-        #unauthorized! DummyAPI::USER_NOT_CONFIRMED unless user.confirmed?
+        #unauthenticated! DummyAPI::USER_NOT_CONFIRMED unless user.confirmed?
 
         token = nil
         if params[:token]
-          payload = {
-              uid: "#{user.id}", # uid must be a string
-              email: user.email,
-              avatar_url: user.avatar_url
-          }
           user.authentication_token = SecureRandom.urlsafe_base64(nil, false)
           user.save
         end
@@ -33,7 +28,7 @@ class Dummy::Sessions < Grape::API
         env['warden'].set_user(user, scope: :user)
         present user, with: Dummy::Entities::User, token: token
       else
-        unauthorized! DummyAPI::BAD_LOGIN
+        unauthenticated! DummyAPI::BAD_LOGIN
       end
     end
 
@@ -43,7 +38,8 @@ class Dummy::Sessions < Grape::API
     end
     delete '/' do
       authorize User.new, :sessions?
-      if u = User.find_by_authentication_token(params[:api_key])
+      u = User.find_by_authentication_token(params[:api_key])
+      if u 
         u.authentication_token = nil
         {status: u.save!}
       else

data/spec/dummy/app/api/dummy/user_api.rb

@@ -2,10 +2,12 @@ class Dummy::UserAPI < IntrospectiveGrape::API
 
   skip_presence_validations :password
 
+  include_actions User, :all
   exclude_actions Role, :show,:update
   exclude_actions UserProjectJob, :show,:update
 
   restful User, [:id, :email, :password, :first_name, :last_name, :skip_confirmation_email,
+    :created_at, :updated_at,
     user_project_jobs_attributes: [:id, :job_id, :project_id, :_destroy],
     roles_attributes: [:id, :ownable_type, :ownable_id, :_destroy],
     avatar_attributes: [:id, :file, :_destroy]
@@ -24,7 +26,7 @@ class Dummy::UserAPI < IntrospectiveGrape::API
   end
 
   class UserEntity < Grape::Entity
-    expose :id, :email, :first_name, :last_name, :avatar_url
+    expose :id, :email, :first_name, :last_name, :avatar_url, :created_at
     expose :roles, as: :roles_attributes, using: RoleEntity
     expose :user_project_jobs, as: :user_project_jobs_attributes, using: UserProjectJobEntity
   end 

data/spec/dummy/app/api/dummy_api.rb

@@ -1,27 +1,27 @@
 #require 'grape-swagger'
 #require 'grape-entity'
-require 'active_record_helpers'
 #require 'introspective_grape/camel_snake'
 
 class DummyAPI < Grape::API
   version 'v1', using: :path
-  format :json
+  format    :json
+  formatter :json, IntrospectiveGrape::Formatter::CamelJson
   default_format :json
 
   include ErrorHandlers
   helpers PermissionsHelper
   helpers ApiHelpers
 
-  USER_NOT_CONFIRMED =    'user_not_confirmed'  # "Your account must be confirmed, please check your email inbox."
-  BAD_LOGIN =             'bad_login' # incorrect username or password'
+  USER_NOT_CONFIRMED = 'user_not_confirmed'.freeze
+  BAD_LOGIN          = 'bad_login'.freeze
 
   before do
     # sets server date in response header. This can be used on the client side
-    header "X-Server-Date", "#{Time.now.to_i}"
+    header "X-Server-Date", Time.now.to_i.to_s
     header "Expires", 1.year.ago.httpdate
     # Convert incoming camel case params to snake case: grape will totally blow this
     # if the params hash is not a Hashie::Mash, so make it one of those:
-    #@params = Hashie::Mash.new(snake_keys(params))
+    #@params = Hashie::Mash.new(params.with_snake_keys)
   end
 
   before_validation do

data/spec/dummy/app/api/error_handlers.rb

@@ -17,11 +17,11 @@ module ErrorHandlers
       error_response message: "Join record not found! #{e.message}", status: 404
     end
 
-    m.rescue_from Pundit::NotAuthorizedError do |e|
+    m.rescue_from Pundit::NotAuthorizedError do
       error_response message: "Forbidden", status: 403 
     end
 
-    m.rescue_from Pundit::NotDefinedError do |e|
+    m.rescue_from Pundit::NotDefinedError do
       error_response message: "Policy not implemented", status: 501 
     end
   end

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

@@ -10,7 +10,7 @@ class ChatUser < AbstractAdapter
   validate :user_not_already_active, on: :create
 
   def user_not_already_active
-    errors[:base] << "#{user.name} is already present in this chat." if chat.chat_users.where(user_id: user.id, departed_at: nil).count > 0 if user.persisted?
+    errors[:base] << "#{user.name} is already present in this chat." if chat.chat_users.where(user_id: user.id, departed_at: nil).count > 0 && user.persisted?
   end
 
 end

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

@@ -11,10 +11,10 @@ class Image < ActiveRecord::Base
 
   #process_in_background :file, processing_image_url: 'empty_avatar.png'
 
-  Paperclip.interpolates :imageable_type  do |attachment, style|
+  Paperclip.interpolates :imageable_type  do |attachment, _style|
       attachment.instance.imageable_type.try(:pluralize)
   end
-  Paperclip.interpolates :imageable_id  do |attachment, style|
+  Paperclip.interpolates :imageable_id  do |attachment, _style|
       attachment.instance.imageable_id
   end
 

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

@@ -15,7 +15,7 @@ class Role < AbstractAdapter
     ownable_type == 'SuperUser' ? SuperUser.new : super
   end
 
-  def self.ownable_assign_options(model=nil)
+  def self.ownable_assign_options(_model=nil)
     ([SuperUser.new] + Company.all + Project.all).map { |i| [ "#{i.class}: #{i.name}", "#{i.class}-#{i.id}"] }
   end
 

data/spec/dummy/app/models/user/chatter.rb

@@ -2,15 +2,15 @@ module User::Chatter
 
   def message_query(chat_id, new = true)
     messages.joins(:chat_message_users) 
-    .where('chat_message_users.user_id'=> id)
-    .where(new ? {'chat_message_users.read_at'=>nil} : '')
-    .where(chat_id ? {'chat_messages.chat_id'=> chat_id} : '')
-    .order('') # or it will add an order by id clause that breaks the count query.
+            .where('chat_message_users.user_id'=> id)
+            .where(new ? {'chat_message_users.read_at'=>nil} : '')
+            .where(chat_id ? {'chat_messages.chat_id'=> chat_id} : '')
+            .order('') # or it will add an order by id clause that breaks the count query.
   end
 
   def new_messages?(chat=nil) # returns a hash of chat_ids with new message counts 
     chat_id = chat.kind_of?(Chat) ? chat.id : chat
-    new = message_query(chat_id, new = true)
+    new = message_query(chat_id)
           .select("chat_messages.chat_id, count(chat_messages.id) as count")
           .group('chat_id')
 
@@ -20,7 +20,7 @@ module User::Chatter
   def read_messages(chat= nil, mark_as_read= false, new= true)
     chat_id = chat.kind_of?(Chat) ? chat.id : chat
     new = message_query(chat_id, new).order('chat_messages.created_at').includes(:author) # :chat?
-    new.map(&:chat).uniq.each {|chat| mark_as_read(chat) } if mark_as_read
+    new.map(&:chat).uniq.each {|c| mark_as_read(c) } if mark_as_read
     new
   end
 

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

@@ -5,9 +5,9 @@ class UserProjectJob < AbstractAdapter
 
   validates_inclusion_of :job, in: proc {|r| r.project.try(:jobs) || [] }
 
-  delegate :email, :avatar_url, to: :user
-  delegate :title, to: :job
-  delegate :name,  to: :project
+  delegate :email, :avatar_url, to: :user,    allow_nil: true
+  delegate :title,              to: :job,     allow_nil: true
+  delegate :name,               to: :project, allow_nil: true
 
   def self.options_for_job(project=nil)
     project.jobs

data/spec/dummy/config/application.rb

@@ -5,7 +5,7 @@ require "active_record/railtie"
 require "action_controller/railtie"
 require "action_mailer/railtie"
 require "action_view/railtie"
-require "sprockets/railtie"
+#require "sprockets/railtie"
 require 'activerecord-tableless'
 require 'devise'
 require 'devise/async'

data/spec/dummy/db/migrate/20150824215701_create_images.rb

@@ -4,10 +4,10 @@ class CreateImages < ActiveRecord::Migration
       t.references :imageable, polymorphic: true, index: true
       t.attachment :file
       t.boolean :file_processing, null: false, default: false
-      t.json  :meta
+      t.json   :meta
       t.string :source
-      t.float :lat
-      t.float :lng
+      t.float  :lat
+      t.float  :lng
       t.timestamp :taken_at
       t.timestamps null: false
     end

data/spec/dummy/db/schema.rb

@@ -102,7 +102,7 @@ ActiveRecord::Schema.define(version: 20150909225019) do
     t.integer  "file_file_size"
     t.datetime "file_updated_at"
     t.boolean  "file_processing",   default: false, null: false
-    t.text   "meta"
+    t.text     "meta"
     t.string   "source"
     t.float    "lat"
     t.float    "lng"

data/spec/models/image_spec.rb

@@ -6,7 +6,7 @@ RSpec.describe Image, type: :model do
 
   it { should have_attached_file(:file) }
   it { should validate_attachment_content_type(:file).
-        allowing('image/png', 'image/gif', 'image/jpeg')
+    allowing('image/png', 'image/gif', 'image/jpeg')
   }
   it { should validate_attachment_size(:file).less_than(2.megabytes) }
 

data/spec/models/role_spec.rb

@@ -25,35 +25,35 @@ RSpec.describe Role, type: :model do
   context "User helper methods" do 
     it "should register a user as a super user" do
       user.superuser?.should == false
-      ur = Role.create!(user:user, ownable: SuperUser.new)
+      Role.create!(user:user, ownable: SuperUser.new)
       user.reload
       user.superuser?.should == true
     end
 
     it "should register a company admin" do
       user.admin?(company).should == false
-      ur = Role.create!(user:user, ownable: company)
+      Role.create!(user:user, ownable: company)
       user.reload
       user.admin?(company).should == true
     end
 
     it "should register a project administrator" do 
       user.admin?(project).should == false
-      ur = Role.create!(user:user, ownable: project)
+      Role.create!(user:user, ownable: project)
       user.reload
       user.admin?(project).should == true
     end
 
     it "should register a user a company admin if admin of any company" do
       user.company_admin?.should == false
-      ur = Role.create!(user:user, ownable: company)
+      Role.create!(user:user, ownable: company)
       user.reload
       user.company_admin?.should == true
     end
 
     it "should register a user as a project admin if admin of any project" do
       user.project_admin?.should == false
-      ur = Role.create!(user:user, ownable: project)
+      Role.create!(user:user, ownable: project)
       user.reload
       user.project_admin?.should == true
     end

data/spec/models/user_location_spec.rb

@@ -16,7 +16,7 @@ RSpec.describe UserLocation, type: :model do
 
   it "logs a user's locations by beacon" do
     beacon = LocationBeacon.last
-    p1 = user.user_locations.build(location: beacon.location, detectable: beacon, coords: rand_coords)
+    user.user_locations.build(location: beacon.location, detectable: beacon, coords: rand_coords)
     user.save.should == true
     p2 = user.user_locations.build(location: beacon.location, detectable: beacon, coords: rand_coords)
     user.save.should == true
@@ -25,7 +25,7 @@ RSpec.describe UserLocation, type: :model do
 
   it "logs a user's beacon location by gps" do
     gps = LocationGps.last
-    p1 = user.user_locations.build(location: gps.location, detectable: gps, coords: rand_coords)
+    user.user_locations.build(location: gps.location, detectable: gps, coords: rand_coords)
     user.save.should == true
     p2 = user.user_locations.build(location: gps.location, detectable: gps, coords: rand_coords)
     user.save.should == true

data/spec/models/user_project_job_spec.rb

@@ -22,7 +22,7 @@ RSpec.describe UserProjectJob, type: :model do
     j = Job.make!
     p.jobs.push j
     p.save
-    r = UserProjectJob.make!(project: p, job: j) 
+    UserProjectJob.make!(project: p, job: j) 
     UserProjectJob.options_for_job(p).should == p.jobs
   end
 

data/spec/rails_helper.rb

@@ -1,4 +1,6 @@
-ENV["RAILS_ENV"] ||= 'test'
+require 'coveralls'
+Coveralls.wear!('rails')
+ENV["RAILS_ENV"] = 'test'
 require File.expand_path("../dummy/config/environment", __FILE__)
 require 'rspec/rails'
 require 'support/request_helpers'