hubrise_app 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c1a7fcf2cdf500f0f88f966e88a651ea31995d37de7aaae211510ad8786fa31
-  data.tar.gz: 38011db1a46d6bd19acdbf05aa79694a07022b586ee3e921e070ac0a600f9142
+  metadata.gz: edf33f7af21bacda62ed654f44074d3e15fc301736a31891e805650f4574fd6f
+  data.tar.gz: 2257043da794e990c02848bc3b4fe82434be9faa0a9f3b7264979055f1f18581
 SHA512:
-  metadata.gz: 1a045f2108e00c6287b6dabdce36221992c459af25eb69343f24dd95e6c5debb3597ebc37f427e8506a4cb5b4275626341fa53f82596a95cd8ebedd84eee6c44
-  data.tar.gz: 3d2fa4490ea440597306760a2e009275d317038755e257c83b0786ee30345ca565ab1cd9f515f4db5033e6f8e1787b5b89e87b0a6cdded807da7d7c22536edf0
+  metadata.gz: '03943e1911fd4482d11893dc81a3d1c0b34f113523865fe62df1c54f316fc9c5b677758c57f9fc8a37049f0e8be409d3ba656cb44f1729a4d056600cb665e8bb'
+  data.tar.gz: e94a7836108d8f6734107e085acc429ec05f03d01165a67fc1e2b29d8670c264ca1255d91c95ce36a55a38e603122679cc8a4b5c29765ae163c6a996573d87b7

data/README.md

@@ -1,7 +1,81 @@
 ![](https://github.com/hubrise/ruby-app/workflows/spec/badge.svg)
 
-## Customization
-To override `oauth_controller` add `controllers/hubrise_app/override/oauth_controller.rb` to the host app
+
+## Installation
+
+Refer to https://github.com/HubRise/ruby-app/tree/master/spec/dummy/ for examples
+
+1. Install the gem (`gem "hubrise_app", git: "https://github.com/HubRise/ruby-app.git"` for now)
+2. Add `hubrise_app/config.yaml`
+3. Copy migrations with `rake hubrise_app:install:migrations` and migrate
+4. Mount engine routes with `mount HubriseApp::Engine => "/"`
+5. Define `hubrise_open_path` rails route (e.g. `get :hubrise_open, to: "application#open"`)
+6. Inherit your `ApplicationController` and apply fundamental `before_actions`:
+```
+class ApplicationController < HubriseApp::ApplicationController
+  before_action :ensure_authenticated!
+  before_action :ensure_app_instance_found!
+
+  def open
+    render plain: current_user.full_name + " | " + current_app_instance.hr_id
+  end
+end
+```
+
+## Intro
+
+This gem provides a framework for a Hubrise App with a Resource Based Access.
+This means that each Hubrise User will be able to create a connection (App Instance) to multiple Accounts and Locations. And this connection will be shared with any other Hubrise User that has access to the same reseources on Hubrise side automatically.
+
+### Note
+The main app's scopes (`account_scope` and `location_scope`) must not include any kind of `profile` access. Otherwise it will make no sense to share the connection with other users.
+
+## Documentation
+
+The framework is based on 3 different Oauth Workflows: `Connect Workflow`, `Login Workflow` and `Authorize Workflow`.
+And 4 main entities: `User`, `AppInstance`, `Account`, `Location`.
+
+### Connect Workflow
+Usualy this workflow gets triggered by clicking the "Install" button from the Hubrise App Market.
+It requests the main connection with the `location_scope` or `account_scope` (which are specified by developer during app creation).
+
+Once it has been completed a new `AppInstance` gets persisted in the DB.
+`Account` and `Location` instances are being created automaticaly depending on the scope and populated from the api.
+Note: this workflow is not responsible for creating a `User` record, it **only** happens in `Login Workflow`.
+
+- If there's a user already logged in - the new app instance gets associated with this user automatically. And the user gets redirected to `hubrise_open_path` with a `app_instance_id` params.
+
+- If there's no user logged in - the `Login Workflow` is triggered right away by redirecting to login oauth url.
+
+
+Code: https://github.com/HubRise/ruby-app/tree/master/app/controllers/hubrise_app/oauth_controller/action_connect_callback.rb
+
+### Login Workflow
+Usualy this workflow gets triggered after `Connect Workflow` or by the `ensure_authenticated!` filter for any anon access.
+It requests `profile_with_email` scope.
+Once completed - a new `User` gets persisted in the DB with a profile `access_token` and redirected to `hubrise_open_path`.
+
+
+### Authorize Workflow
+This workflow gets triggered by `ensure_app_instance_found!` whenever a logged in user does not have access (or it is expired) to `AppInstance` specified by `app_instance_id` param.
+If `app_instance_id` is not specified - its considered to be a broken request and a fatal error message is shown.
+
+Note: when a user opens already installed app by clicking the button from Hubrise Manager - it opens the `open_url` (specified by developer during app creation) with a `app_instance_id` param.
+
+This `app_instance_id` param is carried on from request to request using `default_url_options`: https://github.com/HubRise/ruby-app/tree/master/app/controllers/hubrise_app/application_controller/app_instance_methods.rb#L26
+
+
+A use case:
+1. UserA installs an app for Account1 - an `AppInstance` with `hr_id=abcd` being created
+2. UserA adds UserB as a manager to Account1 (via Hubrise Manager user roles table)
+3. UserB opens the installed app by clicking the button in the dashboard. It redirects to `open_url` with `app_instance_id=abcd`
+4. UserB hits the `ensure_authenticated!` wall and agrees - a `User` record being created
+5. UserB hits the `ensure_app_instance_found!` wall and agrees - a `UserAppInstace` being created for the user and `AppInstance` with `hr_id=abcd`
+6. UserB now has access to the `AppInstance`
+
+
+## Extension
+TODO
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/hubrise_app/application_controller/app_instance_methods.rb

@@ -1,28 +1,28 @@
 module HubriseApp::ApplicationController::AppInstanceMethods
   extend ActiveSupport::Concern
   included do
-    helper_method :current_hr_app_instance
+    helper_method :current_app_instance
   end
 
   def hr_app_instance_id
     params[:app_instance_id]
   end
 
-  def current_hr_app_instance
-    if current_hr_user
-      @hr_app_instance ||= HubriseApp::Services::ResolveAppInstance.run(current_hr_user.hr_app_instances, hr_app_instance_id, self)
+  def current_app_instance
+    if current_user
+      @app_instance ||= HubriseApp::Services::ResolveAppInstance.run(current_user.app_instances, hr_app_instance_id, self)
     end
   end
 
-  def ensure_hr_app_instance_found!
+  def ensure_app_instance_found!
     if hr_app_instance_id.blank?
       render(plain: "Something went wrong. Please try to reopen from Hubrise Dashboard.")
-    elsif current_hr_app_instance.nil?
-      redirect_to(build_hubrise_oauth_authorize_url)
+    elsif current_app_instance.nil?
+      redirect_to(build_hubrise_oauth_authorize_url, allow_other_host: true)
     end
   end
 
   def default_url_options
-    super.merge(app_instance_id: hr_app_instance_id || current_hr_app_instance&.hr_id)
+    super.merge(app_instance_id: hr_app_instance_id || current_app_instance&.hr_id)
   end
 end

data/app/controllers/hubrise_app/application_controller/session_methods.rb

@@ -2,29 +2,29 @@ module HubriseApp::ApplicationController::SessionMethods
   extend ActiveSupport::Concern
   included do
     protect_from_forgery with: :reset_session
-    helper_method :current_hr_user, :logged_in?
+    helper_method :current_user, :logged_in?
   end
 
-  def login(hr_user)
-    session[:user_id] = hr_user.id
-    @current_hr_user  = hr_user
+  def login(user)
+    session[:user_id] = user.id
+    @current_user  = user
   end
 
   def logout
     session[:user_id] = nil
   end
 
-  def current_hr_user
-    @current_hr_user ||= HubriseApp::HrUser.where(id: session[:user_id]).take
+  def current_user
+    @current_user ||= User.where(id: session[:user_id]).take
   end
 
   def logged_in?
-    !!current_hr_user
+    !!current_user
   end
 
   def ensure_authenticated!
     unless logged_in?
-      redirect_to(build_hubrise_oauth_login_url)
+      redirect_to(build_hubrise_oauth_login_url, allow_other_host: true)
       return
     end
 

data/app/controllers/hubrise_app/callback_controller.rb

@@ -1,23 +1,31 @@
 module HubriseApp
   class CallbackController < ApplicationController
     skip_before_action :verify_authenticity_token
-    before_action :ensure_hr_app_instance_found!
+    before_action :ensure_app_instance_found!
+    before_action :verify_event!, only: :event
 
     include ActionEvent
     include ActionDisconnect
 
     protected
 
-    def current_hr_app_instance
-      HubriseApp::Services::ResolveAppInstance.run(HrAppInstance, params[:app_instance_id], self)
+    def current_app_instance
+      HubriseApp::Services::ResolveAppInstance.run(AppInstance, params[:app_instance_id], self)
     end
 
-    def ensure_hr_app_instance_found!
-      head(404) unless current_hr_app_instance
+    def ensure_app_instance_found!
+      head(404) unless current_app_instance
     end
 
     def event_params
-      params.require(:callback).permit!
+      params.require(:callback).permit!.to_h
+    end
+
+    def verify_event!
+      unless hubrise_gateway.valid_hmac?(request.raw_post,
+                                         request.headers["X-Hubrise-Hmac-Sha256"])
+        render(plain: "Invalid HubRise HMAC", status: 401)
+      end
     end
   end
 end

data/app/controllers/hubrise_app/oauth_controller/action_authorize_callback.rb

@@ -2,8 +2,8 @@ module HubriseApp::OauthController::ActionAuthorizeCallback
   # authorize access to specific app_instance (expirable)
   def authorize_callback
     ensure_authenticated! do
-      if current_hr_app_instance
-        HubriseApp::Services::AssignAppInstance.run(current_hr_user, current_hr_app_instance, self)
+      if current_app_instance
+        HubriseApp::Services::AssignAppInstance.run(current_user, current_app_instance, self)
         redirect_to(build_hubrise_open_url)
       else
         render(plain: "Something went wrong. Please try to reinstall the app")

data/app/controllers/hubrise_app/oauth_controller/action_connect_callback.rb

@@ -1,12 +1,12 @@
 module HubriseApp::OauthController::ActionConnectCallback
   def connect_callback
-    @hr_app_instance = HubriseApp::Services::ConnectAppInstance.run(api_client_from_oauth_code, self)
+    @app_instance = HubriseApp::Services::ConnectAppInstance.run(api_client_from_oauth_code, self)
 
     if logged_in?
-      HubriseApp::Services::AssignAppInstance.run(current_hr_user, @hr_app_instance, self)
+      HubriseApp::Services::AssignAppInstance.run(current_user, @app_instance, self)
       redirect_to(build_hubrise_open_url)
     else
-      redirect_to(build_hubrise_oauth_login_url)
+      redirect_to(build_hubrise_oauth_login_url, allow_other_host: true)
     end
   end
 end

data/app/controllers/hubrise_app/oauth_controller/action_login_callback.rb

@@ -1,7 +1,7 @@
 module HubriseApp::OauthController::ActionLoginCallback
   def login_callback
-    hr_user = HubriseApp::Refresher::User.run(api_client_from_oauth_code)
-    login(hr_user)
+    user = HubriseApp::Refresher::User.from_api_client(api_client_from_oauth_code)
+    login(user)
     redirect_to(build_hubrise_open_url)
   end
 end

data/app/controllers/hubrise_app/oauth_controller.rb

@@ -6,8 +6,10 @@ module HubriseApp
 
     protected
 
-    def current_hr_app_instance
-      @hr_app_instance ||= HubriseApp::Services::ResolveAppInstance.run(HrAppInstance, api_client_from_oauth_code.app_instance_id, self)
+    def current_app_instance
+      @app_instance ||= HubriseApp::Services::ResolveAppInstance.run(
+                          AppInstance, api_client_from_oauth_code.app_instance_id, self
+                        )
     end
 
     def api_client_from_oauth_code

data/app/lib/hubrise_app/hubrise_gateway.rb

@@ -21,7 +21,7 @@ class HubriseApp::HubriseGateway
 
   def build_api_client_from_app_instance(app_instance)
     build_api_client(
-      access_token: app_instance.hr_access_token,
+      access_token: app_instance.access_token,
       app_instance_id: app_instance.hr_id,
       account_id: app_instance.hr_account_id,
       location_id: app_instance.hr_location_id,
@@ -43,4 +43,16 @@ class HubriseApp::HubriseGateway
   def build_app_authorization_url(hr_app_instance_id, redirect_uri)
     build_api_client.build_authorization_url(redirect_uri, nil, app_instance_id: hr_app_instance_id)
   end
+
+  def valid_hmac?(body, request_hmac)
+    calculated_hmac = OpenSSL::HMAC.hexdigest(
+                        OpenSSL::Digest.new("sha256"),
+                        @config[:hubrise_client_secret],
+                        body
+                      )
+    ActiveSupport::SecurityUtils.secure_compare(
+      calculated_hmac,
+      request_hmac || ""
+    )
+  end
 end

data/app/lib/hubrise_app/refresher/account.rb

@@ -1,23 +1,15 @@
-class HubriseApp::Refresher::Account
-  REFRESH_THRESHOLD = 1.day
-
-  class << self
-    def run(hr_account, api_client)
-      return unless stale?(hr_account)
-      raise if api_client.account_id != hr_account.hr_id
-
-      hr_account.update!(
-        refreshed_at: Time.now,
-        hr_api_data: if api_client.location_id
-                       api_client.get_location(api_client.location_id).data["account"]
-                     else
-                       api_client.get_account(hr_account.hr_id).data
-                     end.except("id")
-      )
-    end
-
-    def stale?(hr_account)
-      hr_account.refreshed_at.nil? || Time.now - hr_account.refreshed_at > REFRESH_THRESHOLD
+module HubriseApp::Refresher
+  class Account < Base
+    class << self
+      def fetch_attributes(resource, api_client)
+        {
+          api_data: if api_client.location_id
+                      api_client.get_location(api_client.location_id).data["account"]
+                    else
+                      api_client.get_account(resource.hr_id).data
+                    end.except("id")
+        }
+      end
     end
   end
 end

data/app/lib/hubrise_app/refresher/app_instance.rb

@@ -1,30 +1,23 @@
-class HubriseApp::Refresher::AppInstance
-  class << self
-    def run(hr_app_instance, api_client)
-      hr_app_instance.update!(
-        hr_account: build_hr_account(api_client),
-        hr_location: build_hr_location(api_client),
-        hr_access_token: api_client.access_token,
-        hr_catalog_id: api_client.catalog_id,
-        hr_customer_list_id: api_client.customer_list_id
-      )
-    end
-
-    protected
-
-    def build_hr_account(api_client)
-      if api_client.account_id
-        hr_account = HubriseApp::HrAccount.find_or_initialize_by(hr_id: api_client.account_id)
-        HubriseApp::Refresher::Account.run(hr_account, api_client)
-        hr_account
-      end
-    end
-
-    def build_hr_location(api_client)
-      if api_client.location_id
-        hr_location = HubriseApp::HrLocation.find_or_initialize_by(hr_id: api_client.location_id)
-        HubriseApp::Refresher::Location.run(hr_location, api_client)
-        hr_location
+module HubriseApp::Refresher
+  class AppInstance < Base
+    class << self
+      def run(resource, api_client, *refresher_args)
+        resource.update!(
+          access_token: api_client.access_token,
+          account: HubriseApp::Refresher::Account.from_api_client(
+            api_client, *refresher_args
+          ),
+          location: HubriseApp::Refresher::Location.from_api_client(
+            api_client, *refresher_args
+          ),
+          catalog: HubriseApp::Refresher::Catalog.from_api_client(
+            api_client, *refresher_args
+          ),
+          customer_list: HubriseApp::Refresher::CustomerList.from_api_client(
+            api_client, *refresher_args
+          )
+        )
+        resource
       end
     end
   end

data/app/lib/hubrise_app/refresher/base.rb

@@ -0,0 +1,45 @@
+class HubriseApp::Refresher::Base
+  REFRESH_THRESHOLD = 1.day
+
+  class << self
+    def from_api_client(api_client, *args)
+      hr_id = api_client.public_send(id_key)
+      if hr_id
+        run(
+          model_factory.find_or_initialize_by(hr_id: hr_id),
+          api_client,
+          *args
+        )
+      end
+    end
+
+    def run(resource, api_client, force: false)
+      return resource if !stale?(resource) && !force
+
+      resource.update!(
+        fetch_attributes(resource, api_client).merge(
+          refreshed_at: Time.now,
+        )
+      )
+      resource
+    end
+
+    protected
+
+    def fetch_attributes(_resource, _api_client)
+      {}
+    end
+
+    def stale?(resource)
+      resource.refreshed_at.nil? || Time.now - resource.refreshed_at > REFRESH_THRESHOLD
+    end
+
+    def model_factory
+      const_get("::" + self.name.demodulize)
+    end
+
+    def id_key
+      self.name.demodulize.underscore + "_id"
+    end
+  end
+end

data/app/lib/hubrise_app/refresher/catalog.rb

@@ -0,0 +1,13 @@
+module HubriseApp::Refresher
+  class Catalog < Base
+    class << self
+      def fetch_attributes(resource, api_client)
+        {
+          api_data: api_client.get_catalog(resource.hr_id)
+                              .data
+                              .except("data", "id")
+        }
+      end
+    end
+  end
+end

data/app/lib/hubrise_app/refresher/customer_list.rb

@@ -0,0 +1,13 @@
+module HubriseApp::Refresher
+  class CustomerList < Base
+    class << self
+      def fetch_attributes(resource, api_client)
+        {
+          api_data: api_client.get_customer_list(resource.hr_id)
+                              .data
+                              .except("id")
+        }
+      end
+    end
+  end
+end

data/app/lib/hubrise_app/refresher/location.rb

@@ -1,18 +1,13 @@
-class HubriseApp::Refresher::Location
-  REFRESH_THRESHOLD = 1.day
-
-  class << self
-    def run(hr_location, api_client)
-      return unless stale?(hr_location)
-
-      hr_location.update!(
-        refreshed_at: Time.now,
-        hr_api_data: api_client.get_location(hr_location.hr_id).data.except("id")
-      )
-    end
-
-    def stale?(hr_location)
-      hr_location.refreshed_at.nil? || Time.now - hr_location.refreshed_at > REFRESH_THRESHOLD
+module HubriseApp::Refresher
+  class Location < Base
+    class << self
+      def fetch_attributes(resource, api_client)
+        {
+          api_data: api_client.get_location(resource.hr_id)
+                              .data
+                              .except("id", "account")
+        }
+      end
     end
   end
 end

data/app/lib/hubrise_app/refresher/user.rb

@@ -1,15 +1,15 @@
-class HubriseApp::Refresher::User
-  REFRESH_THRESHOLD = 1.day
-
-  class << self
-    def run(api_client)
-      api_data = api_client.get_user.data
-      HubriseApp::HrUser.find_or_initialize_by(hr_id: api_data.delete("id")).tap do |hr_user|
-        hr_user.update!(
-          refreshed_at: Time.now,
-          hr_api_data: api_data,
-          hr_access_token: api_client.access_token
-        )
+module HubriseApp::Refresher
+  class User < Base
+    class << self
+      def fetch_attributes(resource, api_client)
+        api_data = api_client.get_user.data
+        {
+          access_token: api_client.access_token,
+          email: api_data["email"],
+          first_name: api_data["first_name"],
+          last_name: api_data["last_name"],
+          locales: api_data["locales"]
+        }
       end
     end
   end

data/app/lib/hubrise_app/services/assign_app_instance.rb

@@ -1,6 +1,6 @@
 class HubriseApp::Services::AssignAppInstance
   def self.run(hr_user, hr_app_instance, _ctx)
-    HubriseApp::HrUserAppInstance.find_or_initialize_by(
+    UserAppInstance.find_or_initialize_by(
       hr_app_instance_id: hr_app_instance.hr_id,
       hr_user_id: hr_user.hr_id
     ).update!(refreshed_at: Time.now)

data/app/lib/hubrise_app/services/connect_app_instance.rb

@@ -1,7 +1,5 @@
 class HubriseApp::Services::ConnectAppInstance
   def self.run(api_client, _ctx)
-    hr_app_instance = HubriseApp::HrAppInstance.find_or_initialize_by(hr_id: api_client.app_instance_id)
-    HubriseApp::Refresher::AppInstance.run(hr_app_instance, api_client)
-    hr_app_instance
+    HubriseApp::Refresher::AppInstance.from_api_client(api_client)
   end
 end

data/app/models/account.rb

@@ -0,0 +1,2 @@
+class Account < HubriseApp::AccountBase
+end

data/app/models/app_instance.rb

@@ -0,0 +1,2 @@
+class AppInstance < HubriseApp::AppInstanceBase
+end

data/app/models/catalog.rb

@@ -0,0 +1,2 @@
+class Catalog < HubriseApp::CatalogBase
+end

data/app/models/customer_list.rb

@@ -0,0 +1,2 @@
+class CustomerList < HubriseApp::CustomerListBase
+end

data/app/models/hubrise_app/account_base.rb

@@ -0,0 +1,7 @@
+module HubriseApp
+  class AccountBase < HubriseApp::ApplicationRecord
+    self.abstract_class = true
+
+    store_accessor :api_data, :name, :currency
+  end
+end

data/app/models/hubrise_app/app_instance_base.rb

@@ -0,0 +1,10 @@
+module HubriseApp
+  class AppInstanceBase < HubriseApp::ApplicationRecord
+    self.abstract_class = true
+
+    belongs_to :account, optional: true, primary_key: :hr_id, foreign_key: :hr_account_id
+    belongs_to :location, optional: true, primary_key: :hr_id, foreign_key: :hr_location_id
+    belongs_to :catalog, optional: true, primary_key: :hr_id, foreign_key: :hr_catalog_id
+    belongs_to :customer_list, optional: true, primary_key: :hr_id, foreign_key: :hr_customer_list_id
+  end
+end

data/app/models/hubrise_app/catalog_base.rb

@@ -0,0 +1,7 @@
+module HubriseApp
+  class CatalogBase < HubriseApp::ApplicationRecord
+    self.abstract_class = true
+
+    store_accessor :api_data, :name
+  end
+end

data/app/models/hubrise_app/customer_list_base.rb

@@ -0,0 +1,7 @@
+module HubriseApp
+  class CustomerListBase < HubriseApp::ApplicationRecord
+    self.abstract_class = true
+
+    store_accessor :api_data, :name
+  end
+end

data/app/models/hubrise_app/location_base.rb

@@ -0,0 +1,11 @@
+module HubriseApp
+  class LocationBase < HubriseApp::ApplicationRecord
+    self.abstract_class = true
+
+    store_accessor :api_data, :name, :country
+
+    def timezone
+      api_data.dig("timezone", "name")
+    end
+  end
+end

data/app/models/hubrise_app/user_app_instance_base.rb

@@ -0,0 +1,12 @@
+module HubriseApp
+  class UserAppInstanceBase < HubriseApp::ApplicationRecord
+    self.abstract_class = true
+
+    belongs_to :app_instance, primary_key: :hr_id, foreign_key: :hr_app_instance_id
+
+    REFRESH_THRESHOLD = 1.day
+    def self.fresh(time: Time.now)
+      where("user_app_instances.refreshed_at > ?", time - REFRESH_THRESHOLD)
+    end
+  end
+end

data/app/models/hubrise_app/user_base.rb

@@ -0,0 +1,18 @@
+module HubriseApp
+  class UserBase < HubriseApp::ApplicationRecord
+    self.abstract_class = true
+
+    has_many :user_app_instances, -> { fresh }, primary_key: :hr_id, foreign_key: :hr_user_id
+    has_many :app_instances, through: :user_app_instances
+
+    serialize :locales
+
+    def primary_locale
+      locales.first
+    end
+
+    def full_name
+      [first_name, last_name].join(" ")
+    end
+  end
+end

data/app/models/location.rb

@@ -0,0 +1,2 @@
+class Location < HubriseApp::LocationBase
+end

data/app/models/user.rb

@@ -0,0 +1,2 @@
+class User < HubriseApp::UserBase
+end

data/app/models/user_app_instance.rb

@@ -0,0 +1,2 @@
+class UserAppInstance < HubriseApp::UserAppInstanceBase
+end

data/db/migrate/20190116155419_create_base_tables.rb

@@ -1,44 +1,48 @@
 class CreateBaseTables < ActiveRecord::Migration[5.2]
   def change
-    create_table :hr_accounts do |t|
-      t.string   :hr_id,        null: false, index: { unique: true }
-      t.json     :hr_api_data,  null: false
+    create_table :accounts do |t|
+      t.string :hr_id, null: false, index: { unique: true }
+      t.string :name, null: false
+      t.string :currency, null: false
       t.datetime :refreshed_at, null: false
     end
 
-    create_table :hr_locations do |t|
-      t.string   :hr_id,        null: false, index: { unique: true }
-      t.json     :hr_api_data,  null: false
+    create_table :locations do |t|
+      t.string :hr_id, null: false, index: { unique: true }
+      t.string :name, null: false
       t.datetime :refreshed_at, null: false
     end
 
-    create_table :hr_app_instances do |t|
+    create_table :app_instances do |t|
       t.string :hr_id, null: false, index: { unique: true }
-      t.string :hr_account_id,  index: true
+      t.string :hr_account_id, index: true
       t.string :hr_location_id, index: true
       t.string :hr_catalog_id
       t.string :hr_customer_list_id
-      t.string :hr_access_token, null: false
+      t.string :access_token, null: false
     end
 
-    add_foreign_key :hr_app_instances, :hr_accounts, primary_key: :hr_id
-    add_foreign_key :hr_app_instances, :hr_locations, primary_key: :hr_id
+    add_foreign_key :app_instances, :accounts, primary_key: :hr_id, column: :hr_account_id
+    add_foreign_key :app_instances, :locations, primary_key: :hr_id, column: :hr_location_id
 
-    create_table :hr_users do |t|
-      t.string   :hr_id,            null: false, index: { unique: true }
-      t.json     :hr_api_data,      null: false
-      t.string   :hr_access_token,  null: false
-      t.datetime :refreshed_at,     null: false
+    create_table :users do |t|
+      t.string :hr_id, null: false, index: { unique: true }
+      t.string :access_token, null: false
+      t.string :email
+      t.string :first_name
+      t.string :last_name
+      t.string :locales, array: true
+      t.datetime :refreshed_at, null: false
     end
 
-    create_table :hr_user_app_instances do |t|
-      t.string    :hr_user_id,         index: true
-      t.string    :hr_app_instance_id, index: true
-      t.datetime  :refreshed_at, null: false
+    create_table :user_app_instances do |t|
+      t.string :hr_user_id, index: true
+      t.string :hr_app_instance_id, index: true
+      t.datetime :refreshed_at, null: false
     end
 
-    add_foreign_key :hr_user_app_instances, :hr_users, primary_key: :hr_id
-    add_foreign_key :hr_user_app_instances, :hr_app_instances, primary_key: :hr_id
-    add_index :hr_user_app_instances, %i[hr_user_id hr_app_instance_id refreshed_at], name: :index_user_app_instances, using: :btree
+    add_foreign_key :user_app_instances, :users, primary_key: :hr_id, column: :hr_user_id
+    add_foreign_key :user_app_instances, :app_instances, primary_key: :hr_id, column: :hr_app_instance_id
+    add_index :user_app_instances, %i[hr_user_id hr_app_instance_id refreshed_at], name: :index_user_app_instances, using: :btree
   end
 end

data/db/migrate/20200829091933_add_locations_timezone.rb

@@ -0,0 +1,5 @@
+class AddLocationsTimezone < ActiveRecord::Migration[6.0]
+  def change
+    add_column :locations, :timezone, :string, null: false, default: Time.zone.name
+  end
+end

data/db/migrate/20210120142001_add_api_json_column.rb

@@ -0,0 +1,6 @@
+class AddApiJsonColumn < ActiveRecord::Migration[6.0]
+  def change
+    add_column :accounts, :api_data, :json, after: :hr_id
+    add_column :locations, :api_data, :json, after: :hr_id
+  end
+end

data/db/migrate/20210121150253_remove_replaced_by_api_data_columns.rb

@@ -0,0 +1,9 @@
+class RemoveReplacedByApiDataColumns < ActiveRecord::Migration[6.0]
+  def change
+    remove_column :accounts, :name
+    remove_column :accounts, :currency
+
+    remove_column :locations, :name
+    remove_column :locations, :timezone
+  end
+end

data/db/migrate/20210419120038_add_catalogs_and_customer_lists.rb

@@ -0,0 +1,28 @@
+class AddCatalogsAndCustomerLists < ActiveRecord::Migration[6.0]
+  def change
+    create_table :catalogs do |t|
+      t.string :hr_id, null: false
+      t.json :api_data
+      t.datetime :refreshed_at, null: false
+      t.index :hr_id, unique: true
+    end
+
+    create_table :customer_lists do |t|
+      t.string :hr_id, null: false
+      t.json :api_data
+      t.datetime :refreshed_at, null: false
+      t.index :hr_id, unique: true
+    end
+
+    AppInstance.distinct.pluck(:hr_catalog_id).each do |hr_catalog_id|
+      Catalog.create!(hr_id: hr_catalog_id, refreshed_at: Date.new(2000)) if hr_catalog_id.present?
+    end
+
+    AppInstance.distinct.pluck(:hr_customer_list_id).each do |hr_customer_list_id|
+      CustomerList.create!(hr_id: hr_customer_list_id, refreshed_at: Date.new(2000)) if hr_customer_list_id.present?
+    end
+
+    add_foreign_key :app_instances, :catalogs, primary_key: :hr_id, column: :hr_catalog_id
+    add_foreign_key :app_instances, :customer_lists, primary_key: :hr_id, column: :hr_customer_list_id
+  end
+end

data/lib/hubrise_app/version.rb

@@ -1,3 +1,3 @@
 module HubriseApp
-  VERSION = "1.0.0".freeze
+  VERSION = "1.1.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hubrise_app
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Antoine Monnier
@@ -9,20 +9,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-07 00:00:00.000000000 Z
+date: 2022-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hubrise_client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.2
 - !ruby/object:Gem::Dependency
@@ -66,22 +66,38 @@ files:
 - app/lib/hubrise_app/hubrise_gateway.rb
 - app/lib/hubrise_app/refresher/account.rb
 - app/lib/hubrise_app/refresher/app_instance.rb
+- app/lib/hubrise_app/refresher/base.rb
+- app/lib/hubrise_app/refresher/catalog.rb
+- app/lib/hubrise_app/refresher/customer_list.rb
 - app/lib/hubrise_app/refresher/location.rb
 - app/lib/hubrise_app/refresher/user.rb
 - app/lib/hubrise_app/services/assign_app_instance.rb
 - app/lib/hubrise_app/services/connect_app_instance.rb
 - app/lib/hubrise_app/services/resolve_app_instance.rb
+- app/models/account.rb
+- app/models/app_instance.rb
+- app/models/catalog.rb
+- app/models/customer_list.rb
+- app/models/hubrise_app/account_base.rb
+- app/models/hubrise_app/app_instance_base.rb
 - app/models/hubrise_app/application_record.rb
-- app/models/hubrise_app/hr_account.rb
-- app/models/hubrise_app/hr_app_instance.rb
-- app/models/hubrise_app/hr_location.rb
-- app/models/hubrise_app/hr_user.rb
-- app/models/hubrise_app/hr_user_app_instance.rb
+- app/models/hubrise_app/catalog_base.rb
+- app/models/hubrise_app/customer_list_base.rb
+- app/models/hubrise_app/location_base.rb
+- app/models/hubrise_app/user_app_instance_base.rb
+- app/models/hubrise_app/user_base.rb
+- app/models/location.rb
+- app/models/user.rb
+- app/models/user_app_instance.rb
 - app/views/hubrise_app/application/root.html.haml
 - app/views/layouts/hubrise_app/application.html.erb
 - config/initializers/hubrise_app_config.rb
 - config/routes.rb
 - db/migrate/20190116155419_create_base_tables.rb
+- db/migrate/20200829091933_add_locations_timezone.rb
+- db/migrate/20210120142001_add_api_json_column.rb
+- db/migrate/20210121150253_remove_replaced_by_api_data_columns.rb
+- db/migrate/20210419120038_add_catalogs_and_customer_lists.rb
 - lib/hubrise_app.rb
 - lib/hubrise_app/engine.rb
 - lib/hubrise_app/spec_support.rb
@@ -105,8 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Rails engine to bootstrap a HubRise-based application

data/app/models/hubrise_app/hr_account.rb

@@ -1,5 +0,0 @@
-class HubriseApp::HrAccount < HubriseApp::ApplicationRecord
-  self.table_name = :hr_accounts
-
-  store_accessor :hr_api_data, :name
-end

data/app/models/hubrise_app/hr_app_instance.rb

@@ -1,8 +0,0 @@
-module HubriseApp
-  class HrAppInstance < HubriseApp::ApplicationRecord
-    self.table_name = :hr_app_instances
-
-    belongs_to :hr_account,   optional: true, primary_key: :hr_id
-    belongs_to :hr_location,  optional: true, primary_key: :hr_id
-  end
-end

data/app/models/hubrise_app/hr_location.rb

@@ -1,5 +0,0 @@
-class HubriseApp::HrLocation < HubriseApp::ApplicationRecord
-  self.table_name = :hr_locations
-
-  store_accessor :hr_api_data, :name
-end

data/app/models/hubrise_app/hr_user.rb

@@ -1,17 +0,0 @@
-module HubriseApp
-  class HrUser < HubriseApp::ApplicationRecord
-    self.table_name = :hr_users
-
-    has_many :hr_user_app_instances, -> { fresh }, primary_key: :hr_id
-    has_many :hr_app_instances, through: :hr_user_app_instances
-
-    store_accessor :hr_api_data, :first_name,
-                                 :last_name,
-                                 :email,
-                                 :locales
-
-    def primary_locale
-      locales&.first
-    end
-  end
-end

data/app/models/hubrise_app/hr_user_app_instance.rb

@@ -1,10 +0,0 @@
-class HubriseApp::HrUserAppInstance < HubriseApp::ApplicationRecord
-  self.table_name = :hr_user_app_instances
-
-  belongs_to :hr_app_instance, primary_key: :hr_id
-
-  REFRESH_THRESHOLD = 1.day
-  def self.fresh(time: Time.now)
-    where("hr_user_app_instances.refreshed_at > ?", time - REFRESH_THRESHOLD)
-  end
-end