distributed-press-api-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9851a2ea9ababa58c8a990d18cf2bde427e695c70c641b1fc2bf56849fe8bd95
+  data.tar.gz: 9a883d1d204796510a04f4588e99eed5b2093d410b940d62c7c8dd074fb265e2
+SHA512:
+  metadata.gz: d19a77c2cef4d0d26c28fb6317c6b0602c8f5c68951c4214a634b136f01a01256077ba3d13f7f4bb1c37f4193bb6f653f7d746b7a3cfef45a300e38481e72ef1
+  data.tar.gz: b71374a0b60435231a4b61616935433989f727d810ae3b0c9dea924b67d9419095b3c3fa9665f15d33a5819521e469006812c0404cb5b4b124da689af99b506b

data/README.md

@@ -0,0 +1,68 @@
+# Distributed Press API client
+
+This is an API client for [Distributed Press](https://distributed.press/).
+
+Supports basic configuration and uploading the website's directory.  It
+will create a tarball on the fly, and uses `IO` to minimize memory
+usage.  May not work on every operating system.
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'distributed-press-api-client'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install distributed-press-api-client
+```
+
+## Usage
+
+```ruby
+require 'distributed_press'
+
+dp = DistributedPress.new
+       url: 'https://api.distributed.press',
+       api_key: 'https://github.com/hyphacoop/api.distributed.press#steps',
+       project_domain: 'example.org'
+
+dp.configure
+dp.publish '/path/to/your/site'
+```
+
+API key and project domain can be passed as environment variables called
+`DISTRIBUTED_PRESS_API_KEY` and `DISTRIBUTED_PRESS_PROJECT_DOMAIN`
+respectively.  API URL is optional and defaults to
+`https://api.distributed.press`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on 0xacab.org at
+<https://0xacab.org/sutty/distributed-press-api-client>. This project is
+intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the [Sutty code of
+conduct](https://sutty.nl/en/code-of-conduct/).
+
+If you like our plugins, [please consider
+donating](https://donaciones.sutty.nl/en/)!
+
+## License
+
+The gem is available as free software under the terms of the Affero GPL3
+License.
+
+## Code of Conduct
+
+Everyone interacting in the distributed-press-api-client project’s
+codebases, issue trackers, chat rooms and mailing lists is expected to
+follow the [code of conduct](https://sutty.nl/en/code-of-conduct/).

data/lib/distributed_press.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'open3'
+
+# Distributed Press (https://distributed.press) API client
+class DistributedPress
+  include ::HTTParty
+
+  NEWLINE  = "\r\n"
+  BOUNDARY = '--'
+
+  attr_reader :api_key, :project_domain
+
+  # @param options [Hash]
+  # @option options [String] :url API URL
+  # @option options [String] :api_key API Key
+  # @option options [String] :project_domain Domain name
+  def initialize(url: 'https://api.distributed.press', api_key: nil, project_domain: nil)
+    @api_key = api_key || ENV['DISTRIBUTED_PRESS_API_KEY']
+    @project_domain = project_domain || ENV['DISTRIBUTED_PRESS_PROJECT_DOMAIN']
+
+    raise ArgumentError, "API key is missing" unless @api_key
+    raise ArgumentError, "Project domain is missing" unless @project_domain
+
+    self.class.default_options[:base_uri] = HTTParty.normalize_base_uri(url)
+  end
+
+  # Configure the domain
+  #
+  # @return [Boolean] Configuration was successful
+  def configure
+    stream, config = IO.pipe
+
+    Thread.new do
+      write_multipart_header config, 'config.json'
+      IO.copy_stream StringIO.new({ 'domain' => project_domain }.to_json), config
+      write_multipart_footer config
+
+      config.close
+    end
+
+    result = upload_io('/v0/publication/configure', stream)
+
+    result['errorCode'].zero?
+  end
+
+  # Publishes a directory by tarballing it on the fly.
+  #
+  # @param [String] Directory path
+  # @return [Boolean] Upload was successful
+  def publish(path)
+    raise ArgumentError, "#{path} is not a directory" unless File.directory? path
+
+    filename = File.basename path
+
+    Open3.popen2('tar', '--to-stdout', '--create', '--gzip', '--directory', path, '.') do |stdin, stdout, thread|
+      stream, body = IO.pipe
+
+      # Generate a multipart body and copy contents to it.
+      Thread.new do
+        write_multipart_header body, filename
+        IO.copy_stream stdout, body
+        write_multipart_footer body
+
+        body.close
+      end
+
+      result = upload_io '/v0/publication/publish', stream
+
+      # wait
+      thread.value
+      result['errorCode'].zero?
+    end
+  end
+
+  private
+
+  # Write the multipart header
+  def write_multipart_header(io, filename)
+    io.write BOUNDARY
+    io.write boundary
+    io.write NEWLINE
+    io.write "Content-Disposition: form-data; name=\"file\"; filename=\"#{filename}.tar.gz\""
+    io.write NEWLINE
+    io.write 'Content-Type: application/octet-stream'
+    io.write NEWLINE
+    io.write NEWLINE
+
+    nil
+  end
+
+  # Write the multipart footer
+  def write_multipart_footer(io)
+    io.write NEWLINE
+    io.write BOUNDARY
+    io.write boundary
+    io.write BOUNDARY
+    io.write NEWLINE
+
+    nil
+  end
+
+  # Upload an IO object
+  #
+  # @param [String]
+  # @param [IO]
+  def upload_io(endpoint, io)
+    self.class.post(endpoint, body_stream: io, headers: headers(
+      'Accept' => 'application/json',
+      'Content-Type' => "multipart/form-data; boundary=#{boundary}",
+      'Transfer-Encoding' => 'chunked'
+    ))
+  end
+
+  # Generate a MultiPart boundary and reuse it
+  #
+  # @return [String]
+  def boundary
+    @boundary ||= HTTParty::Request::MultipartBoundary.generate
+  end
+
+  # Default request headers
+  #
+  # @param [Hash] Extra headers
+  # @return [Hash]
+  def headers(extra = {})
+    extra.merge('Accept' => 'application/json', 'Authorization' => 'Bearer ' + api_key)
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: distributed-press-api-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- f
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+description: An API client for Distributed Press (https://distributed.press/)
+email:
+- f@sutty.nl
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/distributed_press.rb
+homepage: https://0xacab.org/sutty/distributed-press-api-client
+licenses:
+- AGPL-3.0
+metadata:
+  bug_tracker_uri: https://0xacab.org/sutty/distributed-press-api-client/issues
+  homepage_uri: https://0xacab.org/sutty/distributed-press-api-client
+  source_code_uri: https://0xacab.org/sutty/distributed-press-api-client
+  changelog_uri: https://0xacab.org/sutty/distributed-press-api-client/-/blob/master/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/distributed-press-api-client
+post_install_message:
+rdoc_options:
+- "--title"
+- distributed-press-api-client - Distributed Press API Client
+- "--main"
+- README.md
+- "--line-numbers"
+- "--inline-source"
+- "--quiet"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.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: Distributed Press API Client
+test_files: []