nearmiss-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 37c92bb3b0a1da8954fc384ba187fff5e0c17cff
+  data.tar.gz: 83345b933cb9dcaa559abf80d6a01b5ba12f82b3
+SHA512:
+  metadata.gz: 911b84234c34e43330e263e864b46da974fc5cd7efd1e3c06e15dedb1ead89e13b645aeb9c94950682efe587c2cacdff3558a16de18808524188d17d0611a0d8
+  data.tar.gz: d15b9d4d665d0d824118c47d0c4546975e3415e8035084c72640862880ccc6b710e3e0efd2b181aa00395c378f01850fe27699f0c2a8ecebd92e13d888ae758d

data/AUTHORS.md

@@ -0,0 +1,7 @@
+Authors
+=======
+
+A huge thanks to all of our contributors:
+
+
+- This could be you!

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+ruby-nearmiss changelog
+=====================
+
+Version 1.0.1
+-------------
+
+Release January 4, 2016
+
+- Fixed fetching projects
+
+Version 1.0.0
+-------------
+
+Release January 3, 2016
+
+- Intro

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :spec do
+  # gem 'jruby-openssl', :platforms => :jruby
+  gem 'rake'
+  gem 'rspec', '~> 3.3.0'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016, Markus Klooth
+
+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,188 @@
+
+# nearmiss-ruby
+
+A module for using the Nearmiss REST API and generating valid [TwiML](http://www.nearmissapp.com/docs/api/). [Click here to read the full documentation.][documentation]
+
+## Installation
+
+To install using [Bundler][bundler] grab the latest stable version:
+
+```ruby
+gem 'nearmiss-ruby', '~> 1.0.0'
+```
+
+To manually install `nearmiss-ruby` via [Rubygems][rubygems] simply gem install:
+
+# nearmiss-ruby
+
+A module for using the Nearmiss REST API and generating valid [TwiML](http://www.nearmissapp.com/docs/api/). [Click here to read the full documentation.][documentation]
+
+## Installation
+
+To install using [Bundler][bundler] grab the latest stable version:
+
+```ruby
+gem 'nearmiss-ruby', '~> 1.0.0'
+```
+
+To manually install `nearmiss-ruby` via [Rubygems][rubygems] simply gem install:
+
+```bash
+gem install nearmiss-ruby
+```
+
+To build and install the development branch yourself from the latest source:
+
+```bash
+git clone git@github.com:nearmiss/nearmiss-ruby.git
+cd nearmiss-ruby
+make install
+```
+
+## Getting Started With REST
+
+### Setup Work
+
+``` ruby
+require 'rubygems' # not necessary with ruby 1.9 but included for completeness
+require 'nearmiss-ruby'
+
+# put your own credentials here
+account_sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
+
+# set up a client to talk to the Nearmiss REST API
+@client = Nearmiss::REST::Client.new account_sid, auth_token
+
+# alternatively, you can preconfigure the client like so
+Nearmiss.configure do |config|
+  config.account_sid = account_sid
+  config.auth_token = auth_token
+end
+
+# and then you can create a new client without parameters
+@client = Nearmiss::REST::Client.new
+```
+
+
+
+### List Projects
+You can look up a list of all projects.
+
+``` ruby
+# list calls made or received on or after May 13, 2013
+@client.project_list("start_time>" => "2013-05-13") # Notice we omit the "=" in the "start_time>=" parameter because it is automatically added
+```
+
+### List Categories
+You can look up a list of all defined categories.
+
+``` ruby
+# list calls made or received on or after May 13, 2013
+@client.categories() # Notice we omit the "=" in the "start_time>=" parameter because it is automatically added
+```
+
+
+
+## Supported Ruby Versions
+
+This library supports and is [tested against][travis] the following Ruby
+implementations:
+
+- Ruby 2.2.0
+- Ruby 2.1.0
+- Ruby 2.0.0
+- Ruby 1.9.3
+- [JRuby][jruby]
+- [Rubinius][rubinius]
+
+## Getting help
+
+If you need help installing or using the library, please contact Nearmiss Support at help@nearmiss.com first. Nearmiss's Support staff are well-versed in all of the Nearmiss Helper Libraries, and usually reply within 24 hours.
+
+If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!
+
+## More Information
+
+There are more detailed examples in the included [examples][examples]
+directory. Also for those upgrading, the [upgrade guide][upgrade] is available in the [nearmiss-ruby github wiki][wiki].
+
+```bash
+gem install nearmiss-ruby
+```
+
+To build and install the development branch yourself from the latest source:
+
+```bash
+git clone git@github.com:nearmiss/nearmiss-ruby.git
+cd nearmiss-ruby
+make install
+```
+
+## Getting Started With REST
+
+### Setup Work
+
+``` ruby
+require 'rubygems' # not necessary with ruby 1.9 but included for completeness
+require 'nearmiss-ruby'
+
+# put your own credentials here
+account_sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
+
+# set up a client to talk to the Nearmiss REST API
+@client = Nearmiss::REST::Client.new account_sid, auth_token
+
+# alternatively, you can preconfigure the client like so
+Nearmiss.configure do |config|
+  config.account_sid = account_sid
+  config.auth_token = auth_token
+end
+
+# and then you can create a new client without parameters
+@client = Nearmiss::REST::Client.new
+```
+
+
+
+### List Projects
+You can look up a list of all projects.
+
+``` ruby
+# list calls made or received on or after May 13, 2013
+@client.project_list("start_time>" => "2013-05-13") # Notice we omit the "=" in the "start_time>=" parameter because it is automatically added
+```
+
+### List Categories
+You can look up a list of all defined categories.
+
+``` ruby
+# list calls made or received on or after May 13, 2013
+@client.categories() # Notice we omit the "=" in the "start_time>=" parameter because it is automatically added
+```
+
+
+
+## Supported Ruby Versions
+
+This library supports and is [tested against][travis] the following Ruby
+implementations:
+
+- Ruby 2.2.0
+- Ruby 2.1.0
+- Ruby 2.0.0
+- Ruby 1.9.3
+- [JRuby][jruby]
+- [Rubinius][rubinius]
+
+## Getting help
+
+If you need help installing or using the library, please contact Nearmiss Support at help@nearmiss.com first. Nearmiss's Support staff are well-versed in all of the Nearmiss Helper Libraries, and usually reply within 24 hours.
+
+If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!
+
+## More Information
+
+There are more detailed examples in the included [examples][examples]
+directory. Also for those upgrading, the [upgrade guide][upgrade] is available in the [nearmiss-ruby github wiki][wiki].

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler.setup
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+task test: :spec

data/lib/nearmiss-ruby/arguments.rb

@@ -0,0 +1,14 @@
+module Nearmiss
+
+  # Extracts options from method arguments
+  # @private
+  class Arguments < Array
+    attr_reader :options
+
+    def initialize(args)
+      @options = args.last.is_a?(::Hash) ? args.pop : {}
+      super(args)
+    end
+
+  end
+end

data/lib/nearmiss-ruby/authentication.rb

@@ -0,0 +1,60 @@
+module Nearmiss
+
+  # Authentication methods for {Nearmiss::Client}
+  module Authentication
+
+    # Indicates if the client was supplied  Basic Auth
+    # username and password
+    #
+    # @see 
+    # @return [Boolean]
+    def basic_authenticated?
+      !!(@email && @password)
+    end
+
+    # Indicates if the client was supplied an OAuth
+    # access token
+    #
+    # @see 
+    # @return [Boolean]
+    def token_authenticated?
+      !!@access_token
+    end
+
+    def sign_in
+
+      response  = post 'auth/sign_in', { email: @email, password: @password}
+      update_headers(last_response.headers)
+      reset_agent
+      @me       = response[:data]
+    end
+    alias :login :sign_in
+
+    def update_headers(headers)
+      # puts "update"
+      # last_response.headers
+      @client_id    = headers["client"]
+      @access_token = headers["access-token"]
+      @expiry       = headers["expiry"]
+      @uid          = headers["uid"]
+
+    end
+
+    # Closes the current active session by expiring the ticket.
+    #
+    def sign_out
+      post "api/logout"
+      @me = nil
+    end
+    alias :logout :sign_out
+
+    # Check is a user is currently signed in.
+    #
+    # @return [Boolean]
+    def signed_in?
+      !!@me
+    end
+
+  end
+
+end

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

@@ -0,0 +1,155 @@
+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
+
+      # 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

data/lib/nearmiss-ruby/client/notifications.rb

@@ -0,0 +1,31 @@
+module Nearmiss
+  class Client
+
+    # Methods for the Notifications API
+    #
+    module Notifications
+
+      # List notifications for the current user
+      #
+      # If user is not supplied, repositories for the current
+      #   authenticated user are returned.
+      #
+      # @note If the user provided is a GitHub organization, only the
+      #   organization's public repositories will be listed. For retrieving
+      #   organization repositories the {Organizations#organization_repositories}
+      #   method should be used instead.
+      # @see https://developer.github.com/v3/repos/#list-your-repositories
+      # @see https://developer.github.com/v3/repos/#list-user-repositories
+      # @param user [Integer, String] Optional GitHub user login or id for which
+      #   to list repos.
+      # @return [Array<Sawyer::Resource>] List of projects
+      def notifications(options = {})
+        paginate "notifications", options
+      end
+      alias :list_notifications :notifications
+
+
+
+    end
+  end
+end