moco-ruby 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d7bd1d9f8ec25fb5689f497af1ad20f7481fa4df62eb794e6a0123c5c9ed495
+  data.tar.gz: 75e4a230361fd3f05b5392c6cb6ad8fc218c63f18f4f77b41b148fc615a231d0
+SHA512:
+  metadata.gz: 34d936b6240f8645bf2210686a46651d6116d9073fef13f1802d6fbd07700b3fe1cc71a7bbd7044a1f79b055cc29b3f89e3266e2e4049f1b7f350f8374983ec1
+  data.tar.gz: 4ff707e14a5b1b327799d5feda4bb0d993b12a586d084b4c9f735333f85bb572f3abe2be4e57b5185fa8f8e269d2d9eab32c3e6561274676dcd215377eee18df

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  SuggestExtensions: false
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Naming/MethodParameterName:
+  AllowedNames:
+  - a
+  - b
+
+Layout/LineLength:
+  Max: 130
+
+Metrics/BlockLength:
+  Max: 40
+
+Metrics/ClassLength:
+  Max: 130

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.0

data/.vscode/launch.json

@@ -0,0 +1,21 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "rdbg",
+      "name": "Debug current file with rdbg",
+      "request": "launch",
+      "script": "${file}",
+      "args": [],
+      "askParameters": true
+    },
+    {
+      "type": "rdbg",
+      "name": "Attach with rdbg",
+      "request": "attach"
+    }
+  ]
+}

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+## [Unreleased]
+
+## [0.1.1] - 2024-02-27
+
+### Added
+
+- Prepared for Gem release
+
+### Changed
+
+- Changed target Ruby version to 2.6 (from 3.x)
+- Applied Rubocop configuration and fixed style errors
+
+### Security
+
+- Bumped `uri` dependency to 0.13.0
+
+## [0.1.0] - 2024-02-27
+
+- Initial release

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org/"
+
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    moco-ruby (0.1.1)
+      faraday (~> 2.9.0)
+      fuzzy_match (~> 2.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
+    faraday-net_http (3.1.0)
+      net-http
+    fuzzy_match (2.1.0)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    net-http (0.4.1)
+      uri
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rubocop (1.60.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.5.0)
+    uri (0.13.0)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  moco-ruby!
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.1

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,101 @@
+# moco-ruby
+
+A Ruby Gem to interact with the [MOCO API](https://hundertzehn.github.io/mocoapp-api-docs/).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add moco-ruby
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install moco-ruby
+
+## Usage
+
+### MOCO::API
+
+```ruby
+moco = MOCO::API.new(subdomain, api_key)
+assigned_projects = moco.get_assigned_projects(active: 'true')
+assigned_projects.each do |project|
+  puts "Project \##{project.id} #{project.name} for customer #{project.customer.name}"
+  project.tasks.each do |task|
+    puts "- Task #{task.name} is #{task.billable ? 'billable' : 'not billable'}"
+  end
+end
+```
+
+### MOCO::Entities
+
+The following entities are currently defined:
+
+- Project (:id, :active, :name, :customer, :tasks)
+- Task (:id, :active, :name, :project_id, :billable)
+- Activity (:id, :active, :date, :description, :project, :task, :seconds, :hours, :billable, :billed, :user, :customer, :tag)
+- Customer (:id, :name)
+- User (:id, :firstname, :lastname)
+
+The entities implement comparison, hash and JSON conversion.
+
+### MOCO::Sync
+
+Intelligently matches and syncs data from one MOCO instance to another.
+Currently supports activities (time entries) only.
+See `sync_activity.rb` for a more detailed example.
+
+```ruby
+source_api = MOCO::API.new(source_instance, source_api_key)
+target_api = MOCO::API.new(target_instance, target_api_key)
+
+syncer = MOCO::Sync.new(
+  source_api,
+  target_api,
+  project_match_threshold: options[:match_project_threshold],
+  task_match_threshold: options[:match_task_threshold],
+  filters: {
+    source: options.slice(:from, :to, :project_id, :company_id, :term),
+    target: options.slice(:from, :to)
+  },
+  dry_run: options[:dry_run]
+)
+```
+
+## Utilities
+
+Utilities can use `config.yml` to fetch instance data and other configuration. For format, see `config.yml.sample`.
+
+### mocurl
+
+Run an API request against a MOCO instance and return the result nicely formatted.
+Use config.yml or specify api key with `-a`.
+
+```
+Usage: mocurl.rb [options] url
+       mocurl.rb [options] subdomain path
+    -X, --method METHOD              Set HTTP method to use
+    -d, --data DATA                  Data to send to server, JSON format
+    -a, --api-key API_KEY            Manually specify MOCO API key
+    -n, --no-format                  Disable JSON pretty-printing
+    -v, --verbose                    Show additional request and response information
+    -h, --help                       Show this message
+```
+
+### sync_activity
+
+Sync activity data (time entries) from one instance to another, fuzzy matching projects and tasks.
+It is highly recommended to use filter options (`--from`, `--to`) and to use `--dry-run` first to check the matching performance.
+
+```
+Usage: sync_activity.rb [options] source target
+    -f, --from DATE                  Start date (YYYY-MM-DD)
+    -t, --to DATE                    End date (YYYY-MM-DD)
+    -p, --project PROJECT_ID         Project ID to filter by
+    -c, --company COMPANY_ID         Company ID to filter by
+    -g, --term TERM                  Term to filter for
+    -n, --dry-run                    Match only, but do not edit data
+        --match-project-threshold VALUE
+                                     Project matching threshold (0.0 - 1.0), default 0.8
+        --match-task-threshold VALUE Task matching threshold (0.0 - 1.0), default 0.45
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/config.yml.sample

@@ -0,0 +1,9 @@
+match_thresholds:
+  project: 0.80
+  task: 0.45
+
+instances:
+  "my-own-moco-subdomain":
+    api_key: 1234abcdef
+  "some-target-subdomain":
+    api_key: 1234abcdef

data/lib/moco/api.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require "faraday"
+require_relative "entities"
+
+module MOCO
+  # MOCO::API abstracts access to the MOCO API and its entities
+  class API
+    def initialize(subdomain, api_key)
+      @subdomain = subdomain
+      @api_key = api_key
+      @conn = Faraday.new do |f|
+        f.request :json
+        f.response :json
+        f.request :authorization, "Token", "token=#{@api_key}" if @api_key
+        f.url_prefix = "https://#{@subdomain}.mocoapp.com/api/v1"
+      end
+    end
+
+    %w[get post put patch delete].each do |method|
+      define_method(method) do |path, *args|
+        @conn.send(method, path, *args)
+      end
+    end
+
+    def get_projects(**args)
+      response = @conn.get("projects?#{Faraday::Utils.build_query(args)}")
+      parse_projects_response(response.body)
+    end
+
+    def get_assigned_projects(**args)
+      response = @conn.get("projects/assigned?#{Faraday::Utils.build_query(args)}")
+      parse_projects_response(response.body)
+    end
+
+    def get_activities(filters = {})
+      response = @conn.get("activities?#{Faraday::Utils.build_query(filters)}")
+      parse_activities_response(response.body)
+    end
+
+    def create_activity(activity)
+      api_entity = activity.to_h.except(:id, :project, :user, :customer).tap do |h|
+        h[:project_id] = activity.project.id
+        h[:task_id] = activity.task.id
+      end
+      @conn.post("activities", api_entity)
+    end
+
+    def update_activity(activity)
+      api_entity = activity.to_h.except(:project, :user, :customer).tap do |h|
+        h[:project_id] = activity.project.id
+        h[:task_id] = activity.task.id
+      end
+      @conn.put("activities/#{activity.id}", api_entity)
+    end
+
+    private
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def parse_projects_response(data)
+      data.map do |project_data|
+        Project.new.tap do |project|
+          project.id = project_data["id"]
+          project.name = project_data["name"]
+          project.customer = parse_customer_reference(project_data["customer"])
+          project.tasks = project_data["tasks"].map do |task_data|
+            Task.new.tap do |task|
+              task.id = task_data["id"]
+              task.name = task_data["name"]
+              task.project_id = task_data["project_id"]
+              task.billable = task_data["billable"]
+            end
+          end
+        end
+      end
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def parse_activities_response(data)
+      data.map do |activity_data|
+        Activity.new.tap do |activity|
+          activity.id = activity_data["id"]
+          activity.date = activity_data["date"]
+          activity.description = activity_data["description"]
+          activity.user = parse_user_reference(activity_data["user"])
+          activity.customer = parse_customer_reference(activity_data["customer"])
+          activity.project = parse_project_reference(activity_data["project"])
+          activity.task = parse_task_reference(activity_data["task"])
+          activity.hours = activity_data["hours"]
+          activity.seconds = activity_data["seconds"]
+          activity.billable = activity_data["billable"]
+          activity.billed = activity_data["billed"]
+          activity.tag = activity_data["tag"]
+        end
+      end
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+    def parse_project_reference(project_data)
+      Project.new.tap do |project|
+        project.id = project_data["id"]
+        project.name = project_data["name"]
+      end
+    end
+
+    def parse_task_reference(task_data)
+      Task.new.tap do |task|
+        task.id = task_data["id"]
+        task.name = task_data["name"]
+      end
+    end
+
+    def parse_user_reference(user_data)
+      User.new.tap do |user|
+        user.id = user_data["id"]
+        user.firstname = user_data["firstname"]
+        user.lastname = user_data["lastname"]
+      end
+    end
+
+    def parse_customer_reference(customer_data)
+      Customer.new.tap do |customer|
+        customer.id = customer_data["id"]
+        customer.name = customer_data["name"]
+      end
+    end
+  end
+end

data/lib/moco/entities.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module MOCO
+  # Base entity class others inherit from, providing comparison, to_h, to_json
+  class BaseEntity
+    def eql?(other)
+      return false unless other.is_a? self.class
+
+      id == other.id
+    end
+
+    def hash
+      id.hash
+    end
+
+    def ==(other)
+      id == other.id
+    end
+
+    def to_h
+      hash = {}
+      instance_variables.each do |var|
+        key = var.to_s.delete_prefix("@")
+        hash[key.to_sym] = instance_variable_get(var)
+      end
+      hash
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def to_json(*arg)
+      to_h do |k, v|
+        if v.is_a? Hash
+          if v.key?(:id) && !v[:id].nil?
+            ["#{k}_id", v[:id]]
+          else
+            [k, v.except(:id)]
+          end
+        else
+          [k, v]
+        end
+      end.to_h.to_json(arg)
+    end
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  # https://hundertzehn.github.io/mocoapp-api-docs/sections/projects.html
+  class Project < BaseEntity
+    attr_accessor :id, :active, :name, :customer, :tasks
+
+    def to_s
+      [customer&.name, name].join(" / ")
+    end
+  end
+
+  # https://hundertzehn.github.io/mocoapp-api-docs/sections/project_tasks.html
+  class Task < BaseEntity
+    attr_accessor :id, :active, :name, :project_id, :billable
+
+    def to_s
+      name
+    end
+  end
+
+  # https://hundertzehn.github.io/mocoapp-api-docs/sections/activities.html
+  class Activity < BaseEntity
+    attr_accessor :id, :active, :date, :description, :project, :task, :seconds, :hours, :billable, :billed, :user,
+                  :customer, :tag
+
+    def to_s
+      "#{date} - #{hours}h (#{seconds}s) - #{project&.name} - #{task&.name}#{description.empty? ? "" : " (#{description})"} " \
+        "(#{%i[billable billed].map { |x| (send(x) ? "" : "not ") + x.to_s }.join(", ")})"
+    end
+  end
+
+  # https://hundertzehn.github.io/mocoapp-api-docs/sections/companies.html
+  class Customer < BaseEntity
+    attr_accessor :id, :name
+  end
+
+  # https://hundertzehn.github.io/mocoapp-api-docs/sections/users.html
+  class User < BaseEntity
+    attr_accessor :id, :firstname, :lastname
+  end
+end

data/lib/moco/sync.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+require "fuzzy_match"
+require_relative "api"
+
+module MOCO
+  # Match and map projects and tasks between MOCO instances and sync activities
+  class Sync
+    attr_reader :project_mapping, :task_mapping, :source_projects, :target_projects
+    attr_accessor :project_match_threshold, :task_match_threshold, :dry_run
+
+    def initialize(source_instance_api, target_instance_api, **args)
+      @source_api = source_instance_api
+      @target_api = target_instance_api
+      @project_match_threshold = args.fetch(:project_match_threshold, 0.8)
+      @task_match_threshold = args.fetch(:task_match_threshold, 0.45)
+      @filters = args.fetch(:filters, {})
+      @dry_run = args.fetch(:dry_run, false)
+
+      @project_mapping = {}
+      @task_mapping = {}
+
+      fetch_assigned_projects
+      build_initial_mappings
+    end
+
+    # rubocop:todo Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    def sync(&callbacks)
+      results = []
+
+      source_activities_r = @source_api.get_activities(@filters.fetch(:source, {}))
+      target_activities_r = @target_api.get_activities(@filters.fetch(:target, {}))
+
+      source_activities_grouped = source_activities_r.group_by(&:date).transform_values do |activities|
+        activities.group_by(&:project)
+      end
+      target_activities_grouped = target_activities_r.group_by(&:date).transform_values do |activities|
+        activities.group_by(&:project)
+      end
+
+      source_activities_grouped.each do |date, activities_by_project|
+        activities_by_project.each do |project, source_activities|
+          target_activities = target_activities_grouped.fetch(date, {}).fetch(@project_mapping[project.id], [])
+          next if source_activities.empty? || target_activities.empty?
+
+          matches = calculate_matches(source_activities, target_activities)
+          matches.sort_by! { |match| -match[:score] }
+
+          used_source_activities = []
+          used_target_activities = []
+
+          matches.each do |match|
+            source_activity, target_activity = match[:activity]
+            score = match[:score]
+
+            next if used_source_activities.include?(source_activity) || used_target_activities.include?(target_activity)
+
+            best_score = score
+            best_match = target_activity
+            expected_target_activity = get_expected_target_activity(source_activity)
+
+            case best_score
+            when 100
+              # 100 - perfect match found, nothing needs doing
+              callbacks&.call(:equal, source_activity, expected_target_activity)
+            when 60...100
+              # >=60 <100 - match with some differences
+              expected_target_activity.to_h.except(:id, :user, :customer).each do |k, v|
+                best_match.send("#{k}=", v)
+              end
+              callbacks&.call(:update, source_activity, best_match)
+              unless @dry_run
+                results << @target_api.update_activity(best_match)
+                callbacks&.call(:updated, source_activity, best_match, results.last)
+              end
+            when 0...60
+              # <60 - no good match found, create new entry
+              callbacks&.call(:create, source_activity, expected_target_activity)
+              unless @dry_run
+                results << @target_api.create_activity(expected_target_activity)
+                callbacks&.call(:created, source_activity, best_match, results.last)
+              end
+            end
+
+            used_source_activities << source_activity
+            used_target_activities << target_activity
+          end
+        end
+      end
+      results
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+    private
+
+    def get_expected_target_activity(source_activity)
+      source_activity.dup.tap do |a|
+        a.task = @task_mapping[source_activity.task.id]
+        a.project = @project_mapping[source_activity.project.id]
+      end
+    end
+
+    def calculate_matches(source_activities, target_activities)
+      matches = []
+      source_activities.each do |source_activity|
+        target_activities.each do |target_activity|
+          score = score_activity_match(get_expected_target_activity(source_activity), target_activity)
+          matches << { activity: [source_activity, target_activity], score: score }
+        end
+      end
+      matches
+    end
+
+    def clamped_factored_diff_score(a, b, cmin = 0.0, cmax = 7.0, factor = 0.5)
+      difference = (a - b).abs.clamp(cmin, cmax)
+      normalized_difference = difference / cmax
+      sublinear_factor = normalized_difference**factor
+      score = 1 - sublinear_factor
+      [0.0, score].max
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def score_activity_match(a, b)
+      return 0 if a.project != b.project
+
+      score = 0
+      # (mapped) task is the same as the source task
+      score += 20 if a.task == b.task
+      # description fuzzy match score (0.0 .. 1.0)
+      _, description_match_score = FuzzyMatch.new([a.description]).find_with_score(b.description)
+      score += (description_match_score * 40.0).to_i if description_match_score
+      # differences in time tracked are weighted by sqrt of diff clamped to 7h
+      # i.e. smaller differences are worth higher scores; 1.75h diff = 0.5 score * 40
+      score += (clamped_factored_diff_score(a.hours, b.hours) * 40.0).to_i
+
+      score
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    def fetch_assigned_projects
+      @source_projects = @source_api.get_assigned_projects(**@filters.fetch(:source, {}).merge(active: "true"))
+      @target_projects = @target_api.get_assigned_projects(**@filters.fetch(:target, {}).merge(active: "true"))
+    end
+
+    def build_initial_mappings
+      @target_projects.each do |target_project|
+        source_project = match_project(target_project)
+        next unless source_project
+
+        @project_mapping[source_project.id] = target_project
+        target_project.tasks.each do |target_task|
+          source_task = match_task(target_task, source_project)
+          @task_mapping[source_task.id] = target_task if source_task
+        end
+      end
+    end
+
+    def match_project(target_project)
+      matcher = FuzzyMatch.new(@source_projects, read: :name)
+      matcher.find(target_project.name, threshold: @project_match_threshold)
+    end
+
+    def match_task(target_task, source_project)
+      matcher = FuzzyMatch.new(source_project.tasks, read: :name)
+      matcher.find(target_task.name, threshold: @task_match_threshold)
+    end
+  end
+end

data/lib/moco/version.rb

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

data/lib/moco.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "moco/version"
+require_relative "moco/entities"
+require_relative "moco/api"
+require_relative "moco/sync"
+
+module MOCO
+  class Error < StandardError; end
+end

data/mocurl.rb

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "optparse"
+require "yaml"
+require "json"
+require_relative "lib/moco"
+
+options = { method: "GET", data: {}, api_key: nil, no_format: false, verbose: false }
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{$PROGRAM_NAME} [options] url\n       " \
+                "#{$PROGRAM_NAME} [options] subdomain path"
+
+  opts.on("-X", "--method METHOD", "Set HTTP method to use") do |method|
+    options[:method] = method.upcase
+  end
+
+  opts.on("-d", "--data DATA", "Data to send to server, JSON format") do |data|
+    options[:data] = JSON.parse(data)
+  end
+
+  opts.on("-a", "--api-key API_KEY", "Manually specify MOCO API key") do |key|
+    options[:api_key] = key
+  end
+
+  opts.on("-n", "--no-format", "Disable JSON pretty-printing") do
+    options[:no_format] = true
+  end
+
+  opts.on("-v", "--verbose", "Show additional request and response information") do
+    options[:verbose] = true
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end.parse!
+
+def extract_subdomain(url)
+  url.match(%r{https?://([^.]+)\.mocoapp\.com})[1]
+end
+
+# Ensure we have a URL
+url = ARGV.shift
+if url.nil?
+  warn "Error: URL is required"
+  exit 1
+end
+
+if ARGV.empty?
+  subdomain = extract_subdomain(url)
+else
+  subdomain = url
+  path = ARGV.shift
+  url = "https://#{subdomain}.mocoapp.com/api/v1/#{path.gsub(%r{\A/}, "")}"
+end
+
+# Load default API key from config
+config = YAML.load_file("config.yml")
+options[:api_key] ||= config["instances"].fetch(subdomain, nil)&.fetch("api_key", nil)
+
+warn "Error: No API key found for `#{subdomain}' and none given, continuing without" if options[:api_key].nil?
+
+api = MOCO::API.new(subdomain, options[:api_key])
+
+case options[:method]
+when "GET"
+  result = api.get(url)
+when "DELETE"
+  result = api.delete(url)
+when "POST"
+  result = api.post(url, options[:data])
+when "PUT"
+  result = api.put(url, options[:data])
+when "PATCH"
+  result = api.patch(url, options[:data])
+else
+  puts "Error: Invalid HTTP Method: #{options[:method]}"
+  exit 1
+end
+
+if options[:verbose]
+  puts "> #{options[:method]} #{result.env.url}"
+  puts(result.env.request_headers.map do |k, v|
+         "> #{k}: #{k == "Authorization" ? "#{v[0...16]}<REDACTED>#{v[-4..]}" : v}"
+       end)
+  puts ">"
+  puts result.env.request_body.split.map { |l| "> #{l}" }.join if result.env.request_body
+  puts "---"
+  puts "< #{result.status} #{result.reason_phrase}"
+  puts(result.headers.map { |k, v| "< #{k}: #{v}" })
+  puts ""
+end
+if options[:no_format]
+  puts result.body.to_json
+else
+  puts JSON.pretty_generate(result.body)
+end

data/sync_activity.rb

@@ -0,0 +1,111 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "optparse"
+require "yaml"
+require_relative "lib/moco"
+
+options = {
+  from: nil,
+  to: nil,
+  project: nil,
+  match_project_threshold: 0.8,
+  match_task_threshold: 0.45
+}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{$PROGRAM_NAME} [options] source target"
+
+  opts.on("-f", "--from DATE", "Start date (YYYY-MM-DD)") do |date|
+    options[:from] = date
+  end
+
+  opts.on("-t", "--to DATE", "End date (YYYY-MM-DD)") do |date|
+    options[:to] = date
+  end
+
+  opts.on("-p", "--project PROJECT_ID", "Project ID to filter by") do |project_id|
+    options[:project_id] = project_id
+  end
+
+  opts.on("-c", "--company COMPANY_ID", "Company ID to filter by") do |company_id|
+    options[:company_id] = company_id
+  end
+
+  opts.on("-g", "--term TERM", "Term to filter for") do |term|
+    options[:term] = term
+  end
+
+  opts.on("-n", "--dry-run", "Match only, but do not edit data") do
+    options[:dry_run] = true
+  end
+
+  opts.on("--match-project-threshold VALUE", Float, "Project matching threshold (0.0 - 1.0), default 0.8") do |val|
+    options[:match_project_threshold] = val
+  end
+
+  opts.on("--match-task-threshold VALUE", Float, "Task matching threshold (0.0 - 1.0), default 0.45") do |val|
+    options[:match_task_threshold] = val
+  end
+end.parse!
+
+source_instance = ARGV.shift
+target_instance = ARGV.shift
+if source_instance.nil?
+  warn "Source instance is required"
+  exit 1
+end
+if target_instance.nil?
+  warn "Target instance is required"
+  exit 1
+end
+
+config = YAML.load_file("config.yml")
+source_config = config["instances"].fetch(source_instance, nil)
+target_config = config["instances"].fetch(target_instance, nil)
+
+source_api = MOCO::API.new(source_instance, source_config["api_key"])
+target_api = MOCO::API.new(target_instance, target_config["api_key"])
+
+syncer = MOCO::Sync.new(
+  source_api,
+  target_api,
+  project_match_threshold: options[:match_project_threshold],
+  task_match_threshold: options[:match_task_threshold],
+  filters: {
+    source: options.slice(:from, :to, :project_id, :company_id, :term),
+    target: options.slice(:from, :to)
+  },
+  dry_run: options[:dry_run]
+)
+
+syncer.source_projects.each do |project|
+  if syncer.project_mapping[project.id]
+    puts "✅ Project #{project} --> #{syncer.project_mapping[project.id]}"
+    project.tasks.each do |task|
+      if syncer.task_mapping[task.id]
+        puts "  ✅ Task #{task} --> #{syncer.task_mapping[task.id]}"
+      else
+        puts "  ❌ Task #{task} not mapped"
+      end
+    end
+  else
+    puts "❌ Project #{project} not mapped"
+  end
+  puts ""
+end
+
+syncer.sync do |event, source, target|
+  case event
+  when :equal
+    puts "👀 EXISTS\n     #{source}\n  == #{target}"
+  when :update
+    puts "📝 UPDATE\n     #{source}\n  -> #{target}"
+  when :updated
+    puts "UPDATED"
+  when :create
+    puts "🆕 CREATE\n     #{target}"
+  when :created
+    puts "CREATED"
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: moco-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Teal Bauer
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: fuzzy_match
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description:
+email:
+- rubygems@teal.is
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".tool-versions"
+- ".vscode/launch.json"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- config.yml.sample
+- lib/moco.rb
+- lib/moco/api.rb
+- lib/moco/entities.rb
+- lib/moco/sync.rb
+- lib/moco/version.rb
+- mocurl.rb
+- sync_activity.rb
+homepage: https://github.com/moeffju/moco-ruby
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/moeffju/moco-ruby
+  source_code_uri: https://github.com/moeffju/moco-ruby
+  changelog_uri: https://github.com/moeffju/moco-ruby/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: A Ruby Gem to interact with the MOCO (mocoapp.com) API.
+test_files: []