keybase-unofficial 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db0b875052bf623f798762c590f519e6143115f7
-  data.tar.gz: b501af569c38574f42652f2417513371b4fc2f63
+  metadata.gz: 569fd96fa1a8332e7d7e88d64e2214f7eef12cc5
+  data.tar.gz: 88477e5dab7b71a7aabcd2161243d90b0937521e
 SHA512:
-  metadata.gz: cd0c47e547ead2245567014a587f0023014e7d251710c3be188302b0f0915fff88fd45c952d763f391d02c30ce58a29e0e24c41dc8bbb3a5a80dff0bdf98b396
-  data.tar.gz: c38b9d94a32786fa374de4bbef4c09cd61d9e1bb3701d7bcda497fded963b3d3daaeacaac07386bbc76f51df80cd5dcd02233e94d87be272b01fa972caa7bfea
+  metadata.gz: 4f725902a0cb3264d2b7541fef4a729b634f2ed67903c00073b40e94c0fd4f8cf1216495a94d0e5021c0dc891c4715f8653b6f0638e8665185ca888cd9cda92a
+  data.tar.gz: c96ebe40d9789ba5bfed0e9cd1e0a26da8565cbb586a83d9deebbe0872d1c7bd52858ae6f153dd252cfc5dd1c2dbcc30054e0e529788376855613e224b42b7c9

data/README.md

@@ -7,6 +7,11 @@ An unofficial ruby library for Keybase and the Keybase API.
 
 Work in progress.
 
+### Documentation
+
+Documentation for the current release can be found on
+[RubyDoc](http://www.rubydoc.info/gems/keybase-unofficial/).
+
 ### Example
 
 ```ruby

data/lib/keybase.rb

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

data/lib/keybase/api.rb

@@ -1,10 +1,10 @@
 require "faraday"
 require "json"
 require "ostruct"
-require "uri"
 
 module Keybase
   # Represents (parts of) the Keybase REST API.
+  # @see https://keybase.io/docs/api/1.0
   class API
     # The base URL for the majority of API calls.
     BASE_URL = "https://keybase.io/_/api/1.0"

data/lib/keybase/configuration.rb

@@ -17,9 +17,10 @@ module Keybase
       CONFIG_HASH["current_user"]
     end
 
-    # @return [Array<Keybase::User>] a list of all local users known to Keybase
-    def users
-      CONFIG_HASH["users"].map { |_, v| Keybase::User.new(v) }
+    # @return [Array<Keybase::LocalUser>] a list of all local users known
+    #  to Keybase
+    def local_users
+      CONFIG_HASH["users"].map { |_, v| Keybase::LocalUser.new(v) }
     end
 
     # @return [String] the user's private KBFS directory

data/lib/keybase/{user.rb → local_user.rb}

@@ -1,7 +1,7 @@
 module Keybase
   # Represents a user known to the local Keybase process.
   # These are (presumably) users that have been logged into locally.
-  class User
+  class LocalUser
     # @return [String] the device's unique identifier
     attr_reader :device
 
@@ -15,11 +15,16 @@ module Keybase
     # @note I have no idea what this field does.
     attr_reader :salt
 
-    def initialize(hsh)
-      @device = hsh["device"]
-      @id = hsh["id"]
-      @name = hsh["name"]
-      @salt = hsh["salt"]
+    # @param fields [Hash] the user's configuration fields
+    # @option fields device [String] the device's unique identifier
+    # @option fields id [String] the user's unique identifier
+    # @option fields name [String] the user's Keybase username
+    # @option fields salt [String] some kind of salt
+    def initialize(fields)
+      @device = fields["device"]
+      @id = fields["id"]
+      @name = fields["name"]
+      @salt = fields["salt"]
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keybase-unofficial
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - William Woodruff
@@ -38,7 +38,7 @@ files:
 - lib/keybase/configuration.rb
 - lib/keybase/exceptions.rb
 - lib/keybase/kbfs.rb
-- lib/keybase/user.rb
+- lib/keybase/local_user.rb
 homepage: https://github.com/woodruffw/keybase-unofficial
 licenses:
 - MIT