glassfrog 0.3.0

data/lib/glassfrog/rest/get.rb

@@ -0,0 +1,40 @@
+require 'glassfrog/rest/request'
+
+module Glassfrog
+  module REST
+      # 
+      # Encapsulates all GET requests.
+      # 
+    module Get
+      # 
+      # Sends a GET request.
+      # @param client [Glassfrog::Client] Client that will send the request.
+      # @param path [String] Path to send request to.
+      # @param options [Hash] Options being sent in the request.
+      # 
+      # @return [Array<Hash>] Array containing Hashes of objects fetched.
+      def self.get(client, path, options)
+        path = options[:id] ? path + '/' + options.delete(:id).to_s : path
+        Glassfrog::REST::Request.new(client, :get, path, options).perform
+      end
+
+      # 
+      # Handles GET requests for objects that do not have a native get with ID method on GlassFrog.
+      # @param client [Glassfrog::Client] Client that will send the request.
+      # @param type [Symbol] The symbol of the object type being fetched to be used as a key in the response hash.
+      # @param path [String] Path to send request to.
+      # @param options [Hash] Options being sent in the request.
+      # 
+      # @return [Array<Hash>] Array containing Hashes of objects fetched.
+      def self.irregular_get(client, type, path, options)
+        if options.is_a?(Hash) && options[:id]
+          response = get(client, path, {})
+          if response[type] then response[type].select! { |object| object[:id] == options[:id] } end
+        else
+          response = get(client, path, options)
+        end
+        response
+      end
+    end
+  end
+end

data/lib/glassfrog/rest/patch.rb

@@ -0,0 +1,35 @@
+require 'glassfrog/rest/request'
+
+module Glassfrog
+  module REST
+      # 
+      # Encapsulates all PATCH requests.
+      # 
+    module Patch
+      # 
+      # Sends a PATCH request.
+      # @param client [Glassfrog::Client] Client that will send the request.
+      # @param path [String] Path to send request to.
+      # @param options [Hash] Options being sent in the request.
+      # 
+      # @return [Boolean] Whether request was successful.
+      def self.patch(client, path, options)
+        Glassfrog::REST::Request.new(client, :patch, path, options).perform
+      end
+
+      # 
+      # Turns options into PATCH form.
+      # @param options [Hash] Options to be formified.
+      # @param type [Class] Class being targeted by the request.
+      # 
+      # @return [Hash] Formified options.
+      def self.formify(options, type)
+        options.keys.map do |key|
+         { op: 'replace',
+           path: type::PATH + '/0/' + key.to_s,
+           value: options[key] }
+        end
+      end
+    end
+  end
+end

data/lib/glassfrog/rest/post.rb

@@ -0,0 +1,21 @@
+require 'glassfrog/rest/request'
+
+module Glassfrog
+  module REST
+      # 
+      # Encapsulates all POST requests.
+      # 
+    module Post
+      # 
+      # Sends a POST request.
+      # @param client [Glassfrog::Client] Client that will send the request.
+      # @param path [String] Path to send request to.
+      # @param options [Hash] Options being sent in the request.
+      # 
+      # @return [Array<Hash>] Array containing a Hash for the object created.
+      def self.post(client, path, options)
+        Glassfrog::REST::Request.new(client, :post, path, options).perform
+      end
+    end
+  end
+end

data/lib/glassfrog/rest/request.rb

@@ -0,0 +1,88 @@
+require 'addressable/uri'
+require 'glassfrog/client'
+require 'glassfrog/error'
+require 'glassfrog/utils/utils'
+
+module Glassfrog
+  module REST
+    # 
+    # Encapsulates an HTTP Request.
+    # 
+    class Request
+      include Glassfrog::Utils
+      # @return [Glassfrog::Client]
+      attr_accessor :client
+      # @return [Hash]
+      attr_accessor :headers, :options
+      # @return [Symbol]
+      attr_accessor :request_method
+      # @return [Addressable::URI]
+      attr_accessor :uri
+      ROOT_URL = 'https://glassfrog.holacracy.org/api/v3'
+
+      REQUEST_ASSOCIATIONS = {
+           get: :params,
+          post: :json,
+         patch: :json,
+        delete: :form
+      }
+
+      # 
+      # Initializes a new Request object.
+      # @param client [Glassfrog::Client] The client that will send the request.
+      # @param request_method [Symbol] The type of request that will be sent.
+      # @param path [String] The path (minus the root) that the request will be sent to.
+      # @param options [Hash] The options that will be included in the request.
+      # 
+      # @return [Glassfrog::Request] The initialized Request object.
+      def initialize(client, request_method, path, options)
+        @client = client
+        @headers = client.headers
+        @request_method = request_method
+        @uri = Addressable::URI.parse(path.start_with?('http') ? path : ROOT_URL + path)
+        @options = options
+      end
+
+      # 
+      # Sends the Request.
+      # 
+      # @return [Array<Hash>, Boolean] The fetched or created parameters, or boolean reflecting whether the request was successful.
+      def perform
+        options_key = REQUEST_ASSOCIATIONS[@request_method]
+        response = @client.http.headers(@headers).public_send(@request_method, @uri.to_s, options_key => @options)
+        fail_or_return_response_body(response.code, response, response.headers)
+      end
+
+      private
+
+      # 
+      # Returns an error if there was one, or parses the fetched object.
+      # @param code [Integer] The HTTP response code.
+      # @param body [String] The body of the HTTP response.
+      # @param headers [Hash] The HTTP response headers.
+      # 
+      # @return [Array<Hash>, Boolean] The fetched or created parameters or boolean reflecting whether the request was successful.
+      def fail_or_return_response_body(code, body, headers)
+        error = error(code, body, headers)
+        fail(error) if error
+        if @request_method == :patch || @request_method == :delete
+          true
+        else
+          symbolize_keys(body.parse)
+        end
+      end
+
+      # 
+      # Generates an error if the code corresponds to one.
+      # @param code [Integer] The HTTP response code.
+      # @param body [String] The body of the HTTP response.
+      # @param headers [Hash] The HTTP response headers.
+      # 
+      # @return [Glassfrog::Error, nil] The corresponding error, or nil.
+      def error(code, body, headers)
+        klass = Glassfrog::Error::ERRORS[code]
+        klass.from_response(code, body, headers) if !klass.nil?
+      end
+    end
+  end
+end

data/lib/glassfrog/rest/rest.rb

@@ -0,0 +1,7 @@
+module Glassfrog
+  # 
+  # Encapsulates all HTTP functionality.
+  # 
+  module REST
+  end
+end

data/lib/glassfrog/role.rb

@@ -0,0 +1,94 @@
+require 'glassfrog/base'
+require 'glassfrog/rest/get'
+require 'glassfrog/rest/patch'
+
+module Glassfrog
+  # 
+  # Encapsulates GlassFrog Roles.
+  # 
+  class Role < Glassfrog::Base
+    # @return [String]
+    attr_accessor :name, :purpose
+    # @return [Hash]
+    attr_accessor :links
+    PATH = '/roles'
+    PATCH_PATH = '/roles/0/links/people/'
+    TYPE = :roles
+
+    # 
+    # Sends a GET request for Role(s) to GlassFrog.
+    # @param client [Glassfrog::Client] The client that will send the request. Contains the API key.
+    # @param options [Hash, Glassfrog::Base] The options used to find the correct Roles(s).
+    # 
+    # @return [Array<Glassfrog::Role>] The array of Role(s) fetched from GlassFrog.
+    def self.get(client, options)
+      response = Glassfrog::REST::Get.get(client, PATH, options)
+      response[TYPE].map { |object| self.new(object) }
+    end
+
+    # 
+    # Sends a PATCH request to update a ChecklistItem on GlassFrog. Only updates the People assigned to the Role.
+    # @param client [Glassforg::Client] The client that will send the request. Contains the API key.
+    # @param identifier [Integer] The ID of the ChecklistItem to be updated.
+    # @param options [Hash, Glassfrog::Base] The options used to update the ChecklistItem.
+    # 
+    # @return [Boolean] Whether the request failed or not.
+    def self.patch(client, identifier, options)
+      path = PATH + '/' + identifier.to_s
+      current_object = self.get(client, { id: identifier }).first
+      options = options.is_a?(Glassfrog::Role) ? parse_options(options.hashify) : parse_options(options)
+      if current_object.links && current_object.links[:people] && options[:people]
+        (options[:people] - current_object.links[:people]).each do |person_id|
+          o = formify_role_patch({ person_id: person_id }, 'add')
+          if !Glassfrog::REST::Patch.patch(client, path, o) then return false end
+        end
+        (current_object.links[:people] - options[:people]).each do |person_id|
+          o = formify_role_patch({ person_id: person_id }, 'remove')
+          if !Glassfrog::REST::Patch.patch(client, path, o) then return false end
+        end
+      else
+        raise(ArgumentError, "No people found")
+      end
+      true
+    end
+
+    # 
+    # Returns the name as a symbol with underscores instead of spaces.
+    # 
+    # @return [Symbol] The name as a symbol.
+    def name_parameterized
+      parameterize(@name)
+    end
+
+    private
+
+    PARAMS = [
+      :people
+    ]
+
+    # 
+    # Grabs only the parameters accepted by GlassFrog.
+    # @param options [Hash] Inputed options.
+    # 
+    # @return [Hash] Valid GlassFrog options.
+    def self.parse_options(options)
+      options[:people] = options[:links][:people] if options[:links] && options[:links][:people]
+      params_hash = Hash.new
+      PARAMS.each { |param| params_hash[param] = options[param] if options[param] }
+      params_hash
+    end
+
+    # 
+    # Turns options into the format to update GlassFrog.
+    # @param options [Hash] Hash containing the Person to update the Roles of.
+    # @param operation [String] The operation to perform, either 'Remove' or 'Add'.
+    # 
+    # @return [Hash] Formified options.
+    def self.formify_role_patch(options, operation)
+      options.keys.map do |key|
+        { op: operation,
+          path: PATCH_PATH + options[key].to_s }
+      end
+    end
+  end
+end

data/lib/glassfrog/trigger.rb

@@ -0,0 +1,29 @@
+require 'glassfrog/base'
+require 'glassfrog/rest/get'
+
+module Glassfrog
+  # 
+  # Encapsulates GlassFrog Actions.
+  # 
+  class Trigger < Glassfrog::Base
+    # @return [String]
+    attr_accessor :description, :created_at
+    # @return [Boolean]
+    attr_accessor :private_to_circle
+    # @return [Hash]
+    attr_accessor :links
+    PATH = '/triggers'
+    TYPE = :triggers
+
+    # 
+    # Sends a GET request for Trigger(s) to GlassFrog.
+    # @param client [Glassfrog::Client] The client that will send the request. Contains the API key.
+    # @param options [Hash, Glassfrog::Base] The options used to find the correct Triggers(s).
+    # 
+    # @return [Array<Glassfrog::Trigger>] The array of Trigger(s) fetched from GlassFrog.
+    def self.get(client, options)
+      response = Glassfrog::REST::Get.irregular_get(client, TYPE, PATH, options)
+      response[TYPE] ? response[TYPE].map { |object| self.new(object) } : []
+    end
+  end
+end

data/lib/glassfrog/utils/graph.rb

@@ -0,0 +1,37 @@
+module Glassfrog
+  # 
+  # Encapsulates utilities for building a circle hierarchy based on supporting roles/supported circles.
+  # 
+  module Graph
+      # 
+      # Finds the root of the 'circle tree' by finding the role that does not belong to a circle.
+      # @param circles [Array<Glassfrog::Circle>] Array of circle objects (e.g. returned from GET or post-hierarchy build).
+      # @param roles [Array<Glassfrog::Role>] Array of role objects (e.g. returned from GET).
+      # 
+      # @return [Glassfrog::Circle] The root circle.
+    def self.root(circles, roles)
+      root_role = roles.select { |role| role.links[:circle].nil? }.first
+      circles.select { |circle| circle.id == root_role.links[:supporting_circle] }.first
+    end
+
+    # 
+    # Populates each circle's sub_circles array with its respective sub circles.
+    # This done by finding all of the supporting roles and the circle to which they belong.
+    # @param client [Glassfrog::Client] Client used to make the get requests (unless circles and roles are provided).
+    # @param circles=nil [Array<Glassfrog::Circle>] Array of circle objects (used instead of a get request).
+    # @param roles=nil [Array<Glassfrog::Role>] Array of role objects (used instead of a get request).
+    # 
+    # @return [Glassfrog::Circle] The root circle of the 'circle tree'.
+    def self.hierarchy(client, circles=nil, roles=nil)
+      circles ||= client.get(:circles)
+      roles ||= client.get(:roles)
+      circle_hash, role_hash = Hash[circles.map { |circle| [circle.id, circle] }], Hash[client.get(:roles).map { |role| [role.id, role] }]
+      sub_circles = circles.select { |circle| circle.links[:supported_role].is_a? Fixnum }
+      sub_circles_hash = Hash[sub_circles.map { |circle| [circle, circle_hash[role_hash[circle.links[:supported_role]].links[:circle]]] }]
+      sub_circles_hash.each do |sub_circle, parent_circle| 
+          (parent_circle.sub_circles ? parent_circle.sub_circles.push(sub_circle) : parent_circle.sub_circles = [sub_circle]) if parent_circle
+      end
+      root(circles, roles)
+    end
+  end
+end

data/lib/glassfrog/utils/utils.rb

@@ -0,0 +1,56 @@
+module Glassfrog
+  # 
+  # Utilites for handling requests.
+  # 
+  module Utils
+    # 
+    # Turns a string into a lowercase, underscored symbol for use as a parameter.
+    # @param value [String] The string.
+    # 
+    # @return [Symbol] The symbol.
+    def parameterize(value)
+      value.to_s.downcase.tr(" ", "_").to_sym
+    end
+
+    # 
+    # Turns all the values into symbols in an array or all the keys in a hash.
+    # @param object [Hash, Array, Object] Object to be symbolized.
+    # 
+    # @return [Hash, Array, Object] Symbolized object.
+    def symbolize_keys(object)
+      if object.is_a?(Array)
+        object.each_with_index do |val, index|
+          object[index] = symbolize_keys(val)
+        end
+      elsif object.is_a?(Hash)
+        object.keys.each do |key|
+          object[key.to_sym] = symbolize_keys(object.delete(key))
+        end
+      end
+      object
+    end
+
+    # 
+    # Grabs ID out of an object.
+    # @param object [Integer, String, URI, Glassfrog::Base] The object to fetch ID from.
+    # @param klass [Class] The expected class.
+    # 
+    # @return [Integer, nil] ID or nil.
+    def extract_id(object, klass)
+      case object
+      when ::Integer
+        object
+      when ::String
+        object.split('/').last.to_i
+      when ::Hash
+        object[:id] || object[:ID]
+      when URI, Addressable::URI
+        object.path.split('/').last.to_i
+      when klass
+        object.id
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/glassfrog/version.rb

@@ -0,0 +1,3 @@
+module Glassfrog
+  VERSION = "0.3.0"
+end

data/lib/glassfrog.rb

@@ -0,0 +1,8 @@
+require 'glassfrog/version'
+require 'glassfrog/client'
+
+# 
+# Encapsulates all of GlassFrog functionality.
+# 
+module Glassfrog
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: glassfrog
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Undercurrent
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  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: http
+  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: rack-cache
+  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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 
+email:
+- robert.wells@undercurrent.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- glassfrog.gemspec
+- lib/glassfrog.rb
+- lib/glassfrog/action.rb
+- lib/glassfrog/base.rb
+- lib/glassfrog/checklist_item.rb
+- lib/glassfrog/circle.rb
+- lib/glassfrog/client.rb
+- lib/glassfrog/error.rb
+- lib/glassfrog/metric.rb
+- lib/glassfrog/person.rb
+- lib/glassfrog/project.rb
+- lib/glassfrog/rest/delete.rb
+- lib/glassfrog/rest/get.rb
+- lib/glassfrog/rest/patch.rb
+- lib/glassfrog/rest/post.rb
+- lib/glassfrog/rest/request.rb
+- lib/glassfrog/rest/rest.rb
+- lib/glassfrog/role.rb
+- lib/glassfrog/trigger.rb
+- lib/glassfrog/utils/graph.rb
+- lib/glassfrog/utils/utils.rb
+- lib/glassfrog/version.rb
+homepage: https://github.com/UCSoftware/glassfrog-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.0.14
+signing_key: 
+specification_version: 4
+summary: A Ruby interface for the GlassFrog API.
+test_files: []