Skip to content

Commit

Permalink
Initial gem setup
Browse files Browse the repository at this point in the history
  • Loading branch information
18bitmood committed Aug 13, 2021
1 parent 01f614b commit f3fbc33
Show file tree
Hide file tree
Showing 11 changed files with 155 additions and 2 deletions.
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/.bundle/
/.yardoc
/_yardoc/
/coverage/
/doc/
/pkg/
/spec/reports/
/tmp/

# rspec failure tracking
.rspec_status
3 changes: 3 additions & 0 deletions .rspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
--format documentation
--color
--require spec_helper
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## [Unreleased]

## [0.1.0] - 2021-08-13

- Initial release
10 changes: 10 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# frozen_string_literal: true

source "https://rubygems.org"

# Specify your gem's dependencies in blockfrostruby.gemspec
gemspec

gem "rake", "~> 13.0"

gem "rspec", "~> 3.0"
37 changes: 35 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,35 @@
# blockfrost-ruby
Ruby SDK for Blockfrost.io
# Blockfrostruby

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/blockfrostruby`. To experiment with that code, run `bin/console` for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'blockfrostruby'
```

And then execute:

$ bundle install

Or install it yourself as:

$ gem install blockfrostruby

## Usage

TODO: Write usage instructions here

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/blockfrostruby.
8 changes: 8 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# frozen_string_literal: true

require "bundler/gem_tasks"
require "rspec/core/rake_task"

RSpec::Core::RakeTask.new(:spec)

task default: :spec
39 changes: 39 additions & 0 deletions blockfrostruby.gemspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# frozen_string_literal: true

require_relative "lib/blockfrostruby/version"

Gem::Specification.new do |spec|
spec.name = "blockfrostruby"
spec.version = Blockfrostruby::VERSION
spec.authors = ["Ivan (https://github.com/18bitmood)"]
spec.email = ["[email protected]"]

spec.summary = "Ruby SDK to work with Blockfrost (Cardano Blockchain API)"
spec.description = "Blockfrost is a hosted API as a service serving the data from the Cardano blockchain.
This gem is Ruby SDK for Blockfrost 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."
spec.homepage = "https://github.com/blockfrost/blockfrost-ruby"
spec.required_ruby_version = ">= 2.4.0"

# spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"

spec.metadata["homepage_uri"] = spec.homepage
spec.metadata["source_code_uri"] = "https://github.com/blockfrost/blockfrost-ruby"
spec.metadata["changelog_uri"] = "https://github.com/blockfrost/blockfrost-ruby/blob/master/CHANGELOG.md"

# Specify which files should be added to the gem when it is released.
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
spec.files = Dir.chdir(File.expand_path(__dir__)) do
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
end
spec.bindir = "exe"
spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
spec.require_paths = ["lib"]

# Uncomment to register a new dependency of your gem
# spec.add_dependency "example-gem", "~> 1.0"

# For more information and examples about making a new gem, checkout our
# guide at: https://bundler.io/guides/creating_gem.html
end
13 changes: 13 additions & 0 deletions lib/blockfrostruby.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# frozen_string_literal: true

require_relative "blockfrostruby/version"

module Blockfrostruby
class Error < StandardError; end

class Check
def self.hi
puts 'Hello world'
end
end
end
5 changes: 5 additions & 0 deletions lib/blockfrostruby/version.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# frozen_string_literal: true

module Blockfrostruby
VERSION = "0.1.0"
end
11 changes: 11 additions & 0 deletions spec/blockfrostruby_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# frozen_string_literal: true

RSpec.describe Blockfrostruby do
it "has a version number" do
expect(Blockfrostruby::VERSION).not_to be nil
end

it "does something useful" do
expect(false).to eq(true)
end
end
15 changes: 15 additions & 0 deletions spec/spec_helper.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# frozen_string_literal: true

require "blockfrostruby"

RSpec.configure do |config|
# Enable flags like --only-failures and --next-failure
config.example_status_persistence_file_path = ".rspec_status"

# Disable RSpec exposing methods globally on `Module` and `main`
config.disable_monkey_patching!

config.expect_with :rspec do |c|
c.syntax = :expect
end
end

0 comments on commit f3fbc33

Please sign in to comment.