foreman_scc_manager 1.6.3 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e046f783a69d37d132094313fbeed914c9d246e315bc238ca8ca8c2ae806dace
-  data.tar.gz: e9b8af6dd55a5756c76d4ba93f93b39919251930b281e694b5099add68147457
+  metadata.gz: 1049862eb94d3a0e5da9add1afcf83da6a7edf3e8e315f126c3ec531f3b8d3fc
+  data.tar.gz: aae14c2ae2305b52281b4c270dcec231b01bfe3745fc4b66b0da084d26b57a15
 SHA512:
-  metadata.gz: 3814c9b796a0b9869f00fdc49da07e46d71a73c9fbf32628c2dd11185fa84535b3469a6c7ee6b81f5fa3d0fe4a75f651f1f2d92bce35bf8289e0231c8c65f0c9
-  data.tar.gz: c8a7483a75e235b2499c99b885dcead01e57c5511e29655d5ec9013b604af70dd5cb3d9eb9042455080b6a4861435447907b73656944e96e0ea58502049ab7b0
+  metadata.gz: 87c896f8ad3c8e279e068ebe14d6a7a7c1648d94ae4c677500232208f6d8f181d67e4120d4cd1cd8aa3bfed1961851f49cda1e786cd2a7bbf11a20d604bdd030
+  data.tar.gz: 7cf6d36616da6866fb1f641e2f28b927bf789467c7bea6c6adecef0dc1bf4a841c603b79fac309cb3626b9ad2846eae16cdf8a7ac79f4569d47ea4e5c9bb1fb8

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status master](https://travis-ci.org/ATIX-AG/foreman_scc_manager.svg?branch=master)](https://travis-ci.org/ATIX-AG/foreman_scc_manager)
+
 # ForemanSccManager
 
 Foreman plugin to sync SUSE Customer Center products and repositories into Katello
@@ -11,6 +13,7 @@ for how to install Foreman plugins
 
 | Foreman Version | Katello Version | Plugin Version |
 | --------------- | --------------- | -------------- |
+| 1.22            | 3.12            | ~> 1.7.0       |
 | 1.21            | 3.10            | ~> 1.6.0       |
 | 1.20            | 3.9             | ~> 1.6.0       |
 | 1.19            | 3.8             | ~> 1.5.1       |

data/Rakefile

@@ -38,7 +38,7 @@ task default: :test
 begin
   require 'rubocop/rake_task'
   RuboCop::RakeTask.new
-rescue StandardError => _
+rescue StandardError => _e
   puts 'Rubocop not loaded.'
 end
 

data/app/controllers/api/v2/scc_accounts_controller.rb

@@ -0,0 +1,159 @@
+module Api
+  module V2
+    class SccAccountsController < ::Api::V2::BaseController
+      include Api::Version2
+      include Foreman::Controller::AutoCompleteSearch
+
+      resource_description do
+        resource_id 'scc_accounts'
+        api_version 'v2'
+        api_base_url '/api/v2'
+      end
+
+      before_action :find_resource, :only => [:show, :update, :destroy, :sync, :bulk_subscribe]
+
+      api :GET, '/scc_accounts/', N_('List all scc_accounts')
+      param :organization_id, :identifier, :required => true
+      param_group :search_and_pagination, ::Api::V2::BaseController
+      def index
+        scope = resource_scope
+        scope = scope.where(:organization => params[:organization_id]) if params[:organization_id].present?
+        @scc_accounts = scope.search_for(params[:search], :order => params[:order]).paginate(:page => params[:page])
+      end
+
+      api :GET, '/scc_accounts/:id/', N_('Show scc_account')
+      param :id, :identifier_dottable, :required => true
+      param :organization_id, :identifier, :required => true
+      def show; end
+
+      def_param_group :scc_account do
+        param :scc_account, Hash, :required => true, :action_aware => true do
+          param :organization_id, :identifier, :required => true
+          param :name, String, :required => true, :desc => N_('Name of the scc_account')
+          param :login, String, :required => true, :desc => N_('Login id of scc_account')
+          param :password, String, :required => true, :desc => N_('Password of scc_account')
+          param :base_url, String, :required => false, :desc => N_('URL of SUSE for scc_account')
+          param :interval, ['never', 'daily', 'weekly', 'monthy'], :desc => N_('Interval for syncing scc_account')
+          param :sync_date, String, :desc => N_('Last Sync time of scc_account')
+        end
+      end
+
+      api :POST, '/scc_accounts/', N_('Create an scc_account')
+      param_group :scc_account, :as => :create
+      def create
+        @scc_account = resource_class.new(scc_account_params)
+        process_response @scc_account.save_with_logic!
+      end
+
+      api :PUT, '/scc_accounts/:id', N_('Update scc_account')
+      param :id, :identifier_dottable, :required => true
+      param_group :scc_account
+      def update
+        process_response @scc_account.update(scc_account_params)
+      end
+
+      api :DELETE, '/scc_accounts/:id', N_('Delete scc_account')
+      param :id, :identifier_dottable, :required => true
+      def destroy
+        process_response @scc_account.destroy
+      end
+
+      api :POST, '/scc_accounts/test_connection', N_('Test connection for scc_account')
+      api :PUT, '/scc_accounts/:id/test_connection', N_('Test connection for scc_account')
+      param :id, :identifier_dottable, :required => false
+      param :login, String, :required => false, :desc => N_('Login id of scc_account')
+      param :password, String, :required => false, :desc => N_('Password of scc_account')
+      param :base_url, String, :required => false, :desc => N_('URL of SUSE for scc_account')
+      def test_connection
+        if params[:id].present?
+          find_resource
+          begin
+            local_scc_account_params = scc_account_params
+          rescue ActionController::ParameterMissing
+            local_scc_account_params = {}
+          end
+          @scc_account.login = local_scc_account_params[:login] unless local_scc_account_params[:login].empty?
+          @scc_account.password = local_scc_account_params[:password] unless local_scc_account_params[:password].empty?
+        else
+          @scc_account = resource_class.new(scc_account_params)
+        end
+        respond_to do |format|
+          if @scc_account.test_connection
+            format.json { render json: 'Success'.to_json, status: :ok }
+          else
+            format.json { render json: 'Failed'.to_json, status: :not_found }
+          end
+        end
+      end
+
+      api :PUT, '/scc_accounts/:id/sync', N_('Sync scc_account')
+      param :id, :identifier_dottable, :required => true
+      def sync
+        sync_task = ForemanTasks.async_task(::Actions::SccManager::Sync, @scc_account)
+        synced = @scc_account.update! sync_task: sync_task
+        respond_to do |format|
+          format.json { render json: sync_task.to_json } if synced
+        end
+      rescue ::Foreman::Exception => e
+        render json: { error: ('Failed to add task to queue: %s' % e).to_s }, status: :unprocessable_entity
+      rescue ForemanTasks::Lock::LockConflict => e
+        render json: { error: ('Lock on SCC account already taken: %s' % e).to_s }, status: :unprocessable_entity
+      end
+
+      api :PUT, '/scc_accounts/:id/bulk_subscribe/', N_('Bulk subscription of scc_products for scc_account')
+      param :id, :identifier_dottable, :required => true
+      param :scc_subscribe_product_ids, Array
+      def bulk_subscribe
+        scc_products_to_subscribe = @scc_account.scc_products.where(:id => params[:scc_subscribe_product_ids])
+        respond_to do |format|
+          if scc_products_to_subscribe.count > 0
+            subscribe_task = ForemanTasks.async_task(::Actions::BulkAction,
+                                                     ::Actions::SccManager::SubscribeProduct,
+                                                     scc_products_to_subscribe)
+            format.json { render json: subscribe_task.to_json, status: :ok }
+          else
+            format.json { render json: 'No Product selected'.to_json, status: :expectation_failed }
+          end
+        end
+      rescue ::Foreman::Exception => e
+        render json: { error: ('Failed to add task to queue: %s' % e).to_s }, status: :unprocessable_entity
+      rescue ForemanTasks::Lock::LockConflict => e
+        render json: { error: ('Lock on SCC account already taken: %s' % e).to_s }, status: :unprocessable_entity
+      end
+
+      private
+
+      def scc_account_params
+        params[:scc_account].delete(:password) if params[:scc_account][:password].blank?
+        params.require(:scc_account).permit(
+          :name,
+          :login,
+          :password,
+          :base_url,
+          :interval,
+          :sync_date,
+          :organization_id
+        )
+      end
+
+      def find_resource
+        @scc_account = resource_class.find(params[:id])
+      end
+
+      def resource_class
+        ::SccAccount
+      end
+
+      def action_permission
+        case params[:action]
+        when 'sync', 'test_connection'
+          :sync
+        when 'bulk_subscribe'
+          :bulk_subscribe
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/app/controllers/api/v2/scc_products_controller.rb

@@ -0,0 +1,64 @@
+module Api
+  module V2
+    class SccProductsController < ::Api::V2::BaseController
+      include Api::Version2
+      include Foreman::Controller::AutoCompleteSearch
+
+      resource_description do
+        resource_id 'scc_products'
+        api_version 'v2'
+        api_base_url '/api/v2'
+      end
+
+      before_action :find_resource, :only => [:show, :subscribe]
+
+      api :GET, '/scc_accounts/:scc_account_id/scc_products/', N_('List all products for scc_account')
+      param :scc_account_id, :identifier_dottable, :required => true
+      param_group :search_and_pagination, ::Api::V2::BaseController
+      def index
+        scope = resource_scope
+        scope = scope.where(:organization => params[:organization_id]) if params[:organization_id].present?
+        @scc_products = scope.search_for(params[:search], :order => params[:order]).paginate(:page => params[:page])
+      end
+
+      api :GET, '/scc_accounts/:scc_account_id/scc_products/:id/', N_('Show an scc_account product')
+      param :id, :identifier_dottable, :required => true
+      param :scc_account_id, :identifier_dottable, :required => true
+      def show; end
+
+      api :PUT, '/scc_accounts/:scc_account_id/scc_products/:id/subscribe/', N_('Subscribe product')
+      param :id, :identifier_dottable, :required => true
+      param :scc_account_id, :identifier_dottable, :required => true
+      def subscribe
+        subcribe_task = ForemanTasks.async_task(::Actions::SccManager::SubscribeProduct, @scc_product) if @scc_product
+        respond_to do |format|
+          if subcribe_task
+            format.json { render json: subcribe_task.to_json, status: :ok }
+          else
+            format.json { render json: 'Failed to subscribe product'.to_json, status: :not_found }
+          end
+        end
+      rescue ::Foreman::Exception => e
+        render json: { error: ('Failed to add task to queue: %s' % e).to_s }, status: :unprocessable_entity
+      rescue ForemanTasks::Lock::LockConflict => e
+        render json: { error: ('Lock on SCC account already taken: %s' % e).to_s }, status: :unprocessable_entity
+      end
+
+      private
+
+      def find_resource
+        @scc_account = ::SccAccount.find_by!(id: params[:scc_account_id])
+        @scc_product = @scc_account.scc_products.find_by!(id: params[:id])
+      end
+
+      def action_permission
+        case params[:action]
+        when 'subscribe'
+          :subscribe
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/app/models/scc_account.rb

@@ -34,6 +34,7 @@ class SccAccount < ApplicationRecord
   default_scope -> { order(:login) }
 
   scoped_search on: :login, complete_value: true
+  scoped_search on: :name
 
   def init
     # set default values
@@ -84,7 +85,7 @@ class SccAccount < ApplicationRecord
 
   def update_attributes_with_logic!(params)
     transaction do
-      self.update_attributes!(params)
+      self.update!(params)
       if rec_logic_changed?
         old_rec_logic = self.foreman_tasks_recurring_logic
         associate_recurring_logic

data/app/models/scc_product.rb

@@ -19,6 +19,7 @@ class SccProduct < ApplicationRecord
 
   default_scope -> { order(:name) }
   scoped_search on: :name, complete_value: true
+  scoped_search on: :friendly_name
 
   def uniq_name
     "#{scc_id} " + friendly_name

data/app/views/api/v2/scc_accounts/base.json.rabl

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+object @scc_account
+
+attributes :id, :name

data/app/views/api/v2/scc_accounts/index.json.rabl

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+collection @scc_accounts
+extends 'api/v2/scc_accounts/main'

data/app/views/api/v2/scc_accounts/main.json.rabl

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+object @scc_account
+extends 'api/v2/scc_accounts/base'
+attributes :organization_id, :organization_name, :login, :base_url, :interval, :sync_date

data/app/views/api/v2/scc_accounts/show.json.rabl

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+object @scc_account
+extends 'api/v2/scc_accounts/main'

data/app/views/api/v2/scc_products/base.json.rabl

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+object @scc_product
+
+attributes :id, :name

data/app/views/api/v2/scc_products/index.json.rabl

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+collection @scc_products
+extends 'api/v2/scc_products/main'

data/app/views/api/v2/scc_products/main.json.rabl

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+object @scc_product
+extends 'api/v2/scc_products/base'
+attributes :organization_id, :organization_name, :scc_account_id, :name, :arch, :friendly_name, :description

data/app/views/api/v2/scc_products/show.json.rabl

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+object @scc_product
+
+extends 'api/v2/scc_products/main'

data/config/routes.rb

@@ -1,10 +1,11 @@
 Rails.application.routes.draw do
   resources :scc_accounts do
     collection do
-      put 'test_connection'
+      post 'test_connection'
       get 'auto_complete_search'
     end
     member do
+      put 'test_connection'
       put 'sync'
       put 'bulk_subscribe'
     end
@@ -15,4 +16,32 @@ Rails.application.routes.draw do
       put 'unsubscribe'
     end
   end
+
+  namespace :api, :defaults => { :format => 'json' } do
+    scope '(:apiv)', :module => :v2,
+                     :defaults => { :apiv => 'v2' },
+                     :apiv => /v1|v2/,
+                     :constraints => ApiConstraints.new(:version => 2, :default => true) do
+      resources :scc_accounts do
+        collection do
+          post 'test_connection'
+          get 'auto_complete_search'
+        end
+        member do
+          put 'test_connection'
+          put 'sync'
+          put 'bulk_subscribe'
+        end
+      end
+      constraints(:scc_account_id => /[^\/]+/) do
+        resources :scc_accounts, :only => [] do
+          resources :scc_products, only: %i[index show] do
+            member do
+              put 'subscribe'
+            end
+          end
+        end
+      end
+    end
+  end
 end

data/lib/foreman_scc_manager/engine.rb

@@ -22,18 +22,37 @@ module ForemanSccManager
 
     initializer 'foreman_scc_manager.register_plugin', :before => :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_scc_manager do
-        requires_foreman '>= 1.18'
-        requires_foreman_plugin 'katello', '>= 3.7.0'
+        requires_foreman '>= 1.22'
+        requires_foreman_plugin 'katello', '>= 3.12.0'
+
+        apipie_documented_controllers ["#{ForemanSccManager::Engine.root}/app/controllers/api/v2/*.rb"]
 
         # Add permissions
         security_block :foreman_scc_manager do
-          permission :view_scc, :scc_account => %i[index show]
-          permission :use_scc, :scc_account => [:bulk_subscribe]
-          # permission :use_scc, :scc_product => [:subscribe, :unsubscribe]
-          permission :new_scc, :scc_account => %i[new create]
-          permission :edit_scc, :scc_account => %i[edit update]
-          permission :delete_scc, :scc_account => [:destroy]
-          permission :sync_scc, :scc_account => [:sync]
+          permission :view_scc, {
+            :'foreman_scc_manager/scc_accounts' => [:show, :index],
+            :'api/v2/scc_accounts' => [:show, :index]
+          }
+          permission :use_scc, {
+            :'foreman_scc_manager/scc_accounts' => [:bulk_subscribe],
+            :'api/v2/scc_accounts' => [:bulk_subscribe]
+          }
+          permission :new_scc, {
+            :'foreman_scc_manager/scc_accounts' => [:new, :create],
+            :'api/v2/scc_accounts' => [:create]
+          }
+          permission :edit_scc, {
+            :'foreman_scc_manager/scc_accounts' => [:edit, :update],
+            :'api/v2/scc_accounts' => [:update]
+          }
+          permission :delete_scc, {
+            :'foreman_scc_manager/scc_accounts' => [:destroy],
+            :'api/v2/scc_accounts' => [:destroy]
+          }
+          permission :sync_scc, {
+            :'foreman_scc_manager/scc_accounts' => [:sync],
+            :'api/v2/scc_accounts' => [:sync]
+          }
         end
 
         # Add a new role called 'SccManager' if it doesn't exist

data/lib/foreman_scc_manager/version.rb

@@ -1,3 +1,3 @@
 module ForemanSccManager
-  VERSION = '1.6.3'.freeze
+  VERSION = '1.7.0'.freeze
 end

data/lib/tasks/rubocop.rake

@@ -9,7 +9,6 @@ begin
     "#{ForemanSccManager::Engine.root}/db/**/*.rb",
     "#{ForemanSccManager::Engine.root}/lib/**/*.rake",
     "#{ForemanSccManager::Engine.root}/lib/**/*.rb",
-    "#{ForemanSccManager::Engine.root}/locale/**/*.rb",
     "#{ForemanSccManager::Engine.root}/test/**/*.rb"
   ]