keybase-unofficial 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c65d684f169a40ef888365599b327bc4fc33b087
-  data.tar.gz: c621a15ee3e4af35db7ace294a3378452d947f6c
+  metadata.gz: 2edd9a6909fd527cc22f65bc1a4f3ba918179e80
+  data.tar.gz: d847cc38999955a7eb438b17a966f9e0b6f38b4b
 SHA512:
-  metadata.gz: d0cbd85b2bf544a9374ef59c5840fb7a080a7c900d171a831b94b9308dfd3b031a5aa0888df4ac0af665f20f015e2a3f2439c737c4b18318646d8958c6792027
-  data.tar.gz: cd3c1cc0857fc82059d5672347d76af3aecca6881bd2c6de0a3052da809bf45922b04417eacf67e60cd0cf0e12093f2c22160f170eb0de2554d82111e22ba2e4
+  metadata.gz: 94b656684f60c93c94e8ed1453c37231e3df3c3caf4c7a1314b32e0c4c133f0fe21033936c83fa1b59f9e3be18da3a1c8c0ad151764381dae027502eab9f616a
+  data.tar.gz: 00553731d8f691ab623328c2142f853c7c0162c498b6a6bb4ed27b2dd4c9532debb5f0795676658b5aa883e8c0bb5fbf89a11ee64224cfd513ca1cde7ecadef7

data/lib/keybase.rb

@@ -1,13 +1,15 @@
 require_relative "keybase/exceptions"
 require_relative "keybase/configuration"
+require_relative "keybase/u"
 require_relative "keybase/local_user"
 require_relative "keybase/kbfs"
 require_relative "keybase/api"
+require_relative "keybase/chat"
 
 # The primary namespace for keybase-unofficial.
 module Keybase
   # keybase-unofficial's current version
-  VERSION = "0.0.5".freeze
+  VERSION = "0.0.6".freeze
 
   extend Configuration
 end

data/lib/keybase/api.rb

@@ -23,7 +23,7 @@ module Keybase
       # @see https://keybase.io/docs/api/1.0/call/user/lookup
       def lookup(**query)
         if query[:usernames]
-          query[:usernames] = query[:usernames].join(",")
+          query[:usernames] = U[query[:usernames]]
         end
 
         response = Faraday.get "#{BASE_URL}/user/lookup.json", query

data/lib/keybase/chat.rb

@@ -0,0 +1,182 @@
+require "open3"
+require "json"
+require "ostruct"
+
+module Keybase
+  # Represents Keybase's JSON chat API.
+  class Chat
+    # The initial arguments to pass when executing Keybase for chatting.
+    CHAT_EXEC_ARGS = ["keybase", "chat", "api"]
+
+    class << self
+      # @param meth [Symbol] the chat method
+      # @param options [Hash] the options hash
+      # @return [String] the JSON serialized envelope
+      # @api private
+      def envelope(meth, options: {})
+        {
+          method: meth,
+          params: {
+            options: options,
+          },
+        }.to_json
+      end
+
+      # @param payload [String]
+      # @return [OpenStruct] a struct mapping of the JSON response
+      # @api private
+      def chat_call(payload)
+        response = Open3.popen3(*CHAT_EXEC_ARGS) do |stdin, stdout, _, _|
+          stdin.write payload
+          stdin.close # close after writing to let keybase know we're done
+          stdout.read
+        end
+
+        JSON.parse response, object_class: OpenStruct
+      end
+
+      # List the user's inbox.
+      # @return [OpenStruct] a struct mapping of the JSON response
+      def list_inbox(topic_type: nil)
+        payload = envelope :list, options: {
+          topic_type: topic_type,
+        }
+
+        chat_call payload
+      end
+
+      # Read a conversation.
+      # @param users [Array<String>] a list of the users in the conversation
+      # @param peek [Boolean] whether to mark the conversation read
+      # @param unread_only [Boolean] whether to fetch unread messages only
+      # @return [OpenStruct] a struct mapping of the JSON response
+      def conversation(users, peek: false, unread_only: false)
+        payload = envelope :read, options: {
+          channel: {
+            name: U[*users],
+          },
+          peek: peek,
+          unread_only: unread_only,
+        }
+
+        chat_call payload
+      end
+
+      # Send a message to a conversation.
+      # @param users [Array<String>] a list of the users in the conversation
+      # @param message [String] the message to send
+      # @param public [Boolean] whether to send the message to a public channel
+      # @return [OpenStruct] a struct mapping of the JSON response
+      def send_message(users, message, public: false)
+        payload = envelope :send, options: {
+          channel: {
+            name: U[*users],
+            public: public,
+          },
+          message: {
+            body: message,
+          }
+        }
+
+        chat_call payload
+      end
+
+      # Delete a message from a conversation.
+      # @param users [Array<String>] a list of the users in the conversation
+      # @param id [Integer] the id of the message to delete
+      # @return [OpenStruct] a struct mapping of the JSON response
+      def delete_message(users, id)
+        payload = envelope :delete, options: {
+          channel: {
+            name: U[*users],
+          },
+          message_id: id,
+        }
+
+        chat_call payload
+      end
+
+      # Edit a message in a conversation.
+      # @param users [Array<String>] a list of the users in the conversation
+      # @param id [Integer] the id of the message to delete
+      # @param message [String] the message to send
+      # @return [OpenStruct] a struct mapping of the JSON response
+      def edit_message(users, id, message)
+        payload = envelope :edit, options: {
+          channel: {
+            name: U[*users],
+          },
+          message_id: id,
+          message: {
+            body: message,
+          }
+        }
+
+        chat_call payload
+      end
+
+      # Upload a file to a conversation.
+      # @param users [Array<String>] a list of the users in the conversation
+      # @param path [String] the pathname of the file to upload
+      # @param title [String] the uploaded file's title
+      # @return [OpenStruct] a struct mapping of the JSON response
+      def upload_attachment(users, path, title)
+        payload = envelope :attach, options: {
+          channel: {
+            name: U[*users],
+          },
+          filename: path,
+          title: title,
+        }
+
+        chat_call payload
+      end
+
+      # Download a file from a conversation.
+      # @param users [Array<String>] a list of the users in the conversation
+      # @param id [Integer] the id of the message to download from
+      # @param path [String] the pathname to download to
+      # @return [OpenStruct] a struct mapping of the JSON response
+      def download_attachment(users, id, path)
+        payload = envelope :download, options: {
+          channel: {
+            name: U[*users],
+          },
+          message_id: id,
+          output: path,
+        }
+
+        chat_call payload
+      end
+
+      # Make a conversation as read up to a specific ID.
+      # @param users [Array<String>] a list of the users in the conversation
+      # @param id [Integer] the id of the message to mark up to
+      # @return [OpenStruct] a struct mapping of the JSON response
+      def mark_conversation(users, id)
+        payload = envelope :mark, options: {
+          channel: {
+            name: U[*users],
+          },
+          message_id: id,
+        }
+
+        chat_call payload
+      end
+
+      # Mute a conversation.
+      # @param users [Array<String>] a list of the users in the conversation
+      # @return [OpenStruct] a struct mapping of the JSON response
+      def mute_conversation(users)
+        payload = envelope :setstatus, options: {
+          channel: {
+            name: U[*users],
+          },
+          status: "muted",
+        }
+
+        chat_call payload
+      end
+    end
+  end
+end

data/lib/keybase/u.rb

@@ -0,0 +1,14 @@
+module Keybase
+  # A class for converting arrays of users into Keybase-style strings.
+  class U
+    class << self
+      # @param args [Array<String>] the list of users to merge
+      # @return [String] the Keybase-style user string
+      # @example
+      #  Keybase::U["a", "b"] # => "a,b"
+      def [](*args)
+        args.join(",")
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keybase-unofficial
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-02 00:00:00.000000000 Z
+date: 2017-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -35,10 +35,12 @@ files:
 - README.md
 - lib/keybase.rb
 - lib/keybase/api.rb
+- lib/keybase/chat.rb
 - lib/keybase/configuration.rb
 - lib/keybase/exceptions.rb
 - lib/keybase/kbfs.rb
 - lib/keybase/local_user.rb
+- lib/keybase/u.rb
 homepage: https://github.com/woodruffw/keybase-unofficial
 licenses:
 - MIT