ocean-rails 1.14.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef1841120052a0246a8c515f222181d460175a5e
+  data.tar.gz: e415725dd7ff365f19b8feb03c2922c1b101e41c
+SHA512:
+  metadata.gz: c744ca8f3eb1ae1b349d6c5098c579b22a86e502141ca315788fb874f7298ea3390ab62c0c561e6215ad6b7c07fa5249611363a80cc1919f01a777810913905e
+  data.tar.gz: 1f81c189825763f0de71f19df10438ae6d8d0d09b9d848091715b982b9a199fd3fcc6b6b823b84c56590da51882beb203cad5bbefed0ac9e6a8eff078d6ccbdc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,72 @@
+== The Ocean gem
+
+This repository contains the Ocean ruby gem, containing common framework functionality
+for the Ruby on Rails part of the architecture. 
+
+Ocean requires Ruby 2.0 and Ruby on Rails 4.0.0 or later.
+
+=== Documentation
+* Ocean gem API: http://rdoc.info/github/OceanDev/ocean-rails
+* Ocean framework: http://wiki.oceanframework.net
+* Ocean back end tutorial: http://wiki.oceanframework.net/index.php/Tutorial
+
+
+=== Creating an Ocean Rails app
+
+The ocean gem provides an application template and generator to quickly and easily set up 
+a complete Rails application for Ocean. Simply execute the following in your terminal:
+
+ rails new the_app_name -m https://raw.github.com/OceanDev/ocean-rails/master/template.rb
+
+Answer yes to all overwrite queries. 
+
+There is only one piece of manual setup to perform. You must supply the Ocean app with
+your site-specific data: the base domain name, the password for Auth, etc. To do this,
+simply edit <code>config/config.yml</code>. 
+
+There is also a file called <code>config.yml.example</code> in the
+same directory for reference. Don't change it: it is under version control. The file
+you should change, <code>config/config.yml</code>, isn't, as it will contain site-specific and/or
+confidential data.
+
+Verify that your setup is OK by executing
+
+ rspec
+
+All tests should pass.
+
+
+=== Creating an Ocean Resource
+
+To create an aggressively cached Ocean resource based on an SQL model, do the following:
+
+ rails g scaffold quux name:string description:string \ 
+                       lock_version:integer created_by:string updated_by:string
+
+This will create the basic model and associated model and controller scaffolding code, 
+which we will modify shortly. Now run
+
+ rake db:migrate
+
+This will create the SQL table for the resource. Next, we need to replace the HTML-centric
+scaffold code generated above with RESTful JSON scaffold code for Ocean:
+
+ rails g ocean_scaffold quux
+
+Answer yes to all overwrite queries. Now examine +config/routes.rb+. You will find a new resource
+declaration for quuxes. Move it inside the versioned scope and add and +except:+ clause to exclude
+the Rails controller actions not used in a REST Api:
+
+ scope "v1" do
+   resource :quuxes, except: [:new, :edit]
+ end
+
+To verify that everything works as it should, run the tests:
+
+ rspec
+
+All tests should pass. The test coverage should be very close to 100%. A FactoryGirl factory for the new model will be created, there will be model unit tests to check for the presence of all attributes and to verify collection searches, routing tests, controller tests for each action, and view tests to verify that the JSON representation is complete and correct.   
+
+You can now proceed to tailor the new resource to your needs. You will want to add other attributes to the model or remove some or all of the default ones; you can change the JSON representation by modifying the view; and you might want to add or remove controller actions, e.g. to support secondary collections and relations to other resources. And as you no doubt are a responsible, informed developer, you will of course do all this using TDD and/or BDD techniques.
+
+

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Ocean'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/generators/ocean_scaffold/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate ocean_scaffold Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/ocean_scaffold/ocean_scaffold_generator.rb

@@ -0,0 +1,76 @@
+class OceanScaffoldGenerator < Rails::Generators::NamedBase #:nodoc: all
+  
+  source_root File.expand_path('../templates', __FILE__)
+  
+  def extend_model
+    inject_into_class "#{Rails.root}/app/models/#{singular_name}.rb", 
+      class_name.constantize,
+      "
+  ocean_resource_model index: [:name], search: :description
+
+
+  # Relations
+
+
+  # Attributes
+
+
+  # Validations
+  
+  
+"
+  end
+  
+  def add_model_specs
+    template "model_spec.rb", "#{Rails.root}/spec/models/#{singular_name}_spec.rb"
+  end
+  
+  def remove_html_controller_specs
+    remove_file "spec/controllers/#{plural_name}_controller_spec.rb"
+  end
+  
+ def add_json_controller_specs
+    template "controller_specs/delete_spec.rb", "#{Rails.root}/spec/controllers/#{plural_name}/delete_spec.rb"
+    template "controller_specs/show_spec.rb",   "#{Rails.root}/spec/controllers/#{plural_name}/show_spec.rb"
+    template "controller_specs/index_spec.rb",  "#{Rails.root}/spec/controllers/#{plural_name}/index_spec.rb"
+    template "controller_specs/create_spec.rb", "#{Rails.root}/spec/controllers/#{plural_name}/create_spec.rb"
+    template "controller_specs/update_spec.rb", "#{Rails.root}/spec/controllers/#{plural_name}/update_spec.rb"
+  end
+  
+   def remove_html_views
+    remove_file "app/views/#{plural_name}/_form.html.erb"
+    remove_file "app/views/#{plural_name}/edit.html.erb"
+    remove_file "app/views/#{plural_name}/index.html.erb"
+    remove_file "app/views/#{plural_name}/index.json.jbuilder"
+    remove_file "app/views/#{plural_name}/new.html.erb"
+    remove_file "app/views/#{plural_name}/show.html.erb"
+    remove_file "app/views/#{plural_name}/show.json.jbuilder"
+  end
+  
+  def add_json_views
+    template "views/_resource.json.jbuilder", "#{Rails.root}/app/views/#{plural_name}/_#{singular_name}.json.jbuilder"
+  end
+  
+  def remove_html_view_specs
+    remove_file "spec/views/#{plural_name}/index.html.erb_spec.rb"
+    remove_file "spec/views/#{plural_name}/show.html.erb_spec.rb"
+    remove_file "spec/views/#{plural_name}/new.html.erb_spec.rb"
+    remove_file "spec/views/#{plural_name}/create.html.erb_spec.rb"
+    remove_file "spec/views/#{plural_name}/update.html.erb_spec.rb"
+    remove_file "spec/views/#{plural_name}/edit.html.erb_spec.rb"
+  end
+  
+  def add_json_view_spec
+    template "view_specs/_resource_spec.rb", "#{Rails.root}/spec/views/#{plural_name}/_#{singular_name}_spec.rb"
+  end
+  
+  def remove_request_specs
+    remove_file "spec/requests/#{plural_name}_spec.rb"
+  end
+  
+  def update_routing_specs
+    remove_file "spec/routing/#{plural_name}_routing_spec.rb"
+    template "resource_routing_spec.rb", "#{Rails.root}/spec/routing/#{plural_name}_routing_spec.rb"
+  end
+  
+end

data/lib/generators/ocean_scaffold/templates/controller_specs/create_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe <%= class_name.pluralize %>Controller do
+  
+  render_views
+  
+  describe "POST" do
+    
+    before :each do
+      permit_with 200
+      request.headers['HTTP_ACCEPT'] = "application/json"
+      request.headers['X-API-Token'] = "incredibly-fake!"
+      @args = build(:<%= singular_name %>).attributes
+    end
+    
+    
+    it "should return JSON" do
+      post :create, @args
+      response.content_type.should == "application/json"
+    end
+    
+    it "should return a 400 if the X-API-Token header is missing" do
+      request.headers['X-API-Token'] = nil
+      post :create, @args
+      response.status.should == 400
+    end
+    
+    it "should return a 201 when successful" do
+      post :create, @args
+      response.should render_template(partial: "_<%= singular_name %>", count: 1)
+      response.status.should == 201
+    end
+
+    it "should contain a Location header when successful" do
+      post :create, @args
+      response.headers['Location'].should be_a String
+    end
+
+    it "should return the new resource in the body when successful" do
+      post :create, @args
+      response.body.should be_a String
+    end
+    
+    #
+    # Uncomment this test as soon as there is one or more DB attributes that define
+    # the uniqueness of a record.
+    #
+    # it "should return a 422 if the <%= singular_name %> already exists" do
+    #   post :create, @args
+    #   response.status.should == 201
+    #   response.content_type.should == "application/json"
+    #   post :create, @args
+    #   response.status.should == 422
+    #   response.content_type.should == "application/json"
+    #   JSON.parse(response.body).should == {"_api_error" => ["<%= class_name %> already exists"]}
+    # end
+
+    #
+    # Uncomment this test as soon as there is one or more DB attributes that need
+    # validating.
+    #
+    # it "should return a 422 when there are validation errors" do
+    #   post :create, @args.merge('name' => "qz")
+    #   response.status.should == 422
+    #   response.content_type.should == "application/json"
+    #   JSON.parse(response.body).should == {"name"=>["is too short (minimum is 3 characters)"]}
+    # end
+                
+  end
+  
+end

data/lib/generators/ocean_scaffold/templates/controller_specs/delete_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe <%= class_name.pluralize %>Controller do
+  
+  render_views
+
+  describe "DELETE" do
+    
+    before :each do
+      permit_with 200
+      @<%= singular_name %> = create :<%= singular_name %>
+      request.headers['HTTP_ACCEPT'] = "application/json"
+      request.headers['X-API-Token'] = "so-totally-fake"
+    end
+
+    
+    it "should return JSON" do
+      delete :destroy, id: @<%= singular_name %>
+      response.content_type.should == "application/json"
+    end
+
+    it "should return a 400 if the X-API-Token header is missing" do
+      request.headers['X-API-Token'] = nil
+      delete :destroy, id: @<%= singular_name %>
+      response.status.should == 400
+    end
+    
+    it "should return a 204 when successful" do
+      delete :destroy, id: @<%= singular_name %>
+      response.status.should == 204
+      response.content_type.should == "application/json"
+    end
+
+    it "should return a 404 when the <%= class_name %> can't be found" do
+      delete :destroy, id: -1
+      response.status.should == 404
+    end
+    
+    it "should destroy the <%= class_name %> when successful" do
+      delete :destroy, id: @<%= singular_name %>
+      response.status.should == 204
+      <%= class_name %>.find_by_id(@<%= singular_name %>.id).should be_nil
+    end
+    
+  end
+  
+end

data/lib/generators/ocean_scaffold/templates/controller_specs/index_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe <%= class_name.pluralize %>Controller do
+  
+  render_views
+
+  describe "INDEX" do
+    
+    before :each do
+      permit_with 200
+      create :<%= singular_name %>
+      create :<%= singular_name %>
+      create :<%= singular_name %>
+      request.headers['HTTP_ACCEPT'] = "application/json"
+      request.headers['X-API-Token'] = "boy-is-this-fake"
+    end
+
+    
+    it "should return JSON" do
+      get :index
+      response.content_type.should == "application/json"
+    end
+    
+    it "should return a 400 if the X-API-Token header is missing" do
+      request.headers['X-API-Token'] = nil
+      get :index
+      response.status.should == 400
+      response.content_type.should == "application/json"
+    end
+    
+    it "should return a 200 when successful" do
+      get :index
+      response.status.should == 200
+      response.should render_template(partial: "_<%= singular_name %>", count: 3)
+    end
+
+    it "should return a collection" do
+      get :index
+      response.status.should == 200
+      JSON.parse(response.body).should be_an Array
+    end
+
+  end
+  
+end

data/lib/generators/ocean_scaffold/templates/controller_specs/show_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe <%= class_name.pluralize %>Controller do
+  
+  render_views
+
+  describe "GET" do
+    
+    before :each do
+      permit_with 200
+      @<%= singular_name %> = create :<%= singular_name %>
+      request.headers['HTTP_ACCEPT'] = "application/json"
+      request.headers['X-API-Token'] = "totally-fake"
+    end
+
+    
+    it "should return JSON" do
+      get :show, id: @<%= singular_name %>
+      response.content_type.should == "application/json"
+    end
+    
+    it "should return a 400 if the X-API-Token header is missing" do
+      request.headers['X-API-Token'] = nil
+      get :show, id: @<%= singular_name %>
+      response.status.should == 400
+      response.content_type.should == "application/json"
+    end
+    
+    it "should return a 404 when the user can't be found" do
+      get :show, id: -1
+      response.status.should == 404
+      response.content_type.should == "application/json"
+    end
+    
+    it "should return a 200 when successful" do
+      get :show, id: @<%= singular_name %>
+      response.status.should == 200
+      response.should render_template(partial: "_<%= singular_name %>", count: 1)
+    end
+    
+  end
+  
+end

data/lib/generators/ocean_scaffold/templates/controller_specs/update_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe <%= class_name.pluralize %>Controller do
+  
+  render_views
+
+  describe "PUT" do
+    
+    before :each do
+      permit_with 200
+      request.headers['HTTP_ACCEPT'] = "application/json"
+      request.headers['X-API-Token'] = "incredibly-fake!"
+      @u = create :<%= singular_name %>
+      @args = @u.attributes
+    end
+     
+
+    it "should return JSON" do
+      put :update, @args
+      response.content_type.should == "application/json"
+    end
+    
+    it "should return a 400 if the X-API-Token header is missing" do
+      request.headers['X-API-Token'] = nil
+      put :update, @args
+      response.status.should == 400
+    end
+
+    it "should return a 404 if the resource can't be found" do
+      put :update, id: -1
+      response.status.should == 404
+      response.content_type.should == "application/json"
+    end
+
+    it "should return a 422 when resource properties are missing (all must be set simultaneously)" do
+      put :update, id: @u.id
+      response.status.should == 422
+      response.content_type.should == "application/json"
+    end
+
+    it "should return a 409 when there is an update conflict" do
+      @u.update_attributes!({:updated_at => 1.week.from_now}, :without_protection => true)
+      put :update, @args
+      response.status.should == 409
+    end
+        
+    it "should return a 200 when successful" do
+      put :update, @args
+      response.status.should == 200
+      response.should render_template(partial: "_<%= singular_name %>", count: 1)
+    end
+
+    it "should return the updated resource in the body when successful" do
+      put :update, @args
+      response.status.should == 200
+      JSON.parse(response.body).should be_a Hash
+    end
+
+    #
+    # Uncomment this test as soon as there is one or more DB attributes that need
+    # validating.
+    #
+    # it "should return a 422 when there are validation errors" do
+    #   put :update, @args.merge('name' => "qz")
+    #   response.status.should == 422
+    #   response.content_type.should == "application/json"
+    #   JSON.parse(response.body).should == {"name"=>["is too short (minimum is 3 characters)"]}
+    # end
+
+
+    # it "should alter the <%= singular_name %> when successful" do
+    #   @u.name.should == @args['name']
+    #   @u.description.should == @args['description']
+    #   @args['name'] = "zalagadoola"
+    #   @args['description'] = "menchikaboola"
+    #   put :update, @args
+    #   response.status.should == 200
+    #   @u.reload
+    #   @u.name.should == "zalagadoola"
+    #   @u.description.should == "menchikaboola"
+    # end
+
+  end
+  
+end