tana 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 940bd1cd9810385144c4d2bb50f9ab20dcf6050ebfff71b890b614ec473739d1
+  data.tar.gz: ff0b98fd1ffc5ebad0b926c8cb0670394007a83145bf7cfa9d827c0c3f95d609
+SHA512:
+  metadata.gz: 6e0334319f9672dd5dbfa143e06040701930760785c794a930c99adddd328ff688cf8d9523ec2f4aeaf1eb55c21e76f5bed7862e4bb3eeb3ae9946d4c22a878f
+  data.tar.gz: 0ee14bb0daef1726355c8c7fcab2779b3f7c43fcf0e988207918fc63177824df6d54c42dedaf032cc35cb69ac2d3332b46b796f2a224a6b65aca2d6aa9397f15

checksums.yaml.gz.sig

@@ -0,0 +1,2 @@
+_�8W����D�fs;�	3�d�D�U��?�2�s�����&�L�|I�l/��xf�������2�#���s'��M�2
�eصlr��+����P��/K�r�[(��K�K>���)�+�[s��ɤ:��7fQ��3���ə\|��&���䈱a�F�Qݔ*���;�e�CU-�~>;8�9��$+:оD#�Z��w��@�
+--_�o�؟���s�Fs_���92�6����S��p�c1�^��I��T�JL��J�۩��ۻ75��W]1D�����G$	%����2���H�=5%��z��́��0���t����9�;�M
 
�����x�\�ʒX�����_��o[\�>6�X༐�����l�N21ړy5	�G��!��)

data/LICENSE.adoc

@@ -0,0 +1,134 @@
+= Hippocratic License
+
+Version: 2.1.0.
+
+Purpose. The purpose of this License is for the Licensor named above to
+permit the Licensee (as defined below) broad permission, if consistent
+with Human Rights Laws and Human Rights Principles (as each is defined
+below), to use and work with the Software (as defined below) within the
+full scope of Licensor’s copyright and patent rights, if any, in the
+Software, while ensuring attribution and protecting the Licensor from
+liability.
+
+Permission and Conditions. The Licensor grants permission by this
+license ("License"), free of charge, to the extent of Licensor’s
+rights under applicable copyright and patent law, to any person or
+entity (the "Licensee") obtaining a copy of this software and
+associated documentation files (the "Software"), to do everything with
+the Software that would otherwise infringe (i) the Licensor’s copyright
+in the Software or (ii) any patent claims to the Software that the
+Licensor can license or becomes able to license, subject to all of the
+following terms and conditions:
+
+* Acceptance. This License is automatically offered to every person and
+entity subject to its terms and conditions. Licensee accepts this
+License and agrees to its terms and conditions by taking any action with
+the Software that, absent this License, would infringe any intellectual
+property right held by Licensor.
+* Notice. Licensee must ensure that everyone who gets a copy of any part
+of this Software from Licensee, with or without changes, also receives
+the License and the above copyright notice (and if included by the
+Licensor, patent, trademark and attribution notice). Licensee must cause
+any modified versions of the Software to carry prominent notices stating
+that Licensee changed the Software. For clarity, although Licensee is
+free to create modifications of the Software and distribute only the
+modified portion created by Licensee with additional or different terms,
+the portion of the Software not modified must be distributed pursuant to
+this License. If anyone notifies Licensee in writing that Licensee has
+not complied with this Notice section, Licensee can keep this License by
+taking all practical steps to comply within 30 days after the notice. If
+Licensee does not do so, Licensee’s License (and all rights licensed
+hereunder) shall end immediately.
+* Compliance with Human Rights Principles and Human Rights Laws.
+[arabic]
+. Human Rights Principles.
+[loweralpha]
+.. Licensee is advised to consult the articles of the United Nations
+Universal Declaration of Human Rights and the United Nations Global
+Compact that define recognized principles of international human rights
+(the "Human Rights Principles"). Licensee shall use the Software in a
+manner consistent with Human Rights Principles.
+.. Unless the Licensor and Licensee agree otherwise, any dispute,
+controversy, or claim arising out of or relating to (i) Section 1(a)
+regarding Human Rights Principles, including the breach of Section 1(a),
+termination of this License for breach of the Human Rights Principles,
+or invalidity of Section 1(a) or (ii) a determination of whether any Law
+is consistent or in conflict with Human Rights Principles pursuant to
+Section 2, below, shall be settled by arbitration in accordance with the
+Hague Rules on Business and Human Rights Arbitration (the "Rules");
+provided, however, that Licensee may elect not to participate in such
+arbitration, in which event this License (and all rights licensed
+hereunder) shall end immediately. The number of arbitrators shall be one
+unless the Rules require otherwise.
++
+Unless both the Licensor and Licensee agree to the contrary: (1) All
+documents and information concerning the arbitration shall be public and
+may be disclosed by any party; (2) The repository referred to under
+Article 43 of the Rules shall make available to the public in a timely
+manner all documents concerning the arbitration which are communicated
+to it, including all submissions of the parties, all evidence admitted
+into the record of the proceedings, all transcripts or other recordings
+of hearings and all orders, decisions and awards of the arbitral
+tribunal, subject only to the arbitral tribunal’s powers to take such
+measures as may be necessary to safeguard the integrity of the arbitral
+process pursuant to Articles 18, 33, 41 and 42 of the Rules; and (3)
+Article 26(6) of the Rules shall not apply.
+. Human Rights Laws. The Software shall not be used by any person or
+entity for any systems, activities, or other uses that violate any Human
+Rights Laws. "Human Rights Laws" means any applicable laws,
+regulations, or rules (collectively, "Laws") that protect human,
+civil, labor, privacy, political, environmental, security, economic, due
+process, or similar rights; provided, however, that such Laws are
+consistent and not in conflict with Human Rights Principles (a dispute
+over the consistency or a conflict between Laws and Human Rights
+Principles shall be determined by arbitration as stated above). Where
+the Human Rights Laws of more than one jurisdiction are applicable or in
+conflict with respect to the use of the Software, the Human Rights Laws
+that are most protective of the individuals or groups harmed shall
+apply.
+. Indemnity. Licensee shall hold harmless and indemnify Licensor (and
+any other contributor) against all losses, damages, liabilities,
+deficiencies, claims, actions, judgments, settlements, interest, awards,
+penalties, fines, costs, or expenses of whatever kind, including
+Licensor’s reasonable attorneys’ fees, arising out of or relating to
+Licensee’s use of the Software in violation of Human Rights Laws or
+Human Rights Principles.
+* Failure to Comply. Any failure of Licensee to act according to the
+terms and conditions of this License is both a breach of the License and
+an infringement of the intellectual property rights of the Licensor
+(subject to exceptions under Laws, e.g., fair use). In the event of a
+breach or infringement, the terms and conditions of this License may be
+enforced by Licensor under the Laws of any jurisdiction to which
+Licensee is subject. Licensee also agrees that the Licensor may enforce
+the terms and conditions of this License against Licensee through
+specific performance (or similar remedy under Laws) to the extent
+permitted by Laws. For clarity, except in the event of a breach of this
+License, infringement, or as otherwise stated in this License, Licensor
+may not terminate this License with Licensee.
+* Enforceability and Interpretation. If any term or provision of this
+License is determined to be invalid, illegal, or unenforceable by a
+court of competent jurisdiction, then such invalidity, illegality, or
+unenforceability shall not affect any other term or provision of this
+License or invalidate or render unenforceable such term or provision in
+any other jurisdiction; provided, however, subject to a court
+modification pursuant to the immediately following sentence, if any term
+or provision of this License pertaining to Human Rights Laws or Human
+Rights Principles is deemed invalid, illegal, or unenforceable against
+Licensee by a court of competent jurisdiction, all rights in the
+Software granted to Licensee shall be deemed null and void as between
+Licensor and Licensee. Upon a determination that any term or provision
+is invalid, illegal, or unenforceable, to the extent permitted by Laws,
+the court may modify this License to affect the original purpose that
+the Software be used in compliance with Human Rights Principles and
+Human Rights Laws as closely as possible. The language in this License
+shall be interpreted as to its fair meaning and not strictly for or
+against any party.
+* Disclaimer. TO THE FULL EXTENT ALLOWED BY LAW, THIS SOFTWARE COMES
+"AS IS," WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED, AND LICENSOR AND
+ANY OTHER CONTRIBUTOR SHALL NOT BE LIABLE TO ANYONE FOR ANY DAMAGES OR
+OTHER LIABILITY ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE
+OR THIS LICENSE, UNDER ANY KIND OF LEGAL CLAIM.
+
+This Hippocratic License is an link:https://ethicalsource.dev[Ethical Source license] and is offered
+for use by licensors and licensees at their own risk, on an "AS IS" basis, and with no warranties
+express or implied, to the maximum extent permitted by Laws.

data/README.adoc

@@ -0,0 +1,532 @@
+:toc: macro
+:toclevels: 5
+:figure-caption!:
+
+:api_link: link:https://tana.inc/docs/input-api[Input API]
+:bundler_inline_link: link:https://alchemists.io/articles/ruby_bundler_inline[Bundler Inline]
+:data_link: link:https://alchemists.io/articles/ruby_data[Data]
+:dry_monads_link: link:https://dry-rb.org/gems/dry-monads[Dry Monads]
+:dry_schema_link: link:https://dry-rb.org/gems/dry-schema[Dry Schema]
+:dry_validation_link: link:https://dry-rb.org/gems/dry-validation[Dry Validation]
+:function_composition_link: link:https://alchemists.io/articles/ruby_function_composition[Function Composition]
+:pattern_matching_link: link:https://alchemists.io/articles/ruby_pattern_matching[Pattern Matching]
+:tana_link: link:https://tana.inc[Tana]
+:transactable_link: link:https://alchemists.io/projects/transactable[Transactable]
+
+= Tana
+
+This gem is a monadic API client for the {tana_link} Personal Knowledge Management (PKM) system. This allows you to build more sophisticated workflows atop the {api_link} using a design which leverages {function_composition_link} for a powerful, fault tolerant, workflow.
+
+With this gem, you have a convenient building block to automate your workflows or even use this gem to transfer data from other PKM systems into {tana_link}. 🎉
+
+toc::[]
+
+== Features
+
+* Provides an API client which implements Tana's limited, early access {api_link}.
+* Provides HTTP request and response verification using {dry_schema_link} and {dry_validation_link}.
+* Uses {function_composition_link} -- coupled with {transactable_link} -- to process each HTTP request and response.
+
+== Requirements
+
+. link:https://www.ruby-lang.org[Ruby].
+. {tana_link}.
+
+== Setup
+
+To install _with_ security, run:
+
+[source,bash]
+----
+# 💡 Skip this line if you already have the public certificate installed.
+gem cert --add <(curl --compressed --location https://alchemists.io/projects/tana/gems.pem)
+gem install tana --trust-policy HighSecurity
+----
+
+To install _without_ security, run:
+
+[source,bash]
+----
+gem install tana
+----
+
+You can also add the gem directly to your project:
+
+[source,bash]
+----
+bundle add tana
+----
+
+Once the gem is installed, you only need to require it:
+
+[source,ruby]
+----
+require "tana"
+----
+
+== Usage
+
+All interaction is via a `Tana` instance.
+
+=== Initialization
+
+You can initialize the API client -- using the defaults as described in the _Environment_ section below -- as follows:
+
+[source,ruby]
+----
+client = Tana.new
+----
+
+Further customization can be done via a block:
+
+[source,ruby]
+----
+client = Tana.new do |config|
+  config.accept = "application/json"   # Use custom HTTP header.
+  config.token = "abc123"              # Use custom/personal API key.
+  config.url = "https://api.tana.inc"  # Use custom API root.
+end
+----
+
+=== Environment
+
+Environment variable support can be managed using link:https://direnv.net[direnv]. These are the defaults:
+
+[source,bash]
+----
+TANA_API_ACCEPT=application/json
+TANA_API_TOKEN=
+TANA_API_URL=https://europe-west1-tagr-prod.cloudfunctions.net
+----
+
+_You must provide a `TANA_API_TOKEN` value to make authenticated API requests._ This can be done by creating an API token via the API tokens UI:
+
+image:https://alchemists.io/images/projects/tana/screenshots/api_tokens.png[API Tokens,width=714,height=334,role=focal_point]
+
+Here are the steps to view and make use of the UI shown above:
+
+. Click on _Settings_ within your Tana client.
+. Click on _API tokens_.
+. Click `Create` if you haven't already.
+. Copy and paste your API token as value for `TANA_API_TOKEN` key.
+. Refresh your environment accordingly.
+
+=== Identification
+
+When making API requests, you'll often need to acquire the IDs of the nodes you wish to add. This can be done two ways. The first is by selecting the node you are interested in, using `CONTROL + K` to launch the command prompt, and fuzzy type for _Copy link_. Example:
+
+image:https://alchemists.io/images/projects/tana/screenshots/copy_link.png[Copy Link,width=793,height=512,role=focal_point]
+
+Once copied the URL might look like `https://app.tana.inc?nodeid=z-p8LdQk6I76` but you'll only need the ID (i.e. `z-p8LdQk6I76`) for API requests.
+
+For supertags/fields, you can select the node you are interested in using `CONTROL + K` to launch the command prompt and fuzzy type for _Show API schema_. Example:
+
+image:https://alchemists.io/images/projects/tana/screenshots/show_api_schema.png[Show API Schema,width=578,height=875,role=focal_point]
+
+=== Endpoints
+
+At the moment, {tana_link} only provides the {api_link} which is a single endpoint for adding nodes only. This API has the following limitations:
+
+* Rate Limiting
+** One call per second per token.
+** Max 100 nodes created per call.
+** Max 5,000 characters in one request.
+* Additional Limitations
+** Can't target a relative Today node.
+** Must know the IDs of the supertag.
+** Each payload is capped at five kilobytes.
+** Can't add a checkbox child to a normal node.
+** No support for child templates.
+** No support for in-application links (i.e. anything that is not a http/https scheme).
+
+==== Add
+
+To add nodes (i.e. {api_link}), you only need to send the `#add` message. Here's a quick example of adding a simple node to your {tana_link} Inbox.
+
+[source,ruby]
+----
+client = Tana.new
+
+result = client.add(
+  {
+    targetNodeId: "INBOX",
+    nodes: [
+      {
+        name: "With plain node",
+        description: "A demonstration."
+      }
+    ]
+  }
+)
+
+result
+# Success(#<data Tana::Models::Root children=[#<data Tana::Models::Node id="agite1C3Tben", name="With plain node", description="A demonstration.", type="node", children=[]>]>)
+----
+
+The above will yield the following in your {tana_link} Inbox:
+
+image:https://alchemists.io/images/projects/tana/screenshots/inbox.png[Inbox,width=784,height=517,role=focal_point]
+
+You'll also notice, the result is a monad (i.e. {dry_monads_link}) which means you'll only get a `Success` or `Failure` which you can pipe with additional functionality or use {pattern_matching_link}.
+
+For successes, you'll be given a {data_link} object with a simple Object API for accessing the children of the response. At the root, you'll have a `Tana::Models::Root` instance which can be one or more `Tana::Models::Node` children. When you unpack the `Success` -- and to illustrate further -- you'll end up with the following:
+
+[source,ruby]
+----
+Tana::Models::Root[
+  children: [
+    Tana::Models::Node[
+      id: "agite1C3Tben",
+      name: "With plain node",
+      description: "A demonstration.",
+      type: "node",
+      children: []
+    ]
+  ]
+]
+----
+
+This simplifies and reduces the amount of work you have to do in your own program when processing the API result. For a `Failure`, you either get a `HTTP::Response` or a structured response that is a plain `Hash`. Example:
+
+[source,ruby]
+----
+{
+  "formErrors" => ["Invalid input"],
+  "fieldErrors" => {}
+}
+----
+
+Usually, errors are due to invalid authentication credentials or wrong data format. To experiment further, you can use this {bundler_inline_link} script:
+
+[source,ruby]
+----
+#! /usr/bin/env ruby
+# frozen_string_literal: true
+
+# Save as `demo`, then `chmod 755 demo`, and run as `./demo`.
+
+require "bundler/inline"
+
+gemfile true do
+  source "https://rubygems.org"
+
+  gem "amazing_print"
+  gem "debug"
+  gem "tana"
+end
+
+require "base64"
+
+include Dry::Monads[:result]
+
+render = lambda do |result|
+  case result
+    in Success(record) then puts record
+    in Failure(HTTP::Response => error) then puts error.body
+    in Failure(error) then ap error.errors
+    else abort "Unable to process result."
+  end
+end
+
+client = Tana.new
+----
+
+When you save the above and run it locally, you have a quick way to experiment with the API print out the results by using the `render` function which uses {pattern_matching_link} that I hinted at earlier. The following are additional examples you can experiment with by adding to the above script:
+
+*With Nesting*
+
+The following will allow you to create a deeply nested set of nodes. At the moment, your are limited to ten levels deep due to recursion limitations with the {dry_schema_link} and {dry_validation_link} gems.
+
+[source,ruby]
+----
+render.call client.add(
+  {
+    targetNodeId: "INBOX",
+    nodes: [
+      {
+        name: "One",
+        children: [
+          {
+            name: "Two",
+            children: [
+              {
+                name: "Three",
+                children: [
+                  {
+                    name: "Four",
+                    children: [
+                      {
+                        name: "Five",
+                        children: [
+                          {
+                            name: "Six",
+                            children: [
+                              {
+                                name: "Seven",
+                                children: [
+                                  {
+                                    name: "Eight",
+                                    children: [
+                                      name: "Nine",
+                                      children: [
+                                        {name: "Ten"}
+                                      ]
+                                    ]
+                                  }
+                                ]
+                              }
+                            ]
+                          }
+                        ]
+                      }
+                    ]
+                  }
+                ]
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  }
+)
+----
+
+*With Field*
+
+The following allows you to create a node with a field (_you'll want to replace the attribute ID with your ID_).
+
+[source,ruby]
+----
+render.call client.add(
+  {
+    targetNodeId: "INBOX",
+    nodes: [
+      {
+        name: "With field",
+        description: "A demonstration.",
+        children: [
+          {
+            attributeId: "zM582yzfcs-q",
+            type: "field",
+            children: [
+              {name: "💡 Idea"}
+            ]
+          }
+        ]
+      }
+    ]
+  }
+)
+----
+
+*With Supertags*
+
+The following allows you to create a node with supertags (_you'll want to replace the IDs with your own IDs_).
+
+[source,ruby]
+----
+render.call client.add(
+  {
+    targetNodeId: "INBOX",
+    nodes: [
+      {
+        name: "With supertags",
+        description: "A demonstration.",
+        supertags: [
+          {id: "S9aMn7puHzUT"},
+          {id: "iWKs80kHI0SK"}
+        ]
+      }
+    ]
+  }
+)
+----
+
+*With Reference*
+
+The following will allow you to create a node with a reference to another node (_you'll want to replace with your own ID_):
+
+[source,ruby]
+----
+render.call client.add(
+  {
+    targetNodeId: "INBOX",
+    nodes: [
+      {
+        dataType: "reference",
+        id: "H-vAUdPi8taR"
+      }
+    ]
+  }
+)
+----
+
+*With Date*
+
+The following will allow you to create a node with a date:
+
+[source,ruby]
+----
+render.call client.add(
+  {
+    targetNodeId: "INBOX",
+    nodes: [
+      {
+        dataType: "date",
+        name: "2024-01-01T00:00:00Z"
+      }
+    ]
+  }
+)
+----
+
+*With URL*
+
+The following will allow you to create a node with a URL field (_you'll want to replace with your own ID):
+
+[source,ruby]
+----
+render.call client.add(
+  {
+    targetNodeId: "INBOX",
+    nodes: [
+      {
+        type: "field",
+        attributeId: "OceDtN8c0CbR",
+        children: [
+          {
+            dataType: "url",
+            name: "https://alchemists.io"
+          }
+        ]
+      }
+    ]
+  }
+)
+----
+
+*With Checkbox*
+
+The following will allow you to create a node with a checkbox:
+
+[source,ruby]
+----
+render.call client.add(
+  {
+    targetNodeId: "INBOX",
+    nodes: [
+      {
+        name: "With checkbox",
+        dataType: "boolean",
+        value: true
+      }
+    ]
+  }
+)
+----
+
+*With Attachment*
+
+The following will allow you to create a node with an attachment. This requires the _Base64_ gem as shown required in the script above because you need to encode your attachment before making the API request.
+
+[source,ruby]
+----
+render.call client.add(
+  {
+    targetNodeId: "INBOX",
+    nodes: [
+      {
+        dataType: "file",
+        file: Base64.strict_encode64(Pathname("sunglasses.jpeg").read),
+        filename: "sunglasses.jpeg",
+        contentType: "image/jpeg"
+      }
+    ]
+  }
+)
+----
+
+*With Schema Field*
+
+The following will allow you to create a Schema field:
+
+[source,ruby]
+----
+render.call client.add(
+  {
+    targetNodeId: "SCHEMA",
+    nodes: [
+      {
+        name: "demo",
+        description: "With Schema field.",
+        supertags: [{id: "SYS_T02"}]
+      }
+    ]
+  }
+)
+----
+
+*With Schema Supertag*
+
+The following will allow you to create a Schema supertag:
+
+[source,ruby]
+----
+render.call client.add(
+  {
+    targetNodeId: "SCHEMA",
+    nodes: [
+      {
+        name: "demo",
+        description: "With Schema supertag.",
+        supertags: [{id: "SYS_T01"}]
+      }
+    ]
+  }
+)
+----
+
+== Development
+
+To contribute, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/tana
+cd tana
+bin/setup
+----
+
+You can also use the IRB console for direct access to all objects:
+
+[source,bash]
+----
+bin/console
+----
+
+== Tests
+
+To test, run:
+
+[source,bash]
+----
+bin/rake
+----
+
+== link:https://alchemists.io/policies/license[License]
+
+== link:https://alchemists.io/policies/security[Security]
+
+== link:https://alchemists.io/policies/code_of_conduct[Code of Conduct]
+
+== link:https://alchemists.io/policies/contributions[Contributions]
+
+== link:https://alchemists.io/projects/tana/versions[Versions]
+
+== link:https://alchemists.io/community[Community]
+
+== Credits
+
+* Built with link:https://alchemists.io/projects/gemsmith[Gemsmith].
+* Engineered by link:https://alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].

data/lib/tana/api/client.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+
+module Tana
+  module API
+    # A low-level API client for making basic HTTP requests.
+    class Client
+      include Import[:configuration, :http]
+      include Dry::Monads[:result]
+
+      def post path, body = nil, **parameters
+        call __method__, path, json: body, params: parameters
+      end
+
+      private
+
+      def call method, path, **options
+        http.auth("Bearer #{configuration.token}")
+            .headers(accept: configuration.accept)
+            .public_send(method, "#{configuration.url}/#{path}", options)
+            .then { |response| response.status.success? ? Success(response) : Failure(response) }
+      end
+    end
+  end
+end