keybase-unofficial-local 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '09ef090a265fc40d07a8564a2fc5514bb6a0cafc'
-  data.tar.gz: f153a504b1beecd3570dcec400bfec883c587005
+  metadata.gz: f3a1adda41e99d65322a01fe1743e53372a89a9c
+  data.tar.gz: d03dab857b300bb9066ec45da73922a69f45d150
 SHA512:
-  metadata.gz: 4fb253de4da7fc91d05002652c3f6a6b0569e21e287e01436ebbab5edf14b57da117514a53fa781edf6e84b6404c88796b88aacb17a86ceca8e6d9bfc07f4c75
-  data.tar.gz: d410503e96997a14d905b51c117b198171c3bc980b2fc6332b87f2882d0b0044e2c0eb866395eeaf702b5fe8b2561e0f8eec02dab7a78e764f384da20e94a432
+  metadata.gz: '09e28fb48d0732a42e856cbf93a79cccdefc3f9e1040ff347c157631a8f8367709b819412a71242f0272ee2f4f40ebad232e25a2bbb139d757957e59b25093bf'
+  data.tar.gz: 85b46b56b645ca98bb6740c8a4b51ed42e203bee91539277bd92b404847874915654ec410919a9ba224f7f7d9511e0c8b46191793ca53b0e68fa9679de9cd7db

data/lib/keybase/local/chat.rb

@@ -25,28 +25,41 @@ module Keybase
           }.to_json
         end
 
-        # @param payload [String] the JSON payload to send to the chat API
+        # Cleans up the object returned by {chat_call}.
+        # @param struct [OpenStruct] a structified response from the Keybase chat API
+        # @return [OpenStruct] an unwrapped version of the response
+        # @raise [Exceptions::ChatError] when the struct contains an error message
+        # @api private
+        def unwrap(struct)
+          raise Exceptions::ChatError, struct.error.message if struct.error
+
+          struct.result
+        end
+
+        # Makes chat API calls.
+        # @param meth [String, Symbol] the team method
+        # @param options [Hash] the options hash
         # @return [OpenStruct] a struct mapping of the JSON response
+        # @raise [Exceptions::ChatError] if the chat call fails
         # @api private
-        def chat_call(payload)
+        def chat_call(meth, options: {})
           response = Open3.popen3(*CHAT_EXEC_ARGS) do |stdin, stdout, _, _|
-            stdin.write payload
-            stdin.close # close after writing to let keybase know we're done
+            stdin.write envelope meth, options: options
+            stdin.close
             stdout.read
           end
 
-          JSON.parse response, object_class: OpenStruct
+          unwrap JSON.parse response, object_class: OpenStruct
         end
 
-        # List the user's inbox.
+        # List the current user's inbox.
         # @param topic_type [String] the topic type to list by
         # @return [OpenStruct] a struct mapping of the JSON response
+        # @raise [Exceptions::ChatError] if the chat call fails
         def list_inbox(topic_type: nil)
-          payload = envelope :list, options: {
+          chat_call :list, options: {
             topic_type: topic_type,
           }
-
-          chat_call payload
         end
 
         # Read a conversation.
@@ -54,16 +67,15 @@ module Keybase
         # @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
+        # @raise [Exceptions::ChatError] if the chat call fails
         def conversation(users, peek: false, unread_only: false)
-          payload = envelope :read, options: {
+          chat_call :read, options: {
             channel: {
               name: Core::U[*users],
             },
             peek: peek,
             unread_only: unread_only,
           }
-
-          chat_call payload
         end
 
         # Send a message to a conversation.
@@ -71,8 +83,9 @@ module Keybase
         # @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
+        # @raise [Exceptions::ChatError] if the chat call fails
         def send_message(users, message, public: false)
-          payload = envelope :send, options: {
+          chat_call :send, options: {
             channel: {
               name: Core::U[*users],
               public: public,
@@ -81,23 +94,20 @@ module Keybase
               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
+        # @raise [Exceptions::ChatError] if the chat call fails
         def delete_message(users, id)
-          payload = envelope :delete, options: {
+          chat_call :delete, options: {
             channel: {
               name: Core::U[*users],
             },
             message_id: id,
           }
-
-          chat_call payload
         end
 
         # Edit a message in a conversation.
@@ -105,8 +115,9 @@ module Keybase
         # @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
+        # @raise [Exceptions::ChatError] if the chat call fails
         def edit_message(users, id, message)
-          payload = envelope :edit, options: {
+          chat_call :edit, options: {
             channel: {
               name: Core::U[*users],
             },
@@ -115,8 +126,6 @@ module Keybase
               body: message,
             },
           }
-
-          chat_call payload
         end
 
         # Upload a file to a conversation.
@@ -124,16 +133,15 @@ module Keybase
         # @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
+        # @raise [Exceptions::ChatError] if the chat call fails
         def upload_attachment(users, path, title)
-          payload = envelope :attach, options: {
+          chat_call :attach, options: {
             channel: {
               name: Core::U[*users],
             },
             filename: path,
             title: title,
           }
-
-          chat_call payload
         end
 
         # Download a file from a conversation.
@@ -141,45 +149,42 @@ module Keybase
         # @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
+        # @raise [Exceptions::ChatError] if the chat call fails
         def download_attachment(users, id, path)
-          payload = envelope :download, options: {
+          chat_call :download, options: {
             channel: {
               name: Core::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
+        # @raise [Exceptions::ChatError] if the chat call fails
         def mark_conversation(users, id)
-          payload = envelope :mark, options: {
+          chat_call :mark, options: {
             channel: {
               name: Core::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
+        # @raise [Exceptions::ChatError] if the chat call fails
         def mute_conversation(users)
-          payload = envelope :setstatus, options: {
+          chat_call :setstatus, options: {
             channel: {
               name: Core::U[*users],
             },
             status: "muted",
           }
-
-          chat_call payload
         end
       end
     end

data/lib/keybase/local/exceptions.rb

@@ -24,6 +24,22 @@ module Keybase
           super "KBFS needs to be enabled and running"
         end
       end
+
+      # Raised whenever a {Keybase::Local::Chat} call fails.
+      class ChatError < Core::Exceptions::KeybaseError
+        # @param message [String] the error message returned by the API
+        def initialize(message)
+          super message
+        end
+      end
+
+      # Raised whenever a {Keybase::Local::Team} call fails.
+      class TeamError < Core::Exceptions::KeybaseError
+        # @param message [String] the error message returned by the API
+        def initialize(message)
+          super message
+        end
+      end
     end
   end
 end

data/lib/keybase/local/team.rb

@@ -2,138 +2,167 @@
 
 require "open3"
 require "json"
+require "ostruct"
 
 module Keybase
   module Local
-    # Represents an interface to Keybase's teams.
+    # Represents Keybase's JSON team API.
     module Team
       # The initial arguments to pass when executing Keybase for team management.
-      TEAM_EXEC_ARGS = %w[keybase team].freeze
-
-      # The pattern used to (partially) validate team names.
-      # @see https://github.com/keybase/client/blob/5aa02d1b351f0dfab050eb5ae22bffdf59f61d91/go/protocol/keybase1/extras.go#L1560
-      TEAM_PATTERN = /([a-zA-Z0-9][a-zA-Z0-9_]?)+/
+      TEAM_EXEC_ARGS = %w[keybase team api].freeze
 
       class << self
-        # @param args [Array<String>] additional arguments to pass to `keybase team`
-        # @param payload [String, nil] input data to feed to the invocation
-        # @param json [Boolean] whether or not to parse `stdout` as JSON
-        # @return [Hash, Boolean, nil] the parsed JSON, or a true/false/nil result indicating
-        #   command success
+        # @param meth [Symbol] the team method
+        # @param options [Hash] the options hash
+        # @return [String] the JSON serialized envelope
         # @api private
-        def team_call(*args, payload: nil, json: false)
-          if json
-            response = Open3.popen3(*TEAM_EXEC_ARGS, *args) do |stdin, stdout, _, _|
-              stdin.write payload if payload
-              stdin.close # close after writing to let keybase know we're done
-              stdout.read
-            end
-
-            if response.empty?
-              {}
-            else
-              JSON.parse response
-            end
-          else
-            system(*TEAM_EXEC_ARGS, *args)
-          end
+        def envelope(meth, options: {})
+          {
+            method: meth,
+            params: {
+              options: options,
+            },
+          }.to_json
         end
 
-        # Create a new Keybase team.
-        # @note This is a stub.
+        # Cleans up the object returned by {team_call}.
+        # @param struct [OpenStruct] a structified response from the Keybase team API
+        # @return [OpenStruct] an unwrapped version of the response
+        # @raise [Exceptions::TeamError] when the struct contains an error message
         # @api private
-        def create(_team)
-          # stub
-        end
+        def unwrap(struct)
+          raise Exceptions::TeamError, struct.error.message if struct.error
 
-        # Add a user to a Keybase team.
-        # @note This is a stub.
-        # @api private
-        def add_member(_team, _user, _role: :reader, _email: false)
-          # stub
+          struct.result
         end
 
-        # Remove a user from a Keybase team.
-        # @note This is a stub.
+        # Makes team API calls.
+        # @param meth [String, Symbol] the team method
+        # @param options [Hash] the options hash
+        # @return [OpenStruct] a struct mapping on the JSON response
         # @api private
-        def remove_member(_team, _user)
-          # stub
+        def team_call(meth, options: {})
+          response = Open3.popen3(*TEAM_EXEC_ARGS) do |stdin, stdout, _, _|
+            stdin.write envelope meth, options: options
+            stdin.close
+            stdout.read
+          end
+
+          unwrap JSON.parse response, object_class: OpenStruct
         end
 
-        # Modify a user in a Keybase team.
-        # @note This is a stub.
-        # @api private
-        def edit_member(_team, _user, _role: :reader)
-          # stub
+        # List all team memberships for the current user.
+        # @return [OpenStruct] a struct mapping of the JSON response
+        # @raise [Exceptions::TeamError] if the team call fails
+        def list_self_memberships
+          team_call "list-self-memberships"
         end
 
-        # List all teams currently belonged to.
-        # @param force_poll [Boolean] whether or not to force a poll of the server for all idents
-        # @return [Hash] a hash representation of all teams currently belonged to
-        def list_memberships(force_poll: false)
-          args = %w[list-memberships --json]
-          args << "--force-poll" if force_poll
+        alias self_memberships list_self_memberships
 
-          team_call(*args, json: true)
+        # List all users in the given team.
+        # @param team [String] the team to list
+        # @return [OpenStruct] a struct mapping of the JSON response
+        # @raise [Exceptions::TeamError] if the team call fails
+        def list_team_memberships(team)
+          team_call "list-team-memberships", options: {
+            team: team,
+          }
         end
 
-        # List all members of the given team.
-        # @param force_poll [Boolean] whether or not to force a poll of the server for all idents
-        # @return [Hash] a hash representation of all members of the given team
-        def list_members(team, force_poll: false)
-          args = %W[list-members #{team} --json]
-          args << "--force-poll" if force_poll
+        alias team_memberships list_team_memberships
 
-          team_call(*args, json: true)
+        # List teams for a user.
+        # @param user [String] a Keybase username
+        # @return [OpenStruct] a struct mapping of the JSON response
+        # @raise [Exceptions::TeamError] if the team call fails
+        def list_user_memberships(user)
+          team_call "list-user-memberships", options: {
+            username: user,
+          }
         end
 
-        # Change the name of a Keybase team.
-        # @note This is a stub.
-        # @api private
-        def rename(_old_team, _new_team)
-          # stub
-        end
+        alias user_memberships list_user_memberships
 
-        # Request access to a Keybase team.
-        # @note This is a stub.
-        # @api private
-        def request_access(_team)
-          # stub
+        # Create a new team.
+        # @param team [String] the team name
+        # @return [OpenStruct] a struct mapping of the JSON response
+        # @raise [Exceptions::TeamError] if the team call fails
+        def create_team(team)
+          team_call "create-team", options: {
+            team: team,
+          }
         end
 
-        # List requests to join Keybase teams.
-        # @note This is a stub.
-        # @api private
-        def list_requests
-          # stub
+        # Add members to a team.
+        # @param team [String] the team name
+        # @param emails [Array<Hash>] a list of email-role hashes to add to the team
+        # @param users [Array<Hash>] a list of Keybase user-role hashes to add to the team
+        # @return [OpenStruct] a struct mapping of the JSON response
+        # @raise [Exceptions::TeamError] if the team call fails
+        # @example
+        #  Keybase::Local::Team.add_members "foo", users: [{ username: "bob", role: "reader" }]
+        #  Keybase::Local::Team.add_members "bar", emails: [{ email: "foo@bar.com", role: "admin" }]
+        def add_members(team, emails: [], users: [])
+          team_call "add-members", options: {
+            team: team,
+            emails: emails,
+            usernames: users,
+          }
         end
 
-        # Ignore a request to join a Keybase team.
-        # @note This is a stub.
-        # @api private
-        def ignore_request(_team, _user)
-          # stub
+        # Edit the role of a user on a team.
+        # @param team [String] the team name
+        # @param user [String] the Keybase user to edit
+        # @param role [String] the user's new role
+        # @return [OpenStruct] a struct mapping of the JSON response
+        # @raise [Exceptions::TeamError] if the team call fails
+        # @example
+        #  Keybase::Local::Team.edit_member "foo", "bob", "reader"
+        def edit_member(team, user, role)
+          team_call "edit-member", options: {
+            team: team,
+            username: user,
+            role: role,
+          }
         end
 
-        # Accept an email invitation to join a Keybase team.
-        # @note This is a stub.
-        # @api private
-        def accept_invite(_token)
-          # stub
+        # Remove a user from a team.
+        # @param team [String] the team name
+        # @param user [String] the Keybase user to remove
+        # @return [OpenStruct] a struct mapping of the JSON response
+        # @raise [Exceptions::TeamError] if the team call fails
+        def remove_member(team, user)
+          team_call "remove-member", options: {
+            team: team,
+            username: user,
+          }
         end
 
-        # Leave a Keybase team.
-        # @note This is a stub.
-        # @api private
-        def leave(_team, _permanent: false)
-          # stub
+        # Rename a subteam.
+        # @param old_name [String] the subteam's current name
+        # @param new_name [String] the subteam's new name
+        # @return [OpenStruct] a struct mapping of the JSON response
+        # @raise [Exceptions::TeamError] if the team call fails
+        # @example
+        #  Keybase::Local::Team.rename_subteam "foo.bar", "foo.baz"
+        def rename_subteam(old_name, new_name)
+          team_call "rename-subteam", options: {
+            team: old_name,
+            "new-team-name": new_name,
+          }
         end
 
-        # Delete a Keybase team.
-        # @note This is a stub.
-        # @api private
-        def delete(_team)
-          # stub
+        # Leave a team.
+        # @param team [String] the team name
+        # @param permanent [Boolean] whether or not to leave the team permanently
+        # @return [OpenStruct] a struct mapping of the JSON response
+        # @raise [Exceptions::TeamError] if the team call fails
+        def leave_team(team, permanent: false)
+          team_call "leave-team", options: {
+            team: team,
+            permanent: permanent,
+          }
         end
       end
     end

data/lib/keybase/local.rb

@@ -14,7 +14,7 @@ module Keybase
   # The namespace for `keybase-unofficial-local`.
   module Local
     # The current version of `keybase-unofficial-local`.
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
 
     extend Config
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keybase-unofficial-local
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-26 00:00:00.000000000 Z
+date: 2017-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keybase-unofficial-core