kuvera-api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fddfc99b0d0876c4fd02ffd90aca5e6fb178de283ab3ec631332528caa01c9b
-  data.tar.gz: a821110c62d38067eb2d370aa37087dc7789077985cebb555355e93aa7df30ee
+  metadata.gz: 7b690819abf1e87b510cdd9f894cea824d4f7df76c4975c4a899439c76125cc4
+  data.tar.gz: 37d0fa5af70896776aaaa0deff5b24b195a19c6623223c767dcf83402b448078
 SHA512:
-  metadata.gz: fae1327eb06d199560c2cfc362089b427be97163bea2af30dd78f7df2e16c1239b152b78d7d6832626efc148403d5b4c50aeb828fc0b4a3b2843ef82ac8e1ba5
-  data.tar.gz: fb9af7509a3717daf11f1b9fd2444bad682a7658ed182f3bfc38741b2cf30e37e0bc3c85f70510ca8b6e0621d5ad6fef866002da0bb5435f47ecffecf8cfcb9c
+  metadata.gz: c7927b5d0192c756fdc1c1514062f775846f7368aeb64fa51a020428223195a96f8ba96dce5dd1467584d385fea9736cbbc2895af8fface0e64201dff0a5d4e8
+  data.tar.gz: 798e9e7d83b1ca34c2a255d10627c5d6d3b3c2fa0b62f2636cadfac2959977baaf1afc015d78c9fba1b9b9e8bc0b1442db9474a8eaff5f6004fcc7528b0efdc0

data/README.md

@@ -20,13 +20,32 @@ Or install it yourself as:
 
 ## Usage
 
-Currently this gem only supports one-time secrets receving through the `at`
-command.
+- One-time secrets receving through the `at` command.
 
 ```ruby
-Kuvera::Api.at('0x78c4e15f8f1f3e43f6950975f97ff7c2858bcc5a')
+Kuvera::Api.at('SHARE-78c4e15f8f1f3e43f6950975f97ff7c2858bcc5a')
 ```
 
+- Authentification with OAuth credentials
+```ruby
+Kuvera::Api.me
+# => {"id"=>1, "admin_id"=>2, "name"=>"Kuvera Carrier"}
+```
+
+- Secret files uploading
+```ruby
+Kuvera::Api.upload('My Passport', File.open('passport.pdf'), 'application/pdf')
+# => {"address"=>"KEY-11ff53da91ba292ef628b457895bf7ea", "status"=>"success", "title"=>"My Passport"}
+```
+
+- Secrets sharing
+```ruby
+Kuvera::Api.share('KEY-11ff53da91ba292ef628b457895bf7ea')
+# => {"path"=>"https://kuvera.io/at/SHARE-d00a96d19889639a5a5d3991c6fab49d", "status"=>"success"}
+```
+
+In order to use carrier-related methods you need to provide `OAUTH_UID` and `OAUTH_SECRET`.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/CleverLabs/kuvera-api.

data/kuvera-api.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'oauth2', '~> 1.4'
+
   spec.add_development_dependency 'bundler', '~> 1.17'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

data/lib/kuvera/api.rb

@@ -11,7 +11,7 @@ module Kuvera
 
     module_function
 
-    def_delegators :client, :at
+    def_delegators :client, :at, :me, :upload, :share
 
     def client
       @client ||= Client.new

data/lib/kuvera/api/client.rb

@@ -4,28 +4,62 @@ require 'json'
 require 'net/http'
 
 require 'kuvera/api/errors'
+require 'kuvera/api/oauth'
 
 module Kuvera
   module Api
     class Client
       HOST = 'https://kuvera.io/'
-      PATH = 'at/'
+      ENV_UID = ENV['OAUTH_UID']
+      ENV_SECRET = ENV['OAUTH_SECRET']
+      ENV_HOST = ENV.fetch('KUVERA_API', HOST)
+
+      AT_ENDPOINT = 'at/'
+      ME_ENDPOINT = '/api/v1/me'
+      UPLOAD_ENDPOINT = '/api/v1/secrets'
+      SHARE_ENDPOINT = '/api/v1/links'
+
       ROOT = 'secret'
+      ATTACHMENT = 'SecretAttachment'
 
-      def initialize(host: nil)
-        @host = host || ENV.fetch("KUVERA_API", HOST)
+      def initialize(host: ENV_HOST, uid: ENV_UID, secret: ENV_SECRET)
+        @host = host
+        @uid = uid
+        @secret = secret
       end
 
       RESPONSES = {
-        200 => ->(response) { JSON.parse(response.body).fetch(ROOT) },
+        200 => ->(response) { response.body },
         403 => ->(_response) { raise SecretAlreadyRead },
         404 => ->(_response) { raise SecretNotFound }
       }.freeze
 
       def at(address)
-        response = Net::HTTP.get_response(URI.join(@host, PATH, address))
+        response = Net::HTTP.get_response(URI.join(@host, AT_ENDPOINT, address))
         RESPONSES.fetch(response.code.to_i).call(response)
       end
+
+      def me
+        oauth.get(ME_ENDPOINT)
+      end
+
+      def upload(title, io, mime)
+        upload = Faraday::UploadIO.new(io, mime, io.path.split('/').last)
+        body = { new_secret: { type: ATTACHMENT, title: title, body: upload } }
+        oauth.post(UPLOAD_ENDPOINT, body, headers: {})
+      end
+
+      def share(address)
+        oauth.post(SHARE_ENDPOINT, { secret_id: address }.to_json)
+      end
+
+      private
+
+      def oauth
+        raise MissingCredentials if [@host, @uid, @secret].any?(&:nil?)
+
+        @_oauth = Oauth.new(uid: @uid, secret: @secret, host: @host)
+      end
     end
   end
 end

data/lib/kuvera/api/errors.rb

@@ -4,5 +4,7 @@ module Kuvera
   module Api
     SecretNotFound = Class.new(StandardError)
     SecretAlreadyRead = Class.new(StandardError)
+
+    MissingCredentials = Class.new(StandardError)
   end
 end

data/lib/kuvera/api/oauth.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'oauth2'
+require 'net/http/post/multipart'
+
+module Kuvera
+  module Api
+    class Oauth
+      DEFAULT_CONTENT_TYPE = { 'Content-Type' => 'application/json' }.freeze
+      FATAL_ERROR_MESSAGE = { 'error' => 'Internal error' }.freeze
+      CLIENT_SCOPE = 'ext_app'
+
+      def initialize(uid:, secret:, host:)
+        @oauth_client = OAuth2::Client.new(
+          uid, secret, site: host, token_method: :post
+        ) do |stack|
+          stack.request :multipart
+          stack.request :url_encoded
+          stack.adapter Faraday.default_adapter
+        end
+      end
+
+      def get(url, params = {})
+        token.get(url, params: params).parsed
+      rescue OAuth2::Error => error
+        process_exception(error)
+      end
+
+      def post(url, body, headers: DEFAULT_CONTENT_TYPE.dup)
+        token.post(url, headers: headers, body: body).parsed
+      rescue OAuth2::Error => error
+        process_exception(error)
+      end
+
+      private
+
+      def token
+        @token ||=
+          @oauth_client.client_credentials.get_token(scope: CLIENT_SCOPE)
+      end
+
+      def process_exception(exception)
+        exception.response.parsed || FATAL_ERROR_MESSAGE
+      end
+    end
+  end
+end

data/lib/kuvera/api/version.rb

@@ -2,6 +2,6 @@
 
 module Kuvera
   module Api
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: kuvera-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ignat Zakrevsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-11 00:00:00.000000000 Z
+date: 2019-11-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +102,7 @@ files:
 - lib/kuvera/api.rb
 - lib/kuvera/api/client.rb
 - lib/kuvera/api/errors.rb
+- lib/kuvera/api/oauth.rb
 - lib/kuvera/api/version.rb
 homepage: https://kuvera.io
 licenses: