blockfrost-ruby 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ce10dc5e5d7b6c656d0f0103447d52ce0bb746ba5a39bcc2821b9d249aba333
-  data.tar.gz: 7658854a8f655919f872141870fbf95d76ee9849ea362ae9dd4b0a20848bcd60
+  metadata.gz: f6409f9244d146bc02002c7f9add828de36d1564fdabfdae1cc51d2016c16608
+  data.tar.gz: 73521600b8d9a2895333178706bd151a8c6e5f5d412a3901e067640a12913f06
 SHA512:
-  metadata.gz: 7c7ab31fb74e3a6c61b5beda94efdca316f2188e06b42799f8ff25106795850be54b110ae202165d679f68010607893645b01a979dca9e0c70b5fd1744e1cce8
-  data.tar.gz: 4481bf4742675a24b4d2049d4f88fdeaf996769bb7190ee452c46177651125e3f2c521b54ecf20dfb233efbc6a9d3fc4fb93ea66f82279dccbf9e02ea10cd84d
+  metadata.gz: 21b47ca521f021b62e2afaaf3b0244b3f1c48af14c773d34875a6635b0885734ae2d5fd26dfc2f93fb00d4a55d81a66bc3b2de7c7bc20ce89c10e1949c346c8a
+  data.tar.gz: 9ed16e266632b2c95bbe6940e2895429cc27516cc7eca3bacadad63cdc5dccec34306a0e2462beaefb88f24a1ecac655ef9c3303bbc35bd5c73e6c2b0d5d300a

data/.env.example

@@ -0,0 +1,3 @@
+BF_IPFS_PROJECT_ID=
+BF_MAINNET_PROJECT_ID=
+BF_TESTNET_PROJECT_ID=

data/.github/workflows/nix.yaml

@@ -0,0 +1,13 @@
+name: "Nix build"
+on:
+  pull_request:
+  push:
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: cachix/install-nix-action@v18
+      with:
+        nix_path: nixpkgs=channel:nixos-unstable
+    - run: nix-build

data/.gitignore

@@ -9,6 +9,7 @@
 
 *.gem
 *.lock
+*.env
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -5,7 +5,7 @@ AllCops:
 # Metrics
 
 Metrics/BlockLength:
-  Max: 240
+  Max: 350
 
 Metrics/MethodLength:
   Max: 30
@@ -37,3 +37,6 @@ Naming/AccessorMethodName:
 
 Layout/LineLength:
   Max: 150
+
+Naming/FileName:
+  Enabled: false

data/Gemfile

@@ -5,6 +5,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in blockfrostruby.gemspec
 gemspec
 
+gem 'dotenv'
 gem 'rake', '~> 13.0'
 gem 'rspec', '~> 3.0'
-gem 'webmock'

data/README.md

@@ -1,21 +1,28 @@
-# Blockfrostruby
+[![Gem Version](https://badge.fury.io/rb/blockfrost-ruby.svg)](https://rubygems.org/gems/blockfrost-ruby)  <a href="https://fivebinaries.com/"><img src="https://img.shields.io/badge/made%20by-Five%20Binaries-darkviolet.svg?style=flat-square" /></a>
 
-Ruby SDK to work with Blockfrost (Cardano Blockchain API)
-Blockfrost is a hosted API as a service serving the data from the Cardano blockchain.
-This gem is Ruby SDK for Blockfrost.io to enable developers
-to use full power of this API without having to create basic functions for it.
-The OpenAPI documentation is hosted at https://github.com/blockfrost/openapi.\
-This gem is licensed under ASL 2.0.
+<img src="https://blockfrost.io/images/logo.svg" width="250" align="right" height="90">
+
+# blockfrost-ruby
+
+<br/>
+
+<p align="center">Ruby SDK for <a href="https://blockfrost.io">Blockfrost.io</a> API.</p>
+<p align="center">
+  <a href="#installation">Installation</a> •
+  <a href="#usage">Usage</a> •
+  <a href="#development">Development</a>
+</p>
+<br>
 
-More information about using this API can be found on https://docs.blockfrost.io/
 ## Installation
 
-For now, it's not hosted on a RubyGems,
-so you can install this SDK only from this repo.
+You can download the latest release directly from rubygems.org:
+
+    $ gem install blockfrost-ruby
 
-To do this, download this repo to your machine, then go to the directory:
+To build the current master, download this repo to your machine, then go to the directory:
 
-    $ cd path-to-dir-with-this-repo
+    $ cd blockfrost-ruby
 
 And run next commands:
 
@@ -78,6 +85,8 @@ blockfrost_mainnet = Blockfrostruby::CardanoMainNet.new('your-API-key')
 # Or if you want to access other networks: 
 
 blockfrost_testnet = Blockfrostruby::CardanoTestNet.new('your-API-key')
+blockfrost_preview = Blockfrostruby::CardanoPreview.new('your-API-key')
+blockfrost_preprod = Blockfrostruby::CardanoPreprod.new('your-API-key')
 blockfrost_ipfs = Blockfrostruby::IPFS.new('your-API-key')
 
 
@@ -131,4 +140,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/blockfrost/blockfrostruby.
+Bug reports and pull requests are welcome on GitHub at https://github.com/blockfrost/blockfrost-ruby.

data/default.nix

@@ -0,0 +1,16 @@
+with import <nixpkgs> {};
+let
+  gems = bundlerEnv {
+    name = "blockfrost-ruby";
+    inherit ruby;
+    gemdir  = ./.;
+  };
+in stdenv.mkDerivation {
+  name = "blockfrost-ruby";
+  src = ./.;
+
+  installPhase = ''
+    mkdir -p $out
+    cp -r $src $out
+  '';
+}

data/gemset.nix

@@ -0,0 +1,95 @@
+{
+  blockfrost-ruby = {
+    groups = ["default"];
+    platforms = [];
+    source = {
+      path = ./.;
+      type = "path";
+    };
+    version = "0.1.1";
+  };
+  diff-lcs = {
+    groups = ["default"];
+    platforms = [];
+    source = {
+      remotes = ["https://rubygems.org"];
+      sha256 = "0rwvjahnp7cpmracd8x732rjgnilqv2sx7d1gfrysslc3h039fa9";
+      type = "gem";
+    };
+    version = "1.5.0";
+  };
+  dotenv = {
+    groups = ["default"];
+    platforms = [];
+    source = {
+      remotes = ["https://rubygems.org"];
+      sha256 = "1n0pi8x8ql5h1mijvm8lgn6bhq4xjb5a500p5r1krq4s6j9lg565";
+      type = "gem";
+    };
+    version = "2.8.1";
+  };
+  rake = {
+    groups = ["default"];
+    platforms = [];
+    source = {
+      remotes = ["https://rubygems.org"];
+      sha256 = "15whn7p9nrkxangbs9hh75q585yfn66lv0v2mhj6q6dl6x8bzr2w";
+      type = "gem";
+    };
+    version = "13.0.6";
+  };
+  rspec = {
+    dependencies = ["rspec-core" "rspec-expectations" "rspec-mocks"];
+    groups = ["default"];
+    platforms = [];
+    source = {
+      remotes = ["https://rubygems.org"];
+      sha256 = "171rc90vcgjl8p1bdrqa92ymrj8a87qf6w20x05xq29mljcigi6c";
+      type = "gem";
+    };
+    version = "3.12.0";
+  };
+  rspec-core = {
+    dependencies = ["rspec-support"];
+    groups = ["default"];
+    platforms = [];
+    source = {
+      remotes = ["https://rubygems.org"];
+      sha256 = "1ibb81slc35q5yp276sixp3yrvj9q92wlmi1glbnwlk6g49z8rn4";
+      type = "gem";
+    };
+    version = "3.12.0";
+  };
+  rspec-expectations = {
+    dependencies = ["diff-lcs" "rspec-support"];
+    groups = ["default"];
+    platforms = [];
+    source = {
+      remotes = ["https://rubygems.org"];
+      sha256 = "0qldsmjhqr4344zdlamzggr3y98wdk2c4hihkhwx8imk800gkl8v";
+      type = "gem";
+    };
+    version = "3.12.0";
+  };
+  rspec-mocks = {
+    dependencies = ["diff-lcs" "rspec-support"];
+    groups = ["default"];
+    platforms = [];
+    source = {
+      remotes = ["https://rubygems.org"];
+      sha256 = "1yvwnb0x5d6d4ff3wlgahk0wcw72ic51gd2snr1xxc5ify41kabv";
+      type = "gem";
+    };
+    version = "3.12.0";
+  };
+  rspec-support = {
+    groups = ["default"];
+    platforms = [];
+    source = {
+      remotes = ["https://rubygems.org"];
+      sha256 = "12y52zwwb3xr7h91dy9k3ndmyyhr3mjcayk0nnarnrzz8yr48kfx";
+      type = "gem";
+    };
+    version = "3.12.0";
+  };
+}

data/lib/blockfrost-ruby.rb

@@ -79,6 +79,32 @@ module Blockfrostruby
     end
   end
 
+  class CardanoPreview < CardanoMainNet
+    # Create an instanse of CardanoPreview object.
+    # Using of SDK is a calling methods on such object.
+    #
+    # @param project_id [String] the project_id from API
+    # @param config [Hash] a config with params: use_asc_order_as_default, default_count_per_page, parallel_requests, sleep_between_retries_ms
+    # @return [Object] with attr_reader :config, :project_id, :url
+    def initialize(project_id, config = {})
+      super
+      @url = CARDANO_PREVIEW_URL
+    end
+  end
+
+  class CardanoPreprod < CardanoMainNet
+    # Create an instanse of CardanoPreprod object.
+    # Using of SDK is a calling methods on such object.
+    #
+    # @param project_id [String] the project_id from API
+    # @param config [Hash] a config with params: use_asc_order_as_default, default_count_per_page, parallel_requests, sleep_between_retries_ms
+    # @return [Object] with attr_reader :config, :project_id, :url
+    def initialize(project_id, config = {})
+      super
+      @url = CARDANO_PREPROD_URL
+    end
+  end
+
   class IPFS < Net
     include IPFSEndpoints
 

data/lib/blockfrostruby/constants.rb

@@ -2,6 +2,8 @@
 
 CARDANO_MAINNET_URL = 'https://cardano-mainnet.blockfrost.io/api/v0'
 CARDANO_TESTNET_URL = 'https://cardano-testnet.blockfrost.io/api/v0'
+CARDANO_PREVIEW_URL = 'https://cardano-preview.blockfrost.io/api/v0'
+CARDANO_PREPROD_URL = 'https://cardano-preprod.blockfrost.io/api/v0'
 IPFS_URL = 'https://ipfs.blockfrost.io/api/v0'
 
 MAX_COUNT_PER_PAGE = 100

data/lib/blockfrostruby/endpoints/cardano/accounts_endpoints.rb

@@ -54,7 +54,7 @@ module AccountsEndpoints
   # @return [Hash] formatted result with status and body keys.
   def get_account_registrations(address, params = {})
     params = Params.define_params(params, @config)
-    Request.get_response("#{@url}/accounts/#{address}/registations", @project_id, params)
+    Request.get_response("#{@url}/accounts/#{address}/registrations", @project_id, params)
   end
 
   # Calls get request on (@url)/accounts/(address)/withdrawals.
@@ -82,9 +82,9 @@ module AccountsEndpoints
   # @param address [String] will be added to the url for get request.
   # @param params [Hash] - params passed by user.
   # @return [Hash] formatted result with status and body keys.
-  def get_account_addresses(address, params = {})
+  def get_account_assosiated_addresses(address, params = {})
     params = Params.define_params(params, @config)
-    Request.get_response("#{@url}/accounts/#{address}/addresses", @project_id, params, @config)
+    Request.get_response("#{@url}/accounts/#{address}/addresses", @project_id, params)
   end
 
   # Calls get request on (@url)/accounts/(address)/addresses/assets.

data/lib/blockfrostruby/endpoints/cardano/addresses_endpoints.rb

@@ -13,7 +13,7 @@ module AddressesEndpoints
   #
   # @param address [String] will be added to the url for get request.
   # @return [Hash] formatted result with status and body keys.
-  def get_address(address)
+  def get_specific_address(address)
     Request.get_response("#{@url}/addresses/#{address}", @project_id)
   end
 

data/lib/blockfrostruby/endpoints/cardano/assets_endpoints.rb

@@ -23,9 +23,8 @@ module AssetsEndpoints
   # @param asset [String] will be added to the url for get request.
   # @param params [Hash] - params passed by user.
   # @return [Hash] formatted result with status and body keys.
-  def get_asset(asset, params = {})
-    params = Params.define_params(params, @config)
-    Request.get_response("#{@url}/assets/#{asset}", @project_id, params)
+  def get_specific_asset(asset)
+    Request.get_response("#{@url}/assets/#{asset}", @project_id)
   end
 
   # Calls get request on (@url)/assets/(asset)/history.

data/lib/blockfrostruby/endpoints/cardano/epochs_endpoints.rb

@@ -29,9 +29,8 @@ module EpochsEndpoints
   # @param epoch_number [String] will be added to the url for get request.
   # @param params [Hash] - params passed by user.
   # @return [Hash] formatted result with status and body keys.
-  def get_epoch(epoch_number, params = {})
-    params = Params.define_params(params, @config)
-    Request.get_response("#{@url}/epochs/#{epoch_number}", @project_id, params)
+  def get_epoch(epoch_number)
+    Request.get_response("#{@url}/epochs/#{epoch_number}", @project_id)
   end
 
   # Calls get request on (@url)/epochs/(epoch_number)/next.

data/lib/blockfrostruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Blockfrostruby
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/shell.nix

@@ -0,0 +1,12 @@
+with (import <nixpkgs> {});
+let
+  ruby = ruby_3_1;
+  env = bundlerEnv {
+    name = "blockfrost-ruby-env";
+    inherit ruby;
+    gemdir = ./.;
+  };
+in stdenv.mkDerivation {
+  name = "blockfrost-ruby";
+  buildInputs = [ env ruby nodejs git rubyPackages_3_1.rake rubyPackages_3_1.rspec ];
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blockfrost-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ivan (https://github.com/18bitmood)
@@ -22,6 +22,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.example"
+- ".github/workflows/nix.yaml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -31,6 +33,8 @@ files:
 - README.md
 - Rakefile
 - blockfrost-ruby.gemspec
+- default.nix
+- gemset.nix
 - lib/blockfrost-ruby.rb
 - lib/blockfrostruby/config.yml
 - lib/blockfrostruby/configuration.rb
@@ -54,6 +58,7 @@ files:
 - lib/blockfrostruby/request.rb
 - lib/blockfrostruby/validator.rb
 - lib/blockfrostruby/version.rb
+- shell.nix
 homepage: https://github.com/blockfrost/blockfrost-ruby
 licenses: []
 metadata:
@@ -75,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.2.26
 signing_key:
 specification_version: 4
 summary: Ruby SDK to work with Blockfrost (Cardano Blockchain API)