toolhound-ruby 1.0.4

data/lib/toolhound-ruby/client.rb

@@ -0,0 +1,113 @@
+# require "set"
+require "toolhound-ruby/authentication"
+require "toolhound-ruby/configurable"
+require "toolhound-ruby/client/projects"
+# require "toolhound-ruby/incident"
+
+
+module Toolhound
+
+  class Client
+    include Toolhound::Authentication
+    include Toolhound::Configurable
+
+    include Toolhound::Client::Projects
+    # include Toolhound::Client::Bookmarks
+    # include Toolhound::Client::Categories
+    # include Toolhound::Client::Incidents
+    # include Toolhound::Client::Notifications
+    # include Toolhound::Client::Projects
+    # include Toolhound::Client::RateLimit
+    # include Toolhound::Client::Users
+    # include Toolhound::Client::Companies
+    # include Toolhound::Client::Attachments
+
+    # include Toolhound::Client::Users
+    # include Toolhound::Client::ProjectLibrary
+    # include Toolhound::Client::Projects
+    # include Toolhound::Client::Templates
+    # include Toolhound::Client::Checklists
+    # include Toolhound::Client::Tasks
+    # include Toolhound::Client::Issues
+    # include Toolhound::Client::Utils
+
+    # def projects
+    #
+    # end
+    # attr_accessor :access_token, :client_id, :uid, :expiry, :me
+    attr_accessor :connection, :dataserver, :username, :password, :port
+
+    def initialize(options = {})
+
+      # Use options passed in, but fall back to module defaults
+      Toolhound::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || Toolhound.instance_variable_get(:"@#{key}"))
+      end
+
+      sign_in if authenticatable?
+    end
+
+    # Compares client options to a Hash of requested options
+    #
+    # @param opts [Hash] Options to compare with current client options
+    # @return [Boolean]
+    def same_options?(opts)
+      opts.hash == options.hash
+    end
+
+
+    def inspect # :nodoc:
+
+      inspected = super
+
+      # mask password
+      inspected = inspected.gsub! @password, "*******" if @password
+      # Only show last 4 of token, secret
+      # if @access_token
+      #   inspected = inspected.gsub! @access_token, "#{'*'*36}#{@access_token[36..-1]}"
+      # end
+      # if @client_secret
+      #   inspected = inspected.gsub! @client_secret, "#{'*'*36}#{@client_secret[36..-1]}"
+      # end
+
+      inspected
+    end
+
+
+    # Set username for authentication
+    #
+    # @param value [String] Toolhound-field username
+    def username=(value)
+      reset_connection
+      @email = value
+    end
+
+    # Set password for authentication
+    #
+    # @param value [String] Toolhound-field password
+    def password=(value)
+      reset_connection
+      @password = value
+    end
+
+    def reset_connection
+      @connection = nil
+    end
+
+
+    # Wrapper around Kernel#warn to print warnings unless
+    # TOOLHOUND_SILENT is set to true.
+    #
+    # @return [nil]
+    def nearmiss_warn(*message)
+      unless ENV['TOOLHOUND_SILENT']
+        warn message
+      end
+    end
+
+
+
+  end
+
+
+end

data/lib/toolhound-ruby/client/account.rb

@@ -0,0 +1,14 @@
+module Nearmiss
+  class Client
+
+    # Methods for the Bookmarks API
+    #
+    module Account
+
+      def account(options = {})
+        get "account", options
+      end
+
+    end
+  end
+end

data/lib/toolhound-ruby/client/attachments.rb

@@ -0,0 +1,88 @@
+module Nearmiss
+  class Client
+
+    # Methods for the Attachments API
+    #
+    module Attachments
+
+      # List nearmiss attachments
+      #
+      # @return [Array<Sawyer::Resource>] List of attachments
+      #
+      def attachments(options = {})
+        since = options[:since] || options["since"]
+
+        options.merge!(since: iso8601(parse_date(since))) if since
+
+        paginate "attachments", options
+      end
+      alias :list_attachments :attachments
+
+      # Get a single attachment
+      #
+      # @param attachment [String] ID of attachment to fetch
+      # @return [Sawyer::Resource] Incident information
+      #
+      def attachment(attachment, options = {})
+        get "attachments/#{attachment}", options
+      end
+
+      # Project attachments
+      #
+      # @param project [String, Hash, Incident] Incident
+      # @return [Sawyer::Resource] Incident information
+      #
+      def incident_attachments(incident, options = {})
+
+        paginate "#{Incident.new(incident).path}/attachments", options
+
+      end
+      alias :nearmiss_attachments :incident_attachments
+
+
+      # Create an attachment
+      #
+      # @param options [Hash] Attachment information.
+      # @option options [String] :created_by_id Id of person who created this attachment
+      # @option options [String] :original_filename title of file
+      # @option options [String] :content_type e.g. `image/jpeg`
+      # @option options [String] :attachable_id associated ID of resource this attachment belongs to
+      # @option options [String] :attachable_type e.g. Incident
+
+      #
+      # @return [Sawyer::Resource] Newly created attachment info
+      def create_attachment(options = {})
+        post 'attachments', options
+      end
+
+
+      def update_attachment(attachment, options = {})
+        patch "attachments/#{attachment}", options
+      end
+      alias :edit_attachment :update_attachment
+
+
+    protected
+
+    def iso8601(date)
+      if date.respond_to?(:iso8601)
+        date.iso8601
+      else
+        date.strftime("%Y-%m-%dT%H:%M:%S%Z")
+      end
+    end
+      # Parses the given string representation of a date, throwing a meaningful exception
+      # (containing the date that failed to parse) in case of failure.
+      #
+      # @param date [String] String representation of a date
+      # @return [DateTime]
+      def parse_date(date)
+        date = DateTime.parse(date.to_s)
+      rescue ArgumentError
+        raise ArgumentError, "#{date} is not a valid date"
+      end
+
+
+    end
+  end
+end

data/lib/toolhound-ruby/client/bookmarks.rb

@@ -0,0 +1,39 @@
+module Nearmiss
+  class Client
+
+    # Methods for the Bookmarks API
+    #
+    module Bookmarks
+
+      # List bookmarks
+      #
+      # @return [Array<Sawyer::Resource>] List of bookmarks
+      def bookmarks(options = {})
+        paginate "bookmarks", options
+      end
+      alias :list_bookmarks :bookmarks
+
+      # Get a single bookmark
+      #
+      # @param bookmark [String] ID of bookmark to fetch
+      # @return [Sawyer::Resource] Bookmark information
+      #
+      def bookmark(bookmark, options={})
+        get "bookmarks/#{bookmark}", options
+      end
+
+      # Delete a bookmark
+      #
+      # @param bookmark_id [String] Id of the bookmark.
+      # @return [Boolean] True if bookmark deleted, false otherwise.
+      # @example
+      #   @client.delete_bookmark('208sdaz3')
+      #
+      def delete_bookmark(bookmark_id, options={})
+        boolean_from_response(:delete, "bookmarks/#{bookmark_id}", options)
+
+      end
+
+    end
+  end
+end

data/lib/toolhound-ruby/client/categories.rb

@@ -0,0 +1,72 @@
+module Nearmiss
+  class Client
+
+    # Methods for the Categories API
+    #
+    module Categories
+
+      # List categories
+      #
+      # @return [Array<Sawyer::Resource>] List of categories
+      def categories(options = {})
+        paginate "categories", options
+      end
+      alias :list_categories :categories
+      alias :list_cats :categories
+      alias :cats :categories           
+
+      # Get a single category
+      #
+      # @param category [String] ID of category to fetch
+      # @return [Sawyer::Resource] Category information
+      #
+      def category(category, options={})
+        get "categories/#{category}", options
+      end
+      alias :cat :category           
+
+
+      # Create a category
+      #
+      # @param options [Hash] Category information.
+      # @option options [String] :name e.g. Name of category
+      # @return [Sawyer::Resource] Newly created category info
+      def create_category(options = {})
+        post 'categories', options
+      end
+      alias :create_cat :create_category
+
+      # Edit a category
+      #
+      # @param options [Hash] Project information.
+      # @option options [String] :name e.g. Tools
+      #
+      # @return
+      #   [Sawyer::Resource] Edited category info
+      # @example Update a category
+      #   @client.edit_category('some_id', {
+      #     name: "New name of category",
+      #   })
+
+      def edit_category(category, options = {})
+        patch "categories/#{category}", options
+      end
+      alias :edit_cat :edit_category
+
+
+      # Delete a category
+      #
+      # @param category [String] Project ID
+      # @return [Boolean] Indicating success of deletion
+      #
+      def delete_category(category, options = {})
+        boolean_from_response :delete, "categories/#{category}", options
+      end
+      alias :delete_cat :delete_category
+      alias :remove_category :delete_category
+      alias :remove_cat :delete_category
+
+
+    end
+  end
+end

data/lib/toolhound-ruby/client/companies.rb

@@ -0,0 +1,76 @@
+module Nearmiss
+  class Client
+
+    # Methods for the Companies API
+    #
+    module Companies
+
+      # List companies
+      #
+      # @note Shows a list of companies for the users organization aka account
+      #
+      # @return [Array<Sawyer::Resource>] List of companys
+      def companies(options = {})
+        paginate "companies", options
+      end
+      alias :list_companies :companies
+
+      # Get a single company
+      #
+      # @param company [String] UUID of company to fetch
+      # @return [Sawyer::Resource] Project information
+      #
+      def company(company, options = {})
+        get "#{company_path(company)}", options
+      end
+
+      # Create a company
+      #
+      # @param options [Hash] Project information.
+      # @option options [String] :name e.g. Berkeley Art Museum
+      # @option options [String] :company_id e.g. 10611.70
+      # @return [Sawyer::Resource] Newly created company info
+      def create_company(options = {})
+        post 'companies', options
+      end
+
+      # Edit a company
+      #
+      # @param options [Hash] Project information.
+      # @option options [String] :name e.g. Berkeley Art Museum
+      # @option options [String] :company_id e.g. 10611.70
+      #
+      # @return
+      #   [Sawyer::Resource] Newly created company info
+      # @example Update a company
+      #   @client.edit_company('some_id', {
+      #     name: "New name of company",
+      #     company_id: "1043.32"
+      #   })
+      #
+      def edit_company(company, options = {})
+        patch "#{company_path(company)}", options
+      end
+
+      # Delete a company
+      #
+      # @param company [String] Project ID
+      # @return [Boolean] Indicating success of deletion
+      #
+      def delete_company(company, options = {})
+        boolean_from_response :delete, "companies/#{company}", options
+      end
+      alias :remove_company :delete_company
+
+      private
+
+      def company_path(id)
+        if uuid?(id)
+          "companies/#{id}"
+        else
+          "company/#{id}"
+        end
+      end
+    end
+  end
+end

data/lib/toolhound-ruby/client/incidents.rb

@@ -0,0 +1,167 @@
+module Nearmiss
+  class Client
+
+    # Methods for the Incidents API
+    #
+    module Incidents
+
+      # List nearmiss incidents
+      #
+      # @return [Array<Sawyer::Resource>] List of incidents
+      #
+      def incidents(options = {})
+        since = options[:since] || options["since"]
+
+        options.merge!(since: iso8601(parse_date(since))) if since
+
+        paginate "incidents", options
+      end
+      alias :list_incidents :incidents
+      alias :list_nearmisses :incidents
+      alias :nearmisses :incidents
+
+
+      # Get a single incident
+      #
+      # @param incident [String] ID of incident to fetch
+      # @return [Sawyer::Resource] Incident information
+      #
+      def incident(incident, options = {})
+        get "incidents/#{incident}", options
+      end
+      alias :nearmiss :incident
+
+      # Project incidents
+      #
+      # @param project [String] ID of project
+      # @return [Sawyer::Resource] Incident information
+      #
+      def project_incidents(project, options = {})
+
+        paginate "#{Project.new(project).path}/incidents", options
+
+      end
+
+
+      # Create an incident
+      #
+      # @param options [Hash] Incident information.
+      # @option options [String] :title Name of incident
+      # @option options [String] :note Description of what happened
+      # @option options [String] :category_id ID of associated category
+      # @option options [String] :project_id ID of the project where the incident occured
+      # @option options [String] :company Which company did the incident
+      # @option options [String] :date When did the nearmiss occur
+      # @option options [String] :trade e.g. is actually the activity
+      # @option options [Boolean] :is_public Submit the nearmiss publically or private
+      #
+      # @option options [String] :bad_weather "rainy", "sunny", "cloudy", "windy"
+      # @option options [String] :injured Answers: "yes", "no"
+      # @option options [String] :jha Answers: "yes", "no"
+      # @option options [String] :messy Answers: "yes", "no"
+      #
+      # @option options [Array] :attachments
+      #
+      # @return [Sawyer::Resource] Newly created incident info
+      def create_incident(options = {})
+        post 'incidents', options
+      end
+      alias :create_nearmiss :create_incident
+
+      def update_incident(incident, options = {})
+        patch "incidents/#{incident}", options
+      end
+      alias :edit_incident :update_incident
+      alias :update_nearmiss :update_incident
+      alias :edit_nearmiss :update_incident
+
+      # List incident comments
+      #
+      # @param incident_id [String] Incident Id.
+      # @return [Array<Sawyer::Resource>] Array of hashes representing comments.
+      # @example
+      #   Nearmiss.incident_comments('3528ae645')
+      def incident_comments(incident_id, options = {})
+        paginate "incidents/#{incident_id}/comments", options
+      end
+      alias :nearmiss_comments :incident_comments
+
+      # Get incident comment
+      #
+      # @param incident_id [String] Id of the incident.
+      # @param comment_id [Integer] Id of the incident comment.
+      # @return [Sawyer::Resource] Hash representing incident comment.
+      # @example
+      #   Nearmiss.incident_comment('208sdaz3', 1451398)
+      def incident_comment(incident_id, comment_id, options = {})
+        get "incidents/#{incident_id}/comments/#{comment_id}", options
+      end
+      alias :nearmiss_comment :incident_comment
+
+      # Create incident comment
+      #
+      # @param incident_id [String] Id of the incident.
+      # @param comment [String] Comment contents.
+      # @return [Sawyer::Resource] Hash representing incident comment.
+      # @example
+      #   Nearmiss.incident_comment('208sdaz3', "Some text")
+      def create_incident_comment(incident_id, comment, options = {})
+        options.merge!({text: comment})
+        post "incidents/#{incident_id}/comments", options
+      end
+      alias :create_nearmiss_comment :create_incident_comment
+
+      # Update incident comment
+      #
+      # @param incident_id [String] Id of the incident.
+      # @param comment_id [String] Id of the comment.
+      # @param comment [String] Comment contents.
+      # @return [Sawyer::Resource] Hash representing incident comment.
+      # @example
+      #   Nearmiss.incident_comment('208sdaz3', "Some text")
+      def update_incident_comment(incident_id, comment_id, comment, options = {})
+        options.merge!({text: comment})
+        patch "incidents/#{incident_id}/comments/#{comment_id}", options
+      end
+      alias :edit_incident_comment :update_incident_comment
+      alias :update_nearmiss_comment :update_incident_comment
+      alias :edit_nearmiss_comment :update_incident_comment
+
+      # Delete incident comment
+      #
+      # Requires authenticated client.
+      #
+      # @param incident_id [String] Id of the incident.
+      # @param comment_id [Integer] Id of the comment to delete.
+      # @return [Boolean] True if comment deleted, false otherwise.
+      # @example
+      #   @client.delete_incident_comment('208sdaz3', '586399')
+      def delete_incident_comment(incident_id, comment_id, options = {})
+        boolean_from_response(:delete, "incidents/#{incident_id}/comments/#{comment_id}", options)
+      end
+      alias :delete_nearmiss_comment :delete_incident_comment
+
+    protected
+
+    def iso8601(date)
+      if date.respond_to?(:iso8601)
+        date.iso8601
+      else
+        date.strftime("%Y-%m-%dT%H:%M:%S%Z")
+      end
+    end
+      # Parses the given string representation of a date, throwing a meaningful exception
+      # (containing the date that failed to parse) in case of failure.
+      #
+      # @param date [String] String representation of a date
+      # @return [DateTime]
+      def parse_date(date)
+        date = DateTime.parse(date.to_s)
+      rescue ArgumentError
+        raise ArgumentError, "#{date} is not a valid date"
+      end
+
+
+    end
+  end
+end