keybase-unofficial-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 64e949400e24f64b7d16f3f299752f198b3f5661
+  data.tar.gz: e03734a324ab0e4a9ed67378456317db735bb501
+SHA512:
+  metadata.gz: 7bdfa548bad2a519d06117aa61151d40c9e945cd2c0ce9d794534e256da099bf9930a6110f643ec32ed2c78db149d5721546c5b3172ea03492c69427325fa89e
+  data.tar.gz: 366fc167ccf3eb59f8563eba1d779e0a1fab74f2d58f016950e3645ef4009808da4683b72115415bbe5ba4a740be3322c2ad242000774aaafd124f3165c35937

data/.yardopts

@@ -0,0 +1 @@
+--no-private --markup-provider=redcarpet --markup=markdown - *.md LICENSE

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 William Woodruff <william @ yossarian.net>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,15 @@
+keybase-unofficial-api
+======================
+
+An unofficial Ruby library for the Keybase REST API.
+
+### Installation
+
+```bash
+gem install keybase-unofficial-api
+```
+
+### Documentation
+
+Documentation for the current release can be found on
+[RubyDoc](http://www.rubydoc.info/gems/keybase-unofficial-api/).

data/lib/keybase/api.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "keybase/core"
+
+require_relative "api/api"
+
+# The primary namespace.
+module Keybase
+  module API
+    # The current version of `keybase-unofficial-api`.
+    VERSION = "0.0.1"
+  end
+end

data/lib/keybase/api/api.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+require "ostruct"
+
+module Keybase
+  # Represents (parts of) the Keybase REST API.
+  # @see https://keybase.io/docs/api/1.0
+  module API
+    # The base URL for the majority of API calls.
+    BASE_URL = "https://keybase.io/_/api/1.0"
+
+    class << self
+      # 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
+      # @example
+      #  Keybase::API.lookup username: "yossarian"
+      #  Keybase::API.lookup github: "woodruffw"
+      # @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/lookup
+      def lookup(**query)
+        query[:usernames] = Core::U[query[:usernames]]
+
+        fetch_and_structify "/user/lookup.json", query
+      end
+
+      # Test whether the given user exists on Keybase.
+      # @param user [String] the username to test
+      # @return [Boolean] whether or not the user exists
+      # @example
+      #  Keybase::API.user? "yossarian" # => true
+      #  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?
+      end
+
+      # Search Keybase for identity components.
+      # @param query [String] the string to search for
+      # @return [OpenStruct] a struct mapping of the JSON response
+      # @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
+      end
+
+      # Discover Keybase users from external identities.
+      # @param query [Hash] the request parameters
+      # @option query flatten [Boolean] whether or not to remove duplicates
+      # @option query usernames_only [Boolean] whether or not to reply with
+      #  only names
+      # @return [OpenStruct] a struct mapping of the JSON response
+      # @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
+      end
+
+      # Retrieve the current site-wide Merkle root hash.
+      # @param query [Hash] the request parameters
+      # @option query seqno [Integer] a specific Merkle root to return, if found
+      # @option query ctime [Integer] return the first root on or after the
+      #  given time (UTC)
+      # @return [OpenStruct] a struct mapping of the JSON response
+      # @see https://keybase.io/docs/api/1.0/call/merkle/root
+      def merkle_root(**query)
+        fetch_and_structify "/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
+      # @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)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: keybase-unofficial-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- William Woodruff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: keybase-unofficial-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 'This library provides access to Keybase''s REST API from Ruby.
+
+'
+email: william@tuffbizz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- LICENSE
+- README.md
+- lib/keybase/api.rb
+- lib/keybase/api/api.rb
+homepage: https://github.com/woodruffw/keybase-unofficial-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: keybase-unofficial-api - Unofficial library for the Keybase API
+test_files: []