mongosteen 0.1.3 → 0.1.7

data/lib/mongosteen/actions.rb

@@ -1,5 +1,6 @@
 module Mongosteen
   module Actions
+
     # GET /resources
     def index(options={}, &block)
       super do |success, failure|
@@ -7,6 +8,7 @@ module Mongosteen
       end
     end
 
+
     # GET /resources/1
     def show(options={}, &block)
       super do |success, failure|
@@ -14,6 +16,7 @@ module Mongosteen
       end
     end
 
+
     # POST /resources
     def create(options={}, &block)
       super do |success, failure|
@@ -22,6 +25,7 @@ module Mongosteen
       end
     end
 
+
     # PUT /resources/1
     def update(options={}, &block)
       super do |success, failure|
@@ -29,6 +33,8 @@ module Mongosteen
         failure.json { render json: get_resource_ivar.errors, status: :unprocessable_entity }
       end
     end
+
+
   end
 end
 

data/lib/mongosteen/base_helpers.rb

@@ -1,13 +1,8 @@
-# List of dependencies:
-#  - inherited_resources
-#  - has_scope
-#  - mongoid_search
-#  - kaminari
-#  - mongoid-history
-
 module Mongosteen
   module BaseHelpers
+
     protected
+
       # add support for scopes, search and pagination
       def collection
         get_collection_ivar || begin
@@ -33,6 +28,7 @@ module Mongosteen
         end
       end
 
+
       # add support for history
       def get_resource_version
         resource = get_resource_ivar
@@ -47,10 +43,13 @@ module Mongosteen
         return resource
       end
 
+
       # support for json resource configuration
       def as_json_config
         self.class.as_json_config
       end
+
+
   end
 end
 

data/lib/mongosteen/class_methods.rb

@@ -1,7 +1,11 @@
 module Mongosteen
   module ClassMethods
-    def json_config(config_hash)
+
+    def json_config(config_hash={})
+      config_hash[:methods] ||= []
+      config_hash[:methods].concat(json_default_methods).uniq!
       self.as_json_config = config_hash
     end
+
   end
-end
+end

data/lib/mongosteen/permitted_params.rb

@@ -1,46 +1,15 @@
 module Mongosteen
   module PermittedParams
+
     # Permits all parameters that are sent, unless `project_params`
     # (or `smth_else_params`) defined, which is a default Rails
     # controller method for strong parameters definition.
     def params_all_permitted
-      permit_fields = []
-
-      params[resource_request_name].each do |key, value|
-        permit_fields << attr_name_or_map(key, value)
-      end
-
-      return params.require(resource_request_name).permit(permit_fields)
-    end
-
-    # Allow all sent in params attributes to be written
-    def attr_name_or_map(attr_name, val)
-      # NOTE: RECURSION is used to map all hashes in params to update nested documents
-      if val.is_a?(Hash)
-        map = {} ; map[attr_name] = []
-
-        if val.first[0] == val.first[0].to_i.to_s # check if key is an integer which means we have an array of nested objects
-
-          #val.each do |nestedObjectKey, nestedObjectValue|
-          #  nestedObjectValue.each { |arr_value_key, arr_value_value| map[attr_name] << attr_name_or_map(arr_value_key, arr_value_value) }
-          #end
-
-          val.first[1].each { |arr_value_key, arr_value_value| map[attr_name] << attr_name_or_map(arr_value_key, arr_value_value) }
-
-        else
-          val.each { |hsh_key, hsh_value| map[attr_name] << attr_name_or_map(hsh_key, hsh_value) }
-        end
-
-        return map
-      elsif val.is_a?(Array)
-        map = {} ; map[attr_name] = []
-        return map
-      else
-        return attr_name
-      end
+      return params.require(resource_request_name).permit!
     end
   end
 end
 
 
 
+

data/lib/mongosteen/version.rb

@@ -1,3 +1,3 @@
 module Mongosteen
-  VERSION = "0.1.3"
+  VERSION = "0.1.7"
 end

data/mongosteen.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/slate-studio/mongosteen'
   s.summary     = 'An easy way to add restful actions'
   s.description = <<-DESC
-Mongosteen is a library that helps to easily add restful actions to
+Mongosteen is a library that helps to easily add RESTful actions to
 mongoid models with support of search, pagination, scopes, history,
 json config.
   DESC
@@ -22,12 +22,21 @@ json config.
   s.files         = `git ls-files`.split("\n")
   s.require_paths = ['lib']
 
+  s.add_dependency('inherited_resources', '>= 1.6')   # resources
+  s.add_dependency('mongoid-history',     '>= 0.4.5') # history
   s.add_dependency('mongoid',             '>= 4.0')   # orm
-  s.add_dependency('inherited_resources', '>= 1.6')   # base actions
-  s.add_dependency('kaminari',            '>= 0.16')  # pagination
   s.add_dependency('mongoid_search',      '>= 0.3')   # search
+  s.add_dependency('kaminari',            '>= 0.16')  # pagination
   s.add_dependency('has_scope',           '>  0.5')   # scopes
-  s.add_dependency('mongoid-history',     '>= 0.4.5') # history
+
+  s.add_development_dependency('rake', [ '>= 0.8.7' ])
+
+  # automated tests
+  s.add_development_dependency 'rails', '~> 4.1.2'
+  s.add_development_dependency 'database_cleaner'
+  s.add_development_dependency 'factory_girl_rails'
+  s.add_development_dependency 'minitest-reporters'
+  s.add_development_dependency 'minitest-focus'
 end
 
 

data/test/integration/api_test.rb

@@ -0,0 +1,95 @@
+require 'test_helper'
+
+class ApiTest < Capybara::Rails::TestCase
+  test 'create test item' do
+    page.driver.post('/test_items', { test_item: { title: 'Test title', description: 'Test description'} } )
+
+    assert_equal(1, TestItem.count)
+    assert_equal('Test title', TestItem.first.title)
+    assert_equal('Test description', TestItem.first.description)
+  end
+
+  test 'update test item' do
+    TestItem.create!(title: 'Test title', description: 'Test description')
+
+    page.driver.put("/test_items/#{TestItem.first.id}", { test_item: { title: 'Test title 2', description: 'Test description 2'} })
+    assert_equal('Test title 2', TestItem.first.title)
+    assert_equal('Test description 2', TestItem.first.description)
+  end
+
+  test 'show test item' do
+    TestItem.create!(title: 'Test title', description: 'Test description')
+
+    visit "/test_items/#{TestItem.first.id}.json"
+    test_item_hash = JSON.parse(page.body)
+    assert_equal('Test title', test_item_hash["title"])
+    assert_equal('Test description', test_item_hash["description"])
+  end
+
+  test 'index test item' do
+    TestItem.create!(title: 'Test title', description: 'Test description')
+    TestItem.create!(title: 'Test title 2', description: 'Test description 2')
+
+    visit '/test_items.json'
+
+    test_item_array = JSON.parse(page.body)
+
+    assert_equal('Test title', test_item_array[0]["title"])
+    assert_equal('Test description', test_item_array[0]["description"])
+
+    assert_equal('Test title 2', test_item_array[1]["title"])
+    assert_equal('Test description 2', test_item_array[1]["description"])
+  end
+
+  test 'pagination' do
+    (0..2).each do |index|
+      TestItem.create!(title: "Test title #{index}", description: "Test description #{index}")
+    end
+
+    visit '/test_items.json?perPage=2&page=1'
+
+    test_item_array = JSON.parse(page.body)
+    assert_equal(2, test_item_array.length)
+  end
+
+  test 'search' do
+    (0..2).each do |index|
+      TestItem.create!(title: "Test title #{index}", description: "Test description #{index}")
+    end
+
+    TestItem.create!(title: "Mongosteen", description: "Mongosteen description")
+
+    visit '/test_items.json?search=Mongosteen'
+
+    test_item_array = JSON.parse(page.body)
+    assert_equal(1, test_item_array.length)
+    assert_equal('Mongosteen', test_item_array[0]['title'])
+  end
+
+  test 'scope' do
+    TestItem.create!(title: "Test title", description: "Test description")
+    TestItem.create!(title: "Test title 2", description: "Test description 2")
+
+    visit '/test_items.json?test_scope=true'
+
+    test_item_array = JSON.parse(page.body)
+    assert_equal(1, test_item_array.length)
+    assert_equal('Test title', test_item_array[0]['title'])
+  end
+
+  test 'test method' do
+    TestItem.create!(title: "Test title", description: "Test description")
+
+    visit '/test_items.json'
+
+    test_item_array = JSON.parse(page.body)
+    assert_equal('Test method', test_item_array[0]['test_method'])
+  end
+
+  test 'test permit params' do
+    page.driver.post('/test_permit_items', { test_permit_item: { title: 'Test title', description: 'Test description'} } )
+
+    assert_equal('Test title', TestPermitItem.first.title)
+    assert_equal(nil, TestPermitItem.first.description)
+  end
+end

data/test/rails_app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/rails_app/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require_tree .

data/test/rails_app/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/rails_app/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+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
+end

data/test/rails_app/app/controllers/test_items_controller.rb

@@ -0,0 +1,5 @@
+class TestItemsController < ApplicationController
+  mongosteen
+  has_scope :test_scope, type: :boolean
+  json_config methods: [ :test_method ]
+end

data/test/rails_app/app/controllers/test_permit_items_controller.rb

@@ -0,0 +1,9 @@
+class TestPermitItemsController < ApplicationController
+  mongosteen
+
+  private
+
+  def test_permit_item_params
+    params.require(:test_permit_item).permit(:title)
+  end
+end

data/test/rails_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/rails_app/app/models/test_item.rb

@@ -0,0 +1,16 @@
+class TestItem
+  include Mongoid::Document
+  include Mongoid::Search
+
+  # attributes
+  field :title,       type: String
+  field :description, type: String
+
+  scope :test_scope, -> { where title: "Test title" }
+
+  search_in :title, :description
+
+  def test_method
+    'Test method'
+  end
+end

data/test/rails_app/app/models/test_permit_item.rb

@@ -0,0 +1,7 @@
+class TestPermitItem
+  include Mongoid::Document
+
+  # attributes
+  field :title,       type: String
+  field :description, type: String
+end

data/test/rails_app/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>RailsApp</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/rails_app/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/rails_app/bin/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path("../spring", __FILE__)
+rescue LoadError
+end
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/rails_app/bin/rake

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path("../spring", __FILE__)
+rescue LoadError
+end
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/rails_app/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end