linkedin_orbit 0.0.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c7abc1c20ae9b7ec569164b0da57a7068bf6d66f127c44c26bf174c173da451
-  data.tar.gz: 3513cc577b03ce3c9001e177f7710056c0dc68514d6ac8ce0d6f6d49322588a9
+  metadata.gz: 8796a2d61f0d7a8b454eb036291eef66e0b7f04ab5c9ffe36c7e4a6662dff34e
+  data.tar.gz: e083b2dc30609e1ee1d5cbf9f6c8e1d5b277e06cbf6f30580385aa64a900230b
 SHA512:
-  metadata.gz: 52de2a258c2d8b11b570287e371076cade3aea564fb3147030649fac73dc6c162c7b0f36fe5a6bda3fe62e8eb6ce6e9b323558a0a7240f3a145b87780a7a8e31
-  data.tar.gz: 737b6bc45c6e848c0886cc51a2245b659f02aee3651a9021b0ca6f1eb8faa64579cabacc90edd594739ac754b91e9e9a4d0dcf817798589de71e4220308fd457
+  metadata.gz: c2ee0f8697cd95f02737396538669b2cfae02851df3da05d44f63d9572c552e7c015ba258bfe57b94668d59d1d1459f42f20526b2b1c44524867d73b7cb3fbee
+  data.tar.gz: acf4c02bcacabc318df46775bb86e61aef4c93e8aacc1ca3eb3965853fbd2bf52eab142b6fb6a823fc632d8177afefdf1c267880fb6f824fe1dbab8a629b303e

data/.env.sample

@@ -1,5 +1,4 @@
 LINKEDIN_ORGANIZATION=
-LINKEDIN_CODE=
 LINKEDIN_TOKEN=
 ORBIT_API_KEY=
 ORBIT_WORKSPACE_ID=

data/Gemfile

@@ -8,4 +8,6 @@ gem "rake", "~> 13.0"
 
 gem "rubocop", "~> 1.7"
 
+gem "orbit_activities"
+
 gem "byebug"

data/Gemfile.lock

@@ -1,10 +1,12 @@
 PATH
   remote: .
   specs:
-    linkedin_orbit (0.0.1)
+    linkedin_orbit (0.1.3)
+      dotenv (~> 2.7)
       http (~> 4.4)
       json (~> 2.5)
       linkedin (~> 1.1)
+      orbit_activities (~> 0.1)
       thor (~> 1.1)
       zeitwerk (~> 2.4)
 
@@ -20,16 +22,21 @@ GEM
     diff-lcs (1.4.4)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    faraday (1.4.1)
+    dotenv (2.7.6)
+    faraday (1.4.2)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
       faraday-net_http (~> 1.0)
       faraday-net_http_persistent (~> 1.1)
       multipart-post (>= 1.2, < 3)
       ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
     faraday-excon (1.1.0)
     faraday-net_http (1.0.1)
     faraday-net_http_persistent (1.1.0)
-    ffi (1.15.0)
+    ffi (1.15.1)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
@@ -60,6 +67,11 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
+    orbit_activities (0.1.0)
+      http (~> 4.4)
+      json (~> 2.5)
+      rake (~> 13.0)
+      zeitwerk (~> 2.4)
     parallel (1.20.1)
     parser (3.0.1.1)
       ast (~> 2.4.1)
@@ -113,6 +125,7 @@ PLATFORMS
 DEPENDENCIES
   byebug
   linkedin_orbit!
+  orbit_activities
   rake (~> 13.0)
   rspec (~> 3.4)
   rubocop (~> 1.7)

data/README.md

@@ -4,7 +4,9 @@
 [![Gem Version](https://badge.fury.io/rb/linkedin_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 app that can be used to integrate LinkedIn post comments into your organization's Orbit workspace.
+Add your LinkedIn interactions into your Orbit workspace with this community-built integration.
+
+![New LinkedIn post comment in Orbit screenshot](readme_images/new-comment-screenshot.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>|
 |-----------------------------------------|
@@ -20,7 +22,7 @@ The application requires the following environment variables:
 
 | Variable | Description | More Info
 |---|---|--|
-| `LINKEDIN_CODE` | LinkedIn Browser Refresh Code | Follow the [First Time Setup guide](docs/FIRST_TIME_INSTRUCTIONS.md) to obtain the code
+| `LINKEDIN_TOKEN` | LinkedIn Token | Follow the [First Time Setup guide](docs/FIRST_TIME_INSTRUCTIONS.md) to obtain the token
 | `LINKEDIN_ORGANIZATION` | LinkedIn Organization Page ID | Format: `urn:li:organization:#{id}`. ID is the set of numbers in LinkedIn page URL, i.e. `https://www.linkedin.com/company/28866695`, the ID is `28866695`.
 | `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`
@@ -43,7 +45,7 @@ You can instantiate a client by either passing in the required credentials durin
 client = LinkedinOrbit::Client.new(
     orbit_api_key: YOUR_API_KEY,
     orbit_workspace_id: YOUR_ORBIT_WORKSPACE_ID,
-    linkedin_code: YOUR_LINKEDIN_BROWSER_REFRESH_CODE,
+    linkedin_token: YOUR_LINKEDIN_TOKEN,
     linkedin_organization: YOUR_LINKEDIN_ORGANIZATION_ID
 )
 ```
@@ -66,7 +68,7 @@ client.comments
 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:
 
 ```bash
-$ ORBIT_API_KEY=... ORBIT_WORKSPACE_ID=... LINKEDIN_CODE=... LINKEDIN_ORGANIZATION=... bundle exec linkedin_orbit --check_comments
+$ ORBIT_API_KEY=... ORBIT_WORKSPACE_ID=... LINKEDIN_TOKEN=... LINKEDIN_ORGANIZATION=... bundle exec linkedin_orbit --check_comments
 ```
 ## GitHub Actions Automation Setup
 

data/docs/FIRST_TIME_INSTRUCTIONS.md

@@ -1,6 +1,6 @@
 # Instructions for First Time Set Up
 
-These instructions will walk you through authenticating to LinkedIn, and receiving your LinkedIn code, which is needed to use this integration. You will only need to do this one time.
+These instructions will walk you through authenticating to LinkedIn, and receiving your LinkedIn token, which is needed to use this integration. You will only need to do this once every two months.
 
 ## Creating a LinkedIn Developers App
 
@@ -45,9 +45,9 @@ You will also see on the "Auth" page a section called "OAuth 2.0 Settings". We w
 
 After you have finished all of the above steps, you are ready to move on to the last step in this first time setup instructions.
 
-## LinkedIn Browser Code
+## LinkedIn Token
 
-LinkedIn uses OAuth 2.0 as its authentication format, and as such, you need to authenticate *one-time* with your browser to obtain a code that will be used for the integration from then on. 
+LinkedIn uses OAuth 2.0 as its authentication format, and as such, you need to authenticate *one time every two months* to obtain a token that will be used for the integration from then on. 
 
 The `linkedin_orbit` integration includes an authentication application to facilitate this process for you. It requires that you have a [Heroku](https://www.heroku.com/) account. It is free to set up a Heroku account, and the one-time authentication app, is fine to run inside the free tier of the platform.
 
@@ -69,24 +69,26 @@ Copy the URL of the Heroku app in your browser address bar and return to the Lin
 
 You will see a link appear called "+ Add redirect URL". Click on that link. In the text box that appears above it enter your Heroku app URL with "/auth/linkedin/callback" appended at the end. For example, if your Heroku URL was "https://example-heroku-app-url.herokuapp.com" then the full address you need to enter would be: "https://example-heroku-app-url.herokuapp.com/auth/linkedin/callback". When you are finished, click on the "Update" button.
 
-Now, return back to your browser window with your Heroku app running. Click on the "LinkedIn" link on the app. Follow the prompts by LinkedIn to authorize your LinkedIn Developer application. When you are finished, you will be redirected back to your Heroku app and you will see a LinkedIn code. This code is very important. The code you see will be the credential used to authenticate to LinkedIn for the duration of your use of the LinkedIn Orbit community integration.
+Now, return back to your browser window with your Heroku app running. Click on the "LinkedIn" link on the app. Follow the prompts by LinkedIn to authorize your LinkedIn Developer application. When you are finished, you will be redirected back to your Heroku app and you will see a LinkedIn token. This token is very important. The token you see will be the credential used to authenticate to LinkedIn.
 
-The last step you need to complete in this first time setup is to add the LinkedIn code you created into the LinkedIn Orbit community integration credentials, either in the context of a standalone app or in the context of running it as a GitHub Action.
+The last step you need to complete in this first time setup is to add the LinkedIn token you created into the LinkedIn Orbit community integration credentials, either in the context of a standalone app or in the context of running it as a GitHub Action.
 
-## Add the LinkedIn Code to the LinkedIn Orbit Community Integration
+## Add the LinkedIn Token to the LinkedIn Orbit Community Integration
 ### Within GitHub Actions
 
 *(This step assumes you have a GitHub repository created already to run the LinkedIn Orbit community integration. If you do not, please follow [this guide](https://docs.github.com/en/github/getting-started-with-github/create-a-repo) first.)*
 
-The LinkedIn code you created in the last step needs to be added to the GitHub repository that you are running the LinkedIn Orbit community integration from. To do so, follow the step-by-step guide in the [README](https://github.com/orbit-love/github-actions-templates/blob/main/README.md#adding-your-credentials-to-github) in the GitHub Actions instructions. The name for this secret **must** be: `LINKEDIN_CODE`.
+The LinkedIn token you created in the last step needs to be added to the GitHub repository that you are running the LinkedIn Orbit community integration from. To do so, follow the step-by-step guide in the [README](https://github.com/orbit-love/github-actions-templates/blob/main/README.md#adding-your-credentials-to-github) in the GitHub Actions instructions. The name for this secret **must** be: `LINKEDIN_TOKEN`.
 
 ### Within a Standalone App
 
-If you are running the community integration as a standalone app, you can add the LinkedIn code as an environment variable inside the `.env` file in the root directory of the codebase.
+If you are running the community integration as a standalone app, you can add the LinkedIn token as an environment variable inside the `.env` file in the root directory of the codebase.
 
-Open up the `.env` file and add a new line starting with `LINKEDIN_CODE=` and add the LinkedIn Code after the equal sign.
+Open up the `.env` file and add a new line starting with `LINKEDIN_TOKEN=` and add the LinkedIn Code after the equal sign.
 ## Wrapping Up
 
-You have now successfully finished the first time setup for your LinkedIn Orbit community integration. This is a one-time process, and you can safely delete the Heroku authentication app you deployed.
+You have now successfully finished the setup for your LinkedIn Orbit community integration. This steps needs to occur once every 60 days.
+
+In between, you can safely delete the Heroku app you created and recreate a new one when you need to do this again.
 
 From within the Heroku dashboard, navigate to the "Settings" for the app and at the very bottom of the page is a button called "Delete app". Once you click on that button, Heroku will confirm you wish to delete the app. Upon confirmation, the app will be deleted and the deployment on the web will be removed.

data/lib/linkedin_orbit.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "zeitwerk"
+require "orbit_activities"
+require_relative "linkedin_orbit/version"
 
 module LinkedinOrbit
   loader = Zeitwerk::Loader.new

data/lib/linkedin_orbit/client.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require "linkedin"
+require "dotenv/load"
+require "net/http"
+require "json"
 
 # Create a client to log LinkedIn interactions in your Orbit workspace
 # Credentials can either be passed in to the instance or be loaded
@@ -15,8 +18,8 @@ require "linkedin"
 # @option params [String] :orbit_workspace
 #   The workspace ID for the Orbit workspace
 #
-# @option params [String] :linkedin_code
-#   The browser refresh token obtained after authenticating with LinkedIn
+# @option params [String] :linkedin_token
+#   The token obtained after authenticating with LinkedIn
 #   Required if value not provided for LINKEDIN_TOKEN environment variable
 #
 # @option params [String] :linkedin_organization
@@ -38,18 +41,12 @@ module LinkedinOrbit
     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"])
-      @linkedin_code = params[:linkedin_code] || ENV['LINKEDIN_CODE'] || nil
       @linkedin_token = token
       @linkedin_organization = params.fetch(:linkedin_organization, ENV["LINKEDIN_ORGANIZATION"])
     end
 
     def token
-      @token ||= begin
-        return ENV["LINKEDIN_TOKEN"] if ENV["LINKEDIN_TOKEN"]
-
-        linkedin = LinkedIn::Client.new(@linkedin_client_id, @linkedin_client_secret)
-        linkedin.authorize_from_access(ENV["LINKEDIN_CODE"])
-      end
+      @token ||= ENV["LINKEDIN_TOKEN"]
     end
 
     def comments

data/lib/linkedin_orbit/interactions/comment.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "net/http"
 require "json"
 
 module LinkedinOrbit
@@ -16,31 +15,25 @@ module LinkedinOrbit
       end
 
       def after_initialize!
-        url = URI("https://app.orbit.love/api/v1/#{@orbit_workspace}/activities")
-
-        http = Net::HTTP.new(url.host, url.port)
-        http.use_ssl = true
-
-        request = Net::HTTP::Post.new(url)
-        request["Accept"] = "application/json"
-        request["Content-Type"] = "application/json"
-        request["Authorization"] = "Bearer #{@orbit_api_key}"
-
-        request.body = construct_body.to_json
-
-        response = http.request(request)
-
-        JSON.parse(response.body)
+        OrbitActivities::Request.new(
+          api_key: @orbit_api_key,
+          workspace_id: @orbit_workspace,
+          user_agent: "community-ruby-linkedin-orbit/#{LinkedinOrbit::VERSION}",
+          action: "new_activity",
+          body: construct_body.to_json
+        )
       end
 
       def construct_body
         {
           activity: {
             activity_type: "linkedin:comment",
+            tags: ["channel:linkedin"],
             title: "Commented on LinkedIn Post",
             description: construct_description,
             occurred_at: Time.at(@comment["created"]["time"] / 1000).utc,
             key: @comment["id"],
+            link: "https://www.linkedin.com/feed/update/#{@comment["object"]}",
             member: {
               name: name
             }

data/lib/linkedin_orbit/linkedin.rb

@@ -12,6 +12,8 @@ module LinkedinOrbit
     def process_comments
       posts = get_posts
 
+      return posts unless posts.is_a?(Array)
+
       posts.each do |post|
         comments = get_post_comments(post["id"])
 
@@ -48,6 +50,15 @@ module LinkedinOrbit
 
       response = JSON.parse(response.body)
 
+      return response["message"] if response["serviceErrorCode"]
+
+      if response["elements"].nil? || response["elements"].empty?
+        return <<~HEREDOC
+          No new posts to process from your LinkedIn organization.
+          If you suspect this is incorrect, verify your LinkedIn organization schema is correct in your credentials.
+        HEREDOC
+      end
+
       response["elements"].each do |element|
         posts << {
           "id" => element["activity"],

data/lib/linkedin_orbit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LinkedinOrbit
-    VERSION = "0.0.2"
+    VERSION = "0.1.4"
   end

data/linkedin_orbit.gemspec

@@ -31,6 +31,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "zeitwerk", "~> 2.4"
   spec.add_dependency "thor", "~> 1.1"
   spec.add_dependency "linkedin", "~> 1.1"
+  spec.add_dependency "dotenv", "~> 2.7"
+  spec.add_dependency "orbit_activities", "~> 0.1"
   spec.add_development_dependency "rspec", "~> 3.4"
   spec.add_development_dependency "webmock", "~> 3.12"
 end

data/scripts/check_comments.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "dev_orbit"
+require "linkedin_orbit"
 require "thor"
 
 module LinkedinOrbit

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: linkedin_orbit
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Orbit DevRel
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-10 00:00:00.000000000 Z
+date: 2021-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -81,6 +81,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: orbit_activities
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -143,6 +171,7 @@ files:
 - readme_images/linkedin_oauth_redirects.png
 - readme_images/logo.png
 - readme_images/marketing_platform_request_access.png
+- readme_images/new-comment-screenshot.png
 - readme_images/products_list.png
 - readme_images/ways-to-use.png
 - scripts/check_comments.rb