openstax_api 8.3.1 → 8.3.2

data/spec/lib/openstax/api/doorkeeper_application_includes_spec.rb

@@ -1,17 +0,0 @@
-require 'rails_helper'
-
-module OpenStax
-  module Api
-    describe DoorkeeperApplicationIncludes do
-      it 'must add methods to Doorkeeper::Application' do
-        application = Doorkeeper::Application.new
-        expect(application).to respond_to(:is_human?)
-        expect(application.is_human?).to eq(false)
-        expect(application).to respond_to(:is_application?)
-        expect(application.is_application?).to eq(true)
-        expect(application).to respond_to(:is_admin?)
-        expect(application.is_admin?).to eq(false)
-      end
-    end
-  end
-end

data/spec/lib/openstax/api/params_spec.rb

@@ -1,78 +0,0 @@
-# coding: utf-8
-require 'rails_helper'
-
-module OpenStax
-  module Api
-    describe Params do
-
-      let(:params) { {a: '1', b: 2, c: nil, d: '', e: '♥', f: true} }
-      let(:signed) { described_class.sign(params: params, secret: 'secret') }
-
-      it 'disallows blank secrets' do
-        expect{
-          described_class.sign(params: {}, secret: nil)
-        }.to raise_error(StandardError)
-      end
-
-      it 'signs and verifies' do
-        expect(signed[:timestamp]).not_to be_blank
-        expect(signed[:signature]).not_to be_blank
-
-        expect(
-          described_class.signature_and_timestamp_valid?(params: signed, secret: 'secret')
-        ).to eq true
-      end
-
-      it 'does not verify is signature does not match' do
-        signed[:signature] += "a"
-        expect(
-          described_class.signature_and_timestamp_valid?(params: signed, secret: 'secret')
-        ).to eq false
-      end
-
-      it 'does not verify if signature blank' do
-        signed[:signature] = " "
-        expect(
-          described_class.signature_and_timestamp_valid?(params: signed, secret: 'secret')
-        ).to eq false
-      end
-
-      describe "altered params" do
-
-        it 'rejects additions' do
-          expect(
-            described_class.signature_and_timestamp_valid?(
-              params: signed.merge(evil: 'yes'),
-              secret: 'secret')
-          ).to eq false
-        end
-
-        it 'rejects alterations' do
-          expect(
-            described_class.signature_and_timestamp_valid?(
-              params: signed.merge(b: 10000),
-              secret: 'secret')
-          ).to eq false
-        end
-
-        it 'rejects deletions' do
-          expect(
-            described_class.signature_and_timestamp_valid?(
-              params: signed.except(:a),
-              secret: 'secret')
-          ).to eq false
-        end
-
-      end
-
-      it 'does not verify if timestamp too long ago' do
-        expect(
-          described_class.signature_and_timestamp_valid?(params: signed,
-                                                         secret: 'secret',
-                                                         timestamp_window_width: 0.minutes)
-        ).to eq false
-      end
-
-    end
-  end
-end

data/spec/lib/openstax/api/representable_schema_printer_spec.rb

@@ -1,27 +0,0 @@
-require 'rails_helper'
-
-module OpenStax
-  module Api
-    describe RepresentableSchemaPrinter do
-      it 'must print model schemas' do
-        schema = RepresentableSchemaPrinter.json(UserRepresenter)
-        expect(schema).to include('## Schema')
-        expect(schema).to include('{#')
-        expect(schema).to include(' .schema}')
-        expect(schema).to include("<pre class='code'>")
-        expect(schema).to include('</pre>')
-        json_schema = schema.match(/<pre class='code'>([^<]*)<\/pre>/)
-        expect(JSON.parse(json_schema[1])).to eq({
-            "type" => "object",
-            "required" => [ "username" ],
-            "properties" => {
-              "username" => { "type" => "string" },
-              "name" => { "type" => "string" },
-              "email" => { "type" => "string" }
-            },
-            "additionalProperties" => false
-          })
-      end
-    end
-  end
-end

data/spec/lib/openstax/api/roar_spec.rb

@@ -1,45 +0,0 @@
-require 'rails_helper'
-
-module OpenStax
-  module Api
-    module V1
-      describe Roar do
-        let!(:controller) { OpenStax::Api::V1::ApiController.new }
-
-        it 'adds methods to ApiController instance' do
-          expect(controller).to respond_to(:standard_index)
-          expect(controller).to respond_to(:standard_search)
-          expect(controller).to respond_to(:standard_create)
-          expect(controller).to respond_to(:standard_nested_create)
-          expect(controller).to respond_to(:standard_read)
-          expect(controller).to respond_to(:standard_update)
-          expect(controller).to respond_to(:standard_destroy)
-          expect(controller).to respond_to(:standard_restore)
-          expect(controller).to respond_to(:standard_sort)
-          expect(controller).to respond_to(:render_api_errors)
-        end
-
-        context 'render_api_errors' do
-          it 'returns nil if errors is nil' do
-            expect(controller).not_to receive(:render)
-            expect(controller.render_api_errors(nil)).to be_nil
-          end
-
-          it 'returns nil if errors is empty' do
-            expect(controller).not_to receive(:render)
-            expect(controller.render_api_errors([])).to be_nil
-            expect(controller.render_api_errors({})).to be_nil
-          end
-
-          it 'returns the rendered response if there are errors' do
-            expect(controller).to receive(:render) do |options|
-              expect(options[:json]).to eq({ status: 422, errors: [{code: :error}] })
-              expect(options[:status]).to eq :unprocessable_entity
-            end
-            controller.render_api_errors(code: :error)
-          end
-        end
-      end
-    end
-  end
-end

data/spec/lib/openstax/api/routing_mapper_includes_spec.rb

@@ -1,20 +0,0 @@
-require 'rails_helper'
-
-module OpenStax
-  module Api
-    describe RoutingMapperIncludes do
-      it 'must add api method to ActionDispatch::Routing::Mapper' do
-        mapper = ActionDispatch::Routing::Mapper.new(Rails.application.routes)
-        expect(mapper).to respond_to(:api)
-        Rails.application.routes.draw do
-          api :v1 do
-            resource :dummy_models
-          end
-        end
-        route_names = Rails.application.routes.named_routes.names
-        expect(route_names).to include(:api)
-        expect(route_names).to include(:api_dummy_models)
-      end
-    end
-  end
-end

data/spec/lib/openstax_api_spec.rb

@@ -1,19 +0,0 @@
-require 'rails_helper'
-
-describe OpenStax::Api do
-  it 'is configurable' do
-    expect(OpenStax::Api.configuration).to respond_to(:user_class_name)
-    expect(OpenStax::Api.configuration).to respond_to(:current_user_method)
-    expect(OpenStax::Api.configuration).to respond_to(:routing_error_app)
-
-    expect(OpenStax::Api.configuration.user_class_name).to eq 'User'
-
-    OpenStax::Api.configure { |config| config.user_class_name = 'Test' }
-
-    expect(OpenStax::Api.configuration.user_class_name).to eq 'Test'
-
-    OpenStax::Api.configure { |config| config.user_class_name = 'User' }
-
-    expect(OpenStax::Api.configuration.user_class_name).to eq 'User'
-  end
-end

data/spec/models/openstax/api/api_user_spec.rb

@@ -1,47 +0,0 @@
-require 'rails_helper'
-
-module OpenStax
-  module Api
-    describe ApiUser do
-      let(:user) { FactoryBot.create :user }
-      let(:application) { double('Doorkeeper::Application') }
-      let(:doorkeeper_token) { double('Doorkeeper::AccessToken') }
-      let(:non_doorkeeper_user_proc) { lambda { user } }
-
-      context 'human user' do
-        let(:api_user) { ApiUser.new(nil, non_doorkeeper_user_proc) }
-        
-        it 'has a human_user but no application' do
-          expect(api_user.application).to be_nil
-          expect(api_user.human_user).to eq(user)
-        end
-      end
-
-      context 'application with human user' do
-        let(:api_user) { ApiUser.new(doorkeeper_token,
-                                     non_doorkeeper_user_proc) }
-
-        it 'has a human_user and an application' do
-          allow(doorkeeper_token).to receive(:application).and_return(application)
-          allow(doorkeeper_token).to receive(:resource_owner_id).and_return(user.id)
-
-          expect(api_user.application).to eq(application)
-          expect(api_user.human_user).to eq(user)
-        end
-      end
-
-      context 'application only' do
-        let(:api_user) { ApiUser.new(doorkeeper_token,
-                                     non_doorkeeper_user_proc) }
-
-        it 'has an application but no human_user' do
-          allow(doorkeeper_token).to receive(:application).and_return(application)
-          allow(doorkeeper_token).to receive(:resource_owner_id).and_return(nil)
-
-          expect(api_user.application).to eq(application)
-          expect(api_user.human_user).to be_nil
-        end
-      end
-    end
-  end
-end

data/spec/rails_helper.rb

@@ -1,54 +0,0 @@
-ENV["RAILS_ENV"] ||= 'test'
-
-require 'spec_helper'
-require File.expand_path("../dummy/config/environment", __FILE__)
-require 'rspec/rails'
-require 'factory_bot_rails'
-require 'faker'
-require 'squeel'
-
-# Add additional requires below this line. Rails is not loaded until this point!
-
-# Requires supporting ruby files with custom matchers and macros, etc, in
-# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
-# run as spec files by default. This means that files in spec/support that end
-# in _spec.rb will both be required and run as specs, causing the specs to be
-# run twice. It is recommended that you do not name files matching this glob to
-# end with _spec.rb. You can configure this pattern with the --pattern
-# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
-#
-# The following line is provided for convenience purposes. It has the downside
-# of increasing the boot-up time by auto-requiring all files in the support
-# directory. Alternatively, in the individual `*_spec.rb` files, manually
-# require only the support files necessary.
-#
-# Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
-
-# Checks for pending migrations before tests are run.
-# If you are not using ActiveRecord, you can remove this line.
-ActiveRecord::Migration.maintain_test_schema!
-
-RSpec.configure do |config|
-  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
-  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
-
-  # If you're not using ActiveRecord, or you'd prefer not to run each of your
-  # examples within a transaction, remove the following line or assign false
-  # instead of true.
-  # config.use_transactional_fixtures = true
-
-  # RSpec Rails can automatically mix in different behaviours to your tests
-  # based on their file location, for example enabling you to call `get` and
-  # `post` in specs under `spec/controllers`.
-  #
-  # You can disable this behaviour by removing the line below, and instead
-  # explicitly tag your specs with their type, e.g.:
-  #
-  #     RSpec.describe UsersController, :type => :controller do
-  #       # ...
-  #     end
-  #
-  # The different available types are documented in the features, such as in
-  # https://relishapp.com/rspec/rspec-rails/docs
-  config.infer_spec_type_from_file_location!
-end

data/spec/representers/openstax/api/v1/abstract_search_representer_spec.rb

@@ -1,144 +0,0 @@
-require 'rails_helper'
-
-module OpenStax
-  module Api
-    module V1
-      describe AbstractSearchRepresenter do
-
-        before(:all) do
-          100.times do
-            FactoryBot.create(:user)
-          end
-
-          User.where{name.like "% doe%"}.delete_all
-
-          john_doe = FactoryBot.create :user, name: "John Doe",
-                                               username: "doejohn",
-                                               email: "john@doe.com"
-          jane_doe = FactoryBot.create :user, name: "Jane Doe",
-                                               username: "doejane",
-                                               email: "jane@doe.com"
-          jack_doe = FactoryBot.create :user, name: "Jack Doe",
-                                               username: "doejack",
-                                               email: "jack@doe.com"
-
-          @john_hash = JSON.parse(UserRepresenter.new(john_doe).to_json)
-          @jane_hash = JSON.parse(UserRepresenter.new(jane_doe).to_json)
-          @jack_hash = JSON.parse(UserRepresenter.new(jack_doe).to_json)
-        end
-
-        it "represents search results" do
-          outputs = SearchUsers.call(query: 'last_name:dOe').outputs
-          response = JSON.parse(UserSearchRepresenter.new(outputs).to_json)
-          total_count = response['total_count']
-          items = response['items']
-
-          expect(total_count).to eq 3
-          expect(items).to include(@john_hash)
-          expect(items).to include(@jane_hash)
-          expect(items).to include(@jack_hash)
-
-          outputs = SearchUsers.call(query: 'first_name:jOhN last_name:DoE')
-                               .outputs
-          response = JSON.parse(UserSearchRepresenter.new(outputs).to_json)
-          total_count = response['total_count']
-          items = response['items']
-
-          expect(total_count).to eq 1
-          expect(items).to include(@john_hash)
-          expect(items).not_to include(@jane_hash)
-          expect(items).not_to include(@jack_hash)
-
-          outputs = SearchUsers.call(
-            query: 'first_name:JoHn,JaNe last_name:dOe'
-          ).outputs
-          response = JSON.parse(UserSearchRepresenter.new(outputs).to_json)
-          total_count = response['total_count']
-          items = response['items']
-
-          expect(total_count).to eq 2
-          expect(items).to include(@john_hash)
-          expect(items).to include(@jane_hash)
-          expect(items).not_to include(@jack_hash)
-        end
-
-        it "represents ordered results" do
-          outputs = SearchUsers.call(query: 'username:DoE',
-                                     order_by: 'cReAtEd_At AsC, iD')
-                               .outputs
-          response = JSON.parse(UserSearchRepresenter.new(outputs).to_json)
-          total_count = response['total_count']
-          items = response['items']
-
-          expect(total_count).to eq 3
-          expect(items[0]).to eq @john_hash
-          expect(items[1]).to eq @jane_hash
-          expect(items[2]).to eq @jack_hash
-
-          outputs = SearchUsers.call(query: 'username:dOe',
-                                     order_by: 'CrEaTeD_aT dEsC, Id DeSc')
-                               .outputs
-          response = JSON.parse(UserSearchRepresenter.new(outputs).to_json)
-          total_count = response['total_count']
-          items = response['items']
-
-          expect(total_count).to eq 3
-          expect(items[0]).to eq @jack_hash
-          expect(items[1]).to eq @jane_hash
-          expect(items[2]).to eq @john_hash
-        end
-
-        it "represents paginated results" do
-          user_count = User.count
-
-          outputs = SearchUsers.call(query: '').outputs
-          response = JSON.parse(UserSearchRepresenter.new(outputs).to_json)
-          total_count = response['total_count']
-          items = response['items']
-
-          expect(total_count).to eq user_count
-          expect(items.count).to eq user_count
-
-          outputs = SearchUsers.call(query: '', per_page: 20).outputs
-          response = JSON.parse(UserSearchRepresenter.new(outputs).to_json)
-          total_count = response['total_count']
-          items = response['items']
-
-          expect(total_count).to eq user_count
-          expect(items.count).to eq 20
-
-          for page in 1..5
-            outputs = SearchUsers.call(query: '',
-                                       page: page, per_page: 20).outputs
-            response = JSON.parse(UserSearchRepresenter.new(outputs).to_json)
-            total_count = response['total_count']
-            items = response['items']
-
-            expect(total_count).to eq user_count
-            expect(items.count).to eq 20
-          end
-
-          outputs = SearchUsers.call(query: '',
-                                     page: 1000, per_page: 20).outputs
-          response = JSON.parse(UserSearchRepresenter.new(outputs).to_json)
-          total_count = response['total_count']
-          items = response['items']
-
-          expect(total_count).to eq user_count
-          expect(items.count).to eq 0
-        end
-
-        it "removes duplicate search results" do
-          outputs = Hashie::Mash.new(items: [@john_hash, @john_hash, @jane_hash])
-          response = JSON.parse(UserSearchRepresenter.new(outputs).to_json)
-          total_count = response['total_count']
-          items = response['items']
-
-          expect(total_count).to eq 2
-          expect(items.count).to eq 2
-        end
-
-      end
-    end
-  end
-end