dev_orbit 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '07219661dd60fcc93ef1d66943b44c927b7ee25c126dcdf8cabc64d463ea5331'
-  data.tar.gz: 45171eb10c22b690802bf6497fcf9db18165b506a7767451b0a89705a6b421db
+  metadata.gz: 051a39f2fff550c076f0a7bec373c7634f0b6516a9173121ba4b9facebfa157c
+  data.tar.gz: acad969ccbc5ac6dd29b176f069e4a94eb00cec1ffa69c301a9c5da5284e3d6a
 SHA512:
-  metadata.gz: 01d5109a441e6c85244f5dfbcefc4010d29380b21924f84cab2f70b30389e638cbd2f6a081697a6adfe06a48476a190f24a93e49b6c4536057f74b7cb99547aa
-  data.tar.gz: 120224d240169f093e7f3152db9ba9673b7290bb44944f00e59c5c7f8cd6aadfbff2acef3aa5fabeadde05e89ccc557c84ce436b46f0aba32cf7504143840125
+  metadata.gz: 6953c67373ff7f8ae654a87916045b54c2254736809fd074ff26f6a46b400a9e6144226eaf29d2247e3e532877735b378adc77e28b29532e3d4325cf5b22ebce
+  data.tar.gz: e1a4069e95e2b5ff86b14625132bef5e5342c55e1e2d4cd767345fbd53e114cbb5ed5515826e554ffbeb04d929f1bdab1322b93868504a651a0a2ac0afef5cac

data/.env.sample

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

data/.gitignore

@@ -6,4 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
-.byebug_history
+.byebug_history
+.env

data/Gemfile

@@ -9,4 +9,6 @@ gem "rake", "~> 13.0"
 
 gem "rubocop", "~> 1.7"
 
+gem "orbit_activities"
+
 gem "byebug"

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    dev_orbit (0.1.0)
+    dev_orbit (0.1.3)
       actionview (~> 6.1)
       activesupport (~> 6.1)
       http (~> 4.4)
       json (~> 2.5)
+      orbit_activities (~> 0.1)
       thor (~> 1.1)
       zeitwerk (~> 2.4)
 
@@ -59,12 +60,21 @@ GEM
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     minitest (5.14.4)
-    nokogiri (1.11.3-arm64-darwin)
+    nokogiri (1.11.5-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.2-x86_64-linux)
+    nokogiri (1.11.3-x86_64-linux)
       racc (~> 1.4)
+    orbit_activities (0.1.0)
+      http (~> 4.4)
+      json (~> 2.5)
+      rake (~> 13.0)
+      zeitwerk (~> 2.4)
     parallel (1.20.1)
     parser (3.0.0.0)
       ast (~> 2.4.1)
@@ -125,6 +135,7 @@ PLATFORMS
 DEPENDENCIES
   byebug
   dev_orbit!
+  orbit_activities
   rake (~> 13.0)
   rspec (~> 3.4)
   rubocop (~> 1.7)

data/README.md

@@ -4,11 +4,14 @@
 [![Gem Version](https://badge.fury.io/rb/dev_orbit.svg)](https://badge.fury.io/rb/dev_orbit)
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](code_of_conduct.md)
 
-This is a Ruby gem that can be used to integrate your DEV interactions, like DEV comments on blog posts, into your organization's Orbit workspace.
+Add your DEV interactions into your Orbit workspace with this community-built integration.
+
+![New DEV blog post comment in Orbit screenshot](readme-images/new-comment-screenshot.png)
 
 |<p align="left">:sparkles:</p> This is a *community project*. The Orbit team does its best to maintain it and keep it up to date with any recent API changes.<br/><br/>We welcome community contributions to make sure that it stays current. <p align="right">:sparkles:</p>|
 |-----------------------------------------|
 
+![There are three ways to use this integration. Install package - build and run your own applications. Run the CLI - run on-demand directly from your terminal. Schedule an automation with GitHub - get started in minutes - no coding required](readme-images/ways-to-use.png)
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -23,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:
@@ -45,19 +49,30 @@ 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
+### 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 or organization by invoking the `#comments` method on your `client` instance:
+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
@@ -74,18 +89,24 @@ 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
+```
+
 ## 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,7 @@ require 'optparse'
 
 check_comments = false
 check_followers = false
+check_org_comments = false
 
 options = {}
 choices = OptionParser.new do |opts|
@@ -17,6 +18,9 @@ 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
 end.parse!
 
 $LOAD_PATH.unshift(File.expand_path('../lib/dev_orbit', __dir__))
@@ -24,6 +28,7 @@ $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..."
@@ -36,3 +41,9 @@ 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'
+  DevOrbit::Scripts::CheckOrgComments.start(ARGV)
+end

data/dev_orbit.gemspec

@@ -35,6 +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_development_dependency "rspec", "~> 3.4"
   spec.add_development_dependency "webmock", "~> 3.12"
 

data/lib/dev_orbit.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "zeitwerk"
+require "orbit_activities"
+require_relative "dev_orbit/version"
 
 module DevOrbit
   loader = Zeitwerk::Loader.new

data/lib/dev_orbit/client.rb

@@ -13,6 +13,9 @@
 # @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
 #
@@ -25,23 +28,24 @@
 #
 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
 
     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"])
     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
+      ).process_comments(type: type)
     end
 
     def followers
@@ -53,6 +57,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,13 +9,14 @@ 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"])
     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"])
@@ -54,8 +55,15 @@ module DevOrbit
 
     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
 

data/lib/dev_orbit/interactions/comment.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "net/http"
 require "json"
 require "action_view"
 require_relative "../utils"
@@ -22,22 +21,13 @@ module DevOrbit
       end
 
       def after_initialize!
-        url = URI("https://app.orbit.love/api/v1/#{@workspace_id}/activities")
-
-        http = Net::HTTP.new(url.host, url.port)
-        http.use_ssl = true
-        req = Net::HTTP::Post.new(url)
-        req["Accept"] = "application/json"
-        req["Content-Type"] = "application/json"
-        req["Authorization"] = "Bearer #{@api_key}"
-
-        req.body = construct_body
-
-        req.body = req.body.to_json
-
-        response = http.request(req)
-
-        JSON.parse(response.body) if DevOrbit::Utils.valid_json?(response.body)
+        OrbitActivities::Request.new(
+          api_key: @api_key,
+          workspace_id: @workspace_id,
+          user_agent: "community-ruby-dev-orbit/#{DevOrbit::VERSION}",
+          action: "new_activity",
+          body: construct_body.to_json
+        )
       end
 
       def construct_body
@@ -65,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
 
@@ -84,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

@@ -28,6 +28,7 @@ module DevOrbit
         req["Accept"] = "application/json"
         req["Content-Type"] = "application/json"
         req["Authorization"] = "Bearer #{@api_key}"
+        req["User-Agent"] = "community-ruby-dev-orbit/#{DevOrbit::VERSION}"
 
         req.body = construct_body
 

data/lib/dev_orbit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DevOrbit
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 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
+        client = DevOrbit::Client.new
+        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.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Orbit DevRel
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-11 00:00:00.000000000 Z
+date: 2021-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -95,6 +95,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: orbit_activities
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -128,9 +142,7 @@ description: This gem integrates DEV blog interactions like comments, etc. into
 email:
 - devrel@orbit.love
 executables:
-- console
 - dev_orbit
-- setup
 extensions: []
 extra_rdoc_files: []
 files:
@@ -146,9 +158,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
 - bin/dev_orbit
-- bin/setup
 - dev_orbit.gemspec
 - lib/dev_orbit.rb
 - lib/dev_orbit/client.rb
@@ -158,8 +168,11 @@ files:
 - lib/dev_orbit/orbit.rb
 - lib/dev_orbit/utils.rb
 - lib/dev_orbit/version.rb
+- readme-images/new-comment-screenshot.png
+- 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/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "dev_orbit"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

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