dev_orbit 0.0.3 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb8ef6ed191bd8b2935945991706b3d0161779b4590ce002f9c63ef276617dfa
-  data.tar.gz: 9912ae5e0465d7adaf781c565d9bb83dc6a4204d248998a6c6b87f2f953aae46
+  metadata.gz: 792e11afeefa69fd18e74185a4032bdbb91f9f61ba1a81c7438f9ce9e4135fbc
+  data.tar.gz: 43d69304e73007aa485da66a4531e3d0a72897749cec00c6961566c34a7e83be
 SHA512:
-  metadata.gz: f117631421e3ead595db4643f1429d0eb46c2f222b56ec1c8fdeb6dd8260caf4a2a540562dfda0317255d7843d4e35cca54a4f7bf9996cf620efaeec9c5a7049
-  data.tar.gz: 528682ab4b41d0d4253180da0939f47446cbee821c84f5a23e6f7c6e416a124f1dddec42c5bcb0dbe4e6f52aca094010b417c75b9a569957ea452175896dba93
+  metadata.gz: b3f5520a392e8cd0884650e148dd8e576e2c1a40833ea3d50b00e41b75f4b5d6163c9bf940f4b7bac61bbb10a967a27cbd8a8190d724c1f2b4d039162d00f9bd
+  data.tar.gz: 3fbefe52bfb1d3c5624216650f604c53481e78e6e234396d820cb903bd3d5048afb23ee485a06cec0456be6ddd0a2b1eb55a8b83b81edd3bae8e0e6504aeab91

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

@@ -8,4 +8,25 @@
 
 ## [0.0.3] - 2021-03-09
 
-- Bug fix for the CLI functionality, now operational
+- Bug fix for the CLI functionality, now operational
+
+## [0.0.4] - 2021-03-10
+
+- 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

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    dev_orbit (0.0.2)
+    dev_orbit (0.0.7)
+      actionview (~> 6.1)
       activesupport (~> 6.1)
       http (~> 4.4)
       json (~> 2.5)
@@ -11,6 +12,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    actionview (6.1.3)
+      activesupport (= 6.1.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
     activesupport (6.1.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
@@ -20,13 +27,16 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
+    builder (3.2.4)
     byebug (11.1.3)
     concurrent-ruby (1.1.8)
     crack (0.4.5)
       rexml
+    crass (1.0.6)
     diff-lcs (1.4.4)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
+    erubi (1.10.0)
     ffi (1.15.0)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
@@ -45,11 +55,22 @@ GEM
     i18n (1.8.9)
       concurrent-ruby (~> 1.0)
     json (2.5.1)
+    loofah (2.9.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
     minitest (5.14.4)
+    nokogiri (1.11.2-x86_64-darwin)
+      racc (~> 1.4)
     parallel (1.20.1)
     parser (3.0.0.0)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
+    racc (1.5.2)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
     rainbow (3.0.0)
     rake (13.0.3)
     regexp_parser (2.1.1)

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

data/dev_orbit.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
   spec.add_dependency "activesupport", "~> 6.1"
+  spec.add_dependency "actionview", "~> 6.1"
   spec.add_dependency "http", "~> 4.4"
   spec.add_dependency "json", "~> 2.5"
   spec.add_dependency "zeitwerk", "~> 2.4"

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

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",
@@ -44,7 +46,7 @@ module DevOrbit
 
       response = https.request(request)
 
-      JSON.parse(response.body)
+      JSON.parse(response.body) if DevOrbit::Utils.valid_json?(response.body)
     end
 
     def get_article_comments(id)
@@ -55,7 +57,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

@@ -2,6 +2,8 @@
 
 require "net/http"
 require "json"
+require "action_view"
+require_relative "../utils"
 
 module DevOrbit
   module Interactions
@@ -29,7 +31,17 @@ module DevOrbit
         req["Content-Type"] = "application/json"
         req["Authorization"] = "Bearer #{@api_key}"
 
-        req.body = {
+        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
+        hash = {
           activity: {
             activity_type: "dev:comment",
             key: "dev-comment-#{@id}",
@@ -48,17 +60,15 @@ module DevOrbit
           }
         }
 
-        req.body[:activity][:member].merge!(twitter: @commenter[:twitter]) if @commenter[:twitter]
+        hash[:activity][:member].merge!(twitter: @commenter[:twitter]) if @commenter[:twitter]
 
-        req.body[:activity][:member].merge!(github: @commenter[:github]) if @commenter[:github]
+        hash[:activity][:member].merge!(github: @commenter[:github]) if @commenter[:github]
 
-        req.body = req.body.to_json
-
-        response = http.request(req)
-
-        JSON.parse(response.body)
+        hash
       end
 
+      private
+
       def construct_commenter(commenter)
         hash = {
           'name': commenter[:name],
@@ -77,7 +87,9 @@ module DevOrbit
       end
 
       def sanitize_comment(comment)
-        comment.gsub!(/(<[^>]*>)|\n|\t/s) { " " }
+        comment = ActionView::Base.full_sanitizer.sanitize(comment)
+
+        comment.gsub("\n", " ")
       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.3"
+  VERSION = "0.0.8"
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dev_orbit
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.8
 platform: ruby
 authors:
 - Ben Greenberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-09 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +133,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.sample"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -138,6 +154,7 @@ files:
 - lib/dev_orbit/dev.rb
 - lib/dev_orbit/interactions/comment.rb
 - lib/dev_orbit/orbit.rb
+- lib/dev_orbit/utils.rb
 - lib/dev_orbit/version.rb
 - scripts/check_comments.rb
 homepage: https://github.com/bencgreenberg/dev_orbit