moco-ruby 1.1.0 → 1.2.0

data/lib/moco/entities/user.rb

@@ -1,8 +1,44 @@
 # frozen_string_literal: true
 
 module MOCO
-  # Represents a MOCO user
-  # Provides methods for user-specific operations and associations
+  # Represents a MOCO user (staff member)
+  #
+  # == Required attributes for create:
+  #   firstname - String, first name
+  #   lastname  - String, last name
+  #   email     - String, email address (used for login)
+  #   unit_id   - Integer, team/unit ID
+  #
+  # == Optional attributes:
+  #   password     - String, initial password (if not set, user gets welcome email)
+  #   role_id      - Integer, permission role ID
+  #   active       - Boolean, whether user is active
+  #   external     - Boolean, true for contractors/external staff
+  #   language     - String, one of: "de", "de-AT", "de-CH", "en", "it", "fr"
+  #   mobile_phone - String, mobile phone number
+  #   work_phone   - String, work phone number
+  #   home_address - String, home address (use \n for line breaks)
+  #   bday         - String, birthday "YYYY-MM-DD"
+  #   iban         - String, bank account IBAN
+  #   tags         - Array of Strings, e.g., ["Developer", "Remote"]
+  #   custom_properties - Hash, e.g., {"Start Date": "2024-01-01"}
+  #   info         - String, additional notes
+  #   welcome_email - Boolean, send welcome email (default: true if no password)
+  #   avatar       - Hash, { filename: "photo.jpg", base64: "..." }
+  #
+  # == Read-only attributes:
+  #   id, avatar_url, unit (Hash), role (Hash), created_at, updated_at
+  #
+  # == Example:
+  #   moco.users.create(
+  #     firstname: "John",
+  #     lastname: "Doe",
+  #     email: "john.doe@company.com",
+  #     unit_id: 123,
+  #     language: "en",
+  #     tags: ["Developer"]
+  #   )
+  #
   class User < BaseEntity
     # Instance methods for user-specific operations
     def performance_report
@@ -22,6 +58,18 @@ module MOCO
       has_many(:holidays)
     end
 
+    def employments
+      has_many(:employments)
+    end
+
+    def work_time_adjustments
+      has_many(:work_time_adjustments)
+    end
+
+    def unit
+      association(:unit)
+    end
+
     def full_name
       "#{firstname} #{lastname}"
     end

data/lib/moco/entities/user_role.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module MOCO
+  # Represents a MOCO user permission role
+  # Read-only list of available permission roles
+  #
+  # == Read-only attributes:
+  #   id, name, created_at, updated_at
+  #
+  # == Common roles:
+  #   - Admin
+  #   - Manager
+  #   - Coworker
+  #   - etc.
+  #
+  # == Note:
+  #   Permission roles are configured in MOCO's admin interface.
+  #   Use role_id when creating/updating users to assign a role.
+  #
+  class UserRole < BaseEntity
+    def self.entity_path
+      "users/roles"
+    end
+
+    def to_s
+      name.to_s
+    end
+  end
+end

data/lib/moco/entities/vat_code_purchase.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module MOCO
+  # Represents a MOCO purchase VAT code (Steuerschlüssel Einkauf)
+  # Read-only VAT rates for purchases/receipts
+  #
+  # == Read-only attributes:
+  #   id, code, tax, reverse_charge, intra_eu, active
+  #
+  # == Filtering:
+  #   moco.vat_code_purchases.where(active: true)
+  #   moco.vat_code_purchases.where(reverse_charge: true)
+  #   moco.vat_code_purchases.where(intra_eu: true)
+  #   moco.vat_code_purchases.where(ids: "123,456")
+  #
+  # == Note:
+  #   VAT codes are configured in MOCO's admin interface.
+  #   Use vat_code_id when creating purchases/receipts.
+  #
+  class VatCodePurchase < BaseEntity
+    def self.entity_path
+      "vat_code_purchases"
+    end
+
+    def to_s
+      "#{code} - #{name}"
+    end
+  end
+end

data/lib/moco/entities/vat_code_sale.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module MOCO
+  # Represents a MOCO sales VAT code (Steuerschlüssel Verkauf)
+  # Read-only VAT rates for invoices/offers
+  #
+  # == Read-only attributes:
+  #   id, code, tax, reverse_charge, intra_eu, active,
+  #   print_gross_total, notice_tax_exemption, credit_account
+  #
+  # == Filtering:
+  #   moco.vat_code_sales.where(active: true)
+  #   moco.vat_code_sales.where(reverse_charge: true)
+  #   moco.vat_code_sales.where(intra_eu: true)  # EU intra-community
+  #
+  # == Note:
+  #   VAT codes are configured in MOCO's admin interface.
+  #   Use vat_code_id when creating invoices/offers.
+  #
+  class VatCodeSale < BaseEntity
+    def self.entity_path
+      "vat_code_sales"
+    end
+
+    def to_s
+      "#{code} - #{name}"
+    end
+  end
+end

data/lib/moco/entities/web_hook.rb

@@ -1,8 +1,38 @@
 # frozen_string_literal: true
 
 module MOCO
-  # Represents a MOCO webhook
-  # Provides methods for webhook-specific operations
+  # Represents a MOCO webhook for event notifications
+  #
+  # == Required attributes for create:
+  #   target - String, entity type to watch:
+  #            "Activity", "Company", "Contact", "Project",
+  #            "Invoice", "Offer", "Deal", "Expense"
+  #   event  - String, event type: "create", "update", "delete"
+  #   hook   - String, URL to receive webhook payloads (e.g., "https://example.org/callback")
+  #
+  # == Read-only attributes:
+  #   id, disabled, disabled_at, created_at, updated_at
+  #
+  # == Instance methods:
+  #   enable   - Enable the webhook
+  #   disable  - Disable the webhook
+  #
+  # == Example:
+  #   # Create webhook for new activities
+  #   moco.web_hooks.create(
+  #     target: "Activity",
+  #     event: "create",
+  #     hook: "https://example.org/moco-activity-webhook"
+  #   )
+  #
+  #   # Disable a webhook
+  #   webhook = moco.web_hooks.find(123)
+  #   webhook.disable
+  #
+  # == Note:
+  #   Only the `hook` URL can be updated after creation.
+  #   To change target/event, delete and recreate the webhook.
+  #
   class WebHook < BaseEntity
     # Override entity_path to match API path
     def self.entity_path

data/lib/moco/entities/work_time_adjustment.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module MOCO
+  # Represents a MOCO user work time adjustment record
+  # (Korrekturen Zeiterfassung) for overtime/undertime corrections
+  #
+  # == Required attributes for create:
+  #   user_id     - Integer, user to adjust
+  #   date        - String, "YYYY-MM-DD" effective date
+  #   description - String, reason for adjustment
+  #   hours       - Float, hours to add (positive) or subtract (negative)
+  #
+  # == Read-only attributes:
+  #   id, user (Hash), creator (Hash), created_at, updated_at
+  #
+  # == Example:
+  #   # Add overtime from previous year
+  #   moco.work_time_adjustments.create(
+  #     user_id: 123,
+  #     date: "2024-01-01",
+  #     description: "Overtime carryover from 2023",
+  #     hours: 42.0
+  #   )
+  #
+  #   # Correct time balance
+  #   moco.work_time_adjustments.create(
+  #     user_id: 123,
+  #     date: "2024-06-15",
+  #     description: "Correction for unpaid leave",
+  #     hours: -16.0
+  #   )
+  #
+  # == Filtering:
+  #   moco.work_time_adjustments.where(user_id: 123)
+  #   moco.work_time_adjustments.where(from: "2024-01-01", to: "2024-12-31")
+  #
+  class WorkTimeAdjustment < BaseEntity
+    def self.entity_path
+      "users/work_time_adjustments"
+    end
+
+    # Associations
+    def user
+      association(:user)
+    end
+
+    def to_s
+      "WorkTimeAdjustment ##{id} (#{date})"
+    end
+  end
+end

data/lib/moco/version.rb

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

data/lib/moco.rb

@@ -11,8 +11,10 @@ require_relative "moco/connection"
 require_relative "moco/collection_proxy"
 require_relative "moco/nested_collection_proxy"
 
-# New API (v2)
+# Entities
 require_relative "moco/entities/base_entity"
+
+# Core entities (original)
 require_relative "moco/entities/project"
 require_relative "moco/entities/activity"
 require_relative "moco/entities/user"
@@ -26,6 +28,54 @@ require_relative "moco/entities/schedule"
 require_relative "moco/entities/presence"
 require_relative "moco/entities/holiday"
 require_relative "moco/entities/planning_entry"
+
+# New standalone entities
+require_relative "moco/entities/contact"
+require_relative "moco/entities/offer"
+require_relative "moco/entities/purchase"
+require_relative "moco/entities/receipt"
+require_relative "moco/entities/unit"
+require_relative "moco/entities/comment"
+require_relative "moco/entities/tag"
+require_relative "moco/entities/tagging"
+require_relative "moco/entities/deal_category"
+require_relative "moco/entities/project_group"
+require_relative "moco/entities/profile"
+
+# Account-level entities
+require_relative "moco/entities/catalog_service"
+require_relative "moco/entities/custom_property"
+require_relative "moco/entities/expense_template"
+require_relative "moco/entities/fixed_cost"
+require_relative "moco/entities/hourly_rate"
+require_relative "moco/entities/internal_hourly_rate"
+require_relative "moco/entities/task_template"
+require_relative "moco/entities/user_role"
+require_relative "moco/entities/vat_code_sale"
+require_relative "moco/entities/vat_code_purchase"
+
+# Nested/sub-resource entities
+require_relative "moco/entities/employment"
+require_relative "moco/entities/work_time_adjustment"
+require_relative "moco/entities/project_contract"
+require_relative "moco/entities/payment_schedule"
+require_relative "moco/entities/recurring_expense"
+require_relative "moco/entities/invoice_payment"
+require_relative "moco/entities/invoice_reminder"
+require_relative "moco/entities/invoice_bookkeeping_export"
+require_relative "moco/entities/offer_approval"
+require_relative "moco/entities/purchase_category"
+require_relative "moco/entities/purchase_draft"
+require_relative "moco/entities/purchase_payment"
+require_relative "moco/entities/purchase_budget"
+require_relative "moco/entities/purchase_bookkeeping_export"
+
+# Reports
+require_relative "moco/entities/reports/absences"
+require_relative "moco/entities/reports/cashflow"
+require_relative "moco/entities/reports/finance"
+require_relative "moco/entities/reports/utilization"
+
 require_relative "moco/client"
 require_relative "moco/entity_collection"
 

data/moco.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/moco/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "moco-ruby"
+  spec.version = MOCO::VERSION
+  spec.authors = ["Teal Bauer"]
+  spec.email = ["rubygems@teal.is"]
+
+  spec.summary = "A Ruby Gem to interact with the MOCO API."
+  spec.description = "A modern, Ruby-esque interface for the MOCO API (mocoapp.com). " \
+                     "Provides an ActiveRecord-style interface for projects, activities, users, companies, and more."
+  spec.homepage = "https://github.com/starsong-consulting/moco-ruby"
+  spec.required_ruby_version = ">= 3.2.0"
+  spec.license = "Apache-2.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/starsong-consulting/moco-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/starsong-consulting/moco-ruby/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 7.0"
+  spec.add_dependency "faraday", ">= 2.0"
+  spec.add_dependency "fuzzy_match", "~> 2.1.0"
+
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: moco-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Teal Bauer
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-01-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,7 +51,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.1.0
-description:
+description: A modern, Ruby-esque interface for the MOCO API (mocoapp.com). Provides
+  an ActiveRecord-style interface for projects, activities, users, companies, and
+  more.
 email:
 - rubygems@teal.is
 executables: []
@@ -79,23 +80,63 @@ files:
 - lib/moco/entities.rb
 - lib/moco/entities/activity.rb
 - lib/moco/entities/base_entity.rb
+- lib/moco/entities/catalog_service.rb
+- lib/moco/entities/comment.rb
 - lib/moco/entities/company.rb
+- lib/moco/entities/contact.rb
+- lib/moco/entities/custom_property.rb
 - lib/moco/entities/deal.rb
+- lib/moco/entities/deal_category.rb
+- lib/moco/entities/employment.rb
 - lib/moco/entities/expense.rb
+- lib/moco/entities/expense_template.rb
+- lib/moco/entities/fixed_cost.rb
 - lib/moco/entities/holiday.rb
+- lib/moco/entities/hourly_rate.rb
+- lib/moco/entities/internal_hourly_rate.rb
 - lib/moco/entities/invoice.rb
+- lib/moco/entities/invoice_bookkeeping_export.rb
+- lib/moco/entities/invoice_payment.rb
+- lib/moco/entities/invoice_reminder.rb
+- lib/moco/entities/offer.rb
+- lib/moco/entities/offer_approval.rb
+- lib/moco/entities/payment_schedule.rb
 - lib/moco/entities/planning_entry.rb
 - lib/moco/entities/presence.rb
+- lib/moco/entities/profile.rb
 - lib/moco/entities/project.rb
+- lib/moco/entities/project_contract.rb
+- lib/moco/entities/project_group.rb
+- lib/moco/entities/purchase.rb
+- lib/moco/entities/purchase_bookkeeping_export.rb
+- lib/moco/entities/purchase_budget.rb
+- lib/moco/entities/purchase_category.rb
+- lib/moco/entities/purchase_draft.rb
+- lib/moco/entities/purchase_payment.rb
+- lib/moco/entities/receipt.rb
+- lib/moco/entities/recurring_expense.rb
+- lib/moco/entities/reports/absences.rb
+- lib/moco/entities/reports/cashflow.rb
+- lib/moco/entities/reports/finance.rb
+- lib/moco/entities/reports/utilization.rb
 - lib/moco/entities/schedule.rb
+- lib/moco/entities/tag.rb
+- lib/moco/entities/tagging.rb
 - lib/moco/entities/task.rb
+- lib/moco/entities/task_template.rb
+- lib/moco/entities/unit.rb
 - lib/moco/entities/user.rb
+- lib/moco/entities/user_role.rb
+- lib/moco/entities/vat_code_purchase.rb
+- lib/moco/entities/vat_code_sale.rb
 - lib/moco/entities/web_hook.rb
+- lib/moco/entities/work_time_adjustment.rb
 - lib/moco/entity_collection.rb
 - lib/moco/helpers.rb
 - lib/moco/nested_collection_proxy.rb
 - lib/moco/sync.rb
 - lib/moco/version.rb
+- moco.gemspec
 - mocurl.rb
 - sync_activity.rb
 homepage: https://github.com/starsong-consulting/moco-ruby
@@ -106,7 +147,6 @@ metadata:
   source_code_uri: https://github.com/starsong-consulting/moco-ruby
   changelog_uri: https://github.com/starsong-consulting/moco-ruby/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -121,8 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
-summary: A Ruby Gem to interact with the MOCO (mocoapp.com) API.
+summary: A Ruby Gem to interact with the MOCO API.
 test_files: []