mno_enterprise-nimbus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c68a95b3a7ede2cd90be31db90ad9682144f33ac
+  data.tar.gz: 9a214548748d0d83bd22c069ce68d05fdb8f0283
+SHA512:
+  metadata.gz: 1e8ad341ab14d1aeafaa56663b8939203760db157b3f3d7389eb9f7b60ade60bcfc0af949c7745f475360ccbec925b5917acb64cf83fd323bc219ad67693f114
+  data.tar.gz: c60fbdc317ab556a8ff152b97027833dd2c4856abc6d71f9b9357d88af7cc03bcb3cd67a0a6d94d7af58d475b1455dee0e0751b6bee7d3b65d605f37a93fc46a

data/APACHE-LICENSE-2.0

@@ -0,0 +1,201 @@
+                                 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,28 @@
+# MnoEnterprise::Nimbus
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mno_enterprise-nimbus'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install mno_enterprise-nimbus
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MnoEnterprise::Nimbus'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/app/assets/config/mno_enterprise_nimbus_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/mno_enterprise/nimbus .css

data/app/assets/stylesheets/mno_enterprise/nimbus/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/mno_enterprise/nimbus/application_controller.rb

@@ -0,0 +1,7 @@
+module MnoEnterprise
+  module Nimbus
+    class ApplicationController < ActionController::Base
+      protect_from_forgery with: :exception
+    end
+  end
+end

data/app/controllers/mno_enterprise/nimbus/v4/app_instances_controller.rb

@@ -0,0 +1,36 @@
+module MnoEnterprise
+  class Nimbus::V4::AppInstancesController < Nimbus::V4::BaseController
+
+    private
+
+      def resource_klass
+        MnoEnterprise::AppInstance
+      end
+
+      def get_resources
+        parent.app_instances
+      end
+
+      def get_resource(uid)
+        MnoEnterprise::AppInstance.find_by(uid: uid)
+      end
+
+      def params_create_whitelist
+        [:product]
+      end
+
+      def build_resource(attributes)
+        attrs = attributes.dup
+        parent.app_instances.create attrs
+      end
+
+      def destroy_resource(resource)
+        return false unless resource
+        resource.terminate
+      end
+
+      def hash_for(resource)
+        hash_for_app_instance resource
+      end
+  end
+end

data/app/controllers/mno_enterprise/nimbus/v4/apps_controller.rb

@@ -0,0 +1,22 @@
+module MnoEnterprise
+  class Nimbus::V4::AppsController < Nimbus::V4::BaseController
+
+    private
+    ATTRIBUTES = [:nid, :name, :description, :created_at, :updated_at, :logo, :version, :website, :slug, :categories,
+                 :key_benefits, :key_features, :testimonials, :tiny_description]
+
+    def resource_klass
+      MnoEnterprise::App
+    end
+
+    # Retrieve all user
+    def get_resources
+      MnoEnterprise::App.all
+    end
+
+    # Hash representation of the resource
+    def hash_for(resource)
+      resource.attributes.slice(*ATTRIBUTES)
+    end
+  end
+end

data/app/controllers/mno_enterprise/nimbus/v4/base_controller.rb

@@ -0,0 +1,281 @@
+module MnoEnterprise
+  class Nimbus::V4::BaseController < ApplicationController
+    before_filter :authenticate_remote_client!
+    before_filter :check_parent_resource
+    around_filter :prepare_and_handle_error
+
+    class ResponseCode
+      attr_accessor :error_code, :http_code
+
+      def initialize(error_code, http_code)
+        @error_code = error_code
+        @http_code = http_code
+      end
+    end
+
+    INTERNAL_ERROR = ResponseCode.new('unknownError', 500)
+    RESOURCE_NOT_FOUND = ResponseCode.new('notFound', 404)
+    PARENT_RESOURCE_NOT_FOUND = ResponseCode.new('parentNotFound', 404)
+    AUTHENTICATION_ERROR = ResponseCode.new('notAuthenticated', 401)
+    VALIDATION_ERROR = ResponseCode.new('validationError', 400)
+    NO_ERROR = ResponseCode.new('noError', 200)
+
+    respond_to :json
+
+    # GET /api/nimbus/v4/<resources_name>
+    # Get all resources
+    def index
+      render_response(get_resources)
+    end
+
+    # GET /api/nimbus/v4/:id
+    # Show specific resource
+    def show
+      @resource = get_resource(params[:id])
+
+      if @resource
+        render_response(@resource)
+        return
+      else
+        render_error RESOURCE_NOT_FOUND, 'Resource not found: ' + params[:id]
+        return
+      end
+    end
+
+    # POST /api/nimbus/v4/<resources_name>
+    # Create new resource and return representation
+    def create
+      unless params[:data]
+        render_error VALIDATION_ERROR, 'Body does not contain the field: data'
+        return false
+      end
+
+      attributes = params[:data].select { |k, v| params_create_whitelist.include?(k.to_sym) }
+
+      @resource = build_resource(attributes)
+
+      # Save resource or set error code and status
+      unless @resource.save
+        render_errors VALIDATION_ERROR, @resource.errors
+        return
+      end
+
+      after_create_resource(@resource)
+
+      render_response(@resource, 201)
+    end
+
+    # PUT /api/nimbus/v4/<resources_name>/:id
+    # Change, suspend or reactivate a resource
+    # Operation passed in body: {"operation":"suspend"}
+    def update
+      attributes = (params[:data] || {}).select { |k, v| params_update_whitelist.include?(k.to_sym) }
+
+      @resource = get_resource(params[:id])
+
+      # Check resource exists
+      unless @resource
+        render_error RESOURCE_NOT_FOUND, 'Resource not found: ' + params[:id]
+        return false
+      end
+
+      if attributes.any?
+        update_resource(@resource, attributes)
+        unless @resource.save
+          render_errors VALIDATION_ERROR, @resource.errors
+          return false
+        end
+      end
+
+      after_update_resource(@resource, attributes)
+
+      render_response(@resource)
+    end
+
+
+    # DELETE /api/nimbus/v4/<resources_name>/:id
+    # Delete a resource
+    def destroy
+      @resource = get_resource(params[:id])
+      # Check resource exists
+      unless @resource
+        render_error RESOURCE_NOT_FOUND, 'Resource not found: ' + params[:id]
+        return
+      end
+
+      destroy_resource(@resource)
+      render_response(@resource)
+    end
+
+    #=======================================
+    # Private
+    #=======================================
+    private
+
+    # Retrieve the parent resource in a before filter
+    def parent
+      @parent ||= MnoEnterprise::Organization.find_by({uid: params[:organization_id]})
+    end
+
+    def check_parent_resource
+      if params[:organization_id] && !parent
+        render_error PARENT_RESOURCE_NOT_FOUND, 'Parent resource not found: ' + params[:organization_id]
+        return false
+      end
+      true
+    end
+
+    # Around filter
+    # Return properly formatted json message on error
+    def prepare_and_handle_error
+      begin
+        yield
+      rescue Exception => e
+        logger.error e
+        render_error INTERNAL_ERROR, 'Internal error'
+      end
+    end
+
+    # Read the token from the http header and
+    # check that it matches the Westcon auth settings
+    def authenticate_remote_client!
+      valid = false
+
+      # Check authentication
+      authenticate_with_http_basic do |login, password|
+        valid = Settings.westcon.api_login == login && Settings.westcon.api_pwd == password
+      end
+
+      # Block access in production (for the moment)
+      if (valid || Rails.env.development?)
+        return true
+      else
+        render_error AUTHENTICATION_ERROR, 'Authentication error'
+        return true
+      end
+    end
+
+    # Define the list of parameters for creating a resource
+    def params_create_whitelist
+      []
+    end
+
+    # Define the list of parameters for updating a resource
+    # Returns params_create_whitelist by default
+    def params_update_whitelist
+      params_create_whitelist
+    end
+
+
+    # Render an error message with the provided
+    # code and header
+    def render_error(response_code, message)
+      errors = [{
+                    id: UUID.new.generate,
+                    code: response_code.error_code.underscore.dasherize,
+                    title: message,
+                    detail: message
+                }]
+      render json: {error: response_code.error_code, result: {errors: errors}}, status: response_code.http_code
+    end
+
+
+    def render_errors(response_code, errors)
+      render({json: {error: response_code.error_code, result: {errors: process_errors(errors)}}, status: response_code.http_code})
+    end
+
+
+    def process_errors(errors)
+      raise 'call process_error for a single error' if errors.kind_of?(String)
+      # error may be either an array of string, either an iterable of error and error_val
+      # In the first case, error_val will  be nil
+      errors.map do |error, error_val|
+        field = error_val ? error : nil
+        label = [error, error_val].compact.join(' ')
+        code = label.parameterize.gsub(/\-\d+/, '')
+        {
+            id: UUID.new.generate,
+            code: code,
+            title: label,
+            detail: label,
+            attribute: field,
+            value: error_val
+        }
+      end
+    end
+
+    def resource_klass
+      raise NotImplemented
+    end
+
+    def hash_for(resource)
+      raise NotImplemented
+    end
+
+    # Build a resource for creation
+    # Give unlimited free trial
+    def build_resource(attributes)
+      attrs = attributes.dup
+      res = resource_klass.new
+      res.assign_attributes(attrs)
+      res
+    end
+
+    # Update a resource
+    def update_resource(resource, attributes)
+      resource.assign_attributes(attributes.select { |k, v| params_update_whitelist.include?(k.to_sym) })
+    end
+
+    # TODO: Call some sort of "terminate" method on Organization
+    # model which also terminates all the related app_instances
+    # Destroy a resource
+    def destroy_resource(resource)
+      resource.destroy
+    end
+
+    # Hook called after the resource has been
+    # successfully created (optional)
+    def after_create_resource(resource, opts = {})
+    end
+
+    # Hook called after the resource has been
+    # successfully updated (optional)
+    def after_update_resource(resource, opts = {})
+    end
+
+    # Render a resource or resources view
+    def render_response(resource_or_list, http_code = 200)
+      resp = resource_or_list.kind_of?(Array) ? resource_or_list.map { |e| hash_for(e) } : hash_for(resource_or_list)
+      render json: {result: resp, error: NO_ERROR.error_code}, status: http_code
+    end
+
+    def hash_for_organization(resource)
+      {
+          id: resource.uid,
+          name: resource.name,
+          status: resource.suspended? ? 'suspended' : 'active',
+      }
+    end
+
+    def hash_for_user(resource)
+      {
+          id: resource.uid,
+          name: resource.name,
+          surname: resource.surname,
+          email: resource.email,
+          role: resource.role
+      }
+    end
+
+    def hash_for_app_instance(resource)
+      {
+          id: resource.uid,
+          product: resource.app.nid,
+          status: resource.status,
+          stack: resource.stack,
+          created_at: resource.created_at
+      }
+    end
+
+  end
+end

data/app/controllers/mno_enterprise/nimbus/v4/events_controller.rb

@@ -0,0 +1,52 @@
+module MnoEnterprise
+  class Nimbus::V4::EventsController < Nimbus::V4::BaseController
+
+    private
+      def hash_for(resource)
+        resource
+      end
+
+      def resource_klass
+        MnoEnterprise::Invoice
+      end
+
+      # Retrieve all resources
+      def get_resources
+        app_instances_by_uid = MnoEnterprise::AppInstance.all.index_by(&:uid)
+        invoices_request = MnoEnterprise::Invoice.all
+        invoices_request.params[:currency] = Settings.westcon.api.events.currency
+        invoices_request.to_a.select { |invoice| invoice[:updated_at] != nil }.map { |invoice|
+          invoice.billing_summary.each_with_index.map { |bill, i|
+            # price_tag is deprecated
+            bill['lines'].each_with_index.map { |line, j|
+              price = line[:converted_price] || line[:price] || Monetize.parse(line[:price_tag])
+              app_instance = app_instances_by_uid[bill[:app_uid]]
+              if app_instance
+                product = app_instance.app.nid
+              end
+              {
+                  id: "evt-#{invoice.id}b#{i}l#{j}",
+                  event_type: 'financial',
+                  amount_cents: price.cents,
+                  amount_currency: price.currency.iso_code,
+                  label: bill[:label] +' - ' + line[:label],
+                  tx_type: 'charge',
+                  organization_id: invoice.organization.uid,
+                  type: bill[:app_uid] ? 'app' : 'other',
+                  app_instance_id: bill[:app_uid],
+                  app_instance_product: product,
+                  started_at: invoice.started_at,
+                  ended_at: invoice.ended_at,
+                  created_at: invoice.created_at
+
+              }
+            }.flatten
+          }
+        }.flatten
+      end
+
+      def get_resource(id)
+        get_resources.find { |e| e[:id] == id }
+      end
+  end
+end