supplejack_api 1

data/spec/controllers/supplejack_api/status_controller_spec.rb

@@ -0,0 +1,120 @@
+# The majority of the Supplejack API code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# One component is a third party component. See https://github.com/DigitalNZ/supplejack_api for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ and
+# the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+require 'spec_helper'
+
+module SupplejackApi
+  describe StatusController, type: :controller do
+    routes { SupplejackApi::Engine.routes }
+
+    let(:logger) { double(:logger).as_null_object }
+
+    before do
+      allow(Support::StatusLogger).to receive(:logger) { logger }
+    end
+
+    describe "GET 'status'" do
+      it "returns a '200' HTTP status if both Solr and Mongo are up and running" do
+        allow(controller).to receive(:solr_up?).and_return(true)
+        allow(controller).to receive(:mongod_up?).and_return(true)
+
+        get :show
+        expect(response.status).to eq 200
+      end
+
+      it "returns a '500' HTTP response if Solr is down" do
+        allow(controller).to receive(:solr_up?).and_return(false)
+        allow(controller).to receive(:mongod_up?).and_return(true)
+
+        get :show
+        expect(response.status).to eq 500
+      end
+
+      it "returns a '500' http response if Mongo is down" do
+        allow(controller).to receive(:solr_up?).and_return(true)
+        allow(controller).to receive(:mongod_up?).and_return(false)
+
+        get :show
+        expect(response.status).to eq 500
+      end
+
+      it "logs an error message when the status call takes a long time" do
+        allow(controller).to receive(:solr_up?).and_raise(Timeout::Error)
+
+        expect(logger).to receive(:error)
+        get :show
+      end
+    end
+
+    describe "#solr_up?" do
+      it "returns true when solr is up and running" do
+        ok_xml_string = <<-EOF
+          <?xml version="1.0" encoding="UTF-8"?>
+          <response>
+            <str name="status">OK</str>
+          </response>
+        EOF
+
+        allow(RestClient).to receive(:get) { ok_xml_string }
+
+        expect(controller.send(:solr_up?)).to be_truthy
+      end
+
+      it "returns false when solr is running but failing" do
+        failed_xml_string = <<-EOF
+          <?xml version="1.0" encoding="UTF-8"?>
+          <response>
+            <str name="status">NOK</str>
+          </response>
+        EOF
+        allow(RestClient).to receive(:get) { failed_xml_string }
+
+        expect(controller.send(:solr_up?)).to be_falsey
+      end
+
+      context "solr is down" do
+        before(:each) do
+          allow(RestClient).to receive(:get).and_raise(StandardError)
+        end
+
+        it "returns false" do
+          expect(controller.send(:solr_up?)).to be_falsey
+        end
+
+        it "should log an error" do
+          expect(logger).to receive(:error)
+          controller.send(:solr_up?)
+        end
+      end
+    end
+
+    describe "#mongod_up?" do
+      it "returns true when mongod is up and running" do
+        allow(Record).to receive_message_chain(:collection, :database, :session).and_return(session)
+        expect(session).to receive(:command).with(ping: 1).and_return({"ok" => 1})
+
+        expect(controller.send(:mongod_up?)).to be_truthy
+      end
+
+      context "mongod is down" do
+        before(:each) do
+          allow(Record).to receive_message_chain(:collection, :database, :session).and_return(session)
+          expect(session).to receive(:command).with(ping: 1).and_return(nil)
+        end
+
+        it "returns false" do
+          expect(controller.send(:mongod_up?)).to be_falsey
+        end
+
+        it "should log an error" do
+          expect(logger).to receive(:error)
+          controller.send(:mongod_up?)
+        end
+      end
+    end
+  end
+end

data/spec/controllers/supplejack_api/user_sets_controller_spec.rb

@@ -0,0 +1,233 @@
+# The majority of the Supplejack API code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# One component is a third party component. See https://github.com/DigitalNZ/supplejack_api for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ and
+# the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+require 'spec_helper'
+
+module SupplejackApi
+  describe UserSetsController, type: :controller do
+    routes { SupplejackApi::Engine.routes }
+
+    before(:each) do
+      @user = FactoryGirl.create(:user, authentication_token: "abc123")
+      allow(RecordSchema).to receive(:roles) { { admin: double(:admin, admin: true) } }
+      allow(controller).to receive(:authenticate_user!) { true }
+      allow(controller).to receive(:current_user) { @user }
+    end
+
+    describe "GET 'index'" do
+      before(:each) do
+        @sets = [FactoryGirl.build(:user_set)]
+      end
+
+      it "should return all the user's sets" do
+        expect(controller.current_user).to receive(:user_sets){@sets}
+        get :index
+      end
+    end
+
+    describe "GET 'admin_index'" do
+      context "authentication succeeded" do
+        before :each do
+          allow(controller).to receive(:authenticate_admin!) { true }
+          @normal_user = double(User, user_sets: []).as_null_object
+          allow(User).to receive(:find_by_api_key).with("nonadminkey") { @normal_user }
+        end
+
+        it "authenticates the user as an admin" do
+          expect(controller).to receive(:authenticate_admin!) { true }
+          get :admin_index, user_id: "nonadminkey"
+        end
+
+        it "finds the user from the :user_id" do
+          expect(User).to receive(:find_by_api_key).with("nonadminkey")
+          get :admin_index, user_id: "nonadminkey"
+        end
+
+        it "assigns the user's sets to @user_sets" do
+          expect(@normal_user).to receive(:user_sets) { [] }
+          get :admin_index, user_id: "nonadminkey"
+          expect(assigns(:user_sets)).to eq []
+        end
+
+        it "renders a error when the user is not found" do
+          allow(User).to receive(:find_by_api_key) { nil }
+          get :admin_index, user_id: "whatever"
+          expect(response.code).to eq "404"
+          expect(response.body).to eq({errors: "The user with api key: 'whatever' was not found"}.to_json)
+        end
+      end
+
+      context "authentication fails" do
+        it "renders a error when the admin authentication fails" do
+          allow(controller).to receive(:current_user) { double(:developer, admin?: false, role: 'developer') }
+          get :admin_index, user_id: "nonadminkey", format: "json"
+          expect(response.code).to eq "403"
+          expect(response.body).to eq({errors: "You need Administrator privileges to perform this request"}.to_json)
+        end
+      end
+    end
+
+    describe "#public_index" do
+      context "authentication succedded" do
+        before :each do
+          allow(controller).to receive(:authenticate_admin!) { true }
+          @admin_user = double(User).as_null_object
+          allow(controller).to receive(:current_user) { @admin_user }
+        end
+
+        it "finds all public sets" do
+          expect(UserSet).to receive(:public_sets).with(page: nil) { [] }
+          get :public_index, format: "json"
+        end
+      end
+    end
+
+    describe "#featured_sets_index" do
+      context "authentication succedded" do
+        before :each do
+          allow(controller).to receive(:authenticate_admin!) { true }
+          @admin_user = double(User).as_null_object
+          allow(controller).to receive(:current_user) { @admin_user }
+        end
+
+        it "finds 4 public sets" do
+          expect(UserSet).to receive(:featured_sets).with(4) { [] }
+          get :featured_sets_index, format: "json"
+        end
+      end
+    end
+
+    describe "GET 'show'" do
+      before(:each) do
+        @user_set = FactoryGirl.build(:user_set)
+      end
+
+      it "finds the @user_set" do
+        expect(UserSet).to receive(:custom_find).with(@user_set.id.to_s) { @user_set }
+        get :show, id: @user_set.id.to_s
+      end
+
+      it "returns a 404 error when the set is not found" do
+        allow(UserSet).to receive(:custom_find) { nil }
+        get :show, id: @user_set.id.to_s
+        expect(response.code).to eq("404")
+        expect(response.body).to eq({errors: "Set with id: #{@user_set.id.to_s} was not found."}.to_json)
+      end
+    end
+
+    describe "POST 'create'" do
+      before(:each) do
+        @user_set = FactoryGirl.build(:user_set)
+        allow(controller.current_user.user_sets).to receive(:build) { @user_set }
+        create(:record, record_id: 12345)
+        allow(@user_set).to receive(:set_items).and_return(double(first: double(record_id: 12345)))
+      end
+
+      it "should build a new set with the params" do
+        expect(controller.current_user.user_sets).to receive(:build) { @user_set }
+        expect(@user_set).to receive(:update_attributes_and_embedded).with({"name" => "Dogs", "description" => "Ugly", "privacy" => "hidden"})
+        post :create, set: {"name" => "Dogs", "description" => "Ugly", "privacy" => "hidden"}
+      end
+
+      it "saves the user set" do
+        pending # This is broken because it doesn't create sets properly and I don't know how to make it create sets properly
+        expect(@user_set).to receive(:save).and_return(true)
+        post :create, set: {}
+      end
+
+      it "returns a 422 error when the set is invalid" do
+        allow(@user_set).to receive(:update_attributes_and_embedded) { false }
+        allow(@user_set).to receive(:errors).and_return({name: ["can't be blank"]})
+        post :create, set: {}
+        expect(response.code).to eq("422")
+        expect(response.body).to eq({errors: {name: ["can't be blank"]}}.to_json)
+      end
+
+      it "rescues from a :records format error and renders the error" do
+        allow(@user_set).to receive(:update_attributes_and_embedded).and_raise(UserSet::WrongRecordsFormat)
+        post :create, set: {}
+        expect(response.code).to eq("422")
+        expect(response.body).to eq({errors: {records: ["The records array is not in a valid format."]}}.to_json)
+      end
+    end
+
+    describe "PUT 'update'" do
+      before(:each) do
+        @user_set = FactoryGirl.create(:user_set, user_id: @user.id)
+        allow(@user_set).to receive(:update_attributes_and_embedded) { true }
+      end
+
+      context 'normal operations' do
+        before(:each) do
+          allow(controller.current_user.user_sets).to receive(:custom_find) { @user_set }
+        end
+
+        it "finds the @user_set through the user" do
+          expect(controller.current_user.user_sets).to receive(:custom_find).with(@user_set.id.to_s) { @user_set }
+          put :update, id: @user_set.id.to_s, set: {records: [{record_id: 13, position: 2}]}
+        end
+
+        it "returns a 404 error when the set is not found" do
+          allow(controller.current_user.user_sets).to receive(:custom_find) { nil }
+          put :update, id: @user_set.id.to_s
+          expect(response.code).to eq("404")
+          expect(response.body).to eq({errors: "Set with id: #{@user_set.id.to_s} was not found."}.to_json)
+        end
+
+        it "updates the attributes of the @user_set" do
+          expect(@user_set).to receive(:update_attributes_and_embedded).with({"records" => [{"record_id" => "13", "position" => "2"}]}, @user)
+          put :update, id: @user_set.id.to_s, set: {records: [{record_id: 13, position: 2}]}
+        end
+
+        it "updates the approved attribute of a @user_set" do
+          expect(@user_set).to receive(:update_attributes_and_embedded).with({"approved" => true}, @user)
+          put :update, id: @user_set.id.to_s, set: {approved: true}
+        end
+
+        it "returns a 406 error when the set is invalid" do
+          allow(@user_set).to receive(:update_attributes_and_embedded) { false }
+          allow(@user_set).to receive(:errors).and_return({name: ["can't be blank"]})
+          post :update, id: @user_set.id.to_s, set: {name: nil}
+          expect(response.code).to eq("422")
+          expect(response.body).to eq({errors: {name: ["can't be blank"]}}.to_json)
+        end
+
+        it "rescues from a :records format error and renders the error" do
+          allow(@user_set).to receive(:update_attributes_and_embedded).and_raise(UserSet::WrongRecordsFormat)
+          post :update, id: @user_set.id.to_s, set: {name: nil}
+          expect(response.code).to eq("422")
+          expect(response.body).to eq({errors: {records: ["The records array is not in a valid format."]}}.to_json)
+        end
+      end
+
+    end
+
+    describe "DELETE 'destroy'" do
+      before(:each) do
+        @user_set = FactoryGirl.create(:user_set, user_id: @user.id)
+        allow(controller.current_user.user_sets).to receive(:custom_find) { @user_set }
+      end
+
+      it "returns a 404 error when the set is not found" do
+        allow(controller.current_user.user_sets).to receive(:custom_find) { nil }
+        delete :destroy, id: @user_set.id.to_s
+        expect(response.code).to eq("404")
+        expect(response.body).to eq({errors: "Set with id: #{@user_set.id.to_s} was not found."}.to_json)
+      end
+
+      it "finds the @user_set through the user" do
+        expect(controller.current_user.user_sets).to receive(:custom_find).with(@user_set.id.to_s) { @user_set }
+        delete :destroy, id: @user_set.id.to_s, format: :json
+      end
+
+      it "deletes the user set" do
+        expect(@user_set).to receive(:destroy)
+        delete :destroy, id: @user_set.id.to_s, format: :json
+      end
+    end
+  end
+end

data/spec/controllers/supplejack_api/users_controller_spec.rb

@@ -0,0 +1,61 @@
+# The majority of the Supplejack API code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# One component is a third party component. See https://github.com/DigitalNZ/supplejack_api for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ and
+# the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+require 'spec_helper'
+
+module SupplejackApi
+  describe UsersController, type: :controller do
+    routes { SupplejackApi::Engine.routes }
+
+    let(:user) { FactoryGirl.create(:user, authentication_token: 'abc123', role: 'admin') }
+
+    describe 'GET show' do
+      it 'should assign @user' do
+        get :show, id: user.id, api_key: 'abc123', format: :json
+        expect(assigns(:user)).to eq(user)
+      end
+    end
+
+    describe 'POST create' do
+      it 'should create a new user' do
+        allow(RecordSchema).to receive(:roles) { { admin: double(:admin, admin: true) } }
+        expect(User).to receive(:create).with({ 'name' => 'Ben' }).and_return(user)
+        post :create, api_key: 'abc123', user: { name: 'Ben' }, format: 'json'
+      end
+    end
+
+    # describe 'PUT update' do
+    #   before :each do
+    #     User.stub(:custom_find) { user }
+    #   end
+
+    #   it 'should find the user' do
+    #     put :update, id: user.api_key, api_key: user.authentication_token
+    #     assigns(:user).should eq user
+    #   end
+
+    #   it 'updates the user attributes' do
+    #     user.should_receive(:update_attributes).with({'username' => 'john'})
+    #     put :update, id: user.api_key, api_key: user.authentication_token, user: {username: 'john'}
+    #   end
+    # end
+
+    # describe 'DELETE destroy' do
+    #   it 'should find the user' do
+    #     delete :destroy, id: user.id, api_key: user.authentication_token
+    #     assigns(:user).should eq user
+    #   end
+
+    #   it 'destroys the user' do
+    #     User.stub(:find) { user }
+    #     user.should_receive(:destroy)
+    #     delete :destroy, id: user.id, api_key: user.authentication_token
+    #   end
+    # end
+
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,268 @@
+# The majority of the Supplejack API code is Crown copyright (C) 2014, New Zealand Government, 
+# and is licensed under the GNU General Public License, version 3.
+# One component is a third party component. See https://github.com/DigitalNZ/supplejack_api for details. 
+# 
+# Supplejack was created by DigitalNZ at the National Library of NZ and 
+# the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.