aptible-gridiron 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3194ca3112f7c2c9adcd06904ad681ca00ced37c
+  data.tar.gz: f31fa4fda6c721aafae9f42de9a9edcc76a865e7
+SHA512:
+  metadata.gz: 0ae03ee9ed2f392c72910a473f1fbca5d82dbffa48dd9089b0119c98562ad1c954596736008b49fadfe46ef455d1a1de2fc48dd7378adb82a24fb78427fc0240
+  data.tar.gz: 4147963ff65de92ed65d4e4e7d9a36f916fa8e633ba98ae9f9107c2449c7163a1fa1ebd8cbc4ed6dee7798fddeea5f86a4f11322f5df918e2e01ba96b6f4dd06

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,3 @@
+rvm:
+  - 2.0.0
+  - jruby

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'pry', github: 'fancyremarker/pry', branch: 'aptible'
+
+# 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/gridiron -r aptible/auth

data/README.md

@@ -0,0 +1,88 @@
+# ![](https://raw.github.com/aptible/straptible/master/lib/straptible/rails/templates/public.api/icon-60px.png) Aptible::Gridiron
+
+[![Gem Version](https://badge.fury.io/rb/gridiron.png)](https://rubygems.org/gems/gridiron)
+[![Build Status](https://travis-ci.org/aptible/gridiron-ruby.png?branch=master)](https://travis-ci.org/aptible/gridiron-ruby)
+[![Dependency Status](https://gemnasium.com/aptible/gridiron-ruby.png)](https://gemnasium.com/aptible/gridiron-ruby)
+
+Ruby client for [gridiron.aptible.com](https://gridiron.aptible.com/). The Gridiron 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-gridiron'
+
+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 Gridiron server however you wish:
+
+```ruby
+gridiron = Aptible::Gridiron::Agent.new(token: token)
+protocol = gridiron.protocols.first
+protocol.procedures.count
+# => 356
+procedure = protocol.procedures.first
+# => "Obtain and review IT acquisition policy and procedures..."
+procedure.criteria.count
+# => 1
+criterion = procedure.criteria.first
+criterion.name
+# => "Policy Manual"
+```
+
+To work with organization-specific evidence (i.e., documents and events), you may set the `Aptible::Gridiron.configuration.organization` variable. For example:
+
+```ruby
+organization = Aptible::Auth::Organization.all(token: token).first
+Aptible::Gridiron.configure do |config|
+  config.organization = organization
+end
+
+gridiron = Aptible::Gridiron::Agent.new(token: token)
+criterion = gridiron.protocols.first.procedures.first.criteria.first
+criterion.documents.count
+# => 1
+document = criterion.create_document!(
+  print_version: 'http://knowyourmeme.com/photos/11296-success'
+)
+document.print_version.href
+# => "http://knowyourmeme.com/photos/11296-success"
+document.expires_at
+# => 2015-07-08 00:10:31 UTC
+```
+
+## Configuration
+
+| Parameter | Description | Default |
+| --------- | ----------- | --------------- |
+| `root_url` | Root URL of the Gridiron server | `ENV['GRIDIRON_ROOT_URL']` or [https://gridiron.aptible.com](https://gridiron.aptible.com) |
+| `organization` | `Aptible::Auth::Organization` instance to be used for all documents/events | `nil` |
+
+To point the client at a different server (e.g., during development), add the following to your application's initializers (or set the `GRIDIRON_ROOT_URL` environment variable):
+
+```ruby
+Aptible::Gridiron.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) 2013 [Aptible](https://www.aptible.com), Frank Macreery, and contributors.

data/Rakefile

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

data/gridiron-ruby.gemspec

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

data/lib/aptible/gridiron.rb

@@ -0,0 +1,24 @@
+require 'aptible/auth'
+require 'gem_config'
+
+ActiveSupport::Inflector.inflections do |inflect|
+  inflect.irregular 'criterion', 'criteria'
+end
+
+module Aptible
+  module Gridiron
+    include GemConfig::Base
+
+    with_configuration do
+      has :root_url,
+          classes: [String],
+          default: ENV['GRIDIRON_ROOT_URL'] || 'https://gridiron.aptible.com'
+      has :organization,
+          classes: [Aptible::Auth::Organization, NilClass],
+          default: nil
+    end
+  end
+end
+
+require 'aptible/gridiron/resource'
+require 'aptible/gridiron/agent'

data/lib/aptible/gridiron/agent.rb

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

data/lib/aptible/gridiron/criterion.rb

@@ -0,0 +1,16 @@
+module Aptible
+  module Gridiron
+    class Criterion < Resource
+      has_many :documents
+      has_many :events
+
+      field :id
+      field :handle
+      field :name
+      field :description
+      field :evidence_type
+      field :scope
+      field :default_expiry
+    end
+  end
+end

data/lib/aptible/gridiron/document.rb

@@ -0,0 +1,11 @@
+module Aptible
+  module Gridiron
+    class Document < Evidence
+      field :expires_at, type: Time
+
+      def print_version
+        links['print_version']
+      end
+    end
+  end
+end

data/lib/aptible/gridiron/event.rb

@@ -0,0 +1,6 @@
+module Aptible
+  module Gridiron
+    class Event < Evidence
+    end
+  end
+end

data/lib/aptible/gridiron/evidence.rb

@@ -0,0 +1,25 @@
+module Aptible
+  module Gridiron
+    class Evidence < Resource
+      belongs_to :criterion
+
+      field :id
+      field :data
+
+      def organization
+        auth = Aptible::Auth::Organization.new(token: token, headers: headers)
+        auth.find_by_url(links['organization'].href)
+      end
+
+      def user
+        auth = Aptible::Auth::User.new(token: token, headers: headers)
+        auth.find_by_url(links['user'].href)
+      end
+
+      def app
+        api = Aptible::Api::App.new(token: token, headers: headers)
+        api.find_by_url(links['app'].href)
+      end
+    end
+  end
+end

data/lib/aptible/gridiron/procedure.rb

@@ -0,0 +1,12 @@
+module Aptible
+  module Gridiron
+    class Procedure < Resource
+      field :action
+
+      belongs_to :requirement
+      has_many :criteria
+      has_many :documents
+      has_many :events
+    end
+  end
+end

data/lib/aptible/gridiron/protocol.rb

@@ -0,0 +1,13 @@
+module Aptible
+  module Gridiron
+    class Protocol < Resource
+      has_many :requirements
+      has_many :procedures
+      has_many :criteria
+
+      field :id
+      field :version
+      field :published_at, type: Time
+    end
+  end
+end

data/lib/aptible/gridiron/requirement.rb

@@ -0,0 +1,19 @@
+module Aptible
+  module Gridiron
+    class Requirement < Resource
+      belongs_to :protocol
+      has_many :procedures
+
+      field :id
+      field :description
+      field :section
+      field :subsection
+      field :rule
+      field :relevant_provision
+      field :provision_type
+      field :specification_type
+      field :standard_title
+      field :performance_criteria
+    end
+  end
+end

data/lib/aptible/gridiron/resource.rb

@@ -0,0 +1,41 @@
+require 'aptible/resource'
+
+module Aptible
+  module Gridiron
+    class Resource < Aptible::Resource::Base
+      def self.normalize_params(params = {})
+        # TODO: Figure out a more natural solution than this monkey patch
+        if (organization = Aptible::Gridiron.configuration.organization)
+          params.merge!(organization: organization.href)
+        end
+
+        super(params)
+      end
+
+      def outgoing_uri_filter(params)
+        if (organization = Aptible::Gridiron.configuration.organization)
+          params.merge!(organization: organization.href)
+        end
+
+        params
+      end
+
+      def namespace
+        'Aptible::Gridiron'
+      end
+
+      def root_url
+        Aptible::Gridiron.configuration.root_url
+      end
+    end
+  end
+end
+
+require 'aptible/gridiron/protocol'
+require 'aptible/gridiron/requirement'
+require 'aptible/gridiron/procedure'
+require 'aptible/gridiron/criterion'
+
+require 'aptible/gridiron/evidence'
+require 'aptible/gridiron/document'
+require 'aptible/gridiron/event'

data/lib/aptible/gridiron/version.rb

@@ -0,0 +1,5 @@
+module Aptible
+  module Gridiron
+    VERSION = '0.1.0'
+  end
+end

data/spec/aptible/gridiron/agent_spec.rb

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

data/spec/aptible/gridiron/resource_spec.rb

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

data/spec/aptible/gridiron_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Aptible::Gridiron do
+  subject { Aptible::Gridiron::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://gridiron.aptible.com'
+  end
+
+  skip 'uses ENV["GRIDIRON_ROOT_URL"] if defined' do
+    config = described_class.configuration
+    with_env 'GRIDIRON_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/gridiron'
+
+RSpec.configure do |config|
+  config.before { Aptible::Gridiron.configuration.reset }
+end

metadata

@@ -0,0 +1,228 @@
+--- !ruby/object:Gem::Specification
+name: aptible-gridiron
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Frank Macreery
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aptible-resource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: aptible-auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: 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: 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'
+- !ruby/object:Gem::Dependency
+  name: foreman
+  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: 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'
+description: Ruby client for gridiron.aptible.com
+email:
+- frank@macreery.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.md
+- Procfile
+- README.md
+- Rakefile
+- gridiron-ruby.gemspec
+- lib/aptible/gridiron.rb
+- lib/aptible/gridiron/agent.rb
+- lib/aptible/gridiron/criterion.rb
+- lib/aptible/gridiron/document.rb
+- lib/aptible/gridiron/event.rb
+- lib/aptible/gridiron/evidence.rb
+- lib/aptible/gridiron/procedure.rb
+- lib/aptible/gridiron/protocol.rb
+- lib/aptible/gridiron/requirement.rb
+- lib/aptible/gridiron/resource.rb
+- lib/aptible/gridiron/version.rb
+- spec/aptible/gridiron/agent_spec.rb
+- spec/aptible/gridiron/resource_spec.rb
+- spec/aptible/gridiron_spec.rb
+- spec/shared/with_env.rb
+- spec/spec_helper.rb
+homepage: https://github.com/aptible/gridiron-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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby client for gridiron.aptible.com
+test_files:
+- spec/aptible/gridiron/agent_spec.rb
+- spec/aptible/gridiron/resource_spec.rb
+- spec/aptible/gridiron_spec.rb
+- spec/shared/with_env.rb
+- spec/spec_helper.rb