nearmiss-ruby 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c45361a4ff97189c6376c0978c7ae94d72ce178
-  data.tar.gz: 5d875ea9652f3427a8e6792e17972f5e54386aa5
+  metadata.gz: 02345c1b1ede0a30870db477c456afacb9e3efeb
+  data.tar.gz: 687b821cce247887aa3844a44e2a43de66e9822d
 SHA512:
-  metadata.gz: 22e1ade7eb04c1841f7c6998c0da23cf676564857bdda5f9b05e7e32b4d3ec2a26aa57cf15b8e831ac21c36c399653d58757d6102007400eaacd6a44fc365395
-  data.tar.gz: 834b68d3d250b6a169f3df81d7f8f5895ba0308ac6c618e5db1a5661af0ddbe0539f3c0a48d03322903baa913e2bc4963686f1ed2692079539cddd04c57f6264
+  metadata.gz: ca6c040381a5176edfe8c3a46f234260d05b6920485c6bb5ef13f1631e689c65b7a39fb7b4f53d8e63e5d888df7f0da1f55e8b00e9d6e492b6e3509c6ce90ecd
+  data.tar.gz: f02804f0c4a88fd0d7c706e4e0e70dd6e30a65a315eb2543ce7fa9498ee960bc604ac8bbecddfe996851f23c83fe713ae83ee251b4eca8a96bbc8cf2f318ecfb

data/Makefile

@@ -0,0 +1,15 @@
+install:
+	bundle exec rake install
+
+test-install:
+	bundle install
+
+test:
+	bundle exec rake spec
+
+authors:
+	echo "Authors\n=======\n\nA huge thanks to all of our contributors:\n\n" > AUTHORS.md
+	git log --raw | grep "^Author: " | cut -d ' ' -f2- | cut -d '<' -f1 | sed 's/^/- /' | sort | uniq >> AUTHORS.md
+
+deploy:
+	bundle exec rake build | sed -e 's/.*pkg/pkg/g' | sed -e "s/\.$$//g" | xargs gem push

data/lib/nearmiss-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/nearmiss-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/nearmiss-ruby/incident.rb

@@ -0,0 +1,75 @@
+module Nearmiss
+
+  # Class to parse incident owner and name from
+  # URLs and to generate URLs
+  class Incident
+    attr_accessor :id
+
+    # Instantiate from a incident URL
+    #
+    # @return [Incident]
+    def self.from_url(url)
+      Incident.new(URI.parse(url).path[1..-1])
+    end
+
+
+    def initialize(incident)
+      case incident
+      # when Integer
+      #   @id = incident
+      when String
+        @id = incident
+        # @owner, @name = repo.split('/')
+        # unless @owner && @name
+        #   raise ArgumentError, "Invalid Incident. Use user/repo format."
+        # end
+      when Incident
+        @id   = incident.id
+        # @name = repo.name
+      when Hash
+        @id = incident[:incident] ||= incident[:id]
+        # @owner = repo[:owner] ||= repo[:user] ||= repo[:username]
+      end
+    end
+
+    # Incident owner/name
+    # @return [String]
+    def slug
+      # "#{@owner}/#{@name}"
+    end
+    alias :to_s :slug
+
+    # @return [String] Incident API path
+    def path
+      # return named_api_path if @owner && @name
+      return id_api_path if @id
+    end
+
+    # Get the api path for a repo
+    # @param incident [Integer, String, Hash, Incident] A incident.
+    # @return [String] Api path.
+    def self.path(incident)
+      new(incident).path
+    end
+
+    # @return [String] Api path for owner/name identified repos
+    # def named_api_path
+    #   "repos/#{slug}"
+    # end
+
+    # @return [String] Api path for id identified incidents
+    def id_api_path
+      "incidents/#{@id}"
+    end
+
+    # Incident URL based on {Nearmiss::Client#web_endpoint}
+    # @return [String]
+    # def url
+    #   "#{Octokit.web_endpoint}#{slug}"
+    # end
+
+    # alias :user :owner
+    # alias :username :owner
+    # alias :repo :name
+  end
+end

data/lib/nearmiss-ruby/project.rb

@@ -0,0 +1,75 @@
+module Nearmiss
+
+  # Class to parse GitHub repository owner and name from
+  # URLs and to generate URLs
+  class Project
+    attr_accessor :owner, :name, :id
+
+    # Instantiate from a GitHub repository URL
+    #
+    # @return [Repository]
+    def self.from_url(url)
+      Project.new(URI.parse(url).path[1..-1])
+    end
+
+
+    def initialize(project)
+      case project
+      # when Integer
+      #   @id = project
+      when String
+        @id = project
+        # @owner, @name = repo.split('/')
+        # unless @owner && @name
+        #   raise ArgumentError, "Invalid Repository. Use user/repo format."
+        # end
+      when Project
+        @id   = project.id
+        # @name = repo.name
+      when Hash
+        @id = project[:project] ||= project[:id]
+        # @owner = repo[:owner] ||= repo[:user] ||= repo[:username]
+      end
+    end
+
+    # Project owner/name
+    # @return [String]
+    def slug
+      # "#{@owner}/#{@name}"
+    end
+    alias :to_s :slug
+
+    # @return [String] Project API path
+    def path
+      # return named_api_path if @owner && @name
+      return id_api_path if @id
+    end
+
+    # Get the api path for a repo
+    # @param project [Integer, String, Hash, Project] A project.
+    # @return [String] Api path.
+    def self.path(project)
+      new(project).path
+    end
+
+    # @return [String] Api path for owner/name identified repos
+    # def named_api_path
+    #   "repos/#{slug}"
+    # end
+
+    # @return [String] Api path for id identified repos
+    def id_api_path
+      "projects/#{@id}"
+    end
+
+    # Project URL based on {Nearmiss::Client#web_endpoint}
+    # @return [String]
+    def url
+      # "#{Octokit.web_endpoint}#{slug}"
+    end
+
+    # alias :user :owner
+    # alias :username :owner
+    # alias :repo :name
+  end
+end

data/lib/nearmiss-ruby/version.rb

@@ -1,3 +1,3 @@
 module Nearmiss
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/script/bootstrap

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -e
+
+bundle install --quiet "$@"

data/script/cibuild

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -e
+
+script/test

data/script/console

@@ -0,0 +1,11 @@
+#!/bin/sh
+
+set -e
+
+dir=`pwd`
+
+echo "===> Bundling..."
+script/bootstrap --quiet
+
+echo "===> Launching..."
+bundle console

data/script/package

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+# Usage: script/gem
+# Updates the gemspec and builds a new gem in the pkg directory.
+
+mkdir -p pkg
+gem build *.gemspec
+mv *.gem pkg

data/script/release

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+# Usage: script/release
+# Build the package, tag a commit, push it to origin, and then release the
+# package publicly.
+
+set -e
+
+version="$(script/package | grep Version: | awk '{print $2}')"
+[ -n "$version" ] || exit 1
+
+echo $version
+git commit --allow-empty -a -m "Release $version"
+git tag "v$version"
+git push origin
+git push origin "v$version"
+gem push pkg/*-${version}.gem

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nearmiss-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Markus Klooth
@@ -63,6 +63,7 @@ files:
 - CHANGELOG.md
 - Gemfile
 - LICENSE
+- Makefile
 - README.md
 - Rakefile
 - lib/nearmiss-ruby.rb
@@ -70,8 +71,11 @@ files:
 - lib/nearmiss-ruby/authentication.rb
 - lib/nearmiss-ruby/client.rb
 - lib/nearmiss-ruby/client/account.rb
+- lib/nearmiss-ruby/client/attachments.rb
 - lib/nearmiss-ruby/client/bookmarks.rb
 - lib/nearmiss-ruby/client/categories.rb
+- lib/nearmiss-ruby/client/comments.rb
+- lib/nearmiss-ruby/client/companies.rb
 - lib/nearmiss-ruby/client/incidents.rb
 - lib/nearmiss-ruby/client/notifications.rb
 - lib/nearmiss-ruby/client/projects.rb
@@ -80,12 +84,20 @@ files:
 - lib/nearmiss-ruby/configurable.rb
 - lib/nearmiss-ruby/default.rb
 - lib/nearmiss-ruby/error.rb
+- lib/nearmiss-ruby/incident.rb
+- lib/nearmiss-ruby/project.rb
 - lib/nearmiss-ruby/raise_error.rb
 - lib/nearmiss-ruby/rate_limit.rb
 - lib/nearmiss-ruby/response.rb
 - lib/nearmiss-ruby/util.rb
 - lib/nearmiss-ruby/version.rb
 - nearmiss-ruby.gemspec
+- script/bootstrap
+- script/cibuild
+- script/console
+- script/package
+- script/release
+- script/test
 homepage: https://github.com/nearmiss/nearmiss-ruby
 licenses:
 - MIT