dev_orbit 0.1.5 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d171db649e66e6a5c982a44e8188b40526f0d0714c2bc1910587ba892d44e2b7
-  data.tar.gz: dccbdb226266f0cad7551aa765cad38f75cc21b226de4dfd13f2ee4b07dc27fa
+  metadata.gz: ce1f0009ec93dd8200f5c31fa63e016780d46aa4214a212990c17192c4da0df6
+  data.tar.gz: 1c7d8b16887c52840016944fc0a0498187e41ccd39e357967109ba48421473b9
 SHA512:
-  metadata.gz: e3479322756252837970a5fd3baaf07d7dbc55333a640969fa8f814a320f10763497df0b673fe811dfe420b5f7f2c11447ec435d6d590f3cede3bf729e4756fb
-  data.tar.gz: 294b99070ad389f7abe9f031a4a52c8f6c3e4d52b2b0beec29b742767fe53830f203cd51827c3f08d976e9a4774faad4ae4ca2576ba515ee4f33e7fa3e86b05b
+  metadata.gz: 1b2a168a89eea4fad802491d4a686d466f178f62b432c7b2c47ad6f5c20fe7cb17743f4ac6687c94a3a027c214809dde556c64d6bafa3c34fd4d7dfbad2ebcc4
+  data.tar.gz: d820ef63efd2246cc560227c57a26cf332819d30745db76740d8106b888c6e73cc41e706f7e98a844b39ccf726252f402f44d5113dd53a9de3d35fa477634efb

data/.env.sample

@@ -1,4 +1,5 @@
 ORBIT_API_KEY=
 ORBIT_WORKSPACE_ID=
 DEV_API_KEY=
-DEV_USERNAME=
+DEV_USERNAME=
+DEV_ORGANIZATION=

data/CHANGELOG.md

@@ -41,4 +41,7 @@
 ## [0.1.0] - 2021-05-06
 
 - Correct CLI `CheckFollowers` action
-- Update gem specifications
+- Update gem specifications
+## [0.4.1] - 2021-07-01
+
+- Remove debugging output from processing DEV comments

data/Gemfile.lock

@@ -1,25 +1,25 @@
 PATH
   remote: .
   specs:
-    dev_orbit (0.1.3)
+    dev_orbit (0.4.0)
       actionview (~> 6.1)
       activesupport (~> 6.1)
       http (~> 4.4)
       json (~> 2.5)
-      orbit_activities (~> 0.1)
+      orbit_activities (~> 0.2)
       thor (~> 1.1)
       zeitwerk (~> 2.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionview (6.1.3.2)
-      activesupport (= 6.1.3.2)
+    actionview (6.1.4)
+      activesupport (= 6.1.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (6.1.3.2)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -30,7 +30,7 @@ GEM
     ast (2.4.2)
     builder (3.2.4)
     byebug (11.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     crack (0.4.5)
       rexml
     crass (1.0.6)
@@ -38,7 +38,7 @@ GEM
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
     erubi (1.10.0)
-    ffi (1.15.0)
+    ffi (1.15.3)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
@@ -48,7 +48,7 @@ GEM
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
       http-parser (~> 1.2.0)
-    http-cookie (1.0.3)
+    http-cookie (1.0.4)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
     http-parser (1.2.3)
@@ -56,27 +56,19 @@ GEM
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     json (2.5.1)
-    loofah (2.9.1)
+    loofah (2.10.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     minitest (5.14.4)
-    nokogiri (1.11.5-arm64-darwin)
+    nokogiri (1.11.7-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.11.5-x86_64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.11.5-x86_64-linux)
-      racc (~> 1.4)
-    nokogiri (1.11.3-x86_64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.11.3-x86_64-linux)
-      racc (~> 1.4)
-    orbit_activities (0.1.0)
+    orbit_activities (0.2.2)
       http (~> 4.4)
       json (~> 2.5)
       rake (~> 13.0)
       zeitwerk (~> 2.4)
     parallel (1.20.1)
-    parser (3.0.0.0)
+    parser (3.0.1.1)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
     racc (1.5.2)
@@ -102,17 +94,17 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.11.0)
+    rubocop (1.17.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
     thor (1.1.0)
     tzinfo (2.0.4)
@@ -121,7 +113,7 @@ GEM
       unf_ext
     unf_ext (0.0.7.7)
     unicode-display_width (2.0.0)
-    webmock (3.12.1)
+    webmock (3.13.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -129,8 +121,6 @@ GEM
 
 PLATFORMS
   arm64-darwin-20
-  x86_64-darwin-19
-  x86_64-linux
 
 DEPENDENCIES
   byebug

data/README.md

@@ -26,13 +26,14 @@ gem 'dev_orbit'
 
 To instantiate a DevOrbit client, you can either pass along your credentials for DEV and Orbit directly to the instantiation or retain them in your environment variables.
 
-The following are the expected environment variables:
+The following are the environment variables, you can provide either or both a `DEV_USERNAME` or a `DEV_ORGANIZATION`:
 
 ```ruby
 ORBIT_API_KEY
 ORBIT_WORKSPACE_ID
 DEV_API_KEY
 DEV_USERNAME
+DEV_ORGANIZATION
 ```
 
 With the credentials as environment variables:
@@ -48,20 +49,39 @@ client = DevOrbit::Client.new(
   orbit_api_key: '...',
   orbit_workspace: '...',
   dev_api_key: '...',
-  dev_username: '...'
+  dev_username: '...',
+  dev_organization: '...'
 )
 ```
 
-### Post New DEV Comments to Orbit Workspace
+### Performing a Historical Import
 
-You can use the gem to get new DEV comments on your DEV user or organization by invoking the `#comments` method on your `client` instance:
+By default, the integration will only import comments that are newer than the newest DEV comment in your Orbit workspace. You may want to perform a one-time historical import to fetch all your previous DEV comments and bring them into your Orbit workspace. To do so, instantiate your `client` with the `historical_import` flag:
+
+```ruby
+client = DevOrbit::Client.new(
+  historical_import: true
+)
+```
+### Post New DEV Comments from a DEV User to Orbit Workspace
+
+You can use the gem to get new DEV comments on your DEV user by invoking the `#comments` method on your `client` instance:
 
 ```ruby
 client.comments
 ```
 
-This method will fetch all your articles from DEV, gather their respective comments, filter them for anything within the past day, and then send them to your Orbit workspace via the Orbit API.
+This method will fetch all your user articles from DEV, gather their respective comments, filter them for anything within the past day, and then send them to your Orbit workspace via the Orbit API.
 
+### Post New DEV Comments from a DEV Organization to Orbit Workspace
+
+You can use the gem to get new DEV comments on your DEV organization by invoking the `#comments` method on your `client` instance:
+
+```ruby
+client.organization_comments
+```
+
+This method will fetch all your organization articles from DEV, gather their respective comments, filter them for anything within the past day, and then send them to your Orbit workspace via the Orbit API.
 
 ### Post New DEV Followers to Orbit Workspace
 
@@ -77,18 +97,25 @@ You can run this either of those or any one of them as a daily cron job, for exa
 
 You can also use the built-in CLI to perform the following operations:
 
-* Check for new DEV comments and post them to Orbit
+* Check for new DEV user comments and post them to Orbit
 
 ```bash
 $ ORBIT_API_KEY='...' ORBIT_WORKSPACE='...' DEV_API_KEY='...' DEV_USERNAME='...' bundle exec dev_orbit --check-comments
 ```
 
-* Check for new DEV followers and post them to Orbit
+* Check for new DEV user followers and post them to Orbit
 
 ```bash
 $ ORBIT_API_KEY='...' ORBIT_WORKSPACE='...' DEV_API_KEY='...' DEV_USERNAME='...' bundle exec dev_orbit --check-followers
 ```
 
+* Check for new DEV organization comments and post them to Orbit
+
+```bash
+$ ORBIT_API_KEY='...' ORBIT_WORKSPACE='...' DEV_API_KEY='...' DEV_ORGANIZATION='...' bundle exec dev_orbit --check-organization-comments
+```
+**Add the `--historical-import` flag to your CLI command to perform a historical import of all your DEV comments using the CLI.**
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/orbit-love/community-ruby-dev-orbit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/orbit-love/community-ruby-dev-orbit/blob/main/CODE_OF_CONDUCT.md).

data/bin/dev_orbit

@@ -3,6 +3,8 @@ require 'optparse'
 
 check_comments = false
 check_followers = false
+check_org_comments = false
+historical_import = false
 
 options = {}
 choices = OptionParser.new do |opts|
@@ -17,6 +19,12 @@ choices = OptionParser.new do |opts|
   opts.on("--check-followers", "Check for new DEV followers") do
     check_followers = true
   end
+  opts.on("--check-organization-comments", "Check for new DEV comments for an organization") do
+    check_org_comments = true
+  end
+  opts.on("--historical-import", "Performa historical import of all new DEV comments") do
+    historical_import = true
+  end
 end.parse!
 
 $LOAD_PATH.unshift(File.expand_path('../lib/dev_orbit', __dir__))
@@ -24,10 +32,12 @@ $LOAD_PATH.unshift(File.expand_path('../lib/dev_orbit', __dir__))
 require_relative '../lib/dev_orbit'
 require_relative '../scripts/check_comments'
 require_relative '../scripts/check_followers'
+require_relative '../scripts/check_org_comments'
 
 if check_comments
   puts "Checking for new DEV comments within the past day and posting them to your Orbit workspace..."
   ARGV[0] = 'render'
+  ARGV[1] = historical_import
   DevOrbit::Scripts::CheckComments.start(ARGV)
 end
 
@@ -36,3 +46,10 @@ if check_followers
   ARGV[0] = 'render'
   DevOrbit::Scripts::CheckFollowers.start(ARGV)
 end
+
+if check_org_comments
+  puts "Checking for new DEV organization comments and posting them to your Orbit workspace..."
+  ARGV[0] = 'render'
+  ARGV[1] = historical_import
+  DevOrbit::Scripts::CheckOrgComments.start(ARGV)
+end

data/dev_orbit.gemspec

@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "json", "~> 2.5"
   spec.add_dependency "zeitwerk", "~> 2.4"
   spec.add_dependency "thor", "~> 1.1"
-  spec.add_dependency "orbit_activities", "~> 0.1"
+  spec.add_dependency "orbit_activities", "~> 0.2"
   spec.add_development_dependency "rspec", "~> 3.4"
   spec.add_development_dependency "webmock", "~> 3.12"
 

data/lib/dev_orbit/client.rb

@@ -13,35 +13,45 @@
 # @option params [String] :dev_api_key
 #   The API key for the DEV API
 #
+# @option params [String] :dev_organization
+#   The name of the organization in DEV to fetch interactions for
+#
 # @option params [String] :orbit_workspace
 #   The workspace ID for the Orbit workspace
 #
 # @option params [String] :orbit_api_key
 #   The API key for the Orbit API
 #
+# @option params [Boolean] :historical_import
+#   Perform a historical import on all DEV comments
+#   Boolean, default to false
+#
 # @param [Hash] params
 #
 # @return [DevOrbit::Client]
 #
 module DevOrbit
   class Client
-    attr_accessor :dev_username, :dev_api_key, :orbit_workspace, :orbit_api_key
+    attr_accessor :dev_username, :dev_api_key, :dev_organization, :orbit_workspace, :orbit_api_key, :historical_import
 
     def initialize(params = {})
       @orbit_api_key = params.fetch(:orbit_api_key, ENV["ORBIT_API_KEY"])
       @orbit_workspace = params.fetch(:orbit_workspace, ENV["ORBIT_WORKSPACE_ID"])
       @dev_api_key = params.fetch(:dev_api_key, ENV["DEV_API_KEY"])
       @dev_username = params.fetch(:dev_username, ENV["DEV_USERNAME"])
+      @dev_organization = params.fetch(:dev_organization, ENV["DEV_ORGANIZATION"])
+      @historical_import = params.fetch(:historical_import, false)
     end
 
     # Fetch new comments from DEV and post them to the Orbit workspace
-    def comments
+    def comments(type: "user")
       DevOrbit::Dev.new(
         api_key: @dev_api_key,
         username: @dev_username,
         workspace_id: @orbit_workspace,
-        orbit_api_key: @orbit_api_key
-      ).process_comments
+        orbit_api_key: @orbit_api_key,
+        historical_import: @historical_import
+      ).process_comments(type: type)
     end
 
     def followers
@@ -53,6 +63,15 @@ module DevOrbit
       ).process_followers
     end
 
+    def organization_comments(type: "organization")
+      DevOrbit::Dev.new(
+        api_key: @dev_api_key,
+        organization: @dev_organization,
+        workspace_id: @orbit_workspace,
+        orbit_api_key: @orbit_api_key
+      ).process_comments(type: type)
+    end
+
     def orbit
       DevOrbit::Orbit.new
     end

data/lib/dev_orbit/dev.rb

@@ -9,20 +9,22 @@ module DevOrbit
   class Dev
     def initialize(params = {})
       @username = params.fetch(:username, ENV["DEV_USERNAME"])
+      @organization = params.fetch(:organization, ENV["DEV_ORGANIZATION"])
       @api_key = params.fetch(:api_key, ENV["DEV_API_KEY"])
       @workspace_id = params.fetch(:workspace_id, ENV["ORBIT_WORKSPACE_ID"])
       @orbit_api_key = params.fetch(:orbit_api_key, ENV["ORBIT_API_KEY"])
+      @historical_import = params.fetch(:historical_import, false)
     end
 
-    def process_comments
-      articles = get_articles
+    def process_comments(type:)
+      articles = get_articles(type: type)
 
       articles.each do |article|
         comments = get_article_comments(article["id"])
 
         next if comments.nil? || comments.empty?
 
-        DevOrbit::Orbit.call(
+        return DevOrbit::Orbit.new(
           type: "comments",
           data: {
             comments: comments,
@@ -30,8 +32,9 @@ module DevOrbit
             url: article["url"]
           },
           workspace_id: @workspace_id,
-          api_key: @orbit_api_key
-        )
+          api_key: @orbit_api_key,
+          historical_import: @historical_import
+        ).call
       end
     end
 
@@ -41,21 +44,29 @@ module DevOrbit
       followers.each do |follower|
         next if follower.nil? || follower.empty?
 
-        DevOrbit::Orbit.call(
+        DevOrbit::Orbit.new(
           type: "followers",
           data: {
             follower: follower
           },
           workspace_id: @workspace_id,
-          api_key: @orbit_api_key
-        )
+          api_key: @orbit_api_key,
+          historical_import: @historical_import
+        ).call
       end
     end
 
     private
 
-    def get_articles
-      url = URI("https://dev.to/api/articles?username=#{@username}&top=1")
+    def get_articles(type:)
+      if type == "user"
+        url = URI("https://dev.to/api/articles?username=#{@username}&top=1")
+      end
+
+      if type == "organization"
+        url = URI("https://dev.to/api/organizations/#{@organization}/articles")
+      end
+
       https = Net::HTTP.new(url.host, url.port)
       https.use_ssl = true
 
@@ -92,13 +103,7 @@ module DevOrbit
 
       return if comments.nil? || comments.empty?
 
-      filter_comments(comments)
-    end
-
-    def filter_comments(comments)
-      comments.select do |comment|
-        comment["created_at"] <= 1.day.ago
-      end
+      comments
     end
   end
 end

data/lib/dev_orbit/interactions/comment.rb

@@ -55,6 +55,8 @@ module DevOrbit
 
         hash[:activity][:member].merge!(github: @commenter[:github]) if @commenter[:github]
 
+        hash[:activity][:member].merge(url: @commenter[:url]) if @commenter[:url]
+
         hash
       end
 
@@ -74,6 +76,10 @@ module DevOrbit
           hash.merge!('github': commenter[:github_username])
         end
 
+        unless commenter[:website_url].nil? || commenter[:website_url] == ""
+          hash.merge('url': commenter[:website_url])
+        end
+
         hash
       end
 

data/lib/dev_orbit/interactions/follower.rb

@@ -43,8 +43,7 @@ module DevOrbit
         {
           member: {
             name: @name.include?("_") ? @name.split("_").map(&:capitalize).join(" ") : @name,
-            devto: @username,
-            url: "https://dev.to#{@url}"
+            devto: @username
           }
         }
       end

data/lib/dev_orbit/orbit.rb

@@ -2,32 +2,79 @@
 
 require "net/http"
 require "json"
+require "active_support/time"
 
 module DevOrbit
   class Orbit
-    def self.call(type:, data:, workspace_id:, api_key:)
-      if type == "comments"
-        data[:comments].each do |comment|
+    def initialize(type:, data:, workspace_id:, api_key:, historical_import: false)
+      @type = type
+      @data = data
+      @workspace_id = workspace_id
+      @api_key = api_key
+      @historical_import = historical_import
+      @last_orbit_activity_timestamp = last_orbit_activity_timestamp(type)
+    end
+    
+    def call
+      if @type == "comments"
+        times = 0
+        
+        @data[:comments].each do |comment|
+          unless @historical_import && @last_orbit_activity_timestamp
+            next if comment["created_at"] || comment[:created_at] < @last_orbit_activity_timestamp unless @last_orbit_activity_timestamp.nil? 
+          end
+
+          if @last_orbit_activity_timestamp && @historical_import == false
+            next if comment["created_at"] || comment[:created_at] < @last_orbit_activity_timestamp
+          end
+
+          times += 1
+
           DevOrbit::Interactions::Comment.new(
-            article_title: data.transform_keys(&:to_sym)[:title],
+            article_title: @data.transform_keys(&:to_sym)[:title],
             comment: comment.transform_keys(&:to_sym),
-            url: data[:url],
-            workspace_id: workspace_id,
-            api_key: api_key
+            url: @data[:url],
+            workspace_id: @workspace_id,
+            api_key: @api_key
           )
         end
+
+        output = "Sent #{times} new DEV comments to your Orbit workspace"
+        
+        puts output
+        return output
       end
 
-      if type == "followers"
+      if @type == "followers"
         DevOrbit::Interactions::Follower.new(
-          id: data[:follower]["id"],
-          name: data[:follower]["name"],
-          username: data[:follower]["username"],
-          url: data[:follower]["path"],
-          workspace_id: workspace_id,
-          api_key: api_key
+          id: @data[:follower]["id"],
+          name: @data[:follower]["name"],
+          username: @data[:follower]["username"],
+          url: @data[:follower]["path"],
+          workspace_id: @workspace_id,
+          api_key: @api_key
         )
       end
     end
+
+    def last_orbit_activity_timestamp(type)
+      @last_orbit_activity_timestamp ||= begin
+        if type == "comments"
+          activity_type = "custom:dev:comment"
+        end
+
+        if type == "followers"
+          return nil
+        end
+
+        OrbitActivities::Request.new(
+          api_key: @api_key,
+          workspace_id: @workspace_id,
+          user_agent: "community-ruby-dev-orbit/#{DevOrbit::VERSION}",
+          action: "latest_activity_timestamp",
+          filters: { activity_type: activity_type }
+        ).response
+      end
+    end
   end
 end

data/lib/dev_orbit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DevOrbit
-  VERSION = "0.1.5"
+  VERSION = "0.4.1"
 end

data/scripts/check_comments.rb

@@ -8,8 +8,8 @@ module DevOrbit
   module Scripts
     class CheckComments < Thor
       desc "render", "check for new DEV comments and push them to Orbit"
-      def render
-        client = DevOrbit::Client.new
+      def render(*params)
+        client = DevOrbit::Client.new(historical_import: params[0])
         client.comments
       end
     end

data/scripts/check_org_comments.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "dev_orbit"
+require "thor"
+
+module DevOrbit
+  module Scripts
+    class CheckOrgComments < Thor
+      desc "render", "check for new DEV comments on an organization and push them to Orbit"
+      def render(*params)
+        client = DevOrbit::Client.new(historical_import: params[0])
+        client.organization_comments
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dev_orbit
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.4.1
 platform: ruby
 authors:
 - Orbit DevRel
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-27 00:00:00.000000000 Z
+date: 2021-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -101,14 +101,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -143,7 +143,6 @@ email:
 - devrel@orbit.love
 executables:
 - dev_orbit
-- setup
 extensions: []
 extra_rdoc_files: []
 files:
@@ -160,7 +159,6 @@ files:
 - README.md
 - Rakefile
 - bin/dev_orbit
-- bin/setup
 - dev_orbit.gemspec
 - lib/dev_orbit.rb
 - lib/dev_orbit/client.rb
@@ -174,6 +172,7 @@ files:
 - readme-images/ways-to-use.png
 - scripts/check_comments.rb
 - scripts/check_followers.rb
+- scripts/check_org_comments.rb
 homepage: https://github.com/orbit-love/community-ruby-dev-orbit
 licenses:
 - MIT

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here