arweave 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df6c4a7ec670a6671f84a3e7e480eeae4a9169523944c50696d2b46aa5818e26
-  data.tar.gz: 11bfed6127a26a338a28c480b0c6b97490a09bbef275aec75f9fa3a8d9424117
+  metadata.gz: 1b5d27312d0da2f5857127b809dca34c0f1006e313ca0735f3caed5ea8799706
+  data.tar.gz: e089e33e425386c2c09e1a46a775915b2fcc9af70c78cb4836080bbcd672d17a
 SHA512:
-  metadata.gz: accb1b93ee65e402799bcc882d6961327cf51e3dd2492120b6c14c52c882385d13f36754f0440d39f0070847b4fc8da5bba6706d6065f2a55d85ac71c9032253
-  data.tar.gz: 9694281e4f4a6b57f15536f4d779bdd3fdd16833fe864ee7efe5e0d19359c2dcec613c44a099e8917337dfd7425c72b506b36c5ee68df90bf7aa79ae878f100d
+  metadata.gz: 32adbb4d74b2089454c47830e00f8a7ea7d48cda4c04bfe3aa9cd77f6b28a60e5e84bd6c41fcb8a8365fa00f6923fefe44a5360032f75d7e00944c22311cef9e
+  data.tar.gz: 3f5dda23ca893584111fac85393c0d4fafb9406b33ff37e52e5671165724ab517c6ee1f2e0e03671eea276333ff04e8c3f82e1f2753a97e4aa7e72deab2fb81c

data/README.md

@@ -130,3 +130,47 @@ balance.winston.to_i # => 249891527825
 ```ruby
 wallet.last_transaction_id # => "BsHjWHBwSlmW_VgOcgLmsQacQjpohmvVDLMMVyuAkie"
 ```
+
+## Directories
+Directories are an abstract logical grouping around transactions which is implemented using path manifests. For more information, you can take a look at [path manifests](https://github.com/ArweaveTeam/arweave/wiki/Path-Manifests) documentation.
+
+### Create a directory
+To create a directory, first you must have transaction ids you want to put under the new directory and then specify a name for them.
+```ruby
+directory = Arweave::Directory.new(paths: { 'index.html' => 'BsHjWHBwSlmW_VgOcgLmsQacQjpohmvVDLMMVyuAkie' })
+# => #<Arweave::Directory:0x00007ff3400b2350 @paths={...}>
+```
+Then you should get the transaction out of the directory instance and commit it.
+```ruby
+transaction = directory.transaction
+# => #<Arweavev::Transaction:0x00007f9b61299330 @attributes={...}>
+transaction.sign(wallet).commit
+# => #<Arweavev::Transaction:0x00007f9b61299330 @attributes={...}>
+```
+Then you can check your files in the directory using the name you've specified for the files. The endpoint for checking directory files is `/:dir_transaction_id/:filename`. For example
+```
+https:/arweave.net/JxiKsfr2es55AuCTSZg5oJLz7j4phRgireZt5SpChE/index.html
+```
+
+### Directory index
+Arweave creates an HTML file to index your files in a directory, but if you like, you can set one of the files in the paths argument as index file.
+```ruby
+directory =
+  Arweave::Directory.new(
+    index: 'index.html',
+    paths: {
+      'index.html' => 'BsHjWHBwSlmW_VgOcgLmsQacQjpohmvVDLMMVyuAkie',
+      'contact.html' => '-3U2-Oks289pQPH0Umz9Fy0G1Ti2UMlQYIr7NGIYL_M',
+    }
+  ) # => #<Arweave::Directory:0x00007ff3400b2350 @index="...", @paths={...}>
+```
+
+### Adding files to a directory
+You can add files to a directory using the `add` method on a directory instance.
+```ruby
+directory.add('about.html' => 'LhT2WHBwFbv9_Pey67LmsQacQjpZxsyjDLMMVyuAkie')
+# => #<Arweave::Directory:0x00007ff3400b2350 @index="...", @paths={...}>
+```
+**NOTE**: You should add the files to the directory before commiting the transaction,
+else nothing will be added to the directory. In case you want to modify your directory,
+you should create a new transaction for that.

data/arweave.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Arweave SDK}
   spec.description   = %q{Ruby SDK for Arweave decentralized services}
   spec.homepage      = 'https://github.com/LicenseRocks/arweave-ruby'
-  spec.license       = 'GPL v3'
+  spec.license       = 'GPL-3.0'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
 
   spec.metadata['homepage_uri'] = spec.homepage

data/lib/arweave.rb

@@ -3,4 +3,5 @@ require 'arweave/client'
 require 'arweave/api'
 require 'arweave/transaction'
 require 'arweave/wallet'
+require 'arweave/directory'
 require 'arweave/errors'

data/lib/arweave/directory.rb

@@ -0,0 +1,39 @@
+module Arweave
+  class Directory
+    MANIFEST = 'arweave/paths'
+    VERSION = '0.1.0'
+
+    def initialize(index: nil, paths: {})
+      if index && !paths.keys.include?(index)
+        raise PathDoesNotExist.new('`index` path should be included in `paths` argument')
+      end
+
+      @index = index
+      @paths = paths
+    end
+
+    def add(paths)
+      @paths.merge!(paths)
+      self
+    end
+
+    def paths
+      @paths.reduce({}) do |acc, (key, value)|
+        acc.merge(key => { id: value })
+      end
+    end
+
+    def as_json(options = {})
+      {
+        manifest: MANIFEST,
+        version: VERSION,
+        **(@index ? { index: { path: @index } } : {}),
+        paths: paths
+      }
+    end
+
+    def transaction
+      Transaction.new(data: self.to_json).add_tag(name: 'Content-Type', value: 'application/x.arweave-manifest+json')
+    end
+  end
+end

data/lib/arweave/errors.rb

@@ -1,4 +1,5 @@
 module Arweave
   class TransactionNotFound < StandardError; end
   class TransactionNotSigned < StandardError; end
+  class PathDoesNotExist < StandardError; end
 end

data/lib/arweave/version.rb

@@ -1,3 +1,3 @@
 module Arweave
-  VERSION = '1.0.3'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arweave
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Aref Aslani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
+date: 2020-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-jwt
@@ -73,13 +73,14 @@ files:
 - lib/arweave.rb
 - lib/arweave/api.rb
 - lib/arweave/client.rb
+- lib/arweave/directory.rb
 - lib/arweave/errors.rb
 - lib/arweave/transaction.rb
 - lib/arweave/version.rb
 - lib/arweave/wallet.rb
 homepage: https://github.com/LicenseRocks/arweave-ruby
 licenses:
-- GPL v3
+- GPL-3.0
 metadata:
   homepage_uri: https://github.com/LicenseRocks/arweave-ruby
   source_code_uri: https://github.com/LicenseRocks/arweave-ruby