dev_orbit 0.0.2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36450d6b5b14037522d0c711ad89d7ffb7f184054910f0b75913372647b448d2
-  data.tar.gz: 10965b3d98928c4c0a5da6f1417bb5503276726f876202688100c744e6d3936a
+  metadata.gz: a9c02ba74434acb5637a4d93ecd37dc4883969ba36128bb001130d0b6dfbf087
+  data.tar.gz: 6c9eca9384cdb84eb9049d45acf25da3c05a421a75f083a2883f14fb8bef1a7e
 SHA512:
-  metadata.gz: bef3e7efafbf38944a2c3b89a366502527a1263ef523748a28a01b3fe7e330f08335f5b2845d847c9996b7d99bc222e71841b04257846f1270008a393fa7d191
-  data.tar.gz: de5fe855a40bce77bd853d9a61b933a708b96f1eb7eadbac27305ef34e815a50983428b8eaff59e1618cb4e36d213772115cc37d4ad8d01a1ee698002e9caf28
+  metadata.gz: e9870c95fc0e32a818528f2f0ceec830f781cf9193a63056760e30a71e94e6caa509953dfa9408cd27a3dff34003f02f5c1d030a79043d4c47cb2bd4d9606ca7
+  data.tar.gz: fde99905baf0e7a7faad0041c4256ad55713c2dc648e58af4590e18c25c16cf11739321176c36aee75049a249c3bf2ac423df6461a09e4541972198597facb79

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

@@ -4,4 +4,25 @@
 
 ## [0.0.2] - 2021-03-09
 
-- Add a CLI to the gem to run the gem's operations
+- Add a CLI to the gem to run the gem's operations
+
+## [0.0.3] - 2021-03-09
+
+- 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

data/Gemfile.lock

@@ -1,15 +1,23 @@
 PATH
   remote: .
   specs:
-    dev_orbit (0.0.1)
+    dev_orbit (0.0.6)
+      actionview (~> 6.1)
       activesupport (~> 6.1)
       http (~> 4.4)
       json (~> 2.5)
+      thor (~> 1.1)
       zeitwerk (~> 2.4)
 
 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)
@@ -19,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)
@@ -44,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)
@@ -78,6 +100,7 @@ GEM
     rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
     ruby-progressbar (1.11.0)
+    thor (1.1.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unf (0.1.4)

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/bin/dev_orbit

@@ -22,5 +22,6 @@ require_relative '../scripts/check_comments'
 
 if check_comments
   puts "Checking for new DEV comments within the past day and posting them to your Orbit workspace..."
-  %x[ ruby scripts/check_comments.rb ]
+  ARGV[0] = 'render'
+  DevOrbit::Scripts::CheckComments.start(ARGV)
 end

data/dev_orbit.gemspec

@@ -23,16 +23,18 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   # 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"
+  spec.add_dependency "thor", "~> 1.1"
   spec.add_development_dependency "rspec", "~> 3.4"
   spec.add_development_dependency "webmock", "~> 3.12"
 

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,6 +19,7 @@ module DevOrbit
 
       articles.each do |article|
         comments = get_article_comments(article["id"])
+
         next if comments.empty?
 
         DevOrbit::Orbit.call(
@@ -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,8 @@ 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)
 
       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.2"
+  VERSION = "0.0.7"
 end

data/scripts/check_comments.rb

@@ -2,9 +2,16 @@
 # frozen_string_literal: true
 
 require "dev_orbit"
+require "thor"
 
-client = DevOrbit::Client.new
-
-response = client.comments
-
-puts response
+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
+        client.comments
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dev_orbit
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.7
 platform: ruby
 authors:
 - Ben Greenberg
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2021-03-09 00:00:00.000000000 Z
+date: 2021-03-12 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
@@ -66,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -98,10 +126,15 @@ description: This gem integrates DEV blog interactions like comments, etc. into
   Orbit workspace
 email:
 - ben.greenberg@hey.com
-executables: []
+executables:
+- console
+- dev_orbit
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.sample"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -121,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