cyclid 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 52003b67cb59f27d6ef7bea410f715d6b8714c33
+  data.tar.gz: 08e3f06342e7ac69bc8917dd17d47c1ba72aec65
+SHA512:
+  metadata.gz: 400fc554727abcbdfcdd65ca57005ea912e7b725d6568d972cdcb07f0c9bea30c4c90feee27660f00f9fa9d54cb607d9d471f3895c4433593cef1174526dbd34
+  data.tar.gz: 172919cb2f58442730393e9c6c6cce91423c25dabeeec13641925304374d84ed55fd6c9247895cc0b05be85cef3286c5f84edb031b52111c2d6bc62b5d1901a5

data/LICENSE

@@ -0,0 +1,174 @@
+                            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.

data/README.md

@@ -0,0 +1,54 @@
+Cyclid
+======
+
+# Getting started
+```
+$ rbenv install 2.3.0
+$ bundle install --path vendor/bundle
+$ bundle exec rake db:migrate
+$ CYCLID_CONFIG=config/development bundle exec bin/cyclid-db-init
+```
+Cyclid requires a Redis server for Sidekiq; you can either run a Redis server on your local machine or run `bundle exec rake redis` to start one.
+
+You can start Cyclid under Webrick with `bundle exec rake rackup`, and then start Sidekiq with `bundle exec rake sidekiq`, or you can run both under Guard with `bundle exec rake guard`.
+
+You can use curl or wget with HTTP Basic authentication, or the `test/hmac-test.rb` command for GET's using HMAC authentication.
+
+# Testing
+
+RSpec tests are included. Run `bundle exec rake spec` to run the tests and generate a coverage report into the `coverage` directory. The tests do not affect any databases and external API calls are mocked.
+
+The Cyclid source code is also expected to pass Rubocop; run `bundle exec rake rubocop` to lint the code.
+
+# Documentation
+
+Cyclid uses YARD to generate documentation for both the Ruby API (internal Modules, Classes & Methods) and the REST API. Run `bundle exec rake doc` to generate both sets of documentation. The Ruby documentation is placed in the `doc/api` directory, and the REST API documentation is placed in the `doc/rest` directory.
+
+## Test data
+
+The `test/db-loader.rb` script creates two users ('admin' and 'test'), and two organizations ('admins' and 'test).
+
+### Users
+
+An admin (Super Admin) user is configured with the following attributes:
+
+* Username: admin
+* Email: admin@example.com
+* Password: password
+* Secret: aasecret55
+
+A test user is configured with the following attributes:
+
+* Username: test
+* Email: test@example.com
+* Password: aapassword55
+* Secret: aasecret55
+
+### Organizations
+
+Two Organizations are created:
+
+* admins
+* test
+
+The admin user is a member of admins, and the test user is a member of test.

data/app/cyclid.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+# Copyright 2016 Liqwyd Ltd.
+#
+# 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.
+
+require 'require_all'
+require 'logger'
+
+require 'cyclid/config'
+require 'cyclid/plugin_registry'
+
+# Top level module for the core Cyclid code.
+module Cyclid
+  class << self
+    attr_accessor :config, :controllers, :plugins, :dispatcher, :builder, :logger
+
+    config_path = ENV['CYCLID_CONFIG'] || File.join(%w(/ etc cyclid config))
+    Cyclid.config = API::Config.new(config_path)
+
+    Cyclid.controllers = []
+    Cyclid.plugins = API::Plugins::Registry.new
+
+    begin
+      Cyclid.logger = if Cyclid.config.log.casecmp('stderr').zero?
+                        Logger.new(STDERR)
+                      else
+                        Logger.new(Cyclid.config.log)
+                      end
+    rescue StandardError => ex
+      abort "Failed to initialize: #{ex}"
+    end
+  end
+end
+
+require_relative 'db'
+
+require 'cyclid/monkey_patches'
+require 'cyclid/constants'
+require 'cyclid/errors'
+require 'cyclid/models'
+require 'cyclid/hmac'
+require 'cyclid/plugins'
+require 'cyclid/job'
+require 'cyclid/controllers'
+
+dispatcher = Cyclid.plugins.find(Cyclid.config.dispatcher, Cyclid::API::Plugins::Dispatcher)
+abort "Could not find dispatcher '#{Cyclid.config.dispatcher}'" if dispatcher.nil?
+Cyclid.dispatcher = dispatcher.new
+
+Cyclid.builder = Cyclid.plugins.find(Cyclid.config.builder, Cyclid::API::Plugins::Builder)
+abort "Could not find builder '#{Cyclid.config.builder}'" if Cyclid.builder.nil?

data/app/cyclid/config.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+# Copyright 2016 Liqwyd Ltd.
+#
+# 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.
+
+require 'yaml'
+
+module Cyclid
+  module API
+    # Cyclid API configuration
+    class Config
+      attr_reader :database, :log, :dispatcher, :builder, :plugins
+
+      def initialize(path)
+        config = YAML.load_file(path)
+        server = config['server']
+
+        @database = server['database']
+        @log = server['log'] || File.join(%w(/ var log cyclid server))
+        @dispatcher = server['dispatcher']
+        @builder = server['builder']
+        @plugins = server['plugins'] || {}
+      rescue StandardError => ex
+        abort "Failed to load configuration file #{path}: #{ex}"
+      end
+    end
+  end
+end

data/app/cyclid/controllers.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+# Copyright 2016 Liqwyd Ltd.
+#
+# 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.
+
+require 'sinatra/base'
+require 'sinatra/namespace'
+require 'sinatra/cross_origin'
+require 'warden'
+
+require_relative 'sinatra/warden/strategies/basic'
+require_relative 'sinatra/warden/strategies/hmac'
+require_relative 'sinatra/warden/strategies/api_token'
+
+require_relative 'sinatra/api_helpers'
+require_relative 'sinatra/auth_helpers'
+
+# Define some YARD macros that can be used to create the REST API documentation
+
+# @!macro [new] rest
+#   @!scope instance
+#   @api REST
+
+# Top level module for the core Cyclid code.
+module Cyclid
+  # Module for the Cyclid API
+  module API
+    # Base class for all API Controllers
+    class ControllerBase < Sinatra::Base
+      include Errors::HTTPErrors
+
+      register Operations
+      register Sinatra::Namespace
+      register Sinatra::CrossOrigin
+
+      helpers APIHelpers, AuthHelpers
+
+      # The API always returns JSON
+      before do
+        content_type :json
+      end
+
+      # Configure CORS
+      configure do
+        enable :cross_origin
+        set :allow_origin, :any
+        set :allow_methods, [:get, :put, :post, :options]
+        set :allow_credentials, true
+        set :max_age, '1728000'
+        set :expose_headers, ['Content-Type']
+        disable :show_exceptions
+      end
+
+      options '*' do
+        response.headers['Allow'] = 'HEAD,GET,PUT,POST,DELETE,OPTIONS'
+        response.headers['Access-Control-Allow-Headers'] =
+          'Content-Type, Cache-Control, Accept, Authorization'
+        200
+      end
+
+      # Configure Warden to authenticate
+      use Warden::Manager do |config|
+        config.serialize_into_session(&:id)
+        config.serialize_from_session{ |id| User.find_by_id(id) }
+
+        config.scope_defaults :default,
+                              strategies: [:basic, :hmac, :api_token],
+                              action: '/unauthenticated'
+
+        config.failure_app = self
+      end
+
+      Warden::Manager.before_failure do |env, _opts|
+        env['REQUEST_METHOD'] = 'POST'
+      end
+
+      register Strategies::Basic
+      register Strategies::HMAC
+      register Strategies::APIToken
+
+      post '/unauthenticated' do
+        content_type :json
+        # Stop Warden from calling this endpoint again in an endless loop when
+        # it sees the 401 response
+        env['warden'].custom_failure!
+        halt_with_json_response(401, AUTH_FAILURE, 'invalid username or password')
+      end
+    end
+  end
+end
+
+# Load any and all controllers
+require_rel 'controllers/*.rb'
+
+# Top level module for the core Cyclid code.
+module Cyclid
+  # Module for the Cyclid API
+  module API
+    # Sintra application for the REST API
+    class App < Sinatra::Base
+      # Set up the Sinatra configuration
+      configure do
+        enable :logging
+      end
+
+      # Register all of the controllers with Sinatra
+      Cyclid.controllers.each do |controller|
+        Cyclid.logger.debug "Using Sinatra controller #{controller}"
+        use controller
+      end
+    end
+  end
+end