op_connect 0.1.1

data/docker-compose.yml

@@ -0,0 +1,20 @@
+version: '3.8'
+
+services:
+  op-connect-api:
+    image: 1password/connect-api:latest
+    ports:
+      - 8080:8080
+    volumes:
+      - ./1password-credentials.json:/home/opuser/.op/1password-credentials.json
+      - op-connect-data:/home/opuser/.op/data
+  op-connect-sync:
+    image: 1password/connect-sync:latest
+    ports:
+      - 8081:8080
+    volumes:
+      - ./1password-credentials.json:/home/opuser/.op/1password-credentials.json
+      - op-connect-data:/home/opuser/.op/data
+
+volumes:
+  op-connect-data:

data/lib/op_connect/api_request/actor.rb

@@ -0,0 +1,15 @@
+module OpConnect
+  class APIRequest
+    class Actor
+      attr_reader :id, :account, :jti, :user_agent, :ip
+
+      def initialize(options = {})
+        @id = options["id"]
+        @account = options["account"]
+        @jti = options["jti"]
+        @user_agent = options["user_agent"]
+        @ip = options["ip"]
+      end
+    end
+  end
+end

data/lib/op_connect/api_request/resource.rb

@@ -0,0 +1,14 @@
+module OpConnect
+  class APIRequest
+    class Resource
+      attr_reader :type, :vault, :item, :item_version
+
+      def initialize(options = {})
+        @type = options["type"]
+        @vault = Object.new(options["vault"])
+        @item = Object.new(options["item"])
+        @item_version = options["item_version"]
+      end
+    end
+  end
+end

data/lib/op_connect/api_request.rb

@@ -0,0 +1,17 @@
+module OpConnect
+  class APIRequest
+    autoload :Actor, "op_connect/api_request/actor"
+    autoload :Resource, "op_connect/api_request/resource"
+
+    attr_reader :request_id, :timestamp, :action, :result, :actor, :resource
+
+    def initialize(options = {})
+      @request_id = options["request_id"]
+      @timestamp = options["timestamp"]
+      @action = options["action"]
+      @result = options["result"]
+      @actor = Actor.new(options["actor"])
+      @resource = Resource.new(options["resource"])
+    end
+  end
+end

data/lib/op_connect/client/files.rb

@@ -0,0 +1,20 @@
+module OpConnect
+  class Client
+    module Files
+      def list_files(vault_id:, item_id:, **params)
+        get("vaults/#{vault_id}/items/#{item_id}/files", params: params).body.map { |file| Item::File.new(file) }
+      end
+      alias_method :files, :list_files
+
+      def get_file(vault_id:, item_id:, id:, **params)
+        Item::File.new get("vaults/#{vault_id}/items/#{item_id}/files/#{id}", params: params).body
+      end
+      alias_method :file, :get_file
+
+      def get_file_content(vault_id:, item_id:, id:)
+        get("vaults/#{vault_id}/items/#{item_id}/files/#{id}/content").body
+      end
+      alias_method :file_content, :get_file_content
+    end
+  end
+end

data/lib/op_connect/client/items.rb

@@ -0,0 +1,34 @@
+module OpConnect
+  class Client
+    module Items
+      def list_items(vault_id:, **params)
+        get("vaults/#{vault_id}/items", params: params).body.map { |item| Item.new(item) }
+      end
+      alias_method :items, :list_items
+
+      def get_item(vault_id:, id:)
+        Item.new get("vaults/#{vault_id}/items/#{id}").body
+      end
+      alias_method :item, :get_item
+
+      def create_item(vault_id:, **attributes)
+        Item.new post("vaults/#{vault_id}/items", body: attributes).body
+      end
+
+      def replace_item(vault_id:, id:, **attributes)
+        Item.new put("vaults/#{vault_id}/items/#{id}", body: attributes).body
+      end
+
+      def delete_item(vault_id:, id:)
+        return true if delete("vaults/#{vault_id}/items/#{id}").status == 204
+        false
+      rescue OpConnect::Error
+        false
+      end
+
+      def update_item(vault_id:, id:, **attributes)
+        Item.new patch("vaults/#{vault_id}/items/#{id}", body: attributes, headers: {"Content-Type": "applicatoin/json-patch+json"}).body
+      end
+    end
+  end
+end

data/lib/op_connect/client/vaults.rb

@@ -0,0 +1,15 @@
+module OpConnect
+  class Client
+    module Vaults
+      def list_vaults(**params)
+        get("vaults", params: params).body.map { |vault| Vault.new(vault) }
+      end
+      alias_method :vaults, :list_vaults
+
+      def get_vault(id:)
+        Vault.new get("vaults/#{id}").body
+      end
+      alias_method :vault, :get_vault
+    end
+  end
+end

data/lib/op_connect/client.rb

@@ -0,0 +1,45 @@
+module OpConnect
+  class Client
+    autoload :Vaults, "op_connect/client/vaults"
+    autoload :Items, "op_connect/client/items"
+    autoload :Files, "op_connect/client/files"
+
+    include OpConnect::Configurable
+    include OpConnect::Connection
+    include OpConnect::Client::Vaults
+    include OpConnect::Client::Items
+    include OpConnect::Client::Files
+
+    def initialize(options = {})
+      OpConnect::Configurable.keys.each do |key|
+        value = options.key?(key) ? options[key] : OpConnect.instance_variable_get(:"@#{key}")
+        instance_variable_set(:"@#{key}", value)
+      end
+    end
+
+    def inspect
+      inspected = super
+      inspected.gsub!(@access_token, ("*" * 24).to_s) if @access_token
+      inspected
+    end
+
+    def activity(**params)
+      get("activity", params: params).body.map { |a| APIRequest.new(a) }
+    end
+
+    def heartbeat
+      return true if get("/heartbeat").status == 200
+      false
+    rescue OpConnect::Error
+      false
+    end
+
+    def health
+      ServerHealth.new get("/health").body
+    end
+
+    def metrics
+      get("/metrics").body
+    end
+  end
+end

data/lib/op_connect/configurable.rb

@@ -0,0 +1,45 @@
+module OpConnect
+  module Configurable
+    attr_accessor :access_token, :adapter, :stubs, :user_agent
+    attr_writer :api_endpoint
+
+    class << self
+      def keys
+        @keys ||= [
+          :access_token,
+          :adapter,
+          :api_endpoint,
+          :stubs,
+          :user_agent
+        ]
+      end
+    end
+
+    def configure
+      yield self
+    end
+
+    def reset!
+      OpConnect::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", OpConnect::Default.options[key])
+      end
+
+      self
+    end
+    alias_method :setup, :reset!
+
+    def same_options?(opts)
+      opts.hash == options.hash
+    end
+
+    def api_endpoint
+      ::File.join(@api_endpoint, "")
+    end
+
+    private
+
+    def options
+      OpConnect::Configurable.keys.map { |key| [key, instance_variable_get(:"@#{key}")] }.to_h
+    end
+  end
+end

data/lib/op_connect/connection.rb

@@ -0,0 +1,103 @@
+module OpConnect
+  # Network layer for API clients.
+  #
+  module Connection
+    # Make an HTTP GET request.
+    #
+    # @param url [String] The path, relative to {#api_endpoint}.
+    # @param params [Hash] Query parameters for the request.
+    # @param headers [Hash] Header params for the request.
+    #
+    # @return [Faraday::Response]
+    #
+    def get(url, params: {}, headers: {})
+      request :get, url, params, headers
+    end
+
+    # Make an HTTP POST request.
+    #
+    # @param url [String] The path, relative to {#api_endpoint}.
+    # @param body [Hash] Body params for the request.
+    # @param headers [Hash] Header params for the request.
+    #
+    # @return [Faraday::Response]
+    #
+    def post(url, body:, headers: {})
+      request :post, url, body, headers
+    end
+
+    # Make an HTTP PUT request.
+    #
+    # @param url [String] The path, relative to {#api_endpoint}.
+    # @param body [Hash] Body params for the request.
+    # @param headers [Hash] Header params for the request.
+    #
+    # @return [Faraday::Response]
+    #
+    def put(url, body:, headers: {})
+      request :put, url, body, headers
+    end
+
+    # Make an HTTP PATCH request.
+    #
+    # @param url [String] The path, relative to {#api_endpoint}.
+    # @param body [Hash] Body params for the request.
+    # @param headers [Hash] Header params for the request.
+    #
+    # @return [Faraday::Response]
+    #
+    def patch(url, body:, headers: {})
+      request :patch, url, body, headers
+    end
+
+    # Make an HTTP DELETE request.
+    #
+    # @param url [String] The path, relative to {#api_endpoint}.
+    # @param params [Hash] Query params for the request.
+    # @param headers [Hash] Header params for the request.
+    #
+    # @return [Faraday::Response]
+    #
+    def delete(url, params: {}, headers: {})
+      request :delete, url, params, headers
+    end
+
+    # Connection object for the 1Password Connect API.
+    #
+    # @return [Faraday::Client]
+    #
+    def connection
+      @connection ||= Faraday.new(api_endpoint) do |http|
+        http.headers[:user_agent] = user_agent
+
+        http.request :authorization, :Bearer, access_token
+        http.request :json
+
+        http.use OpConnect::Response::RaiseError
+
+        http.response :dates
+        http.response :json, content_type: "application/json"
+
+        http.adapter adapter, @stubs
+      end
+    end
+
+    # Response for the last HTTP request.
+    #
+    # @return [Faraday::Response]
+    #
+    def last_response
+      @last_response if defined? @last_response
+    end
+
+    private
+
+    def request(method, path, data, headers = {})
+      @last_response = response = connection.send(method, path, data, headers)
+      response
+    rescue OpConnect::Error => error
+      @last_response = nil
+      raise error
+    end
+  end
+end

data/lib/op_connect/default.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "op_connect/version"
+
+module OpConnect
+  # Default configuration options for {Client}
+  #
+  module Default
+    API_ENDPOINT = "http://localhost:8080/v1"
+    USER_AGENT = "1Password Connect Ruby SDK #{OpConnect::VERSION}"
+
+    class << self
+      # Configuration options
+      #
+      # @return [Hash]
+      #
+      def options
+        OpConnect::Configurable.keys.map { |key| [key, send(key)] }.to_h
+      end
+
+      # Default access token from ENV
+      #
+      # @return [String]
+      #
+      def access_token
+        ENV["OP_CONNECT_ACCESS_TOKEN"]
+      end
+
+      # Default network adapter for Faraday (defaults to :net_http)
+      #
+      # @return [Symbol]
+      #
+      def adapter
+        Faraday.default_adapter
+      end
+
+      # Default API endpoint from ENV or {API_ENDPOINT}
+      #
+      # @return [<Type>] <description>
+      #
+      def api_endpoint
+        ENV["OP_CONNECT_API_ENDPOINT"] || API_ENDPOINT
+      end
+
+      def stubs
+      end
+
+      # Default user agent from ENV or {USER_AGENT}
+      #
+      # @return [<Type>] <description>
+      #
+      def user_agent
+        ENV["OP_CONNECT_USER_AGENT"] || USER_AGENT
+      end
+    end
+  end
+end

data/lib/op_connect/error.rb

@@ -0,0 +1,60 @@
+module OpConnect
+  class Error < StandardError
+    class << self
+      def from_response(response)
+        status = response.status
+
+        if (klass = case status
+            when 400 then OpConnect::BadRequest
+            when 401 then OpConnect::Unauthorized
+            when 403 then OpConnect::Forbidden
+            when 404 then OpConnect::NotFound
+            when 413 then OpConnect::PayloadTooLarge
+            when 400..499 then OpConnect::ClientError
+            when 500 then OpConnect::InternalServerError
+            when 503 then OpConnect::ServiceUnavailable
+            when 500..599 then OpConnect::ServerError
+            end)
+          klass.new(response)
+        end
+      end
+    end
+
+    def initialize(response = nil)
+      @response = response
+      super(build_error_message)
+    end
+
+    private
+
+    def build_error_message
+      return nil if @response.nil?
+
+      message = "#{@response.method.to_s.upcase} "
+      message << "#{@response.url}: "
+      message << "#{@response.status} - "
+      message << @response.body["message"].to_s if @response.body["message"]
+      message << "\n\n#{@response.body}\n\n"
+
+      message
+    end
+  end
+
+  class ClientError < Error; end
+
+  class BadRequest < ClientError; end
+
+  class Unauthorized < ClientError; end
+
+  class Forbidden < ClientError; end
+
+  class NotFound < ClientError; end
+
+  class PayloadTooLarge < ClientError; end
+
+  class ServerError < Error; end
+
+  class InternalServerError < ServerError; end
+
+  class ServiceUnavailable < ServerError; end
+end

data/lib/op_connect/item/field.rb

@@ -0,0 +1,18 @@
+module OpConnect
+  class Item
+    class Field
+      attr_reader :purpose, :type, :value, :should_generate, :recipe, :section
+
+      alias_method :generate?, :should_generate
+
+      def initialize(options = {})
+        @purpose = options["purpose"] if options["purpose"]
+        @type = options["type"] if options["type"]
+        @value = options["value"]
+        @should_generate = options["generate"] || false
+        @recipe = GeneratorRecipe.new(options["recipe"])
+        @section = Object.new(options["section"])
+      end
+    end
+  end
+end

data/lib/op_connect/item/file.rb

@@ -0,0 +1,16 @@
+module OpConnect
+  class Item
+    class File
+      attr_reader :id, :name, :size, :content_path, :content, :section
+
+      def initialize(options = {})
+        @id = options["id"]
+        @name = options["name"]
+        @size = options["size"]
+        @content_path = options["content_path"]
+        @content = options["content"]
+        @section = Object.new(options["section"])
+      end
+    end
+  end
+end

data/lib/op_connect/item/generator_recipe.rb

@@ -0,0 +1,12 @@
+module OpConnect
+  class Item
+    class GeneratorRecipe
+      attr_reader :length, :character_sets
+
+      def initialize(options = {})
+        @length = options["length"] if options & ["length"]
+        @character_sets = options["characterSets"] if options & ["characterSets"]
+      end
+    end
+  end
+end

data/lib/op_connect/item/section.rb

@@ -0,0 +1,12 @@
+module OpConnect
+  class Item
+    class Section
+      attr_reader :id, :label
+
+      def initialize(options = {})
+        @id = options["id"]
+        @label = options["label"]
+      end
+    end
+  end
+end

data/lib/op_connect/item/url.rb

@@ -0,0 +1,14 @@
+module OpConnect
+  class Item
+    class URL
+      attr_reader :url, :is_primary
+
+      alias_method :primary?, :is_primary
+
+      def initialize(options = {})
+        @url = options["url"]
+        @is_primary = options["primary"] || false
+      end
+    end
+  end
+end

data/lib/op_connect/item.rb

@@ -0,0 +1,31 @@
+module OpConnect
+  class Item
+    autoload :Field, "op_connect/item/field"
+    autoload :File, "op_connect/item/file"
+    autoload :GeneratorRecipe, "op_connect/item/generator_recipe"
+    autoload :Section, "op_connect/item/section"
+    autoload :URL, "op_connect/item/url"
+
+    attr_reader :id, :title, :vault, :category, :urls, :is_favorite, :tags, :version, :state, :sections, :fields, :files, :created_at, :updated_at, :last_edited_by
+
+    alias_method :favorite?, :is_favorite
+
+    def initialize(options = {})
+      @id = options["id"]
+      @title = options["title"]
+      @vault = Object.new(options["vault"])
+      @category = options["category"]
+      @urls = options["urls"]&.collect! { |url| URL.new(url) }
+      @is_favorite = options["favorite"] || false
+      @tags = options["tags"]
+      @version = options["version"]
+      @state = options["state"]
+      @sections = options["sections"]&.collect! { |section| Section.new(section) } || []
+      @fields = options["fields"]&.collect! { |field| Field.new(field) } || []
+      @files = options["files"]&.collect! { |file| File.new(file) } || []
+      @created_at = options["createdAt"]
+      @updated_at = options["updatedAt"]
+      @last_edited_by = options["lastEditedBy"]
+    end
+  end
+end

data/lib/op_connect/object.rb

@@ -0,0 +1,21 @@
+require "ostruct"
+
+module OpConnect
+  class Object < SimpleDelegator
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    private
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        OpenStruct.new(obj.map { |key, value| [key, to_ostruct(value)] }.to_h)
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else
+        obj
+      end
+    end
+  end
+end

data/lib/op_connect/response/raise_error.rb

@@ -0,0 +1,16 @@
+module OpConnect
+  # Faraday response middleware
+  #
+  module Response
+    # This class raises an OpConnect-flavored exception based on HTTP status
+    # codes returned by the API.
+    #
+    class RaiseError < Faraday::Middleware
+      def on_complete(response)
+        if (error = OpConnect::Error.from_response(response))
+          raise error
+        end
+      end
+    end
+  end
+end

data/lib/op_connect/response.rb

@@ -0,0 +1,5 @@
+module OpConnect
+  module Response
+    autoload :RaiseError, "op_connect/response/raise_error"
+  end
+end

data/lib/op_connect/server_health/dependency.rb

@@ -0,0 +1,13 @@
+module OpConnect
+  class ServerHealth
+    class Dependency
+      attr_reader :service, :status, :message
+
+      def initialize(options = {})
+        @service = options["service"]
+        @status = options["status"]
+        @message = options["message"]
+      end
+    end
+  end
+end

data/lib/op_connect/server_health.rb

@@ -0,0 +1,13 @@
+module OpConnect
+  class ServerHealth
+    autoload :Dependency, "op_connect/server_health/dependency"
+
+    attr_reader :name, :version, :dependencies
+
+    def initialize(options = {})
+      @name = options["name"]
+      @version = options["version"]
+      @dependencies = options["dependencies"]&.collect! { |dependency| Dependency.new(dependency) } || []
+    end
+  end
+end

data/lib/op_connect/vault.rb

@@ -0,0 +1,16 @@
+module OpConnect
+  class Vault
+    attr_reader :id, :name, :attribute_version, :content_version, :items, :type, :created_at, :updated_at
+
+    def initialize(options = {})
+      @id = options["id"]
+      @name = options["name"]
+      @attribute_version = options["attributeVersion"]
+      @content_version = options["contentVersion"]
+      @items = options["items"]
+      @type = options["type"]
+      @created_at = options["createdAt"]
+      @updated_at = options["updatedAt"]
+    end
+  end
+end

data/lib/op_connect/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OpConnect
+  VERSION = "0.1.1"
+end