dev_orbit 0.0.1 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80bcc5826d4088f33048db1adc6cc22029b8739e5affd5154f1af496b7f63e04
-  data.tar.gz: 714dc5857e7c11820068f67e004a203cc905c1fcb28c154ebc9f3065a5340561
+  metadata.gz: c91ef071ae7615cf957e49580b99d384b842227bdb5f16557115ae8a81449dfc
+  data.tar.gz: f0d90c3fe043997e7ca812572b3a81b26e261a51b53d64ca98babc0a002e0287
 SHA512:
-  metadata.gz: ae17e17441b221b7a2b9cbf104517c8a3fc36d568549764ffb6670318cb5187be0e9460bf4e59ae6e3d653f40ff27ccf0bdce1deeb2b6d71e3ca6a6edbc44ee3
-  data.tar.gz: 85d4c3d19eb02499608dd140c36f2190ca94470086cd17a881c3c51626665c36eb6d013543f705a6a651673c74ce1879d5d430debbf8a7cf8e5fd595d2e6ce28
+  metadata.gz: 621bd01a4bec7709a5a5ec196dd2bb1235c1eb6334bccb2cc7384c090fee3e8ab10419ccd180e1675d5cdf4694db17e6ccc2d0c7a5b50246cc732bd2e438f798
+  data.tar.gz: 6f988344ad296cfc1ce2e7defcc6534946a511eeb272079689e2fff375ea37824cf0209a59c7ec3879b1ea934bcf43f03b3bc8291be01edbb35df9dada392b74

data/.env.sample

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

data/CHANGELOG.md

@@ -1,3 +1,24 @@
 ## [0.0.1] - 2021-03-06
 
 - Initial release
+
+## [0.0.2] - 2021-03-09
+
+- 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

data/Gemfile.lock

@@ -1,15 +1,23 @@
 PATH
   remote: .
   specs:
-    dev_orbit (0.0.1)
+    dev_orbit (0.0.4)
+      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.1-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,8 @@
 # DEV.to Interactions to Orbit Workspace
 
+[![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.
 
 ## Installation
@@ -16,6 +19,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
@@ -45,6 +57,16 @@ This method will fetch all your articles from DEV, gather their respective comme
 
 You can run this a daily cron job, for example, to add your newest DEV comments as activities in your Orbit workspace.
 
+### CLI
+
+You can also use the built-in CLI to perform the following operations:
+
+* Check for new DEV comments and post them to Orbit
+
+```bash
+$ ORBIT_API_KEY='...' ORBIT_WORKSPACE='...' DEV_API_KEY='...' DEV_USERNAME='...' bundle exec dev_orbit --check-comments
+```
+
 ## 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

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+require 'optparse'
+
+check_comments = false
+
+options = {}
+choices = OptionParser.new do |opts|
+  opts.banner = "Usage: dev_orbit --check-comments"
+  opts.on("-h", "--help", "Prints help instructions") do
+    puts opts
+    exit
+  end
+  opts.on("--check-comments", "Check for new DEV comments") do
+    check_comments = true
+  end
+end.parse!
+
+$LOAD_PATH.unshift(File.expand_path('../lib/dev_orbit', __dir__))
+
+require_relative '../lib/dev_orbit'
+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..."
+  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/interactions/comment.rb

@@ -2,6 +2,7 @@
 
 require "net/http"
 require "json"
+require "action_view"
 
 module DevOrbit
   module Interactions
@@ -29,7 +30,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)
+
+        puts JSON.parse(response.body)
+      end
+
+      def construct_body
+        hash = {
           activity: {
             activity_type: "dev:comment",
             key: "dev-comment-#{@id}",
@@ -48,17 +59,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 +86,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/version.rb

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

data/scripts/check_comments.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "dev_orbit"
+require "thor"
+
+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.1
+  version: 0.0.6
 platform: ruby
 authors:
 - Ben Greenberg
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2021-03-09 00:00:00.000000000 Z
+date: 2021-03-10 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,14 @@ 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"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -113,6 +145,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/dev_orbit
 - bin/setup
 - dev_orbit.gemspec
 - lib/dev_orbit.rb
@@ -121,6 +154,7 @@ files:
 - lib/dev_orbit/interactions/comment.rb
 - lib/dev_orbit/orbit.rb
 - lib/dev_orbit/version.rb
+- scripts/check_comments.rb
 homepage: https://github.com/bencgreenberg/dev_orbit
 licenses:
 - MIT