introspective_grape 0.0.4 → 0.1.9

data/spec/requests/company_api_spec.rb

@@ -1,6 +1,34 @@
 require 'rails_helper'
 
 describe Dummy::CompanyAPI, type: :request do
+  context :default_values do
+    it "should respect default values" do
+      get '/api/v1/companies/special/list'
+      response.should be_success
+      json.should eq({"boolean_default"=>false, "string_default"=>"foo", "integer_default"=>123})
+    end
+
+    it "should override default values" do
+      get '/api/v1/companies/special/list', boolean_default: true, string_default: 'bar', integer_default: 321
+      response.should be_success
+      json.should eq({"boolean_default"=>true, "string_default"=>"bar", "integer_default"=>321})
+    end
+  end
+
+  context :pagination do
+    it "should use the default introsepctive grape pagination values" do
+      Company.destroy_all
+      30.times { Company.make! }
+
+      get '/api/v1/companies'
+
+      response.should be_success
+      json.length.should eq 25
+      json.first['id'].should eq Company.first.id
+      response.headers.slice("X-Total", "X-Total-Pages", "X-Per-Page", "X-Page", "X-Next-Page", "X-Prev-Page", "X-Offset").values.should eq ["30", "2", "25", "1", "2", "", "0"]
+    end
+  end
+
   before :all do
     Company.find_by_name("Sprockets") || Company.make!(name:"Sprockets")
   end

data/spec/requests/location_api_spec.rb

@@ -7,18 +7,34 @@ describe Dummy::LocationAPI, type: :request do
 
   before :all do
     create_test_airport
+    Location.make!(name: "TEST2", kind: "airport") 
   end
 
   it "should return a list of top level locations and their children" do
     get '/api/v1/locations'
     response.should be_success
-    json.length.should > 0
+    json.length.should eq 2
     json.map{|l| l['id'].to_i }.include?(location.id).should == true
 
     json.first['child_locations'].size.should > 0
     json.first['child_locations'].map{|l| l['id'].to_i}.sort.should == location.child_locations.map(&:id).sort
   end
 
+  it "should generate basic filters on the whitelisted model attributes" do 
+    get '/api/v1/locations', { name: "TEST" }
+    response.should be_success
+    json.length.should eq 1
+    json.first['name'].should eq "TEST"
+  end
+
+  it "should parse more advanced JSON filters" do
+    get '/api/v1/locations', filter: "{\"child_locations_locations\":{\"name\":\"Terminal A\"}}" 
+    response.should be_success
+    json.length.should eq 1
+    json.first['child_locations'].length.should eq 1
+    json.first['child_locations'].first['name'].should eq "Terminal A"
+  end
+
   it "should return the specified location" do
     get "/api/v1/locations/#{location.id}"
     response.should be_success
@@ -43,7 +59,7 @@ describe Dummy::LocationAPI, type: :request do
     json['name'].should == "Test 123"
     l   = Location.find(json['id'])
     created = l.beacons.first
-    created.uuid.should   == b.uuid.gsub(/-/,'').upcase
+    created.uuid.should   == b.uuid.delete('-').upcase
     created.minor.should  == b.minor
     created.major.should  == b.major
   end
@@ -93,4 +109,5 @@ describe Dummy::LocationAPI, type: :request do
     Location.where(id: child_locations).size.should == 0
   end
 
+
 end

data/spec/requests/project_api_spec.rb

@@ -24,7 +24,7 @@ describe Dummy::ProjectAPI, type: :request do
 
   context "As a super admin" do
     it "should return a list of all projects" do
-      get '/api/v1/projects'
+      get '/api/v1/projects', per_page: 10, offset: 0
       response.should be_success
       json.length.should == Project.count
       json.map{|c| c['id'].to_i}.include?(project.id).should == true
@@ -118,7 +118,7 @@ describe Dummy::ProjectAPI, type: :request do
     end
 
     it "should return a list of all the company's projects" do
-      get '/api/v1/projects'
+      get '/api/v1/projects', offset: 0
       response.should be_success
       json.length.should == 2 
       json.map{|c| c['name']}.include?("Manufacture Sprockets").should == true
@@ -140,7 +140,7 @@ describe Dummy::ProjectAPI, type: :request do
     end
 
     it "should return a list of all the project admin's projects" do
-      get '/api/v1/projects'
+      get '/api/v1/projects', offset: 0
       response.should be_success
       json.length.should == 1 
       json.map{|c| c['name']}.include?("Manufacture Sprockets").should == true
@@ -148,4 +148,35 @@ describe Dummy::ProjectAPI, type: :request do
     end
   end
 
+  context :pagination do
+    before(:all) do
+      Project.destroy_all
+      20.times { Project.make! }
+    end
+
+    it "should return the project API's declared default paginated results" do
+      get '/api/v1/projects'
+      response.should be_success
+      json.length.should == 2
+      json.first['id'].should eq Project.all[2].id
+      json.second['id'].should eq Project.all[3].id
+      response.headers.slice("X-Total", "X-Total-Pages", "X-Per-Page", "X-Page", "X-Next-Page", "X-Prev-Page", "X-Offset").values.should eq ["20", "9", "2", "1", "2", "", "2"]
+    end
+
+    it "should return the request number of results" do
+      get '/api/v1/projects', per_page: 9, offset: 9
+      response.should be_success
+      json.size.should == 9
+      json.map {|j| j['id']}.should eq Project.all[9..17].map(&:id)
+      response.headers.slice("X-Total", "X-Total-Pages", "X-Per-Page", "X-Page", "X-Next-Page", "X-Prev-Page", "X-Offset").values.should eq ["20", "2", "9", "1", "2", "", "9"]
+    end
+
+    it "should respect the maximum number of results" do
+      get '/api/v1/projects', per_page: 20, offset: 0
+      response.code.should eq "400"
+      json['error'].should eq "per_page must be less than 10"
+    end
+  end
+
+
 end

data/spec/requests/sessions_api_spec.rb

@@ -23,7 +23,7 @@ describe Dummy::Sessions, type: :request do
       post '/api/v1/sessions', { login: user.email, password: 'bad password', token: true }
       response.should_not be_success
       json['error'].should be_truthy
-      json['error']['type'].should == 'unauthorized'
+      json['error']['type'].should == 'unauthenticated'
       user.authentication_token.should be_nil
     end
   end

data/spec/requests/user_api_spec.rb

@@ -26,6 +26,27 @@ describe Dummy::UserAPI, type: :request do
       json.first['roles_attributes'].first['ownable_id'].should == company.id
     end
 
+    it "should constrain the index by a time range" do
+      6.times { User.make! }
+      u = User.last
+      u.update_column(:created_at, 1.day.ago)
+      get '/api/v1/users', { created_at_start: 2.day.ago, created_at_end: 8.hours.ago }
+      response.should be_success
+      json.length.should eq 1
+      json.first['id'].to_i.should    eq u.id
+      json.first['first_name'].should eq u.first_name
+    end
+
+    it "should accept a comma separated list of ids" do
+      4.times { User.make! }
+      user_ids = [User.first,User.second,User.third].map(&:id)
+      get '/api/v1/users', { id: user_ids.join(',') }
+      response.should be_success
+      json.length.should eq 3
+      json.map {|j| j['id'] }.should eq user_ids
+
+    end
+
     it "should not expose users' encrypted_passwords" do
       get "/api/v1/users"
       response.should be_success
@@ -131,7 +152,7 @@ describe Dummy::UserAPI, type: :request do
       user.avatar.should     == Image.last
       user.avatar_url.should == Image.last.file.url(:medium)
     end
- 
+
     it "should upload a user avatar via the nested route, to test the restful api's handling of has_one associations" do
       params = { file: Rack::Test::UploadedFile.new(Rails.root+'../fixtures/images/avatar.jpeg', 'image/jpeg', true) }
 
@@ -142,7 +163,7 @@ describe Dummy::UserAPI, type: :request do
       user.avatar_url.should == Image.last.file.url(:medium)
       user.avatar_url
     end
-    
+
     it "should require a devise re-confirmation email to update a user's email address" do
       new_email = 'new.email@test.com'
       old_email = user.email
@@ -167,7 +188,7 @@ describe Dummy::UserAPI, type: :request do
       put "/api/v1/users/#{user.id}", { roles_attributes: [{ownable_type: 'Company', ownable_id: company.id}] }
       response.should_not be_success
       json['error'].should =~ /user has already been assigned that role/
-        user.admin?(company).should be_truthy
+      user.admin?(company).should be_truthy
     end
 
     it "should update a user to be company admin" do 

data/spec/support/blueprints.rb

@@ -12,11 +12,11 @@ def syllable(length=-1)
 end
 
 def word(max_syl=3)
-  (1+rand(max_syl)).times.collect { syllable }.join
+  Array.new(1+rand(max_syl)).map { syllable }.join
 end
 
 def words(n=3)
-  n.times.collect { word }.join
+  Array.new(n).collect { word }.join
 end
 
 def paragraph(n=25)
@@ -29,7 +29,7 @@ Company.blueprint do
 end
 
 User.blueprint do
-  email       { "test-"+syllable+'@springshot.com' }
+  email       { "test-"+word(5)+'@springshot.com' }
   first_name  { word(4) }
   last_name   { word(5) }
   password    { 'abc12345' }

data/spec/support/location_helper.rb

@@ -6,6 +6,7 @@ module LocationHelper
   end
 
   def create_test_airport
+    return unless Rails.env.test?
     ###  build an airport with 8 terminals each with 3 gates along each cardinal and ordinal
     ###  axis, for two companies each with their own set of bluetooth beacons at every gate:
     ###
@@ -14,43 +15,47 @@ module LocationHelper
     ###                      (8)H-*-D e.g.->(Terminal D with gates D1, D2, and D3) 
     ###                          /|\       
     ###                         G F E 
+    @sprocketCo, @widgetCo = test_companies
 
-    @sprocketCo = Company.find_by_name("Sprockets") || Company.make(name:'Sprockets')
-    @widgetCo   = Company.find_by_name("Widgets")   || Company.make(name:'Widgets')
-    if @airport = Location.find_by_name("TEST")
-      return @airport
-    end
-
-    @airport     = Location.new(name:'TEST',kind:'airport')
-    @airport.companies.push @sprocketCo
-    @airport.companies.push @widgetCo
+    @airport    = Location.find_by_name("TEST") || Location.new(name:'TEST',kind:'airport')
+    return @airport if @airport.persisted?
+    @airport.companies.push @sprocketCo, @widgetCo
     @airport.gps = LocationGps.new(lat: 37.615223, lng: -122.389977 )
+
+    @airport = generate_terminals(@airport)
+    @airport.save!
+    @airport
+  end
+
+  def generate_terminals(airport)
     (1..8).each do |terminal|
       gate = (64+terminal).chr # A-H
       t = Location.new(name:"Terminal #{gate}",kind:'terminal')
 
-      @airport.child_locations.push t
-
       (1..3).each do |number|
-
-        lat, lng = [@airport.gps.lat, @airport.gps.lng]
+        lat, lng = [airport.gps.lat, airport.gps.lng]
         adj = 0.003*number # push successive gates ~0.21 miles out
 
-        lat += (1..3).include?(terminal) ? adj : 0
-        lat -= (5..7).include?(terminal) ? adj : 0
+        lat += (1..3).cover?(terminal) ? adj : 0
+        lat -= (5..7).cover?(terminal) ? adj : 0
 
         adj *= Math.cos(37.615223*Math::PI/180) 
-        lng += (3..5).include?( terminal) ? adj : 0
+        lng += (3..5).cover?( terminal) ? adj : 0
         lng -= [1,7,8].include?(terminal) ? adj : 0
 
-        g = Location.new(name:"Gate #{gate}#{number}", kind:'gate')
+        g     = Location.new(name:"Gate #{gate}#{number}", kind:'gate')
         g.gps = LocationGps.make(location: g, lat: lat, lng: lng)
-        g.beacons.push LocationBeacon.make(company: @sprocketCo, location: g)
-        g.beacons.push LocationBeacon.make(company: @widgetCo, location: g)
+        g.beacons.push LocationBeacon.make(company: airport.companies.first, location: g)
+        g.beacons.push LocationBeacon.make(company: airport.companies.second, location: g)
         t.child_locations.push g
       end
+      airport.child_locations.push t
     end
-    @airport.save!
-    @airport
+    airport
+  end
+
+  def test_companies
+    [Company.find_by_name("Sprockets") || Company.make(name:'Sprockets'),
+    Company.find_by_name("Widgets")   || Company.make(name:'Widgets')]
   end
 end

data/spec/support/request_helpers.rb

@@ -1,9 +1,7 @@
 require 'introspective_grape/camel_snake'
 module RequestHelpers
-  include IntrospectiveGrape::CamelSnake 
-
   def json
-    @json ||= snake_keys(JSON.parse(response.body))
+    @json ||= JSON.parse(response.body).with_snake_keys(true)
   end
 
   def with_authentication(role=:superuser)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: introspective_grape
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.9
 platform: ruby
 authors:
 - Josh Buermann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-25 00:00:00.000000000 Z
+date: 2016-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,70 +16,76 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: grape
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.16.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.16.2
 - !ruby/object:Gem::Dependency
-  name: grape
+  name: grape-entity
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
-  name: grape-entity
+  name: grape-swagger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
-  name: grape-swagger
+  name: grape-kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.4
+        version: 0.1.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.4
+        version: 0.1.9
 - !ruby/object:Gem::Dependency
   name: pundit
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +100,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: camel_snake_keys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -154,16 +174,16 @@ dependencies:
   name: paperclip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: machinist
   requirement: !ruby/object:Gem::Requirement
@@ -228,8 +248,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
 - README.md
@@ -243,15 +267,21 @@ files:
 - app/views/.keep
 - bin/rails
 - introspective_grape.gemspec
+- lib/.DS_Store
 - lib/introspective_grape.rb
 - lib/introspective_grape/api.rb
 - lib/introspective_grape/camel_snake.rb
+- lib/introspective_grape/filters.rb
+- lib/introspective_grape/formatter/camel_json.rb
+- lib/introspective_grape/helpers.rb
+- lib/introspective_grape/traversal.rb
 - lib/introspective_grape/version.rb
 - lib/tasks/introspective_grape_tasks.rake
+- spec/.DS_Store
 - spec/dummy/Gemfile
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
-- spec/dummy/app/api/active_record_helpers.rb
+- spec/dummy/app/api/.DS_Store
 - spec/dummy/app/api/api_helpers.rb
 - spec/dummy/app/api/dummy/chat_api.rb
 - spec/dummy/app/api/dummy/company_api.rb
@@ -421,7 +451,7 @@ test_files:
 - spec/dummy/Gemfile
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
-- spec/dummy/app/api/active_record_helpers.rb
+- spec/dummy/app/api/.DS_Store
 - spec/dummy/app/api/api_helpers.rb
 - spec/dummy/app/api/dummy/chat_api.rb
 - spec/dummy/app/api/dummy/company_api.rb

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

@@ -1,17 +0,0 @@
-# Duck-type some helper class methods into our ActiveRecord models to
-# allow us to configure API behaviors granularly, at the model level.
-class ActiveRecord::Base
-  class << self
-    @@api_actions ||= [:index,:show,:create,:update,:destroy,nil]
-    def api_actions; @@api_actions; end
-
-    def exclude_actions(*args) # Do not define endpoints for these actions
-      raise "#{self.name} defines invalid exclude_actions: #{args-@@api_actions}" if (args.flatten-@@api_actions).present?
-      @exclude_actions = args.present? ? args.flatten : @exclude_actions || []
-    end
-
-    def default_includes(*args) # Eager load these associations.
-      @default_includes = args.present? ? args.flatten : @default_includes || []
-    end
-  end
-end