monday_ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd002aba608dc2f94d8203eee88629ff3185e305e09096ac6206e650b2b6f54f
-  data.tar.gz: b2abc595ac065fad70b823917f063cd8ffd1088c736b38ba18c5417272d6a8ae
+  metadata.gz: e17b85396d9acd3d8dc9346a1c1b54f09280d8815941deee3ed952de6cf55ad1
+  data.tar.gz: 2bc9f14384736558a423f8690175a49dcf716746a2db1f5a5ef51cd7fefb0532
 SHA512:
-  metadata.gz: ab592952c05ad6fcf5c7cc2ae78039939daa46f0f7bac2cc8460e66566d6da05a123c0a9bc23cbae993cd1df6122be275528d12bf87c114bc46bb88fc094e554
-  data.tar.gz: 198556d5abce107ec8109f4b32eee408b618ccea654dbe45f3b0016b71f1be0a9440114aba607a6fdb49009c14f8b49607fd161dbeb246e70dea0f5237a34744
+  metadata.gz: d594d0addabe0adbb550ecf474e12c4d7645e10bdf37a9fe10c7b930ab63d954204c1658f30dd6258303c2b7c1e8fb6ace0476beb23fbf91fc864f9dfb4f6fe4
+  data.tar.gz: e42cdc2c6bcf6de3d5652e5bfa9c3d86f377155f0c2e06e76c2857b691341eca3e115e6abc8811fa02976afcda4997f8f3feffbc3f16b058bf4f3b9849c69835

data/.env

@@ -0,0 +1 @@
+token="[REPLACE_TOKEN]"

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
   NewCops: enable
 
 Style/StringLiterals:

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## v0.2.0 (July 04, 2023)
+
+### Added
+
+- Support for global config
+- VCR for test suite
+
+### Removed
+
+- [BREAKING] Support for Ruby 2.6
+
 ## v0.1.0 (June 28, 2023)
 
 - Initial release

data/README.md

@@ -1,8 +1,14 @@
 # Monday API Library for Ruby
 
 ![Build Status](https://github.com/sanifhimani/monday_ruby/actions/workflows/ci.yml/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/monday_ruby.svg)](https://badge.fury.io/rb/monday_ruby)
 
-This library provides convenient access to the Monday.com API from the application written in the Ruby language. It includes a pre-defined set of actions for the API resources.
+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.
 
 **Visit https://monday-ruby.gitbook.io/docs/ for detailed documentation on how to use the library.**
 
@@ -22,7 +28,7 @@ gem build monday_ruby.gemspec
 
 ### Requirements
 
-* Ruby 2.6+
+* Ruby 2.7+
 
 ### Bundler
 
@@ -40,6 +46,22 @@ gem "monday_ruby"
 
 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).
 
+### Configuration
+
+Once you have the authentication token, you can either globally configure the library or you can configure a specific client.
+
+#### Global config
+
+```ruby
+require "monday_ruby"
+
+Monday.configure do |config|
+  config.token = "<AUTH_TOKEN>"
+end
+
+```
+
+#### Client specific config
 ```ruby
 require "monday_ruby"
 

data/docs/README.md

@@ -0,0 +1,12 @@
+# 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.
+
+#### Requirements
+
+* Ruby 2.7+

data/docs/SUMMARY.md

@@ -0,0 +1,39 @@
+# 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)
+* [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

@@ -0,0 +1,15 @@
+# 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

@@ -0,0 +1,28 @@
+# 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>)
+```
+

data/docs/getting-started.md

@@ -0,0 +1,25 @@
+# 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"
+```

data/docs/quick-start.md

@@ -0,0 +1,269 @@
+# Quick Start
+
+The following is the minimum needed to fetch all the boards with their IDs and column IDs:
+
+{% code lineNumbers="true" %}
+```ruby
+require "monday_ruby"
+
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+select = [
+  "id",
+  {
+    columns: "id"
+  }
+]
+
+response = client.boards(select: select)
+# => <Monday::Response ...>
+
+puts response.body
+```
+{% endcode %}
+
+The response body from the above query would be as follows:
+
+{% code lineNumbers="true" %}
+```json
+{
+  "data": {
+    "boards": [
+      {
+        "id": "123",
+        "columns": [
+          {
+            "id": "name"
+          },
+          {
+            "id": "subitems"
+          },
+          {
+            "id": "work_status"
+          },
+          {
+            "id": "keywords"
+          }
+        ]
+      },
+      {
+        "id": "456",
+        "columns": [
+          {
+            "id": "name"
+          },
+          {
+            "id": "person"
+          },
+          {
+            "id": "status"
+          },
+          {
+            "id": "date0"
+          }
+        ]
+      },
+    ]
+  },
+  "account_id": 123
+}
+```
+{% endcode %}
+
+### Advanced select query
+
+The following is the minimum needed to fetch:
+
+1. All the boards' IDs, names and count of items on each board.
+2. The ID, title and type for the columns on each board.
+3. The ID, name and the value of the items on each board.
+
+{% code lineNumbers="true" %}
+```ruby
+require "monday_ruby"
+
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+select = [
+  "id",
+  "name",
+  "items_count",
+  {
+    columns: %w[id title type],
+    items: [
+      "id",
+      "name",
+      {
+        column_values: "value"
+      }
+    ]
+  }
+]
+
+response = client.boards(select: select)
+# => <Monday::Response ...>
+
+puts response.body
+```
+{% endcode %}
+
+The response body from the above query would be as follows:
+
+{% code lineNumbers="true" %}
+```json
+{
+  "data": {
+    "boards": [
+      {
+        "id": "123",
+        "name": "New test board",
+        "items_count": 2,
+        "columns": [
+          {
+            "id": "name",
+            "title": "Name",
+            "type": "name"
+          },
+          {
+            "id": "subitems",
+            "title": "Subitems",
+            "type": "subtasks"
+          },
+          {
+            "id": "work_status",
+            "title": "Status",
+            "type": "color"
+          },
+          {
+            "id": "keywords",
+            "title": "Keywords",
+            "type": "dropdown"
+          }
+        ],
+        "items": [
+          {
+            "id": "4708726090",
+            "name": "Task 1",
+            "column_values": [
+              {
+                "value": null
+              },
+              {
+                "value": "{\"index\":0,\"changed_at\":\"2023-06-27T16:21:22.192Z\"}"
+              },
+              {
+                "value": "{\"ids\":[1]}"
+              }
+            ]
+          },
+          {
+            "id": "4713421325",
+            "name": "New item",
+            "column_values": [
+              {
+                "value": null
+              },
+              {
+                "value": null
+              },
+              {
+                "value": null
+              }
+            ]
+          }
+        ]
+      },
+      {
+        "id": "456",
+        "name": "Your first board",
+        "items_count": 3,
+        "columns": [
+          {
+            "id": "name",
+            "title": "Name",
+            "type": "name"
+          },
+          {
+            "id": "subitems",
+            "title": "Subitems",
+            "type": "subtasks"
+          },
+          {
+            "id": "person",
+            "title": "Person",
+            "type": "multiple-person"
+          },
+          {
+            "id": "status",
+            "title": "Status",
+            "type": "color"
+          },
+          {
+            "id": "date4",
+            "title": "Date",
+            "type": "date"
+          }
+        ],
+        "items": [
+          {
+            "id": "4691485763",
+            "name": "Item 1",
+            "column_values": [
+              {
+                "value": null
+              },
+              {
+                "value": "{\"changed_at\":\"2022-10-26T12:39:58.664Z\",\"personsAndTeams\":[{\"id\":44865791,\"kind\":\"person\"}]}"
+              },
+              {
+                "value": "{\"index\":0,\"post_id\":null,\"changed_at\":\"2019-03-01T17:24:57.321Z\"}"
+              },
+              {
+                "value": "{\"date\":\"2023-06-21\",\"icon\":null,\"changed_at\":\"2022-12-18T14:03:06.455Z\"}"
+              }
+            ]
+          },
+          {
+            "id": "4691485774",
+            "name": "Item 2",
+            "column_values": [
+              {
+                "value": null
+              },
+              {
+                "value": null
+              },
+              {
+                "value": "{\"index\":1,\"post_id\":null,\"changed_at\":\"2019-03-01T17:28:23.178Z\"}"
+              },
+              {
+                "value": "{\"date\":\"2023-06-23\",\"icon\":null,\"changed_at\":\"2022-12-25T12:31:18.096Z\"}"
+              }
+            ]
+          },
+          {
+            "id": "4691485784",
+            "name": "Item 3",
+            "column_values": [
+              {
+                "value": null
+              },
+              {
+                "value": null
+              },
+              {
+                "value": "{\"index\":2,\"post_id\":null,\"changed_at\":\"2022-12-11T14:33:50.083Z\"}"
+              },
+              {
+                "value": "{\"date\":\"2023-06-25\",\"changed_at\":\"2022-12-25T12:31:20.220Z\"}"
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  },
+  "account_id": 123
+}
+```
+{% endcode %}

data/docs/resources/README.md

@@ -0,0 +1,27 @@
+# Resources
+
+Once you have the client set up, you can call the API resources using the client.
+
+{% content-ref url="account/" %}
+[account](account/)
+{% endcontent-ref %}
+
+{% content-ref url="activity-log/" %}
+[activity-log](activity-log/)
+{% endcontent-ref %}
+
+{% content-ref url="board-view/" %}
+[board-view](board-view/)
+{% endcontent-ref %}
+
+{% content-ref url="board/" %}
+[board](board/)
+{% endcontent-ref %}
+
+{% content-ref url="column/" %}
+[column](column/)
+{% endcontent-ref %}
+
+{% content-ref url="item/" %}
+[item](item/)
+{% endcontent-ref %}

data/docs/resources/account/README.md

@@ -0,0 +1,9 @@
+# Account
+
+The account API is used to access the account data. It includes the following methods:
+
+[accounts.md](accounts.md "mention")
+
+{% hint style="info" %}
+Visit monday.com's API documentation to know more about the [account API](https://developer.monday.com/api-reference/docs/account).
+{% endhint %}

data/docs/resources/account/accounts.md

@@ -0,0 +1,82 @@
+# #accounts
+
+Querying the `account` API will return the metadata for the account.
+
+{% hint style="info" %}
+This account is the one that is associated with the authentication token.
+{% endhint %}
+
+### Basic usage
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+response = client.account
+# => <Monday::Response ...>
+
+puts response.body
+```
+{% endcode %}
+
+This will return the accounts' ID and name fields by default.
+
+The response body from the above query would be as follows:
+
+{% code lineNumbers="true" %}
+```json
+{
+  "data": {
+    "users": [
+      {
+        "account": {
+          "id": 1234,
+          "name": "Test User's Team"
+        }
+      }
+    ]
+  },
+  "account_id": 123
+}
+```
+{% endcode %}
+
+### Customizing fields to retrieve
+
+You can customize the fields to retrieve by passing in the `select` option and listing all the fields you need to retrieve as an array.
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+select = %w[id name slug logo country_code]
+
+response = client.account(select: select)
+
+puts response.body
+```
+{% endcode %}
+
+### Retrieving nested fields
+
+Some fields have nested attributes, and you need to specify the attributes to retrieve that field; else, the API will respond with an error. For example, the field `plan` is of type `Plan` and expects you to pass the attributes you want to retrieve for the `plan` field.
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+select = [
+  "id",
+  "name",
+  {
+    creator: %w[id name email is_admin]
+  }
+]
+
+response = client.boards(select: select)
+
+puts response.body
+```
+{% endcode %}
+
+You can find the list of all the available fields for account [here](https://developer.monday.com/api-reference/docs/account#fields).

data/docs/resources/activity-log/README.md

@@ -0,0 +1,9 @@
+# Activity Log
+
+The activity log API is used to access the activity on your boards. It includes the following methods:
+
+[activity\_logs.md](activity\_logs.md "mention")
+
+{% hint style="info" %}
+Visit monday.com's API documentation to know more about the [activity logs API](https://developer.monday.com/api-reference/docs/activity-logs).
+{% endhint %}