keybase-unofficial 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2fc22bf434a189f47e72c9e7b7482680bc163f8
+  data.tar.gz: b400c92a182732b13d3f454da91a495dbba26ced
+SHA512:
+  metadata.gz: 4eb9f9a9bbc3975045a88e66373689a1518419c3220c405cabf4086b39e3e9a3bd9b33036185d0bfd511fe56d1dd96bfd4056743b88f67b27282ba214a9fc2a4
+  data.tar.gz: 8630e5d3371f3494834f51ffcb069c0ec16c969d603e34ca4b0a65e6365e09e922209a623a34e4ecd0a1048d6a37da9fc1168e1c627f412b2059fb0fd0c4ec71

data/README.md

@@ -0,0 +1,19 @@
+keybase-unofficial
+==================
+
+An unofficial ruby library for Keybase and the Keybase API.
+
+Work in progress.
+
+### Example
+
+```ruby
+require "keybase"
+
+# reads your local configuration
+Keybase.current_user # => "yossarian"
+
+# API access
+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/api.rb

@@ -0,0 +1,41 @@
+require "faraday"
+require "json"
+require "ostruct"
+require "uri"
+
+module Keybase
+  class API
+    BASE_URL = "https://keybase.io/_/api/1.0"
+
+    class << self
+      def lookup(**query)
+        if query[:usernames]
+          query[:usernames] = query[:usernames].join(",")
+        end
+
+        response = Faraday.get "#{BASE_URL}/user/lookup.json", query
+        JSON.parse(response.body, object_class: OpenStruct)
+      end
+
+      def autocomplete(query)
+        response = Faraday.get "#{BASE_URL}/user/autocomplete.json", q: query
+        JSON.parse(response.body, object_class: OpenStruct)
+      end
+
+      def discover(**query)
+        response = Faraday.get "#{BASE_URL}/user/discover.json", query
+        JSON.parse(response.body, object_class: OpenStruct)
+      end
+
+      def merkle_root(**query)
+        response = Faraday.get "#{BASE_URL}/merkle/root.json", query
+        JSON.parse(response.body, object_class: OpenStruct)
+      end
+
+      def merkle_block(**query)
+        response = Faraday.get "#{BASE_URL}/merkle/block.json", query
+        JSON.parse(response.body, object_class: OpenStruct)
+      end
+    end
+  end
+end

data/lib/keybase/configuration.rb

@@ -0,0 +1,39 @@
+require "json"
+
+module Keybase
+  module Configuration
+    CONFIG_DIR = File.expand_path("~/.config/keybase").freeze
+
+    CONFIG_FILE = File.join(CONFIG_DIR, "config.json").freeze
+
+    CONFIG_HASH = JSON.parse(File.read(CONFIG_FILE)).freeze
+
+    def current_user
+      CONFIG_HASH["current_user"]
+    end
+
+    def users
+      CONFIG_HASH["users"].map { |_, v| Keybase::User.new(v) }
+    end
+
+    def private_dir
+      "/keybase/private/#{current_user}"
+    end
+
+    def public_dir
+      "/keybase/public/#{current_user}"
+    end
+
+    def running?
+      # is there a more efficient way to do this that doesn't involve an exec?
+      Dir["/proc/[0-9]*/comm"].any? do |comm|
+        File.read(comm).chomp == "keybase"
+      end
+    end
+
+    def running_version
+      raise KeybaseNotRunningError unless Keybase.running?
+      `keybase --version`.split[2]
+    end
+  end
+end

data/lib/keybase/exceptions.rb

@@ -0,0 +1,16 @@
+module Keybase
+  class KeybaseError < RuntimeError
+  end
+
+  class KeybaseNotRunningError < KeybaseError
+    def initialize
+      super "keybase needs to be running"
+    end
+  end
+
+  class KBFSNotRunningError < KeybaseError
+    def initialize
+      super "KBFS needs to be enabled and running"
+    end
+  end
+end

data/lib/keybase/kbfs.rb

@@ -0,0 +1,12 @@
+module Keybase
+  class KBFS
+    def initialize
+      raise KeybaseNotRunningError unless Keybase.running?
+      raise KBFSNotRunningError unless Dir.exist?("/keybase")
+    end
+
+    # there's nothing here yet.
+    # i could add methods for moving files to and from the public
+    # and private keybase directories, but that feels overkill.
+  end
+end

data/lib/keybase/user.rb

@@ -0,0 +1,12 @@
+module Keybase
+  class User
+    attr_reader :device, :id, :name, :salt
+
+    def initialize(hsh)
+      @device = hsh["device"]
+      @id = hsh["id"]
+      @name = hsh["name"]
+      @salt = hsh["salt"]
+    end
+  end
+end

data/lib/keybase.rb

@@ -0,0 +1,11 @@
+require_relative "keybase/exceptions"
+require_relative "keybase/configuration"
+require_relative "keybase/user"
+require_relative "keybase/kbfs"
+require_relative "keybase/api"
+
+module Keybase
+  VERSION = "0.0.1".freeze
+
+  extend Configuration
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: keybase-unofficial
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- William Woodruff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-28 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'
+description: A unofficial library for Keybase
+email: william@tuffbizz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/keybase.rb
+- lib/keybase/api.rb
+- lib/keybase/configuration.rb
+- lib/keybase/exceptions.rb
+- lib/keybase/kbfs.rb
+- lib/keybase/user.rb
+homepage: https://github.com/woodruffw/keybase-unofficial
+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.8
+signing_key: 
+specification_version: 4
+summary: keybase-unofficial - An unofficial library for Keybase.
+test_files: []