ipfs_public_gateway_checker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 924f869e9bb4c80049a1d71184b9b36bdadf66ccb6d6420e4a8dce6ba612afdc
+  data.tar.gz: b3a3fe1272bf74d2c014c6c00d01dffaffa92d29b60bfb8dbb352226cb4d52f7
+SHA512:
+  metadata.gz: 26b8ad1534688c69e64efc3a1c4dfd230c5678e4ec314456c8255a7a34b67c25fa1c6bb777d4ad906de30d3e6a260f57057b527aa6dcd3f1653aae72e236f34e
+  data.tar.gz: 6a018ef87a4fc43a83fad795377b433c3e7ebe0d0dda2d526ac7026bb79d4d6500d60cd2472fc4444be381cfbf3726367025b21ae9363e6e8f0645870901d9b3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at idegorepl@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/README.md

@@ -0,0 +1,53 @@
+# IPFS Public Gateway Checker
+
+This's a Golang version which migrates from:
+
+* [public-gateway-checker](https://github.com/ipfs/public-gateway-checker) An online webpage of JS version
+* [ipfg](https://github.com/JayBrown/Tools/tree/master/ipfg)  A shell cli version
+* [ipfg](https://github.com/gingerhot/ipfg)  A Golang version
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ipfs_public_gateway_checker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ipfs_public_gateway_checker
+
+## Usage
+
+After installation, there will be a command `ipfg` available for you.
+
+```bash
+ipfg        # to get one available gateway url for you
+ipfg all    # get all available gateway urls
+ipfg help   # show help message
+```
+And you can require the gem in your code, just as what I do in the [bin/ipfg](./bin/ipfg).
+There're two methods for you: `get()` and `active_list()`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/beijingrb/ipfs_public_gateway_checker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the IpfsPublicGatewayChecker project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/beijingrb/ipfs_public_gateway_checker/blob/master/CODE_OF_CONDUCT.md).

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ipfs_public_gateway_checker"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/ipfg

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require 'ipfs_public_gateway_checker'
+
+def help
+  puts <<USAGE
+ipfg - A command line to get available IPFS public gateway list
+
+Usage: "ipfg"      to get maybe the fastest one of gateways
+       "ipfg all"  to get all available gateways
+USAGE
+end
+
+if ARGV.length == 0
+  puts IpfsPublicGatewayChecker.get
+elsif ARGV.length == 1 && ARGV[0] == 'all'
+  puts IpfsPublicGatewayChecker.active_list
+else
+  help
+end

data/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

data/ipfs_public_gateway_checker.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ipfs_public_gateway_checker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ipfs_public_gateway_checker"
+  spec.version       = IpfsPublicGatewayChecker::VERSION
+  spec.authors       = ["B1nj0y"]
+  spec.email         = ["idegorepl@gmail.com"]
+
+  spec.summary       = %q{IPFS Public Gateway Checker}
+  spec.description   = %q{Checks which public gateways are online or not.}
+  spec.homepage      = "https://github.com/beijingrb/ipfs_public_gateway_checker"
+  spec.license       = "MIT"
+
+  spec.files         = %w[ipfs_public_gateway_checker.gemspec] + Dir["*.md", "bin/*", "lib/**/*.rb"]
+  spec.executables   = %w[ipfg]
+  spec.require_paths = %w[lib]
+
+  spec.add_dependency "rest-client", "~> 2.0"
+  spec.add_dependency "parallel", "~> 1.12"
+  spec.add_dependency "concurrent-ruby-edge", "~> 0.4"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/ipfs_public_gateway_checker.rb

@@ -0,0 +1,59 @@
+require "ipfs_public_gateway_checker/version"
+require "rest-client"
+require "parallel"
+require 'concurrent-edge'
+require "json"
+
+module IpfsPublicGatewayChecker
+  HASH_TO_TEST = 'Qmaisz6NMhDB51cCvNWa1GMS7LU1pAxdF4Ld6Ft9kZEP2a'
+  HASH_STRING = 'Hello from IPFS Gateway Checker'
+  GATEWAY_LIST_URL = 'https://raw.githubusercontent.com/ipfs/public-gateway-checker/master/gateways.json'
+
+  Channel = Concurrent::Channel
+
+  class << self
+    # get the possible fastest one
+    def get
+      list = gateway_list
+      return unless list
+      ch = Channel.new
+      list.each do |url|
+        Channel.go do
+          test_url = url.sub(':hash', HASH_TO_TEST)
+          ch << url if check(test_url)
+        end
+      end
+      ~ch
+    end
+
+    # get all active gateway list
+    # I've tried to use concurrent-edge to do this parallel detecting but
+    # there's always some problem. Perhaps I havn't grasped the gem's usage yet,
+    # or due to it's still experimental. Then I use the more robust Parallel gem
+    def active_list
+      list = gateway_list
+      return unless list
+      active_gateways = []
+      Parallel.map(list, in_threads: list.length) do |url|
+        test_url = url.sub(':hash', HASH_TO_TEST)
+        active_gateways << url if check(test_url)
+      end
+      active_gateways&.compact
+    end
+
+    def gateway_list
+      JSON.parse(RestClient.get(GATEWAY_LIST_URL) || '')
+    end
+
+    def check(url, timeout=5)
+      begin
+        resp = RestClient::Request.execute(method: :get, url: url, timeout: timeout)
+      rescue
+        return false
+      end
+      # puts resp.body
+      return false unless resp.code == 200
+      resp.body&.chomp == HASH_STRING
+    end
+  end
+end

data/lib/ipfs_public_gateway_checker/version.rb

@@ -0,0 +1,3 @@
+module IpfsPublicGatewayChecker
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: ipfs_public_gateway_checker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- B1nj0y
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby-edge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Checks which public gateways are online or not.
+email:
+- idegorepl@gmail.com
+executables:
+- ipfg
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- README.md
+- bin/console
+- bin/ipfg
+- bin/setup
+- ipfs_public_gateway_checker.gemspec
+- lib/ipfs_public_gateway_checker.rb
+- lib/ipfs_public_gateway_checker/version.rb
+homepage: https://github.com/beijingrb/ipfs_public_gateway_checker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: IPFS Public Gateway Checker
+test_files: []