roles-management-api 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bdb03f8036e789d47ddb10560a3442c021f1fcda
+  data.tar.gz: 32b5243c81c75337261d8467c9f071b5bf7059b2
+SHA512:
+  metadata.gz: d04851c32b1883bf512a805e923324dbc2aa968b5e0c61cea4a65a5d2afca0597b34fbec97350c7daf425c4bdec5a9aa261b5a2b85cdbd2050deb365894d4813
+  data.tar.gz: 02720c2cd409777fb71cc2873519ba1560cd071e3fe9c058a77371effb73bab3d869a1efc1658537bed622d5e7110d38f417434972194dd1d8a6228e2e7a717e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,56 @@
+# Roles Management API
+
+Ruby gem for interacting with the DSS IT Roles Management API system.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'roles-management-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install roles-management-api
+
+## Usage
+
+```ruby
+client = RolesManagementAPI.login("https://roles.installation.url/api", "Username", "API Key")
+client.connected?
+
+r = client.find_role_by_id(1234)
+puts "Role has #{r.assignments.length} assignments."
+
+p = client.find_person_by_loginid('somebody')
+puts "'somebody' user has full name of #{p.name}"
+
+# You can also do: p = client.find_entity_by_id(123) if you know the ID
+
+puts "Removing first assignment from role ..."
+r.assignments.delete(r.assignments[0])
+client.save(r)
+
+puts "Adding 'somebody' to role ..."
+r.assignments << p
+client.save(r)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/dssit/roles-management-api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "roles-management-api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/roles-management-api.rb

@@ -0,0 +1,23 @@
+require "roles-management-api/version"
+require "roles-management-api/person"
+require "roles-management-api/role_assignment"
+require "roles-management-api/role"
+require "roles-management-api/client"
+
+require "json"
+require "net/http"
+require "uri"
+
+module RolesManagementAPI
+  # Creates an instance of the RolesManagementAPIClient upon successful login
+  # or returns false.
+  def RolesManagementAPI.login(url, username, api_key)
+    client = RolesManagementAPI::Client.new(url, username, api_key)
+
+    if client.connected?
+      return client
+    else
+      return false
+    end
+  end
+end

data/lib/roles-management-api/client.rb

@@ -0,0 +1,111 @@
+module RolesManagementAPI
+  @@client = nil
+
+  class Client
+    attr_accessor :url, :username, :api_key
+
+    @conn = nil
+    @uri = nil
+
+    def initialize(url, username, api_key)
+      @uri = URI.parse(url)
+
+      @conn = Net::HTTP.new(@uri.host, @uri.port)
+      @conn.use_ssl = true if @uri.scheme == "https"
+
+      @username = username
+      @api_key = api_key
+    end
+
+    # Returns true if the API endpoint and key are valid and can connect
+    def connected?
+      response = get_request("validate")
+
+      return response.code == "200"
+    end
+
+    def save(object)
+      if object.is_a? RolesManagementAPI::Role
+        response = put_request("roles/" + object.id.to_s + ".json", object.as_json)
+        return response
+      else
+        STDERR.puts "Cannot save object: type '#{object.class}' not supported."
+        return false
+      end
+    end
+
+    # Returns a Role object for the given role_id or nil on error / not found
+    def find_role_by_id(role_id)
+      response = get_request("roles/" + role_id.to_s + ".json")
+
+      return nil unless response.code == "200"
+
+      json = JSON.parse(response.body, symbolize_names: true)
+
+      return Role.new(role_id, json)
+    end
+
+    # Returns a Person object for the given loginid or nil on error / not found
+    def find_entity_by_id(id)
+      response = get_request("entities/" + id.to_s + ".json")
+
+      return nil unless response.code == "200"
+
+      json = JSON.parse(response.body, symbolize_names: true)
+
+      if json[:type] == "Person"
+        return Person.new(json)
+      else
+        STDERR.puts "Did not understand entity type returned by RM."
+        return nil
+      end
+    end
+
+    # Returns a Person object for the given loginid or nil on error / not found
+    def find_person_by_loginid(loginid)
+      response = get_request("people/" + loginid + ".json")
+
+      return nil unless response.code == "200"
+
+      json = JSON.parse(response.body, symbolize_names: true)
+
+      return Person.new(json)
+    end
+
+    private
+
+      # Performs a HTTP GET using the configured API endpoint and key
+      def get_request(url)
+        request_url = @uri.request_uri + "/" + url
+        request = Net::HTTP::Get.new(request_url)
+        request = sign_request(request)
+
+        response = @conn.request(request)
+
+        STDERR.puts "Error querying RM, response code was #{response.code} for URL #{request_url}." unless response.code == "200"
+
+        return response
+      end
+
+      # Performs a HTTP POST using the configured API endpoint and key
+      def put_request(url, data)
+        request = Net::HTTP::Put.new(@uri.request_uri + "/" + url, initheader = {'Content-Type' =>'application/json'})
+        request = sign_request(request)
+
+        request.body = data.to_json
+
+        return @conn.request(request)
+      end
+
+      # Adds the necessary HTTP headers and API key to a request
+      def sign_request(request)
+        # RM requires we specify which version of the API we want
+        request.add_field("Accept", "application/vnd.roles-management.v1")
+        # RM requires we provide the username and API key via HTTP Basic Auth
+        request.basic_auth(@username, @api_key)
+
+        return request
+      end
+
+  end
+end

data/lib/roles-management-api/person.rb

@@ -0,0 +1,24 @@
+module RolesManagementAPI
+  class Person
+    attr_accessor :id, :loginid, :name, :role_assignments, :group_memberships
+
+    # Creates a new Person object from a JSON object
+    def initialize(json)
+      @id = json[:id]
+      @loginid = json[:loginid]
+      @name = json[:name]
+      @role_assignments = json[:role_assignments]
+      @group_memberships = json[:group_memberships]
+    end
+
+    def as_json
+      json = {}
+
+      json.merge({
+        id: @id,
+        loginid: @loginid,
+        name: @name
+      })
+    end
+  end
+end

data/lib/roles-management-api/role.rb

@@ -0,0 +1,81 @@
+module RolesManagementAPI
+  class Role
+    attr_accessor :id, :application_id, :description, :name, :token, :assignments, :members
+
+    # Creates a new Role object from a NET/HTTP response (see client.rb)
+    def initialize(role_id, json)
+      @id = role_id
+      @application_id = json[:application_id]
+      @description = json[:description]
+      @name = json[:name]
+      @token = json[:token]
+
+      @assignments = RoleAssignmentArray.new(role_id)
+      json[:role_assignments_attributes].each do |assignment_json|
+        @assignments << RoleAssignment.new(assignment_json)
+      end
+
+      @members = []
+      json[:members].each do |member|
+        @members << Person.new(member)
+      end
+    end
+
+    def as_json
+      {
+        role: {
+          role_assignments_attributes: @assignments.as_json
+        }
+      }
+    end
+  end
+
+  # RoleAssignmentArray is an array-like class used by Role for maintaining its
+  # assignment list. Its primary purpose is to add the Rails-required "_destroy: true"
+  # attribute in its as_json for any assignment which has been removed.
+  class RoleAssignmentArray
+    def initialize(role_id)
+      @assignments = []
+      @role_id = role_id
+    end
+
+    def <<(assignment)
+      raise "You may only add objects of type 'RoleAssignment' or 'Person'" unless assignment.is_a?(RoleAssignment) or assignment.is_a?(Person)
+
+      if assignment.is_a?(Person)
+        @assignments << RoleAssignment.new({entity_id: assignment.id, role_id: @role_id})
+      else
+        @assignments << assignment
+      end
+    end
+
+    def [](idx)
+      @assignments[idx]
+    end
+
+    def each &block
+      @assignments.each &block
+    end
+
+    def length
+      @assignments.length
+    end
+
+    def delete(member)
+      raise "You may only delete objects of type 'RoleAssignment'" unless member.is_a?(RoleAssignment)
+
+      @assignments.each do |assignment|
+        if (assignment.id == member.id) and (member.id != nil)
+          assignment.destroy = true
+          return true
+        end
+      end
+
+      return false
+    end
+
+    def as_json
+      @assignments.map{ |a| a.as_json }
+    end
+  end
+end

data/lib/roles-management-api/role_assignment.rb

@@ -0,0 +1,24 @@
+module RolesManagementAPI
+  class RoleAssignment
+    attr_accessor :id, :entity_id, :role_id, :destroy
+
+    # Creates a new Person object from a JSON object
+    def initialize(json)
+      @id = json[:id]
+      @entity_id = json[:entity_id]
+      @role_id = json[:role_id]
+      @destroy = false
+    end
+
+    def as_json
+      json = {}
+      json['_destroy'] = true if @destroy
+
+      json.merge({
+        id: @id,
+        entity_id: @entity_id,
+        role_id: @role_id
+      })
+    end
+  end
+end

data/lib/roles-management-api/version.rb

@@ -0,0 +1,3 @@
+module RolesManagementAPI
+  VERSION = "0.1.3"
+end

data/roles-management-api.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'roles-management-api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "roles-management-api"
+  spec.version       = RolesManagementAPI::VERSION
+  spec.authors       = ["Christopher Thielen"]
+  spec.email         = ["cmthielen@ucdavis.edu"]
+
+  spec.summary       = %q{Ruby gem for consuming the DSS IT Roles Management API}
+  spec.description   = %q{Ruby gem for consuming the RESTful JSON-based DSS IT Roles Management API.}
+  spec.homepage      = "https://github.com/dssit/roles-management-api"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: roles-management-api
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Christopher Thielen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Ruby gem for consuming the RESTful JSON-based DSS IT Roles Management
+  API.
+email:
+- cmthielen@ucdavis.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/roles-management-api.rb
+- lib/roles-management-api/client.rb
+- lib/roles-management-api/person.rb
+- lib/roles-management-api/role.rb
+- lib/roles-management-api/role_assignment.rb
+- lib/roles-management-api/version.rb
+- roles-management-api.gemspec
+homepage: https://github.com/dssit/roles-management-api
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby gem for consuming the DSS IT Roles Management API
+test_files: []