orbit_activities 0.0.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c26b382df27b22b7e81b7bea5245cf76057a6be007bade8477144edb19e21347
-  data.tar.gz: a84f1efce2cc24565e5c7ed7b4f6aa18ee155ac483d1a8c05759df6c848fbddc
+  metadata.gz: f6d4b2a947aca843ad8d235f4aa45ec085ce630da23038b61158d814330c1eed
+  data.tar.gz: c55ab525549e1434fc11d655ba97bb9dbbcadca871233bb37fa6553d0a48b079
 SHA512:
-  metadata.gz: af88365fa3a0d1ca59d0b1f54cb9204f9be397fe06394b4140f700e3b24ecc3711674cb8f4494e6bd2655dc92b6724b56e311bd577b295e64e30d40e0fb949e3
-  data.tar.gz: 6cd5d2bfc5d0d8eaca37c4c0af8082e0008316d6fc5e67f1712274c998e13673105d07b8b0539a70af3b3955cf9b53ffb9e70bcd0ad0892ec55d4d765ac319ab
+  metadata.gz: c393d3604e519836588ddfdde415e3cf8663bf0b16c39de0fd703a634404d9acd06e7d5658e09e6bb454805feb63668916d364ebf0fd3bed86312b562c7087ab
+  data.tar.gz: 9f568b3ebc2b794a516066f78d1edda8501df96b2760cc109d1853f991b17e9500188418d4c0ba6e69c58b337bec54c9ce14c894c640d9eb70278713e8b84f30

data/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: [2.7, 3.0]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -1,2 +1,3 @@
 .byebug_history
-.env
+.env
+*.gem

data/.rubocop.yml

@@ -0,0 +1,30 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  Exclude:
+    - 'spec/**/*'
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    orbit_activities (0.0.1)
+    orbit_activities (0.2.2)
       http (~> 4.4)
       json (~> 2.5)
       rake (~> 13.0)
@@ -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)

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-create-activities/workflows/CI/badge.svg)
+![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
+    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

@@ -8,4 +8,4 @@ module OrbitActivities
   loader.tag = File.basename(__FILE__, ".rb")
   loader.push_dir(__dir__)
   loader.setup
-end
+end

data/lib/orbit_activities/http.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require_relative "utils"
+
+module OrbitActivities
+  class HTTP
+    def self.post(url:, user_agent:, api_key:, body:)
+      url = URI(url)
+
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+      req = Net::HTTP::Post.new(url)
+      req["Accept"] = "application/json"
+      req["Content-Type"] = "application/json"
+      req["Authorization"] = "Bearer #{api_key}"
+      req["User-Agent"] = user_agent
+
+      req.body = body
+
+      response = http.request(req)
+
+      validate_payload(response.body)
+    end
+
+    def self.get(url:, user_agent:, api_key:, filters: nil)
+      url = URI(url)
+      url.query = URI.encode_www_form(filters) if filters
+
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+      req = Net::HTTP::Get.new(url)
+      req["Accept"] = "application/json"
+      req["Authorization"] = "Bearer #{api_key}"
+      req["User-Agent"] = user_agent
+
+      response = http.request(req)
+
+      validate_payload(response.body)
+    end
+
+    def self.delete(url:, user_agent:, api_key:)
+      url = URI(url)
+
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+
+      req = Net::HTTP::Delete.new(url)
+      req["Authorization"] = "Bearer #{api_key}"
+      req["User-Agent"] = user_agent
+
+      response = http.request(req)
+
+      return "Deletion successful" if response.code == "204" || response.code == "200"
+
+      raise ArgumentError, response.message if response.code != "204" || response.code != "200"
+    end
+
+    def self.put(url:, user_agent:, api_key:, body:)
+      url = URI(url)
+
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+      req = Net::HTTP::Put.new(url)
+      req["Accept"] = "application/json"
+      req["Content-Type"] = "application/json"
+      req["Authorization"] = "Bearer #{api_key}"
+      req["User-Agent"] = user_agent
+
+      req.body = body
+
+      response = http.request(req)
+
+      return "Update successful" if response.code == "204" || response.code == "200"
+
+      raise ArgumentError, response.message if response.code != "204" || response.code != "200"
+    end
+
+    def self.validate_payload(payload)
+      JSON.parse(payload) if OrbitActivities::Utils.valid_json?(payload)
+    end
+  end
+end

data/lib/orbit_activities/request.rb

@@ -1,53 +1,128 @@
 # frozen_string_literal: true
 
-require "net/http"
-require "json"
-require_relative "utils"
+require_relative "http"
 
 module OrbitActivities
-    class Request
-        attr_reader :api_key, :workspace_id, :user_agent, :body
+  class Request
+    attr_reader :api_key, :workspace_id, :user_agent, :action, :body, :filters, :member_id, :activity_id
+    attr_accessor :response
 
-        def initialize(params = {})
-            @api_key = params.fetch(:api_key)
-            @workspace_id = params.fetch(:workspace_id)
-            @user_agent = params.fetch(:user_agent, "ruby-orbit-activities/#{OrbitActivities::VERSION}")
-            @body = params.fetch(:body)
+    def initialize(params = {})
+      @action = params.fetch(:action)
+      @api_key = params.fetch(:api_key)
+      @workspace_id = params.fetch(:workspace_id)
+      @user_agent = params.fetch(:user_agent, "ruby-orbit-activities/#{OrbitActivities::VERSION}")
+      @body = params.fetch(:body, nil)
+      @filters = params.fetch(:filters, nil)
+      @member_id = params.fetch(:member_id, nil)
+      @activity_id = params.fetch(:activity_id, nil)
+      @response = nil
 
-            after_initialize!
-        end
+      after_initialize!
+    end
+
+    def after_initialize!
+      case @action
+      when "new_activity"
+        new_activity
+      when "list_activities"
+        list_activities
+      when "get_activity"
+        get_activity
+      when "list_member_activities"
+        list_member_activities
+      when "create_post"
+        create_post
+      when "delete_post"
+        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"
+      end
+    end
+
+    def new_activity
+      @response = OrbitActivities::HTTP.post(
+        url: "https://app.orbit.love/api/v1/#{@workspace_id}/activities",
+        user_agent: @user_agent,
+        api_key: @api_key,
+        body: @body
+      )
+    end
+
+    def list_activities
+      @response = OrbitActivities::HTTP.get(
+        url: "https://app.orbit.love/api/v1/#{@workspace_id}/activities",
+        user_agent: @user_agent,
+        api_key: @api_key,
+        filters: @filters
+      )
+    end
 
-        def after_initialize!
-            call
-        end
+    def latest_activity_timestamp
+      filters = {
+        items: 10,
+        direction: "DESC"
+      }
+      filters.merge!(@filters)
 
-        def call
-            payload = make_request
-            validate_payload(payload)
-        end
+      response = OrbitActivities::HTTP.get(
+        url: "https://app.orbit.love/api/v1/#{@workspace_id}/activities",
+        user_agent: @user_agent,
+        api_key: @api_key,
+        filters: filters
+      )
 
-        def make_request
-            url = URI("https://app.orbit.love/api/v1/#{@workspace_id}/activities")
+      return nil if response["data"].nil? || response["data"].empty?
 
-            http = Net::HTTP.new(url.host, url.port)
-            http.use_ssl = true
-            req = Net::HTTP::Post.new(url)
-            req["Accept"] = "application/json"
-            req["Content-Type"] = "application/json"
-            req["Authorization"] = "Bearer #{@api_key}"
-            req["User-Agent"] = @user_agent
+      @response = response["data"][0]["attributes"]["created_at"]
+    end
 
-            req.body = @body
+    def get_activity
+      @response = OrbitActivities::HTTP.get(
+        url: "https://app.orbit.love/api/v1/#{@workspace_id}/activities/#{@activity_id}",
+        user_agent: @user_agent,
+        api_key: @api_key
+      )
+    end
 
-            req.body = @body.to_json
+    def list_member_activities
+      @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,
+        filters: @filters
+      )
+    end
 
-            response = http.request(req)
+    def create_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,
+        body: @body
+      )
+    end
 
-            response.body
-        end
+    def delete_post
+      @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
+      )
+    end
 
-        def validate_payload(payload)
-            JSON.parse(payload) if OrbitActivities::Utils.valid_json?(payload)
-        end
+    def update_activity
+      @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,
+        body: @body
+      )
     end
-end
+  end
+end

data/lib/orbit_activities/utils.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 module OrbitActivities
-    class Utils
-      def self.valid_json?(string)
-        !JSON.parse(string).nil?
-      rescue JSON::ParserError
-        raise ArgumentError, "Expected confirmation from the Orbit API, but received nothing. Please check your logs and try again."
-      end
+  class Utils
+    def self.valid_json?(string)
+      !JSON.parse(string).nil?
+    rescue JSON::ParserError
+      raise ArgumentError,
+            "Expected confirmation from the Orbit API, but received nothing. Please check your logs and try again."
     end
-  end
+  end
+end

data/lib/orbit_activities/version.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
 module OrbitActivities
-    VERSION = "0.0.1"
-  end
-  
+  VERSION = "0.2.2"
+end

data/orbit_activities.gemspec

@@ -28,10 +28,10 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "http", "~> 4.4"
   spec.add_dependency "json", "~> 2.5"
-  spec.add_dependency "zeitwerk", "~> 2.4"
   spec.add_dependency "rake", "~> 13.0"
+  spec.add_dependency "zeitwerk", "~> 2.4"
+  spec.add_development_dependency "byebug"
   spec.add_development_dependency "rspec", "~> 3.4"
-  spec.add_development_dependency "webmock", "~> 3.12"
   spec.add_development_dependency "rubocop", "~> 1.7"
-  spec.add_development_dependency "byebug"
-end
+  spec.add_development_dependency "webmock", "~> 3.12"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orbit_activities
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Orbit DevRel
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-13 00:00:00.000000000 Z
+date: 2021-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -40,61 +40,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.5'
 - !ruby/object:Gem::Dependency
-  name: zeitwerk
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '13.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -110,19 +110,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.12'
 description: This gem helps you build custom activities for Orbit workspaces using
   the Orbit API
 email:
@@ -133,7 +133,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
@@ -143,6 +145,7 @@ files:
 - bin/console
 - bin/setup
 - lib/orbit_activities.rb
+- lib/orbit_activities/http.rb
 - lib/orbit_activities/request.rb
 - lib/orbit_activities/utils.rb
 - lib/orbit_activities/version.rb