checkoff 0.161.0 → 0.163.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f83187f80678558975069a3181a34814c3859b81a9a19f0d29606e9ba37e62c4
-  data.tar.gz: 8e53186cd5ac43fa6b2fb6f9f4f13a4da3259ab75d8792a43459657e8dcaf8bc
+  metadata.gz: 4e069f1f67cf8145e42254912651cb575323ca8c5ec0b2e94e8929b6c2e1cb33
+  data.tar.gz: 6e0f8039d9e956c0918b03807cc04cf65853232e4b3a97f7d6d5cca72b38b593
 SHA512:
-  metadata.gz: 4e4415a477513de35f11579dd45544071ca1b223a5b7a646c2bba0adb2b3becddf7409d4bd69cf0c14d2f0e8fcf55b10014f7d1b90f33d0b667b442aa25dba63
-  data.tar.gz: 823f046f8f55e05be6d3368cd878abbb02e9632c9bdc7bf5ca5e46160155bee5845ff742550579c55cd1c5013de7e632c828e84c3861ada4998feca0ef29c34a
+  metadata.gz: 9f696c01862a1febb0f973bf90a39ce8afbc3be48d0b7df2a57494f9333c8894c2b17a0b3c2c4954fd2014c572d8e6bc78fdbb128e197f9714809e64e5207d45
+  data.tar.gz: 0d2d8a45685bf264c00dee9e7fedfbfb7974c0a0e3dcd580618dafb99e936ef52d621411fa462a9a75bc4a54a0290c143cea459b549305131d8c8de02a36c253

data/Gemfile.lock

@@ -12,12 +12,13 @@ GIT
 PATH
   remote: .
   specs:
-    checkoff (0.161.0)
+    checkoff (0.163.0)
       activesupport
       asana (> 0.10.0)
       cache_method
       dalli
       gli
+      mime-types
 
 GEM
   remote: https://rubygems.org/
@@ -110,6 +111,9 @@ GEM
       mixlib-config (>= 2.2.1, < 4)
       mixlib-shellout
     method_source (1.0.0)
+    mime-types (3.5.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2023.1205)
     minitest (5.20.0)
     minitest-profile (0.0.2)
     minitest-reporters (1.6.1)

data/Makefile

@@ -49,7 +49,6 @@ clear_metrics: ## remove or reset result artifacts created by tests and quality
 
 clean: clear_metrics ## remove all built artifacts
 
-
 citest: test ## Run unit tests from CircleCI
 
 overcommit: ## run precommit quality checks
@@ -69,6 +68,14 @@ repl:  ## Load up checkoff in pry
 clean-coverage:
 	@bundle exec rake clear_metrics
 
+clean-typecheck: ## Refresh information that type checking depends on
+	bundle install
+	bundle exec solargraph clear
+	rm -fr .yardoc/
+	bundle exec yard gems
+	bundle exec solargraph scan
+	echo all clear
+
 coverage: test report-coverage ## check code coverage
 	@bundle exec rake undercover
 

data/checkoff.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'cache_method'
   spec.add_runtime_dependency 'dalli'
   spec.add_runtime_dependency 'gli'
+  spec.add_runtime_dependency 'mime-types'
 
   spec.metadata = {
     'rubygems_mfa_required' => 'false',

data/lib/checkoff/attachments.rb

@@ -0,0 +1,204 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'faraday'
+require 'forwardable'
+require 'cache_method'
+require 'mime/types'
+require 'net/http'
+require 'net/http/response'
+require 'net/http/responses'
+require 'tempfile'
+require_relative 'internal/config_loader'
+require_relative 'internal/logging'
+require_relative 'workspaces'
+require_relative 'tasks'
+require_relative 'clients'
+
+# https://developers.asana.com/reference/attachments
+
+module Checkoff
+  # Manage attachments in Asana
+  class Attachments
+    # @!parse
+    #   extend CacheMethod::ClassMethods
+
+    include Logging
+
+    MINUTE = 60
+    private_constant :MINUTE
+    HOUR = MINUTE * 60
+    private_constant :HOUR
+    DAY = 24 * HOUR
+    private_constant :DAY
+    REALLY_LONG_CACHE_TIME = HOUR * 1
+    private_constant :REALLY_LONG_CACHE_TIME
+    LONG_CACHE_TIME = MINUTE * 15
+    private_constant :LONG_CACHE_TIME
+    SHORT_CACHE_TIME = MINUTE
+    private_constant :SHORT_CACHE_TIME
+
+    # @param config [Hash]
+    # @param workspaces [Checkoff::Workspaces]
+    # @param clients [Checkoff::Clients]
+    # @param client [Asana::Client]
+    def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
+                   workspaces: Checkoff::Workspaces.new(config: config),
+                   clients: Checkoff::Clients.new(config: config),
+                   client: clients.client)
+      @workspaces = workspaces
+      @client = client
+    end
+
+    # @param url [String]
+    # @param resource [Asana::Resources::Resource]
+    # @param attachment_name [String,nil]
+    # @param just_the_url [Boolean]
+    #
+    # @return [Asana::Resources::Attachment]
+    def create_attachment_from_url!(url,
+                                    resource,
+                                    attachment_name: nil,
+                                    just_the_url: false)
+      if just_the_url
+        create_attachment_from_url_alone!(url, resource, attachment_name: attachment_name)
+      else
+        create_attachment_from_downloaded_url!(url, resource, attachment_name: attachment_name)
+      end
+    end
+
+    private
+
+    # Writes contents of URL to a temporary file with the same
+    # extension as the URL using Net::HTTP, raising an exception if
+    # not succesful
+    #
+    # @param uri [URI]
+    #
+    # @return [Object]
+    # @sg-ignore
+    def download_uri(uri, &block)
+      out = nil
+      Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        # @sg-ignore
+        request = Net::HTTP::Get.new(uri)
+        http.request(request) do |response|
+          # use a block to ensure the file is closed after we're done with it
+          raise("Unexpected response code: #{response.code}") unless response.code == '200'
+
+          write_tempfile_from_response(response) do |tempfile|
+            out = block.yield tempfile
+          end
+        end
+      end
+      out
+    end
+
+    # @sg-ignore
+    # @param response [Net::HTTPResponse]
+    #
+    # @yields [IO]
+    #
+    # @return [Object]
+    def write_tempfile_from_response(response)
+      Tempfile.create('checkoff') do |tempfile|
+        tempfile.binmode
+        # @sg-ignore
+        response.read_body do |chunk|
+          tempfile.write(chunk)
+        end
+        tempfile.rewind
+
+        yield tempfile
+      end
+    end
+
+    # @param url [String]
+    # @param resource [Asana::Resources::Resource]
+    # @param attachment_name [String,nil]
+    #
+    # @return [Asana::Resources::Attachment]
+    def create_attachment_from_downloaded_url!(url, resource, attachment_name:)
+      uri = URI(url)
+      attachment_name ||= File.basename(uri.path)
+      download_uri(uri) do |tempfile|
+        content_type ||= content_type_from_filename(attachment_name)
+        content_type ||= content_type_from_filename(uri.path)
+
+        resource.attach(filename: attachment_name, mime: content_type,
+                        io: tempfile)
+      end
+    end
+
+    # @param url [String]
+    # @param resource [Asana::Resources::Resource]
+    # @param attachment_name [String,nil]
+    #
+    # @return [Asana::Resources::Attachment,nil]
+    def create_attachment_from_url_alone!(url, resource, attachment_name:)
+      with_params = {
+        'parent' => resource.gid,
+        'url' => url,
+        'resource_subtype' => 'external',
+        'name' => attachment_name,
+      }
+      options = {}
+      Asana::Resource.new(parse(client.post('/attachments', body: with_params, options: options)).first,
+                          client: client)
+    end
+
+    # @param filename [String]
+    #
+    # @return [String,nil]
+    # @sg-ignore
+    def content_type_from_filename(filename)
+      # @sg-ignore
+      MIME::Types.type_for(filename)&.first&.content_type
+    end
+
+    # https://github.com/Asana/ruby-asana/blob/master/lib/asana/resource_includes/response_helper.rb#L7
+    # @param response [Faraday::Response]
+    #
+    # @return [Array<Hash, Hash>]
+    def parse(response)
+      data = response.body.fetch('data') do
+        raise("Unexpected response body: #{response.body}")
+      end
+      extra = response.body.except('data')
+      [data, extra]
+    end
+
+    # @return [Checkoff::Workspaces]
+    attr_reader :workspaces
+
+    # @return [Asana::Client]
+    attr_reader :client
+
+    # bundle exec ./attachments.rb
+    # :nocov:
+    class << self
+      # @return [void]
+      def run
+        # @sg-ignore
+        # @type [String]
+        gid = ARGV[0] || raise('Please pass task gid as first argument')
+        # @sg-ignore
+        # @type [String]
+        url = ARGV[1] || raise('Please pass attachment URL as second argument')
+
+        tasks = Checkoff::Tasks.new
+        attachments = Checkoff::Attachments.new
+        task = tasks.task_by_gid(gid)
+        attachment = attachments.create_attachment_from_url!(url, task)
+        puts "Results: #{attachment.inspect}"
+      end
+    end
+    # :nocov:
+  end
+end
+
+# :nocov:
+abs_program_name = File.expand_path($PROGRAM_NAME)
+Checkoff::Attachments.run if abs_program_name == File.expand_path(__FILE__)
+# :nocov:

data/lib/checkoff/version.rb

@@ -3,5 +3,5 @@
 # Command-line and gem client for Asana (unofficial)
 module Checkoff
   # Version of library
-  VERSION = '0.161.0'
+  VERSION = '0.163.0'
 end

data/lib/checkoff.rb

@@ -17,3 +17,4 @@ require 'checkoff/task_selectors'
 require 'checkoff/project_selectors'
 require 'checkoff/section_selectors'
 require 'checkoff/task_searches'
+require 'checkoff/attachments'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.161.0
+  version: 0.163.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-26 00:00:00.000000000 Z
+date: 2023-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - vince@broz.cc
@@ -129,6 +143,7 @@ files:
 - exe/checkoff
 - fix.sh
 - lib/checkoff.rb
+- lib/checkoff/attachments.rb
 - lib/checkoff/cli.rb
 - lib/checkoff/clients.rb
 - lib/checkoff/create-entity.sh