distributed-press-api-client 0.1.5 → 0.2.1

data/lib/distributed_press/v1/schemas/new_token_payload.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'dry-schema'
+
+class DistributedPress
+  module V1
+    module Schemas
+      # JWT payload for new tokens
+      class NewTokenPayload < Dry::Schema::JSON
+        # Capabilities supported by the APIv1
+        #
+        # @return [Array]
+        CAPABILITIES = %w[publisher admin refresh].freeze
+
+        define do
+          optional(:issuedTo).filled(:string)
+          required(:capabilities).filled(:array).each do
+            included_in? CAPABILITIES
+          end
+        end
+      end
+    end
+  end
+end

data/lib/distributed_press/v1/schemas/publisher.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'dry-schema'
+
+class DistributedPress
+  module V1
+    module Schemas
+      # Schema for full publisher
+      class Publisher < Dry::Schema::JSON
+        define do
+          required(:id).filled(:string)
+          required(:name).filled(:string)
+          required(:ownedSites).array(:string)
+        end
+      end
+    end
+  end
+end

data/lib/distributed_press/v1/schemas/publishing_site.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'dry-schema'
+
+class DistributedPress
+  module V1
+    module Schemas
+      # Schema for publishing a site
+      class PublishingSite < Dry::Schema::JSON
+        define do
+          required(:id).filled(:string)
+        end
+      end
+    end
+  end
+end

data/lib/distributed_press/v1/schemas/site.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'dry-schema'
+require_relative 'http_protocol'
+require_relative 'hyper_protocol'
+require_relative 'ipfs_protocol'
+
+class DistributedPress
+  module V1
+    module Schemas
+      # Schema for full site, usually the APIv1 responds with this.
+      class Site < Dry::Schema::JSON
+        define do
+          required(:id).filled(:string)
+
+          # TODO: Validate domain name
+          required(:domain).filled(:string)
+
+          required(:protocols).hash do
+            required(:http).filled(:bool)
+            required(:ipfs).filled(:bool)
+            required(:hyper).filled(:bool)
+          end
+
+          required(:links).hash do
+            optional(:http).hash(HttpProtocol.new)
+            optional(:hyper).hash(HyperProtocol.new)
+            optional(:ipfs).hash(IpfsProtocol.new)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/distributed_press/v1/schemas/token_header.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'dry-schema'
+
+class DistributedPress
+  module V1
+    module Schemas
+      # JWT header
+      class TokenHeader < Dry::Schema::JSON
+        define do
+          required(:alg).filled(:string)
+          optional(:typ).filled(:string)
+        end
+      end
+    end
+  end
+end

data/lib/distributed_press/v1/schemas/token_payload.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'dry-schema'
+
+class DistributedPress
+  module V1
+    module Schemas
+      # JWT payload
+      class TokenPayload < Dry::Schema::JSON
+        # Capabilities supported by the APIv1
+        #
+        # @return [Array]
+        CAPABILITIES = %w[publisher admin refresh].freeze
+
+        define do
+          required(:issuedTo).filled(:string)
+          required(:tokenId).filled(:string)
+          required(:iat).filled(:integer, gt?: 0)
+          required(:expires).filled(:integer, gt?: -2)
+          required(:capabilities).filled(:array).each do
+            included_in? CAPABILITIES
+          end
+        end
+      end
+    end
+  end
+end

data/lib/distributed_press/v1/schemas/update_site.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'dry-schema'
+
+class DistributedPress
+  module V1
+    module Schemas
+      # Schema for updating a website options.  ID is required to
+      # generate URL.
+      class UpdateSite < Dry::Schema::JSON
+        define do
+          required(:id).filled(:string)
+
+          required(:protocols).hash do
+            optional(:http).filled(:bool)
+            optional(:ipfs).filled(:bool)
+            optional(:hyper).filled(:bool)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/distributed_press/v1/schemas.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'schemas/admin'
+require_relative 'schemas/http_protocol'
+require_relative 'schemas/hyper_protocol'
+require_relative 'schemas/ipfs_protocol'
+require_relative 'schemas/new_admin'
+require_relative 'schemas/new_publisher'
+require_relative 'schemas/new_site'
+require_relative 'schemas/new_token_payload'
+require_relative 'schemas/publisher'
+require_relative 'schemas/publishing_site'
+require_relative 'schemas/site'
+require_relative 'schemas/token_header'
+require_relative 'schemas/token_payload'
+require_relative 'schemas/update_site'
+
+class DistributedPress
+  module V1
+    # Schema validation
+    module Schemas
+    end
+  end
+end

data/lib/distributed_press/v1/token.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require 'jwt'
+require_relative 'errors'
+require_relative 'schemas/token_header'
+require_relative 'schemas/token_payload'
+
+class DistributedPress
+  module V1
+    # Authentication is done using a JWT with different capabilities.
+    # This class decodes and help us figure out what we can do
+    # client-side.
+    class Token
+      # Decoded JWT
+      #
+      # @return [JWT]
+      attr_reader :decoded
+
+      # Parsed and validated token header
+      #
+      # @see https://jwt.io
+      # @return [DistributedPress::V1::Schemas::TokenHeader]
+      attr_reader :header
+
+      # Parsed and validated token payload
+      #
+      # @return [DistributedPress::V1::Schemas::TokenPayload]
+      attr_reader :payload
+
+      # Decodes a JWT string
+      #
+      # @param token [String]
+      def initialize(token:)
+        @token = token
+        # XXX: We can't validate the token without its secret.
+        @decoded = JWT.decode(token, nil, false)
+
+        @header = Schemas::TokenHeader.new.call(decoded.find do |part|
+          part['alg']
+        end)
+
+        @payload = Schemas::TokenPayload.new.call(decoded.find do |part|
+          part['tokenId']
+        end)
+
+        raise TokenHeaderNotValidError unless header.success?
+        raise TokenPayloadNotValidError unless payload.success?
+      end
+
+      # Returns the original token when converted to String
+      #
+      # @return [String]
+      def to_s
+        @token
+      end
+
+      # Checks if the token expired.  Returns false if expiration time
+      # is negative.
+      #
+      # @return [Boolean]
+      def expired?
+        return false if forever?
+
+        !expires_in_x_seconds.positive?
+      end
+
+      # Checks if the token never expires
+      #
+      # @return [Boolean]
+      def forever?
+        payload[:expires].negative?
+      end
+
+      # Return issuing time
+      #
+      # @return [Time]
+      def issued_at
+        Time.at(payload[:iat])
+      end
+
+      # Return expiration time
+      #
+      # @return [Time]
+      def expires_at
+        Time.at(0, payload[:expires], :millisecond)
+      end
+
+      # Returns expiration time in seconds
+      #
+      # @return [Integer]
+      def expires_in_x_seconds
+        expires_at.to_i - Time.now.to_i
+      end
+
+      # Checks if a token gives us publisher capabilities
+      #
+      # @return [Boolean]
+      def publisher?
+        payload[:capabilities].include? 'publisher'
+      end
+
+      # Checks if a token gives us admin capabilities
+      #
+      # @return [Boolean]
+      def admin?
+        payload[:capabilities].include? 'admin'
+      end
+
+      # Checks if a token gives us refresh capabilities
+      #
+      # @return [Boolean]
+      def refresh?
+        payload[:capabilities].include? 'refresh'
+      end
+
+      # Returns payload capabilities
+      #
+      # @return [Array]
+      def capabilities
+        payload[:capabilities]
+      end
+    end
+  end
+end

data/lib/distributed_press/v1.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'v1/client'
+require_relative 'v1/client/admin'
+require_relative 'v1/client/auth'
+require_relative 'v1/client/publisher'
+require_relative 'v1/client/site'
+require_relative 'v1/schemas'
+
+# API Client
+class DistributedPress
+  # APIv1
+  module V1
+  end
+end

data/lib/distributed_press/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# API client
+class DistributedPress
+  # Version
+  VERSION = '0.2.1'
+end

data/lib/distributed_press.rb

@@ -2,28 +2,27 @@
 
 require 'httparty'
 require 'open3'
+require_relative 'distributed_press/multipart'
 
 # Distributed Press (https://distributed.press) API client
 class DistributedPress
   include ::HTTParty
 
+  # Default URL
   DEFAULT_URL = 'https://api.distributed.press'
-  NEWLINE  = "\r\n"
-  BOUNDARY = '--'
 
   attr_reader :api_key, :project_domain, :configure_result, :publish_result
 
-  # @param options [Hash]
-  # @option options [String] :url API URL
-  # @option options [String] :api_key API Key
-  # @option options [String] :project_domain Domain name
+  # @param url [String] API URL
+  # @param api_key [String] API Key
+  # @param project_domain [String] Domain name
   def initialize(url: DEFAULT_URL, api_key: nil, project_domain: nil)
     url ||= DEFAULT_URL
     @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
+    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
@@ -33,42 +32,46 @@ class DistributedPress
   # @return [Boolean] Configuration was successful
   def configure
     stream, config = IO.pipe
+    multipart = Multipart.new
 
     Thread.new do
-      write_multipart_header config, 'config.json'
+      multipart.write_header config, 'config.json'
       IO.copy_stream StringIO.new({ 'domain' => project_domain }.to_json), config
-      write_multipart_footer config
+      multipart.write_footer config
 
       config.close
     end
 
-    @configure_result = upload_io('/v0/publication/configure', stream)
+    @configure_result = upload_io('/v0/publication/configure', stream, multipart.boundary)
 
     configure_result['errorCode'].zero?
   end
 
   # Publishes a directory by tarballing it on the fly.
   #
-  # @param [String] Directory path
+  # @param path [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', '--dereference', '--directory', path, '.') do |stdin, stdout, thread|
+    Open3.popen2('tar', '--to-stdout', '--create', '--gzip', '--dereference', '--directory', path,
+                 '.') do |_stdin, stdout, thread|
       stream, body = IO.pipe
 
+      multipart = Multipart.new
+
       # Generate a multipart body and copy contents to it.
       Thread.new do
-        write_multipart_header body, filename
+        multipart.write_header body, "#{filename}.tar.gz"
         IO.copy_stream stdout, body
-        write_multipart_footer body
+        multipart.write_footer body
 
         body.close
       end
 
-      @publish_result = upload_io '/v0/publication/publish', stream
+      @publish_result = upload_io '/v0/publication/publish', stream, multipart.boundary
 
       # wait
       thread.value
@@ -78,36 +81,12 @@ class DistributedPress
 
   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)
+  # @param endpoint [String]
+  # @param io [IO]
+  # @param boundary [String]
+  def upload_io(endpoint, io, boundary)
     self.class.post(endpoint, body_stream: io, headers: headers(
       'Accept' => 'application/json',
       'Content-Type' => "multipart/form-data; boundary=#{boundary}",
@@ -115,18 +94,11 @@ class DistributedPress
     ))
   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
+  # @param extra [Hash] Extra headers
   # @return [Hash]
   def headers(extra = {})
-    extra.merge('Accept' => 'application/json', 'Authorization' => 'Bearer ' + api_key)
+    extra.merge('Accept' => 'application/json', 'Authorization' => "Bearer #{api_key}")
   end
 end

data/lib/{jekyll-distributed-press.rb → jekyll-distributed-press-v0.rb}

@@ -28,14 +28,12 @@ Jekyll::Hooks.register :site, :post_write, priority: :low do |site|
   dest = site.dest
   locales_enabled = site.config['plugins'].include?('jekyll-locales')
 
-  if locales_enabled
-    if site.locales?
-      if site.locale != site.locales.last
-        info "Ignoring #{site.locale}"
-        next
-      else
-        dest = File.realpath(File.join(site.dest, '..'))
-      end
+  if locales_enabled && site.locales?
+    if site.locale != site.locales.last
+      info "Ignoring #{site.locale}"
+      next
+    else
+      dest = File.realpath(File.join(site.dest, '..'))
     end
   end