archive_today 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad131a62edbb1b182f34c8beccaff07cb2e6f73414cd7391c8c8487bfe5ba3b4
+  data.tar.gz: a30538c8a90aeec34e003c51de6efcefc4f2b8985a3c66c8bb47355ce2fcbd28
+SHA512:
+  metadata.gz: 92b10f61076a7b1e2c44b93bdad340ed71a5be366b3766f00743e33eec0ca4b3515758fda76a3ee6c140006528cbfd9dc97837bb06a8f466d72ac9e671d82a38
+  data.tar.gz: fb4d2613c9417dcf16cfce535596574f367a8da48ad25dda967667d918b5ad32c49585de8b32eb1072988de8693e321d85995366760b6215724e1448f5ba7a7b

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0
+
+Initial commit

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in archive_today.gemspec
+gemspec
+
+gem 'faraday', '~> 1.0'
+gem 'faraday_middleware', '~> 1.0'
+gem 'nokogiri', '~> 1.10'
+gem 'rake', '~> 12.0'

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    archive_today (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    mini_portile2 (2.4.0)
+    multipart-post (2.1.1)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    rake (12.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  archive_today!
+  faraday (~> 1.0)
+  faraday_middleware (~> 1.0)
+  nokogiri (~> 1.10)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 TODO: Write your name
+
+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,48 @@
+# ArchiveToday
+
+A simple Ruby wrapper for the [Archive.today](https://archive.today) web capture service (formerly known as Archive.is)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'archive_today'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install archive_today
+
+## Usage
+
+```ruby
+require 'archive_today'
+
+ArchiveToday.submit(url: 'https://example.com')
+
+# => 'https://archive.is/a1b2c3
+```
+
+## Roadmap
+
+- proxies
+- optionally return URL of captured screenshot
+
+## 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/tomholford/archive_today.
+
+## Credit
+
+Inspired by [this Python implementation](https://github.com/pastpages/archiveis), thanks to those contributors.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/archive_today.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/archive_today/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "archive_today"
+  spec.version       = ArchiveToday::VERSION
+  spec.authors       = ["tomholford"]
+  spec.email         = ["tomholford@users.noreply.github.com"]
+
+  spec.summary       = %q{A Ruby gem for submitting links to Archive.today (AKA Archive.is)}
+  spec.description   = %q{Submit a URL to the Archive.today service to preserve it's contents in a Memento-compatible format}
+  spec.homepage      = "https://github.com/tomholford/archive-today"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/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('..', __FILE__)) 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"]
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "archive_today"
+
+require "irb"
+IRB.start(__FILE__)

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/lib/archive_today.rb

@@ -0,0 +1,12 @@
+require 'archive_today/version'
+require 'archive_today/archiver'
+
+module ArchiveToday
+  class Error < StandardError; end
+
+  class << self
+    def submit(url:, debug: false)
+      Archiver.new(url: url, debug: debug).submit
+    end
+  end
+end

data/lib/archive_today/archiver.rb

@@ -0,0 +1,75 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'nokogiri'
+require_relative 'version'
+
+module ArchiveToday
+  class Archiver
+    BASE_URL = 'https://archive.today/'.freeze
+    DEFAULT_USER_AGENT = "archive_today #{ArchiveToday::VERSION}".freeze
+
+    attr_reader :debug, :url, :user_agent
+
+    def initialize(url:, user_agent: DEFAULT_USER_AGENT, debug: false)
+      @debug = debug
+      @url = url
+      @user_agent = user_agent
+    end
+
+    def submit
+      puts 'Submitting URL ...'
+      response = connection.post('/submit/') do |req|
+        req.body = submission_body
+      end
+      raise unless response.success?
+
+      handle_response(response)
+    end
+
+    private
+
+    def handle_response(response)
+      headers = response.headers
+
+      return headers[:location] if headers.has_key?('location')
+      return headers[:refresh].split(';url=').last if headers.has_key?('refresh')
+
+      # TODO: handle the history case mentioned here?
+      # https://github.com/pastpages/archiveis/blob/master/archiveis/api.py#L81
+      response.env.url
+    end
+
+    def submission_body
+      URI.encode_www_form(
+        {
+          url: url,
+          anyway: 1,
+          submitid: unique_submission_id
+        }
+      )
+    end
+
+    def unique_submission_id
+      puts 'Getting unique submission ID ...'
+      response = connection.get('/')
+      raise unless response.success?
+
+      html = Nokogiri::HTML(response.body)
+      node = html.at_css('input[name="submitid"]')
+      id = node.attr('value')
+      puts "Got ID: #{id}" and return if id
+
+      nil
+    end
+
+    def connection
+      @connection ||= begin
+        Faraday.new(BASE_URL) do |faraday|
+          faraday.headers = { 'User-Agent' => user_agent }
+          faraday.use FaradayMiddleware::FollowRedirects
+          faraday.response :logger if debug
+        end
+      end
+    end
+  end
+end

data/lib/archive_today/version.rb

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

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: archive_today
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tomholford
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-13 00:00:00.000000000 Z
+dependencies: []
+description: Submit a URL to the Archive.today service to preserve it's contents in
+  a Memento-compatible format
+email:
+- tomholford@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- archive_today.gemspec
+- bin/console
+- bin/setup
+- lib/archive_today.rb
+- lib/archive_today/archiver.rb
+- lib/archive_today/version.rb
+homepage: https://github.com/tomholford/archive-today
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tomholford/archive-today
+  source_code_uri: https://github.com/tomholford/archive-today
+  changelog_uri: https://github.com/tomholford/archive-today/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A Ruby gem for submitting links to Archive.today (AKA Archive.is)
+test_files: []