insights-api-common 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc3e9311fa97474f63d69e67945cc243bac2f249ab67ab7055e45212727fc130
+  data.tar.gz: 88aabb5afa5ddf89aafe5401342a6954c84523f6f4ecb6b77652b136c4bc58b6
+SHA512:
+  metadata.gz: 933e547ddc3cab50a6b78051be51195d1ebccb32a48acfcf369429a2a7b751b3a4ba0bd7050496117bcaef5ec238b57e8b5320d70d445748891444143e8fccb5
+  data.tar.gz: bd10b8a9bd50bfe2e7fa90500e733d4517bb48a710582e0a251a33b83ba083dc27e42ea02285df5ae36c633b8a6c49f6640dd9176b0e4090f8ad880a5813eed1

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,102 @@
+# Insights::API::Common
+
+[![Build Status](https://travis-ci.org/RedHatInsights/insights-api-common-rails.svg)](https://travis-ci.org/RedHatInsights/insights-api-common-rails)
+[![Maintainability](https://api.codeclimate.com/v1/badges/790ea6c77d82da6be68a/maintainability)](https://codeclimate.com/github/RedHatInsights/insights-api-common-rails/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/790ea6c77d82da6be68a/test_coverage)](https://codeclimate.com/github/RedHatInsights/insights-api-common-rails/test_coverage)
+[![Security](https://hakiri.io/github/RedHatInsights/insights-api-common-rails/master.svg)](https://hakiri.io/github/RedHatInsights/insights-api-common-rails/master)
+
+Header, Encryption, RBAC, Serialization, Pagination and other common behavior for Insights microservices built with Rails
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'insights-api-common'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install insights-api-common
+
+## Usage
+
+#### Insights::Api::Common::Filter
+
+| Supported Comparators     | Comparator    |
+| ---------------------     | ----------    |
+| Integer                   | eq            |
+|                           | gt            |
+|                           | gte           |
+|                           | lt            |
+|                           | lte           |
+|                           | nil           |
+|                           | not_nil       |
+| String                    | eq            |
+|                           | contains      |
+|                           | starts_with   |
+|                           | ends_with     |
+|                           | nil           |
+|                           | not_nil       |
+| String (case insensitive) | eq_i          |
+|                           | contains_i    |
+|                           | starts_with_i |
+|                           | ends_with_i   |
+
+After implementing filtering in your application, this is the way to filter via parameters on index functions:
+
+| Query Parameter | Ruby Client Parameter <br> **GraphQL filter: Parameter** |
+| --------------- | -------------------------------------------------------- |
+|"?filter[name]=reviews"|`{:filter => { :name => "reviews" }}`<br> **`filter: { name: "reviews" }`**|
+|"?filter[name][eq]=reviews"|`{:filter => { :name => { :eq => "reviews" } }}` <br> **`filter: { name: { eq: "reviews" } }`**|
+|"?filter[name][starts_with]=a"|`{:filter => { :name => { :starts_with => "a" } }}` <br> **`filter: { name: { starts_with: "a" } }`**|
+|"?filter[name][ends_with]=manager"|`{:filter => { :name => { :ends_with => "manager" } }}` <br> **`filter: { name: { ends_with: "manager" } }`**|
+|"?filter[name][contains]=openshift"|`{:filter => { :name => { :contains => "openshift" } }}` <br> **`filter: { name: { contains: "openshift" } }`**|
+|"?filter[id]=5"|`{:filter => { :id => "5" }}` <br> **`filter: { id: "5" }`**|
+|"?filter[id][eq]=5"|`{:filter => { :id => { :eq => "5" }}}` <br> **`filter: { id: { eq: "5" } }`**|
+|"?filter[id][gt]=180"|`{:filter => { :id => { :gt => "180" }}}` <br> **`filter: { id: { gt: "180" } }`**|
+|"?filter[id][gte]=190"|`{:filter => { :id => { :gte => "190" }}}` <br> **`filter: { id: { gte: "190" } }`**|
+|"?filter[id][lt]=5"|`{:filter => { :id => { :lt => "5" }}} ` <br> **`filter: { id: { lt: "5" } }`**|
+|"?filter[id][lte]=5"|`{:filter => { :id => { :lte => "5" }}}` <br> **`filter: { id: { lte: "5" } }`**|
+|"?filter[id][]=5&filter[id][]=10&filter[id][]=15&filter[id][]=20"|`{:filter => { :id => ["5", "10", "15", "20"]}}` <br> **`filter: { id: ["5", "10", "15", "20"] }`**|
+|"?filter[id][eq][]=5&filter[id][eq][]=10&filter[id][eq][]=15&filter[id][eq][]=20"|`{:filter => { :id => { :eq => ["5", "10", "15", "20"]}}}` <br> **`filter: { id: { eq: ["5", "10", "15", "20"] }`**|
+
+#### Sorting Results
+
+Sorting query results is controlled via the _sort_by_ query parameter. The _sort_by_ parameter is available for both REST API and GraphQL requests.
+
+The syntax for the _sort_by_ parameter supports:
+
+- a single string representing the attribute name to sort by which may be followed by :asc or :desc
+  - **attribute**   (_default order is ascending_)
+  - **attribute:asc** (_ascending order_)
+  - **attribute:desc** (_descending order_)
+- an array of strings of the above syntax
+
+##### Sort_by Examples:
+
+- GET /api/v1.0/sources?sort_by=name
+- GET /api/v1.0/vms?sort_by[]=power_state\&sort_by[]=memory:desc
+
+| Query Parameter | Ruby Client Parameter | GraphQL Parameter |
+| --------------- | --------------------- | ----------------- |
+| "?sort_by=name" | { :sort_by => "name" } | sort_by: "name" |
+| "?sort_by[]=power_state\&sort_by[]=memory:desc" | { :sort_by => ["power_state", "memory:desc"] } |  sort_by: ["power_state, "memory:desc"] |
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/RedHatInsights/insights-api-common-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+This project is available as open source under the terms of the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).

data/Rakefile

@@ -0,0 +1,18 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/models/authentication.rb

@@ -0,0 +1,19 @@
+require 'active_record'
+require 'rails'
+require 'acts_as_tenant'
+class Authentication < ActiveRecord::Base
+  acts_as_tenant(:tenant)
+
+  belongs_to :resource, :polymorphic => true
+  has_one :encryption, :dependent => :destroy
+
+  validates :encryption, :presence => true
+
+  def secret=(secret)
+    encryption.nil? ? self.encryption = Encryption.new(:secret => secret) : encryption.update(:secret => secret)
+  end
+
+  def secret
+   encryption.secret || nil
+  end
+end

data/app/models/concerns/encryption_concern.rb

@@ -0,0 +1,52 @@
+require 'manageiq/password'
+module EncryptionConcern
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :encrypted_columns
+    self.encrypted_columns = []
+  end
+
+  module ClassMethods
+    def encrypt_column(column)
+      # Given a column of "password", create 4 instance methods:
+      #   password            : Get the password in plain text
+      #   password=           : Set the password in plain text
+      #   password_encrypted  : Get the password in cryptext
+      #   password_encrypted= : Set the password in cryptext
+
+      encrypted_columns << column.to_s
+      encrypted_columns << "#{column}_encrypted"
+
+      mod = generated_methods_for_password_mixin
+
+      mod.send(:define_method, column) do
+        val = send("#{column}_encrypted")
+        val.blank? ? val : ManageIQ::Password.decrypt(val)
+      end
+
+      mod.send(:define_method, "#{column}=") do |val|
+        val = ManageIQ::Password.try_encrypt(val) if val.present?
+        send("#{column}_encrypted=", val)
+      end
+
+      mod.send(:define_method, "#{column}_encrypted") do
+        self[column]
+      end
+
+      mod.send(:define_method, "#{column}_encrypted=") do |val|
+        self[column] = val
+      end
+    end
+
+    private
+
+    def generated_methods_for_password_mixin
+      @generated_methods_for_password_mixin ||= begin
+        mod = const_set(:GeneratedMethodsForPasswordMixin, Module.new)
+        include mod
+        mod
+      end
+    end
+  end
+end

data/app/models/encryption.rb

@@ -0,0 +1,13 @@
+require 'active_record'
+require 'rails'
+require 'acts_as_tenant'
+class Encryption < ActiveRecord::Base
+  include EncryptionConcern
+  acts_as_tenant(:tenant)
+
+  validates :authentication_id, :secret, :presence => true
+
+  belongs_to :authentication
+
+  encrypt_column :secret
+end

data/lib/generators/shared_utilities/migration_generator.rb

@@ -0,0 +1,79 @@
+require "rails/generators/active_record"
+require 'rails/generators/migration'
+require 'generators/shared_utilities/orm_helper'
+module SharedUtilities
+  class MigrationGenerator < Rails::Generators::NamedBase
+    include ActiveRecord::Generators::Migration
+    include Rails::Generators::Migration
+    include SharedUtilities::OrmHelper
+
+    argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+    class_option :primary_key_type, type: :string, desc: "The type for primary key"
+
+    source_root File.expand_path("../templates", __FILE__)
+
+    def initialize(args, *options)
+      raise StandardError, "Only 'authentication' model is currently implemented" if args.first != "authentication"
+      super
+    end
+
+    def manifest
+      copy_migration
+    end
+
+    def copy_migration
+      if (behavior == :invoke && model_exists?) || (behavior == :revoke && migration_exists?(table_name))
+        migration_template "migration_existing.rb", "#{migration_path}/update_authentications_on_#{table_name}.rb", migration_version: migration_version
+      else
+        migration_template "migration.rb", "#{migration_path}/create_#{table_name}.rb", migration_version: migration_version
+      end
+    end
+
+    def migration_data
+<<RUBY
+   ## Required
+      #  t.references "resource", :polymorphic => true, :index => true
+      #  t.string       :name
+      #  t.string       :authtype
+      #  t.string       :status
+      #  t.string       :status_details
+      #  t.#{ip_column}     :tenant_id
+      #  t.timestamps
+RUBY
+    end
+
+    def ip_column
+      # Padded with spaces so it aligns nicely with the rest of the columns.
+      "%-8s" % (inet? ? "inet" : "string")
+    end
+
+    def inet?
+     postgresql?
+    end
+
+    def rails5?
+      Rails.version.start_with? '5'
+    end
+
+    def postgresql?
+      config = ActiveRecord::Base.configurations[Rails.env]
+      config && config['adapter'] == 'postgresql'
+    end
+
+    def primary_key_type
+       primary_key_string if rails5?
+    end
+
+    def primary_key_string
+      key_string = options[:primary_key_type] || "bigserial"
+      ", id: :#{key_string}" if key_string
+    end
+
+    def migration_version
+      if rails5?
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+      end
+    end
+  end
+end