click_up 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 63c4a01c0a82ecb2d67e78014791cc49201e986767178eba67b6674bc0dfb739
+  data.tar.gz: e9df7b7a8a6a0fe422477dd6819672dc876b30a0bc9069ced27fec3bace67889
+SHA512:
+  metadata.gz: 374be8c97b3094db1eade7fb5030b7a2215657fd6d9cd266220a0b847f3b213d8aa449153fcbe3cb86a832b849f0c2f09d977adbefe5c6b7fec1d13734451e22
+  data.tar.gz: 81cd9b8691a072cdafa0c67ba02d8d98441a0a0ffe74843c2cafba126534a29e10092c14ebe471ff195adc585018325c58a75dea7106e6aff9c50bc4aed91a2b

data/.gitignore

@@ -0,0 +1,70 @@
+*.rbc
+capybara-*.html
+.rspec
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/db/*.sqlite3-[0-9]*
+/public/system
+/coverage/
+/spec/tmp
+*.orig
+rerun.txt
+pickle-email-*.html
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# TODO Comment out this rule if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/master.key
+
+# Only include if you have production secrets in this file, which is no longer a Rails default
+# config/secrets.yml
+
+# dotenv
+# TODO Comment out this rule if environment variables can be committed
+.env
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+# Ignore Byebug command history file.
+.byebug_history
+
+# Ignore node_modules
+node_modules/
+
+# Ignore precompiled javascript packs
+/public/packs
+/public/packs-test
+/public/assets
+
+# Ignore yarn files
+/yarn-error.log
+yarn-debug.log*
+.yarn-integrity
+
+# Ignore uploaded files in development
+/storage/*
+!/storage/.keep
+
+#Ignore Rubymine project directories
+.idea/*

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Dinesh Budhayer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,2 @@
+# clickup
+ClickUp API library for rails

data/click_up.gemspec

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+$:.unshift ::File.join(::File.dirname(__FILE__), "lib")
+
+require "click_up/version"
+
+Gem::Specification.new do |s|
+  s.name = "click_up"
+  s.version = ClickUp::VERSION
+  s.required_ruby_version = ">= 2.3.0"
+  s.summary = "Ruby library for the ClickUp API"
+  s.description = "ClickUp: One app to replace them all."
+  s.author = "ayer-dines"
+  s.files = `git ls-files`.split("\n")
+  s.email = "budhayer96d@gmail.com"
+  s.homepage = "https://github.com/ayerdines/clickup-ruby"
+  s.license = "MIT"
+  s.require_paths = ["lib"]
+end

data/lib/click_up.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+
+require 'click_up/errors'
+
+require 'click_up/connection_manager'
+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/hierarchy/team'
+require 'click_up/hierarchy/space'
+require 'click_up/hierarchy/folder'
+require 'click_up/hierarchy/task'
+require 'click_up/hierarchy/list'
+
+require 'click_up/version'
+
+module ClickUp
+  class << self
+    attr_accessor :api_token
+  end
+end

data/lib/click_up/api_operations/all.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ClickUp
+  module APIOperations
+    module All
+      def all(params={})
+        execute_request(:get, index_path(params))
+      end
+    end
+  end
+end

data/lib/click_up/api_operations/create.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ClickUp
+  module APIOperations
+    module Create
+      def create(params={})
+        execute_request(:post, index_path(params), formatted_params(params))
+      end
+    end
+  end
+end

data/lib/click_up/api_operations/get.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ClickUp
+  module APIOperations
+    module Get
+      def get(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(:get, resource_path(params))
+      end
+    end
+  end
+end

data/lib/click_up/api_resource.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ClickUp
+  class APIResource
+    class << self
+      def execute_request(method, path, data={})
+        client(path, data).send(method)
+      end
+
+      private
+      def client(path, data)
+        ConnectionManager.new(path, data)
+      end
+    end
+  end
+end

data/lib/click_up/connection_manager.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module ClickUp
+  class ConnectionManager
+    attr_reader :path, :data
+
+    def initialize(path, data)
+      @path = path
+      @data = data
+    end
+
+    def get
+      net_http_response = https_client.request_get(resource_url.path, default_headers)
+      format_response(net_http_response.body)
+    end
+
+    def post
+      form_data = data.to_json if data.is_a?(Hash) && data.size > 0
+      net_http_response = https_client.request_post(resource_url.path, form_data, default_headers)
+      format_response(net_http_response.body)
+    end
+
+    private
+    def resource_url
+      uri = URI("#{api_base}#{namespace}#{path}")
+      uri.query = URI.encode_www_form(data) if data.size > 0
+      uri
+    end
+
+    def namespace
+      "/api/v2"
+    end
+
+    def api_base
+      "https://api.clickup.com"
+    end
+
+    def default_headers
+      {
+        'Content-Type' => 'application/json',
+        'Authorization' => ClickUp.api_token
+      }
+    end
+
+    def format_response(net_http_response)
+      JSON.parse(net_http_response)
+    end
+
+    def https_client
+      https = Net::HTTP.new(resource_url.host, resource_url.port)
+      https.use_ssl = true
+      https
+    end
+  end
+end

data/lib/click_up/errors.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ClickUp
+  class ClickUpError < StandardError
+    attr_reader :message
+
+    def initialize(msg = nil)
+      @message = msg
+    end
+
+    def to_s
+      "#{message}"
+    end
+  end
+
+  class ParamRequiredError < ClickUpError
+    attr_reader :params
+
+    def initialize(msg, *params)
+      super(msg)
+      @params = params
+    end
+  end
+end

data/lib/click_up/hierarchy/folder.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ClickUp
+  class Folder < APIResource
+    extend ClickUp::APIOperations::All
+    extend ClickUp::APIOperations::Create
+    extend ClickUp::APIOperations::Get
+
+    class << self
+      def index_path(params={})
+        "/space/#{params[:space_id]}/folder"
+      end
+
+      def resource_path(params={})
+        "/folder/#{params[:id]}"
+      end
+
+      def rejected_params
+        [
+          :id,
+          :space_id
+        ]
+      end
+
+      def formatted_params(params)
+        params.reject {|key, _| rejected_params.include?(key) }
+        # {
+        #   "name": "Updated Folder Name"
+        # }
+      end
+    end
+  end
+end

data/lib/click_up/hierarchy/list.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module ClickUp
+  class List < APIResource
+    extend ClickUp::APIOperations::All
+    extend ClickUp::APIOperations::Create
+    extend ClickUp::APIOperations::Get
+
+    class << self
+      def index_path(params={})
+        if params.has_key?(:folder_id)
+          folder_path(params[:folder_id])
+        elsif params.has_key?(:space_id)
+          folderless_path(params[:space_id])
+        else
+          raise ArgumentError, "Either folder_id or space_id is required."
+        end
+      end
+
+      def folder_path(folder_id)
+        "/folder/#{folder_id}/list"
+      end
+
+      def folderless_path(space_id)
+        "/space/#{space_id}/list"
+      end
+
+      def resource_path(params={})
+        "/list/#{params[:id]}"
+      end
+
+      def rejected_params
+        [
+          :id,
+          :folder_id,
+          :space_id
+        ]
+      end
+
+      def formatted_params(params)
+        params.reject {|key, _| rejected_params.include?(key) }
+        # {
+        #   "name": "New List Name",
+        #   "content": "Sent from API V2",
+        #   "due_date": 1577811600000,
+        #   "due_date_time": false,
+        #   "priority": 1,
+        #   "assignee": 53480,
+        #   "status": "red"
+        # }
+      end
+    end
+  end
+end

data/lib/click_up/hierarchy/space.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module ClickUp
+  class Space < APIResource
+    extend ClickUp::APIOperations::All
+    extend ClickUp::APIOperations::Create
+    extend ClickUp::APIOperations::Get
+
+    class << self
+      def index_path(params={})
+        "/team/#{params[:team_id]}/space"
+      end
+
+      def resource_path(params={})
+        "/space/#{params[:id]}"
+      end
+
+      def rejected_params
+        [
+          :id,
+          :team_id
+        ]
+      end
+
+      def formatted_params(params)
+        params.reject {|key, _| rejected_params.include?(key) }
+        # {
+        #   "name": "New Space Name",
+        #   "multiple_assignees": true,
+        #   "features": {
+        #     "due_dates": {
+        #       "enabled": true,
+        #       "start_date": false,
+        #       "remap_due_dates": true,
+        #       "remap_closed_due_date": false
+        #     },
+        #     "time_tracking": {
+        #       "enabled": false
+        #     },
+        #     "tags": {
+        #       "enabled": true
+        #     },
+        #     "time_estimates": {
+        #       "enabled": true
+        #     },
+        #     "checklists": {
+        #       "enabled": true
+        #     },
+        #     "custom_fields": {
+        #       "enabled": true
+        #     },
+        #     "remap_dependencies": {
+        #       "enabled": true
+        #     },
+        #     "dependency_warning": {
+        #       "enabled": true
+        #     },
+        #     "portfolios": {
+        #       "enabled": true
+        #     }
+        #   }
+        # }
+      end
+    end
+  end
+end

data/lib/click_up/hierarchy/task.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module ClickUp
+  class Task < APIResource
+    extend ClickUp::APIOperations::All
+    extend ClickUp::APIOperations::Create
+    extend ClickUp::APIOperations::Get
+
+    class << self
+      def index_path(params={})
+        "/list/#{params[:list_id]}/task"
+      end
+
+      def resource_path(params={})
+        "/task/#{params[:id]}"
+      end
+
+      def rejected_params
+        [
+          :id,
+          :list_id
+        ]
+      end
+
+      def formatted_params(params)
+        params.reject {|key, _| rejected_params.include?(key) }
+        # {
+        #   "name": "New Task Name",
+        #   "description": "New Task Description",
+        #   "assignees": [
+        #     183
+        #   ],
+        #   "tags": [
+        #     "tag name 1"
+        #   ],
+        #   "status": "Open",
+        #   "priority": 3,
+        #   "due_date": 1508369194377,
+        #   "due_date_time": false,
+        #   "time_estimate": 8640000,
+        #   "start_date": 1567780450202,
+        #   "start_date_time": false,
+        #   "notify_all": true,
+        #   "parent": null,
+        #   "links_to": null,
+        #   "custom_fields": [
+        #     {
+        #       "id": "0a52c486-5f05-403b-b4fd-c512ff05131c",
+        #       "value": 23
+        #     },
+        #     {
+        #       "id": "03efda77-c7a0-42d3-8afd-fd546353c2f5",
+        #       "value": "Text field input"
+        #     }
+        #   ]
+        # }
+      end
+    end
+  end
+end

data/lib/click_up/hierarchy/team.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ClickUp
+  class Team < APIResource
+    extend ClickUp::APIOperations::All
+
+    class << self
+      def index_path(params={})
+        "/team"
+      end
+    end
+  end
+end

data/lib/click_up/version.rb

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

data/lib/generators/click_up/install_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module ClickUp
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "This generator creates click_up.rb file at config/initializers"
+      def create_initializer_file
+        create_file "config/initializers/click_up.rb", "# Add ClickUp.api_token here\nClickUp.api_token = 'xxxxxxxxxxxxxxxxxxxxxxxxxxx'"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: click_up
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ayer-dines
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-15 00:00:00.000000000 Z
+dependencies: []
+description: 'ClickUp: One app to replace them all.'
+email: budhayer96d@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- click_up.gemspec
+- lib/click_up.rb
+- lib/click_up/api_operations/all.rb
+- lib/click_up/api_operations/create.rb
+- lib/click_up/api_operations/get.rb
+- lib/click_up/api_resource.rb
+- lib/click_up/connection_manager.rb
+- lib/click_up/errors.rb
+- lib/click_up/hierarchy/folder.rb
+- lib/click_up/hierarchy/list.rb
+- lib/click_up/hierarchy/space.rb
+- lib/click_up/hierarchy/task.rb
+- lib/click_up/hierarchy/team.rb
+- lib/click_up/version.rb
+- lib/generators/click_up/install_generator.rb
+homepage: https://github.com/ayerdines/clickup-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby library for the ClickUp API
+test_files: []