circle_orbit 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05150b8b72010db06ed8915304757ae06a885e62130c9911b3de0e770177024d
-  data.tar.gz: f89c0f9b61f0aa4719a95e1e10a34e4c4d62519908a6a99aad38804acb9617ea
+  metadata.gz: fb34d0a49d0faedec68de8090ca49b128254bb362e2ac3dd5766dd81f77078ee
+  data.tar.gz: 3559155b79bdcfc9d0acdfad1d015afc9671defe748a2f1abbf2da41d126b8bb
 SHA512:
-  metadata.gz: 3bba116eab82c62e33bdae6abd7b03bf63934b07b892f2eb1bfc8424efb0f1863c9dc5e75df722bf7fbcb0117cd348f966c5858dcb6fa955ef59ad72cfbca5a2
-  data.tar.gz: 67d5bdf2f0a18ffdcaae2e29108c40794d01b30dd56268268ffe401809ae363831dfc3b4356c3222855ae86778401783869c842c986c46b8267fe2b09d90062b
+  metadata.gz: f8b7577ddd24e448ac577f9adfa4033749d7407ae72246de36db5ee90ffea1863d7adeb1dd8da444ac5178b728639cfb3a6b2a346446f326420847721c20637a
+  data.tar.gz: 02ff348d42763b30afe08044b83c48d57784f5da42324f6556f99e105bcd176c5115aef722d7e0e319967d2671e5c0448aca76fec417aa3b273fa5ce55058d47

data/Gemfile.lock

@@ -1,26 +1,26 @@
 PATH
   remote: .
   specs:
-    circle_orbit (0.0.1)
+    circle_orbit (0.0.2)
       actionview (~> 6.1)
       activesupport (~> 6.1)
       dotenv (~> 2.7)
       http (~> 4.4)
       json (~> 2.5)
-      orbit_activities (~> 0.1)
+      orbit_activities (~> 0.2)
       thor (~> 1.1)
       zeitwerk (~> 2.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionview (6.1.3.2)
-      activesupport (= 6.1.3.2)
+    actionview (6.1.4)
+      activesupport (= 6.1.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (6.1.3.2)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -31,7 +31,7 @@ GEM
     ast (2.4.2)
     builder (3.2.4)
     byebug (11.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     crack (0.4.5)
       rexml
     crass (1.0.6)
@@ -40,7 +40,7 @@ GEM
       unf (>= 0.0.5, < 1.0.0)
     dotenv (2.7.6)
     erubi (1.10.0)
-    ffi (1.15.1)
+    ffi (1.15.3)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
@@ -50,7 +50,7 @@ GEM
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
       http-parser (~> 1.2.0)
-    http-cookie (1.0.3)
+    http-cookie (1.0.4)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
     http-parser (1.2.3)
@@ -58,13 +58,15 @@ GEM
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     json (2.5.1)
-    loofah (2.9.1)
+    loofah (2.10.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     minitest (5.14.4)
-    nokogiri (1.11.3-arm64-darwin)
+    nokogiri (1.11.7-arm64-darwin)
       racc (~> 1.4)
-    orbit_activities (0.1.0)
+    nokogiri (1.11.7-x86_64-linux)
+      racc (~> 1.4)
+    orbit_activities (0.2.2)
       http (~> 4.4)
       json (~> 2.5)
       rake (~> 13.0)
@@ -96,13 +98,13 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.15.0)
+    rubocop (1.18.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.5.0, < 2.0)
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.7.0)
@@ -123,6 +125,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   byebug

data/README.md

@@ -49,12 +49,20 @@ client = CircleOrbit::Client.new(
     circle_url: YOUR_CIRCLE_URL
 )
 ```
-
 ### Instantiation with credentials in dotenv file:
 
 ```ruby
 client = CircleOrbit::Client.new
 ```
+### Performing a Historical Import
+
+You may want to perform a one-time historical import to fetch all your previous Circle interactions and bring them into your Orbit workspace. To do so, instantiate your `client` with the `historical_import` flag:
+
+```ruby
+client = CircleOrbit::Client.new(
+  historical_import: true
+)
+```
 ### Post New Spaces Posts to Orbit Workspace
 
 You can use the gem to get new posts in your Circle Spaces and share them as custom activities to your Orbit workspace by using the `#posts` method on your `client instance`:
@@ -86,6 +94,8 @@ To check for new comments on posts:
 $ ORBIT_API_KEY=... ORBIT_WORKSPACE_ID=... CIRCLE_API_KEY=... CIRCLE_URL=... bundle exec circle_orbit --check-comments
 ```
 
+**Add the `--historical-import` flag to your CLI command to perform a historical import of all your Circle interactions using the CLI.**
+
 ## GitHub Actions Automation Setup
 
 ⚡ You can set up this integration in a matter of minutes using our GitHub Actions template. It will run regularly to add new activities to your Orbit workspace. All you need is a GitHub account.

data/bin/circle_orbit

@@ -5,6 +5,7 @@ require "optparse"
 
 check_comments = false
 check_posts = false
+historical_import = false
 
 options = {}
 choices = OptionParser.new do |opts|
@@ -19,6 +20,9 @@ choices = OptionParser.new do |opts|
   opts.on("--check-posts", "Check for new posts in your Circle Spaces") do
     check_posts = true
   end
+  opts.on("--historical-import", "Performa historical import of all new Circle interactions") do
+    historical_import = true
+  end
 end.parse!
 
 $LOAD_PATH.unshift(File.expand_path("../lib/circle_orbit", __dir__))
@@ -30,11 +34,13 @@ require_relative "../scripts/check_posts"
 if check_comments
   puts "Checking for new Circle Spaces post comments within the past day and sending them to your Orbit workspace..."
   ARGV[0] = "render"
+  ARGV[1] = historical_import
   CircleOrbit::Scripts::CheckComments.start(ARGV)
 end
 
 if check_posts
   puts "Checking for new Circle Spaces posts and sending them to your Orbit workspace..."
   ARGV[0] = "render"
+  ARGV[1] = historical_import
   CircleOrbit::Scripts::CheckPosts.start(ARGV)
 end

data/circle_orbit.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "dotenv", "~> 2.7"
   spec.add_dependency "http", "~> 4.4"
   spec.add_dependency "json", "~> 2.5"
-  spec.add_dependency "orbit_activities", "~> 0.1"
+  spec.add_dependency "orbit_activities", "~> 0.2"
   spec.add_dependency "thor", "~> 1.1"
   spec.add_dependency "zeitwerk", "~> 2.4"
   spec.add_development_dependency "rspec", "~> 3.4"

data/lib/circle_orbit/circle.rb

@@ -8,6 +8,7 @@ module CircleOrbit
       @circle_url = params.fetch(:circle_url)
       @orbit_api_key = params.fetch(:orbit_api_key)
       @orbit_workspace = params.fetch(:orbit_workspace)
+      @historical_import = params.fetch(:historical_import, false)
     end
 
     def process_posts
@@ -16,9 +17,21 @@ module CircleOrbit
       spaces.each do |space|
         posts = get_posts(space["id"])
 
+        times = 0
+        orbit_timestamp = last_orbit_activity_timestamp(type: "post")
         posts.each do |post|
           next if post.nil? || post.empty?
 
+          unless @historical_import && orbit_timestamp
+            next if post["created_at"] < orbit_timestamp unless orbit_timestamp.nil?
+          end
+
+          if orbit_timestamp && @historical_import == false
+            next if post["created_at"] < orbit_timestamp
+          end
+
+          times += 1
+
           CircleOrbit::Orbit.call(
             type: "post",
             data: post,
@@ -26,6 +39,11 @@ module CircleOrbit
             orbit_workspace: @orbit_workspace
           )
         end
+
+        output = "Sent #{times} new posts to your Orbit workspace"
+
+        puts output
+        return output
       end
     end
 
@@ -34,9 +52,21 @@ module CircleOrbit
 
       return if comments.nil? || comments.empty?
 
+      times = 0
+      orbit_timestamp = last_orbit_activity_timestamp(type: "comment")
       comments.each do |comment|
         next if comment.nil? || comment.empty?
 
+        unless @historical_import && orbit_timestamp
+          next if comment["body"]["created_at"] < orbit_timestamp unless orbit_timestamp.nil?
+        end
+
+        if orbit_timestamp && @historical_import == false
+          next if comment["body"]["created_at"] < orbit_timestamp
+        end
+
+        times += 1
+
         CircleOrbit::Orbit.call(
           type: "comment",
           data: comment,
@@ -44,6 +74,10 @@ module CircleOrbit
           orbit_workspace: @orbit_workspace
         )
       end
+      output = "Sent #{times} new comments to your Orbit workspace"
+
+      puts output
+      return output
     end
 
     private
@@ -89,5 +123,25 @@ module CircleOrbit
 
       JSON.parse(response.body)
     end
+
+    def last_orbit_activity_timestamp(type: )
+      @last_orbit_activity_timestamp ||= begin
+        if type == "post"
+          activity_type = "custom:circle:post"
+        end
+
+        if type == "comment"
+          activity_type = "custom:circle:comment"
+        end
+
+        OrbitActivities::Request.new(
+          api_key: @orbit_api_key,
+          workspace_id: @orbit_workspace,
+          user_agent: "community-ruby-circle-orbit/#{CircleOrbit::VERSION}",
+          action: "latest_activity_timestamp",
+          filters: { activity_type: activity_type }
+        ).response
+      end
+    end
   end
 end

data/lib/circle_orbit/client.rb

@@ -23,13 +23,17 @@ require "json"
 # @option params [String] :circle_url
 #   The URL of the Circle community
 #
+# @option params [Boolean] :historical_import
+#   Flag on whether to import all Circle historical data
+#   Default to false
+#
 # @param [Hash] params
 #
 # @return [CircleOrbit::Client]
 #
 module CircleOrbit
   class Client
-    attr_accessor :orbit_api_key, :orbit_workspace, :circle_api_key, :circle_url, :circle_community_id
+    attr_accessor :orbit_api_key, :orbit_workspace, :circle_api_key, :circle_url, :circle_community_id, :historical_import
 
     def initialize(params = {})
       @orbit_api_key = params.fetch(:orbit_api_key, ENV["ORBIT_API_KEY"])
@@ -37,6 +41,7 @@ module CircleOrbit
       @circle_api_key = params.fetch(:circle_api_key, ENV["CIRCLE_API_KEY"])
       @circle_url = sanitize_url(params.fetch(:circle_url, ENV["CIRCLE_URL"]))
       @circle_community_id = circle_community_id
+      @historical_import = params.fetch(:historical_import, false)
     end
 
     def posts
@@ -45,7 +50,8 @@ module CircleOrbit
         circle_url: @circle_url,
         circle_community_id: @circle_community_id,
         orbit_api_key: @orbit_api_key,
-        orbit_workspace: @orbit_workspace
+        orbit_workspace: @orbit_workspace,
+        historical_import: @historical_import
       ).process_posts
     end
 
@@ -55,7 +61,8 @@ module CircleOrbit
         circle_url: @circle_url,
         circle_community_id: @circle_community_id,
         orbit_api_key: @orbit_api_key,
-        orbit_workspace: @orbit_workspace
+        orbit_workspace: @orbit_workspace,
+        historical_import: @historical_import
       ).process_comments
     end
 

data/lib/circle_orbit/version.rb

@@ -3,5 +3,5 @@
 # frozen_string_literal = true
 
 module CircleOrbit
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/scripts/check_comments.rb

@@ -8,8 +8,8 @@ module CircleOrbit
   module Scripts
     class CheckComments < Thor
       desc "render", "check for new comments in Spaces posts and push them to Orbit"
-      def render
-        client = CircleOrbit::Client.new
+      def render(*params)
+        client = CircleOrbit::Client.new(historical_import: params[0])
         client.comments
       end
     end

data/scripts/check_posts.rb

@@ -8,8 +8,8 @@ module CircleOrbit
   module Scripts
     class CheckPosts < Thor
       desc "render", "check for new posts in Circle Spaces and push them to Orbit"
-      def render
-        client = CircleOrbit::Client.new
+      def render(*params)
+        client = CircleOrbit::Client.new(historical_import: params[0])
         client.posts
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: circle_orbit
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Orbit DevRel
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-08 00:00:00.000000000 Z
+date: 2021-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -87,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement