click_up 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63c4a01c0a82ecb2d67e78014791cc49201e986767178eba67b6674bc0dfb739
-  data.tar.gz: e9df7b7a8a6a0fe422477dd6819672dc876b30a0bc9069ced27fec3bace67889
+  metadata.gz: c019b479637fd2046363ab70c1c257534412cb331bc1e6b4b110aba1329e8d5f
+  data.tar.gz: 8d42b415d00cc9768114bece96e8f91442b9db05fe1945b6d452e36b9af99f72
 SHA512:
-  metadata.gz: 374be8c97b3094db1eade7fb5030b7a2215657fd6d9cd266220a0b847f3b213d8aa449153fcbe3cb86a832b849f0c2f09d977adbefe5c6b7fec1d13734451e22
-  data.tar.gz: 81cd9b8691a072cdafa0c67ba02d8d98441a0a0ffe74843c2cafba126534a29e10092c14ebe471ff195adc585018325c58a75dea7106e6aff9c50bc4aed91a2b
+  metadata.gz: 774a45e861cf393c9c25d542b46bef131798edfc86bdc02ae1b1d3844b06efc1f41ad7330bc01d6cb2052327b1f06d82699d5d56ba71eb067b4e01ca003d11da
+  data.tar.gz: 6c61c68f35b3a15bb5f3a9bbcf67565ba3008e1ec3c190f91b61a44e94d090c9878f7dcded9398b77e209d9f78ab5f149b1b9b68a42825f6c283aa1c759a80ae

data/README.md

@@ -1,2 +1,69 @@
-# clickup
-ClickUp API library for rails
+# ClickUp API Ruby Library
+ ClickUp API solution for Ruby. As of now, it doesn't support OAuth Authentication. You can only use personal token based authentication.
+
+# Getting Started
+
+```ruby
+gem install 'click_up'
+```
+Or add the following line to your Gemfile.
+
+```ruby
+gem 'click_up'
+```
+Next, you need to run the generator:
+
+```ruby
+rails generate click_up:install
+```
+It generates a `click_up.rb` initializer file at `config/initializers/`.
+
+Add your ClickUp personal token to this initializer file:
+
+```ruby
+ClickUp.api_token = 'pk_1e2....................'
+```
+
+# Usage
+
+## Team
+```ruby
+ClickUp::Team.all
+```
+
+## Space
+```ruby
+ClickUp::Space.all(team_id: 3451451)
+
+ClickUp::Space.create(team_id: 3451451, name: 'Space From API')
+
+ClickUp::Space.get(323455)
+```
+
+## Folder
+```ruby
+ClickUp::Folder.create(space_id: 323455, name: 'Folder From API')
+
+ClickUp::Folder.get(756376)
+```
+
+## List
+```ruby
+ClickUp::List.create(space_id: 323455, name: 'Folderless list')
+
+ClickUp::List.create(folder_id: 756376, name: 'Foldered list')
+```
+
+## Task
+
+```ruby
+ClickUp::Task.all(list_id: 4766363)
+
+ClickUp::Task.create(list_id: 4766363, name: 'Task from API')
+```
+
+# Additional Information
+Pull requests and comments are welcome.
+
+## License
+MIT License

data/lib/click_up.rb

@@ -11,6 +11,7 @@ require 'click_up/api_resource'
 require 'click_up/api_operations/create'
 require 'click_up/api_operations/get'
 require 'click_up/api_operations/all'
+require 'click_up/api_operations/delete'
 
 require 'click_up/hierarchy/team'
 require 'click_up/hierarchy/space'

data/lib/click_up/api_operations/delete.rb

@@ -0,0 +1,14 @@
+module ClickUp
+  module APIOperations
+    module Delete
+      def delete(id=nil, **opts)
+        params = opts.clone
+        unless params.has_key?(:id) || id
+          raise ParamRequiredError, "id is a required parameter.", "id"
+        end
+        params[:id] = id ? id : params[:id]
+        execute_request(:delete, resource_path(params))
+      end
+    end
+  end
+end

data/lib/click_up/connection_manager.rb

@@ -20,6 +20,11 @@ module ClickUp
       format_response(net_http_response.body)
     end
 
+    def delete
+      net_http_response = https_client.delete(resource_url.path, default_headers)
+      format_response(net_http_response.body)
+    end
+
     private
     def resource_url
       uri = URI("#{api_base}#{namespace}#{path}")

data/lib/click_up/hierarchy/folder.rb

@@ -5,6 +5,7 @@ module ClickUp
     extend ClickUp::APIOperations::All
     extend ClickUp::APIOperations::Create
     extend ClickUp::APIOperations::Get
+    extend ClickUp::APIOperations::Delete
 
     class << self
       def index_path(params={})

data/lib/click_up/hierarchy/list.rb

@@ -5,6 +5,7 @@ module ClickUp
     extend ClickUp::APIOperations::All
     extend ClickUp::APIOperations::Create
     extend ClickUp::APIOperations::Get
+    extend ClickUp::APIOperations::Delete
 
     class << self
       def index_path(params={})

data/lib/click_up/hierarchy/space.rb

@@ -5,6 +5,7 @@ module ClickUp
     extend ClickUp::APIOperations::All
     extend ClickUp::APIOperations::Create
     extend ClickUp::APIOperations::Get
+    extend ClickUp::APIOperations::Delete
 
     class << self
       def index_path(params={})

data/lib/click_up/hierarchy/task.rb

@@ -5,6 +5,7 @@ module ClickUp
     extend ClickUp::APIOperations::All
     extend ClickUp::APIOperations::Create
     extend ClickUp::APIOperations::Get
+    extend ClickUp::APIOperations::Delete
 
     class << self
       def index_path(params={})

data/lib/click_up/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ClickUp
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: click_up
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - ayer-dines
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-15 00:00:00.000000000 Z
+date: 2021-01-16 00:00:00.000000000 Z
 dependencies: []
 description: 'ClickUp: One app to replace them all.'
 email: budhayer96d@gmail.com
@@ -23,6 +23,7 @@ files:
 - lib/click_up.rb
 - lib/click_up/api_operations/all.rb
 - lib/click_up/api_operations/create.rb
+- lib/click_up/api_operations/delete.rb
 - lib/click_up/api_operations/get.rb
 - lib/click_up/api_resource.rb
 - lib/click_up/connection_manager.rb