monday_ruby 0.6.2 → 1.1.0

data/lib/monday/resources/subitem.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require_relative "base"
+
 module Monday
   module Resources
     # Represents Monday.com's subitem resource.
-    module Subitem
+    class Subitem < Base
       DEFAULT_SELECT = %w[id name created_at].freeze
 
       # Retrieves all the subitems for the item.
@@ -11,10 +13,10 @@ module Monday
       # Allows filtering subitems using the args option.
       # Allows customizing the values to retrieve using the select option.
       # By default, ID, name and created_at fields are retrieved.
-      def subitems(args: {}, select: DEFAULT_SELECT)
-        query = "query { items#{Util.format_args(args)} { subitems{#{Util.format_select(select)}}}}"
+      def query(args: {}, select: DEFAULT_SELECT)
+        request_query = "query{items#{Util.format_args(args)}{ subitems{#{Util.format_select(select)}}}}"
 
-        make_request(query)
+        make_request(request_query)
       end
 
       # Creates a new subitem.
@@ -22,8 +24,8 @@ module Monday
       # Allows customizing the subitem creation using the args option.
       # Allows customizing the values to retrieve using the select option.
       # By default, ID, name and created_at fields are retrieved.
-      def create_subitem(args: {}, select: DEFAULT_SELECT)
-        query = "mutation { create_subitem#{Util.format_args(args)} {#{Util.format_select(select)}}}"
+      def create(args: {}, select: DEFAULT_SELECT)
+        query = "mutation{create_subitem#{Util.format_args(args)}{#{Util.format_select(select)}}}"
 
         make_request(query)
       end

data/lib/monday/resources/update.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require_relative "base"
+
 module Monday
   module Resources
     # Represents Monday.com's update resource.
-    module Update
+    class Update < Base
       DEFAULT_SELECT = %w[id body created_at].freeze
 
       # Retrieves all the updates.
@@ -11,10 +13,10 @@ module Monday
       # Allows filtering updates using the args option.
       # Allows customizing the values to retrieve using the select option.
       # By default, ID, body and created_at fields are retrieved.
-      def updates(args: {}, select: DEFAULT_SELECT)
-        query = "query { updates#{Util.format_args(args)} { #{Util.format_select(select)}}}"
+      def query(args: {}, select: DEFAULT_SELECT)
+        request_query = "query{updates#{Util.format_args(args)}{#{Util.format_select(select)}}}"
 
-        make_request(query)
+        make_request(request_query)
       end
 
       # Creates a new update.
@@ -22,8 +24,8 @@ module Monday
       # Allows customizing the update creation using the args option.
       # Allows customizing the values to retrieve using the select option.
       # By default, ID, body and created_at fields are retrieved.
-      def create_update(args: {}, select: DEFAULT_SELECT)
-        query = "mutation { create_update#{Util.format_args(args)} {#{Util.format_select(select)}}}"
+      def create(args: {}, select: DEFAULT_SELECT)
+        query = "mutation{create_update#{Util.format_args(args)}{#{Util.format_select(select)}}}"
 
         make_request(query)
       end
@@ -33,8 +35,8 @@ module Monday
       # 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 like_update(args: {}, select: %w[id])
-        query = "mutation { like_update#{Util.format_args(args)} {#{Util.format_select(select)}}}"
+      def like(args: {}, select: %w[id])
+        query = "mutation{like_update#{Util.format_args(args)}{#{Util.format_select(select)}}}"
 
         make_request(query)
       end
@@ -45,7 +47,7 @@ module Monday
       # Allows customizing the values to retrieve using the select option.
       # By default, ID is retrieved.
       def clear_item_updates(args: {}, select: %w[id])
-        query = "mutation { clear_item_updates#{Util.format_args(args)} {#{Util.format_select(select)}}}"
+        query = "mutation{clear_item_updates#{Util.format_args(args)}{#{Util.format_select(select)}}}"
 
         make_request(query)
       end
@@ -55,8 +57,8 @@ module Monday
       # 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 delete_update(args: {}, select: %w[id])
-        query = "mutation { delete_update#{Util.format_args(args)} {#{Util.format_select(select)}}}"
+      def delete(args: {}, select: %w[id])
+        query = "mutation{delete_update#{Util.format_args(args)}{#{Util.format_select(select)}}}"
 
         make_request(query)
       end

data/lib/monday/resources/workspace.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require_relative "base"
+
 module Monday
   module Resources
     # Represents Monday.com's workspace resource.
-    module Workspace
+    class Workspace < Base
       DEFAULT_SELECT = %w[id name description].freeze
 
       # Retrieves all the workspaces.
@@ -11,10 +13,10 @@ module Monday
       # Allows filtering workspaces using the args option.
       # Allows customizing the values to retrieve using the select option.
       # By default, ID, name and description fields are retrieved.
-      def workspaces(args: {}, select: DEFAULT_SELECT)
-        query = "query { workspaces#{Util.format_args(args)} {#{Util.format_select(select)}}}"
+      def query(args: {}, select: DEFAULT_SELECT)
+        request_query = "query{workspaces#{Util.format_args(args)}{#{Util.format_select(select)}}}"
 
-        make_request(query)
+        make_request(request_query)
       end
 
       # Creates a new workspaces.
@@ -22,8 +24,8 @@ module Monday
       # Allows customizing creating a workspace using the args option.
       # Allows customizing the values to retrieve using the select option.
       # By default, ID, name and description fields are retrieved.
-      def create_workspace(args: {}, select: DEFAULT_SELECT)
-        query = "mutation { create_workspace#{Util.format_args(args)} {#{Util.format_select(select)}}}"
+      def create(args: {}, select: DEFAULT_SELECT)
+        query = "mutation{create_workspace#{Util.format_args(args)}{#{Util.format_select(select)}}}"
 
         make_request(query)
       end
@@ -33,8 +35,8 @@ module Monday
       # Requires workspace_id to delete the workspace.
       # Allows customizing the values to retrieve using the select option.
       # By default, returns the ID of the workspace deleted.
-      def delete_workspace(workspace_id, select: ["id"])
-        query = "mutation { delete_workspace(workspace_id: #{workspace_id}) {#{Util.format_select(select)}}}"
+      def delete(workspace_id, select: ["id"])
+        query = "mutation{delete_workspace(workspace_id: #{workspace_id}){#{Util.format_select(select)}}}"
 
         make_request(query)
       end

data/lib/monday/resources.rb

@@ -1,27 +1,23 @@
 # frozen_string_literal: true
 
-require_relative "resources/account"
-require_relative "resources/activity_log"
-require_relative "resources/board"
-require_relative "resources/board_view"
-require_relative "resources/column"
-require_relative "resources/group"
-require_relative "resources/item"
-require_relative "resources/subitem"
-require_relative "resources/workspace"
-require_relative "resources/update"
+Dir[File.join(__dir__, "resources", "*.rb")].sort.each { |file| require file }
 
 module Monday
+  # Encapsulates all available resources and includes them in the client.
   module Resources
-    include Account
-    include ActivityLog
-    include Board
-    include BoardView
-    include Column
-    include Group
-    include Item
-    include Subitem
-    include Workspace
-    include Update
+    def self.initialize(client)
+      constants.each do |constant|
+        resource_class = const_get(constant)
+        resource_name = constant.to_s.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase
+        client.instance_variable_set("@#{resource_name}", resource_class.new(client))
+        define_resource_accessor(client, resource_name) unless client.class.method_defined?(resource_name)
+      end
+    end
+
+    def self.define_resource_accessor(client, resource_name)
+      client.class.class_eval do
+        attr_reader resource_name
+      end
+    end
   end
 end

data/lib/monday/util.rb

@@ -29,6 +29,18 @@ module Monday
         values
       end
 
+      # Formats a hash as a GraphQL input object (not JSON string)
+      # Used for complex input types like ItemsQuery
+      #
+      # input: { rules: [{ column_id: "status", compare_value: [1] }], operator: :and }
+      # output: { rules: [{ column_id: "status", compare_value: [1] }], operator: and }
+      def format_graphql_object(hash)
+        formatted = hash.map do |key, value|
+          "#{key}: #{format_graphql_value(value)}"
+        end.join(", ")
+        "{#{formatted}}"
+      end
+
       def status_code_exceptions_mapping(status_code)
         {
           "500" => InternalServerError,
@@ -43,7 +55,9 @@ module Monday
       def response_error_exceptions_mapping(error_code)
         {
           "ComplexityException" => [ComplexityError, 429],
+          "COMPLEXITY_BUDGET_EXHAUSTED" => [RateLimitError, 429],
           "UserUnauthorizedException" => [AuthorizationError, 403],
+          "USER_UNAUTHORIZED" => [AuthorizationError, 403],
           "ResourceNotFoundException" => [ResourceNotFoundError, 404],
           "InvalidUserIdException" => [InvalidRequestError, 400],
           "InvalidVersionException" => [InvalidRequestError, 400],
@@ -58,7 +72,8 @@ module Monday
           "ItemNameTooLongException" => [InvalidRequestError, 400],
           "ColumnValueException" => [InvalidRequestError, 400],
           "CorrectedValueException" => [InvalidRequestError, 400],
-          "InvalidWorkspaceIdException" => [InvalidRequestError, 400]
+          "InvalidWorkspaceIdException" => [InvalidRequestError, 400],
+          "INTERNAL_SERVER_ERROR" => [InternalServerError, 500]
         }[error_code] || [Error, 400]
       end
 
@@ -76,9 +91,26 @@ module Monday
         end.join(" ")
       end
 
+      def format_graphql_value(value)
+        case value
+        when Hash
+          format_graphql_object(value)
+        when Array
+          "[#{value.map { |v| format_graphql_value(v) }.join(", ")}]"
+        when Integer, TrueClass, FalseClass
+          value
+        when String
+          "\"#{value}\""
+        else
+          value.to_s
+        end
+      end
+
       def formatted_args_value(value)
+        return value if value.is_a?(Symbol)
         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)
 
         "\"#{value}\""
       end

data/lib/monday/version.rb

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

data/lib/monday_ruby.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "monday/client"
+require_relative "monday/deprecation"
 require_relative "monday/version"
 
 # Module to configure the library globally

metadata

@@ -1,16 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: monday_ruby
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Sanif Himani
 - Wes Hays
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-21 00:00:00.000000000 Z
-dependencies: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 description: A Gem to easily interact with monday.com API using native Ruby
 email:
 - sanifhimani92@gmail.com
@@ -30,55 +43,19 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- docs/README.md
-- docs/SUMMARY.md
-- docs/client.md
-- docs/configuration.md
-- docs/error-handling.md
-- docs/getting-started.md
-- docs/quick-start.md
-- docs/resources/README.md
-- docs/resources/account/README.md
-- docs/resources/account/accounts.md
-- docs/resources/activity-log/README.md
-- docs/resources/activity-log/activity_logs.md
-- docs/resources/board-view/README.md
-- docs/resources/board-view/board_views.md
-- docs/resources/board/README.md
-- docs/resources/board/archive_board.md
-- docs/resources/board/boards.md
-- docs/resources/board/create_board.md
-- docs/resources/board/delete_board.md
-- docs/resources/board/delete_board_subscribers.md
-- docs/resources/board/duplicate_board.md
-- docs/resources/board/update_board.md
-- docs/resources/column/README.md
-- docs/resources/column/change_column_metadata.md
-- docs/resources/column/change_column_title.md
-- docs/resources/column/change_column_value.md
-- docs/resources/column/change_multiple_column_value.md
-- docs/resources/column/change_simple_column_value.md
-- docs/resources/column/column_values.md
-- docs/resources/column/columns.md
-- docs/resources/column/create_column.md
-- docs/resources/column/delete_column.md
-- docs/resources/item/README.md
-- docs/resources/item/archive_item.md
-- docs/resources/item/create_item.md
-- docs/resources/item/delete_item.md
-- docs/resources/item/duplicate_item.md
-- docs/resources/item/items.md
-- docs/response.md
 - lib/monday/client.rb
 - lib/monday/configuration.rb
+- lib/monday/deprecation.rb
 - lib/monday/error.rb
 - lib/monday/request.rb
 - lib/monday/resources.rb
 - lib/monday/resources/account.rb
 - lib/monday/resources/activity_log.rb
+- lib/monday/resources/base.rb
 - lib/monday/resources/board.rb
 - lib/monday/resources/board_view.rb
 - lib/monday/resources/column.rb
+- lib/monday/resources/folder.rb
 - lib/monday/resources/group.rb
 - lib/monday/resources/item.rb
 - lib/monday/resources/subitem.rb
@@ -88,16 +65,14 @@ files:
 - lib/monday/util.rb
 - lib/monday/version.rb
 - lib/monday_ruby.rb
-- monday_ruby.gemspec
 homepage: https://github.com/sanifhimani/monday_ruby
 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/v0.6.2/CHANGELOG.md
+  changelog_uri: https://github.com/sanifhimani/monday_ruby/blob/v1.1.0/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -112,8 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby bindings to use the monday.com API
 test_files: []

data/docs/README.md

@@ -1,13 +0,0 @@
-# Monday API Library for Ruby
-
-This library provides convenient access to the monday.com API from the application written in the Ruby language.
-
-The library provides:
-
-1. A pre-defined set of methods to easily interact with the API resources.
-2. Easy configuration path for fast setup and use.
-3. Easy error handling
-
-#### Requirements
-
-* Ruby 2.7+

data/docs/SUMMARY.md

@@ -1,40 +0,0 @@
-# Table of contents
-
-* [Monday API Library for Ruby](README.md)
-* [Getting Started](getting-started.md)
-* [Configuration](configuration.md)
-* [Client](client.md)
-* [Response](response.md)
-* [Quick Start](quick-start.md)
-* [Error Handling](error-handling.md)
-* [Resources](resources/README.md)
-  * [Account](resources/account/README.md)
-    * [#accounts](resources/account/accounts.md)
-  * [Activity Log](resources/activity-log/README.md)
-    * [#activity\_logs](resources/activity-log/activity\_logs.md)
-  * [Board View](resources/board-view/README.md)
-    * [#board\_views](resources/board-view/board\_views.md)
-  * [Board](resources/board/README.md)
-    * [#boards](resources/board/boards.md)
-    * [#create\_board](resources/board/create\_board.md)
-    * [#duplicate\_board](resources/board/duplicate\_board.md)
-    * [#update\_board](resources/board/update\_board.md)
-    * [#archive\_board](resources/board/archive\_board.md)
-    * [#delete\_board](resources/board/delete\_board.md)
-    * [#delete\_board\_subscribers](resources/board/delete\_board\_subscribers.md)
-  * [Column](resources/column/README.md)
-    * [#columns](resources/column/columns.md)
-    * [#column\_values](resources/column/column\_values.md)
-    * [#create\_column](resources/column/create\_column.md)
-    * [#change\_column\_title](resources/column/change\_column\_title.md)
-    * [#change\_column\_metadata](resources/column/change\_column\_metadata.md)
-    * [#change\_column\_value](resources/column/change\_column\_value.md)
-    * [#change\_simple\_column\_value](resources/column/change\_simple\_column\_value.md)
-    * [#change\_multiple\_column\_value](resources/column/change\_multiple\_column\_value.md)
-    * [#delete\_column](resources/column/delete\_column.md)
-  * [Item](resources/item/README.md)
-    * [#items](resources/item/items.md)
-    * [#create\_item](resources/item/create\_item.md)
-    * [#duplicate\_item](resources/item/duplicate\_item.md)
-    * [#archive\_item](resources/item/archive\_item.md)
-    * [#delete\_item](resources/item/delete\_item.md)

data/docs/client.md

@@ -1,15 +0,0 @@
-# Client
-
-The Monday client is flat, meaning most API actions are available as methods on the client object. To initialize a client, run the following:
-
-{% code lineNumbers="true" %}
-```ruby
-# If the library is configured globally
-client_with_global_config = Monday::Client.new
-
-# For a specific client
-client = Monday::Client.new(token: <AUTH_TOKEN>)
-```
-{% endcode %}
-
-You can then use all the [resources](resources/) using the client object.

data/docs/configuration.md

@@ -1,40 +0,0 @@
-# Configuration
-
-To interact with the API, you must provide a valid auth token. This token can be generated from the Administration tab on the account. For more authentication information, please look at monday.com's [API documentation](https://developer.monday.com/api-reference/docs/authentication).
-
-Once you have the authentication token, you can either globally configure the library or you can configure a specific client.
-
-### Global
-
-To configure the library globally, you can do the following:
-
-```ruby
-require "monday_ruby"
-
-Monday.configure do |config|
-  config.token = <AUTH_TOKEN>
-end
-```
-
-### Client specific config
-
-To configure a client, you can do the following:
-
-```ruby
-require "monday_ruby"
-
-client = Monday::Client.new(token: <AUTH_TOKEN>)
-```
-
-You can optionally pass in the version of the API you want to use using the `version` configuration field.
-
-By default, the latest stable version is used. Read more about the version on monday.com's [official documentation](https://developer.monday.com/api-reference/docs/api-versioning).
-
-```ruby
-require "monday_ruby"
-
-Monday.configure do |config|
-  config.token = <AUTH_TOKEN>
-  config.version = "2023-07"
-end
-```

data/docs/error-handling.md

@@ -1,71 +0,0 @@
-# Error Handling
-
-Monday.com has a set of predefined errors and exceptions that are sent back from their GraphQL API. Refer to their [official documentation](https://developer.monday.com/api-reference/docs/errors) to know more about the error codes.
-
-### Catching exceptions
-
-If there is an error from the API, the library raises an exception. It's a best practice to catch and handle exceptions.
-
-To catch an exception, use the `rescue` keyword. You can catch all the exceptions from the API using the `Monday::Error` class. However, it is recommended to catch specific exceptions using its subclasses and have a fallback rescue using `Monday::Error`.
-
-```ruby
-require "monday_ruby"
-
-client = Monday::Client.new(token: <AUTH_TOKEN>)
-
-def example
-  res = client.boards
-  puts res.body
-rescue Monday::AuthorizationError => error
-  puts "Authorization error: #{error.message}"
-  puts "Error code: #{error.code}"
-rescue Monday::Error => error
-  puts "Other error: #{error.message}"
-end
-```
-
-Along with the default status code exceptions, monday.com returns some other exceptions with `200` status code. This library handles those errors and raises exceptions accordingly.
-
-#### `Monday::InternalServer Error`
-
-This exception is raised when the server returns a `500` status code. Read more about what can cause this error on Monday.com's [official documentation](https://developer.monday.com/api-reference/docs/errors#internal-server-error).
-
-#### `Monday::AuthorizationError`
-
-This exception is raised when the server returns a `401` or a `403` status code. This can happen when the client is not authenticated, i.e., not configured with the token, or the token is incorrect.
-
-This exception is also raised when the server returns a `200` status code but the body returns `UserUnauthorizedException` error code.
-
-#### `Monday::RateLimitError`
-
-This exception is raised when the server returns a `429` status code. This can happen when you exceed the rate limit, i.e., 5,000 requests per minute. Read more about their rate limit on their [official documentation](https://developer.monday.com/api-reference/docs/rate-limits).
-
-#### `Monday::ResourceNotFoundError`
-
-This exception is raised when the server returns a `404` status code. This can happen when you pass an invalid ID in the query.
-
-This exception is also raised when the server returns a `200` status code but the body returns `ResourceNotFoundException` error code.
-
-#### `Monday::ComplexityError`
-
-This exception is raised when the server returns a `200` status code but the body returns  `ComplexityException` error code.
-
-#### `Monday::InvalidRequestError`
-
-This exception is raised when the server returns a `400` status code. This can happen when the query you pass is invalid.
-
-This exception is also raised when the server returns a `200` status code but the body returns the following error codes:
-
-1. `InvalidUserIdException`
-2. `InvalidVersionException`
-3. `InvalidColumnIdException`
-4. `InvalidItemIdException`
-5. `InvalidBoardIdException`
-6. `InvalidArgumentException`
-7. `CreateBoardException`
-8. `ItemsLimitationException`
-9. `ItemNameTooLongException`
-10. `ColumnValueException`
-11. `CorrectedValueException`
-
-Read more about these specific exceptions on their [official API documentation](https://developer.monday.com/api-reference/docs/errors).

data/docs/getting-started.md

@@ -1,25 +0,0 @@
-# Getting Started
-
-### Installation
-
-You don't need the source code unless you want to modify the gem. If you want to use the package, run the following:
-
-```sh
-gem install monday_ruby
-```
-
-If you want to build the gem from the source:
-
-```sh
-gem build monday_ruby.gemspec
-```
-
-### Bundler
-
-If you are installing via bundler, you should be sure to use the HTTPS rubygems source in your Gemfile, as any gems fetched over HTTP could potentially be compromised in transit and alter the code of gems fetched securely over HTTPS:
-
-```ruby
-source "https://rubygems.org"
-
-gem "monday_ruby"
-```