keybase-unofficial-api 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3df5451abd33c04346aa4412bb0a8b709b15fe9
-  data.tar.gz: 0edbc63742d8b29cb58d5bc39b98d8df9ab3e486
+  metadata.gz: 45e7e413717ec5933b9999bfc86caca02b160385
+  data.tar.gz: d6104e90e99c9025df7fb16a4201366d52902b5b
 SHA512:
-  metadata.gz: 61b6b94ec2137f60ce03d0de0d41a03024d3f6f534f46505f92d1cee2ab54f98bb2ae365adbf78d56fa6cada0288f0f483dbf49c3c1bd2ae75993914719d271e
-  data.tar.gz: c096f7dafce476587604efae5e84e07969cb3844f8e462bdc34a8c63ebf971ba01a66f51a5df1e701ab3edc078100af83117e8cf167e6b95ce57b8933d4521a4
+  metadata.gz: 564a397037d7ca60f3809af6115e34295b2314111efb31d1bfc57c3a7281d4874ed181173caca04bb53a84753007fc9806a5a85df6d8799272d8d8191798178f
+  data.tar.gz: fe047406a0a6c81bab586ad0fb013e64426d5591670192c4fa418e1ca3f65aca5efcf6a740881311ce4ed799eff03fac2b634d356a221c1bb487f53e43152d12

data/lib/keybase/api.rb

@@ -2,12 +2,13 @@
 
 require "keybase/core"
 
+require_relative "api/exceptions"
 require_relative "api/api"
 
 # The primary namespace.
 module Keybase
   module API
     # The current version of `keybase-unofficial-api`.
-    VERSION = "0.0.3"
+    VERSION = "0.1.0"
   end
 end

data/lib/keybase/api/api.rb

@@ -12,11 +12,32 @@ module Keybase
     BASE_URL = "https://keybase.io/_/api/1.0"
 
     class << self
+      # Cleans up the object returned by {api_call}.
+      # @param struct [OpenStruct] a structified response from the Keybase API
+      # @raise [Exceptions::APIError] when the struct contains an error message
+      def unwrap(struct)
+        raise Exceptions::APIError, struct.status.desc unless struct.status.code.zero?
+
+        struct
+      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
+      # @raise [Exceptions::APIError] if the API call fails
+      # @api private
+      def api_call(endpoint, query)
+        response = Faraday.get "#{BASE_URL}#{endpoint}", query
+        unwrap JSON.parse response.body, object_class: OpenStruct
+      end
+
       # Look up a user, users, or external identity.
       # @param query [Hash] the request parameters
       # @option query username [String] the username to look up
       # @option query usernames [Array<String>] multiple usernames to look up
       # @return [OpenStruct] a struct mapping of the JSON response
+      # @raise [Exceptions::APIError] if the API call fails
       # @example
       #  Keybase::API.lookup username: "yossarian"
       #  Keybase::API.lookup github: "woodruffw"
@@ -26,7 +47,7 @@ module Keybase
       def lookup(**query)
         query[:usernames] = Core::U[query[:usernames]]
 
-        fetch_and_structify "/user/lookup.json", query
+        api_call "/user/lookup.json", query
       end
 
       # Test whether the given user exists on Keybase.
@@ -37,17 +58,18 @@ module Keybase
       #  Keybase::API.user? "idonotexist" # => false
       # @note This call only works on Keybase usernames, not external identities.
       def user?(user)
-        lookup(username: user).status.code.zero?
+        lookup(username: user).status.code.zero? rescue false
       end
 
       # Search Keybase for identity components.
       # @param query [String] the string to search for
       # @return [OpenStruct] a struct mapping of the JSON response
+      # @raise [Exceptions::APIError] if the API call fails
       # @example
       #  Keybase::API.autocomplete "William Woodruff"
       # @see https://keybase.io/docs/api/1.0/call/user/autocomplete
       def autocomplete(query)
-        fetch_and_structify "/user/autocomplete.json", q: query
+        api_call "/user/autocomplete.json", q: query
       end
 
       # Discover Keybase users from external identities.
@@ -56,13 +78,14 @@ module Keybase
       # @option query usernames_only [Boolean] whether or not to reply with
       #  only names
       # @return [OpenStruct] a struct mapping of the JSON response
+      # @raise [Exceptions::APIError] if the API call fails
       # @example
       #  Keybase::API.discover github: "woodruffw", flatten: true
       # @note Any identity supported by keybase should work (e.g, `domain`,
       #  `hackernews`, `reddit`, `github`, etc.)
       # @see https://keybase.io/docs/api/1.0/call/user/discover
       def discover(**query)
-        fetch_and_structify "/user/discover.json", query
+        api_call "/user/discover.json", query
       end
 
       # Retrieve the current site-wide Merkle root hash.
@@ -71,28 +94,20 @@ module Keybase
       # @option query ctime [Integer] return the first root on or after the
       #  given time (UTC)
       # @return [OpenStruct] a struct mapping of the JSON response
+      # @raise [Exceptions::APIError] if the API call fails
       # @see https://keybase.io/docs/api/1.0/call/merkle/root
       def merkle_root(**query)
-        fetch_and_structify "/merkle/root.json", query
+        api_call "/merkle/root.json", query
       end
 
       # Retrieve a Merkle node corresponding to a given hash.
       # @param query [Hash] the request parameters
       # @option query hash [String] the hash of the block to look up
       # @return [OpenStruct] a struct mapping of the JSON response
+      # @raise [Exceptions::APIError] if the API call fails
       # @see https://keybase.io/docs/api/1.0/call/merkle/block
       def merkle_block(**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)
+        api_call "/merkle/block.json", query
       end
     end
   end

data/lib/keybase/api/exceptions.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Keybase
+  module API
+    # A namespace for all exceptions defined by {Keybase::API}.
+    module Exceptions
+      # Raised whenever an {API} call fails.
+      class APIError < Core::Exceptions::KeybaseError
+        # @param message [String] the error message returned by the API
+        def initialize(message)
+          super message
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keybase-unofficial-api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-20 00:00:00.000000000 Z
+date: 2017-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -51,7 +51,8 @@ files:
 - README.md
 - lib/keybase/api.rb
 - lib/keybase/api/api.rb
-homepage: https://github.com/woodruffw/keybase-unofficial-api
+- lib/keybase/api/exceptions.rb
+homepage: https://github.com/kbsecret/keybase-unofficial-api
 licenses:
 - MIT
 metadata: {}