monday_ruby 0.6.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4da1daad80c509a485414efe293d4a628dd6b002871b403c877d150ec12c178
-  data.tar.gz: 10f869bd1cd5fdf8068a8314644bd59ac3da16c98e3794f0a60347fde951f44b
+  metadata.gz: 6e8164389fc7acb67d40bee3bf79a9768e1256833268e5ef8002c6d9392a5b75
+  data.tar.gz: 29165f3538b8658267944fd2ea91f2bbdf11c916c7967e17cfe55e27397959c3
 SHA512:
-  metadata.gz: 206f792cdc8f7950c309380a58019dd8ce6874fc2a2dce2da0fdf9cd7cfd5d6e36f1fb8c65715f458de19039e60679bc4b9ba6b9723c3e90a9b8e34aa685011e
-  data.tar.gz: b635c776e2ea724aeb5dad4e047ef03a35226f7ee0031afd3b05831250e0bf4ef64c3835c41df332eb286e1e8992f3206772c0a1c113e9bc8b24825a8f961227
+  metadata.gz: f21b44ba54e5c14513cd7f39b6709126fe1a5e54a00468da76fc2275230d9a01e7cf4844ae5035bf8777dacd8153ee7571a8a53a3491b6bf4366b47ea324d6ce
+  data.tar.gz: bbaee28c405107767469f7a9386c7d2b991b4e877ccc3b476a360837ca25bb776aee2d05579ef4aa641b74b747cafe2fb73dc72836dd6b8264f61d4982b36729

data/.env

@@ -1 +1 @@
-token="[REPLACE_TOKEN]"
+token="eyJhbGciOiJIUzI1NiJ9.eyJ0aWQiOjM4MTE3NTY1MywiYWFpIjoxMSwidWlkIjo2MzEzMDMxMiwiaWFkIjoiMjAyNC0wNy0wN1QxMzo0OTo0Mi4wMzJaIiwicGVyIjoibWU6d3JpdGUiLCJhY3RpZCI6MjQzMDgwODMsInJnbiI6InVzZTEifQ.AKgwPueXJkzm9d0I9y4DzSKBwJ3Vi3t8IsOc2hpyDtk"

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## v1.0.0 (July 30, 2024)
+
+### Changed
+
+- **Refactor: Flat API replaced by Resource Classes**
+  - The client now uses a modular approach with resource classes instead of a flat API.
+  - Introduced a `Base` class for resources to encapsulate common functionality.
+  - All resource-specific logic is now encapsulated within individual resource classes (e.g., `Account`, `Board`).
+
+### Added
+
+- Support for enums
+
+### Breaking Changes
+
+- **Accessing Resources**:
+  - The way resources are accessed has changed.
+  - **Old**: `client.account`, `client.create_board`
+  - **New**: `client.accounts.query`, `client.board.create`
+
 ## v0.6.2 (April 21, 2024)
 
 ### Bug Fixes

data/README.md

@@ -4,7 +4,7 @@
 [![Gem Version](https://badge.fury.io/rb/monday_ruby.svg)](https://badge.fury.io/rb/monday_ruby)
 [![Coverage Status](https://coveralls.io/repos/github/sanifhimani/monday_ruby/badge.svg?branch=main)](https://coveralls.io/github/sanifhimani/monday_ruby?branch=main)
 
-This library provides convenient access to the monday.com API from the application written in the Ruby language.
+This library provides convenient access to the monday.com API from the application written in Ruby.
 
 The library provides:
 
@@ -12,39 +12,17 @@ The library provides:
 2. Easy configuration path for fast setup and use.
 3. Easy error handling.
 
-**Visit https://monday-ruby.gitbook.io/docs/ for detailed documentation on how to use the library.**
+**Check out the [Wiki](https://github.com/sanifhimani/monday_ruby/wiki) for detailed documentation on how to use the library.**
 
 ## Installation
 
-You don't need the source code unless you want to modify the gem. If you want to use the package, run:
-
-```sh
+```bash
 gem install monday_ruby
 ```
 
-If you want to build the gem from source:
-
-```sh
-gem build monday_ruby.gemspec
-```
-
-### Requirements
-
-* Ruby 2.7+
-
-### 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"
-```
-
 ## Usage
 
-***Complete list of actions along with examples are provided [here](https://monday-ruby.gitbook.io/docs/).***
+***Complete list of resources along with examples are provided in the [Wiki](https://github.com/sanifhimani/monday_ruby/wiki).***
 
 The library needs to be configured with your account's authentication token which is available on the Admin tab on monday.com. Elaborate documentation can be found [here](https://developer.monday.com/api-reference/docs/authentication).
 
@@ -60,7 +38,6 @@ require "monday_ruby"
 Monday.configure do |config|
   config.token = "<AUTH_TOKEN>"
 end
-
 ```
 
 #### Client specific config
@@ -70,7 +47,7 @@ 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.
+The version configuration field allows you to optionally pass in the version of the API you want to use. By default, the latest stable version is used.
 
 ```ruby
 require "monday_ruby"
@@ -89,35 +66,33 @@ Get access to response objects by initializing a client and using the appropriat
 client = Monday::Client.new(token: "<AUTH_TOKEN>")
 response = client.boards
 
+puts response.success?
 puts response.body
 ```
 
 ### Use cases
 
-Here are some common uses cases for the API client.
+Here are some common use cases for the API client.
 
 #### Fetching all the boards
 
-Initialize the client with the auth token and call the `boards` action.
+Initialize the client with the auth token and call the `boards` method.
 
 ```ruby
 client = Monday::Client.new(token: <AUTH_TOKEN>)
 
-response = client.boards
-# => <Monday::Response ...>
+response = client.boards # => <Monday::Response ...>
 
 # To check if the request was successful
-response.success?
-# => true
+response.success? # => true
 
 # To get the boards from the response
-response.dig("data", "boards")
-# => [...]
+response.dig("data", "boards") # => [...]
 ```
 
 #### Creating a new board
 
-Initialize the client with the auth token and call the `create_board` action.
+Initialize the client with the auth token and call the `create_board` method.
 
 ```ruby
 client = Monday::Client.new(token: <AUTH_TOKEN>)
@@ -128,21 +103,19 @@ args = {
   description: "Test board description"
 }
 
-response = client.create_board(args: args)
 # => <Monday::Response ...>
+response = client.create_board(args: args)
 
 # To check if the request was successful
-response.success?
-# => true
+response.success? # => true
 
 # To get the created board from the response
-response.dig("data", "create_board")
-# => { ... }
+response.dig("data", "create_board") # => { ... }
 ```
 
 #### Creating a new item on board
 
-Initialize the client with the auth token and call the `create_item` action.
+Initialize the client with the auth token and call the `create_item` method.
 
 ```ruby
 client = Monday::Client.new(token: <AUTH_TOKEN>)
@@ -160,35 +133,33 @@ args = {
   }
 }
 
-response = client.create_item(args: args)
 # => <Monday::Response ...>
+response = client.create_item(args: args)
 
 # To check if the request was successful
-response.success?
-# => true
+response.success? # => true
 
 # To get the created item from the response
-response.dig("data", "create_item")
-# => { ... }
+response.dig("data", "create_item") # => { ... }
 ```
 
 ## Development
 
 Run all tests:
 
-```sh
+```bash
 bundle exec rake spec
 ```
 
 Run linter:
 
-```sh
+```bash
 bundle exec rake rubocop
 ```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/sanifhimani/monday_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/sanifhimani/monday_ruby/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on [GitHub](https://github.com/sanifhimani/monday_ruby). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/sanifhimani/monday_ruby/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/monday/client.rb

@@ -15,20 +15,25 @@ module Monday
   # Client executes requests against the monday.com's API and
   # allows a user to mutate and retrieve resources.
   class Client
-    include Resources
-
     JSON_CONTENT_TYPE = "application/json"
     private_constant :JSON_CONTENT_TYPE
 
     attr_reader :config
 
     def initialize(config_args = {})
-      @config = config_options(config_args)
+      @config = configure(config_args)
+      Resources.initialize(self)
+    end
+
+    def make_request(body)
+      response = Request.post(uri, body, request_headers)
+
+      handle_response(Response.new(response))
     end
 
     private
 
-    def config_options(config_args)
+    def configure(config_args)
       return Monday.config if config_args.empty?
 
       Configuration.new(**config_args)
@@ -45,12 +50,6 @@ module Monday
       }
     end
 
-    def make_request(body)
-      response = Request.post(uri, body, request_headers)
-
-      handle_response(Response.new(response))
-    end
-
     def handle_response(response)
       return response if response.success?
 
@@ -58,7 +57,7 @@ module Monday
     end
 
     def raise_errors(response)
-      raise default_exception(response) unless (200..299).cover?(response.status)
+      raise default_exception(response) unless successful_response?(response.status)
 
       raise response_exception(response)
     end
@@ -75,5 +74,9 @@ module Monday
     def default_exception(response)
       Util.status_code_exceptions_mapping(response.status).new(response: response)
     end
+
+    def successful_response?(status)
+      (200..299).cover?(status)
+    end
   end
 end

data/lib/monday/resources/account.rb

@@ -1,19 +1,21 @@
 # frozen_string_literal: true
 
+require_relative "base"
+
 module Monday
   module Resources
     # Represents Monday.com's account resource.
-    module Account
+    class Account < Base
       DEFAULT_SELECT = %w[id name].freeze
 
       # Retrieves the users account.
       #
       # Allows customizing the values to retrieve using the select option.
       # By default, ID and name are retrieved.
-      def account(select: DEFAULT_SELECT)
-        query = "query { users { account {#{Util.format_select(select)}}}}"
+      def query(select: DEFAULT_SELECT)
+        request_query = "query{users{account {#{Util.format_select(select)}}}}"
 
-        make_request(query)
+        make_request(request_query)
       end
     end
   end

data/lib/monday/resources/activity_log.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require_relative "base"
+
 module Monday
   module Resources
     # Represents Monday.com's activity log resource.
-    module ActivityLog
+    class ActivityLog < Base
       DEFAULT_SELECT = %w[id event data].freeze
 
       # Retrieves the activity logs for boards.
@@ -12,11 +14,11 @@ module Monday
       # Allows filtering activity logs using the args option.
       # Allows customizing the values to retrieve using the select option.
       # By default, ID, event and data are retrieved.
-      def activity_logs(board_ids, args: {}, select: DEFAULT_SELECT)
-        query = "query { boards(ids: #{board_ids}) " \
-                "{ activity_logs#{Util.format_args(args)} {#{Util.format_select(select)}}}}"
+      def query(board_ids, args: {}, select: DEFAULT_SELECT)
+        request_query = "query{boards(ids: #{board_ids})" \
+                        "{activity_logs#{Util.format_args(args)}{#{Util.format_select(select)}}}}"
 
-        make_request(query)
+        make_request(request_query)
       end
     end
   end

data/lib/monday/resources/base.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Monday
+  module Resources
+    # Base class for all resources.
+    class Base
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      protected
+
+      def make_request(query)
+        client.make_request(query)
+      end
+    end
+  end
+end

data/lib/monday/resources/board.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require_relative "base"
+
 module Monday
   module Resources
     # Represents Monday.com's board resource.
-    module Board
+    class Board < Base
       DEFAULT_SELECT = %w[id name description].freeze
 
       # Retrieves all the boards.
@@ -11,10 +13,10 @@ module Monday
       # Allows filtering boards using the args option.
       # Allows customizing the values to retrieve using the select option.
       # By default, ID, name and description fields are retrieved.
-      def boards(args: {}, select: DEFAULT_SELECT)
-        query = "query { boards#{Util.format_args(args)} {#{Util.format_select(select)}}}"
+      def query(args: {}, select: DEFAULT_SELECT)
+        request_query = "query{boards#{Util.format_args(args)}{#{Util.format_select(select)}}}"
 
-        make_request(query)
+        make_request(request_query)
       end
 
       # Creates a new boards.
@@ -22,8 +24,8 @@ module Monday
       # Allows customizing creating a board 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_board(args: {}, select: DEFAULT_SELECT)
-        query = "mutation { create_board#{Util.format_args(args)} {#{Util.format_select(select)}}}"
+      def create(args: {}, select: DEFAULT_SELECT)
+        query = "mutation{create_board#{Util.format_args(args)}{#{Util.format_select(select)}}}"
 
         make_request(query)
       end
@@ -33,8 +35,8 @@ module Monday
       # Allows customizing duplicating the board using the args option.
       # Allows customizing the values to retrieve using the select option.
       # By default, ID, name and description fields are retrieved.
-      def duplicate_board(args: {}, select: DEFAULT_SELECT)
-        query = "mutation { duplicate_board#{Util.format_args(args)} { board {#{Util.format_select(select)}}}}"
+      def duplicate(args: {}, select: DEFAULT_SELECT)
+        query = "mutation{duplicate_board#{Util.format_args(args)}{board{#{Util.format_select(select)}}}}"
 
         make_request(query)
       end
@@ -43,8 +45,8 @@ module Monday
       #
       # Allows customizing updating the board using the args option.
       # Returns the ID of the updated board.
-      def update_board(args: {})
-        query = "mutation { update_board#{Util.format_args(args)}}"
+      def update(args: {})
+        query = "mutation{update_board#{Util.format_args(args)}}"
 
         make_request(query)
       end
@@ -54,8 +56,8 @@ module Monday
       # Requires board_id to archive board.
       # Allows customizing the values to retrieve using the select option.
       # By default, returns the ID of the board archived.
-      def archive_board(board_id, select: ["id"])
-        query = "mutation { archive_board(board_id: #{board_id}) {#{Util.format_select(select)}}}"
+      def archive(board_id, select: ["id"])
+        query = "mutation{archive_board(board_id: #{board_id}){#{Util.format_select(select)}}}"
 
         make_request(query)
       end
@@ -65,8 +67,8 @@ module Monday
       # Requires board_id to delete the board.
       # Allows customizing the values to retrieve using the select option.
       # By default, returns the ID of the board deleted.
-      def delete_board(board_id, select: ["id"])
-        query = "mutation { delete_board(board_id: #{board_id}) {#{Util.format_select(select)}}}"
+      def delete(board_id, select: ["id"])
+        query = "mutation{delete_board(board_id: #{board_id}){#{Util.format_select(select)}}}"
 
         make_request(query)
       end
@@ -76,9 +78,9 @@ module Monday
       # Requires board_id and user_ids to delete subscribers.
       # Allows customizing the values to retrieve using the select option.
       # By default, returns the deleted subscriber IDs.
-      def delete_board_subscribers(board_id, user_ids, select: ["id"])
-        query = "mutation { delete_subscribers_from_board(" \
-                "board_id: #{board_id}, user_ids: #{user_ids}) {#{Util.format_select(select)}}}"
+      def delete_subscribers(board_id, user_ids, select: ["id"])
+        query = "mutation{delete_subscribers_from_board(" \
+                "board_id: #{board_id}, user_ids: #{user_ids}){#{Util.format_select(select)}}}"
 
         make_request(query)
       end

data/lib/monday/resources/board_view.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require_relative "base"
+
 module Monday
   module Resources
     # Represents Monday.com's board view resource.
-    module BoardView
+    class BoardView < Base
       DEFAULT_SELECT = %w[id name type].freeze
 
       # Retrieves board views from a specific board.
@@ -11,10 +13,10 @@ module Monday
       # Allows filtering views using the args option.
       # Allows customizing the values to retrieve using the select option.
       # By default, ID, name and type fields are retrieved.
-      def board_views(args: {}, select: DEFAULT_SELECT)
-        query = "query { boards#{Util.format_args(args)} { views {#{Util.format_select(select)}}}}"
+      def query(args: {}, select: DEFAULT_SELECT)
+        request_query = "query{boards#{Util.format_args(args)}{views{#{Util.format_select(select)}}}}"
 
-        make_request(query)
+        make_request(request_query)
       end
     end
   end

data/lib/monday/resources/column.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require_relative "base"
+
 module Monday
   module Resources
     # Represents Monday.com's column resource.
-    module Column
+    class Column < Base
       DEFAULT_SELECT = %w[id title description].freeze
 
       # Retrieves all the columns for the boards.
@@ -11,10 +13,10 @@ module Monday
       # Allows filtering columns using the args option.
       # Allows customizing the values to retrieve using the select option.
       # By default, ID, title and description fields are retrieved.
-      def columns(args: {}, select: DEFAULT_SELECT)
-        query = "query { boards#{Util.format_args(args)} { columns {#{Util.format_select(select)}}}}"
+      def query(args: {}, select: DEFAULT_SELECT)
+        request_query = "query{boards#{Util.format_args(args)}{columns{#{Util.format_select(select)}}}}"
 
-        make_request(query)
+        make_request(request_query)
       end
 
       # Retrieves metadata about one or a collection of columns.
@@ -25,8 +27,8 @@ module Monday
       def column_values(board_ids = [], item_ids = [], select: DEFAULT_SELECT)
         board_args = board_ids.empty? ? "" : "ids: #{board_ids}"
         item_args = item_ids.empty? ? "" : "ids: #{item_ids}"
-        query = "query { boards (#{board_args}) { items (#{item_args}) " \
-                "{ column_values {#{Util.format_select(select)}}}}}"
+        query = "query{boards(#{board_args}){items(#{item_args})" \
+                "{column_values{#{Util.format_select(select)}}}}}"
 
         make_request(query)
       end
@@ -36,8 +38,8 @@ module Monday
       # Allows customizing the column creation using the args option.
       # Allows customizing the values to retrieve using the select option.
       # By default, ID, title and description fields are retrieved.
-      def create_column(args: {}, select: DEFAULT_SELECT)
-        query = "mutation { create_column#{Util.format_args(args)} {#{Util.format_select(select)}}}"
+      def create(args: {}, select: DEFAULT_SELECT)
+        query = "mutation{create_column#{Util.format_args(args)}{#{Util.format_select(select)}}}"
 
         make_request(query)
       end
@@ -47,8 +49,8 @@ module Monday
       # Allows customizing the update using the args option.
       # Allows customizing the values to retrieve using the select option.
       # By default, ID, title and description fields are retrieved.
-      def change_column_title(args: {}, select: DEFAULT_SELECT)
-        query = "mutation { change_column_title#{Util.format_args(args)} {#{Util.format_select(select)}}}"
+      def change_title(args: {}, select: DEFAULT_SELECT)
+        query = "mutation{change_column_title#{Util.format_args(args)}{#{Util.format_select(select)}}}"
 
         make_request(query)
       end
@@ -58,8 +60,8 @@ module Monday
       # Allows customizing the update using the args option.
       # Allows customizing the values to retrieve using the select option.
       # By default, ID, title and description fields are retrieved.
-      def change_column_metadata(args: {}, select: DEFAULT_SELECT)
-        query = "mutation { change_column_metadata#{Util.format_args(args)} {#{Util.format_select(select)}}}"
+      def change_metadata(args: {}, select: DEFAULT_SELECT)
+        query = "mutation{change_column_metadata#{Util.format_args(args)}{#{Util.format_select(select)}}}"
 
         make_request(query)
       end
@@ -69,8 +71,8 @@ module Monday
       # Allows customizing the update using the args option.
       # Allows customizing the item values to retrieve using the select option.
       # By default, ID, and name fields are retrieved.
-      def change_column_value(args: {}, select: %w[id name])
-        query = "mutation { change_column_value#{Util.format_args(args)} {#{Util.format_select(select)}}}"
+      def change_value(args: {}, select: %w[id name])
+        query = "mutation{change_column_value#{Util.format_args(args)}{#{Util.format_select(select)}}}"
 
         make_request(query)
       end
@@ -80,8 +82,8 @@ module Monday
       # Allows customizing the update using the args option.
       # Allows customizing the item values to retrieve using the select option.
       # By default, ID, and name fields are retrieved.
-      def change_simple_column_value(args: {}, select: %w[id name])
-        query = "mutation { change_simple_column_value#{Util.format_args(args)} {#{Util.format_select(select)}}}"
+      def change_simple_value(args: {}, select: %w[id name])
+        query = "mutation{change_simple_column_value#{Util.format_args(args)}{#{Util.format_select(select)}}}"
 
         make_request(query)
       end
@@ -91,8 +93,8 @@ module Monday
       # Allows customizing the update using the args option.
       # Allows customizing the item values to retrieve using the select option.
       # By default, ID, and name fields are retrieved.
-      def change_multiple_column_value(args: {}, select: %w[id name])
-        query = "mutation { change_multiple_column_values#{Util.format_args(args)} {#{Util.format_select(select)}}}"
+      def change_multiple_values(args: {}, select: %w[id name])
+        query = "mutation{change_multiple_column_values#{Util.format_args(args)}{#{Util.format_select(select)}}}"
 
         make_request(query)
       end
@@ -102,8 +104,8 @@ module Monday
       # Requires board_id and column_id to delete.
       # Allows customizing the values to retrieve using the select option.
       # By default, ID is retrieved.
-      def delete_column(board_id, column_id, select: %w[id])
-        query = "mutation { delete_column(board_id: #{board_id}, column_id: #{column_id}) " \
+      def delete(board_id, column_id, select: %w[id])
+        query = "mutation{delete_column(board_id: #{board_id}, column_id: \"#{column_id}\")" \
                 "{#{Util.format_select(select)}}}"
 
         make_request(query)