g5_updatable 0.0.1

data/spec/dummy/tmp/pids/server.pid

@@ -0,0 +1 @@
+52393

data/spec/fabricators/client_fabricator.rb

@@ -0,0 +1,6 @@
+Fabricator :client do
+  uid { "http://foo.com" }
+  name { Faker::Name.name }
+  vertical { "Apartments" }
+  domain { "http://bar.com" }
+end

data/spec/fabricators/location_fabricator.rb

@@ -0,0 +1,9 @@
+Fabricator :location do
+  uid { Faker::Internet.url }
+  urn { "g5-cl-2398223-#{Faker::Name.name.parameterize}" }
+  name { Faker::Name.name }
+  state { Faker::Address.state_abbr }
+  city { Faker::Address.city }
+  domain { Faker::Internet.url }
+  corporate { false }
+end

data/spec/lib/g5_updatable/client_feed_processor_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+describe G5Updatable::ClientFeedProcessor do
+  let(:client_updater) { double(update: nil) }
+  let(:locations_updater) { double(update: nil) }
+
+  before do
+    allow(G5Updatable::ClientUpdater).to receive(:new) { client_updater }
+    allow(G5Updatable::LocationsUpdater).to receive(:new) { locations_updater }
+  end
+
+  describe "#work" do
+    after { described_class.new(urn).work }
+    let(:urn) { nil }
+
+    context "a nil urn" do
+      before { allow(G5Updatable).to receive(:client_identifier) { nil } }
+
+      it "does not call update on the client updater" do
+        expect(client_updater).to_not receive(:update)
+      end
+
+      it "does not call update on the locations updater" do
+        expect(locations_updater).to_not receive(:update)
+      end
+    end
+
+    context "a present urn" do
+      it "calls update on the client updater" do
+        expect(client_updater).to receive(:update)
+      end
+
+      it "calls update on the locations updater" do
+        expect(locations_updater).to receive(:update)
+      end
+    end
+  end
+end

data/spec/lib/g5_updatable/client_updater_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+describe G5Updatable::ClientUpdater do
+  let(:feed_endpoint) { "#{Rails.root}/spec/support/" }
+  let(:client_identifier) { "client_feed.html" }
+  let(:client_uid) { "#{Rails.root}/spec/support/client_feed.html" }
+  let(:g5_client) { G5Updatable::FeedMapper.new(client_identifier).client }
+  let(:updater) { described_class.new(g5_client) }
+
+  before do
+    allow(G5Updatable).to receive(:feed_endpoint) { feed_endpoint }
+    allow(G5Updatable).to receive(:client_identifier) { client_identifier }
+  end
+
+  describe "#update" do
+    let!(:client) do
+      Fabricate(:client, uid: client_uid, name: "Foo", vertical: "Self-Storage")
+    end
+
+    context "update client disabled" do
+      it "does nothing" do
+        expect(client).to_not receive(:save)
+        updater.update
+      end
+    end
+
+    context "update client enabled" do
+      before { allow(G5Updatable).to receive(:update_client) { true } }
+
+      context "default parameters" do
+        it "updates the name attribute" do
+          expect { updater.update }.to change { client.reload.name }.
+            from("Foo").to("Farmhouse")
+        end
+
+        it "does not update other attributes" do
+          expect { updater.update }.not_to change { client.reload.vertical }
+        end
+      end
+
+      context "custom parameters" do
+        before do
+          allow(G5Updatable).to receive(:client_parameters) { [:name, :vertical] }
+        end
+
+        it "updates the name attribute" do
+          expect { updater.update }.to change { client.reload.name }.
+            from("Foo").to("Farmhouse")
+        end
+
+        it "updates other attributes" do
+          expect { updater.update }.to change { client.reload.vertical }.
+            from("Self-Storage").to("Apartments")
+        end
+      end
+    end
+  end
+end

data/spec/lib/g5_updatable/feed_mapper_spec.rb

@@ -0,0 +1,115 @@
+require "spec_helper"
+
+describe G5Updatable::FeedMapper do
+  let(:feed_endpoint) { "#{Rails.root}/spec/support/" }
+
+  before { allow(G5Updatable).to receive(:feed_endpoint) { feed_endpoint } }
+
+  describe "#client" do
+    subject(:client_mapper) { described_class.new(client_identifier).client }
+
+    context "a nil identifier" do
+      let(:client_identifier) { nil }
+
+      before { allow(G5Updatable).to receive(:client_identifier) { nil } }
+
+      it "does nothing" do
+        expect(client_mapper).to be_nil
+      end
+    end
+
+    context "a given identifier" do
+      let(:client_identifier) { "client_feed.html" }
+
+      it "maps to the correct name" do
+        expect(client_mapper.name).to eq("Farmhouse")
+      end
+
+      it "maps to the correct vertical" do
+        expect(client_mapper.vertical).to eq("Apartments")
+      end
+
+      it "maps to the correct domain" do
+        expect(client_mapper.domain).to eq("http://farmhouseapartments.com/")
+      end
+
+      it "maps to the correct type" do
+        expect(client_mapper.type).to eq("MultiDomainClient")
+      end
+    end
+  end
+
+  describe "#locations" do
+    subject(:location_mapper) { described_class.new(client_identifier).locations.first }
+
+    context "a nil identifier" do
+      let(:client_identifier) { nil }
+
+      before { allow(G5Updatable).to receive(:client_identifier) { nil } }
+
+      it "does nothing" do
+        expect(location_mapper).to be_nil
+      end
+    end
+
+    context "a given identifier" do
+      let(:client_identifier) { "client_feed.html" }
+
+      it "maps to the correct urn" do
+        expect(location_mapper.urn).to eq("g5-cl-1qrcyt46-hollywood")
+      end
+
+      it "maps to the correct name" do
+        expect(location_mapper.name).to eq("Hollywood")
+      end
+
+      it "maps to the correct domain" do
+        expect(location_mapper.domain).to eq("http://www.hollywood.com/")
+      end
+
+      it "maps to the correct street_address" do
+        expect(location_mapper.street_address).to eq("4567 Storage Drive Unit 5")
+      end
+
+      it "maps to the correct state" do
+        expect(location_mapper.state).to eq("CA")
+      end
+
+      it "maps to the correct city" do
+        expect(location_mapper.city).to eq("Hollywood")
+      end
+
+      it "maps to the correct neighborhood" do
+        expect(location_mapper.neighborhood).to eq("Westwood")
+      end
+
+      it "maps to the correct postal_code" do
+        expect(location_mapper.postal_code).to eq("80229")
+      end
+
+      it "maps to the correct phone_number" do
+        expect(location_mapper.phone_number).to eq("555-555-5555")
+      end
+
+      it "maps to the correct corporate" do
+        expect(location_mapper.corporate).to eq("False")
+      end
+
+      it "maps to the correct floor_plans" do
+        expect(location_mapper.floor_plans).to eq("2 Bedroom 2 Bath, Studio")
+      end
+
+      it "maps to the correct primary_amenity" do
+        expect(location_mapper.primary_amenity).to eq("Secret Passages")
+      end
+
+      it "maps to the correct qualifier" do
+        expect(location_mapper.qualifier).to eq("Luxury")
+      end
+
+      it "maps to the correct primary_landmark" do
+        expect(location_mapper.primary_landmark).to eq("Seattle Grace Hospital")
+      end
+    end
+  end
+end

data/spec/lib/g5_updatable/locations_updater_spec.rb

@@ -0,0 +1,71 @@
+require "spec_helper"
+
+describe G5Updatable::LocationsUpdater do
+  let(:feed_endpoint) { "#{Rails.root}/spec/support/" }
+  let(:client_identifier) { "updated_client_feed.html" }
+  let(:locations) { G5Updatable::FeedMapper.new(client_identifier).locations }
+  let(:g5_location) { locations.first }
+  let(:urn) { g5_location.uid.to_s.split("/").last }
+  let(:updater) { described_class.new(locations) }
+
+  before do
+    allow(G5Updatable).to receive(:feed_endpoint) { feed_endpoint }
+    allow(G5Updatable).to receive(:client_identifier) { client_identifier }
+  end
+
+  describe "#update" do
+    let!(:location) do
+      Fabricate(:location, urn: urn, name: "Foo", neighborhood: "Eastside")
+    end
+
+    context "update locations disabled" do
+      before { allow(G5Updatable).to receive(:update_locations) { false } }
+
+      it "does not update existing locations" do
+        expect(locations).to_not receive(:save)
+        updater.update
+      end
+
+      it "creates new locations" do
+        expect { updater.update }.to change { Location.all.size }.from(1).to(2)
+      end
+    end
+
+    context "update locations enabled" do
+      context "default parameters" do
+        it "updates the name attribute" do
+          expect { updater.update }.to change { location.reload.name }.
+            from("Foo").to("Hollywood")
+        end
+
+        it "does not update other attributes" do
+          expect { updater.update }.not_to change { location.reload.neighborhood }
+        end
+
+        it "creates new locations" do
+          expect { updater.update }.to change { Location.all.size }.from(1).to(2)
+        end
+      end
+
+      context "custom parameters" do
+        before do
+          allow(G5Updatable).to receive(:location_parameters) { [:name, :neighborhood] }
+        end
+
+        it "updates the name attribute" do
+          expect { updater.update }.to change { location.reload.name }.
+            from("Foo").to("Hollywood")
+        end
+
+        it "updates other attributes" do
+          expect { updater.update }.to change { location.reload.neighborhood }.
+            from("Eastside").to("River West")
+        end
+
+        it "creates new locations" do
+          expect { updater.update }.to change { Location.all.size }.from(1).to(2)
+        end
+      end
+    end
+  end
+end

data/spec/lib/g5_updatable/version.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe G5Updatable::VERSION do
+  it "should have a version" do
+    expect(G5Updatable::VERSION).to_not be_blank
+  end
+end

data/spec/lib/generators/g5_updatable/install_generator_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+require "generators/g5_updatable/install/install_generator"
+
+describe G5Updatable::InstallGenerator, type: :generator do
+  destination File.expand_path("../../../tmp", __FILE__)
+  arguments %w()
+
+  before do
+    prepare_destination
+    setup_routes
+    run_generator
+  end
+
+  it "should copy the g5_updatable initializer" do
+    expect(destination_root).to have_structure {
+      directory "config" do
+        directory "initializers" do
+          file "g5_updatable.rb" do
+            contains "G5Updatable.setup do |config|"
+          end
+        end
+      end
+    }
+  end
+
+  it "should mount the engine" do
+    expect(destination_root).to have_structure {
+      directory "config" do
+        file "routes.rb" do
+          contains "mount G5Updatable::Engine => '/g5_updatable'"
+        end
+      end
+    }
+  end
+
+  def setup_routes
+    routes = <<-END
+      Rails.application.routes.draw do
+        resource :home, only: [:show, :index]
+
+        match "/some_path", to: "controller#action", as: :my_alias
+
+        root to: "home#index"
+      end
+    END
+    config_dir = File.join(destination_root, "config")
+
+    FileUtils.mkdir_p(config_dir)
+    File.write(File.join(config_dir, "routes.rb"), routes)
+  end
+end

data/spec/lib/generators/tmp/config/routes.rb

@@ -0,0 +1,7 @@
+      Rails.application.routes.draw do
+        resource :home, only: [:show, :index]
+
+        match '/some_path', to: 'controller#action', as: :my_alias
+
+        root to: 'home#index'
+      end

data/spec/lib/tmp/config/initializers/g5_updatable.rb

@@ -0,0 +1,25 @@
+G5Updatable.setup do |config|
+  # base path to the G5 Hub
+  #
+  #config.feed_endpoint = "..."
+
+  # identifier of the client (urn)
+  #
+  #config.client_identifier = "..."
+
+  # default is true. When set to true, existing locations in your app will be
+  # updated with any changes made to the hub. If set to false, existing locations
+  # will be skipped and only newly added locations will be created.
+  #
+  #config.update_locations = true
+
+  # default is false. When set to true, client data will update.
+  #
+  #config.update_client = false
+
+  # default is [:name]. A whitlist of parameters to create/update on the model
+  #config.location_parameters = [:name]
+
+  # default is [:name]. A whitlist of parameters to update on the model
+  #config.client_parameters = [:name]
+end

data/spec/lib/tmp/config/routes.rb

@@ -0,0 +1,8 @@
+      Rails.application.routes.draw do
+  mount G5Updatable::Engine => '/g5_updatable'
+        resource :home, only: [:show, :index]
+
+        match "/some_path", to: "controller#action", as: :my_alias
+
+        root to: "home#index"
+      end

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require 'rspec/rails'
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+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.check_pending! if defined?(ActiveRecord::Migration)
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # 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
+
+  # If true, the base class of anonymous controllers will be inferred
+  # automatically. This will be the default behavior in future versions of
+  # rspec-rails.
+  config.infer_base_class_for_anonymous_controllers = false
+
+  # 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"
+end