dev_orbit 0.0.4 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44b1844cc0404a82182eb33f1a103b57d2b9be7577c1975e0c2e1755b44357f3
-  data.tar.gz: b2c48ee968464e77bf86088969fa35075da57239917274940b1112f4c6cf196a
+  metadata.gz: b2c4b8c2f8de5eabeff15996ee2d7d03b7ed40710d8f2f604ef0fb832cef0476
+  data.tar.gz: a50f6959cc9292b7822b1da81153df7f0d3a6ad397dd9e5211a5ca6900888085
 SHA512:
-  metadata.gz: f58e4425e99158a5e35b7aa0b2c3063c3bf12587339b4fd11b7e2ebee93b8d950e93abcb4285f61bd6e3dbddefba822bb0e41819890191c855cffde806cb7c69
-  data.tar.gz: ac4ddd1cd9e03cb6cab47cac12973f17e48fb8c2245c05679fb14685419041d8e91841243a53255f28b42fc814a7b92928a7b27dbd12e3fa9e1cde254c7f5f3b
+  metadata.gz: 95575a8af9172ad28c5c3613510d2f45076c38e9eb726e7a7670acd6a476f2b3b8683ce4c7abf5c7c8dd5d2c9f1c68c8f41287e4c2e52f6d63d2f74eaed34f62
+  data.tar.gz: d71011147c850f5bc5b8b4d6467bf7fb723dc5e766127046c9bb854dfd8afdf2f2e3b136e37b60585dbcf6e2e0503f99a07b7a8e7adbe375f03a4d30eebb5fc3

data/.env.sample

@@ -0,0 +1,4 @@
+ORBIT_API_KEY=
+ORBIT_WORKSPACE_ID=
+DEV_API_KEY=
+DEV_USERNAME=

data/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: [2.7, 3.0]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rspec

data/CHANGELOG.md

@@ -12,4 +12,25 @@
 
 ## [0.0.4] - 2021-03-10
 
-- Bug fix for stripping the HTML from the DEV blog post comment body
+- Bug fix for stripping the HTML from the DEV blog post comment body
+
+## [0.0.5] - 2021-03-10
+
+- Print out Orbit API response
+
+## [0.0.6] - 2021-03-10
+
+- Fix misnamed env var in client instantiation
+- Add a sample `.env` file
+
+## [0.0.7] - 2021-03-12
+
+- Check for valid JSON from API response before continuing
+
+## [0.0.8] - 2021-03-16
+
+- Early return if there are no new comments
+
+## [0.0.9] - 2021-04-11
+
+- Add check for new DEV followers functionality

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dev_orbit (0.0.3)
+    dev_orbit (0.0.8)
       actionview (~> 6.1)
       activesupport (~> 6.1)
       http (~> 4.4)
@@ -59,7 +59,7 @@ GEM
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     minitest (5.14.4)
-    nokogiri (1.11.1-x86_64-darwin)
+    nokogiri (1.11.2-x86_64-darwin)
       racc (~> 1.4)
     parallel (1.20.1)
     parser (3.0.0.0)

data/README.md

@@ -1,5 +1,6 @@
 # DEV.to Interactions to Orbit Workspace
 
+![Build Status](https://github.com/bencgreenberg/dev_orbit/workflows/CI/badge.svg)
 [![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)
 
@@ -19,6 +20,15 @@ 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:
+
+```ruby
+ORBIT_API_KEY
+ORBIT_WORKSPACE_ID
+DEV_API_KEY
+DEV_USERNAME
+```
+
 With the credentials as environment variables:
 
 ```ruby
@@ -46,7 +56,16 @@ 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.
 
-You can run this a daily cron job, for example, to add your newest DEV comments as activities in your Orbit workspace.
+
+### Post New DEV Followers to Orbit Workspace
+
+You can use the gem to get new DEV followers by invoking the `#followers` method on your `client` instance:
+
+```ruby
+client.followers
+```
+
+You can run this either of those or any one of them as a daily cron job, for example, to add your newest DEV comments and/or followers as activities and members in your Orbit workspace.
 
 ### CLI
 
@@ -58,6 +77,12 @@ You can also use the built-in CLI to perform the following operations:
 $ 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
+
+```bash
+$ ORBIT_API_KEY='...' ORBIT_WORKSPACE='...' DEV_API_KEY='...' DEV_USERNAME='...' bundle exec dev_orbit --check-followers
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/bencgreenberg/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/bencgreenberg/dev_orbit/blob/master/CODE_OF_CONDUCT.md).

data/bin/dev_orbit

@@ -2,6 +2,7 @@
 require 'optparse'
 
 check_comments = false
+check_followers = false
 
 options = {}
 choices = OptionParser.new do |opts|
@@ -13,6 +14,9 @@ choices = OptionParser.new do |opts|
   opts.on("--check-comments", "Check for new DEV comments") do
     check_comments = true
   end
+  opts.on("--check-followers", "Check for new DEV followers") do
+    check_followers = true
+  end
 end.parse!
 
 $LOAD_PATH.unshift(File.expand_path('../lib/dev_orbit', __dir__))
@@ -25,3 +29,9 @@ if check_comments
   ARGV[0] = 'render'
   DevOrbit::Scripts::CheckComments.start(ARGV)
 end
+
+if check_followers
+  puts "Checking for new DEV followers posting them to your Orbit workspace..."
+  ARGV[0] = 'render'
+  DevOrbit::Scripts::CheckComments.start(ARGV)
+end

data/lib/dev_orbit/client.rb

@@ -29,7 +29,7 @@ module DevOrbit
 
     def initialize(params = {})
       @orbit_api_key = params.fetch(:orbit_api_key, ENV["ORBIT_API_KEY"])
-      @orbit_workspace = params.fetch(:orbit_workspace, ENV["ORBIT_WORKSPACE"])
+      @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"])
     end
@@ -44,6 +44,15 @@ module DevOrbit
       ).process_comments
     end
 
+    def followers
+      DevOrbit::Dev.new(
+        api_key: @dev_api_key,
+        username: @dev_username,
+        workspace_id: @orbit_workspace,
+        orbit_api_key: @orbit_api_key
+      ).process_followers
+    end
+
     def orbit
       DevOrbit::Orbit.new
     end

data/lib/dev_orbit/dev.rb

@@ -3,6 +3,7 @@
 require "net/http"
 require "json"
 require "active_support/time"
+require_relative "utils"
 
 module DevOrbit
   class Dev
@@ -18,7 +19,8 @@ module DevOrbit
 
       articles.each do |article|
         comments = get_article_comments(article["id"])
-        next if comments.empty?
+
+        next if comments.nil? || comments.empty?
 
         DevOrbit::Orbit.call(
           type: "comments",
@@ -33,6 +35,23 @@ module DevOrbit
       end
     end
 
+    def process_followers
+      followers = get_followers
+
+      followers.each do |follower|
+        next if follower.nil? || follower.empty?
+
+        DevOrbit::Orbit.call(
+          type: "followers",
+          data: {
+            follower: follower
+          },
+          workspace_id: @workspace_id,
+          api_key: @orbit_api_key
+        )
+      end
+    end
+
     private
 
     def get_articles
@@ -44,7 +63,20 @@ module DevOrbit
 
       response = https.request(request)
 
-      JSON.parse(response.body)
+      JSON.parse(response.body) if DevOrbit::Utils.valid_json?(response.body)
+    end
+
+    def get_followers
+      url = URI("https://dev.to/api/followers/users")
+      https = Net::HTTP.new(url.host, url.port)
+      https.use_ssl = true
+
+      request = Net::HTTP::Get.new(url)
+      request["api_key"] = @api_key
+
+      response = https.request(request)
+
+      JSON.parse(response.body) if DevOrbit::Utils.valid_json?(response.body)
     end
 
     def get_article_comments(id)
@@ -55,7 +87,10 @@ module DevOrbit
       request = Net::HTTP::Get.new(url)
 
       response = https.request(request)
-      comments = JSON.parse(response.body)
+
+      comments = JSON.parse(response.body) if DevOrbit::Utils.valid_json?(response.body)
+
+      return if comments.nil? || comments.empty?
 
       filter_comments(comments)
     end

data/lib/dev_orbit/interactions/comment.rb

@@ -3,6 +3,7 @@
 require "net/http"
 require "json"
 require "action_view"
+require_relative "../utils"
 
 module DevOrbit
   module Interactions
@@ -36,7 +37,7 @@ module DevOrbit
 
         response = http.request(req)
 
-        JSON.parse(response.body)
+        JSON.parse(response.body) if DevOrbit::Utils.valid_json?(response.body)
       end
 
       def construct_body
@@ -86,7 +87,9 @@ module DevOrbit
       end
 
       def sanitize_comment(comment)
-        ActionView::Base.full_sanitizer.sanitize(comment)
+        comment = ActionView::Base.full_sanitizer.sanitize(comment)
+
+        comment.gsub("\n", " ")
       end
     end
   end

data/lib/dev_orbit/interactions/follower.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require "action_view"
+require_relative "../utils"
+
+module DevOrbit
+  module Interactions
+    class Follower
+      def initialize(id:, name:, username:, url:, workspace_id:, api_key:)
+        @id = id
+        @name = name
+        @username = username
+        @url = url
+        @workspace_id = workspace_id
+        @api_key = api_key
+
+        after_initialize!
+      end
+
+      def after_initialize!
+        url = URI("https://app.orbit.love/api/v1/#{@workspace_id}/members")
+
+        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)
+      end
+
+      def construct_body
+        {
+          member: {
+            name: @name.include?("_") ? @name.split("_").map(&:capitalize).join(" ") : @name,
+            devto: @username,
+            url: "https://dev.to#{@url}"
+          }
+        }
+      end
+    end
+  end
+end

data/lib/dev_orbit/orbit.rb

@@ -17,6 +17,17 @@ module DevOrbit
           )
         end
       end
+
+      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
+        )
+      end
     end
   end
 end

data/lib/dev_orbit/utils.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DevOrbit
+  class Utils
+    def self.valid_json?(string)
+      !JSON.parse(string).nil?
+    rescue JSON::ParserError
+      false
+    end
+  end
+end

data/lib/dev_orbit/version.rb

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

data/scripts/check_comments.rb

@@ -10,8 +10,7 @@ module DevOrbit
       desc "render", "check for new DEV comments and push them to Orbit"
       def render
         client = DevOrbit::Client.new
-        response = client.comments
-        puts response
+        client.comments
       end
     end
   end

data/scripts/check_followers.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "dev_orbit"
+require "thor"
+
+module DevOrbit
+  module Scripts
+    class CheckFollowers < Thor
+      desc "render", "check for new DEV followers and push them to Orbit"
+      def render
+        client = DevOrbit::Client.new
+        client.followers
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dev_orbit
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.9
 platform: ruby
 authors:
 - Ben Greenberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2021-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -133,6 +133,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.sample"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -151,9 +153,12 @@ files:
 - lib/dev_orbit/client.rb
 - lib/dev_orbit/dev.rb
 - lib/dev_orbit/interactions/comment.rb
+- lib/dev_orbit/interactions/follower.rb
 - lib/dev_orbit/orbit.rb
+- lib/dev_orbit/utils.rb
 - lib/dev_orbit/version.rb
 - scripts/check_comments.rb
+- scripts/check_followers.rb
 homepage: https://github.com/bencgreenberg/dev_orbit
 licenses:
 - MIT