keybase-unofficial 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2edd9a6909fd527cc22f65bc1a4f3ba918179e80
-  data.tar.gz: d847cc38999955a7eb438b17a966f9e0b6f38b4b
+  metadata.gz: 92b8d2bb03033f025a8a8e778f11d5e2d470a88a
+  data.tar.gz: 9fb4001568fcddebd690431706c93d87459e2e87
 SHA512:
-  metadata.gz: 94b656684f60c93c94e8ed1453c37231e3df3c3caf4c7a1314b32e0c4c133f0fe21033936c83fa1b59f9e3be18da3a1c8c0ad151764381dae027502eab9f616a
-  data.tar.gz: 00553731d8f691ab623328c2142f853c7c0162c498b6a6bb4ed27b2dd4c9532debb5f0795676658b5aa883e8c0bb5fbf89a11ee64224cfd513ca1cde7ecadef7
+  metadata.gz: c42a9078a6129bd77e4aa06c73dd6b7525883638fec692fcf645012b89d75714598b6d708faaa8f7d4d2fe8e02fd0250a277237892910805de28a0425608213e
+  data.tar.gz: 3947bf4f71286973f63966a1f444ba2a2a6a2f8c495a216a241f41fdd93a360e4a831ca2f9100cfe61804851f8b30fd071e85ddb517c578211a4af2b63f951b1

data/README.md

@@ -7,6 +7,12 @@ An unofficial ruby library for Keybase and the Keybase API.
 
 Work in progress.
 
+### Installation
+
+```bash
+$ gem install keybase-unofficial
+```
+
 ### Documentation
 
 Documentation for the current release can be found on
@@ -20,7 +26,10 @@ require "keybase"
 # reads your local configuration
 Keybase.current_user # => "yossarian"
 
-# API access
+# Chatting API
+Keybase::Chat.send_message ["yossarian", "you"], "hello"
+
+# REST API
 person = Keybase::API.lookup username: "yossarian"
 person.them.profile.bio # => "Computer Science and Philosophy student at the University of Maryland, College Park.\n"
 ```

data/lib/keybase.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "keybase/exceptions"
 require_relative "keybase/configuration"
 require_relative "keybase/u"
@@ -9,7 +11,7 @@ require_relative "keybase/chat"
 # The primary namespace for keybase-unofficial.
 module Keybase
   # keybase-unofficial's current version
-  VERSION = "0.0.6".freeze
+  VERSION = "0.0.7"
 
   extend Configuration
 end

data/lib/keybase/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "faraday"
 require "json"
 require "ostruct"
@@ -22,12 +24,9 @@ module Keybase
       #  `hackernews`, `reddit`, `github`, etc.)
       # @see https://keybase.io/docs/api/1.0/call/user/lookup
       def lookup(**query)
-        if query[:usernames]
-          query[:usernames] = U[query[:usernames]]
-        end
+        query[:usernames] = U[query[:usernames]]
 
-        response = Faraday.get "#{BASE_URL}/user/lookup.json", query
-        JSON.parse(response.body, object_class: OpenStruct)
+        fetch_and_structify "/user/lookup.json", query
       end
 
       # Search Keybase for identity components.
@@ -37,8 +36,7 @@ module Keybase
       #  Keybase::API.autocomplete "William Woodruff"
       # @see https://keybase.io/docs/api/1.0/call/user/autocomplete
       def autocomplete(query)
-        response = Faraday.get "#{BASE_URL}/user/autocomplete.json", q: query
-        JSON.parse(response.body, object_class: OpenStruct)
+        fetch_and_structify "/user/autocomplete.json", q: query
       end
 
       # Discover Keybase users from external identities.
@@ -53,8 +51,7 @@ module Keybase
       #  `hackernews`, `reddit`, `github`, etc.)
       # @see https://keybase.io/docs/api/1.0/call/user/discover
       def discover(**query)
-        response = Faraday.get "#{BASE_URL}/user/discover.json", query
-        JSON.parse(response.body, object_class: OpenStruct)
+        fetch_and_structify "/user/discover.json", query
       end
 
       # Retrieve the current site-wide Merkle root hash.
@@ -65,8 +62,7 @@ module Keybase
       # @return [OpenStruct] a struct mapping of the JSON response
       # @see https://keybase.io/docs/api/1.0/call/merkle/root
       def merkle_root(**query)
-        response = Faraday.get "#{BASE_URL}/merkle/root.json", query
-        JSON.parse(response.body, object_class: OpenStruct)
+        fetch_and_structify "/merkle/root.json", query
       end
 
       # Retrieve a Merkle node corresponding to a given hash.
@@ -75,7 +71,16 @@ module Keybase
       # @return [OpenStruct] a struct mapping of the JSON response
       # @see https://keybase.io/docs/api/1.0/call/merkle/block
       def merkle_block(**query)
-        response = Faraday.get "#{BASE_URL}/merkle/block.json", query
+        fetch_and_structify "/merkle/block.json", query
+      end
+
+      # Make a GET request to the given endpoint with the given parameters.
+      # @param endpoint [String] the keybase API endpoint
+      # @param query [Hash] the request parameters
+      # @return [OpenStruct] a struct mapping of the JSON response
+      # @api private
+      def fetch_and_structify(endpoint, query)
+        response = Faraday.get "#{BASE_URL}#{endpoint}", query
         JSON.parse(response.body, object_class: OpenStruct)
       end
     end

data/lib/keybase/chat.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "open3"
 require "json"
 require "ostruct"
@@ -6,7 +8,7 @@ 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"]
+    CHAT_EXEC_ARGS = %w[keybase chat api].freeze
 
     class << self
       # @param meth [Symbol] the chat method
@@ -75,7 +77,7 @@ module Keybase
           },
           message: {
             body: message,
-          }
+          },
         }
 
         chat_call payload
@@ -109,7 +111,7 @@ module Keybase
           message_id: id,
           message: {
             body: message,
-          }
+          },
         }
 
         chat_call payload

data/lib/keybase/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "json"
 
 module Keybase

data/lib/keybase/exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Keybase
   # A top-level exception for the library.
   class KeybaseError < RuntimeError

data/lib/keybase/kbfs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Keybase
   # Represents the Keybase filesystem.
   # @note This is just a stub for the time being.

data/lib/keybase/local_user.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Keybase
   # Represents a user known to the local Keybase process.
   # These are (presumably) users that have been logged into locally.

data/lib/keybase/u.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Keybase
   # A class for converting arrays of users into Keybase-style strings.
   class U

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keybase-unofficial
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-08 00:00:00.000000000 Z
+date: 2017-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -61,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: keybase-unofficial - An unofficial library for Keybase.