spn2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6ec6088e94bed925212bc5aa5abf3211cae5fd0bf5402c49f316d7e4d65f051d
+  data.tar.gz: e00cad0b9921f36052ec81271e69f553979dec1e0b6cd540f1bee1c0f712f337
+SHA512:
+  metadata.gz: e618df35304407811745df2e7c92106669a01564d4c61c1639fa06a109ffb995fb05e145e12d13efc7cf30fd4c899a959138e0640894bc68c3942efd1035e3d0
+  data.tar.gz: cc5616e4848cd9f5bfceb58e163095f9adfc86e584857d3c5c9674bfbbe8a182262d7c779c7d24a87134e7959e7f3a6fcbfc4588f039efc5184919e193d70ca2

data/.rubocop.yml

@@ -0,0 +1,13 @@
+---
+require:
+  - rubocop-minitest
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.1
+
+Style/HashSyntax:
+  Enabled: false  # yuk Ruby 3.1
+
+Style/NumericLiterals:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-06-29
+
+- Initial release

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+guard :minitest do
+  watch(%r{^test/(.*)/?test_(.*)\.rb$})
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/lib/#{m[1]}test_#{m[2]}.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 MatzFan
+
+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.

data/README.md

@@ -0,0 +1,71 @@
+[![Gem Version](https://badge.fury.io/rb/spn2.svg)](https://badge.fury.io/rb/spn2)
+
+# Spn2
+
+Spn2 is a gem for interacting with the [Wayback Machine](https://web.archive.org/)'s Save Page Now 2 (SPN2) REST API. The API (draft) specification is [here](https://docs.google.com/document/d/1Nsv52MvSjbLb2PCpHlat0gkzw0EvtSgpKHu4mk0MnrA/edit).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add spn2
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install spn2
+
+## Usage
+
+For the Spn2 namespace do:
+
+```rb
+require 'spn2'
+```
+
+### Authentication
+
+The API requires authentication, so you will need an account at [archive.org](https://archive.org). There are two methods of authentication; cookies and API key. Presently only the latter is implemented. API keys may be generated at https://archive.org/account/s3.php. Ensure your access key and secret key are set in environment variables SPN2_ACCESS_KEY and SPN2_SECRET_KEY respectively.
+
+### Save a page
+
+Save a url in the Wayback Machine. This method returns the job_id in a hash.
+```rb
+> Spn2.save(url: 'example.com') # returns a job_id
+
+=> {job_id: 'spn2-9c17e047f58f9220a7008d4f18152fee4d111d14'}
+```
+
+### View the status of a job
+
+Use the job_id.
+```rb
+> Spn2.status(job_id: 'spn2-9c17e047f58f9220a7008d4f18152fee4d111d14')
+
+=> {"counters"=>{"outlinks"=>1, "embeds"=>2}, "job_id"=>"spn2-9c17e047f58f9220a7008d4f18152fee4d111d14",
+    "original_url"=>"http://example.com/", "resources"=>["http://example.com/", "http://example.com/favicon.ico"],
+    "duration_sec"=>6.732, "outlinks"=>["https://www.iana.org/domains/example"], "http_status"=>200,
+    "timestamp"=>"20220622224107", "status"=>"success"}
+```
+"status" => "success" is what you are looking for.
+
+### System status
+
+The status of Wayback Machine itself is available.
+```rb
+> Spn2.system_status
+=> {"status"=>"ok"}
+```
+
+## Development
+
+~~After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 GitLab at https://gitlab.com/matzfan/spn2. Please run `rubocop` and correct all errors before submitting PR's.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/curlable.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'curb'
+
+# namespace
+module Curlable
+  def get(url:, headers: {})
+    Curl::Easy.http_get(url) do |http|
+      http.follow_location = true
+      headers.each { |k, v| http.headers[k] = v }
+    end.body_str
+  end
+
+  def post(url:, headers: {}, params: {})
+    Curl::Easy.http_post("#{url}?#{Curl.postalize(params)}", params) do |http|
+      http.follow_location = true
+      headers.each { |k, v| http.headers[k] = v }
+    end.body_str
+  end
+end

data/lib/spn2/version.rb

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

data/lib/spn2.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'nokogiri'
+
+require_relative 'curlable'
+
+# namespace
+module Spn2
+  extend Curlable # for .system_status
+  include Curlable
+
+  class Spn2Error < StandardError; end
+
+  FIND_JOB_ID_REGEXP = /(spn2-([a-f]|\d){40})/
+  WEB_ARCHIVE = 'https://web.archive.org'
+
+  def self.access_key
+    ENV.fetch('SPN2_ACCESS_KEY', nil)
+  end
+
+  def self.secret_key
+    ENV.fetch('SPN2_SECRET_KEY', nil)
+  end
+
+  def self.system_status
+    JSON.parse get(url: "#{WEB_ARCHIVE}/save/status/system")
+  end
+
+  def self.save(url:)
+    job_id(json(auth_post(url: "#{WEB_ARCHIVE}/save/#{url}", params: "url=#{url}")))
+  end
+
+  def self.status(job_id:)
+    json auth_get(url: "#{WEB_ARCHIVE}/save/status/#{job_id}?_t=#{Time.now.to_i}")
+  end
+
+  def self.auth_get(url:)
+    get(url: url, headers: accept_header.merge(auth_header))
+  end
+
+  def self.auth_post(url:, params:)
+    post(url: url, headers: accept_header.merge(auth_header), params:)
+  end
+
+  def self.accept_header
+    { 'Accept' => 'application/json' }
+  end
+
+  def self.auth_header
+    { 'Authorization' => "LOW #{Spn2.access_key}:#{Spn2.secret_key}" }
+  end
+
+  def self.job_id(hash)
+    { job_id: hash['job_id'] }
+  end
+
+  def self.json(json_string)
+    JSON.parse Nokogiri::HTML(json_string)
+  end
+end

data/sig/spn2.rbs

@@ -0,0 +1,4 @@
+module Spn2
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: spn2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- MatzFan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.30'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.30'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: Atomate the process of saving web pages to archive.org
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/curlable.rb
+- lib/spn2.rb
+- lib/spn2/version.rb
+- sig/spn2.rbs
+homepage: https://gitlab.com/matxfan/spn2
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://gitlab.com/matzfan/spn2
+  source_code_uri: https://gitlab.com/matzfan/spn2
+  changelog_uri: https://gitlab.com/matzfan/spn2/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.16
+signing_key: 
+specification_version: 4
+summary: Gem for the Save Page Now API of the Wayback Machine
+test_files: []