active_call-zoho_crm 0.1.0 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5692f8ba47b601d8c6781d92154ae4f2b229923bfdb34c5b1537eef054558bc3
4
- data.tar.gz: 95346571658eddc07819ad96a8b8d2bda19942dcd8d20d23fc6efc4283ff0a24
3
+ metadata.gz: a8852c4549beb42d7a307486c52e28b2d5e1933f8dc070729dd96f0c5daff865
4
+ data.tar.gz: 8b26e9456a10f34049a8fb5ca4fee049a42985d2195bec6bc4b9446e0418487b
5
5
  SHA512:
6
- metadata.gz: 5f2d97143511747fec70a48323a0590cd633592b38e379be100c8a12666d31ff20e83c0d6975be5cbe97be265c3792ab931debaa431fe2b46b8e653eab32533e
7
- data.tar.gz: da622d9adc9047203d77e8c76340ddb3c800f898097d93562b0d381593b7641361d7120dd2c4b88fb8b154d2c74039c37cf2fc615ffcc573c7b33bfca59e24d7
6
+ metadata.gz: 93311690a3463462b3bebdc338046ad4679b3ea7d9b3b0e1c0fe71ec063e5e75330f4e3a898a1fe2ccd7e9e11c3843a663496cef96e535bd5c9d038efe43f917
7
+ data.tar.gz: 51035aac4ef6719b844453f4d5ecb15de506f9000724e11a471fcc468880aec0176f3d644f685899bb4aa9158bcbac8677807292aee150ac8a7383837a421828
data/CHANGELOG.md CHANGED
@@ -1,4 +1,15 @@
1
- ## [Unreleased]
1
+ ## [0.1.3] - 2025-05-09
2
+
3
+ - README and Gemspec description updates.
4
+
5
+ ## [0.1.2] - 2025-04-11
6
+
7
+ - No changes. Gem version 0.1.1 does not seem to be findable.
8
+
9
+ ## [0.1.1] - 2025-04-11
10
+
11
+ - Update `CACHE_KEY` base `zoho_sign/...` -> `zoho_crm/...`
12
+ - README updates with links to API endpoint docs
2
13
 
3
14
  ## [0.1.0] - 2025-04-02
4
15
 
data/README.md CHANGED
@@ -1,6 +1,16 @@
1
1
  # Active Call - Zoho CRM
2
2
 
3
- Zoho CRM exposes the [Zoho CRM API](https://www.zoho.com/crm/developer/docs/api) endpoints through service objects.
3
+ [![Gem Version](https://badge.fury.io/rb/active_call-zoho_crm.svg?icon=si%3Arubygems)](https://badge.fury.io/rb/active_call-zoho_crm)
4
+
5
+ Zoho CRM exposes the [Zoho CRM API](https://www.zoho.com/crm/developer/docs/api) endpoints through [Active Call](https://rubygems.org/gems/active_call) service objects.
6
+
7
+ <div align="center">
8
+ <a href="https://platform45.com?utm_source=github&utm_content=zoho_crm">
9
+ <picture>
10
+ <img src="https://github.com/user-attachments/assets/19fd40df-2ce9-4f30-8120-d53f3fbf9f07">
11
+ </picture>
12
+ </a>
13
+ </div>
4
14
 
5
15
  - [Installation](#installation)
6
16
  - [Configuration](#configuration)
@@ -16,18 +26,16 @@ Zoho CRM exposes the [Zoho CRM API](https://www.zoho.com/crm/developer/docs/api)
16
26
 
17
27
  ## Installation
18
28
 
19
- TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
20
-
21
29
  Install the gem and add to the application's Gemfile by executing:
22
30
 
23
31
  ```bash
24
- bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
32
+ bundle add active_call-zoho_crm
25
33
  ```
26
34
 
27
35
  If bundler is not being used to manage dependencies, install the gem by executing:
28
36
 
29
37
  ```bash
30
- gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
38
+ gem install active_call-zoho_crm
31
39
  ```
32
40
 
33
41
  ## Configuration
@@ -228,6 +236,8 @@ For custom modules, use their respective API names in the request URL. You can o
228
236
  #### List records
229
237
 
230
238
  ```ruby
239
+ # https://www.zoho.com/crm/developer/docs/api/v7/get-records.html
240
+
231
241
  ZohoCrm::Record::ListService.call(module_name: 'Contacts', fields: 'Email,Last_Name', page: 1, per_page: 10).each do |facade|
232
242
  facade.attributes
233
243
  end
@@ -244,6 +254,8 @@ Columns to sort by are `id`, `Created_Time` and `Modified_Time`.
244
254
  #### Search records
245
255
 
246
256
  ```ruby
257
+ # https://www.zoho.com/crm/developer/docs/api/v7/search-records.html
258
+
247
259
  ZohoCrm::Record::SearchService.call(module_name: 'Contacts', email: 'eric.cartman@example.com', page: 1, per_page: 10).each do |facade|
248
260
  facade.attributes
249
261
  end
@@ -284,6 +296,8 @@ ZohoCrm::Record::SearchService.call(module_name: 'Contacts', word: 'eric').map {
284
296
  #### Get a record
285
297
 
286
298
  ```ruby
299
+ # https://www.zoho.com/crm/developer/docs/api/v7/get-records.html
300
+
287
301
  service = ZohoCrm::Record::GetService.call(module_name: 'Contacts', id: '')
288
302
  service.id
289
303
  service.attributes
@@ -296,7 +310,9 @@ service.attributes['Owner']['name']
296
310
  #### Create a record
297
311
 
298
312
  ```ruby
299
- service = ZohoCrm::Record::CreateService.call(
313
+ # https://www.zoho.com/crm/developer/docs/api/v7/insert-records.html
314
+
315
+ ZohoCrm::Record::CreateService.call(
300
316
  module_name: 'Contacts',
301
317
  data: {
302
318
  'Email' => 'eric.cartman@example.com',
@@ -309,7 +325,9 @@ service = ZohoCrm::Record::CreateService.call(
309
325
  #### Update a record
310
326
 
311
327
  ```ruby
312
- service = ZohoCrm::Record::UpdateService.call(
328
+ # https://www.zoho.com/crm/developer/docs/api/v7/update-records.html
329
+
330
+ ZohoCrm::Record::UpdateService.call(
313
331
  module_name: 'Contacts',
314
332
  data: {
315
333
  'id' => '',
@@ -321,7 +339,9 @@ service = ZohoCrm::Record::UpdateService.call(
321
339
  #### Upsert a record
322
340
 
323
341
  ```ruby
324
- service = ZohoCrm::Record::UpsertService.call(
342
+ # https://www.zoho.com/crm/developer/docs/api/v7/upsert-records.html
343
+
344
+ ZohoCrm::Record::UpsertService.call(
325
345
  module_name: 'Contacts',
326
346
  data: {
327
347
  'Email' => 'eric.cartman@example.com',
@@ -335,7 +355,25 @@ service = ZohoCrm::Record::UpsertService.call(
335
355
  #### Delete a record
336
356
 
337
357
  ```ruby
338
- service = ZohoCrm::Record::DeleteService.call(module_name: 'Contacts', id: '')
358
+ # https://www.zoho.com/crm/developer/docs/api/v7/delete-records.html
359
+
360
+ ZohoCrm::Record::DeleteService.call(module_name: 'Contacts', id: '')
361
+ ```
362
+
363
+ </details>
364
+
365
+ <details>
366
+ <summary>Organization</summary>
367
+
368
+ ### Organization
369
+
370
+ #### Get a organization
371
+
372
+ ```ruby
373
+ # https://www.zoho.com/crm/developer/docs/api/v7/get-org-data.html
374
+
375
+ service = ZohoCrm::Organization::GetService.call
376
+ service.attributes
339
377
  ```
340
378
 
341
379
  </details>
@@ -9,6 +9,8 @@ class ZohoCrm::AccessToken::GetService < ZohoCrm::BaseService
9
9
 
10
10
  # Get access token.
11
11
  #
12
+ # https://www.zoho.com/crm/developer/docs/api/v7/refresh.html
13
+ #
12
14
  # ==== Examples
13
15
  #
14
16
  # service = ZohoCrm::AccessToken::GetService.call
@@ -5,7 +5,7 @@ class ZohoCrm::BaseService < ActiveCall::Base
5
5
 
6
6
  self.abstract_class = true
7
7
 
8
- CACHE_KEY = { access_token: 'zoho_sign/base_service/access_token' }.freeze
8
+ CACHE_KEY = { access_token: 'zoho_crm/base_service/access_token' }.freeze
9
9
 
10
10
  config_accessor :base_url, default: 'https://www.zohoapis.com/crm/v7', instance_writer: false
11
11
  config_accessor :cache, default: ActiveSupport::Cache::MemoryStore.new, instance_writer: false
@@ -20,6 +20,8 @@ class ZohoCrm::GrantToken::GetService < ZohoCrm::BaseService
20
20
 
21
21
  # Get refresh token from grant token.
22
22
  #
23
+ # https://www.zoho.com/crm/developer/docs/api/v7/access-refresh.html
24
+ #
23
25
  # ==== Examples
24
26
  #
25
27
  # service = ZohoCrm::GrantToken::GetService.call(grant_token: '', client_id: '', client_secret: '')
@@ -7,6 +7,8 @@ class ZohoCrm::Organization::GetService < ZohoCrm::BaseService
7
7
 
8
8
  # Get a document.
9
9
  #
10
+ # https://www.zoho.com/crm/developer/docs/api/v7/get-org-data.html
11
+ #
10
12
  # ==== Examples
11
13
  #
12
14
  # service = ZohoCrm::Organization::GetService.call
@@ -16,6 +16,8 @@ class ZohoCrm::Record::CreateService < ZohoCrm::BaseService
16
16
 
17
17
  # Create a record.
18
18
  #
19
+ # https://www.zoho.com/crm/developer/docs/api/v7/insert-records.html
20
+ #
19
21
  # ==== Examples
20
22
  #
21
23
  # service = ZohoCrm::Record::CreateService.call(
@@ -16,6 +16,8 @@ class ZohoCrm::Record::DeleteService < ZohoCrm::BaseService
16
16
 
17
17
  # Delete a record.
18
18
  #
19
+ # https://www.zoho.com/crm/developer/docs/api/v7/delete-records.html
20
+ #
19
21
  # ==== Examples
20
22
  #
21
23
  # service = ZohoCrm::Record::DeleteService.call(module_name: 'Contacts', id: '')
@@ -16,6 +16,8 @@ class ZohoCrm::Record::GetService < ZohoCrm::BaseService
16
16
 
17
17
  # Get a document.
18
18
  #
19
+ # https://www.zoho.com/crm/developer/docs/api/v7/get-records.html
20
+ #
19
21
  # ==== Examples
20
22
  #
21
23
  # service = ZohoCrm::Record::GetService.call(module_name: 'Contacts', id: '')
@@ -18,6 +18,8 @@ class ZohoCrm::Record::ListService < ZohoCrm::BaseService
18
18
 
19
19
  # List records.
20
20
  #
21
+ # https://www.zoho.com/crm/developer/docs/api/v7/get-records.html
22
+ #
21
23
  # ==== Examples
22
24
  #
23
25
  # service = ZohoCrm::Record::ListService.call(module_name: 'Contacts', fields: 'Email,Last_Name').first
@@ -18,6 +18,8 @@ class ZohoCrm::Record::SearchService < ZohoCrm::BaseService
18
18
 
19
19
  # List records.
20
20
  #
21
+ # https://www.zoho.com/crm/developer/docs/api/v7/search-records.html
22
+ #
21
23
  # ==== Examples
22
24
  #
23
25
  # service = ZohoCrm::Record::SearchService.call(module_name: 'Contacts', email: 'eric.cartman@example.com').first
@@ -16,6 +16,8 @@ class ZohoCrm::Record::UpdateService < ZohoCrm::BaseService
16
16
 
17
17
  # Create a record.
18
18
  #
19
+ # https://www.zoho.com/crm/developer/docs/api/v7/update-records.html
20
+ #
19
21
  # ==== Examples
20
22
  #
21
23
  # service = ZohoCrm::Record::UpdateService.call(
@@ -19,6 +19,8 @@ class ZohoCrm::Record::UpsertService < ZohoCrm::BaseService
19
19
 
20
20
  # Create a record.
21
21
  #
22
+ # https://www.zoho.com/crm/developer/docs/api/v7/upsert-records.html
23
+ #
22
24
  # ==== Examples
23
25
  #
24
26
  # service = ZohoCrm::Record::UpsertService.call(
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module ZohoCrm
4
- VERSION = '0.1.0'
4
+ VERSION = '0.1.3'
5
5
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: active_call-zoho_crm
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Kobus Joubert
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2025-04-05 00:00:00.000000000 Z
11
+ date: 2025-05-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: active_call-api
@@ -24,7 +24,8 @@ dependencies:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
26
  version: '0.1'
27
- description: Zoho CRM exposes the Zoho CRM API endpoints through service objects.
27
+ description: Zoho CRM exposes the Zoho CRM API endpoints through Active Call service
28
+ objects.
28
29
  email:
29
30
  - kobus@translate3d.com
30
31
  executables: []
@@ -85,5 +86,5 @@ requirements: []
85
86
  rubygems_version: 3.3.27
86
87
  signing_key:
87
88
  specification_version: 4
88
- summary: Zoho CRM
89
+ summary: Zoho CRM service objects
89
90
  test_files: []