datashift_journey 0.1.2

data/spec/requests/collector/api/v1/page_state_spec.rb

@@ -0,0 +1,85 @@
+require 'rails_helper'
+
+module DatashiftJourney
+
+  describe 'Collector::PageState API' do
+
+    RSpec.configure do |config|
+      config.render_views = true
+    end
+
+    context "API" do
+
+      let(:expected_page_states) { 3 }
+
+      before :each do
+        create_list(:collector_page_state, 3)
+      end
+
+      it 'sends a list of page states' do
+
+        get '/api/v1/page_states'
+
+        json = parse(response)
+
+        # test for the 200 status-code
+        expect(response).to be_success
+
+        # check to make sure the right amount of messages are returned
+        expect(json['data'].length).to eq(expected_page_states)
+      end
+
+      it 'creates a new page state and responds with JSON body containing expected PageState' do
+        expect {
+          post '/api/v1/page_states', params: { page_state: { form_name: 'BrandNewPage' } }
+        }.to change(Collector::PageState, :count).by(1)
+
+        # test for the 200 status-code
+        expect(response).to be_success
+
+        jdata = parse_attribs(response)
+
+        expect(jdata).to have_key 'form-name'
+        expect(jdata['form-name']).to eq 'BrandNewPage'
+      end
+
+      it 'rejects badly defined page state and responds with Unprocesable entity' do
+        expect {
+          post '/api/v1/page_states', params: { page_state: {} }
+        }.to_not change(Collector::PageState, :count)
+
+        expect(response.status).to eq(422)
+
+        json = parse(response)
+
+        expect(json).to have_key 'errors'
+
+        e = json['errors'][0]
+        expect(e).to have_key "source"
+        expect(e).to have_key "detail"
+        expect(e['detail']).to eq "can't be blank"
+      end
+
+      it "should get a valid page state"  do
+        page_state = Collector::PageState.first
+        get "/api/v1/page_states/#{page_state.id}"
+        expect(response).to be_success
+        jdata = parse response
+
+        expect( page_state.id.to_s).to eq jdata['data']['id']
+        expect( page_state.form_name).to eq  jdata['data']['attributes']['form-name']
+
+        #see Rails.application.routes.default_url_options = {
+        expect( page_state_url(page_state, { host: "localhost", port: 3000 }) ).to eq jdata['data']['links']['self']
+      end
+
+      it "Should get JSON:API error block when requesting page state data with invalid ID" do
+        get '/api/v1/page_states/zzz'
+        expect(response.status).to eq(404)
+        jdata = parse response
+        expect( "Wrong ID provided").to eq  jdata['errors'][0]['detail']
+        expect( '/data/attributes/id').to eq  jdata['errors'][0]['source']['pointer']
+      end
+    end
+  end
+end

data/spec/requests/collector/api/v1/states_spec.rb

@@ -0,0 +1,28 @@
+require 'rails_helper'
+
+module DatashiftJourney
+
+  describe 'States API' do
+
+    RSpec.configure do |config|
+      config.render_views = true
+    end
+
+    context "list" do
+
+      it 'sends a list of states of current JourneyPlan model' do
+
+        get '/api/v1/states'
+
+        json = parse(response)
+
+        dump_json response
+
+        # test for the 200 status-code
+        expect(response).to be_success
+        expect(json['data']).to have_key 'states'
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,63 @@
+ENV['RAILS_ENV'] ||= 'test'
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+
+require "simplecov"
+
+SimpleCov.start do
+  add_filter "spec/factories"
+  add_filter "spec/dummy"
+  add_filter "app"
+end
+
+require 'rspec/rails'
+require 'factory_girl_rails'
+require 'capybara/rails'
+require 'capybara/rspec'
+require 'shoulda-matchers'
+require "shoulda/matchers"
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Load our Engine
+require File.expand_path("../../lib/datashift_journey",  __FILE__)
+
+RSpec.configure do |config|
+
+  config.mock_with :rspec
+  config.use_transactional_fixtures = true
+  config.infer_base_class_for_anonymous_controllers = false
+
+  config.include FactoryGirl::Syntax::Methods
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  def parse(response)
+    JSON.parse(response.body)
+  end
+
+  def parse_attribs(response)
+    JSON.parse(response.body)['data']['attributes']
+  end
+
+  def dump_json(response)
+    puts response.body
+  end
+
+end
+
+# Decorate model with helper methods required for BRANCHING in Test journey plans
+
+DatashiftJourney::Collector::Collector.class_eval do
+  def construction_demolition_value
+    'yes'
+  end
+
+  def registration_type_value
+    # carrier_dealer_sequence:
+    'carrier_dealer'
+    # broker_dealer_sequence: 'broker_dealer',
+    # carrier_broker_dealer_sequence: 'carrier_broker_dealer')
+  end
+end

data/spec/support/asserts.rb

@@ -0,0 +1,27 @@
+RSpec.configure do |_config|
+  # Set of standard checks
+  #
+  #   Is our current state == expected_state
+  #
+  def expect_state_matches(journey, expected_state, message = nil)
+    expect(journey.state_name).to eq(expected_state), message
+    expect(journey.state).to eq(expected_state.to_s), message
+    expect(journey.state?(expected_state)).to eq(true), message
+  end
+
+  # Set of standard checks
+  #
+  #   Is our current state == expected_state
+  #   We can transition to back
+  #   We can transition to next
+  #   Fire next
+  #
+  def expect_state_canback_cannext_and_next!(journey, expected_state, message = nil)
+    expect_state_matches(journey, expected_state, message)
+
+    expect(journey.can_back?).to eq(true), 'Expected can_back?  to be true'
+    expect(journey.can_next?).to eq(true), 'Expected can_next?  to be true'
+
+    journey.next!
+  end
+end

data/spec/support/mailer_macros.rb

@@ -0,0 +1,25 @@
+module MailerMacros
+
+  def last_email
+    ActionMailer::Base.deliveries.last
+  end
+
+  def last_email_text
+    ActionMailer::Base.deliveries.last.body.raw_source
+  end
+
+  # for multi-part e-mails, first need to select the correct part
+
+  def last_multipart_raw(index)
+    ActionMailer::Base.deliveries.last.parts[index].body.raw_source
+  end
+
+  def reset_email
+    ActionMailer::Base.deliveries = []
+  end
+end
+
+RSpec.configure do |config|
+  config.include(MailerMacros)
+  config.before(:each) { reset_email }
+end

data/spec/support/page_objects/base_page_object.rb

@@ -0,0 +1,77 @@
+require 'capybara/dsl'
+
+class BasePageObject
+
+  RSpec.configure do |_config|
+    # this suggested form dont seems to work for latest version of Rails/rspec
+    # config.include Rails.application.routes.url_helpers
+    # but simply using standard module inclusion does the trick
+    include Rails.application.routes.url_helpers
+
+    Rails.application.routes.default_url_options = { host: 'www.example.com' }
+  end
+
+  include RSpec::Matchers
+  include Capybara::DSL
+
+  # In RSpec the Engine routing proxy method may not be available,
+  # Use this helper to prefix Engine paths in your specs  :dsj_url_helper.page_state_path
+  #
+  def dsj_url_helper
+    DatashiftJourney::Engine.routes.url_helpers
+  end
+
+  # Default - relies on PageObject utilising the 'state' method
+  # so we can create correct journey_plan object and jump straight to right page
+  def visit_page
+    begin
+      @journey_plan ||= DatashiftJourney.journey_plan_class.new
+    rescue => e
+      puts 'WARNING -RSPEC Setup Issue - No create_related_journey_plan - '\
+           "did you call 'state :<state>' in your PageObject ?"
+      puts 'See PageObjectHelpers for more details'
+      raise e
+    end
+
+    Rails.logger.debug("RSPEC : VISITING state [#{journey_plan.state}] with #{journey_plan.inspect}")
+
+    visit dsj_url_helper.journey_plan_state_path(journey_plan.state, journey_plan)
+
+    self
+  end
+
+  def visit_state(state)
+    visit dsj_url_helper.journey_plan_state_path(state, journey_plan)
+  end
+
+  def submit
+    click_button('Continue')
+  end
+
+  def click_back_link
+    click_link(I18n.t('back'))
+  end
+
+  # Default advance - fill out page and click submit
+  # fill_page  - expect derived to define this - this should not call Submit
+  #
+  def advance_page
+    visit_page unless current_path && has_text?(self.class.on_page_text)
+    fill_page
+    submit
+    find_journey_plan
+  end
+
+  def dump
+    print page.html
+  end
+
+  # requires test has :  js: true
+  # rubocop:disable Debugger
+  def screenshot(timestamp = '%H%M%S%L')
+    file = "/tmp/rspec_po_#{Time.zone.now.strftime(timestamp)}.png"
+    save_screenshot(file, full: true)
+    puts "RSPEC created screenshot of current page #{file}"
+  end
+
+end

data/spec/swagger_helper.rb

@@ -0,0 +1,25 @@
+require 'rails_helper'
+
+RSpec.configure do |config|
+  # Specify a root folder where Swagger JSON files are generated
+  # NOTE: If you're using the rswag-api to serve API descriptions, you'll need
+  # to ensure that it's confiugred to server Swagger from the same folder
+  config.swagger_root = File.join(DatashiftJourney::Engine.root, 'spec', 'swagger')
+
+  # Define one or more Swagger documents and provide global metadata for each one
+  # When you run the 'rswag:specs:to_swagger' rake task, the complete Swagger will
+  # be generated at the provided relative path under swagger_root
+  # By default, the operations defined in spec files are added to the first
+  # document below. You can override this behavior by adding a swagger_doc tag to the
+  # the root example_group in your specs, e.g. describe '...', swagger_doc: 'v2/swagger.json'
+  config.swagger_docs = {
+    'v1/swagger.json' => {
+      swagger: '2.0',
+      info: {
+        title: 'API V1',
+        version: 'v1'
+      },
+      paths: {}
+    }
+  }
+end