orbit_activities 0.1.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc19e521a7103168771b57342dabb7bceffb4a051a52458102cd2c159d8e1ba4
-  data.tar.gz: f1dccee34992a1c77528bd1d83a07aee16c728f9341a57f134d7d981e8ab52bc
+  metadata.gz: f1a41acb3a0bbbe16e86bf6b1c0d369207120f15085fb178015733f6cba8b353
+  data.tar.gz: d68d8d88b2d610b6f1b3e780ef52aa05381adbf087472479b10f87dad099c133
 SHA512:
-  metadata.gz: 80a6d164b1352cc746168545e1d3a6c4f55097da810ec867e6540c455edfdacfa4dce9dc2843c52ae7b37a32b79a72f3c9f143d1031835f1cfe11ca35d468540
-  data.tar.gz: 3e0f3ccba92e0fc6d404bb46f1a72f1c3177b5f9609adf465b5388adcf5ea0877c883a430efbd392eb93fab442d91205b10fb50b38e91df5cd30c06716ed2ad1
+  metadata.gz: 8f8b24a3552058ccd69b4d74ca073231b81803a50e742cd55c2bcded567169653031cf9f456ee2365791b63643d10ac64348516184182097164e89120a31d6d4
+  data.tar.gz: f04486582e0457c0f636a27224e9fbfe061a6748203bf07522ea9d0ff8a03813dbb59fe382b0ea21173becb4b43fea8072e8935436be4b4390e2900b786d3cf0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    orbit_activities (0.0.2)
+    orbit_activities (0.2.2)
       http (~> 4.4)
       json (~> 2.5)
       rake (~> 13.0)
@@ -10,7 +10,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
     byebug (11.1.3)
@@ -19,7 +19,7 @@ GEM
     diff-lcs (1.4.4)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    ffi (1.15.0)
+    ffi (1.15.3)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
@@ -29,7 +29,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)
@@ -56,23 +56,23 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.14.0)
+    rubocop (1.17.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.5.0)
+    rubocop-ast (1.7.0)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.7)
     unicode-display_width (2.0.0)
-    webmock (3.12.2)
+    webmock (3.13.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -80,6 +80,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   byebug

data/README.md

@@ -1,12 +1,12 @@
-# Orbit API Create Custom Activities Helper
+# Orbit Activities Helper Library for Ruby
 
 ![Build Status](https://github.com/orbit-love/ruby-orbit-activities/workflows/CI/badge.svg)
 [![Gem Version](https://badge.fury.io/rb/orbit_activities.svg)](https://badge.fury.io/rb/orbit_activities)
 [![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 included in any Ruby application to take care of the logic of interacting with the Orbit API to create custom activities.
+> Orbit API helper library for Ruby. <br>This client can create, read, update and delete activities in your Orbit workspace.
 
-<hr />
+<img src="https://github.com/orbit-love/js-orbit-activities/blob/bc4ce38a34af95e40b2c3e54ba44d3df6b3d3aac/.github/logo.png" alt="Orbit" style="max-width: 300px; margin: 2em 0;">
 
 ## Package Usage
 
@@ -20,19 +20,105 @@ gem "orbit_activities"
 
 Then, run `bundle install` from your terminal.
 
-### Send Custom Activity
+### Usage
 
-To send a custom activity to Orbit using the gem, instantiate a new instance of the `Request` class:
+#### Create an Activity
+
+To create an activity:
+
+```ruby
+OrbitActivities::Request.new(
+    api_key: # Your Orbit API key,
+    workspace_id: # Your Orbit workspace ID,
+    action: "new_activity",
+    body: # The custom activity object in JSON format, see Orbit API docs for reference
+)
+```
+
+You can inspect the Orbit API response by appending `.response` to the end of the initialization method.
+#### Update an Activity
+
+To update an activity:
+
+```ruby
+OrbitActivities::Request.new(
+    api_key: # Your Orbit API key,
+    workspace_id: # Your Orbit workspace ID,
+    action: "update_activity",
+    activity_id: # The ID of the activity to be updated,
+    member_id: # The ID of the member the activity is attached to,
+    body: # The custom activity object in JSON format, see Orbit API docs for reference
+)
+```
+
+You can inspect the Orbit API response by appending `.response` to the end of the initialization method.
+#### Delete an Activity
+
+To delete an activity:
 
 ```ruby
 OrbitActivities::Request.new(
     api_key: # Your Orbit API key,
     workspace_id: # Your Orbit workspace ID,
-    body: # The custom activity object in JSON format
+    action: "delete_activity",
+    activity_id: # The ID of the activity to be updated,
+    member_id: # The ID of the member the activity is attached to
 )
 ```
 
-For details on the data structure the Orbit API expects for a custom activity object, refer to the [Orbit API Documentation](https://docs.orbit.love/reference#post_-workspace-id-activities).
+You can inspect the Orbit API response by appending `.response` to the end of the initialization method.
+#### List Activities
+
+To list activities:
+
+```ruby
+OrbitActivities::Request.new(
+    api_key: # Your Orbit API key,
+    workspace_id: # Your Orbit workspace ID,
+    action: "list_activities",
+    filters: # Any filters on the request in JSON format, see Orbit API docs for reference
+).response
+```
+#### Get Specific Activity
+
+To get a specific activity:
+
+```ruby
+OrbitActivities::Request.new(
+    api_key: # Your Orbit API key,
+    workspace_id: # Your Orbit workspace ID,
+    action: "get_activity",
+    activity_id: # The ID of the actiivity
+).response
+```
+#### Get Member Activities
+
+To get activities associated with a specific member:
+
+```ruby
+OrbitActivities::Request.new(
+    api_key: # Your Orbit API key,
+    workspace_id: # Your Orbit workspace ID,
+    action: "list_member_activities",
+    activity_id: # The ID of the actiivity,
+    member_id: # The ID of the member,
+    filters: # Any filters on the request in JSON format, see Orbit API docs for reference
+).response
+```
+#### Get Latest Activity Timestamp for Activity Type
+
+To get the latest activity timestamp for a specific activity type:
+
+```ruby
+OrbitActivities::Request.new(
+    api_key: # Your Orbit API key,
+    workspace_id: # Your Orbit workspace ID,
+    action: "latest_activity_timestamp",
+    filters: { activity_type: # Activity type to search for, e.g. "custom:linkedin:comment" }
+).response
+```
+
+For details on the data structures the Orbit API expects, refer to the [Orbit API Documentation](https://docs.orbit.love/reference).
 
 ## Contributing
 
@@ -44,4 +130,4 @@ This is available as open source under the terms of the [MIT License](LICENSE).
 
 ## Code of Conduct
 
-This project uses the [Contributor Code of Conduct](CODE_OF_CONDUCT.md). We ask everyone to please adhere by its guidelines.
+This project uses the [Contributor Code of Conduct](CODE_OF_CONDUCT.md). We ask everyone to please adhere by its guidelines.

data/lib/orbit_activities.rb

@@ -6,6 +6,9 @@ require_relative "orbit_activities/version"
 module OrbitActivities
   loader = Zeitwerk::Loader.new
   loader.tag = File.basename(__FILE__, ".rb")
+  loader.inflector.inflect({
+    'Http' => 'HTTP'
+  })
   loader.push_dir(__dir__)
   loader.setup
 end

data/lib/orbit_activities/http.rb

@@ -21,6 +21,12 @@ module OrbitActivities
 
       response = http.request(req)
 
+      if response.class == Net::HTTPTooManyRequests
+        puts "Reached rate limitation in API, retrying in 60 seconds..."
+        sleep(60)
+        response = http.request(req)
+      end
+
       validate_payload(response.body)
     end
 

data/lib/orbit_activities/request.rb

@@ -5,6 +5,7 @@ require_relative "http"
 module OrbitActivities
   class Request
     attr_reader :api_key, :workspace_id, :user_agent, :action, :body, :filters, :member_id, :activity_id
+    attr_accessor :response
 
     def initialize(params = {})
       @action = params.fetch(:action)
@@ -15,6 +16,7 @@ module OrbitActivities
       @filters = params.fetch(:filters, nil)
       @member_id = params.fetch(:member_id, nil)
       @activity_id = params.fetch(:activity_id, nil)
+      @response = nil
 
       after_initialize!
     end
@@ -35,6 +37,8 @@ module OrbitActivities
         delete_post
       when "update_activity"
         update_activity
+      when "latest_activity_timestamp"
+        latest_activity_timestamp
       else
         raise ArgumentError,
               "Activity type is unrecognized. Must be one of: new_activity, list_activities, get_activity, list_member_activities, create_post, delete_post, update_activity"
@@ -42,7 +46,7 @@ module OrbitActivities
     end
 
     def new_activity
-      OrbitActivities::HTTP.post(
+      @response = OrbitActivities::HTTP.post(
         url: "https://app.orbit.love/api/v1/#{@workspace_id}/activities",
         user_agent: @user_agent,
         api_key: @api_key,
@@ -51,7 +55,7 @@ module OrbitActivities
     end
 
     def list_activities
-      OrbitActivities::HTTP.get(
+      @response = OrbitActivities::HTTP.get(
         url: "https://app.orbit.love/api/v1/#{@workspace_id}/activities",
         user_agent: @user_agent,
         api_key: @api_key,
@@ -59,8 +63,27 @@ module OrbitActivities
       )
     end
 
+    def latest_activity_timestamp
+      filters = {
+        items: 10,
+        direction: "DESC"
+      }
+      filters.merge!(@filters)
+
+      response = OrbitActivities::HTTP.get(
+        url: "https://app.orbit.love/api/v1/#{@workspace_id}/activities",
+        user_agent: @user_agent,
+        api_key: @api_key,
+        filters: filters
+      )
+
+      return nil if response["data"].nil? || response["data"].empty?
+
+      @response = response["data"][0]["attributes"]["created_at"]
+    end
+
     def get_activity
-      OrbitActivities::HTTP.get(
+      @response = OrbitActivities::HTTP.get(
         url: "https://app.orbit.love/api/v1/#{@workspace_id}/activities/#{@activity_id}",
         user_agent: @user_agent,
         api_key: @api_key
@@ -68,7 +91,7 @@ module OrbitActivities
     end
 
     def list_member_activities
-      OrbitActivities::HTTP.get(
+      @response = OrbitActivities::HTTP.get(
         url: "https://app.orbit.love/api/v1/#{@workspace_id}/members/#{@member_id}/activities",
         user_agent: @user_agent,
         api_key: @api_key,
@@ -77,7 +100,7 @@ module OrbitActivities
     end
 
     def create_post
-      OrbitActivities::HTTP.post(
+      @response = OrbitActivities::HTTP.post(
         url: "https://app.orbit.love/api/v1/#{@workspace_id}/members/#{@member_id}/activities",
         user_agent: @user_agent,
         api_key: @api_key,
@@ -86,7 +109,7 @@ module OrbitActivities
     end
 
     def delete_post
-      OrbitActivities::HTTP.delete(
+      @response = OrbitActivities::HTTP.delete(
         url: "https://app.orbit.love/api/v1/#{@workspace_id}/members/#{@member_id}/activities/#{@activity_id}",
         user_agent: @user_agent,
         api_key: @api_key
@@ -94,7 +117,7 @@ module OrbitActivities
     end
 
     def update_activity
-      OrbitActivities::HTTP.put(
+      @response = OrbitActivities::HTTP.put(
         url: "https://app.orbit.love/api/v1/#{@workspace_id}/members/#{@member_id}/activities/#{@activity_id}",
         user_agent: @user_agent,
         api_key: @api_key,

data/lib/orbit_activities/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OrbitActivities
-  VERSION = "0.1.0"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orbit_activities
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Orbit DevRel
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-24 00:00:00.000000000 Z
+date: 2021-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http