Throw in some unit tests for parsing services

.rspec

@@ -0,0 +1 @@
+--require spec_helper

Gemfile

@@ -22,6 +22,9 @@ gem 'bootsnap', '>= 1.1.0', require: false
 group :development, :test do
   gem 'pry'
   gem 'rspec-rails'
+  gem 'rails-controller-testing'
+  gem 'factory_bot_rails'
+  gem 'faker'
 end
 
 group :development do

Gemfile.lock

@@ -79,6 +79,13 @@ GEM
       unf (>= 0.0.5, < 1.0.0)
     erubi (1.8.0)
     execjs (2.7.0)
+    factory_bot (4.11.1)
+      activesupport (>= 3.0.0)
+    factory_bot_rails (4.11.1)
+      factory_bot (~> 4.11.1)
+      railties (>= 3.0.0)
+    faker (1.9.1)
+      i18n (>= 0.7)
     ffi (1.9.25)
     globalid (0.4.1)
       activesupport (>= 4.2.0)
@@ -140,6 +147,10 @@ GEM
       bundler (>= 1.3.0)
       railties (= 5.2.2)
       sprockets-rails (>= 2.0.0)
+    rails-controller-testing (1.0.4)
+      actionpack (>= 5.0.1.x)
+      actionview (>= 5.0.1.x)
+      activesupport (>= 5.0.1.x)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
@@ -238,6 +249,8 @@ DEPENDENCIES
   capybara (>= 2.15)
   chromedriver-helper
   coffee-rails (~> 4.2)
+  factory_bot_rails
+  faker
   haml
   jbuilder (~> 2.5)
   listen (>= 3.0.5, < 3.2)
@@ -245,6 +258,7 @@ DEPENDENCIES
   pry
   puma (~> 3.11)
   rails (~> 5.2.2)
+  rails-controller-testing
   rest-client
   rspec-rails
   sass-rails (~> 5.0)

app/controllers/pokemon_controller.rb

@@ -36,25 +36,23 @@ class PokemonController < ApplicationController
 
   def upload
     files = params[:pokemon]
-    response = PKParse::Client.new(files).parse
-
-    saved = false
+    response = pkparse.parse(files)
 
     Pokemon.transaction do
-      saved = Pokemon.create!(response.pokemon.map(&:to_h))
+      Pokemon.create!(response.pokemon.map(&:to_h))
     end
 
-    if saved
-      redirect_to pokemon_index_path
-    else
-      flash.now[:alert] = "Failed to commit the uploaded pokemon."
-      @pokemon = Pokemon.new
-      render :new
-    end
+    redirect_to pokemon_index_path
   rescue PKParse::Error => e
     flash.now[:alert] = e.message
     @pokemon = Pokemon.new
     render :new
+  rescue ActiveRecord::ActiveRecordError => e
+    PKParse.logger.error("Failed to commit parsed results:\n#{e}\n#{e.backtrace.join("\n")}")
+
+    flash.now[:alert] = "Failed to commit the uploaded pokemon."
+    @pokemon = Pokemon.new
+    render :new
   end
 
   private
@@ -64,4 +62,10 @@ class PokemonController < ApplicationController
       :id, :pokedex_number, :nickname
     )
   end
+
+  def pkparse
+    # There may be some configuration we'll provide in the future that would
+    # benefit from instantiating the client in this way
+    @pkparse_client ||= PKParse::Client.new
+  end
 end

lib/pkparse/client.rb

@@ -2,14 +2,8 @@ require 'rest-client'
 
 module PKParse
   class Client
-    attr_accessor :files
-
-    def initialize(files)
-      @files = files
-    end
-
-    def parse
-      response = RestClient.post("#{PKParse.service_url}/parse", form_key => files, multipart: true)
+    def parse(files)
+      response = RestClient.post("#{PKParse.service_url}/parse", form_key(files) => files, multipart: true)
       response = JSON.parse(response, symbolize_keys: true)
 
       PKParse::Response.new(response)
@@ -21,7 +15,7 @@ module PKParse
 
     private
 
-    def form_key
+    def form_key(files)
       # RestClient will add brackets to array form values, but go-pkparse-server
       # expects brackets regardless of multivalue or not.
       if files.size > 1

spec/controllers/pokemon_controller_spec.rb

@@ -0,0 +1,70 @@
+require 'rails_helper'
+
+RSpec.describe PokemonController, type: :controller do
+  describe "DELETE #destroy" do
+    let!(:pokemon) { FactoryBot.create(:pokemon) }
+    subject { delete :destroy, params: {id: pokemon.id} }
+
+    context "the pokemon is successfully deleted" do
+      it 'deletes the pokemon' do
+        expect{subject}.to change{Pokemon.count}.by(-1)
+        expect(response).to redirect_to pokemon_index_path
+      end
+    end
+
+    context "the pokemon is not deleted" do
+      before { allow_any_instance_of(Pokemon).to receive(:destroy).and_return(false) }
+
+      it 'does not delete the pokemon' do
+        expect{subject}.to change{Pokemon.count}.by(0)
+        expect(response).to render_template :show
+      end
+    end
+  end
+
+  describe "POST #upload" do
+    subject { post :upload, params: {pokemon: double()} }
+    let(:pokemon) { double(pokedex_number: 10, nickname: "pyukuchu", to_h: {pokedex_number: 10, nickname: "pyukuchu"}) }
+    let(:client_response) { double(pokemon: [pokemon]) }
+
+    before do
+      allow_any_instance_of(PKParse::Client).to receive(:parse).and_return(client_response)
+    end
+
+    context 'parsing succeeds' do
+      context 'committing result to database fails' do
+        before { allow(Pokemon).to receive(:create!).and_raise(ActiveRecord::ActiveRecordError.new) }
+
+        it 'does not create any new pokemon' do
+          #expect{subject}.to raise_error 'canned failure'
+          expect{(subject rescue nil)}.to change{Pokemon.count}.by(0)
+          expect(response).to render_template :new
+        end
+      end
+
+      context 'committing result to database succeeds' do
+        before do
+          allow_any_instance_of(PKParse::Client).to receive(:parse).and_return(client_response)
+        end
+
+        it 'creates some new pokemon' do
+          expect{subject}.to change{Pokemon.count}.by(1)
+          expect(response).to redirect_to pokemon_index_path
+        end
+      end
+
+    end
+
+    context 'parsing fails' do
+      before do
+        allow_any_instance_of(PKParse::Client).to receive(:parse).and_raise(PKParse::Error.new(StandardError.new))
+      end
+
+      it 'does not create any new pokemon' do
+        expect{subject}.to change{Pokemon.count}.by(0)
+        expect(controller.flash.now["alert"]).not_to be_empty
+        expect(response).to render_template :new
+      end
+    end
+  end
+end

spec/factories/pokemon.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :pokemon do
+    pokedex_number { Random.rand(151) }
+    nickname { Faker::Pokemon.name }
+  end
+end

spec/lib/pkparse/client_spec.rb

@@ -0,0 +1,35 @@
+require 'rails_helper'
+
+RSpec.describe PKParse::Client do
+  let(:client) { described_class.new }
+  let(:response) { '[{"pokedex_number":1}]' }
+
+  before { allow(RestClient).to receive(:post).and_return(response) }
+
+  describe '#parse' do
+    let!(:files) { [] }
+    subject { client.parse(files) }
+
+    context 'succeeds as normal' do
+      specify { expect(subject.pokemon.size).to eq 1 }
+    end
+
+    context 'fails' do
+      context 'getting a response' do
+        before { allow(RestClient).to receive(:post).and_raise(RestClient::Exception.new) }
+
+        it 'returns a more specific error' do
+          expect{subject}.to raise_error(PKParse::ResponseError)
+        end
+      end
+
+      context 'processing a response' do
+        before { allow(JSON).to receive(:parse).and_raise(JSON::ParserError.new) }
+        it 'returns a more specific error' do
+          expect{subject}.to raise_error(PKParse::Error)
+        end
+      end
+    end
+  end
+end
+

spec/rails_helper.rb

@@ -0,0 +1,61 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+require 'spec_helper'
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../../config/environment', __FILE__)
+# Prevent database truncation if the environment is production
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+require 'rspec/rails'
+# 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 and applies them before tests are run.
+# If you are not using ActiveRecord, you can remove these lines.
+begin
+  ActiveRecord::Migration.maintain_test_schema!
+rescue ActiveRecord::PendingMigrationError => e
+  puts e.to_s.strip
+  exit 1
+end
+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!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace("gem name")
+end

spec/spec_helper.rb

@@ -0,0 +1,96 @@
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end