circle_orbit 0.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Orbit Labs, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+# Circle Interactions to Orbit Workspace
+
+![Build Status](https://github.com/orbit-love/community-ruby-circle-orbit/workflows/CI/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/circle_orbit.svg)](https://badge.fury.io/rb/circle_orbit)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](.github/CODE_OF_CONDUCT.md)
+
+Add your Circle interactions into your Orbit workspace with this community-built integration.
+
+![Screenshot of Activity in Orbit Workspace](readme-images/screenshot_of_activity.png)
+
+|<p align="left">:sparkles:</p> This is a *community project*. The Orbit team does its best to maintain it and keep it up to date with any recent API changes.<br/><br/>We welcome community contributions to make sure that it stays current. <p align="right">:sparkles:</p>|
+|-----------------------------------------|
+
+![There are three ways to use this integration. Install package - build and run your own applications. Run the CLI - run on-demand directly from your terminal. Schedule an automation with GitHub - get started in minutes - no coding required](readme-images/ways-to-use.png)
+
+## First Time Setup
+
+To set up this integration you will need your Circle API key and your Circle community URL. See the below table for instructions on where to find it, along with your Orbit API credentials.
+## Application Credentials
+
+The application requires the following environment variables:
+
+| Variable | Description | More Info
+|---|---|--|
+| `CIRCLE_API_KEY` | Circle API key | Create a new API key in the API section in your User Settings
+| `CIRCLE_URL`     | Circle community URL | This is your Circle custom URL, for example: `https://orbit.circle.so`
+| `ORBIT_API_KEY` | API key for Orbit | Found in `Account Settings` in your Orbit workspace
+| `ORBIT_WORKSPACE_ID` | ID for your Orbit workspace | Last part of the Orbit workspace URL, i.e. `https://app.orbit.love/my-workspace`, the ID is `my-workspace`
+
+## Package Usage
+
+Install the package with the following command
+
+```
+$ gem install circle_orbit
+```
+
+Then, run `bundle install` from your terminal.
+
+You can instantiate a client by either passing in the required credentials during instantiation or by providing them in your `.env` file.
+
+### Instantiation with credentials:
+
+```ruby
+client = CircleOrbit::Client.new(
+    orbit_api_key: YOUR_API_KEY,
+    orbit_workspace_id: YOUR_ORBIT_WORKSPACE_ID,
+    circle_api_key: YOUR_CIRCLE_API_KEY,
+    circle_url: YOUR_CIRCLE_URL
+)
+```
+
+### Instantiation with credentials in dotenv file:
+
+```ruby
+client = CircleOrbit::Client.new
+```
+### 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`:
+
+```ruby
+client.posts
+```
+
+### Post New Spaces Comments to Orbit Workspace
+
+You can use the gem to get new comments on posts in your Circle Spaces and share them as custom activities to your Orbit workspace by using the `#posts` method on your `client instance`:
+
+```ruby
+client.comments
+```
+## CLI Usage
+
+You can also use this package with the included CLI. To use the CLI pass in the required environment variables on the command line before invoking the CLI.
+
+To check for new posts:
+
+```bash
+$ ORBIT_API_KEY=... ORBIT_WORKSPACE_ID=... CIRCLE_API_KEY=... CIRCLE_URL=... bundle exec circle_orbit --check-posts
+```
+
+To check for new comments on posts:
+
+```bash
+$ ORBIT_API_KEY=... ORBIT_WORKSPACE_ID=... CIRCLE_API_KEY=... CIRCLE_URL=... bundle exec circle_orbit --check-comments
+```
+
+## 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.
+
+[See our guide for setting up this automation](https://github.com/orbit-love/github-actions-templates/blob/main/Circle/README.md)
+
+## Contributing
+
+We 💜 contributions from everyone! Check out the [Contributing Guidelines](.github/CONTRIBUTING.md) for more information.
+
+## License
+
+This project is under the [MIT License](./LICENSE).
+
+## Code of Conduct
+
+This project uses the [Contributor Code of Conduct](.github/CODE_OF_CONDUCT.md). We ask everyone to please adhere by its guidelines.

data/bin/circle_orbit

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+require 'optparse'
+
+check_comments = false
+check_posts = false
+
+options = {}
+choices = OptionParser.new do |opts|
+  opts.banner = "Usage: circle_orbit --check-comments"
+  opts.on("-h", "--help", "Prints help instructions") do
+    puts opts
+    exit
+  end
+  opts.on("--check-comments", "Check for new comments on your Circle Spaces posts") do
+    check_comments = true
+  end
+  opts.on("--check-posts", "Check for new posts in your Circle Spaces") do
+    check_posts = true
+  end
+end.parse!
+
+$LOAD_PATH.unshift(File.expand_path('../lib/circle_orbit', __dir__))
+
+require_relative '../lib/circle_orbit'
+require_relative '../scripts/check_comments'
+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'
+  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'
+  CircleOrbit::Scripts::CheckPosts.start(ARGV)
+end

data/circle_orbit.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/circle_orbit/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "circle_orbit"
+  spec.version                = CircleOrbit::VERSION
+  spec.authors                = ["Orbit DevRel", "Ben Greenberg"]
+  spec.email                  = ["devrel@orbit.love"]
+
+  spec.summary                = "Integrate Circle interactions into Orbit"
+  spec.description            = "This gem brings in Circle activities to your Orbit workspace"
+  spec.homepage               = "https://github.com/orbit-love/community-ruby-circle-orbit"
+  spec.license                = "MIT"
+  spec.required_ruby_version  = Gem::Requirement.new(">= 2.7.2")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/orbit-love/community-ruby-circle-orbit/blob/main/CHANGELOG.md"
+
+  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                 = "bin"
+  spec.executables            = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths          = ["lib"]
+
+  spec.add_dependency "actionview", "~> 6.1"
+  spec.add_dependency "activesupport", "~> 6.1"
+  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 "thor", "~> 1.1"
+  spec.add_dependency "zeitwerk", "~> 2.4"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "webmock", "~> 3.12"
+end

data/docs/setup.md

@@ -0,0 +1,11 @@
+<small><a href="../README.md">Back to README</a></small>
+
+# First Time Setup
+
+<!-- This is a summary section. Explain what we need to do at a high-level. For example... -->
+
+During the setup, we will need to create a new application on Stack Apps which will allow this integration to interact with the platform. The application will contain a Key which we should take note of for later.
+
+1. Head to [Stack Apps](https://stackapps.com) and login in to your account.
+2. [Register a new Stack Apps application](https://stackapps.com/apps/oauth/register). The oauth domain can be anything, as can the application website.
+3. In your application settings, take note of your `Key` value.

data/lib/circle_orbit.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+require "orbit_activities"
+require_relative "circle_orbit/version"
+
+module CircleOrbit
+  loader = Zeitwerk::Loader.new
+  loader.tag = File.basename(__FILE__, ".rb")
+  loader.push_dir(__dir__)
+  loader.setup
+end

data/lib/circle_orbit/circle.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module CircleOrbit
+  class Circle
+    def initialize(params = {})
+      @circle_api_key = params.fetch(:circle_api_key)
+      @circle_community_id = params.fetch(:circle_community_id)
+      @circle_url = params.fetch(:circle_url)
+      @orbit_api_key = params.fetch(:orbit_api_key)
+      @orbit_workspace = params.fetch(:orbit_workspace)
+    end
+
+    def process_posts
+      spaces = get_spaces
+
+      spaces.each do |space|
+        posts = get_posts(space["id"])
+
+        posts.each do |post|
+          CircleOrbit::Orbit.call(
+            type: "post",
+            data: post,
+            orbit_api_key: @orbit_api_key,
+            orbit_workspace: @orbit_workspace
+          )
+        end
+      end
+    end
+
+    def process_comments
+        comments = get_comments
+
+        return if comments.nil? || comments.empty?
+
+        comments.each do |comment|
+            CircleOrbit::Orbit.call(
+                type: "comment",
+                data: comment,
+                orbit_api_key: @orbit_api_key,
+                orbit_workspace: @orbit_workspace
+            )
+        end
+    end
+
+    private
+
+    def get_spaces
+      url = URI("#{@circle_url}/api/v1/spaces?community_id=#{@circle_community_id}")
+
+      https = Net::HTTP.new(url.host, url.port)
+      https.use_ssl = true
+
+      request = Net::HTTP::Get.new(url)
+      request["Authorization"] = "Token #{@circle_api_key}"
+
+      response = https.request(request)
+
+      response = JSON.parse(response.body)
+    end
+
+    def get_posts(id)
+      url = URI("#{@circle_url}/api/v1/posts?community_id=#{@circle_community_id}&space_id=#{id}")
+
+      https = Net::HTTP.new(url.host, url.port)
+      https.use_ssl = true
+
+      request = Net::HTTP::Get.new(url)
+      request["Authorization"] = "Token #{@circle_api_key}"
+
+      response = https.request(request)
+
+      response = JSON.parse(response.body)
+    end
+
+    def get_comments
+        url = URI("#{@circle_url}/api/v1/comments?community_id=#{@circle_community_id}")
+
+        https = Net::HTTP.new(url.host, url.port)
+        https.use_ssl = true
+  
+        request = Net::HTTP::Get.new(url)
+        request["Authorization"] = "Token #{@circle_api_key}"
+  
+        response = https.request(request)
+  
+        response = JSON.parse(response.body)
+    end
+  end
+end

data/lib/circle_orbit/client.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "dotenv/load"
+require "net/http"
+require "json"
+
+# Create a client to log Circle activities in your Orbit workspace
+# Credentials can either be passed in to the instance or be loaded
+# from environment variables
+#
+# @example
+#   client = CircleOrbit::Client.new
+#
+# @option params [String] :orbit_api_key
+#   The API key for the Orbit API
+#
+# @option params [String] :orbit_workspace
+#   The workspace ID for the Orbit workspace
+#
+# @option params [String] :circle_api_key
+#   The API key for the Circle API
+#
+# @option params [String] :circle_url
+#   The URL of the Circle community
+#
+# @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
+
+    def initialize(params = {})
+      @orbit_api_key = params.fetch(:orbit_api_key, ENV["ORBIT_API_KEY"])
+      @orbit_workspace = params.fetch(:orbit_workspace, ENV["ORBIT_WORKSPACE_ID"])
+      @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
+    end
+
+    def posts
+      CircleOrbit::Circle.new(
+        circle_api_key: @circle_api_key,
+        circle_url: @circle_url,
+        circle_community_id: @circle_community_id,
+        orbit_api_key: @orbit_api_key,
+        orbit_workspace: @orbit_workspace
+      ).process_posts
+    end
+
+    def comments
+      CircleOrbit::Circle.new(
+        circle_api_key: @circle_api_key,
+        circle_url: @circle_url,
+        circle_community_id: @circle_community_id,
+        orbit_api_key: @orbit_api_key,
+        orbit_workspace: @orbit_workspace
+      ).process_comments
+    end
+
+    private
+
+    def sanitize_url(url)
+      return url.delete_suffix("/") if url[-1, 1] == "/"
+
+      url
+    end
+
+    def circle_community_id
+      @circle_community_id ||= begin
+        return ENV["CIRCLE_COMMUNITY_ID"] if ENV["CIRCLE_COMMUNITY_ID"]
+
+        url = URI("#{@circle_url}/api/v1/communities")
+
+        https = Net::HTTP.new(url.host, url.port)
+        https.use_ssl = true
+
+        request = Net::HTTP::Get.new(url)
+        request["Authorization"] = "Token #{@circle_api_key}"
+
+        response = https.request(request)
+
+        response = JSON.parse(response.body)
+
+        response[0]["id"]
+      end
+    end
+  end
+end

data/lib/circle_orbit/interactions/comment.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "json"
+require "action_view"
+
+module CircleOrbit
+  module Interactions
+    class Comment
+      def initialize(post_title:, body:, created_at:, id:, space:, url:, author:, email:, workspace_id:, api_key:)
+        @post_title = post_title
+        @body = sanitize_body(body)
+        @created_at = created_at
+        @id = id
+        @space = space
+        @url = url
+        @author = author
+        @email = email
+        @workspace_id = workspace_id
+        @api_key = api_key
+
+        after_initialize!
+      end
+
+      def after_initialize!
+        OrbitActivities::Request.new(
+          api_key: @api_key,
+          workspace_id: @workspace_id,
+          user_agent: "community-ruby-circle-orbit/#{CircleOrbit::VERSION}",
+          action: "new_activity",
+          body: construct_body.to_json
+        )
+      end
+
+      def construct_body
+        {
+          activity: {
+            activity_type: "circle:comment",
+            tags: ["channel:circle"],
+            key: "circle-comment-#{@id}",
+            title: "New comment in the #{@space} Space in Circle",
+            description: construct_description(@post_title, @body),
+            occurred_at: @created_at,
+            link: @url,
+            member: {
+              name: @author,
+              email: @email
+            }
+          },
+          identity: {
+            source: "circle",
+            email: @email
+          }
+        }
+      end
+
+      def construct_description(title, body)
+        return body if title == "" || title.nil?
+
+        <<~HEREDOC
+          ### Comment on Post: *#{title}*
+
+          #{body}
+        HEREDOC
+      end
+
+      private
+
+      def sanitize_body(body)
+        body = ActionView::Base.full_sanitizer.sanitize(body)
+
+        body.gsub("\n", " ")
+      end
+    end
+  end
+end