g5_updatable 0.20.3.pre.1 → 1.0.2.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fff24c03cbb209168e956147a0266737b9bcfba9
-  data.tar.gz: b459baf96623cb716ed624e606307f1712359d40
+  metadata.gz: 93beab4174e49a498235996df13b1bc146415102
+  data.tar.gz: 4a7f6ceff1db6fb48aa3182b4504f78bfed7603f
 SHA512:
-  metadata.gz: fccf2277a17f67d1c7945ef14c90084b60eb11d42e5937352b4cefe52b45fa79d704f857329593df4bddf78a3571d0987b4b731bf0424d1e30c1e7b1ce35e825
-  data.tar.gz: c550dc2f70ec537c76570849bc2f54b637367b5ad5c9c55bf59dae1bae1d1d2acf99adb11b97ef4d97b70993a50ebd74829106e3e7028056be686db8af4aac0c
+  metadata.gz: efe5b305ac002832bcf559a2626da2dbd830d2221c52c5442bd993cd70787e7a2ad3ebea0f6691aa46e30f1585fa7e5eb1ae7c9c5389b16eee2e8dd61052eba0
+  data.tar.gz: e4b950c357105f6d4c008451ecab304fdb80cc0b8f700f2e917bd7d0635b239dffecba04adf47762c8a342d5dd8dd852e714346b58f53d6351e01fb3e110241e

data/README.md

@@ -1,14 +1,16 @@
 # G5 Updatable
 
-[![Gem Version](https://badge.fury.io/rb/g5_updatable.svg)](http://badge.fury.io/rb/g5_updatable)
-[![Build Status](https://travis-ci.org/G5/g5_updatable.png?branch=master)](https://travis-ci.org/G5/g5_updatable)
-
 G5 Updatable provides a solution for automatic updates of client and location
 data when modified or created in the G5 Hub.
 
 ## Requirements
 
-G5 Updatable makes use of PostgrSQL's `json` field type, and so only supports implementing apps that also use PostgreSQL.
+G5 Updatable makes use of PostgreSQL's `json` field type, and so only supports
+apps that also use PostgreSQL.
+
+Compatible with rails 4.x : Use version 0.x
+
+Compatible with rails 5.x : Use version >= 1.0.0
 
 ## Installation
 
@@ -18,12 +20,13 @@ G5 Updatable makes use of PostgrSQL's `json` field type, and so only supports im
    gem 'g5_updatable'
    ```
 
-2. And then execute:
+1. And then execute:
 
    ```console
    bundle
    ```
-3. Run the generator.
+
+1. Run the generator.
 
    ```ruby
    rails g g5_updatable:install
@@ -31,12 +34,19 @@ G5 Updatable makes use of PostgrSQL's `json` field type, and so only supports im
 
    This mounts the engine at `/g5_updatable`.
 
-3. And copy the engine's migrations to your application:
+1. And copy the engine's migrations to your application:
 
-  ```console
+   ```console
     rake g5_updatable:install:migrations
-  ```
-3. Optional: load all of G5-Hub's data into your database
+   ```
+1. Run the schema AND data migrations:
+
+    ```console
+      rake db:migrate
+      rake g5_updatable:data_migration
+    ```
+
+2. Optional: load all of G5-Hub's data into your database
 
   **Important:** The entries.js and entries.json endpoint on the hub are deprecated. So, for all versions of g5_updatable before 0.17.0, this task will only load the newest 10 clients. If you would like to load all clients, please specify "~> 0.17.0" or higher in your Gemfile.
 
@@ -79,6 +89,7 @@ end
 
 Also optionally expect a secondary block argument, receiving the object previous to be updated
 ... you know.. For diff reasons.
+
 ```ruby
 G5Updatable::LocationsUpdater.on_update do |g5_updatable_location, before_update_location|
   puts "G5Updatable::Location##{before_update_location.properties} changed to "
@@ -110,6 +121,11 @@ end
 
 It provides a `#location` method that will fetch the correct location.
 
+### Dependencies
+
+Versions >= 0.28.0 include Sidekiq as a dependency so that feed processing can be
+handled asynchronously instead of in the context of a web request. Note that we assume a queue of ```g5_updatable``` is present and that applications with custom queues should make sure to include one by that name, which can be prioritized per app as needed.
+
 ### Spec Helpers
 
 The engine provides a helper files that can be included in your project to bring in some testing support. Currently this is limited to (some factory definitions)[https://github.com/G5/g5_updatable/blob/active-record-up-in-here/lib/g5_updatable/rspec/factories.rb]. In rspec you can add the following line to your `spec/spec_helper.rb`:
@@ -118,9 +134,9 @@ The engine provides a helper files that can be included in your project to bring
 require 'g5_updatable/rspec'
 ```
 
-### FactoryGirl Factories
+### FactoryBot Factories
 
-For easier testing, if your app uses `FactoryGirl`, you can get access to factories by `require "g5_updatable/factories"`.
+For easier testing, if your app uses `FactoryBot`, you can get access to factories by `require "g5_updatable/factories"`.
 
 ## Authors
 
@@ -143,17 +159,29 @@ If you find bugs, have feature requests or questions, please
 ## Specs
 
 The `database.yml` for the dummy app must be created and modified to match your
-PostgreSQL configuration. If you are using the [G5 Orion
-Vagrant](https://github.com/G5/g5-orion-vagrant) image, the sample file should
-just work. You can copy it into place with:
-```bash
-$ cp spec/dummy/config/database.sample.yml spec/dummy/config/database.yml
+PostgreSQL configuration. You can copy it into place with:
+
+```console
+cp spec/dummy/config/database.sample.yml spec/dummy/config/database.yml
+```
+
+Set up the test database for the first time:
+
+```console
+bundle exec rake db:test:setup
+```
+
+Run specs:
+
+```console
+bundle exec rspec spec
 ```
 
-Run specs via `rspec` with:
+If you add a migration, make sure you apply it to the dummy app and commit the
+changes to spec/dummy/db/schema.rb:
 
-```bash
-$ rspec spec
+```console
+bundle exec rake app:db:migrate RAILS_ENV=test
 ```
 
 ## License

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -14,7 +16,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
 load 'rails/tasks/engine.rake'
 
 Bundler::GemHelper.install_tasks
@@ -22,9 +24,32 @@ Bundler::GemHelper.install_tasks
 require 'rspec/core'
 require 'rspec/core/rake_task'
 
-Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each { |f| load f }
+
+namespace :db do
+  namespace :test do
+    desc 'Set up a new test database'
+    task :setup do
+      Rails.env = 'test'
+      Rake::Task['app:db:create'].invoke
+      Rake::Task['app:db:migrate'].invoke
+    end
+
+    desc 'Drop the test database'
+    task :drop do
+      Rails.env = 'test'
+      Rake::Task['app:db:drop'].invoke
+    end
+  end
+end
 
-desc "Run all specs in spec directory (excluding plugin specs)"
+desc 'Set up test db and run all specs'
+RSpec::Core::RakeTask.new(spec: 'db:test:setup')
+task default: :spec
 
-RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
-task :default => :spec
+namespace :spec do
+  desc 'Run tests and clean up the db afterwards'
+  task clean: :spec do
+    Rake::Task['db:test:drop'].invoke
+  end
+end

data/app/concerns/g5_updatable/first_class_properties.rb

@@ -13,7 +13,7 @@ module G5Updatable::FirstClassProperties
 protected
 
   def define_methods_for_properties
-    return unless properties.present?
+    return unless has_attribute?(:properties) && properties.present?
 
     properties.each do |key, value|
       next if respond_to?(key)

data/app/controllers/g5_updatable/base_updatable_controller.rb

@@ -1,6 +1,4 @@
 module G5Updatable
   class BaseUpdatableController < ActionController::Base
-    skip_before_filter :authenticate_user!
-    skip_before_filter :verify_authenticity_token
   end
 end

data/app/controllers/g5_updatable/feed_controller.rb

@@ -1,6 +1,6 @@
 class G5Updatable::FeedController < G5Updatable::BaseUpdatableController
   def update
-    G5Updatable::ClientFeedProcessor.new(params).work
+    G5Updatable::ClientFeedProcessorWorker.perform_async(client_uid: params[:client_uid], location_uid: params[:location_uid])
     render json: {}, status: :ok
   end
 end

data/app/controllers/g5_updatable/syncs_controller.rb

@@ -1,6 +1,6 @@
 class G5Updatable::SyncsController < G5Updatable::BaseUpdatableController
 
-  before_filter :set_client
+  before_action :set_client
 
   def index
     timestamp = @client.locations.max_updated_at
@@ -16,4 +16,4 @@ class G5Updatable::SyncsController < G5Updatable::BaseUpdatableController
   def formatted_timestamp(timestamp)
     timestamp.in_time_zone.strftime("%I:%M%P on %B %e, %Y") if timestamp
   end
-end
+end

data/{lib → app/lib}/g5_updatable/all_client_urns_fetcher.rb

@@ -1,7 +1,8 @@
 module G5Updatable
   class AllClientUrnsFetcher
     def self.fetch_uids
-      G5Updatable::Fetcher.get_with_token(url)['clients'].collect do |urn|
+      return unless urns = G5Updatable::Fetcher.get_with_token(url).try(:[], 'clients')
+      urns.collect do |urn|
         "#{hub_url}/clients/#{urn['urn']}.json"
       end
     end

data/{lib → app/lib}/g5_updatable/client_feed_processor.rb

@@ -32,11 +32,13 @@ class G5Updatable::ClientFeedProcessor
   private
 
   def update_location
-    G5Updatable::LocationsUpdater.new(location_hash).update
+    return unless update_params = location_hash
+    G5Updatable::LocationsUpdater.new(update_params).update
   end
 
   def update_client
-    G5Updatable::ClientUpdater.new(client_hash).update
+    return unless update_params = client_hash
+    G5Updatable::ClientUpdater.new(update_params).update
   end
 
   def client_hash

data/{lib → app/lib}/g5_updatable/fetcher.rb

@@ -3,8 +3,11 @@ module G5Updatable
     extend ::G5AuthenticationClient::AuthTokenHelper
 
     def self.get_with_token(url)
+      url = self.url_for_env(url)
       response = do_with_username_pw_access_token do |access_token|
-        ::HTTParty.get(url, { query:   { access_token: access_token },
+        query = { access_token: access_token, updatable_version: G5Updatable::VERSION }
+        query[:updatable_referer] = ENV['HEROKU_APP_NAME'] unless ENV['HEROKU_APP_NAME'].blank?
+        ::HTTParty.get(url, { query:   query,
                               headers: { 'Content-Type' => 'application/json',
                                          'Accept'       => 'application/json' } })
       end
@@ -13,10 +16,16 @@ module G5Updatable
         when 200
           JSON.parse(response.body)
         when 404
-          raise "Couldn't find record at URL '#{url}'"
+          Rails.logger.warn "Couldn't find record at URL '#{url}'"
+          return {}
         else
           raise "I got an unexpected response code '#{response.code}'"
       end
     end
+
+    def self.url_for_env(url)
+      return url.gsub(/(http|https):\/\/([a-zA-Z0-9-]*\.)+[a-zA-Z0-9]+/, ENV['HUB_URL']) if ENV['HUB_URL'].present?
+      url
+    end
   end
-end
+end

data/{lib → app/lib}/g5_updatable/locations_updater.rb

@@ -39,7 +39,10 @@ class G5Updatable::LocationsUpdater
     before_update_object = location.dup
     is_new_loc           = location.new_record?
 
-    amenities = attributes.delete(:amenities)
+    amenities          = attributes.delete(:amenities)
+    points_of_interest = attributes.delete(:points_of_interest)
+    hour_sets          = attributes.delete(:hour_sets)
+    special_dates      = attributes.delete(:special_dates)
     location.update_attributes!(
         uid:        attributes[:uid],
         name:       attributes[:name],
@@ -50,6 +53,9 @@ class G5Updatable::LocationsUpdater
         updated_at: Time.now
     )
     create_amenities(amenities, location)
+    create_points_of_interest(points_of_interest, location)
+    create_hour_sets(hour_sets, location)
+    create_special_dates(special_dates, location)
     self.class.on_create_callbacks.each { |cb| cb.call(location) } if is_new_loc
     self.class.on_update_callbacks.each { |cb| cb.call(location, before_update_object) }
   end
@@ -63,6 +69,41 @@ class G5Updatable::LocationsUpdater
     location.refresh_flat_amenity_names!
   end
 
+  def create_points_of_interest(poi_hashes, location)
+    location.points_of_interest.delete_all
+    return if poi_hashes.blank?
+    poi_hashes.each do |poi_hash|
+      location.points_of_interest.create(poi_hash.except(:id, :location_id))
+    end
+  end
+
+  def create_hour_sets(hour_set_hashes, location)
+    location.hour_sets.destroy_all
+    return if hour_set_hashes.blank?
+    hour_set_hashes.each do |hour_set_hash|
+      attributes = hour_set_hash.dup
+      week_days = attributes.delete(:week_days)
+      special_dates = attributes.delete(:special_dates)
+      hour_set = location.hour_sets.create(attributes.except(:id, :location_id))
+      create_week_days(week_days, hour_set)
+    end
+  end
+
+  def create_week_days(week_day_hashes, hour_set)
+    return if week_day_hashes.blank?
+    week_day_hashes.each do |week_day_hash|
+      hour_set.week_days.create(week_day_hash.except(:id, :hour_set_id))
+    end
+  end
+
+  def create_special_dates(special_date_hashes, location)
+    location.special_dates.destroy_all
+    return if special_date_hashes.blank?
+    special_date_hashes.each do |special_date_hash|
+      location.special_dates.create(special_date_hash.except(:id))
+    end
+  end
+
   def create_or_update_amenity(amenity_hash)
     amenity = G5Updatable::HubAmenity.where(external_id: amenity_hash[:id]).first_or_create
     if amenity.name != amenity_hash[:name] || amenity.icon != amenity_hash[:icon]

data/app/lib/g5_updatable/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module G5Updatable
+  VERSION = '1.0.1'
+end

data/app/models/g5_updatable/client.rb

@@ -10,5 +10,16 @@ module G5Updatable
     })
 
     validates :uid, :urn, presence: true, uniqueness: true
+
+    CENTRALIZED_CLS_URL_PROPERTY = 'centralized_cls_url'.freeze
+    CENTRALIZED_CMS_URL_PROPERTY = 'centralized_cms_url'.freeze
+
+    def centralized_cls?
+      properties[CENTRALIZED_CLS_URL_PROPERTY].present?
+    end
+
+    def centralized_cms?
+      properties[CENTRALIZED_CMS_URL_PROPERTY].present?
+    end
   end
 end

data/app/models/g5_updatable/hour_set.rb

@@ -0,0 +1,6 @@
+module G5Updatable
+  class HourSet < ActiveRecord::Base
+    belongs_to :location, foreign_key: :g5_updatable_location_id
+    has_many :week_days, dependent: :destroy
+  end
+end

data/app/models/g5_updatable/hub_amenity.rb

@@ -1,21 +1,26 @@
+# frozen_string_literal: true
+
 module G5Updatable
   class HubAmenity < ActiveRecord::Base
     validates :external_id, presence: true
     has_many :hub_amenities_locations, foreign_key: :g5_updatable_hub_amenity_id
 
-    scope :by_client_urn, -> (client_urn) {
-      joins(hub_amenities_locations: { location: :client }).
-          where('g5_updatable_clients.urn = :client_urn', client_urn: client_urn).uniq
+    scope :by_client_urn, lambda { |client_urn|
+      joins(hub_amenities_locations: { location: :client })
+        .where('g5_updatable_clients.urn = :client_urn',
+               client_urn: client_urn).distinct
     }
 
-    scope :by_client_urns, -> (client_urns) {
-      joins(hub_amenities_locations: { location: :client }).
-          where('g5_updatable_clients.urn IN (:client_urns)', client_urns: client_urns.join(',')).uniq
+    scope :by_client_urns, lambda { |client_urns|
+      joins(hub_amenities_locations: { location: :client })
+        .where('g5_updatable_clients.urn IN (:client_urns)',
+               client_urns: client_urns.join(',')).distinct
     }
 
-    scope :by_client_uid, -> (client_uid) {
-      joins(hub_amenities_locations: :location).
-          where('g5_updatable_locations.client_uid = :client_uid', client_uid: client_uid).uniq
+    scope :by_client_uid, lambda { |client_uid|
+      joins(hub_amenities_locations: :location)
+        .where('g5_updatable_locations.client_uid = :client_uid',
+               client_uid: client_uid).distinct
     }
   end
-end
+end

data/app/models/g5_updatable/location.rb

@@ -4,11 +4,17 @@ module G5Updatable
     include G5Updatable::UrnAsParameter
     include BelongsToClient
 
+    has_many :points_of_interest, foreign_key: :g5_updatable_location_id, dependent: :destroy
+    has_many :hour_sets, foreign_key: :g5_updatable_location_id, dependent: :destroy
+    has_many :week_days, through: :hour_sets, dependent: :destroy
+    has_many :special_dates, foreign_key: :g5_updatable_location_id, dependent: :destroy
     has_many :hub_amenities_locations, foreign_key: :g5_updatable_location_id, dependent: :destroy
     has_many :hub_amenities, through: :hub_amenities_locations
 
-    validates :uid, :urn, :client_uid, :client_urn, presence: true
+    validates :uid, :urn, :client_uid, presence: true
     validates :urn, uniqueness: true
+    # Only validate if the column exists, which it doesn't on older versions of this gem
+    validates :client_urn, presence: true, if: Proc.new { |l| l.respond_to? :client_urn }
 
     scope :by_client_uid, -> (client_uid) { where(client_uid: client_uid) }
     scope :by_client_urn, -> (client_urn) { where(client_urn: client_urn) }
@@ -30,7 +36,11 @@ module G5Updatable
       end
       results
     }
-    before_validation :set_client_urn, :set_client_uid
+    before_validation :set_client_urn, :set_client_uid, :set_display_name
+
+    def self.ordered_display_names_and_urns_by_client_urn(client_urn)
+      where(client_urn: client_urn).order(:display_name).select(:display_name, :urn)
+    end
 
     def refresh_flat_amenity_names!
       update_attributes(flat_amenity_names: self.class.amenity_names_to_tokenized_string(hub_amenities.collect(&:name)))
@@ -47,12 +57,6 @@ module G5Updatable
       "#{FLAT_DELIM}#{[names_array].flatten.compact.sort.join(FLAT_DELIM)}#{FLAT_DELIM}"
     end
 
-    def display_name
-      return nil unless properties
-      return properties['internal_branded_name'] if properties['internal_branded_name'].present?
-      name
-    end
-
     def neighborhoods
       [properties['neighborhood'], properties['neighborhood_2']].select(&:present?)
     end
@@ -62,7 +66,7 @@ module G5Updatable
     end
 
     def no_deploy?
-      status?("No Deploy")
+      properties['no_deploy']
     end
 
     def pending?
@@ -83,12 +87,20 @@ module G5Updatable
       !!match
     end
 
+    # Custom setter because older version of this gem don't have this attrbute
     def set_client_urn
-      self.client_urn ||= self.client_uid.split('/').last if self.client_uid
+      if self.client_uid and self.respond_to?(:client_urn)
+        self.client_urn ||= self.client_uid.split('/').last
+      end
     end
 
     def set_client_uid
       self.client_uid||= self.client.try(:uid)
     end
+
+    def set_display_name
+      branded           = properties.try(:[], 'internal_branded_name')
+      self.display_name = branded.present? ? branded : name
+    end
   end
 end