glassfrog 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c89ef4ee91bbf6648c716f375c63c4bc1e6cb124
+  data.tar.gz: 4c4d158ce34299e65c377c53fe598f4bbab85097
+SHA512:
+  metadata.gz: 23762758ceba1cb5f9860e7a487b9b554fbc72f3997d562e91a661cba4d637e8c2007ffd3defb3d60dd5533a4dfa6d78a75728f92313ace19811dc666e6e4de1
+  data.tar.gz: 121c1061db9c5c11a55a428baf46305015d19b3dd7f56284157dda098c2e418b430d24010393960053ad946dae0e0e22a9bcd65829dd93756d49680d24558430

data/.gitignore

@@ -0,0 +1,74 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/var/
+
+# OS X
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# Ruby
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Undercurrent
+
+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/README.md

@@ -0,0 +1,198 @@
+# Glassfrog
+
+A Ruby interface for the GlassFrog API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'glassfrog'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install glassfrog
+
+## Documentation
+
+To generate local rdocs run:
+
+    $ rdoc
+
+## Configuration
+
+The GlassFrog API requires a personally generated GlassFrog API key.
+
+This can be passed into `Glassfrog::Client.new` as a String, Hash, or a Block.
+
+```ruby
+client = Glassfrog::Client.new("YOUR_API_KEY")
+```
+
+```ruby
+client = Glassfrog::Client.new({ 
+    api_key: "YOUR_API_KEY" 
+})
+```
+
+```ruby
+client = Glassfrog::Client.new do |config|
+    config.api_key = "YOUR_API_KEY"
+end
+```
+
+## Usage
+
+This GlassFrog interface also has a caching feature which allows https requests to be cached and only sent once.
+
+To set caching with the default (temporary) cache, pass `true` to the `caching` variable.
+
+```ruby
+client = Glassfrog::Client.new({ 
+    api_key: "YOUR_API_KEY",
+    caching: true
+})
+```
+
+```ruby
+client = Glassfrog::Client.new do |config|
+    config.api_key = "YOUR_API_KEY"
+    config.caching = true
+end
+```
+
+You can change the location of the cache file (or storage type) by passing in a `caching_settings` Hash.
+
+```ruby
+client = Glassfrog::Client.new({ 
+    api_key: "YOUR_API_KEY",
+    caching: true,
+    caching_settings: {
+        :metastore   => 'file:/var/cache/rack/meta',
+        :entitystore => 'file:/var/cache/rack/body'
+    }
+})
+```
+
+```ruby
+client = Glassfrog::Client.new do |config|
+    config.api_key = "YOUR_API_KEY"
+    config.caching = true
+    caching_settings: {
+        :metastore   => 'file:/var/cache/rack/meta',
+        :entitystore => 'file:/var/cache/rack/body'
+    }
+end
+```
+
+### Once the client has been configured:
+
+#### GET all circles (or other objects)
+
+```ruby
+circles = client.get :circles
+roles = client.get :roles
+```
+
+#### GET a specific circle (or other object) with an ID
+
+```ruby
+circle_1 = client.get :circle, 1
+role_1 = client.get :role, 1
+```
+
+#### GET a specific circle (or other object) with an object with an ID
+
+```ruby
+circle_1 = client.get :circle, Glassfrog::Circle.new({ id: 1 })
+role_1 = client.get :role, Glassfrog::Role.new({ id: 1 })
+```
+
+##### Note: Updating certain objects require specific keys (people requires admin access)
+
+#### Create a checklist item, metric, person, or project with POST and an object
+
+```ruby
+new_person = client.post :person, Glassfrog::Person.new({ 
+    name: 'Jim Bob', 
+    email: 'jim.bob@example.org' 
+})
+```
+
+#### Create a checklist item, metric, person, or project with POST and a Hash
+
+```ruby
+new_person = client.post :person, { 
+    name: 'Jim Bob', 
+    email: 'jim.bob@example.org' 
+}
+```
+
+#### Update a checklist item, metric, person, or project with PATCH and an object (returns update object)
+
+```ruby
+updated_person = client.patch :person, Glassfrog::Person.new({
+    id: 1, 
+    email: 'jb@newemail.org' 
+})
+```
+
+#### Update a checklist item, metric, person, or project with PATCH and a Hash (returns update options)
+
+```ruby
+updated_person = client.patch :person, { 
+    id: 1
+    email: 'jb@newemail.org' 
+})
+```
+
+#### Update a checklist item, metric, person, or project with PATCH, a Hash (or an object), and a supplied identifier (returns update options)
+
+```ruby
+updated_person = client.patch :person, 1, {
+    email: 'jb@newemail.org' 
+})
+```
+
+#### Delete a checklist item, metric, person, or project with DELETE and an object (returns boolean)
+
+```ruby
+was_deleted = client.patch :person, { 
+    id: 1
+    email: 'jb@newemail.org' 
+})
+```
+
+#### Delete a checklist item, metric, person, or projectw with DELETE and an identifier (returns boolean)
+
+```ruby
+was_deleted = client.patch :person, 1
+```
+
+#### Build a hierarchy from an array of circles and roles, or get them from GlassFrog
+
+```ruby
+root_circle = client.build_hierarchy circles, roles
+root_circle_from_get = client.build_hierarchy
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/UCSoftware/glassfrog.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "glassfrog"
+
+# 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/glassfrog.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'glassfrog/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "glassfrog"
+  spec.version       = Glassfrog::VERSION
+  spec.authors       = ["Undercurrent"]
+  spec.email         = ["robert.wells@undercurrent.com"]
+
+  spec.summary       = %q{A Ruby interface for the GlassFrog API.}
+  spec.homepage      = "https://github.com/UCSoftware/glassfrog-ruby"
+  spec.license       = "MIT"
+
+  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"]
+
+  # Runtime Dependencies
+  spec.add_runtime_dependency "addressable"
+  spec.add_runtime_dependency "http"
+  spec.add_runtime_dependency "rack-cache"
+
+  # Development Dependencies
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/glassfrog/action.rb

@@ -0,0 +1,29 @@
+require 'glassfrog/base'
+require 'glassfrog/rest/get'
+
+module Glassfrog
+  # 
+  # Encapsulates GlassFrog Actions.
+  # 
+  class Action < Glassfrog::Base
+    # @return [String]
+    attr_accessor :description, :created_at
+    # @return [Boolean]
+    attr_accessor :private_to_circle
+    # @return [Hash]
+    attr_accessor :links
+    PATH = '/actions'
+    TYPE = :actions
+
+    # 
+    # Sends a GET request for Action(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 Actions(s).
+    # 
+    # @return [Array<Glassfrog::Action>] The array of Action(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/base.rb

@@ -0,0 +1,43 @@
+require 'glassfrog/utils/utils'
+
+module Glassfrog
+  # 
+  # Superclass of all GlassFrog classes.
+  # 
+  class Base
+    include Glassfrog::Utils
+    # @return [Integer]
+    attr_accessor :id
+    
+    # 
+    # Initializes a new Base object.
+    # @param attrs = {} [Hash] Attributes used to instantiate Base object.
+    # 
+    # @return [Glassfrog::Base] The new Base object.
+    def initialize(attrs = {})
+      attrs.each do |key, value|
+        instance_variable_set("@#{key}", value);
+      end
+      yield(self) if block_given?
+    end
+
+    # 
+    # Check equality between two objects. Should be equal if they are the same type and their IDs are also equal.
+    # @param other [Glassfrog::Base] The object to compare to self.
+    # 
+    # @return [Boolean] They are equal or not.
+    def ==(other)
+      self.id == other.id && self.class == other.class
+    end
+
+    # 
+    # Turns the Base object into a hash.
+    # 
+    # @return [Hash] Hash version of the Base object.
+    def hashify
+      hash = Hash.new
+      self.instance_variables.each { |var| hash[var.to_s.delete("@")] = self.instance_variable_get(var) }
+      symbolize_keys(hash)
+    end
+  end
+end

data/lib/glassfrog/checklist_item.rb

@@ -0,0 +1,89 @@
+require 'glassfrog/base'
+require 'glassfrog/rest/get'
+require 'glassfrog/rest/post'
+require 'glassfrog/rest/patch'
+require 'glassfrog/rest/delete'
+
+module Glassfrog
+  # 
+  # Encapsulates GlassFrog Checklist Items.
+  # 
+  class ChecklistItem < Glassfrog::Base
+    # @return [String]
+    attr_accessor :description, :frequency
+    # @return [Boolean]
+    attr_accessor :global
+    # @return [Hash]
+    attr_accessor :links
+    PATH = '/checklist_items'
+    TYPE = :checklist_items
+
+    # 
+    # Sends a GET request for ChecklistItem(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 ChecklistItems(s).
+    # 
+    # @return [Array<Glassfrog::ChecklistItem>] The array of ChecklistItem(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
+
+    # 
+    # Sends a POST request to create a ChecklistItem on GlassFrog.
+    # @param client [Glassforg::Client] The client that will send the request. Contains the API key.
+    # @param options [Hash, Glassforg::Base] The options used to create the new ChecklistItems.
+    # 
+    # @return [Array<Glassfrog::ChecklistItem>] The array containing the new ChecklistItem.
+    def self.post(client, options)
+      response = Glassfrog::REST::Post.post(client, PATH, { TYPE => [parse_options(options)] })
+      response[TYPE] ? response[TYPE].map { |object| self.new(object) } : []
+    end
+
+    # 
+    # Sends a PATCH request to update a ChecklistItem on GlassFrog.
+    # @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)
+      options = Glassfrog::REST::Patch.formify(parse_options(options), self)
+      response = Glassfrog::REST::Patch.patch(client, PATH + '/' + identifier.to_s, options)
+    end
+
+    # 
+    # Sends a DELETE request to delete a ChecklistItem on GlassFrog.
+    # @param client [Glassforg::Client] The client that will send the request. Contains the API key.
+    # @param options [Hash, Glassfrog::Base] The options containing the ID of the ChecklistItem to delete.
+    # 
+    # @return [Boolean] Whether the request failed or not.
+    def self.delete(client, options)
+      path = PATH + '/' + options.delete(:id).to_s
+      response = Glassfrog::REST::Delete.delete(client, path, options)
+    end
+
+    private
+
+    PARAMS = [
+      :description,
+      :frequency,
+      :global,
+      :circle_id,
+      :role_id
+    ]
+
+    # 
+    # Grabs only the parameters accepted by GlassFrog.
+    # @param options [Hash] Inputed options.
+    # 
+    # @return [Hash] Valid GlassFrog options.
+    def self.parse_options(options)
+      options[:circle_id] = options[:links][:circle] if options[:links] && options[:links][:circle]
+      options[:role_id] = options[:links][:role] if options[:links] && options[:links][:role]
+      params_hash = Hash.new
+      PARAMS.each { |param| params_hash[param] = options[param] if options[param] }
+      params_hash
+    end
+  end
+end

data/lib/glassfrog/circle.rb

@@ -0,0 +1,29 @@
+require 'glassfrog/base'
+require 'glassfrog/rest/get'
+
+module Glassfrog
+  # 
+  # Encapsulates GlassFrog Circles.
+  # 
+  class Circle < Glassfrog::Base
+    # @return [String]
+    attr_accessor :name, :short_name, :strategy
+    # @return [Hash]
+    attr_accessor :links
+    # @return [Array<Glassfrog::Circle]
+    attr_accessor :sub_circles
+    PATH = '/circles'
+    TYPE = :circles
+
+    # 
+    # Sends a GET request for Circle(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 Circles(s).
+    # 
+    # @return [Array<Glassfrog::Circle>] The array of Circle(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
+  end
+end