monday_ruby 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b952365eaf332b933932dea993d33470bc585c9eadcf0dc7525e4550794313d2
-  data.tar.gz: 665a9d53d8a06972f88022040a28bf8003fa13247aa0bdac60e21f7ca8be9da5
+  metadata.gz: 9976cfcde08608cfe4106783b717d0c3fcc4c7b9851a3f994a3c7bd33493c437
+  data.tar.gz: bbaa8b1e58c3c1e2a73e50a797040c5828000a79e5efac05e43471109a26a51c
 SHA512:
-  metadata.gz: 2af82867a8586bb1bdd6f665f6e584b9e41ea76d0a74fab00f56d408d4357fee4986fde25df96403f0ba8284a4ecc99c61e97e1a4e9668e6024ca7e94574a22e
-  data.tar.gz: 7b66ffafb1c9bfd6bb5c24de9c19438acf89ba59a0a07204ca76a38e18bd043e183077ccda3042453560f71f18c307c73bf8b6f1d161e75a42a39bcadb468229
+  metadata.gz: 7a023ba0076f5cfebd1ca6e4708942afe37b7f75001ecab2126e676fa2338fce6e5ce232d3ab5ab5109301cba5fae1a0dfcd504c1db9a6de99b96587dacb7d17
+  data.tar.gz: 46f345126e55080fe842bfda28d0dc349848640fda23f4323832b973170534c41345410852d330ba3731f8f011fd65c6a5b4b975410313a3717973be343c12c5

data/.simplecov

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+SimpleCov.minimum_coverage 97

data/CHANGELOG.md

@@ -1,3 +1,32 @@
+## v0.6.0 (October 9, 2023)
+
+### Added
+
+- Support for working with subitems:
+  - Listing subitems
+  - Creating a subitem
+
+- Support for working with updates:
+  - Create an Update
+  - Like an Update
+  - Clear an item's updates
+  - Delete an update
+
+## v0.5.0 (September 21, 2023)
+
+### Added
+
+- Support for working with board groups:
+  - Reading, Creating, Deleting
+  - Archiving, Duplicating
+  - Moving an item to a group
+
+## v0.4.0 (September 15, 2023)
+
+### Added
+
+- Support for Reading, Creating and Deleting Workspaces
+
 ## v0.3.0 (July 10, 2023)
 
 ### Added

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing
+
+Thanks for taking the time to contribute!
+
+The following is a set of guidelines for contributing to `monday_ruby`. These are mostly guidelines, not rules. Use your best judgment, and feel to propose changes to this document in a pull request.
+
+## Your first code contribution
+
+Unsure where to begin contributing? You can start by looking through `good first issue` and `help wanted` issues.
+
+### Pull request
+
+Please follow these steps to have your contribution considered:
+
+1. Follow the [pull request template](PULL_REQUEST_TEMPLATE.md).
+2. Follow the [commit guidelines](#commit-message-guidelines).
+3. After you submit your pull request, verify that all the status checks are passing.
+
+## Commit message guidelines
+
+* Use present tense ("Add feature" not "Added feature")
+* Use the imperative mood ("Move file to..." not "Moves file to...")
+* Limit the first line to 70 characters or less.
+* Reference issues and pull requests after the first line.
+* Try to follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)

data/docs/configuration.md

@@ -35,6 +35,6 @@ require "monday_ruby"
 
 Monday.configure do |config|
   config.token = <AUTH_TOKEN>
-  config.version = "2023-10"
+  config.version = "2023-07"
 end
 ```

data/lib/monday/error.rb

@@ -79,9 +79,9 @@ module Monday
   #
   # It is also raised when the body returns the following error_codes:
   #   InvalidUserIdException, InvalidVersionException, InvalidColumnIdException
-  #   InvalidItemIdException, InvalidBoardIdException, InvalidArgumentException
+  #   InvalidItemIdException, InvalidSubitemIdException, InvalidBoardIdException, InvalidArgumentException
   #   CreateBoardException, ItemsLimitationException, ItemNameTooLongException
-  #   ColumnValueException, CorrectedValueException
+  #   ColumnValueException, CorrectedValueException, InvalidGroupIdException
   class InvalidRequestError < Error
   end
 

data/lib/monday/resources/group.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Monday
+  module Resources
+    # Represents Monday.com's group resource.
+    module Group
+      DEFAULT_SELECT = %w[id title].freeze
+
+      # Retrieves all the groups.
+      #
+      # Allows filtering groups using the args option.
+      # Allows customizing the values to retrieve using the select option.
+      # By default, ID and title fields are retrieved.
+      def groups(args: {}, select: DEFAULT_SELECT)
+        query = "query { boards(#{Util.format_args(args)}) { groups{#{Util.format_select(select)}}}}"
+
+        make_request(query)
+      end
+
+      # Creates a new group.
+      #
+      # Allows customizing creating a group using the args option.
+      # Allows customizing the values to retrieve using the select option.
+      # By default, ID and title fields are retrieved.
+      def create_group(args: {}, select: DEFAULT_SELECT)
+        query = "mutation { create_group(#{Util.format_args(args)}) {#{Util.format_select(select)}}}"
+
+        make_request(query)
+      end
+
+      # Updates a group.
+      #
+      # Allows customizing updating the group using the args option.
+      # By default, returns the ID of the updated group.
+      def update_group(args: {}, select: ["id"])
+        query = "mutation { update_group(#{Util.format_args(args)}) {#{Util.format_select(select)}}}"
+
+        make_request(query)
+      end
+
+      # Deletes a group.
+      #
+      # Requires board_id and group_id in args option to delete the group.
+      # Allows customizing the values to retrieve using the select option.
+      # By default, returns the ID of the group deleted.
+      def delete_group(args: {}, select: ["id"])
+        query = "mutation { delete_group(#{Util.format_args(args)}) {#{Util.format_select(select)}}}"
+
+        make_request(query)
+      end
+
+      # Archives a group.
+      #
+      # Requires board_id and group_id in args option to archive the group.
+      # Allows customizing the values to retrieve using the select option.
+      # By default, returns the ID of the group archived.
+      def archive_group(args: {}, select: ["id"])
+        query = "mutation { archive_group(#{Util.format_args(args)}) {#{Util.format_select(select)}}}"
+
+        make_request(query)
+      end
+
+      # Duplicates a group.
+      #
+      # Requires board_id and group_id in args option to duplicate the group.
+      # Allows customizing the values to retrieve using the select option.
+      # By default, ID and title fields are retrieved.
+      def duplicate_group(args: {}, select: DEFAULT_SELECT)
+        query = "mutation { duplicate_group(#{Util.format_args(args)}) {#{Util.format_select(select)}}}"
+
+        make_request(query)
+      end
+
+      # Move item to group.
+      #
+      # Requires item_id and group_id in args option to move an item to a group.
+      # Allows customizing the values to retrieve using the select option.
+      # By default, ID and title fields are retrieved.
+      def move_item_to_group(args: {}, select: ["id"])
+        query = "mutation { move_item_to_group(#{Util.format_args(args)}) {#{Util.format_select(select)}}}"
+
+        make_request(query)
+      end
+    end
+  end
+end

data/lib/monday/resources/subitem.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Monday
+  module Resources
+    # Represents Monday.com's subitem resource.
+    module Subitem
+      DEFAULT_SELECT = %w[id name created_at].freeze
+
+      # Retrieves all the subitems for the item.
+      #
+      # 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)}}}}"
+
+        make_request(query)
+      end
+
+      # Creates a new subitem.
+      #
+      # 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)}}}"
+
+        make_request(query)
+      end
+    end
+  end
+end

data/lib/monday/resources/update.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Monday
+  module Resources
+    # Represents Monday.com's update resource.
+    module Update
+      DEFAULT_SELECT = %w[id body created_at].freeze
+
+      # Retrieves all the updates.
+      #
+      # 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)}}}"
+
+        make_request(query)
+      end
+
+      # Creates a new update.
+      #
+      # 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)}}}"
+
+        make_request(query)
+      end
+
+      # Like an update.
+      #
+      # 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)}}}"
+
+        make_request(query)
+      end
+
+      # Clear an item's update
+      #
+      # 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_item_updates(args: {}, select: %w[id])
+        query = "mutation { clear_item_updates(#{Util.format_args(args)}) {#{Util.format_select(select)}}}"
+
+        make_request(query)
+      end
+
+      # Delete an update
+      #
+      # 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)}}}"
+
+        make_request(query)
+      end
+    end
+  end
+end

data/lib/monday/resources/workspace.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Monday
+  module Resources
+    # Represents Monday.com's workspace resource.
+    module Workspace
+      DEFAULT_SELECT = %w[id name description].freeze
+
+      # Retrieves all the workspaces.
+      #
+      # 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)}}}"
+
+        make_request(query)
+      end
+
+      # Creates a new workspaces.
+      #
+      # 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)}}}"
+
+        make_request(query)
+      end
+
+      # Deletes a workspace.
+      #
+      # 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)}}}"
+
+        make_request(query)
+      end
+    end
+  end
+end

data/lib/monday/resources.rb

@@ -5,7 +5,11 @@ 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"
 
 module Monday
   module Resources
@@ -14,6 +18,10 @@ module Monday
     include Board
     include BoardView
     include Column
+    include Group
     include Item
+    include Subitem
+    include Workspace
+    include Update
   end
 end

data/lib/monday/util.rb

@@ -45,13 +45,16 @@ module Monday
           "InvalidVersionException" => [InvalidRequestError, 400],
           "InvalidColumnIdException" => [InvalidRequestError, 400],
           "InvalidItemIdException" => [InvalidRequestError, 400],
+          "InvalidSubitemIdException" => [InvalidRequestError, 400],
           "InvalidBoardIdException" => [InvalidRequestError, 400],
+          "InvalidGroupIdException" => [InvalidRequestError, 400],
           "InvalidArgumentException" => [InvalidRequestError, 400],
           "CreateBoardException" => [InvalidRequestError, 400],
           "ItemsLimitationException" => [InvalidRequestError, 400],
           "ItemNameTooLongException" => [InvalidRequestError, 400],
           "ColumnValueException" => [InvalidRequestError, 400],
-          "CorrectedValueException" => [InvalidRequestError, 400]
+          "CorrectedValueException" => [InvalidRequestError, 400],
+          "InvalidWorkspaceIdException" => [InvalidRequestError, 400]
         }[error_code] || [Error, 400]
       end
 

data/lib/monday/version.rb

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

data/monday_ruby.gemspec

@@ -8,8 +8,8 @@ repository = "https://github.com/sanifhimani/monday_ruby"
 Gem::Specification.new do |spec|
   spec.name = "monday_ruby"
   spec.version = version
-  spec.authors = ["Sanif Himani"]
-  spec.email = ["sanifhimani92@gmail.com"]
+  spec.authors = ["Sanif Himani", "Wes Hays"]
+  spec.email = ["sanifhimani92@gmail.com", "weshays@gmail.com"]
 
   spec.summary = "Ruby bindings to use the monday.com API"
   spec.description = "A Gem to easily interact with monday.com API using native Ruby"

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: monday_ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Sanif Himani
+- Wes Hays
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-10 00:00:00.000000000 Z
+date: 2023-10-18 00:00:00.000000000 Z
 dependencies: []
 description: A Gem to easily interact with monday.com API using native Ruby
 email:
 - sanifhimani92@gmail.com
+- weshays@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -20,9 +22,11 @@ files:
 - ".env"
 - ".rspec"
 - ".rubocop.yml"
+- ".simplecov"
 - ".vscode/settings.json"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - LICENSE
 - README.md
 - Rakefile
@@ -75,7 +79,11 @@ files:
 - lib/monday/resources/board.rb
 - lib/monday/resources/board_view.rb
 - lib/monday/resources/column.rb
+- lib/monday/resources/group.rb
 - lib/monday/resources/item.rb
+- lib/monday/resources/subitem.rb
+- lib/monday/resources/update.rb
+- lib/monday/resources/workspace.rb
 - lib/monday/response.rb
 - lib/monday/util.rb
 - lib/monday/version.rb
@@ -87,7 +95,7 @@ licenses:
 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.3.0/CHANGELOG.md
+  changelog_uri: https://github.com/sanifhimani/monday_ruby/blob/v0.6.0/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -104,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Ruby bindings to use the monday.com API