researchable-freedcamp-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 75d48e7be6f5c575ec993b2dc2051d27083b91b643ed6ff89ce75056e3303089
+  data.tar.gz: 182f78158dabec5f59889a00a277187ba5b7d57651787630672875ef94a94bab
+SHA512:
+  metadata.gz: 3eb40dbd7912f74b5391d6951c617e60e6552db39df5992cbe8bd140b20a3bc893e288537a95814c7e640f6df699c1621fd9d6339914d128ae712cd35468be1e
+  data.tar.gz: ffe562dc9a4aa8f8d682d23b513d892cfbe3854b7d6b36eb8f153041427c633b72de236dcd8507af551bf70c6ba1d7ad793d526acf2595f55377e504d65bf63a

data/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_JOBS: "8"

data/.gitignore

@@ -0,0 +1 @@
+output/*

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in researchable_freedcamp_api.gemspec
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    researchable-freedcamp-api (0.1.0)
+      active_interaction (>= 3.2)
+      httparty (>= 0.14)
+      sorbet-runtime
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    active_interaction (4.1.0)
+      activemodel (>= 5, < 8)
+      activesupport (>= 5, < 8)
+    activemodel (6.1.4.4)
+      activesupport (= 6.1.4.4)
+    activesupport (6.1.4.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.5.0)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    minitest (5.15.0)
+    multi_xml (0.6.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    sorbet (0.5.9542)
+      sorbet-static (= 0.5.9542)
+    sorbet-runtime (0.5.9468)
+    sorbet-static (0.5.9542-x86_64-linux)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.5.3)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (> 0)
+  byebug
+  researchable-freedcamp-api!
+  rspec (~> 3.0)
+  sorbet
+
+BUNDLED WITH
+   2.2.15

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Frank Blaauw
+
+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,39 @@
+# FreedcampApi
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/freedcamp_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'freedcamp_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install freedcamp_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/freedcamp_api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "researchable-freedcamp-api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/researchable/freedcamp_api/create_task.rb

@@ -0,0 +1,22 @@
+# typed: false
+# typed: sigil
+#
+module Researchable
+  module FreedcampApi
+    # @api private
+    class CreateTask < Endpoint
+      object :task, class: Researchable::FreedcampApi::Structs::Task
+      def execute
+        create_task(task)
+      end
+
+      private
+
+      sig { params(task: Researchable::FreedcampApi::Structs::Task).returns(T::Hash[T.untyped, T.untyped]) }
+      def create_task(task)
+        # title
+        session.post('/tasks', task)
+      end
+    end
+  end
+end

data/lib/researchable/freedcamp_api/endpoint.rb

@@ -0,0 +1,34 @@
+# typed: strict
+#
+module Researchable
+  module FreedcampApi
+    # TODO: Does this work?
+    class Endpoint < ActiveInteraction::Base
+      # class Endpoint < T::Types::Base
+      extend T::Sig
+      object :session,
+             default: -> { FreedcampApi.signed_session },
+             class: Researchable::FreedcampApi::Sessions::Session
+
+      private
+
+      # Fetch all browses paginated responses
+      # @param keyword [[TODO:type]] [TODO:description]
+      sig { params(keyword: String).returns(T::Array[T.untyped]) }
+      def fetch_all(keyword)
+        result = T.let([], T::Array[T.untyped])
+        has_more = T.let(true, T::Boolean)
+        offset = T.let(0, Integer)
+        limit = T.let(200, Integer)
+
+        while has_more
+          temp = yield limit, offset
+          has_more = T.let(temp.dig('data', 'meta', 'has_more') == 'true', T::Boolean)
+          result += temp['data'][keyword]
+          offset += limit
+        end
+        result
+      end
+    end
+  end
+end

data/lib/researchable/freedcamp_api/list_milestones.rb

@@ -0,0 +1 @@
+# typed: strict

data/lib/researchable/freedcamp_api/list_projects.rb

@@ -0,0 +1 @@
+# typed: strict

data/lib/researchable/freedcamp_api/list_tasks.rb

@@ -0,0 +1,36 @@
+# typed: false
+module Researchable
+  module FreedcampApi
+    class ListTasks < Endpoint
+      integer :task_id, default: nil
+      integer :f_with_archived, default: 1
+
+      # Accepts "active", "archived", "all" values. Omitting is equal to "active".
+      string :lists_status, default: 'active'
+      integer :f_cf, default: 1
+
+      # @api private
+      def execute
+        list_tasks(task_id)
+      end
+
+      sig do
+        params(
+          task_id: T.nilable(Integer)
+        ).returns(
+          T::Array[Researchable::FreedcampApi::Structs::Task]
+        )
+      end
+      def list_tasks(task_id)
+        task_query = task_id ? "/#{task_id}" : '/'
+        fetch_all('tasks') do |limit, offset|
+          session.get("/tasks#{task_query}?limit=#{limit}
+                   &offset=#{offset}
+                   &f_with_archived=#{f_with_archived}
+                   &f_cf=#{f_cf}
+                   &lists_status=#{lists_status}")
+        end
+      end
+    end
+  end
+end

data/lib/researchable/freedcamp_api/sessions/session.rb

@@ -0,0 +1,28 @@
+# typed: strict
+module Researchable
+  module FreedcampApi
+    module Sessions
+      class Session
+        extend T::Sig
+        extend T::Helpers # (1)
+        abstract! # (2)
+
+        sig { abstract.params(path: String).returns(T::Hash[T.untyped, T.untyped]) }
+        def get(path); end
+
+        # (3)
+        sig do
+          abstract.params(
+            path: String,
+            data: T.any(
+              Researchable::FreedcampApi::Structs::Task,
+              Researchable::FreedcampApi::Structs::Comment,
+              T::Hash[T.untyped, T.untyped]
+            )
+          ).returns(T.untyped)
+        end
+        def post(path, data); end
+      end
+    end
+  end
+end

data/lib/researchable/freedcamp_api/sessions/signed_session.rb

@@ -0,0 +1,128 @@
+# typed: strict
+require 'json'
+require 'httparty'
+require 'byebug'
+
+require_relative '../structs/signature'
+require_relative '../structs/task'
+
+module Researchable
+  module FreedcampApi
+    module Sessions
+      class SignedSession < Session
+        extend T::Sig
+        extend T::Helpers
+
+        BASE = T.let('https://freedcamp.com/api/v1'.freeze, String)
+        HEADERS = T.let({ 'Content-Type' => 'application/x-www-form-urlencoded' }.freeze,
+                        T::Hash[T.untyped, T.untyped])
+
+        # rubocop:disable Style/AccessorGrouping
+        sig { returns(String) }
+        attr_reader :public_key
+
+        sig { returns(String) }
+        attr_reader :secret_key
+
+        sig { returns(T::Boolean) }
+        attr_reader :use_cache
+
+        # rubocop:enable Style/AccessorGrouping
+
+        sig { params(public_key: String, secret_key: String, use_cache: T::Boolean).void }
+        def initialize(public_key: ENV['PUBLIC_KEY'], secret_key: ENV['SECRET_KEY'], use_cache: true)
+          @public_key = public_key
+          @secret_key = secret_key
+          @use_cache = use_cache
+        end
+
+        sig { override.params(path: String).returns(T::Hash[T.untyped, T.untyped]) }
+        def get(path)
+          call_url(path, :get)
+        end
+
+        # (3)
+        sig do
+          override.params(
+            path: String,
+            data: T.any(
+              Researchable::FreedcampApi::Structs::Task,
+              Researchable::FreedcampApi::Structs::Comment,
+              T::Hash[T.untyped, T.untyped]
+            )
+          ).returns(T.untyped)
+        end
+        def post(path, data)
+          call_url(path, :post, data)
+        end
+
+        private
+
+        sig do
+          params(
+            path: String, method: Symbol,
+            data: T.any(
+              Researchable::FreedcampApi::Structs::Task,
+              Researchable::FreedcampApi::Structs::Comment,
+              T::Hash[T.untyped, T.untyped]
+            )
+          ).returns(T::Hash[T.untyped, T.untyped])
+        end
+        def call_url(path, method, data = {})
+          cache_url = "output/#{Digest::SHA1.hexdigest(path + method.to_s)}"
+          content = if data == {} && File.exist?(cache_url) && @use_cache
+                      render_cache(cache_url)
+                    else
+                      render_call(path, method, data, cache_url)
+                    end
+
+          content = JSON.parse(content) if content
+          content
+        end
+
+        def render_cache(cache_url)
+          file = File.open(cache_url)
+          content = file.read
+        end
+
+        def render_call(path, method, data, cache_url)
+          signature = generate_signature
+          url = make_url(path, signature)
+          data = serialize_data(data)
+          content = HTTParty.send(method,
+                                  url,
+                                  body: data,
+                                  headers: HEADERS).body
+          File.open(cache_url, 'w') { |f| f.write content }
+          content
+        end
+
+        def serialize_data(data = {})
+          return {} if data == {}
+
+          data = data.serialize if data.is_a? T::Struct
+          data = { data: data.to_json }
+        end
+
+        sig { params(path: String, signature: Signature).returns(String) }
+        def make_url(path, signature)
+          result = BASE + path
+          sep = result.include?('?') ? '&' : '?'
+          result + "#{sep}api_key=#{signature.api_key}&timestamp=#{signature.timestamp}&hash=#{signature.calculated_hash}"
+        end
+
+        sig { returns(Signature) }
+        def generate_signature
+          time = Time.new.to_i * 1000
+          data = "#{@public_key}#{time}"
+          signature = OpenSSL::HMAC.hexdigest('sha1', @secret_key, data)
+          Signature.new(
+            timestamp: time,
+            api_key: @public_key,
+            calculated_hash: signature
+          )
+        end
+      end
+    end
+  end
+end

data/lib/researchable/freedcamp_api/sessions.rb

@@ -0,0 +1,17 @@
+# typed: false
+# typed: sigil
+require 'httparty'
+require_relative 'sessions/session'
+require_relative 'sessions/signed_session'
+
+module Researchable
+  module FreedcampApi
+    extend T::Sig
+
+    def self.signed_session(*arguments, &block)
+      Researchable::FreedcampApi::Sessions::SignedSession.new(
+        *arguments, &block)
+#public_key: ENV['PUBLIC_KEY'], secret_key: ENV['SECRET_KEY'], use_cache: true
+    end
+  end
+end

data/lib/researchable/freedcamp_api/structs/signature.rb

@@ -0,0 +1,11 @@
+# typed: strict
+#require 'sorbet-runtime'
+
+# (1) Create a new class that subclasses `T::Struct`
+class Signature < T::Struct
+  # (2) Declare fields on the struct with the `prop` and `const` DSL
+  prop :timestamp, Integer
+  const :api_key, String
+  const :calculated_hash, String
+end
+

data/lib/researchable/freedcamp_api/structs/task.rb

@@ -0,0 +1,48 @@
+# typed: strict
+# require 'sorbet-runtime'
+
+# (1) Create a new class that subclasses `T::Struct`
+module Researchable
+  module FreedcampApi
+    module Structs
+      class Task < T::Struct
+        const :title, T.nilable(String)
+        const :description, T.nilable(String)
+        const :project_id, T.nilable(String)
+        # Can be empty or absent if task_group_name is passed
+        const :task_group_id, T.nilable(String)
+
+        # 	If passed, task_group_id is ignored, and new tasks group with this name will be created
+        const :task_group_name, T.nilable(String)
+
+        # 	Will be used if task_group_name passed, can be an empty string or absent
+        const :task_group_description, T.nilable(String)
+
+        # 	Priority id. See priorities for :get.
+        const :priority, T.nilable(Integer)
+
+        #	Should contain assigned to user id OR one of the two constants:  -1 (ASSIGNED_EVERYONE) and 0 (ASSIGNED_NOONE)
+        const :assigned_to_id, T.nilable(String)
+        const :assigned_ids, T.nilable(T::Array[String])
+
+        # 	Can be empty or absent, the format is YYYY-MM-DD (empty value will be used if start_date is not allowed for the plan. Old start_date will be overridden in this case, if any).
+        const :start_date, T.nilable(String)
+
+        #	The recurrence rule in iCalendar (RFC 5545) format, can be an empty string or absent
+        const :r_rule, T.nilable(String)
+
+        # 	Can be empty or absent, the format is YYYY-MM-DD
+        const :due_date, T.nilable(String)
+
+        # 	An array of files uploaded previously with temporary=1 flag
+        const :attached_ids, T.nilable(Integer)
+
+        # 	Can be absent or empty. It contains a parent task id. Note: parent task should be in the same tasks group as passed task_group_id. WARN! if a project, where subtask is added to, does not allow advanced subtasks (i.e. has f_subtasks_adv = false, see above), added subtask should contain empty string for description and due_date fields, and "0" for priority and assigned_to_id fields. Also, the parent task should not be a subtask. In case when other values are passed, they will be implicitly fixed to the right values with triggering an error sent to Freedcamp developers.
+        const :item_parent_id, T.nilable(Integer)
+
+        const :status, T.nilable(Integer)
+        const :status_title, T.nilable(String)
+      end
+    end
+  end
+end

data/lib/researchable/freedcamp_api/structs.rb

@@ -0,0 +1,8 @@
+require_relative 'structs/task'
+require_relative 'structs/comment'
+module Researchable
+  module FreedcampApi
+    module Structs
+    end
+  end
+end

data/lib/researchable/freedcamp_api/update_task.rb

@@ -0,0 +1,27 @@
+# typed: false
+#
+module Researchable
+  module FreedcampApi
+    class UpdateTask < Endpoint
+      integer :task_id, default: 44_509_132
+      object :task, class: Researchable::FreedcampApi::Structs::Task
+
+      def execute
+        update_task(task_id, task)
+      end
+
+      sig do
+        params(
+          task_id: Integer,
+          task: Researchable::FreedcampApi::Structs::Task
+        ).returns(
+          T::Array[Researchable::FreedcampApi::Structs::Task]
+        )
+      end
+      def update_task(task_id, task)
+        result = session.post("/tasks/#{task_id}", task)
+        result['data']['tasks']
+      end
+    end
+  end
+end

data/lib/researchable/freedcamp_api/version.rb

@@ -0,0 +1,8 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Researchable
+  module FreedcampApi
+    VERSION = "0.1.0"
+  end
+end

data/lib/researchable/freedcamp_api.rb

@@ -0,0 +1,21 @@
+# typed: strict
+# frozen_string_literal: true
+
+require 'active_interaction'
+require_relative 'freedcamp_api/version'
+require_relative 'freedcamp_api/structs'
+require_relative 'freedcamp_api/sessions'
+require_relative 'freedcamp_api/endpoint'
+
+require_relative 'freedcamp_api/list_tasks'
+require_relative 'freedcamp_api/update_task'
+require_relative 'freedcamp_api/create_task'
+
+require_relative 'freedcamp_api/create_comment'
+
+module Researchable
+  module FreedcampApi
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/lib/researchable-freedcamp-api.rb

@@ -0,0 +1,6 @@
+# typed: strict
+require 'sorbet-runtime'
+require_relative 'researchable/freedcamp_api'
+
+module Researchable
+end