chronicle-zulip 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 27ed02b087bd99b0db8a702d8140add3dba7cdc9df1b3fea0cb2825b49051642
+  data.tar.gz: 01a4efcbf6ccc39ed9d21672684c32c71b37759b32fbaf553097b21edf4a4ce5
+SHA512:
+  metadata.gz: 2c706f57da0de15bce5c20430edeebc9b358c55e0e5d060ebe770f91e70e40dfba3ff08edc419e704ba7901d8bae1cf65e5f16ebe033c57d680c6c8400f65b47
+  data.tar.gz: b02063a99a83b93e93f44926d44cd16d17e8125ac250a5300b8a3874d3eadd656e2ef9d7d91a01db5c44aee8129b1dcfe5dbdbdbcb61c6f325375b1f8e4d1730

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status
+.DS_Store

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at andrew@hyfen.net. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in chronicle-zulip.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/README.md

@@ -0,0 +1,43 @@
+# Chronicle::Zulip
+[![Gem Version](https://badge.fury.io/rb/chronicle-zulip.svg)](https://badge.fury.io/rb/chronicle-zulip)
+
+Extract your Zulip messages using the command line with this plugin for [chronicle-etl](https://github.com/chronicle-app/chronicle-etl).
+
+## Usage
+
+```sh
+# Install chronicle-etl and this plugin
+$ gem install chronicle-etl
+$ chronicle-etl plugins:install zulip
+```
+
+You can get a personal access token by going to Settings -> Account & Privacy and pressing the "Show/change your API key".
+
+```sh
+# Save username, access_token, and realm
+$ chronicle-etl secrets:set zulip username foo@gmail.com
+$ chronicle-etl secrets:set zulip access_token ACCESS_TOKEN
+$ chronicle-etl secrets:set zulip realm foo
+
+# Then, retrieve your private messages
+$ chronicle-etl --extractor zulip:private-messages --loader json
+```
+
+## Available Connectors
+### Extractors
+
+#### `private-message`
+
+Extractor for importing private messages from Zulip
+
+##### Settings
+
+- `username`: The email address associated with your Zulip account
+- `access_token`: Your personal access token
+- `realm`: ____.zulipchat.com
+
+### Transformers
+
+#### `message`
+
+Transform a Zulip message into Chronicle Schema

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "chronicle/zulip"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/chronicle-zulip.gemspec

@@ -0,0 +1,45 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "chronicle/zulip/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "chronicle-zulip"
+  spec.version       = Chronicle::Zulip::VERSION
+  spec.authors       = ["Andrew Louis"]
+  spec.email         = ["andrew@hyfen.net"]
+
+  spec.summary       = "Zulip importer for Chronicle"
+  spec.description   = "Zulip importer for chronicle-etl"
+  spec.homepage      = "https://github.com/chronicle-app/chronicle-zulip"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/chronicle-app/chronicle-zulip"
+    spec.metadata["changelog_uri"] = "https://github.com/chronicle-app/chronicle-zulip"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "chronicle-etl", "~> 0.5.3"
+  spec.add_dependency "faraday", "~> 2.2"
+
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.9"
+end

data/lib/chronicle/zulip/message_transformer.rb

@@ -0,0 +1,102 @@
+require 'chronicle/etl'
+
+module Chronicle
+  module Zulip
+    class MessageTransformer < Chronicle::ETL::Transformer
+      register_connector do |r|
+        r.description = 'a zulip message'
+        r.provider = 'zulip'
+        r.identifier = 'message'
+      end
+
+      def transform
+        build_messaged
+      end
+
+      def id
+        message[:id]
+      end
+
+      def timestamp
+        Time.at(message[:timestamp])
+      end
+
+      private 
+
+      def message
+        @message ||= @extraction.data
+      end
+
+      def participants
+        @participants ||= begin
+          message[:display_recipient].map do |recipient|
+            build_user(
+              id: recipient[:id],
+              email: recipient[:email],
+              full_name: recipient[:full_name],
+              realm: message[:sender_realm_str]
+            )
+          end
+        end
+      end
+
+      def build_messaged
+        record = ::Chronicle::ETL::Models::Activity.new
+        record.verb = 'messaged'
+        record.provider = 'zulip'
+        record.provider_id = id
+        record.provider_namespace = message[:sender_realm_str]
+        record.end_at = timestamp
+
+        record.dedupe_on << [:verb, :provider, :provider_id]
+
+        record.actor = build_actor
+        record.involved = build_message
+        record
+      end
+
+      def build_actor
+        participants.find { |participant| participant.provider_id == message[:sender_id]}
+      end
+
+      def build_user(id:, email:, full_name:, realm:)
+        record = ::Chronicle::ETL::Models::Entity.new
+        record.represents = 'identity'
+        record.provider = 'zulip'
+        record.provider_id = id
+        record.provider_namespace = realm
+        record.title = full_name
+
+        record.analogous = [ build_email_identity(email) ]
+
+        record.dedupe_on << [:represents, :provider, :provider_id, :provider_namespace]
+
+        record
+      end
+
+      def build_email_identity(email)
+        record = ::Chronicle::ETL::Models::Entity.new
+        record.represents = 'identity'
+        record.provider = 'email'
+        record.slug = email
+        record.dedupe_on << [:represents, :provider, :slug]
+        record
+      end
+
+      def build_message
+        record = ::Chronicle::ETL::Models::Entity.new
+        record.represents = 'message'
+        record.provider = 'zulip'
+        record.provider_id = id
+        record.provider_namespace = message[:sender_realm_str]
+        record.body = message[:content]
+
+        record.consumers = participants.select { |participant| participant.provider_id != message[:sender_id] }
+
+        record.dedupe_on << [:represents, :provider, :provider_id]
+
+        record
+      end
+    end
+  end
+end

data/lib/chronicle/zulip/private_message_extractor.rb

@@ -0,0 +1,27 @@
+require 'chronicle/etl'
+require 'faraday'
+module Chronicle
+  module Zulip
+    class PrivateMessageExtractor < Chronicle::ETL::Extractor
+      register_connector do |r|
+        r.provider = 'zulip'
+        r.description = 'zulip direct messages'
+        r.identifier = 'private-message'
+      end
+
+      setting :access_token, required: true
+      setting :username, required: true
+      setting :realm, required: true
+
+      def prepare
+        @proxy = Chronicle::Zulip::Proxy.new(username: @config.username, realm: @config.realm, access_token: @config.access_token)
+      end
+
+      def extract
+        @proxy.all_private_messages do |message|
+          yield Chronicle::ETL::Extraction.new(data: message)
+        end
+      end
+    end
+  end
+end

data/lib/chronicle/zulip/proxy.rb

@@ -0,0 +1,61 @@
+require 'faraday'
+
+module Chronicle
+  module Zulip
+    class Proxy
+      def initialize(username:, access_token:, realm:)
+        @username = username
+        @access_token = access_token 
+        @realm = realm
+      end
+
+      def all_private_messages(anchor: 'oldest')
+        narrow = '[{"negated":false,"operator":"is","operand":"private"}]'
+        has_more = true
+
+        while has_more
+          response = load_messages(anchor: anchor, narrow: narrow)
+          messages = response[:messages] || []
+
+          messages.each do |message|
+            yield message
+          end
+
+          has_more = !response[:found_newest]
+          anchor = messages.map { |message| message[:id] }.max
+        end
+      end
+
+      def load_messages(anchor:, narrow:)
+        params = {
+          narrow: narrow,
+          num_after: '50',
+          num_before: '0',
+          anchor: anchor,
+          apply_markdown: 'false'
+        }
+
+        make_request(endpoint: 'messages', params: params)
+      end
+
+      def make_request(endpoint:, params: {})
+        conn = Faraday.new(
+          url: zulip_subdomain,
+          params: params
+        ) do |conn|
+          conn.use Faraday::Response::RaiseError
+          conn.request :authorization, :basic, @username, @access_token
+        end
+
+        response = conn.get("api/v1/#{endpoint}")
+        JSON.parse(response.body, { symbolize_names: true })
+      end
+
+      private
+
+      def zulip_subdomain
+        "https://#{@realm}.zulipchat.com"
+      end
+    end
+  end
+end

data/lib/chronicle/zulip/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Chronicle
+  module Zulip
+    VERSION = "0.1.1"
+  end
+end

data/lib/chronicle/zulip.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "zulip/version"
+require_relative "zulip/proxy"
+require_relative "zulip/private_message_extractor"
+require_relative "zulip/message_transformer"
+
+module Chronicle
+  module Zulip
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: chronicle-zulip
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Andrew Louis
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chronicle-etl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: Zulip importer for chronicle-etl
+email:
+- andrew@hyfen.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chronicle-zulip.gemspec
+- lib/chronicle/zulip.rb
+- lib/chronicle/zulip/message_transformer.rb
+- lib/chronicle/zulip/private_message_extractor.rb
+- lib/chronicle/zulip/proxy.rb
+- lib/chronicle/zulip/version.rb
+homepage: https://github.com/chronicle-app/chronicle-zulip
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/chronicle-app/chronicle-zulip
+  source_code_uri: https://github.com/chronicle-app/chronicle-zulip
+  changelog_uri: https://github.com/chronicle-app/chronicle-zulip
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Zulip importer for Chronicle
+test_files: []