huginn_github_notifications_agent 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0d6aee74e2adca3a10f5ab9279365077842e4a2c
-  data.tar.gz: 32156bfb2ba69eeebc9a6fa96c659aa28b38f456
+SHA256:
+  metadata.gz: 32de69b831360c89b3502b200d49f099cc3c9a7616c34fcb6bdc2fc6deb11747
+  data.tar.gz: 07dd68125abca5710eb4b0d80f303c91220a328cc426df118821fd7d7ce4d8f4
 SHA512:
-  metadata.gz: 12e52d39209d83e739ad87633b2b538f10f5331f27573f2c62980930b186cc683e1c0aff71763b327d83ed9704551bb3888bf2db27fd1292f1a752789413321c
-  data.tar.gz: f2c6f6bbe30297e82f415439a310f2051d4ec50c8acaa771a98b6d2819d7aabba12415a6420e3a789a9b971ca9d4cdbea233c688e39ca2514c88432ccef0aa02
+  metadata.gz: 6ce0a3c77a6120b6403879c428484fb2755c586bb7a9769c1f1e5b1b9ec6342cbb743dc29b4af16cd483cd24bcf4b6cb3968c845491b3fbf6bc791aa64c6f23b
+  data.tar.gz: b1a643a836c5350baa9eeef1dc2fb15c5ebf7ef6a3659187ab0a9b74c25fbdb2e8e5e2f8141529c0640bd17df89a3f52bdb5d979c81138ade8438b0dde3d90a2

data/lib/huginn_github_notifications_agent.rb

@@ -1,4 +1,11 @@
+# frozen_string_literal: true
+
+# rubocop:disable Layout/LineLength
+
 require 'huginn_agent'
+require 'virtus'
+require 'huginn_github_notifications_agent/subject'
 
-#HuginnAgent.load 'huginn_github_notifications_agent/concerns/my_agent_concern'
+# HuginnAgent.load 'huginn_github_notifications_agent/concerns/my_agent_concern'
 HuginnAgent.register 'huginn_github_notifications_agent/github_notifications_agent'
+# rubocop:enable Layout/LineLength

data/lib/huginn_github_notifications_agent/github_notifications_agent.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 module Agents
   class GithubNotificationsAgent < Agent
-
     cannot_receive_events!
     can_dry_run!
 
-    default_schedule "every_10m"
+    default_schedule 'every_10m'
 
     description <<-MD
       The GithubNotificationsAgent fetches your notifications from Github.
@@ -17,6 +18,14 @@ module Agents
 
       More options might be added for the [API](https://developer.github.com/v3/activity/notifications/#list-your-notifications).
 
+      This agent also adds two more fields to `subject` in the response, `url_web` and `repo_name`. These are for convenience, if you want to link to the updated resource for example.
+      ```
+      "subject": {
+        "url_web": "https://github.com/joenas/huginn_github_notifications/pull/1234",
+        "repo_name": "joenas/huginn_github_notifications"
+      }
+      ```
+
     MD
 
     def default_options
@@ -28,32 +37,49 @@ module Agents
     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
+      unless options['access_token'].present?
+        errors.add(:base, 'access_token is required ')
+      end
+      # rubocop:disable Style/GuardClause
       if last_modified.present? && boolify(last_modified).nil?
-        errors.add(:base, "last_modified must be a boolean value")
+        errors.add(:base, 'last_modified must be a boolean value')
       end
+      # rubocop:enable Style/GuardClause
     end
 
     def working?
       !recent_error_logs?
     end
 
+    # TODO: Fix
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
     def check
       response = HTTParty.get base_url, request_options
-      # If there are no new notifications, you will see a "304 Not Modified" response
+      # If there are no new notifications, you will get a "304 Not Modified"
       return if response.code == 304
-      notifications = JSON.parse response.body
+
+      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}
+      end
+      notifications.each do |notif|
+        data = notif['subject'].merge(
+          repo_name: notif['repository']['full_name']
+        )
+        subject = ::HuginnGithubNotificationsAgent::Subject.new(data)
+        notif['subject'] = subject.to_h
+      end
+      if emit_single_event?
+        create_event payload: { notifications: notifications }
       else
-        notifications.each {|notification| create_event payload: notification}
+        notifications.each { |notification| create_event payload: notification }
       end
-      memory[:last_modified] = response.headers["last-modified"]
+      memory[:last_modified] = response.headers['last-modified']
     end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
 
     private
 
@@ -65,29 +91,33 @@ module Agents
       options['last_modified']
     end
 
+    def use_last_modified?
+      memory[:last_modified].present? && boolify(last_modified)
+    end
+
     def base_url
-      "https://api.github.com/notifications"
+      'https://api.github.com/notifications'
     end
 
     def request_options
       {
-        headers: default_headers.merge(extra_headers),
-        query: query_parameters
+        headers: default_headers.merge(extra_headers)
       }
     end
 
     def default_headers
-      {"User-Agent" => "Huginn (https://github.com/cantino/huginn)"}
+      {
+        'User-Agent' => 'Huginn (https://github.com/cantino/huginn)',
+        'Authorization' => 'token ' + interpolated['access_token']
+      }
     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']
-      }
+      if use_last_modified?
+        { 'If-Modified-Since' => memory[:last_modified] }
+      else
+        {}
+      end
     end
   end
 end

data/lib/huginn_github_notifications_agent/subject.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module HuginnGithubNotificationsAgent
+  class Subject
+    include Virtus.model
+
+    attribute :title, String
+    attribute :url, String
+    attribute :latest_comment_url, String
+    attribute :type, String
+    attribute :url_web, String
+    attribute :repo_name, String
+
+    def url_web
+      matches = url.scan(%r{/(?<type>pull|issues)s?/(?<id>\d+)$})
+      (["https://github.com/#{repo_name}"] << matches.flatten).join('/')
+    end
+  end
+end

data/spec/github_notifications_agent_spec.rb

@@ -1,90 +1,115 @@
+# frozen_string_literal: true
+
 require 'rails_helper'
 require 'huginn_agent/spec_helper'
 
 describe Agents::GithubNotificationsAgent do
   before do
     @valid_params = {
-      name: "somename",
+      name: 'somename',
       options: {
-        access_token: 'sometoken',
-        events: "multiple",
+        access_token: '{% credential github_access_token %}',
+        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'}
+      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'
+      }
     )
 
+    users(:jane).user_credentials.create!(
+      credential_name: 'github_access_token',
+      credential_value: 'something'
+    )
     @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)
+  describe '#check' do
+    it "emits a single event with options['events'] = single" do
+      @checker.options[:events] = 'single'
+      expect { @checker.check }.to change { Event.count }.by(1)
+    end
+
+    it "emits multiple events with options['events'] = multiple" do
+      expect { @checker.check }.to change { Event.count }.by(2)
+    end
+
+    it 'creates an Events with the received data' do
+      @checker.check
+      expect(Event.last.payload['url']).to eq 'https://api.github.com/notifications/threads/1'
+
+      # Adding subject.url_web
+      subject_first = @checker.events.first.payload['subject']
+      subject_last = @checker.events.last.payload['subject']
+      expect(subject_first['url_web']).to eq 'https://github.com/octocat/Hello-World/pull/10'
+      expect(subject_first['repo_name']).to eq 'octocat/Hello-World'
+      expect(subject_first['title']).to eq 'Greetings'
+      expect(subject_last['url_web']).to eq 'https://github.com/octocat/Hello-World/issues/123'
     end
   end
 
-  describe "helpers" do
-    it "should generate a correct request options hash on the first run" do
+  describe 'helpers' do
+    it 'should generate a correct request options hash on the first run' do
+      access_token = users(:jane).user_credentials.last.credential_value
       expect(@checker.send(:request_options)).to eq({
-        headers: {"User-Agent" => "Huginn (https://github.com/cantino/huginn)"},
-        query: {access_token: @checker.options['access_token']}
+        headers: {
+          'User-Agent' => 'Huginn (https://github.com/cantino/huginn)',
+          'Authorization' => "token #{access_token}"
+        }
       })
     end
 
-    it "should generate a correct request options hash on consecutive runs" do
-      time = (Time.now-1.minute).iso8601
+    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
+      access_token = users(:jane).user_credentials.last.credential_value
       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']}
+        headers: {
+          'User-Agent' => 'Huginn (https://github.com/cantino/huginn)',
+          'If-Modified-Since' => time,
+          'Authorization' => "token #{access_token}"
+        }
       })
     end
 
-    it "should generate a correct request options hash on consecutive runs with last_modified == false" do
+    # rubocop:disable Layout/LineLength
+    it 'should generate a correct request options hash on consecutive runs with last_modified == false' do
+      # rubocop:enable Layout/LineLength
       @checker.options['last_modified'] = 'false'
       @checker.memory[:last_modified] = Time.now
       @checker.save
+      access_token = users(:jane).user_credentials.last.credential_value
       expect(@checker.reload.send(:request_options)).to eq({
-        headers: {"User-Agent" => "Huginn (https://github.com/cantino/huginn)"},
-        query: {access_token: @checker.options['access_token']}
+        headers: {
+          'User-Agent' => 'Huginn (https://github.com/cantino/huginn)',
+          'Authorization' => "token #{access_token}"
+        }
       })
     end
-
   end
 
-  describe "validation" do
+  describe 'validation' do
     before do
       expect(@checker).to be_valid
     end
 
-    it "should validate presence of access_token key" do
+    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
+    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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: huginn_github_notifications_agent
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - joenas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-15 00:00:00.000000000 Z
+date: 2020-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.1
 - !ruby/object:Gem::Dependency
   name: huginn_agent
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: 
 email:
 - jon@jonnev.se
@@ -62,6 +90,7 @@ files:
 - LICENSE.txt
 - lib/huginn_github_notifications_agent.rb
 - lib/huginn_github_notifications_agent/github_notifications_agent.rb
+- lib/huginn_github_notifications_agent/subject.rb
 - spec/github_notifications_agent_spec.rb
 homepage: https://github.com/joenas/huginn_github_notifications_agent
 licenses:
@@ -82,8 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Huginn agent to fetch Github notifications