Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v1.9.0 update #9

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
PATH
remote: .
specs:
uplink-ruby (1.9.0)
ffi (~> 1.15.0)

GEM
remote: https://rubygems.org/
specs:
diff-lcs (1.5.0)
ffi (1.15.5)
rspec (3.12.0)
rspec-core (~> 3.12.0)
rspec-expectations (~> 3.12.0)
rspec-mocks (~> 3.12.0)
rspec-core (3.12.0)
rspec-support (~> 3.12.0)
rspec-expectations (3.12.2)
diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.12.0)
rspec-mocks (3.12.2)
diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.12.0)
rspec-support (3.12.0)

PLATFORMS
x86_64-linux

DEPENDENCIES
rspec (~> 3.12.0)
uplink-ruby!

BUNDLED WITH
2.3.26
26 changes: 10 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# <b>Uplink-Ruby</b>

Ruby bindings to the [libuplink](https://github.com/storj/uplink-c) Storj API library.
Ruby bindings to the Storj C library (libuplink/uplink-c).

## <b> Getting Started </b>

### Prerequisites
* Clone [uplink-c](https://github.com/storj/uplink-c) repository.
* Check out the release version `v1.8.0`.
* Check out the release version `v1.9.0`.
```bash
$ git fetch --tags
$ git checkout tags/v1.8.0
$ git checkout tags/v1.9.0
```
* Run `make build` to build the uplink-c library.
* The `libuplink.so` file should be created in the `.build` folder.
* Add the `libuplink.so` location path into `LD_LIBRARY_PATH` environment variable
* Add the `libuplink.so` location path into `LD_LIBRARY_PATH` environment variable.
```bash
$ export LD_LIBRARY_PATH=<libuplink.so_folder_path>:$LD_LIBRARY_PATH
```
Expand All @@ -23,42 +23,36 @@ Ruby bindings to the [libuplink](https://github.com/storj/uplink-c) Storj API li
Add this line to your application's Gemfile:

```ruby
gem 'uplink-ruby', '~> 1.8.0'
```

or from the git:

```ruby
gem 'uplink-ruby', git: 'https://github.com/storj-thirdparty/uplink-ruby', tag: 'v1.8.0'
gem 'uplink-ruby', git: 'https://github.com/storj-thirdparty/uplink-ruby', tag: 'v1.9.0'
```

Make sure the major & minor version of the gem or git tag matches the uplink-c release version.


### Running the Tests
* Create a [Storj](https://www.storj.io/) account.
* In the Storj Dashboard, create an Access Grant and set the access grant key to `UPLINK_0_ACCESS` environment variable
* In the Storj Dashboard, create an Access Grant key, and set the Access Grant key to `UPLINK_0_ACCESS` environment variable.

```bash
$ export UPLINK_0_ACCESS="15W8fjomdWMwh4cdbZx5YmDQpQsc8EN..."
```
* Create a Storj CLI Access key, which consists of Satellite Address and API key, and set them to `UPLINK_0_SATELLITE_ADDR` and `UPLINK_0_APIKEY` environment variables
* Create a Storj CLI Access key, which consists of Satellite Address and API key, and set them to `UPLINK_0_SATELLITE_ADDR` and `UPLINK_0_APIKEY` environment variables.
```bash
$ export UPLINK_0_SATELLITE_ADDR="125WTSDqyNZVcEU95Tbdf..."
$ export UPLINK_0_APIKEY="11MKmbWfdCCVzgCso5reTK..."
```
* Create a passphrase and set it to `UPLINK_0_PASSPHRASE` environment variable
* Create a passphrase and set it to `UPLINK_0_PASSPHRASE` environment variable.
```bash
$ export UPLINK_0_PASSPHRASE="mypassphrase"
```

* Install gem dependencies
* Install gem dependencies.

```bash
$ bundle install
```

* Run the tests
* Run the tests.
```bash
$ rspec
```
Expand Down
22 changes: 11 additions & 11 deletions uplink-ruby.gemspec
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# frozen_string_literal: true

Gem::Specification.new do |s|
s.name = 'uplink-ruby'
s.version = '1.8.0'
s.summary = 'libuplink bindings for ruby'
s.description = 'Ruby bindings to the libuplink C Storj API library'
s.authors = ['Your Data Inc']
s.homepage = 'https://github.com/storj-thirdparty/uplink-ruby'
s.license = 'MIT'
s.files = Dir['lib/**/*.rb']
s.required_ruby_version = '>= 2.6.0'
s.add_runtime_dependency 'ffi', '~> 1.15.0'
s.add_development_dependency 'rspec', '~> 3.12.0'
s.name = "uplink-ruby"
s.version = "1.9.0"
s.summary = "libuplink bindings for ruby"
s.description = "Ruby bindings to the Storj C library"
s.authors = ["Your Data Inc"]
s.homepage = "https://github.com/storj-thirdparty/uplink-ruby"
s.license = "MIT"
s.files = Dir["lib/**/*.rb"]
s.required_ruby_version = ">= 2.6.0"
s.add_runtime_dependency "ffi", "~> 1.15.0"
s.add_development_dependency "rspec", "~> 3.12.0"
end