worksection-ruby 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd335a7a6e13d6915170afd82ec11f51eb2960af5cb704d499d3d0abdc91a8ea
-  data.tar.gz: 20f9940f85787ed9854750ebcbcf7c512bcff6f21f3fb7909288f59b17a7426e
+  metadata.gz: f6c0d980e612a4a3a25b119ee6fc9dbbbe49415b923a0634367c3279b417b7a2
+  data.tar.gz: ad9e85aca8ca8d38ce681430dcdf4a1a2c2ab368e4fa866d89d22e864f9fbbd7
 SHA512:
-  metadata.gz: 59c127e31ee759244416149b79eed81253c461741b83b500636ae0e8dce8e4a148395790f25511b23b53b43e97a914a8ac2a32cc7f0dc57ec94a8bc00511b66d
-  data.tar.gz: 3923f76eb5ba664a8b6b93af8e2ae202b0a8da566e82055b2ad6a2497256953cedef64a21fa096d1bcad7b551dd98b73e6fb6e2bb162e7e3a54bebbdfecfb97d
+  metadata.gz: d56355caa674d4ce6cce499d4e9ffd3a5b27485e6c33977480b401d8a9c2c8e06457ce1aed0ba93dc5370a3fd2abf2d8247454634e4dfaef6042e231cdebcfe5
+  data.tar.gz: 15a2fd1bcc1992da3c9e36b66446551cf3c037608e09a207398f36227501efe35ccfaf7e07d2ae7ed2012f99c22e232d21dbf8ff81b7a7d39d84c70bf368f293

data/README.md

@@ -19,7 +19,7 @@ Or install it yourself as:
     $ gem install worksection-ruby
 
 ## Usage
-### API methods: getting data 
+###API methods: getting data 
 Action | Method | Hash Parameters
 -------|--------|-----------
 Returns project names, their statuses (archive, active, pending), company and relative reference to the project. |get_projects|
@@ -30,7 +30,7 @@ Returns the costs incurred for the period, their executor (user_from field), cor
 Returns the text field with user comments|get_comments|
 Returns data about all users in account|get_users|
 
-### API methods: creating projects/tasks/comments
+###API methods: creating projects/tasks/comments
 
 Action | Method | Hash Parameters
 -------|--------|-----------
@@ -40,7 +40,7 @@ Creating a Subtask|post_subtask|
 Placement of time and financial costs in the task or subtask|post_timemoney|
 Inviting user to the account|add_user|
 
-### API methods:  editing projects/tasks/subtasks/tags
+###API methods:  editing projects/tasks/subtasks/tags
 
 Action | Method | Hash Parameters
 -------|--------|-----------
@@ -59,6 +59,104 @@ Subscribe user to a task|subscribe|
 Unsubscribe user from task|unsubscribe|
 Update tags in task/subtask|update_tags|
 
+
+## Usage examples
+
+````ruby
+require "worksection"
+
+DOMAIN_NAME = "<worksection_domain_name>"
+WORKSECTION_KEY = "<worksection_api_key>"
+
+client = Worksection::Client.new(DOMAIN_NAME, WORKSECTION_KEY)
+````
+Here are some common use cases for the Worksection Administrative API (v.05).
+
+### You can list all projects for organization
+````ruby
+puts "#{ JSON.pretty_generate(client.get_projects)}"
+=>
+{
+  "status": "ok",
+  "data": [
+    {
+      "name": "ProjectName0",
+      "page": "/project/61028/",
+      "status": "active",
+      "company": "CompanyName",
+      "user_from": {
+        "email": "john.doe@email.com",
+        "name": "John Doe"
+      },
+      "user_to": {
+        "email": "john.doe@email.com",
+        "name": "John Doe"
+      }
+    },
+    {
+      "name": "ProjectName1",
+      "page": "/project/46167/",
+      "status": "active",
+      "company": "CompanyName",
+      "user_from": {
+        "email": "bob.doe@email.com",
+        "name": "Bob Doe"
+      },
+      "user_to": {
+        "email": "bob.doe@email.com",
+        "name": "Bob Doe"
+      },
+      "max_money": 1950
+    }
+  ]
+}
+
+````
+
+### You can list all tasks for organization
+
+````ruby
+puts "#{ JSON.pretty_generate(client.get_all_tasks)}"
+=>
+{
+  "status": "ok",
+  "data": [
+    {
+      "name": "Task1",
+      "page": "/project/55735/1419268/",
+      "status": "active",
+      "priority": "1",
+      "user_from": {
+        "email": "bob.doe@email.com",
+        "name": "Bob Doe"
+      },
+      "user_to": {
+        "email": "john.doe@email.com",
+        "name": "John Doe"
+      },
+      "date_added": "2019-08-22 17:41",
+      "max_time": 6
+    },
+    {
+      "name": "Task2",
+      "page": "/project/61824/1475984/",
+      "status": "active",
+      "priority": "0",
+      "user_from": {
+        "email": "john.doe@email.com",
+        "name": "John Doe"
+      },
+      "user_to": {
+        "email": "john.doe@email.com",
+        "name": "John Doe"
+      },
+      "date_added": "2019-08-29 18:41"
+    }
+  ]
+}
+
+````
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/worksection-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/worksection/modules/getting_data.rb

@@ -1,39 +1,49 @@
 class Worksection::Client
   module GettingData
     #https://your-domain.com/api/admin/?action=get_projects&hash=HASH
-    def get_projects
-      url = URI("https://#{@domain}/api/admin/?action=get_projects&hash=#{to_md5(__method__.to_s)}")
+    def get_projects(**args)
+      url = URI("https://#{@domain}/api/admin/?action=get_projects
+                #{collect_params(**args)}
+                &hash=#{to_md5(__method__.to_s)}")
       perform_request(url)
     end
 
     #https://your-domain.com/api/admin/?action=get_all_tasks&hash=HASH
-    def get_all_tasks
-      url = URI("https://#{@domain}/api/admin/?action=get_all_tasks&hash=#{to_md5(__method__.to_s)}")
+    def get_all_tasks(**args)
+      url = URI("https://#{@domain}/api/admin/?action=get_all_tasks
+                #{collect_params(**args)}
+                &hash=#{to_md5(__method__.to_s)}")
       perform_request(url)
     end
 
     #https://your-domain.com/api/admin/?action=get_priority&hash=HASH
-    def get_priority
-      url = URI("https://#{@domain}/api/admin/?action=get_priority&hash=#{to_md5(__method__.to_s)}")
+    def get_priority(**args)
+      url = URI("https://#{@domain}/api/admin/?action=get_priority
+                #{collect_params(**args)}
+                &hash=#{to_md5(__method__.to_s)}")
       perform_request(url)
     end
 
     #https://your-domain.com/api/admin/?action=get_task&page=/project/PROJECT_ID/TASK_ID/&hash=HASH
-    def get_task(project_id, task_id)
+    def get_task(project_id, task_id, **args)
       page = "/project/#{project_id}/#{task_id}/"
-      url = URI("https://#{@domain}/api/admin/?action=get_task&page=#{page}&hash=#{to_md5(__method__.to_s, page)}")
+      url = URI("https://#{@domain}/api/admin/?action=get_task&page=#{page}
+                #{collect_params(**args)}
+                &hash=#{to_md5(__method__.to_s, page)}")
       perform_request(url)
     end
 
     #https://your-domain.com/api/admin/?action=get_tasks&page=/project/PROJECT_ID/&hash=HASH
-    def get_tasks(project_id)
+    def get_tasks(project_id, **args)
       page = "/project/#{project_id}"
-      url = URI("https://#{@domain}/api/admin/?action=get_tasks&page=#{page}&hash=#{to_md5(__method__.to_s, page)}")
+      url = URI("https://#{@domain}/api/admin/?action=get_tasks&page=#{page}
+                #{collect_params(**args)}
+                &hash=#{to_md5(__method__.to_s, page)}")
       perform_request(url)
     end
 
     #https://your-domain.com/api/admin/?action=get_timemoney&hash=HASH
-    def get_timemoney
+    def get_timemoney(**args)
       url = URI("https://#{@domain}/api/admin/?action=get_timemoney&hash=#{to_md5(__method__.to_s)}")
       perform_request(url)
     end

data/lib/worksection/version.rb

@@ -1,3 +1,3 @@
 module Worksection
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: worksection-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Valentin