huginn_github_notifications_agent 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d6aee74e2adca3a10f5ab9279365077842e4a2c
+  data.tar.gz: 32156bfb2ba69eeebc9a6fa96c659aa28b38f456
+SHA512:
+  metadata.gz: 12e52d39209d83e739ad87633b2b538f10f5331f27573f2c62980930b186cc683e1c0aff71763b327d83ed9704551bb3888bf2db27fd1292f1a752789413321c
+  data.tar.gz: f2c6f6bbe30297e82f415439a310f2051d4ec50c8acaa771a98b6d2819d7aabba12415a6420e3a789a9b971ca9d4cdbea233c688e39ca2514c88432ccef0aa02

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2017 joenas
+
+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/lib/huginn_github_notifications_agent.rb

@@ -0,0 +1,4 @@
+require 'huginn_agent'
+
+#HuginnAgent.load 'huginn_github_notifications_agent/concerns/my_agent_concern'
+HuginnAgent.register 'huginn_github_notifications_agent/github_notifications_agent'

data/lib/huginn_github_notifications_agent/github_notifications_agent.rb

@@ -0,0 +1,93 @@
+module Agents
+  class GithubNotificationsAgent < Agent
+
+    cannot_receive_events!
+    can_dry_run!
+
+    default_schedule "every_10m"
+
+    description <<-MD
+      The GithubNotificationsAgent fetches your notifications from Github.
+
+      You need to create a [personal access token](https://github.com/settings/tokens) to use this, only the `notifications` scope is necessary.
+
+      To emit all new notifications as a single event, change `events` to `single`. The event key will be `notifications`.
+
+      To fetch all (unread) notifications, change `last_modified` to `false`. Default behaviour is to only fetch notifications that are updated since last run.
+
+      More options might be added for the [API](https://developer.github.com/v3/activity/notifications/#list-your-notifications).
+
+    MD
+
+    def default_options
+      {
+        'access_token' => 'my_gh_access_token',
+        'events' => 'multiple',
+        'last_modified' => true
+      }
+    end
+
+    def validate_options
+      errors.add(:base, "access_token is required ") unless options['access_token'].present?
+      errors.add(:base, "interval needs to be a positive integer") if options['interval'].present? &&  options['interval'].to_i <= 0
+      if last_modified.present? && boolify(last_modified).nil?
+        errors.add(:base, "last_modified must be a boolean value")
+      end
+    end
+
+    def working?
+      !recent_error_logs?
+    end
+
+    def check
+      response = HTTParty.get base_url, request_options
+      # If there are no new notifications, you will see a "304 Not Modified" response
+      return if response.code == 304
+      notifications = JSON.parse response.body
+      if response.code > 400
+        error("Error during http request: #{response.body}")
+        return
+      elsif emit_single_event?
+        create_event payload: {notifications: notifications}
+      else
+        notifications.each {|notification| create_event payload: notification}
+      end
+      memory[:last_modified] = response.headers["last-modified"]
+    end
+
+    private
+
+    def emit_single_event?
+      options['events'] == 'single'
+    end
+
+    def last_modified
+      options['last_modified']
+    end
+
+    def base_url
+      "https://api.github.com/notifications"
+    end
+
+    def request_options
+      {
+        headers: default_headers.merge(extra_headers),
+        query: query_parameters
+      }
+    end
+
+    def default_headers
+      {"User-Agent" => "Huginn (https://github.com/cantino/huginn)"}
+    end
+
+    def extra_headers
+      (memory[:last_modified].present? && boolify(last_modified)) ? {'If-Modified-Since' => memory[:last_modified]} : {}
+    end
+
+    def query_parameters
+      {
+        access_token: interpolated['access_token']
+      }
+    end
+  end
+end

data/spec/github_notifications_agent_spec.rb

@@ -0,0 +1,90 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::GithubNotificationsAgent do
+  before do
+    @valid_params = {
+      name: "somename",
+      options: {
+        access_token: 'sometoken',
+        events: "multiple",
+        last_modified: true
+      }
+    }
+
+    stub_request(:get, /github\.com/).to_return(
+      :body => File.read(File.join(__dir__,"fixtures/github_notifications.json")),
+      :status => 200,
+      :headers => {"Content-Type" => "text/json", "Last-Modified" => 'Thu, 25 Oct 2012 15:16:27 GMT'}
+    )
+
+    @checker = Agents::GithubNotificationsAgent.new(@valid_params)
+    @checker.user = users(:jane)
+    @checker.save!
+
+  end
+
+  describe "#check" do
+    it "checks if it can handle multiple events" do
+      expect {
+        @checker.check()
+      }.to change { Event.count }.by(2)
+    end
+  end
+
+  describe "helpers" do
+    it "should generate a correct request options hash on the first run" do
+      expect(@checker.send(:request_options)).to eq({
+        headers: {"User-Agent" => "Huginn (https://github.com/cantino/huginn)"},
+        query: {access_token: @checker.options['access_token']}
+      })
+    end
+
+    it "should generate a correct request options hash on consecutive runs" do
+      time = (Time.now-1.minute).iso8601
+      @checker.memory[:last_modified] = time
+      @checker.save
+      expect(@checker.reload.send(:request_options)).to eq({
+        headers: {"User-Agent" => "Huginn (https://github.com/cantino/huginn)", "If-Modified-Since" => time},
+        query: {access_token: @checker.options['access_token']}
+      })
+    end
+
+    it "should generate a correct request options hash on consecutive runs with last_modified == false" do
+      @checker.options['last_modified'] = 'false'
+      @checker.memory[:last_modified] = Time.now
+      @checker.save
+      expect(@checker.reload.send(:request_options)).to eq({
+        headers: {"User-Agent" => "Huginn (https://github.com/cantino/huginn)"},
+        query: {access_token: @checker.options['access_token']}
+      })
+    end
+
+  end
+
+  describe "validation" do
+    before do
+      expect(@checker).to be_valid
+    end
+
+    it "should validate presence of access_token key" do
+      @checker.options[:access_token] = nil
+      expect(@checker).not_to be_valid
+    end
+
+    it "should validate last_modified is boolean" do
+      @checker.options[:last_modified] = 'test'
+      expect(@checker).not_to be_valid
+    end
+
+    it "should validate interval is positive integer, if present" do
+      @checker.options[:interval] = "asdf"
+      expect(@checker).not_to be_valid
+    end
+
+    it "should validate interval is positive integer, if present" do
+      @checker.options[:interval] = "-1"
+      expect(@checker).not_to be_valid
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: huginn_github_notifications_agent
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- joenas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: huginn_agent
+  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'
+description: 
+email:
+- jon@jonnev.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/huginn_github_notifications_agent.rb
+- lib/huginn_github_notifications_agent/github_notifications_agent.rb
+- spec/github_notifications_agent_spec.rb
+homepage: https://github.com/joenas/huginn_github_notifications_agent
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Huginn agent to fetch Github notifications
+test_files:
+- spec/github_notifications_agent_spec.rb