From 465033fac36c57f5fbbc7fd9f2e6f1e261e68851 Mon Sep 17 00:00:00 2001 From: ZippyDev Date: Wed, 15 Jul 2020 19:36:16 -0600 Subject: [PATCH] initial commit. --- .gitignore | 11 +++++ .rspec | 3 ++ .rubocop.yml | 19 +++++++++ .travis.yml | 6 +++ Gemfile | 9 ++++ Gemfile.lock | 99 +++++++++++++++++++++++++++++++++++++++++++ LICENSE.txt | 21 +++++++++ README.md | 40 +++++++++++++++++ Rakefile | 8 ++++ bin/console | 10 +++++ bin/setup | 8 ++++ btcpay.gemspec | 37 ++++++++++++++++ lib/btcpay.rb | 8 ++++ lib/btcpay/version.rb | 5 +++ spec/btcpay_spec.rb | 11 +++++ spec/spec_helper.rb | 16 +++++++ 16 files changed, 311 insertions(+) create mode 100644 .gitignore create mode 100644 .rspec create mode 100644 .rubocop.yml create mode 100644 .travis.yml create mode 100644 Gemfile create mode 100644 Gemfile.lock create mode 100644 LICENSE.txt create mode 100644 README.md create mode 100644 Rakefile create mode 100755 bin/console create mode 100755 bin/setup create mode 100644 btcpay.gemspec create mode 100644 lib/btcpay.rb create mode 100644 lib/btcpay/version.rb create mode 100644 spec/btcpay_spec.rb create mode 100644 spec/spec_helper.rb diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b04a8c8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +/.bundle/ +/.yardoc +/_yardoc/ +/coverage/ +/doc/ +/pkg/ +/spec/reports/ +/tmp/ + +# rspec failure tracking +.rspec_status diff --git a/.rspec b/.rspec new file mode 100644 index 0000000..34c5164 --- /dev/null +++ b/.rspec @@ -0,0 +1,3 @@ +--format documentation +--color +--require spec_helper diff --git a/.rubocop.yml b/.rubocop.yml new file mode 100644 index 0000000..7fb51b3 --- /dev/null +++ b/.rubocop.yml @@ -0,0 +1,19 @@ +AllCops: + TargetRubyVersion: 2.7 + Exclude: + - 'bin/**/*' +Documentation: + Enabled: false +LineLength: + Max: 120 +Style/RaiseArgs: + EnforcedStyle: compact +Metrics/AbcSize: + Enabled: false +Metrics/MethodLength: + Max: 25 +Lint/Debugger: + Enabled: false +Metrics/BlockLength: + Exclude: + - 'spec/**/*.rb' diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..4c5a5bb --- /dev/null +++ b/.travis.yml @@ -0,0 +1,6 @@ +--- +language: ruby +cache: bundler +rvm: + - 2.7.1 +before_install: gem install bundler -v 2.1.4 diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..a02c770 --- /dev/null +++ b/Gemfile @@ -0,0 +1,9 @@ +# frozen_string_literal: true + +source 'https://rubygems.org' + +# Specify your gem's dependencies in btcpay.gemspec +gemspec + +gem 'rake', '~> 12.0' +gem 'rspec', '~> 3.0' diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000..3d039cd --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,99 @@ +PATH + remote: . + specs: + btcpay (0.1.0) + flexirest (~> 1.9, < 2.0) + +GEM + remote: https://rubygems.org/ + specs: + activesupport (6.0.3.2) + concurrent-ruby (~> 1.0, >= 1.0.2) + i18n (>= 0.7, < 2) + minitest (~> 5.1) + tzinfo (~> 1.1) + zeitwerk (~> 2.2, >= 2.2.2) + ast (2.4.1) + coderay (1.1.3) + concurrent-ruby (1.1.6) + crack (0.4.3) + safe_yaml (~> 1.0.0) + diff-lcs (1.4.4) + docile (1.3.2) + faraday (1.0.1) + multipart-post (>= 1.2, < 3) + flexirest (1.9.16) + activesupport + crack + faraday + mime-types + multi_json + i18n (1.8.3) + concurrent-ruby (~> 1.0) + method_source (1.0.0) + mime-types (3.3.1) + mime-types-data (~> 3.2015) + mime-types-data (3.2020.0512) + minitest (5.14.1) + multi_json (1.15.0) + multipart-post (2.1.1) + parallel (1.19.2) + parser (2.7.1.4) + ast (~> 2.4.1) + pry (0.13.1) + coderay (~> 1.1) + method_source (~> 1.0) + rainbow (3.0.0) + rake (12.3.3) + regexp_parser (1.7.1) + rexml (3.2.4) + rspec (3.9.0) + rspec-core (~> 3.9.0) + rspec-expectations (~> 3.9.0) + rspec-mocks (~> 3.9.0) + rspec-core (3.9.2) + rspec-support (~> 3.9.3) + rspec-expectations (3.9.2) + diff-lcs (>= 1.2.0, < 2.0) + rspec-support (~> 3.9.0) + rspec-mocks (3.9.1) + diff-lcs (>= 1.2.0, < 2.0) + rspec-support (~> 3.9.0) + rspec-support (3.9.3) + rubocop (0.88.0) + parallel (~> 1.10) + parser (>= 2.7.1.1) + rainbow (>= 2.2.2, < 4.0) + regexp_parser (>= 1.7) + rexml + rubocop-ast (>= 0.1.0, < 1.0) + ruby-progressbar (~> 1.7) + unicode-display_width (>= 1.4.0, < 2.0) + rubocop-ast (0.1.0) + parser (>= 2.7.0.1) + ruby-progressbar (1.10.1) + safe_yaml (1.0.5) + simplecov (0.18.5) + docile (~> 1.1) + simplecov-html (~> 0.11) + simplecov-html (0.12.2) + thread_safe (0.3.6) + tzinfo (1.2.7) + thread_safe (~> 0.1) + unicode-display_width (1.7.0) + zeitwerk (2.4.0) + +PLATFORMS + ruby + +DEPENDENCIES + btcpay! + bundler (~> 2.0) + pry (> 0) + rake (~> 12.0) + rspec (~> 3.0) + rubocop (> 0) + simplecov (> 0) + +BUNDLED WITH + 2.1.4 diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..7234375 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2020 ZippyDev + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..db66b81 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# Btcpay Server + +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/btcpay`. 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 'btcpay' +``` + +And then execute: + + $ bundle install + +Or install it yourself as: + + $ gem install btcpay + +## 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 tags, 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]/btcpay. + + +## License + +The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..82bb534 --- /dev/null +++ b/Rakefile @@ -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 diff --git a/bin/console b/bin/console new file mode 100755 index 0000000..13460e4 --- /dev/null +++ b/bin/console @@ -0,0 +1,10 @@ +#!/usr/bin/env ruby + +require 'bundler/setup' +require 'btcpay' + +# You can add fixtures and/or initialization code here to make experimenting +# with your gem easier. You can also use a different console, if you like. + +require 'pry' +Pry.start diff --git a/bin/setup b/bin/setup new file mode 100755 index 0000000..dce67d8 --- /dev/null +++ b/bin/setup @@ -0,0 +1,8 @@ +#!/usr/bin/env bash +set -euo pipefail +IFS=$'\n\t' +set -vx + +bundle install + +# Do any other automated setup that you need to do here diff --git a/btcpay.gemspec b/btcpay.gemspec new file mode 100644 index 0000000..a213dd3 --- /dev/null +++ b/btcpay.gemspec @@ -0,0 +1,37 @@ +# frozen_string_literal: true + +require_relative 'lib/btcpay/version' + +Gem::Specification.new do |spec| + spec.name = 'btcpay' + spec.version = Btcpay::VERSION + spec.authors = ['snogrammer'] + spec.email = ['btcpay-gem@snogram.com'] + + spec.summary = 'BTCPay Server v1 API wrapper. Be your own Bitpay!' + spec.homepage = 'https://docs.btcpayserver.org/API/Greenfield/v1/' + spec.license = 'MIT' + spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0') + + spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'" + + spec.metadata['homepage_uri'] = spec.homepage + spec.metadata['source_code_uri'] = 'https://gitlab.com/snogrammer/btpay' + spec.metadata['changelog_uri'] = 'https://gitlab.com/snogrammer/btpay/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{^(test|spec|features)/}) } + end + spec.bindir = 'exe' + spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) } + spec.require_paths = ['lib'] + + spec.add_dependency 'flexirest', '~> 1.9', '< 2.0' + + spec.add_development_dependency 'bundler', '~> 2.0' + spec.add_development_dependency 'pry', '> 0' + spec.add_development_dependency 'rubocop', '> 0' + spec.add_development_dependency 'simplecov', '> 0' +end diff --git a/lib/btcpay.rb b/lib/btcpay.rb new file mode 100644 index 0000000..bbb3d4b --- /dev/null +++ b/lib/btcpay.rb @@ -0,0 +1,8 @@ +# frozen_string_literal: true + +require 'btcpay/version' + +module Btcpay + class Error < StandardError; end + # Your code goes here... +end diff --git a/lib/btcpay/version.rb b/lib/btcpay/version.rb new file mode 100644 index 0000000..2262fb8 --- /dev/null +++ b/lib/btcpay/version.rb @@ -0,0 +1,5 @@ +# frozen_string_literal: true + +module Btcpay + VERSION = '0.1.0' +end diff --git a/spec/btcpay_spec.rb b/spec/btcpay_spec.rb new file mode 100644 index 0000000..a5abc27 --- /dev/null +++ b/spec/btcpay_spec.rb @@ -0,0 +1,11 @@ +# frozen_string_literal: true + +RSpec.describe Btcpay do + it 'has a version number' do + expect(Btcpay::VERSION).not_to be nil + end + + it 'does something useful' do + expect(false).to eq(true) + end +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb new file mode 100644 index 0000000..0cd80a0 --- /dev/null +++ b/spec/spec_helper.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +require 'bundler/setup' +require 'btcpay' + +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