monday_ruby 1.1.0 → 1.2.0

data/lib/monday/client.rb

@@ -2,6 +2,7 @@
 
 require "uri"
 require "net/http"
+require "net/http/post/multipart"
 require "json"
 
 require_relative "configuration"
@@ -37,6 +38,18 @@ module Monday
       handle_response(Response.new(response))
     end
 
+    def make_file_request(query, variables)
+      response = Request.post_multipart(
+        files_uri,
+        { query: query, variables: variables },
+        request_multipart_headers,
+        open_timeout: @config.open_timeout,
+        read_timeout: @config.read_timeout
+      )
+
+      handle_response(Response.new(response))
+    end
+
     private
 
     def configure(config_args)
@@ -49,6 +62,10 @@ module Monday
       URI(@config.host)
     end
 
+    def files_uri
+      URI(@config.files_host)
+    end
+
     def request_headers
       {
         "Content-Type": "application/json",
@@ -56,6 +73,13 @@ module Monday
       }
     end
 
+    def request_multipart_headers
+      {
+        "Content-Type": "multipart/form-data",
+        Authorization: @config.token
+      }
+    end
+
     def handle_response(response)
       return response if response.success?
 

data/lib/monday/configuration.rb

@@ -7,8 +7,10 @@ module Monday
   #
   # token: used to authenticate the requests
   # host: defaults to https://api.monday.com/v2
+  # files_host: defaults to https://api.monday.com/v2/files
   class Configuration
     DEFAULT_HOST = "https://api.monday.com/v2"
+    DEFAULT_FILES_HOST = "#{DEFAULT_HOST}/file"
     DEFAULT_TOKEN = nil
     DEFAULT_VERSION = "2023-07"
     DEFAULT_OPEN_TIMEOUT = 10
@@ -17,6 +19,7 @@ module Monday
     CONFIGURATION_FIELDS = %i[
       token
       host
+      files_host
       version
       open_timeout
       read_timeout
@@ -29,6 +32,7 @@ module Monday
       raise ArgumentError, "Unknown arguments: #{invalid_keys}" unless invalid_keys.empty?
 
       @host = DEFAULT_HOST
+      @files_host = DEFAULT_FILES_HOST
       @token = DEFAULT_TOKEN
       @version = DEFAULT_VERSION
       @open_timeout = DEFAULT_OPEN_TIMEOUT
@@ -42,6 +46,7 @@ module Monday
     def reset
       @token = DEFAULT_TOKEN
       @host = DEFAULT_HOST
+      @files_host = DEFAULT_FILES_HOST
       @version = DEFAULT_VERSION
       @open_timeout = DEFAULT_OPEN_TIMEOUT
       @read_timeout = DEFAULT_READ_TIMEOUT

data/lib/monday/request.rb

@@ -18,5 +18,20 @@ module Monday
 
       http.request(request)
     end
+
+    def self.post_multipart(uri, body, headers, open_timeout: 10, read_timeout: 30)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.open_timeout = open_timeout
+      http.read_timeout = read_timeout
+
+      params = {
+        "query" => body[:query],
+        "variables[file]" => body[:variables][:file]
+      }
+
+      request = Net::HTTP::Post::Multipart.new(uri.request_uri, params, headers)
+      http.request(request)
+    end
   end
 end

data/lib/monday/resources/base.rb

@@ -12,6 +12,10 @@ module Monday
 
       protected
 
+      def make_file_request(query, variables)
+        client.make_file_request(query, variables)
+      end
+
       def make_request(query)
         client.make_request(query)
       end

data/lib/monday/resources/file.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Monday
+  module Resources
+    # Represents Monday.com's file asset resource.
+    class File < Base
+      DEFAULT_SELECT = %w[id].freeze
+
+      # Adds a file to a file type column for an item.
+      #
+      # Allows customizing the column update using the args option.
+      # Allows customizing the values to retrieve using the select option.
+      # By default, The ID is retrieved.
+      def add_file_to_column(args: {}, select: DEFAULT_SELECT)
+        cloned_args = args.clone
+        variables = { file: cloned_args.delete(:file) }
+        cloned_args.merge!(file: "$file")
+        query = <<~QUERY
+          mutation add_file($file: File!) {
+            add_file_to_column#{Util.format_args(cloned_args)} {#{Util.format_select(select)}}
+          }
+        QUERY
+        make_file_request(query, variables)
+      end
+
+      # Adds a file to an update for an item.
+      #
+      # Allows customizing the update creation using the args option.
+      # Allows customizing the values to retrieve using the select option.
+      # By default, The ID is retrieved.
+      def add_file_to_update(args: {}, select: DEFAULT_SELECT)
+        cloned_args = args.clone
+        variables = { file: cloned_args.delete(:file) }
+        cloned_args.merge!(file: "$file")
+        query = <<~QUERY
+          mutation ($file: File!) {
+            add_file_to_update#{Util.format_args(cloned_args)} {#{Util.format_select(select)}}
+          }
+        QUERY
+        make_file_request(query, variables)
+      end
+
+      # Clear an item's files column. This is a helper method for files
+      # and you could also use the column.change_value to clear the column as well.
+      #
+      # Allows customizing the update creation using the args option.
+      # Allows customizing the values to retrieve using the select option.
+      # By default, ID is retrieved.
+      def clear_file_column(args: {}, select: DEFAULT_SELECT)
+        merged_args = args.merge(value: '{\"clear_all\": true}')
+        query = "mutation { change_column_value#{Util.format_args(merged_args)} {#{Util.format_select(select)}}}"
+        make_request(query)
+      end
+    end
+  end
+end

data/lib/monday/util.rb

@@ -108,6 +108,7 @@ module Monday
 
       def formatted_args_value(value)
         return value if value.is_a?(Symbol)
+        return value if value.to_s.include?("$") # GraphQL query variable
         return value.to_json.to_json if value.is_a?(Hash)
         return value if integer?(value)
         return "[#{value.map { |v| formatted_args_value(v) }.join(", ")}]" if value.is_a?(Array)

data/lib/monday/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Monday
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: monday_ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Sanif Himani
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 description: A Gem to easily interact with monday.com API using native Ruby
 email:
 - sanifhimani92@gmail.com
@@ -43,6 +57,74 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- docs/.vitepress/config.mjs
+- docs/.vitepress/theme/index.js
+- docs/.vitepress/theme/style.css
+- docs/README.md
+- docs/explanation/architecture.md
+- docs/explanation/best-practices/errors.md
+- docs/explanation/best-practices/performance.md
+- docs/explanation/best-practices/rate-limiting.md
+- docs/explanation/best-practices/testing.md
+- docs/explanation/column-values.md
+- docs/explanation/design.md
+- docs/explanation/graphql.md
+- docs/explanation/migration/v1.md
+- docs/explanation/pagination.md
+- docs/guides/advanced/batch.md
+- docs/guides/advanced/complex-queries.md
+- docs/guides/advanced/errors.md
+- docs/guides/advanced/pagination.md
+- docs/guides/advanced/rate-limiting.md
+- docs/guides/authentication.md
+- docs/guides/boards/create.md
+- docs/guides/boards/delete.md
+- docs/guides/boards/duplicate.md
+- docs/guides/boards/query.md
+- docs/guides/boards/update.md
+- docs/guides/columns/create.md
+- docs/guides/columns/metadata.md
+- docs/guides/columns/query.md
+- docs/guides/columns/update-multiple.md
+- docs/guides/columns/update-values.md
+- docs/guides/files/add-to-column.md
+- docs/guides/files/add-to-update.md
+- docs/guides/files/clear-column.md
+- docs/guides/first-request.md
+- docs/guides/folders/manage.md
+- docs/guides/groups/items.md
+- docs/guides/groups/manage.md
+- docs/guides/installation.md
+- docs/guides/items/create.md
+- docs/guides/items/delete.md
+- docs/guides/items/query.md
+- docs/guides/items/subitems.md
+- docs/guides/items/update.md
+- docs/guides/updates/manage.md
+- docs/guides/use-cases/dashboard.md
+- docs/guides/use-cases/import.md
+- docs/guides/use-cases/task-management.md
+- docs/guides/workspaces/manage.md
+- docs/index.md
+- docs/package-lock.json
+- docs/package.json
+- docs/reference/client.md
+- docs/reference/configuration.md
+- docs/reference/errors.md
+- docs/reference/resources/account.md
+- docs/reference/resources/activity-log.md
+- docs/reference/resources/board-view.md
+- docs/reference/resources/board.md
+- docs/reference/resources/column.md
+- docs/reference/resources/file.md
+- docs/reference/resources/folder.md
+- docs/reference/resources/group.md
+- docs/reference/resources/item.md
+- docs/reference/resources/subitem.md
+- docs/reference/resources/update.md
+- docs/reference/resources/workspace.md
+- docs/reference/response.md
+- docs/tutorial/first-integration.md
 - lib/monday/client.rb
 - lib/monday/configuration.rb
 - lib/monday/deprecation.rb
@@ -55,6 +137,7 @@ files:
 - lib/monday/resources/board.rb
 - lib/monday/resources/board_view.rb
 - lib/monday/resources/column.rb
+- lib/monday/resources/file.rb
 - lib/monday/resources/folder.rb
 - lib/monday/resources/group.rb
 - lib/monday/resources/item.rb
@@ -70,8 +153,8 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/sanifhimani/monday_ruby
-  documentation_uri: https://monday-ruby.gitbook.io/docs/
-  changelog_uri: https://github.com/sanifhimani/monday_ruby/blob/v1.1.0/CHANGELOG.md
+  documentation_uri: https://sanifhimani.github.io/monday_ruby/
+  changelog_uri: https://github.com/sanifhimani/monday_ruby/blob/v1.2.0/CHANGELOG.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -87,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Ruby bindings to use the monday.com API
 test_files: []