aptible-comply 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 73797d7e74a221dbb6b6ea159a026bddb3faad4fd857a09dd6fe39a575029609
+  data.tar.gz: c40df7143b96673aee11ab478c4b209cecbc37310f567bc2f594e8858ee854e6
+SHA512:
+  metadata.gz: 518b73e24ca28ca6ed1ba5564484a691406e88714fa6e208d6aec140ce06334726442fae49365c5a28d4f4266abdd7861ed87293b1f8099086b77c3de3ff5d2b
+  data.tar.gz: bbb40ef281fbf9b3a09deb16b12731de09428d87fe514630f0ef653e01e5752d8d2b95619890d9174fbfd5c5a613668c78602182c19df127f514e4f2a518b63b

data/.github/CODEOWNERS

@@ -0,0 +1 @@
+*   @dawenster

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in aptible-api.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Aptible, Inc.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Procfile

@@ -0,0 +1 @@
+console: bundle exec pry -r aptible/comply -r aptible/auth

data/README.md

@@ -0,0 +1,49 @@
+# Aptible::Comply
+
+Ruby client for [comply.aptible.com](https://comply.aptible.com/). The Comply server is built on top of [HAL+JSON](http://tools.ietf.org/html/draft-kelly-json-hal-06), and so this client is just a thin layer on top of the [HyperResource](https://github.com/gamache/hyperresource) gem.
+
+## Installation
+
+Add the following lines to your application's Gemfile.
+
+    gem 'aptible-comply'
+
+And then run `bundle install`.
+
+## Usage
+
+First, get a token:
+
+```ruby
+token = Aptible::Auth::Token.create(email: 'user0@example.com', password: 'password')
+```
+
+From here, you can interact with the Comply server.
+
+## Configuration
+
+| Parameter | Description | Default |
+| --------- | ----------- | --------------- |
+| `root_url` | Root URL of the Comply server | `ENV['APTIBLE_COMPLY_ROOT_URL']` or [https://comply-api.aptible.com](https://comply-api.aptible.com) |
+
+To point the client at a different server (e.g., during development), add the following to your application's initializers (or set the `APTIBLE_COMPLY_ROOT_URL` environment variable):
+
+```ruby
+Aptible::Comply.configure do |config|
+  config.root_url = 'http://some.other.url'
+end
+```
+
+## Contributing
+
+1. Fork the project.
+1. Commit your changes, with specs.
+1. Ensure that your code passes specs (`rake spec`) and meets Aptible's Ruby style guide (`rake rubocop`).
+1. Create a new pull request on GitHub.
+
+## Copyright and License
+
+MIT License, see [LICENSE](LICENSE.md) for details.
+
+Copyright (c) 2019 [Aptible](https://www.aptible.com) and contributors.
+

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+
+require 'aptible/tasks'
+Aptible::Tasks.load_tasks

data/comply-ruby.gemspec

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'English'
+require 'aptible/comply/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'aptible-comply'
+  spec.version       = Aptible::Comply::VERSION
+  spec.authors       = ['Frank Macreery']
+  spec.email         = ['frank@macreery.com']
+  spec.description   = 'Ruby client for compliance-os-dashboard.aptible.com'
+  spec.summary       = 'Ruby client for compliance-os-dashboard.aptible.com'
+  spec.homepage      = 'https://github.com/aptible/comply-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($RS)
+  spec.test_files    = spec.files.grep(%r{^spec\/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'aptible-auth', '>= 0.11.10'
+  spec.add_dependency 'aptible-resource', '>= 0.3.7'
+  spec.add_dependency 'gem_config'
+
+  spec.add_development_dependency 'activesupport'
+  spec.add_development_dependency 'aptible-tasks', '>= 0.4.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-its'
+end

data/lib/aptible/comply.rb

@@ -0,0 +1,18 @@
+require 'aptible/auth'
+require 'gem_config'
+
+module Aptible
+  module Comply
+    include GemConfig::Base
+
+    with_configuration do
+      has :root_url,
+          classes: [String],
+          default: ENV['APTIBLE_COMPLY_ROOT_URL'] ||
+                   'https://comply-api-prototype.aptible.com'
+    end
+  end
+end
+
+require 'aptible/comply/resource'
+require 'aptible/comply/agent'

data/lib/aptible/comply/agent.rb

@@ -0,0 +1,6 @@
+module Aptible
+  module Comply
+    class Agent < Resource
+    end
+  end
+end

data/lib/aptible/comply/asset.rb

@@ -0,0 +1,16 @@
+module Aptible
+  module Comply
+    class Asset < Resource
+      belongs_to :program
+      belongs_to :vendor
+      has_many :asset_reviews
+      has_many :grants
+
+      field :id
+      field :asset_type
+      field :name
+      field :owner
+      field :current_check_result
+    end
+  end
+end

data/lib/aptible/comply/asset_review.rb

@@ -0,0 +1,13 @@
+module Aptible
+  module Comply
+    class AssetReview < Resource
+      belongs_to :asset
+
+      field :review_type
+      field :workflow_id
+      field :reviewer_id
+      field :completed_at, type: Time
+      field :notes
+    end
+  end
+end

data/lib/aptible/comply/grant.rb

@@ -0,0 +1,10 @@
+module Aptible
+  module Comply
+    class Grant < Resource
+      belongs_to :asset
+      embeds_one :access_recipient
+
+      field :status
+    end
+  end
+end

data/lib/aptible/comply/group.rb

@@ -0,0 +1,11 @@
+module Aptible
+  module Comply
+    class Group < Resource
+      belongs_to :program
+      has_many :memberships
+      embeds_many :memberships
+
+      field :name
+    end
+  end
+end

data/lib/aptible/comply/integration.rb

@@ -0,0 +1,10 @@
+module Aptible
+  module Comply
+    class Integration < Resource
+      belongs_to :program
+
+      field :integration_type
+      field :env
+    end
+  end
+end

data/lib/aptible/comply/membership.rb

@@ -0,0 +1,8 @@
+module Aptible
+  module Comply
+    class Membership < Resource
+      belongs_to :group
+      embeds_one :person
+    end
+  end
+end

data/lib/aptible/comply/person.rb

@@ -0,0 +1,11 @@
+module Aptible
+  module Comply
+    class Person < Resource
+      belongs_to :program
+
+      field :first_name
+      field :last_name
+      field :email
+    end
+  end
+end

data/lib/aptible/comply/program.rb

@@ -0,0 +1,24 @@
+module Aptible
+  module Comply
+    class Program < Resource
+      has_many :assets
+      has_many :vendors
+      has_many :people
+      has_many :groups
+      has_many :integrations
+
+      field :id
+
+      def organization_url
+        links['organization'].href
+      end
+
+      def organization
+        return @organization if @organization
+
+        auth = Aptible::Auth::Organization.new(token: token, headers: headers)
+        @organization = auth.find_by_url(organization_url)
+      end
+    end
+  end
+end

data/lib/aptible/comply/resource.rb

@@ -0,0 +1,25 @@
+require 'aptible/resource'
+
+module Aptible
+  module Comply
+    class Resource < Aptible::Resource::Base
+      def namespace
+        'Aptible::Comply'
+      end
+
+      def root_url
+        Aptible::Comply.configuration.root_url
+      end
+    end
+  end
+end
+
+require 'aptible/comply/program'
+require 'aptible/comply/asset'
+require 'aptible/comply/vendor'
+require 'aptible/comply/person'
+require 'aptible/comply/group'
+require 'aptible/comply/grant'
+require 'aptible/comply/membership'
+require 'aptible/comply/asset_review'
+require 'aptible/comply/integration'

data/lib/aptible/comply/vendor.rb

@@ -0,0 +1,17 @@
+module Aptible
+  module Comply
+    class Vendor < Resource
+      belongs_to :program
+      belongs_to :vendor
+
+      field :name
+      field :description
+      field :aptible_products
+      field :claimed
+      field :logo_url
+      field :website_url
+      field :banner_meta
+      field :badges
+    end
+  end
+end

data/lib/aptible/comply/version.rb

@@ -0,0 +1,5 @@
+module Aptible
+  module Comply
+    VERSION = '0.1.0'.freeze
+  end
+end

data/spec/aptible/comply/agent_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Aptible::Comply::Agent do
+  it { should be_a Aptible::Comply::Resource }
+end

data/spec/aptible/comply/resource_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe Aptible::Comply::Resource do
+  its(:namespace) { should eq 'Aptible::Comply' }
+  its(:root_url) { should eq 'https://comply-api.aptible.com' }
+end

data/spec/aptible/comply_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Aptible::Comply do
+  subject { Aptible::Comply::Protocol.new }
+
+  it 'should have a configurable root_url' do
+    config = described_class.configuration
+    expect(config).to be_a GemConfig::Configuration
+    expect(config.root_url).to eq 'https://comply-api.aptible.com'
+  end
+
+  skip 'uses ENV["APTIBLE_COMPLY_ROOT_URL"] if defined' do
+    config = described_class.configuration
+    with_env 'APTIBLE_COMPLY_ROOT_URL', 'http://foobar.com' do
+      config.reset
+      expect(config.root_url).to eq 'http://foobar.com'
+    end
+  end
+end

data/spec/shared/with_env.rb

@@ -0,0 +1,10 @@
+def with_env(*args)
+  hash = args.first.is_a?(Hash) ? args.first : Hash[*args]
+  old_values = Hash[hash.map { |k, _| [k, ENV[k]] }]
+  begin
+    hash.each { |k, v| ENV[k] = v }
+    yield
+  ensure
+    old_values.each { |k, v| ENV[k] = v }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec/its'
+
+# Load shared spec files
+Dir["#{File.dirname(__FILE__)}/shared/**/*.rb"].each do |file|
+  require file
+end
+
+# Require library up front
+require 'aptible/comply'
+
+RSpec.configure do |config|
+  config.before { Aptible::Comply.configuration.reset }
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: aptible-comply
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Frank Macreery
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aptible-auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.10
+- !ruby/object:Gem::Dependency
+  name: aptible-resource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.7
+- !ruby/object:Gem::Dependency
+  name: gem_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aptible-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby client for compliance-os-dashboard.aptible.com
+email:
+- frank@macreery.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/CODEOWNERS"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- Procfile
+- README.md
+- Rakefile
+- comply-ruby.gemspec
+- lib/aptible/comply.rb
+- lib/aptible/comply/.DS_Store
+- lib/aptible/comply/agent.rb
+- lib/aptible/comply/asset.rb
+- lib/aptible/comply/asset_review.rb
+- lib/aptible/comply/grant.rb
+- lib/aptible/comply/group.rb
+- lib/aptible/comply/integration.rb
+- lib/aptible/comply/membership.rb
+- lib/aptible/comply/person.rb
+- lib/aptible/comply/program.rb
+- lib/aptible/comply/resource.rb
+- lib/aptible/comply/vendor.rb
+- lib/aptible/comply/version.rb
+- spec/aptible/comply/agent_spec.rb
+- spec/aptible/comply/resource_spec.rb
+- spec/aptible/comply_spec.rb
+- spec/shared/with_env.rb
+- spec/spec_helper.rb
+homepage: https://github.com/aptible/comply-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby client for compliance-os-dashboard.aptible.com
+test_files:
+- spec/aptible/comply/agent_spec.rb
+- spec/aptible/comply/resource_spec.rb
+- spec/aptible/comply_spec.rb
+- spec/shared/with_env.rb
+- spec/spec_helper.rb